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

• Narrative Content
• XML
• JSON
• TTL

: Update a patient's address. - XML Representation

Draft as of 2023-06-12

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-set-address"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Patient/[id]/$set-address</p><p>Parameters</p><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>address-type</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Must be physical or postal</p>
</div></td></tr><tr><td>IN</td><td>nz-address-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 id of the validated address as returned by the eSAM address service</p>
</div></td></tr><tr><td>IN</td><td>address-line</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 first line of the validated address as returned by eSAM</p>
</div></td></tr><tr><td>IN</td><td>address-building-name</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Building name if required as additional address information, not returned by eSAM</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 address is validated and the patient address is updated.</p>
</div></div>
  </text>
  <url
       value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-address"/>
  <version value="1.5.4"/>
  <name value="Set Address"/>
  <title value="Update a patient's address."/>
  <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 to replace a name on a patient's record."/>
  <affectsState value="true"/>
  <code value="set-address"/>
  <comment
           value="The address is validated and the patient address is updated."/>
  <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="address-type"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Must be physical or postal"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="nz-address-id"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The id of the validated address as returned by the eSAM address service"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="address-line"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The first line of the validated address as returned by eSAM"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="address-building-name"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Building name if required as additional address information, not returned by eSAM"/>
    <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>