New Zealand Health Terminology Service (NZHTS) Implementation Guide
0.1.0 - ci-build

New Zealand Health Terminology Service (NZHTS) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Home

Official URL: https://fhir-ig.digital.health.nz/nzhts/ImplementationGuide/tewhatuora.nzhts Version: 0.1.0
Draft as of 2026-06-29 Computable Name: nzhts

NZHTS

The New Zealand Health Terminology Service (NZHTS) is the national health terminology service run by Health New Zealand | Te Whatu Ora. It is an instance of Ontoserver, publishing and serving terminology as an FHIR R4 terminology service API.

This IG provides guidance to NZHTS FHIR users. It focuses on the FHIR usage patterns and integration with FHIR tooling rather than the clinical governance of individual terminologies. For more general NZHTS information, see the NZHTS home page.

This guide covers:

  • A primer for the FHIR terminology concepts that matter when using NZHTS
  • how to use NZHTS as part of the wider HL7 FHIR terminology ecosystem including with terminology for which NZHTS is declared as the authoratitive server
  • how to to use NZHTS authentication with the IG Publisher
  • architecture guidance on consuming NZHTS and production terminology service usage

The production FHIR terminology endpoint is https://nzhts.digital.health.nz/fhir. The included NZHTS CapabilityStatement describes the server's supported functionality.

Guide pages

References

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 (tewhatuora.nzhts.r4) and R4B (tewhatuora.nzhts.r4b) are available.

Dependencies

IGPackageFHIRComment
.. New Zealand Health Terminology Service (NZHTS) Implementation Guidetewhatuora.nzhts#0.1.0R4
... HL7 Terminology (THO)hl7.terminology.r4#7.2.0R4Automatically added as a dependency - all IGs depend on HL7 Terminology
.... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.3.0R4
... FHIR Tooling Extensions IGhl7.fhir.uv.tools.r4#0.7.1R4for 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#0.7.1

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 Sat, Jul 26, 2025 06:59+1000+10:00)

Intellectual property

This publication includes IP covered under the following statements.