New Zealand NHI IG
1.4.1 - Release
New Zealand NHI IG - Local Development build (v1.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-name | Version: 1.4.1 | |||
| Draft as of 2023-06-12 | Computable Name: Add Name | |||
An operation to add a name to a patient’s NHI record
URL: [base]/Patient/[id]/$add-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 | 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 | 1..1 | string | attribute used to indicate whether the name is preferred or not | ||
| IN | information-source | 1..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.