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

CapabilityStatement: NhiCapabilityStatement

Official URL: Version: 1.4.1
Draft as of 2020-04-21 Computable Name:

A FHIR API in front of the New Zealand NHI

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 1.4.1
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats: json
  • Published on: Tue Apr 21 00:00:00 UTC 2020
  • Published by: Te Whatu Ora

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides


FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile


The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations

Resource Conformance: supportedPatient

Profile Conformance
Reference Policy

Interaction summary
  • Supports read.

Extended Operations

POST, [base]/Patient/$Match, /$Match (Find NHI) with In parameter onlyCertainMatches: 0 (False) An operation to search the NHI by demographics using fuzzy logic. Returns a bundle of results with match scores. HTTP Request 'POST'. Scope required: patient:search / Patient.s. $Match (Validate) with In parameter onlyCertainMatches: 1 (True) An operation to validate known patient demographic details against an NHI number. Returns a bundle of results with one patient resource that only includes the live nhi-id,system/Patient.v


POST, [base]/Patient/$set-preferred-name, Set the patient's preferred name, system/Patient.u


POST, [base]/Patient/$set-address,Update a patient's address, system/Patient.u


POST, [base]/Patient/$set-unvalidated-address, Allows a user to replace a physical address OR add or replace a postal address with an unvalidated address,system/Patient.u


POST, [base]/Patient/$remove-postal-address, Remove a patient's postal address,system/Patient.u


POST, [base]/Patient/$update-birth, Update a patient's birth information, system/Patient.u, system/Patient.a


POST, [base]/Patient/$update-identity, An operation to update a patient's identity details., system/Patient.u, system/Patient.a


POST, [base]/Patient/$add-name, Add a name to a patient's NHI record, system/Patient.u, system/Patient.a


POST, [base]/Patient/$replace-name, An operation to replace a name on a patient's record, system/Patient.u, system/Patient.a


POST, [base]/Patient/$inactivate-name, Inactivate a name that is currently active on a patients record ,system/Patient.u, system/Patient.a


POST, [base]/Patient/$update-eligibility, Update a patient's citizenship information, system/Patient.u, system/Patient.a


POST, [base]/Patient/$create,Create a new patient record in the NHI, system/Patient.c, system/Patient.a