Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-medication

AU Base Medication [FMM Level 0]

This profile defines a medication information structure including core localisation concepts for Australia. Wherever possible, the structure for medication information profiled here, has been aligned to the proposed R4 Medication. In support of alignment it is expected that value of Medication.package.content.item is the same as Medication.code; and the following elements have been profile to allow a maximum cardinality of 1:

  • Medication.package
  • Medication.package.content
  • Medication.package.batch

The following elements available in STU3 Medication have been removed from the standard structure of R4 Medication, and for this reason it is recommended use of these elements is not encouraged:

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

Extensions

Extensions used in this profile:

  • Medication: PBS Sponsor [1]
  • Medication.code.coding: Medication Type [1]

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

Medication record for Australian context

This profile builds on Medication.

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

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

This profile contains the following variations from Medication:

  1. zero or more extension sliced
    • at most one PBS Sponsor extension
  2. at most one code Coding for the Medicine
    • zero or more coding Medication PBS coding (ignore item context)
    • zero or more coding Medication Package GTIN
    • at most one coding AMT Trade Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Containered Trade Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Trade Product Unit of Use
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product Unit of Use
      • at most one Type of medication coding extension
    • at most one coding AMT Trade Product
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product
      • at most one Type of medication coding extension
    • at most one coding MIMS Package
  3. at most one manufacturer Physical Product Manufacturer Organisation
    • at most one coding Medication Form (SNOMED CT)
  4. zero or more ingredient
    • item[x] Coded Ingredient Product
    • coding AMT Medicinal Product Ingredient
      • at most one Medication Batch Serial Number extension
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... pbs-sponsor 0..1Reference(PBS Sponsor)PBS sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... code 0..1CodeableConceptCoding for the Medicine
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding 0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
.... coding 0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
.... coding 0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
.... coding 0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
.... coding 0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
.... coding 0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
.... coding 0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
... manufacturer 0..1Reference(Organization)Physical Product Manufacturer Organisation
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
​.... item[x] 1..1CodeableConceptCoded Ingredient Product
​..... coding CodingSlice: Unordered, Open by value:system
​..... coding 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... amount 0..1RatioStrength of Ingredient

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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pbs-sponsor I0..1Reference(PBS Sponsor)PBS sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCoding for the Medicine
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... 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 Σ0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
..... 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 Σ0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
..... 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 Σ0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
..... 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 Σ0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
..... 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 Σ0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
..... 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 Σ0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
..... 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 Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(Organization)Physical Product Manufacturer Organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
..... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioStrength of Ingredient
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..1BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..1BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-batch-serialnumber I0..1stringMedication Batch Serial Number
URL: http://hl7.org.au/fhir/StructureDefinition/medication-batch-serialnumber
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

This profile contains the following variations from Medication:

  1. zero or more extension sliced
    • at most one PBS Sponsor extension
  2. at most one code Coding for the Medicine
    • zero or more coding Medication PBS coding (ignore item context)
    • zero or more coding Medication Package GTIN
    • at most one coding AMT Trade Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Containered Trade Product Pack
      • at most one Type of medication coding extension
    • at most one coding AMT Trade Product Unit of Use
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product Unit of Use
      • at most one Type of medication coding extension
    • at most one coding AMT Trade Product
      • at most one Type of medication coding extension
    • at most one coding AMT Medicinal Product
      • at most one Type of medication coding extension
    • at most one coding MIMS Package
  3. at most one manufacturer Physical Product Manufacturer Organisation
    • at most one coding Medication Form (SNOMED CT)
  4. zero or more ingredient
    • item[x] Coded Ingredient Product
    • coding AMT Medicinal Product Ingredient
      • at most one Medication Batch Serial Number extension

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... pbs-sponsor 0..1Reference(PBS Sponsor)PBS sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... code 0..1CodeableConceptCoding for the Medicine
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding 0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
.... coding 0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
.... coding 0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
.... coding 0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
.... coding 0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
.... coding 0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
.... coding 0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
... manufacturer 0..1Reference(Organization)Physical Product Manufacturer Organisation
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
​.... item[x] 1..1CodeableConceptCoded Ingredient Product
​..... coding CodingSlice: Unordered, Open by value:system
​..... coding 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... amount 0..1RatioStrength of Ingredient

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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pbs-sponsor I0..1Reference(PBS Sponsor)PBS sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCoding for the Medicine
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... 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 Σ0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
..... 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 Σ0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
..... 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 Σ0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
..... 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 Σ0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
..... 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 Σ0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
..... 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 Σ0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
..... 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 Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(Organization)Physical Product Manufacturer Organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
..... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioStrength of Ingredient
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..1BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..1BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-batch-serialnumber I0..1stringMedication Batch Serial Number
URL: http://hl7.org.au/fhir/StructureDefinition/medication-batch-serialnumber
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

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