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

OperationDefinition: Update a patient's address.

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-address Version: 1.5.4
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

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INaddress-type1..1string

Must be physical or postal

INnz-address-id1..1string

The id of the validated address as returned by the eSAM address service

INaddress-line1..1string

The first line of the validated address as returned by eSAM

INaddress-building-name0..1string

Building name if required as additional address information, not returned by eSAM

OUTreturn0..1Patient

The updated patient resource

OUTfailure0..1OperationOutcome

Error response

The address is validated and the patient address is updated.