Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions


Rheumatic Fever API terminology overview

This page provides an overview of the terminology systems that are depended on, or have been created, for use in this FHIR API.

The Rheumatic Fever FHIR resources make use of established SNOMED (International and NZ Editions) and NZMT (New Zealand Medication Terminology) codesystems, and defines new terminology needed to code the certainty of a rheumatic fever diagnosis.

New terminology for severity and certainty of rheumatic fever diagnosis

This IG introduces new terminology (a CodeSystem and ValueSet) defining the possible values of severity and certainty of a rheumatic fever diagnosis. This terminology is specific to and important for NZ’s care of patients with rheumatic fever.

The terminology is used two coded extensions to the FHIR Condition resource type. See Rheumatic Fever Condition in the Profiles section.

These new codes are published for the time being in this IG.

In future it is anticipated that the New Zealand Health Terminology Server (NZHTS) will host the official published versions however there are currently problems with this meaning clients cannot expand ValueSets for DiagnosticCertainty or RHD severity.

New SNOMED-based ValueSets

SNOMED codes are used in rheumatic fever for:

  1. severity of the rheumatic fever condition and of the related rheumatic heart disease condition,
  2. category of CarePlans and CareTeams,
  3. identifying the medication route by which secondary prophylaxis medication is taken,
  4. identifying the body site of secondary prophylaxis medication injection,
  5. codifying roles of whanau CareTeam participants,
  6. codifying medication substances a patient is allergic to,
  7. codifying the interval / frequency of medication,

The codes which are valid for these purposes are defined by ValueSets in this Implementation Guide.

Note that SNOMED codes are taken from the SNOMED CT International Edition wherever possible but a handful of new codes had to be defined where suitable terms were not already available. These new codes are being introduced in the SNOMED CT New Zealand Edition which has a root concept defined here.

The NZ edition is published only every six months (October and April), and there are also SNOMED licensing restrictions affecting accessibility of NZ edition terms in the New Zealand Health Terminology Server and in the the FHIR global terminology service. Due to these issues FHIR API clients ValueSets which define SNOMED-based terminology are not usable by FHIR API clients when published at the NZ Health Terminology Server, and so at the present time, the official definitions of rheumatic fever terminology are given by the ValueSets published in this Implementation Guide.

It is anticipated that this situation will ease in the future as the new NZ terms become more accessible to NZ clients through established global terminology services.

New Zealand Medication Terminology

New Zealand Medication Terminology is documented here and its terms can be easily listed by expanding an NZHTS-published ValueSet

NZMT codes are used in rheumatic fever for:

1.secondary prophylaxis medication ingredient

  • eg. #10134211000116105 benzathine penicillin (as benzathine benzylpenicillin tetrahydrate) [Used in Medication.ingredient]

2.secondary prophylaxis medication brand

  • eg. #43924201000116108 Bicillin LA 1.2 million units/2.3 mL (900 mg/2.3 mL) injection: suspension, 1 x 2.3 mL syringe [Medication.code]

3.secondary prophylaxis strength/concentration of lignocaine pain relief medication

  • eg. #10747581000116100 lidocaine hydrochloride anhydrous 1% (20 mg/2 mL) injection, ampoule [MedicationStatement.medicationCodeableConcept)]

Coding of external national system identifier types

Some FHIR resources in this IG need to be capable of holding identifiers to resources in other Te Whatu Ora applications and national applications. Examples of this class of national system identifiers in FHIR include:

  • RheumaticFeverCareplans recording a Salesforce case identifier (Te Whatu Ora application)

  • RheumaticFeverConditions recording a Salesforce case identifier and an EPISurv number (ESR system)

The convention in this IG that all such external ‘national identifiers’ will be recorded in a [NationalSystem] slice on the identifier resource element. This slicing requires FHIR Identifiers to be represented as follows:

"identifier" : [
    "use" : "usual",
    "type" : {
      "coding" : "SHOULD be a code defined by this IG for the type of national identifier"
    "system" : "Url identifying the Naming System of these identifiers, for example https://standards.digital.health.nz/ns/nhi-id",
    "value" : "The actual external identifier value"

See the ValueSet of external identifier types which defines the codes API consumers can give for identifiers which use the [NationalSystem] slice.