HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
0.1.0 - ci-build

HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by . This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions


This IG is to support retrieving formulary and medication information in New Zealand. This is part of a project by the NZULM/NZ Formulary to provide the information we produce and collate in a standards-based form. As an organisation we want to make it as easy as possible to retrieve the medication information that you require in a timely manner.

The key resource for this implementation is the Medication resource. For those that are familiar with the New Zealand Medicines Terminology (NZMT) we will provide a medication resource for the key types of medications in the NZMT. These are:

  • Medicinal Product (MP) e.g. paracetamol
  • Trade Product (TP) e.g. panadol
  • Medicinal Product Unit of Use (MPUU) e.g. paracetamol 500 mg tablet
  • Trade Product Unit of Use (TPUU) e.g. Panadol (paracetamol 500 mg) tablet: film-coated, 1 tablet
  • Container Trade Product Pack (CTPP) e.g. Panadol 500 mg tablet: film-coated, 1000 tablets, blister pack
  • Medicinal Product Pack (MPP) e.g. paracetamol 120 mg/5 mL oral liquid, 200 mL
  • Trade Product Pack (TPP) e.g. Panadol 500 mg tablet: film-coated, 12 tablets

The standard Medication resource provides the key information needed for integration however we have defined several extensions to allow for the addition of specific NZULM/Formulary information. The following table describes these extensions and shows which extensions apply to which medication type.

Extension Description MP TP MPUU TPUU MPP TPP CTPP
Type Type of NZMT reference (e.g. CTPP, MPUU) etc. Yes Yes Yes Yes Yes Yes
Cautionary and Advisory Labels (CALs) List of all Cautionary and Advisory labels associated with the medication Yes Yes Yes Yes Yes
ATC The Anatomical Therapeutic Chemical Classification code(s) Yes Yes Yes Yes Yes Yes Yes
Unapproved True if the medication has not been approved by Medsafe and can be prescribed under section 29 Yes
Legal Classification Medsafe legal classification Yes Yes Yes
Medsafe Status Medsafe product status Yes
Prescribe by Brand Whether the medication should be prescribed by brand or not Yes
Funding NZ specific funding information provided by pharmac Yes
Pharmac Supply Information Pharmac provided information detailing medication supply issues Yes Yes Yes Yes Yes Yes Yes
Links Links to associated resources, such as monographs, datasheets and patient information leaflets Yes Yes Yes Yes Yes Yes Yes

The medication resources will also link to several documents (using the link extension). To facilitate this, we use DocumentReference resources. Currently the intention is to have document references to formulary monographs, datasheets, patient information leaflets and pharmac special authority forms. These will be linked from the specific medication that they apply to as well as at a DocumentReference endpoint. This will allow for retrieval of all DocumentReferences of a certain type (e.g. give me all the datasheets etc.).

As we stated we want this to be as useful as possible so please get in touch if you have any feedback.