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


Official URL: Version: 1.4.1
Active as of 2022-08-03 Computable Name: NewZealandNHIIG

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

The NHI is made up of two resources:

This guide uses artifacts from New Zealand Base Implementation Guide.

NHI FHIR Introduction videos

Organization of the Guide

  • Business view: The Business context of the NHI

  • Use Cases: The expected Use Cases including the FHIR interactions that the NHI supports.

  • Onboarding and Compliance: Information on the process for onboarding and compliance, and the specific tests for each of the NHI FHIR interactions.

  • API: Information on the specific features supported by the API.

  • Profiles: Details of the data elements included in the NHI Patient and NHI Address profiles.

  • Extensions: List of extensions defined by the guide.

  • Identifiers: Provides details of the NHI-ID.

  • Terminology: List of the FHIR terminology artifacts defined within this implementation guide For other FHIR terminology see the HL7® FHIR® New Zealand Base Implementation Guide. Links can be found from each of the artifacts in the patient and address profiles).

  • Artifact Index: This is a tab automatically generated during the build of the Implementation Guide, and lists all the FHIR artifacts defined by the guide with a link to the details.

  • Support Links to the FHIR spec and downloads.


    ​ This IG was built from github branch: master commit id: 90c8dc717456da8c6a11f55930f241558f7b5592