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: Replace a name on a patient's NHI record.

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name Version: 1.5.4
Draft as of 2023-06-12 Computable Name: Replace Name

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

URL: [base]/Patient/[id]/$replace-name

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INreplace-id1..1integer

The id for the name on the nhi to be replaced

INuse0..1string

the name use qualifier for a name

INprefix0..1string

the name prefix

INgiven-10..1string

the first or given name

INgiven-20..1string

the middle or other given name(s)

INfamily0..1string

the family name

INpreferred0..1string

attribute used to indicate whether the name is preferred or not

INinformation-source0..1string

The information source for the patient's name

INnhi-name-use-extra0..1string

an attribute used to qualify pre-allocated and babyof names

OUTreturn0..1Patient

The updated patient resource

OUTfailure0..1OperationOutcome

Error response

The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new name is added to the nhi record, and the old one is removed.