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: Set patient's preferred name

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

Inactivate name

URL: [base]/Patient/[id]/$set-preferred-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 | preferred-id |  | 1..1 | integer |  | The id of the name element to be set to be the preferred name (patient.name.id)
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 name.id is validated. If all request parameters are valid the name.preferred boolean is set to TRUE on the requested name and FALSE on the current preferred name.