New Zealand NHI IG
0.1.0 - CI Build

New Zealand NHI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of and changes regularly. See the Directory of published versions


This is the Implementation Guide for a HL7® FHIR© interface for the interface to the New Zealand NHI - National Health Identifier. It brings together all the artifacts that are necessary to understand and use this API.

The NHI is a national Patient Identifier system, which has been in continuous use for over 20 years. It is represented using the FHIR Patient resource.

The NHI serves 2 primary purposes:

  • A unique identifier for each individual
  • The source of truth for the key information about that individual.

Note that the NHI is not the actual source of information, rather it is the central registry from where a client can access (or update) it.

Organization of the Guide

This guide defines a profile on a single resource - the Patient resource and the API that can access it. This was created by first defining an Information model that defines the actual information in the model, and then subsequently the FHIR profile.


The API page describes how a client can retrieve Patients from the NHI. Write operations are not (yet) supported.

Need a comment / page on security