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

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name | Version: 1.6.5
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

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 | replace-id |  | 1..1 | integer |  | The id for the name on the nhi to be replaced
IN | use |  | 0..1 | string |  | the name use qualifier for a name
IN | prefix |  | 0..1 | string |  | the name prefix
IN | given-1 |  | 0..1 | string |  | the first or given name
IN | given-2 |  | 0..1 | string |  | the middle or other given name(s)
IN | family |  | 0..1 | string |  | the family name
IN | preferred |  | 0..1 | string |  | attribute used to indicate whether the name is preferred or not
IN | information-source |  | 0..1 | string |  | The information source for the patient's name
IN | nhi-name-use-extra |  | 0..1 | string |  | an attribute used to qualify pre-allocated and babyof names
OUT | return |  | 0..1 | Patient |  | The updated patient resource
OUT | failure |  | 0..1 | OperationOutcome |  | 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.