AU Base Implementation Guide
4.2.1-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 4.2.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Medication

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medication Version: 4.2.1-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.codemay contain only the list of ingredients as text in Medication.code.text.
  • Non-coded support for other medicinal product information can be supported as follows:
    • ​brand name in Medication Brand Name extension
    • ​generic name in Medication Generic Name extension
    • item form and strength as part of medication definition in Medication.code.text
    • manufacturer in Medication.manufacturer.display

Potentially useful extensions:

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... code 0..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt 0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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 & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt Σ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
... ingredient 0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... strength 0..1RatioQuantity/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.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... 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:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... 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:amt Σ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... 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
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

Maturity: 2

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... code 0..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt 0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt Σ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
... ingredient 0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... strength 0..1RatioQuantity/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.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... 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:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... 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:amt Σ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... 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
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
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

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron