New Zealand NHI IG
1.5.4 - Release

New Zealand NHI IG - Local Development build (v1.5.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: Update patient's birth details

Official URL: https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-birth Version: 1.5.4
Draft as of 2023-06-12 Computable Name: Update Birth Details

Update patient’s birth details.

URL: [base]/Patient/[id]/$update-birth

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INnhi1..1string

The Patient's nhi number

INversion-id1..1string

The current value of the patient resources meta.versionId

INbirthdate0..1string

The patient's date of birth

INbirthdate-information-source1..1string

The information source for the patient's date of birth

INcountry-of-birth0..1string

The patient's country of birth

INcountry-of-birth-information-source0..1string

The information source for the patient's country of birth

INplace-of-birth0..1string

The place where the person as born, E.g. Whangārei. Only populate if country-of-birth is populated

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 included items are updated on the Patients NHI record.