Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.5.0: 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]

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.

AU Base Medication profile contains:

  1. Optional GTINs (as Coding)
  2. Optional PBS Items (as Coding)
  3. Optional AMT Trade Product Pack (as Coding)
  4. Optional AMT Medicinal Product Pack (as Coding)
  5. Optional AMT Containered Trade Product Pack (as Coding)
  6. Optional AMT Trade Product Unit of Use (as Coding)
  7. Optional AMT Medicinal Product Unit of Use (as Coding)
  8. Optional AMT Trade Product (as Coding)
  9. Optional AMT Medicinal Product (as Coding)
  10. Optional MIMS Package (as Coding)
  11. Optional PBS Pharmaceutical Manufacturer (as Reference)
  12. Optional AMT Medicinal Product Ingredients (as Coding)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Australian context Medication information
... 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)
..... 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)
..... 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)
..... 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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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(PBS Pharmaceutical Manufacturer
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(SubstanceMedicationAU Ingredient Product
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)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Australian context Medication information
... 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..*ExtensionAdditional Content defined by implementations
... 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)
.... 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)
..... 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)
...... 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)
..... 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)
...... 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)
..... 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)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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(PBS Pharmaceutical ManufacturerManufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... 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(SubstanceMedicationAU Ingredient Product
Slice: Unordered, Open by type:$this
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... 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..1RatioQuantity of ingredient present
... 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..*BackboneElementWhat 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(MedicationThe item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... 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

AU Base Medication profile contains:

  1. Optional GTINs (as Coding)
  2. Optional PBS Items (as Coding)
  3. Optional AMT Trade Product Pack (as Coding)
  4. Optional AMT Medicinal Product Pack (as Coding)
  5. Optional AMT Containered Trade Product Pack (as Coding)
  6. Optional AMT Trade Product Unit of Use (as Coding)
  7. Optional AMT Medicinal Product Unit of Use (as Coding)
  8. Optional AMT Trade Product (as Coding)
  9. Optional AMT Medicinal Product (as Coding)
  10. Optional MIMS Package (as Coding)
  11. Optional PBS Pharmaceutical Manufacturer (as Reference)
  12. Optional AMT Medicinal Product Ingredients (as Coding)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Australian context Medication information
... 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)
..... 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)
..... 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)
..... 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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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)
..... medication-type 0..1CodingMedication Type
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(PBS Pharmaceutical Manufacturer
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(SubstanceMedicationAU Ingredient Product
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)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Australian context Medication information
... 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..*ExtensionAdditional Content defined by implementations
... 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)
.... 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)
..... 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)
...... 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)
..... 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)
...... 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)
..... 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)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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)
..... medication-type 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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(PBS Pharmaceutical ManufacturerManufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... 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(SubstanceMedicationAU Ingredient Product
Slice: Unordered, Open by type:$this
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... 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..1RatioQuantity of ingredient present
... 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..*BackboneElementWhat 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(MedicationThe item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... 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