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 New Zealand Medicines Formulary LP. 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

DocumentReference resource for NZ Formulary

DocumentReference resource for NZ Formulary

Medication resource for NZ Formulary

Medication resource for NZ Formulary

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide

Coding resource for NZ Formulary

Coding resource for NZ Formulary

Structures: Extension Definitions

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.

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

Medsafe

Medsafe package and reg situation details

NzfPageSize

Attachment page size

NzmtDescription

Specific NZMT descriptions that apply to this medication

NzmtType

Type of NZMT record (e.g. MP, MPUU)

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

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

ATC codes

ATC Codes

Legal Medication status

Legal Medication status

NZF Document Type

New Zealand Formulary Document Type

NZMT Description types

NZMT Description types

Nzf page size

Page size

NZMT Codes

All NZMT Codes

Nzmt type

New Zealand Medication Terminology Type

Derived pharmac funding code

Derived pharmac funding code

Pharmac funding type

Pharmac funding type

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

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 page size

The set of all possible page sizes

Possible values for NZMT Type

The set of all possible nzmt types

Possible values for Derived Pharmac funding code

The set of all possible funding codes

Possible values for Pharmac funding type

The set of all possible funding codes

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

ctpp-50000391000117104
ctpp-50079341000117105
ctpp-with-funding
medsafe-datasheet-document-reference-example

Datasheet for 50000121000117103

mp-ibuprofen-10013251000116106
mpuu-ibuprofen-200-mg-capsule-10013271000116104
patient-information-leaflet-example

Acarbose

tpuu-10013331000116105