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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| DocumentReference resource for NZ Formulary |
DocumentReference resource for NZ Formulary |
| Interaction Clincial Use Definition resource for NZ Formulary |
Interaction Clincial Use Definition resource for NZ Formulary |
| Medication resource for NZ Formulary |
Medication resource for NZ Formulary |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Coding resource for NZ Formulary |
Coding resource for NZ Formulary |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Atc |
Anatomical Therapeutic Chemical (ATC) Classification - see https://www.who.int/tools/atc-ddd-toolkit/atc-classification |
| Cautionary and Advisory Label |
Cautionary and Advisory Label |
| Funding |
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. |
| FundingRule |
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. |
| InteractionEvidence | |
| InteractionModificationDate | |
| InteractionReviewDate | |
| InteractionSeverity | |
| InteractionTextLink | |
| InteractionWarning | |
| InteractionsRoute | |
| IsPrimary |
Is primary code within given context, e.g. primary Pharmacode® when multiple given |
| LegalClass |
Legal classification |
| Link |
Reference to other information about this medication |
| MedicationSponsor |
Organization sponsoring this medication |
| Medsafe |
Medsafe package, reg situation and administration route details |
| NzfPack |
NZF Pack detail |
| NzfPageSize |
Attachment page size |
| NzmtDescription |
Specific NZMT descriptions that apply to this medication |
| NzmtType |
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. |
| PilDoseForm |
Doseform that this PIL applies to |
| PilFormulary |
Applicable formulary for PIL |
| PilIndication |
Indication that this PIL applies to |
| PilRouteOfAdmin |
Route of admin that this PIL applies to |
| PilSource |
Source of the PIL (e.g. mymedicines) |
| PrescribeByBrand |
True if can be prescribed by brand |
| RelatedMedication |
A related medication within the NZMT hierarchy |
| SupplyInformation |
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. |
| Unapproved |
True if this medication has not been approved by Medsafe and can be prescribed under section 29 |
These define sets of codes used by systems conforming to this implementation guide.
| ATC codes |
ATC Codes |
| Derived PHARMAC funding code |
Derived PHARMAC funding code |
| Legal Medication status |
Legal Medication status |
| NZF Document Type |
New Zealand Formulary Document Type |
| NZMT Codes |
All NZMT Codes |
| NZMT Description types |
NZMT Description types |
| Nzf page size |
Page size |
| Nzmt type |
New Zealand Medication Terminology Type |
| PHARMAC funding type |
PHARMAC funding type |
These define new code systems used by systems conforming to this implementation guide.
| Possible values for Derived PHARMAC funding code |
The set of all possible funding codes |
| Possible values for Medication Legal Classification |
The set of all possible legal classifications |
| Possible values for NZF Document Type |
The set of all possible nzf document types |
| Possible values for NZMT Type |
The set of all possible nzmt types |
| Possible values for PHARMAC funding type |
The set of all possible funding codes |
| Possible values for page size |
The set of all possible page sizes |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.