AU Base Implementation Guide
6.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/steveswinsburg/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Medication

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medication Version: 6.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUBaseMedication

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a medication structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • Medication definition includes coding as:
  • When a code for medication definition is unavailable, just text is allowed in Medication.code.text.
  • When a medication is compounded and is a list of ingredients, Medication.code may contain only the list of ingredients as text in Medication.code.text.
  • For support as text representation of other medicinal product information consider:
    • ​brand name in Medication Brand Name extension
    • ​generic name in Medication Generic Name extension
    • medication strength, for medication as a whole, in Medication Strength extension
    • medication form in Medication.form.text
    • item form and strength as part of medication definition in Medication.code.text
    • manufacturer in Medication.manufacturer.display
  • When individual ingredient strength is unavailable as a ratio, it can be surfaced as text in CodeableConcept.text by using pre-adoption of the FHIR R5 Medication.ingredient.strength[x] element with the extension URL http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength[x]. See this example of use Tadim.
    • This is to be interpreted as the strength of that specific ingredient, not the strength of the medication as a whole.
    • Where possible use the existing Medication.ingredient.strength element in preference to pre-adopting the FHIR R5 Medication.ingredient.strength[x] element.
    • Details on cross version pre-adoption implementation can be found in the FHIR specification Extensions for converting between versions section.

Potentially useful extensions:

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.0.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... code Σ 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... text Σ 0..1 string Medication primary text
    ... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    ... ingredient 0..* BackboneElement Active or inactive ingredient
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... item[x] 1..1 The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    ..... itemCodeableConcept CodeableConcept
    ..... itemReference Reference(Substance | Medication)
    .... strength 0..1 Ratio Quantity/strength of ingredient present

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Medication.codeexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    From the FHIR Standard
    Medication.statusrequiredMedication Status Codes
    http://hl7.org/fhir/ValueSet/medication-status|4.0.1
    From the FHIR Standard
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Medication

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... code 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... coding
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    .... text 0..1 string Medication primary text
    ... manufacturer 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    .... item[x] 1..1 CodeableConcept, Reference(Substance | Medication) The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    .... strength 0..1 Ratio Quantity/strength of ingredient present

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Medication.codeexampleSNOMEDCTMedicationCodes
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business identifier for this medication
    ... code Σ 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... coding Σ 0..* Coding Code defined by a terminology system
    ..... id 0..1 string Unique id for inter-element referencing
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ..... system Σ 0..1 uri Identity of the terminology system
    ..... version Σ 0..1 string Version of the system - if relevant
    ..... code Σ 0..1 code Symbol in syntax defined by the system
    ..... display Σ 0..1 string Representation defined by the system
    ..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    .... text Σ 0..1 string Medication primary text
    ... status ?!Σ 0..1 code active | inactive | entered-in-error
    Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
    ... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    ... amount Σ 0..1 Ratio Amount of drug in package
    ... ingredient 0..* BackboneElement Active or inactive ingredient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... item[x] 1..1 The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    ..... itemCodeableConcept CodeableConcept
    ..... itemReference Reference(Substance | Medication)
    .... isActive 0..1 boolean Active ingredient indicator
    .... strength 0..1 Ratio Quantity/strength of ingredient present
    ... batch 0..1 BackboneElement Details about packaged medications
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... lotNumber 0..1 string Identifier assigned to batch
    .... expirationDate 0..1 dateTime When batch will expire

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Medication.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Medication.codeexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    From the FHIR Standard
    Medication.statusrequiredMedication Status Codes
    http://hl7.org/fhir/ValueSet/medication-status|4.0.1
    From the FHIR Standard
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Medication

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... code Σ 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... text Σ 0..1 string Medication primary text
    ... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    ... ingredient 0..* BackboneElement Active or inactive ingredient
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... item[x] 1..1 The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    ..... itemCodeableConcept CodeableConcept
    ..... itemReference Reference(Substance | Medication)
    .... strength 0..1 Ratio Quantity/strength of ingredient present

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Medication.codeexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    From the FHIR Standard
    Medication.statusrequiredMedication Status Codes
    http://hl7.org/fhir/ValueSet/medication-status|4.0.1
    From the FHIR Standard
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Differential View

    This structure is derived from Medication

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... code 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... coding
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    .... text 0..1 string Medication primary text
    ... manufacturer 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    .... item[x] 1..1 CodeableConcept, Reference(Substance | Medication) The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    .... strength 0..1 Ratio Quantity/strength of ingredient present

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Medication.codeexampleSNOMEDCTMedicationCodes
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Medication 0..* Medication A medication in an Australian healthcare context
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business identifier for this medication
    ... code Σ 0..1 CodeableConcept Coding for the medicine
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... coding Σ 0..* Coding Code defined by a terminology system
    ..... id 0..1 string Unique id for inter-element referencing
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ..... system Σ 0..1 uri Identity of the terminology system
    ..... version Σ 0..1 string Version of the system - if relevant
    ..... code Σ 0..1 code Symbol in syntax defined by the system
    ..... display Σ 0..1 string Representation defined by the system
    ..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    .... text Σ 0..1 string Medication primary text
    ... status ?!Σ 0..1 code active | inactive | entered-in-error
    Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
    ... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
    ... form 0..1 CodeableConcept powder | tablets | capsule +
    Binding: Medication Form . (preferred)
    ... amount Σ 0..1 Ratio Amount of drug in package
    ... ingredient 0..* BackboneElement Active or inactive ingredient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... item[x] 1..1 The actual ingredient or content
    Binding: AMT Medicinal Product and Substances (preferred)
    ..... itemCodeableConcept CodeableConcept
    ..... itemReference Reference(Substance | Medication)
    .... isActive 0..1 boolean Active ingredient indicator
    .... strength 0..1 Ratio Quantity/strength of ingredient present
    ... batch 0..1 BackboneElement Details about packaged medications
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... lotNumber 0..1 string Identifier assigned to batch
    .... expirationDate 0..1 dateTime When batch will expire

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Medication.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Medication.codeexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    From the FHIR Standard
    Medication.statusrequiredMedication Status Codes
    http://hl7.org/fhir/ValueSet/medication-status|4.0.1
    From the FHIR Standard
    Medication.formpreferredMedicationForm .
    https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
    Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
    http://terminology.hl7.org.au/ValueSet/amt-mp-codes
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Medication

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron