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

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INcontact-id1..1string

The id of the telecom element to be replaced

INuse0..1string

home or mobile

INsystem0..1string

phone or email

INvalue0..1string

the phone number or email address

INisValidFormat0..1boolean

The format of the email address or phone number is valid (true or false)

INisValidDomain0..1string

The domain of the email address is valid (true or false)

INisVerified0..1string

Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false)

INisShared0..1string

The email address or phone number is shared with other people (true or false)

INisPrivate0..1string

The email address or phone number may be used to communicate private health information about the individual identified by the NHI

INisPrivate0..1string

Additional information about the context of use of this contact

OUTreturn0..1Patient

The updated patient resource

OUTfailure0..1OperationOutcome

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.