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

## OperationDefinition: Update a patient address using an unvalidated address.

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address | Version: 1.6.5
Draft as of 2023-06-12 | Computable Name: Set Unvalidated Address

Update a patient address using an unvalidated address.

URL: [base]/Patient/[id]/$set-unvalidated-address

### Parameters

Use | Name | Scope | Cardinality | Type | Binding | Documentation
IN | nhi |  | 1..1 | string |  | The Patient's nhi number
IN | version-id |  | 1..1 | string |  | The current value of the patient resources meta.versionId
IN | not-validated-address-reason |  | 1..1 | string |  | The reason the address could not be validated
IN | address-type |  | 1..1 | string |  | Must be physical or postal
IN | address-line-1 |  | 1..1 | string |  | The first line of the address
IN | address-line-2 |  | 0..1 | string |  | The first line of the address
IN | address-building-name |  | 0..1 | string |  | Building name if required as additional address information, not returned by eSAM
IN | address-suburb |  | 0..1 | string |  |
IN | address-city |  | 0..1 | string |  |
IN | address-postal-code |  | 0..1 | string |  |
IN | address-country-code |  | 0..1 | string |  | 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’
IN | address-domicile-code |  | 0..1 | string |  | 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)
OUT | return |  | 0..1 | Patient |  | The updated patient resource
OUT | failure |  | 0..1 | OperationOutcome |  | Error response

The patient address is updated with an unvalidated address.