Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.0.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-medication

AU Base Medication [FMM Level 2]

This profile defines a medication structure including core localisation concepts for use in an Australian context.

The following elements available in STU3 Medication have been removed from the standard structure of R4 Medication. If required in R4 use prior version extensions1, for this reason the direct use of these elements is not encouraged:

  • Medication.isBrand
  • Medication.isOverCounter
  • Medication.package.container
  • Medication.image

Medication Coding

Medication codings are used to define relevant drug/medication concepts. This includes coding as:

  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding.
  • GTIN - Global Trade Item Number, physical product reference.
  • AMT Code - Australian Medicines Terminology, national drug terminology.
  • MIMS Package - commonly used medicine coding.

Extensions

Extensions used in this profile:

  • Medication.code.coding: Medication Type [1] - used to distinguish a level classification when the same coding system is used.
  • Medication Brand Name [1] - This text-only extension is supplied to support a brand name where no brand concept coding is available. Use code if a brand concept coding is available.
  • Medication Generic Drug Name [1] - This text-only extension is supplied to support a generic name where no generic concept coding is available. Use code if a generic concept coding is available.
  • NOTE: if extensions Medication Brand Name or Medication Generic Drug Name are used then code must also be used.

Examples

Fluconazole Dose Based Medication

Paracetamol Generic Pack

Nexium Hp7 Brand Pack

Nexium Hp7 Combination Package with Product Parts

Clarithromycin 500mg Tablet Unbranded Product

Esomeprazole 20mg Tablet Unbranded Product

Amoxicillin 500mg Capsule Unbranded Product

Norvasc 10 mg Tablet Brand Product with Batch Details

The following examples have been taken from the National guidelines for on-screen display of clinical medicines information – January 2016 published by the Australian Commission on Safety and Quality in Health Care. Care has been taken with the clinical content in the structured data, and construction of narrative to be consistent with the guidelines:

Single active ingredient product: pack-based

Two active ingredients product

Product with four or more active ingredients

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-medication

This profile defines a medication structure including core localisation concepts for use in an Australian context.

This profile builds on Medication.

This profile was published on Thu May 11 00:06:07 UTC 2017 as a active by Health Level Seven Australia (Medications WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... code I0..1CodeableConceptCoding for the medicine
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amt-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system, value:code
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
..... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElement
.... item[x] 1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept 0..1CodeableConceptCoded Ingredient Product
...... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
....... coding:amtMP 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code ΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amt-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
..... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedForm Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... amount Σ0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptCoded Ingredient Product
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:amtMP Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
...... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... code I0..1CodeableConceptCoding for the medicine
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amt-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system, value:code
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
..... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElement
.... item[x] 1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept 0..1CodeableConceptCoded Ingredient Product
...... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
....... coding:amtMP 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code ΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amt-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
..... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedForm Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... amount Σ0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptCoded Ingredient Product
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:amtMP Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
...... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-medication

none defined