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/inactivate-name | Version: 1.4.1 | |||
| Draft as of 2023-06-12 | Computable Name: Inactivate Name | |||
Inactivate name
URL: [base]/Patient/[id]/$inactivate-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 | inactivate-id | 1..1 | integer | The id of the name element to be inactivated (patient.name.id)) | ||
| OUT | return | 0..1 | Patient | The updated patient resource | ||
| OUT | failure | 0..1 | OperationOutcome | Error response |
The NHI is validated. The version-id is validated. The inactivate-id is validated. If all request parameters are valid the name is made inactive on the patient record.