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

Validate Patient

Validate Patient Overview

  • The local system sends a validate request to the NHI with an nhi-id and patient details
    • if a ‘dormant’ nhi-id is used, the response will include the ‘live’ nhi-id
  • In Parameters:
    • Patient resource
    • onlyCertainMatches: 1 (True)
  • The NHI validates the nhi-id and provided details against patient records held on the NHI
  • The NHI returns a bundle with an nhi-id if a validation has been successful
  • The bundle will also include a search score.
  • For an example Validate request body click here
Validate PatientIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> NHI<FHIR API> NHINHI MDMNHI MDMProvide resource withPatient details for NHI tovalidatePOST<Endpoint>/Patient/$match(onlyCertainMatches set toTrue)Validate[]RequestReturn Patient record withonly NHI numberDisplay confirmation to user

Validate Patient processing steps:

  1. The user initiates a validate request in the integrating application
  2. The integrating application sends an HTTP POST request using a $match operation to the NHI with ‘In Parameters’ (A patient resource and onlyCertainMatches set to True). E.g. Post<Endpoint>/Patient/$match
  3. The request is validated - ALT: Validation failure. OperationOutcome resource returned
  4. The NHI validates whether the Patient details and nhi-id provided are a match
  5. If there is a certain match the NHI FHIR API returns a Bundle containing only the Patient record with the nhi-id showing. Alt: Empty Bundle returned with OperationOutcome resource returned.
  6. The integrating application displays the results of the validate to the user.

In Parameters

Parameter name Parameter type Mandatory / Optional Description
'Patient resource' Resource Mandatory See validate request example (link below)
onlyCertainMatches: 1 (True) boolean Mandatory Must be set to true


Note: To be more FHIR compliant this will be changed to return:

  • A search score most likely (1) to least likely (0)
  • A “match-grade”: (certain, possible, certainly-not)

Example request

For an example Validate request and response click here

Validate Patient Rules and errors

For Request rules and errors click here

Validate Patient rules
  • A Validate patient request must include:
    • A valid nhi-id
    • name
    • birthdate

  • Validate Patient errors
    • NHI number supplied cannot be found
    • onlyCertainMatches is only currently supported when sending an NHI identifier (Not an ID)
    • Patient name is a required field
    • Patient birthdate is a required field