New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Add a contact to a patient's NHI record. - XML Representation

Draft as of 2023-06-12

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="Patient-add-contact"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Patient-add-contact</b></p><a name="Patient-add-contact"> </a><a name="hcPatient-add-contact"> </a><p>URL: [base]/Patient/[id]/$add-contact</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>nhi</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The Patient's nhi number</p>
    </div></td></tr><tr><td>IN</td><td>version-id</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The current value of the patient resources meta.versionId</p>
    </div></td></tr><tr><td>IN</td><td>use</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>home or mobile</p>
    </div></td></tr><tr><td>IN</td><td>system</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>phone or email</p>
    </div></td></tr><tr><td>IN</td><td>value</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the phone number or email address</p>
    </div></td></tr><tr><td>IN</td><td>isVerified</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Verification has  been performed to determine that the email or phone number can be used to communicate with the patient (true or false)</p>
    </div></td></tr><tr><td>IN</td><td>isShared</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>The email address or phone number is shared with other people (true or false)</p>
    </div></td></tr><tr><td>IN</td><td>isPrivate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>The email address or phone number may be used to communicate private health information about the individual identified by the NHI</p>
    </div></td></tr><tr><td>IN</td><td>context</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Additional information about the context of use of this contact</p>
    </div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td><td/><td><div><p>The updated patient resource</p>
    </div></td></tr><tr><td>OUT</td><td>failure</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Error response</p>
    </div></td></tr></table><div><p>The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new contact is added to the nhi record.</p>
    </div></div>
      </text>
      <url
           value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-contact"/>
      <version value="1.6.5"/>
      <name value="Add Contact"/>
      <title value="Add a contact to a patient's NHI record."/>
      <status value="draft"/>
      <kind value="operation"/>
      <experimental value="false"/>
      <date value="2023-06-12T12:47:40+10:00"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="email"/>
          <value value="mailto:integration@health.govt.nz"/>
        </telecom>
      </contact>
      <description
                   value="An operation to add a contact to a patient's NHI record"/>
      <affectsState value="true"/>
      <code value="add-contact"/>
      <comment
               value="The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new contact is added to the nhi record."/>
      <resource value="Patient"/>
      <system value="false"/>
      <type value="false"/>
      <instance value="true"/>
      <parameter>
        <name value="nhi"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The Patient's nhi number"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="version-id"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The current value of the patient resources meta.versionId"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="use"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="home or mobile"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="system"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="phone or email"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="value"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="the phone number or email address"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="isVerified"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="Verification has  been performed to determine that the email or phone number can be used to communicate with the patient (true or false)"/>
        <type value="boolean"/>
      </parameter>
      <parameter>
        <name value="isShared"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="The email address or phone number is shared with other people (true or false)"/>
        <type value="boolean"/>
      </parameter>
      <parameter>
        <name value="isPrivate"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="The email address or phone number may be used to communicate private health information about the individual identified by the NHI"/>
        <type value="boolean"/>
      </parameter>
      <parameter>
        <name value="context"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="Additional information about the context of use of this contact"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="return"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The updated patient resource"/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="failure"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="Error response"/>
        <type value="OperationOutcome"/>
      </parameter>
    </OperationDefinition>