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

Nzmt Datamodel

New Zealand Medicines Terminology (NZMT) overview

The New Zealand Medicines Terminology (NZMT) database has been designed from the SNOMED data model, and is intended to provide a single, consistent database of names for medicines and trade products containing these medicines.

New Zealand Medicines Terminology Data Model

NZMT Overview

This is a simplified view of the structure of the NZ Medicines Terminology. It uses an example medicine to show how information is linked together.

It does not show all of the information available and the multitude of relationships that can exist. For example a medicine may be available in more than one dose form, strength and brand.

*Panadol is a registered trademark of the Haleon group of companies.

Concept Examples
Medicinal Product (MP) ibuprofen
Medicinal Product Pack (MPP) ibuprofen 10 mg/2 mL injection, 4 x 2 mL ampoules
ibuprofen 200 mg capsule, 96
Medicinal Product Unit of Use (MPUU) ibuprofen 800 mg tablet: modified release
ibuprofen 200 mg/5 mL oral liquid
Trade Product (TP) Fenpaed
Caldolor
Nurofen
Trade Product Pack (TPP) ACT-3 200 mg capsule: soft, 48 capsules
ACT-3 200 mg capsule: soft, 20 capsules
ACT-3 (ibuprofen 200 mg) capsule: soft, 12
Trade Product Unit of Use (TPUU) Nurofen Solutabs (ibuprofen 200 mg) tablet: dispersible, 1 tablet
Nurofen Duralast (ibuprofen 200 mg/24 hours) patch
Nurofen Caplet (ibuprofen 200 mg) tablet: sugar-coated, 1 tablet
Container Trade Product Pack (CTPP) Medreich Ibuprofen 200 mg tablet: film-coated, 96 tablets, blister pack
Nurofen 200 mg tablet: sugar-coated, 6 tablets, blister pack
Nurofen 400 Double Strength 400 mg tablet: sugar-coated, 48 tablets, blister pack

SNOMED ID Codes (SCTIDs)

Overview

The SNOMED spec dictates that all records are identified by a globally unique 18-digit number. This means that you can create a single lookup table inside your database that contains all the id numbers of all the NZMT records in your database and you won’t get a single duplicate.

The primary purpose of this globally unique key is to allow records from any of the Medicines Terminologies operated by SNOMED member nations to co-exist in a single database if required, and also to conform to the very flexible but rather challenging to use “three-table” structure of the standard SNOMED data structure (which is not covered in this document – please ask if you need additional information).

ID Data Format

id numbers that are 18 digits wide are just slightly too large to fit within the largest integers supported by most databases. So all record IDs are stored as 18 character strings.

Key Structure

The 18-digit key contains (in order):

  • an 8-digit sequence number
  • a 7-digit national “namespace” number (1000117 or 1000116)
  • a 2 digit SNOMED “type” code known as the ‘partition code’
  • a single checkdigit

E.g.: 50004811000117106 breaks down as: 5000481 – 1000117 – 10 – 6

Note 1: The Australian national namespace code is: 1000036. You can use this to identify data imported from the AMT.

Note 2: We currently only use 7 of the available 8 digits in the initial sequence number, so as in our example above almost all of our SCTIDs are actually 17-character strings.

Note 3: The SNOMED ‘partition code’ has three values: 10 for Concept IDs, 11 for Description IDs and 12 for Relationship IDs. The example above is therefore a Concept ID and is actually the SCTID for a CTPP record. All of the seven primary tables and of the lookup tables are considered to have Concept IDs. The descriptions table has Description IDs, while relationship tables such as MHM and THT have Relationship IDs.