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

Extensions

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 Yes
Descriptions Specific NZMT descriptions that apply to this medication Yes 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
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 Medsafe status, regSituation and routes of administation Yes
Prescribe by Brand Whether the medication should be prescribed by brand or not Yes Yes
Funding NZ specific funding information provided by PHARMAC Yes
Funding rules The rules and constraints around funding for the given medicine 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
NZF Pack details Unit quantity and (if applicable) unit size details for the given medicine pack Yes
Related medication A related medication within the NZMT hierarchy Yes Yes Yes Yes Yes Yes Yes
NZF Medication Sponsor Organization sponsoring the medication Yes

Extensions defined in this guide

IdUrlContext of UseDescriptionPurpose FMM Status
nzf-atc http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
Medication
Anatomical Therapeutic Chemical (ATC) Classification - see https://www.who.int/tools/atc-ddd-toolkit/atc-classification 0 draft
nzf-cal http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
Medication
Cautionary and Advisory Label 0 draft
nzf-description http://hl7.org.nz/fhir/StructureDefinition/nzf-description
Medication
Specific NZMT descriptions that apply to this medication 0 draft
nzf-funding-rule http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
Medication
Funding restriction information which complements the general funding information provided in the nzf-funding extension. The extension can be added multiple times to a product for each given rule as well as for each PHARMAC schedule. These can be differentiated via the scheduleDate field. 0 draft
nzf-funding http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
Medication
Core funding information specific to NZ. The extension can be added multiple times to a product for each PHARMAC schedule. These can be differentiated via the scheduleDate field. 0 draft
nzf-is-primary-coding http://hl7.org.nz/fhir/StructureDefinition/nzf-is-primary-coding
Coding
Is primary code within given context, e.g. primary Pharmacode® when multiple given 0 draft
nzf-legalclass http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
Medication
Legal classification 0 draft
nzf-link http://hl7.org.nz/fhir/StructureDefinition/nzf-link
Medication
Reference to other information about this medication 0 draft
nzf-medication-sponsor http://hl7.org.nz/fhir/StructureDefinition/nzf-medication-sponsor
Medication
Organization sponsoring this medication 0 draft
nzf-medsafe http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
Medication
Medsafe package, reg situation and administration route details 0 draft
nzf-nzmtType http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Medication
The NZ Medicines Terminology (NZMT) Data Class – MP (Medicinal Product), MPUU (Medicinal Product Unit of Use), MPP (Medicinal Product Pack), TP (Trade Product), TPUU (Trade Product Unit of Use), TPP (Trade Product Pack) or CTPP (Containered Trade Product Pack) – that the Medication is a member of. 0 draft
nzf-pack http://hl7.org.nz/fhir/StructureDefinition/nzf-pack
Medication
NZF Pack detail 0 draft
nzf-page-size http://hl7.org.nz/fhir/StructureDefinition/nzf-page-size
DocumentReference.content.attachment
Attachment page size 0 draft
nzf-pil-dose-form http://hl7.org.nz/fhir/StructureDefinition/nzf-pil-dose-form
DocumentReference.context
Doseform that this PIL applies to 0 draft
nzf-pil-formulary http://hl7.org.nz/fhir/StructureDefinition/nzf-pil-formulary
DocumentReference.context
Applicable formulary for PIL 0 draft
nzf-pil-indication http://hl7.org.nz/fhir/StructureDefinition/nzf-pil-indication
DocumentReference.context
Indication that this PIL applies to 0 draft
nzf-pil-route-of-admin http://hl7.org.nz/fhir/StructureDefinition/nzf-pil-route-of-admin
DocumentReference.context
Route of admin that this PIL applies to 0 draft
nzf-pil-source http://hl7.org.nz/fhir/StructureDefinition/nzf-pil-source
DocumentReference.context
Source of the PIL (e.g. mymedicines) 0 draft
nzf-prescribe-by-brand http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
Medication
True if can be prescribed by brand 0 draft
nzf-related-medication http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
Medication
A related medication within the NZMT hierarchy 0 draft
nzf-supply-information http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
Medication
Information around the supply and availability of medications applied at each NZMT level. For example, when paracetamol tablets are in short supply an alert may be attached to the MP level medication along with the relevant details. 0 draft
nzf-unapproved http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
Medication
True if this medication has not been approved by Medsafe and can be prescribed under section 29 0 draft
stockleys-interaction-evidence-code http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-evidence-code
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-modification-date http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-modification-date
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-review-date http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-review-date
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-route http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-severity-code http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-severity-code
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-text-link http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-text-link
ClinicalUseDefinition
undefined 0 draft
stockleys-interaction-warning-code http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-warning-code
ClinicalUseDefinition
undefined 0 draft

Extensions used but defined elsewhere

PathUrlDescriptionIG where defined