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's address.

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

An operation to to replace a name on a patient's record.

URL: [base]/Patient/[id]/$set-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 | address-type |  | 1..1 | string |  | Must be physical or postal
IN | nz-address-id |  | 1..1 | string |  | The id of the validated address as returned by the eSAM address service
IN | address-line |  | 1..1 | string |  | The first line of the validated address as returned by eSAM
IN | address-building-name |  | 0..1 | string |  | Building name if required as additional address information, not returned by eSAM
OUT | return |  | 0..1 | Patient |  | The updated patient resource
OUT | failure |  | 0..1 | OperationOutcome |  | Error response

The address is validated and the patient address is updated.