HL7® FHIR® New Zealand Base Implementation Guide
0.9.0 - Ballot version

HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v0.9.0). See the Directory of published versions


New Zealand base FHIR Implementation Guide

This is the base Implementation Guide (IG) for New Zealand and contains the common extensions that most NZ FHIR Implementations will need, along with any terminology artifacts referenced by them (ie coded elements).

The following tabs are available from the navbar at the top.


This tab lists all the extensions defined in this guide, where an extension is an additional element that can be recorded in a resource. The extension definition describes the purpose of the extension, its name and dataType/s.

Clicking on the link in the ‘id’ column will display the detail page for that extension. Extensions can have a single value, or can be composed of multiple ‘child’ elements - an example is the funded programme extension. The snapshot tab in the details page (about halfway down) lists all the parts of the extension - including a link to the ValueSet if the element is coded.


This tab lists the terminology artifacts defined in this guide. There are 2 artifacts that will be found here:

  • ValueSets are ‘selectors’ of concepts that apply to some particular coded element in an Extension Definition or Profile - they contain a list of possible values for that element. It is usually possible to use other values if needed, but these are the ‘recommended’ values. Note that it is possible to have elements where the concept MUST come from the ValueSet, though this is uncommon.
  • CodeSystem resources are used to define specific concepts. Generally, it is preferred to use an ‘external’ terminology like SNOMED or LOINC, but sometimes it isn’t possible to find the matching concepts there so they need to be defined separately.

These resources can be used by Terminology Servers (like Terminz or Ontoserver ) to provide terminology operations of use to implementers, such as the ValueSet $expand operation.

There is a lot more detail on terminology in the FHIR specification. The section on Terminology Services is also useful.


Identifiers are used to unambiguously identify something. Examples in New Zealand are the NHI (National Health Identifier) or HPI (Health Practitioner index). Each type of identifier has a url that uniquely identifies it - for example the value for the NHI is https://standards.digital.health.nz/ns/nhi-id. This url will be present in the ‘system’ value in a resource instance. Note that the url will not necessarily ‘resolve’ - entering it into a web browser will not result in anything.

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.


Contains links to the main FHIR specification, as well downloads for the full IG or the artifacts defined in the guide (Extension Definitions, ValueSets and CodeSystems.)

Terminology Audit.

This is a working page during development of the guide and will be removed when published.