New Zealand NHI IG
1.5.4 - Release
New Zealand NHI IG
1.5.4 - Release
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
| Draft as of 2023-06-12 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="Patient-set-unvalidated-address"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Patient/[id]/$set-unvalidated-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>not-validated-address-reason</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 reason the address could not be validated</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>address-line-1</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 address</p>
</div></td></tr><tr><td>IN</td><td>address-line-2</td><td/><td>0..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 address</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>IN</td><td>address-suburb</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-city</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-postal-code</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-country-code</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Must be supplied when not-validated-address-reason = OSEA and must not be ‘NZ’. When not-validated-address-reason not = OSEA and country-code is supplied it must be ‘NZ’</p>
</div></td></tr><tr><td>IN</td><td>address-domicile-code</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>When supplied it must be a valid code in domicile-code valueset. When not supplied, the suburb and city are used to derive a domicile code from the streets file. If a suburb/city combination is not found in the streets file an error is returned (note the client end-user can then enter a domicile code or client system can supply a default district domicile code)</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 patient address is updated with an unvalidated address.</p>
</div></div>
</text>
<url
value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address"/>
<version value="1.5.4"/>
<name value="Set Unvalidated Address"/>
<title value="Update a patient address using an unvalidated 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="Update a patient address using an unvalidated address."/>
<affectsState value="true"/>
<code value="set-unvalidated-address"/>
<comment
value="The patient address is updated with an unvalidated address."/>
<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="not-validated-address-reason"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The reason the address could not be validated"/>
<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="address-line-1"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The first line of the address"/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-line-2"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="The first line of the address"/>
<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="address-suburb"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-city"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-postal-code"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-country-code"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Must be supplied when not-validated-address-reason = OSEA and must not be ‘NZ’. When not-validated-address-reason not = OSEA and country-code is supplied it must be ‘NZ’ "/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-domicile-code"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="When supplied it must be a valid code in domicile-code valueset. When not supplied, the suburb and city are used to derive a domicile code from the streets file. If a suburb/city combination is not found in the streets file an error is returned (note the client end-user can then enter a domicile code or client system can supply a default district domicile code)"/>
<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>