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

Update Birth

Update Birth Overview

The update birth operation allows an authorised user to update a persons birthdate and birthplace information on a persons identity record.

This includes:

  • Bithdate
  • Birthdate information source
  • Birthplace:
    • Country
    • information source
    • place of birth
$update-birthIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> NHI<FHIR API> NHINHI MDMNHI MDMProvide patient birth detailsto be updatedPOST<Endpoint>/Patient/$update-birthValidate[]RequestReturn updated PatientrecordDisplay updated patientdetails to user

Update-birth - Processing steps:

  1. The user provides patient details to be updated
  2. The integrating application sends an HTTP Post request using the $update-birth operation to the NHI E.g. Post<Endpoint>/Patient/$update-birth
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
  4. The provided patient attributes are updated
  5. The updated record is returned with an HTTP 200 ok response
  6. The integrating application displays the updated details to the user

Update-birth - In Parameters

Parameter name Parameter type Mandatory / Optional Description
nhi valueString Mandatory The patients nhi number
version-id valueString Mandatory The current patient version number
birthdate valueString Optional The patients date of birth
birthdate-information-source valueString Optional The information source for the patients date of birth
country-of-birth valueString Optional The patient's country of birth
country-of-birth-information-source valueString Optional The information source for the patient's country of birth
place-of-birth valueString Optional The place where the person as born, E.g. Whangarei.
Only populate if country-of-birth is populated

Update-identity - Behaviour

  • The NHI is validated
  • The Patient version-id is validated
  • The parameters are validated
  • If all request parameters are valid, the attributes are updated on the NHI.

Update-birth - Example request - TBC

  "resourceType": "Parameters",
  "id": "example",
  "parameter": [
        "name" : "nhi",
        "valueString" : "ZGD9203"
        "name" : "version-id",
        "valueString" : "3321540"
        "name" : "birthdate",
        "valueString" : "2015-09-09" 
        "name" : "birthdate-information-source",
        "valueString" : "BREG" 
        "name" : "country-of-birth",
        "valueString" : "NZ" 
        "name" : "country-of-birth-information-source",
        "valueString" : "BREG" 
        "name" : "place-of-birth",
        "valueString" : "Whangarei" 

Update-birth - Rules and errors

For Request rules and errors click here

Patient update-birth rules
  • An update request must contain:
    • the live NHI number for the Patient Record.
    • the version number of the current Patient Record.
  • An update request must not:
    • delete/inactivate mandatory information.
    • modify or delete any information with a Status of Registered.
  • An update request may:
    • populate the request parameter with the required value(s) to modify the existing NHI value for that parameter.
    • not populate the request parameter to retain the existing NHI value for that parameter.
    • modify active patient information which is not ‘registered’ or verified’ information.
    • modify active patient information for which evidence has been sighted (“verified” information) Can modify a verified source to another verified source or verified to Registered.
  • An update request which results in an attribute Status of Registered must only be submitted via an authorised Agency.
  • An update request must not modify a record to the extent that the patient identity describes a different patient.
  • An update requestt to update the value for a core identity field must also update the information source.
  • An update request must update the source of information only when the information is also provided.

  • Patient update-birth errors
    • Patient NHI and version number are required
    • Version number is incorrect
    • _The NHI Identifier provided is dormant. This record cannot be updated
    • Cannot delete mandatory data

Update-birth birthdate rules

  • Patient update-birth birthdate errors
    • birth-date has been validated against a verified source, and must only be modified by authorised users
    • birth-date can only be set to a ‘Registered’ value by an authorised Agency
    • The patient identity information supplied may result in transformation of this NHI. Please resubmit or contact NHI administration.
    • birth-date-information-source is required when birth-date is present
    • birth-date is required when birth-date-information-source is present.
Update-birth birthplace rules
  • All create patient birthplace rules apply and,
  • A request to update place-of-birth must also update country-of-birth
  • A request to update country of birth must also update country-of-birth-information-source
  • birth-place cannot be updated if source is ‘registered’ (BREG) See Glossary
  • birth-place can only be updated to registered by an authorised agency
  • A verified birthplace can be updated by another verified source, not by an unverified source.

  • Patient update-birth birthdate errors
    • birth-place has been validated against a verified source, and must only be modified by authorised users
    • Can only modify a verified source to another verified source or verified to Registered (see Modification of registered information)
    • birth-place can only be set to a ‘Registered’ value by an authorised Agency
    • Cannot delete mandatory data
    • country-of-birth-information-source is required when country-of-birth is present
    • country-of-birth is required when country-of-birth-information-source is present.