Brief description

When communicating with each other, healthcare providers use certain terms and code sets for different health concepts. The New Zealand Health Terminology Service (NZHTS) provides access to terminology and code set standards for healthcare systems which:

  • give health providers confidence they are speaking about the same concepts, and a better experience because reliable data is shared seamlessly
  • improve data quality and reduce data management overheads.

For more information, visit the NZ Health Terminology Service page.

Overview

The NZHTS API provides read-only access to assured terminology and code systems.

There are two endpoints:

  • A FHIR API for a real-time code system, value set and concept map lookups.
  • A ‘syndication service’ that allows users’ own local systems and terminology services to receive code set updates.

The FHIR API and syndication service are available to developers now.

Currently, the following code sets and terminologies are available:

  • SNOMED CT New Zealand Edition
  • National Health Index (NHI) code sets
  • Health Provider Index (HPI) code sets
  • MedDRA
  • LOINC.

More code sets will be added over time, including the New Zealand Pathology Observation Code Sets (NZPOCS) and code sets for the New Zealand International Patient Summary (NZIPS), CanShare and the Aotearoa Immunisation Register (AIR).

The NZHTS has an authoring platform that allow partners such as Te Aho o Te Kahu to contribute to the content of our code sets.

Who can use this API

The NZHTS is available to:

  • healthcare providers – government and private/non-governmental organisations (NGOs)
  • health software developers
  • healthcare commissions
  • population health professionals
  • health researchers and analysts
  • ACC, health insurers, and others who supply services or support the healthcare market.

Use cases

Example outcomes when using the NZHTS API include:

  • Look up the details of a code you want to use.
  • Look up clinical finding, diagnosis and procedure concepts.
  • Search and filter content to find the correct term.
  • Make sure your local code set data is up to date.
  • Check you are using the correct codes and terms when sharing information with another healthcare provider.

Onboarding and implementation

To start using the terminology service API, first visit our SNOMED portal to register as a SNOMED user and then go to the NZHTS site to accept the terms of use and create an NZHTS account.

Complete the online onboarding request form next. You will need to provide information about your organisation and the application you will integrate with.

Onboarding request form

Once your onboarding request has been approved, you will be provided with the information to start integration. The onboarding team will be in touch if further information is required.

If you require help or have any questions regarding the onboarding process, please contact our team by completing a general enquiry form.

General enquiry form

API types

REST API 

Technical

All API endpoints adhere to the FHIR® (Fast Healthcare Interoperable Resources) interoperability standard. CSIRO Ontoserver® is the software used.

Technical documentation can be found on the Ontoserver – FHIR launchpad page. This focusses on the FHIR Terminology Service resources and API.