HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
1.0.0 - ci-build
HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions
Official URL: https://fhir-docs.nzf.org.nz/ImplementationGuide/hl7.org.nz.fhir.ig.formulary | Version: 1.0.0 | |||
Active as of 2024-07-17 | Computable Name: NZFormularyIG |
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 provide a medication resource for the key types of medications in the NZMT. These are:
*Panadol is a registered trademark of the Haleon group of companies.
Click here for more information on the NZMT data model.
Complementing the NZMT information is information from the NZF Formulary, Pharmac and Medsafe. This includes information ranging from funding to legal classifications to Cautionary and Advisory labels. For more information on the full data set see the data, including examples of how to retrieve specific information.
The medication resources also link to several documents (using the link extension). To facilitate this, we use DocumentReference resources.
We provide document references for the following data:
Data | Description |
---|---|
Adult monographs | A reference to all adult monographs - this allows for integrating systems to determine which monograph(s) to link to for a given medication |
Child monographs | A reference to all children monographs - this allows for integrating systems to determine which monograph(s) to link to for a given medication |
Patient information leaflets | A link to all patient information leaflets - these contain a number of extensions to provide extra information about the PIL (see mapping tab) |
Medsafe Datasheets | A reference to all medsafe datasheet URLs |
Medsafe CMIs | A reference to all medsafe CMI URLs |
We also provide substance resources for each NZMT substance. See Substance resources.
This guide is divided into a number of sections
We also work closely with the NZ Health Terminology Service (NZHTS). The codes from the NZMT are published to the NZHTS and this might be the best option for light use-cases or if terminology services are needed. The services are complementary so both APIs can be used together. To get more information please see here: https://www.tewhatuora.govt.nz/our-health-system/digital-health/terminology-service/ . Any valuesets created will also be published to this service.
To contact us please use the email address fhir ‘at’ nzformulary.org with any questions or requests to access the data.
We want, not only the API, but also this documentation to be as useful as possible so please get in touch if you have any feedback.