HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/daniel-thomson/nzbase/ and changes regularly. See the Directory of published versions

## Home

Official URL: http://hl7.org.nz/fhir/ImplementationGuide/fhir.org.nz.ig.base | Version: 3.1.0
Active as of 2026-05-21 | Computable Name: HL7FHIRNewZealandBaseImplementationGuide

### 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).

#### Macron support for Te reo Māori

By default, FHIR supports macrons (and all diacritics) as commonly used by Te Reo Māori to indicate long vowels.

Macrons are supported as FHIR uses UTF-8 for all encoding formats (JSON, XML, and RDF), and macrons are explicitly allowed by the relevant FHIR datatypes where macrons could appear.

### Overview of IG Sections

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

#### Extensions

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.

#### Terminology

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

- ValueSets are sets of codes, drawn from one or more code systems, intended for use in coded data elements in Resources, as defined by a particular conformance rule - such as an Extension or Profile. The ValueSets in this Guide are 'recommended' values, but it may be possible for implementers to use additional concepts if the rules defined by a particular Extension or Profile permit this.
- CodeSystem resources are used to declare the existence of and describe a code system, its key properties, and optionally define a part or all of its content. Wherever possible, the use of international terminologies, such as SNOMED CT, is recommended; however, a number of New Zealand-specific code systems are included in this Guide to meet unique, local requirements.

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

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.

#### Support

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.)

If you would like to provide any feedback on this Implementation Guide, email admin@hl7.org.nz

### Version

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (fhir.org.nz.ig.base.r4) and R4B (fhir.org.nz.ig.base.r4b) are available.

### Dependencies

IG | Package | FHIR | Comment
--- | --- | --- | ---
HL7® FHIR® New Zealand Base Implementation Guide | fhir.org.nz.ig.base#3.1.0 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#7.1.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.3.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r4#1.1.2 | R4 | for example references

Package hl7.fhir.uv.extensions.r4#5.3.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, May 16, 2026 18:32+1000+10:00)

Package hl7.fhir.uv.tools.r4#1.1.2 This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Mar 24, 2026 11:13+1100+11:00)

### IP Statement

This publication includes IP covered under the following statements.

- © 2020+ New Zealand Crown Copyright
  Show Usage
  - NZ DHB: DHB, Dhb, Patient/patient-address-building-name, Patient/patient-address-suburb and Patient/patient-dhb
- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms&reg; (SNOMED CT&reg;): Condition/condition-long-term-condition, Iwi_code... Show 4 more, MedicationRequest/medicationrequest-nzeps-long-term-medication, MedicationRequest/medicationrequest-nzeps-supply-period-reason, MedicationRequest/medicationrequest-nzeps-unusual-dose-quantity and NZ_ethnic_group_codes
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - SubscriberPolicyholder Relationship Codes: Coverage/CoverageCSC, Coverage/CoverageGMS and Coverage/CoverageHUHC
  - identifierType: HPIFacility, HPIOrganization... Show 20 more, HPIProvider, Moe_facility_id, NBN, NZChiro, NZDental, NZDiet, NZMC, NZMidwife, NZNC, NZOCC, NZOpt, NZOst, NZParamed, NZPhysio, NZPsych, NZPsycho, NZRadiologist, NZScience, Nz_address_id and Rheumatic_fever_ccs_id
  - degreeLicenseCertificate: Practitioner/practitioner-additional-authorisation, Practitioner/practitioner-condition-on-practice... Show 4 more, Practitioner/practitioner-educational-qualification, Practitioner/practitioner-registration-initial-date, Practitioner/practitioner-registration-status-code and Practitioner/practitioner-scope-of-practice

### Globals

There are no Global profiles defined