New Zealand HPI Implementation Guide
0.9.0 - CI Build

New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of and changes regularly. See the Directory of published versions



This page describes the subset of the FHIR RESTful API supported by the HPI.

It does not include the authentication and other security requirements


Queries that allow individual practitioners to be returned.

The Companion application has a query tool that can be used.

Search by Demographics

Returns a bundle with matching patients. Elements supported:

  • name
  • birthDate
  • gender
  • identifier

(there are likely some mandatory elements…)

GET [host]/Patient?name={x}&birthDate={y}...

See the spec for details on the searches

Specific queries

Search by name

Returns a bundle of patients with matching names. There will very likely be more than one.




Note that the name query will match any of the string fields in the HumanName, including family, given and/or text

Search by NHI

Returns a bundle of patients with matching NHI’s. There may be more than one.

GET [host]/Patient?identifier={nhi} eg


Note that the identifier query (whch is of type token) should include the ‘system’ (or namespace) of the NHI

Included resources

It is possible to return resources that are referenced by the matching resource in the same query using the _include parameter.

For example the following query will return all patients whose name is ‘smith’ and include the referenced resources for general practitioner and organization (regardless of the type of the referenced resource).