New Zealand NHI IG
1.6.1 - Release

New Zealand NHI IG - Local Development build (v1.6.1) 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.1
Draft as of 2023-06-12 Computable Name: Set Unvalidated Address

Update a patient address using an unvalidated address.

Generated Narrative: OperationDefinition Patient-set-unvalidated-address

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INnot-validated-address-reason1..1string

The reason the address could not be validated

INaddress-type1..1string

Must be physical or postal

INaddress-line-11..1string

The first line of the address

INaddress-line-20..1string

The first line of the address

INaddress-building-name0..1string

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

INaddress-suburb0..1string
INaddress-city0..1string
INaddress-postal-code0..1string
INaddress-country-code0..1string

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’

INaddress-domicile-code0..1string

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)

OUTreturn0..1Patient

The updated patient resource

OUTfailure0..1OperationOutcome

Error response

The patient address is updated with an unvalidated address.