New Zealand NHI IG
1.6.5 - Release
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
| Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-contact | Version: 1.6.5 | |||
| Draft as of 2023-06-12 | Computable Name: Replace Contact | |||
An operation to replace a contact on a patient's NHI record
URL: [base]/Patient/[id]/$replace-contact
| 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 | contact-id | 1..1 | string | The id of the contact to be replaced | ||
| IN | use | 0..1 | string | home or mobile | ||
| IN | system | 1..1 | string | phone or email | ||
| IN | value | 1..1 | string | the phone number or email address | ||
| IN | isVerified | 0..1 | boolean | Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false) | ||
| IN | isShared | 0..1 | boolean | The email address or phone number is shared with other people (true or false) | ||
| IN | isPrivate | 0..1 | boolean | The email address or phone number may be used to communicate private health information about the individual identified by the NHI | ||
| IN | context | 0..1 | string | Additional information about the context of use of this contact | ||
| 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 contact is added to the nhi record.