AU Base Implementation Guide
4.2.0-preview - Working Australia flag

This page is part of the Australian Base IG (v4.2.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Medication Dispense

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationdispense Version: 4.2.0-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: AUBaseMedicationDispense

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

This profile defines a medication dispense structure that localises core concepts, including identifiers and 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:

  • When identifying a medication, this resource can use either a code or refer to a Medication resource.
  • If making use of MedicationDispense.code, this profile includes coding as:
  • If a medication is compounded and is a list of ingredients, MedicationDispense.code is still present and may contain only the list of ingredients as text in MedicationDispense.code.text.
  • Where additional medicinal product information is needed, MedicationDispense.medicationReference is preferred to MedicationDispense.code and use of extensions, see guidance on AU Base Medication.
  • See each Identifier profile page for guidance related to that identifier type.

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 MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... dispenseNumber 0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Dispensed Medication
..... 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
.... medication[x]:medicationReference 0..1Reference(Medication)Dispensed Medication
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
mdd-1: whenHandedOver cannot be before whenPrepared
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AULocalDispenseIdentifierExternal identifier
... status ?!Σ1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... Slices for medication[x] Σ1..1What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

..... 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
.... medication[x]:medicationReference Σ0..1Reference(Medication)Dispensed Medication
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA 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()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... dispenseNumber 0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AULocalDispenseIdentifierExternal identifier
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!Σ1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

..... 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
.... medication[x]:medicationReference Σ0..1Reference(Medication)Dispensed Medication
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer 0..*BackboneElementWho performed event
.... 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
.... function 0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor 1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)Individual who was performing
... location 0..1Reference(Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... 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
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)
.... responsibleParty 0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA 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()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationDispense.medication[x] is sliced based on the value of type:$this (Closed)
  • The element MedicationDispense.medication[x].coding is sliced based on the value of value:system

Maturity: 2

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... dispenseNumber 0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Dispensed Medication
..... 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
.... medication[x]:medicationReference 0..1Reference(Medication)Dispensed Medication
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
mdd-1: whenHandedOver cannot be before whenPrepared
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AULocalDispenseIdentifierExternal identifier
... status ?!Σ1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... Slices for medication[x] Σ1..1What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

..... 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
.... medication[x]:medicationReference Σ0..1Reference(Medication)Dispensed Medication
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA 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()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... subsidisedConcurrentSupply 0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
Binding: Concurrent Supply Grounds . (required)
... dispenseNumber 0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*Identifier, AULocalDispenseIdentifierExternal identifier
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!Σ1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

..... 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
.... medication[x]:medicationReference Σ0..1Reference(Medication)Dispensed Medication
... subject Σ0..1Reference(Patient | Group)Who the dispense is for
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer 0..*BackboneElementWho performed event
.... 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
.... function 0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor 1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)Individual who was performing
... location 0..1Reference(Location)Where the dispense occurred
... authorizingPrescription 0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... 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
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..1CodeableConceptWhy was substitution made
Binding: Medicine Substitution Reason . (preferred)
.... responsibleParty 0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationDispense.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationDispense.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationDispense.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonpreferredMedicineSubstitutionReason .
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA 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()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationDispense.medication[x] is sliced based on the value of type:$this (Closed)
  • The element MedicationDispense.medication[x].coding is sliced based on the value of value:system

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron