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.medicationCodeableConcept, this profile includes coding as:
  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding
  • Medication Package Global Trade Item Number - Global Trade Item Number (GTIN) physical product reference
  • AMT Medicines - Australian Medicines Terminology, national drug terminology
  • MIMS Package - commonly used medicine coding
• If a medication is compounded and is a list of ingredients, MedicationDispense.medicationCodeableConcept 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.medicationCodeableConcept 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:

• MedicationDispense: Medication Brand Name
• MedicationDispense: Medication Generic Name

Changes since version 6.0.0:

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense	C	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1
MedicationDispense.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
MedicationDispense.identifier		0..*	Identifier , AULocalDispenseIdentifier	External identifier
MedicationDispense.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preparation | 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.
MedicationDispense.Slices for medication[x]	Σ This element is included in summaries.	1..1		What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medicationCodeableConcept			CodeableConcept
MedicationDispense.Slices for medication[x].medicationReference			Reference(Medication)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept	Σ This element is included in summaries.	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text	Σ This element is included in summaries.	0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference	Σ This element is included in summaries.	0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.status	Base	required	Medication dispense status codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	MedicationDispense	If 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-4	error	MedicationDispense	If 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-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared	whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense		0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.identifier		0..*	Identifier, AULocalDispenseIdentifier	External identifier
MedicationDispense.Slices for medication[x]		1..1	CodeableConcept, Reference(Medication)	What medication was supplied Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept		0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension				Content/Rules for all slices
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension.extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text		0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference		0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example		Not State	Unknown
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense	C	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1
MedicationDispense.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
MedicationDispense.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
MedicationDispense.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
MedicationDispense.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
MedicationDispense.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
MedicationDispense.contained		0..*	Resource	Contained, inline Resources
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
MedicationDispense.identifier		0..*	Identifier , AULocalDispenseIdentifier	External identifier
MedicationDispense.partOf		0..*	Reference(Procedure)	Event that dispense is part of
MedicationDispense.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preparation | 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.
MedicationDispense.statusReason[x]		0..1		Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
MedicationDispense.statusReason[x].statusReasonCodeableConcept			CodeableConcept
MedicationDispense.statusReason[x].statusReasonReference			Reference(DetectedIssue)
MedicationDispense.category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
MedicationDispense.Slices for medication[x]	Σ This element is included in summaries.	1..1		What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medicationCodeableConcept			CodeableConcept
MedicationDispense.Slices for medication[x].medicationReference			Reference(Medication)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept	Σ This element is included in summaries.	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension				Content/Rules for all slices
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension.extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text	Σ This element is included in summaries.	0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference	Σ This element is included in summaries.	0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.subject	Σ This element is included in summaries.	0..1	Reference(Patient | Group)	Who the dispense is for
MedicationDispense.context		0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with event
MedicationDispense.supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
MedicationDispense.performer		0..*	BackboneElement	Who performed event
MedicationDispense.performer.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.performer.extension		0..*	Extension	Additional content defined by implementations
MedicationDispense.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.performer.function		0..1	CodeableConcept	Who 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.
MedicationDispense.performer.actor		1..1	Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)	Individual who was performing
MedicationDispense.location		0..1	Reference(Location)	Where the dispense occurred
MedicationDispense.authorizingPrescription		0..*	Reference(MedicationRequest)	Medication order that authorizes the dispense
MedicationDispense.type		0..1	CodeableConcept	Trial 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.
MedicationDispense.quantity	C	0..1	SimpleQuantity(4.0.1)	Amount dispensed Constraints: sqty-1
MedicationDispense.daysSupply	C	0..1	SimpleQuantity(4.0.1)	Amount of medication expressed as a timing amount Constraints: sqty-1
MedicationDispense.whenPrepared	Σ This element is included in summaries.	0..1	dateTime	When product was packaged and reviewed
MedicationDispense.whenHandedOver		0..1	dateTime	When product was given out
MedicationDispense.destination		0..1	Reference(Location)	Where the medication was sent
MedicationDispense.receiver		0..*	Reference(Patient | Practitioner)	Who collected the medication
MedicationDispense.note		0..*	Annotation	Information about the dispense
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.substitution.extension		0..*	Extension	Additional content defined by implementations
MedicationDispense.substitution.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.type		0..1	CodeableConcept	Code 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.
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
MedicationDispense.substitution.responsibleParty		0..*	Reference(Practitioner | PractitionerRole)	Who is responsible for the substitution
MedicationDispense.detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
MedicationDispense.eventHistory		0..*	Reference(Provenance)	A list of relevant lifecycle events
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
MedicationDispense.status	Base	required	Medication dispense status codes	📍4.0.1	FHIR Std.
MedicationDispense.statusReason[x]	Base	example	Medication dispense status reason codes	📍4.0.1	FHIR Std.
MedicationDispense.category	Base	preferred	Medication dispense category codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.performer.​function	Base	example	Medication dispense performer function codes	📍4.0.1	FHIR Std.
MedicationDispense.type	Base	example	ActPharmacySupplyType	📦3.0.0	THO v7.4
MedicationDispense.substitution.​type	Base	example	ActSubstanceAdminSubstitutionCode	📦3.0.0	THO v7.4
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	MedicationDispense	If 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-4	error	MedicationDispense	If 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-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared	whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
sqty-1	error	MedicationDispense.quantity, MedicationDispense.daysSupply	The comparator is not used on a SimpleQuantity	comparator.empty()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense	C	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1
MedicationDispense.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
MedicationDispense.identifier		0..*	Identifier , AULocalDispenseIdentifier	External identifier
MedicationDispense.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preparation | 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.
MedicationDispense.Slices for medication[x]	Σ This element is included in summaries.	1..1		What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medicationCodeableConcept			CodeableConcept
MedicationDispense.Slices for medication[x].medicationReference			Reference(Medication)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept	Σ This element is included in summaries.	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text	Σ This element is included in summaries.	0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference	Σ This element is included in summaries.	0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.status	Base	required	Medication dispense status codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	MedicationDispense	If 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-4	error	MedicationDispense	If 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-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared	whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Differential View

This structure is derived from MedicationDispense

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense		0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.identifier		0..*	Identifier, AULocalDispenseIdentifier	External identifier
MedicationDispense.Slices for medication[x]		1..1	CodeableConcept, Reference(Medication)	What medication was supplied Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept		0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension				Content/Rules for all slices
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension.extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text		0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference		0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example		Not State	Unknown
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MedicationDispense	C	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1
MedicationDispense.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
MedicationDispense.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
MedicationDispense.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
MedicationDispense.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
MedicationDispense.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
MedicationDispense.contained		0..*	Resource	Contained, inline Resources
MedicationDispense.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for extension.extension:subsidisedConcurrentSupply		0..1	Coding	Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required)
MedicationDispense.Slices for extension.extension:dispenseNumber		0..1	integer	Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
MedicationDispense.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
MedicationDispense.identifier		0..*	Identifier , AULocalDispenseIdentifier	External identifier
MedicationDispense.partOf		0..*	Reference(Procedure)	Event that dispense is part of
MedicationDispense.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	preparation | 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.
MedicationDispense.statusReason[x]		0..1		Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
MedicationDispense.statusReason[x].statusReasonCodeableConcept			CodeableConcept
MedicationDispense.statusReason[x].statusReasonReference			Reference(DetectedIssue)
MedicationDispense.category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
MedicationDispense.Slices for medication[x]	Σ This element is included in summaries.	1..1		What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medicationCodeableConcept			CodeableConcept
MedicationDispense.Slices for medication[x].medicationReference			Reference(Medication)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept	Σ This element is included in summaries.	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension				Content/Rules for all slices
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.Slices for extension.extension:medicationClass		0..1	Coding	Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required)
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
MedicationDispense.Slices for medication[x].medication[x]:medicationCodeableConcept.text	Σ This element is included in summaries.	0..1	string	Medication primary text
MedicationDispense.Slices for medication[x].medication[x]:medicationReference	Σ This element is included in summaries.	0..1	Reference(Medication)	Dispensed Medication
MedicationDispense.subject	Σ This element is included in summaries.	0..1	Reference(Patient | Group)	Who the dispense is for
MedicationDispense.context		0..1	Reference(Encounter | EpisodeOfCare)	Encounter / Episode associated with event
MedicationDispense.supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
MedicationDispense.performer		0..*	BackboneElement	Who performed event
MedicationDispense.performer.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.performer.extension		0..*	Extension	Additional content defined by implementations
MedicationDispense.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.performer.function		0..1	CodeableConcept	Who 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.
MedicationDispense.performer.actor		1..1	Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)	Individual who was performing
MedicationDispense.location		0..1	Reference(Location)	Where the dispense occurred
MedicationDispense.authorizingPrescription		0..*	Reference(MedicationRequest)	Medication order that authorizes the dispense
MedicationDispense.type		0..1	CodeableConcept	Trial 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.
MedicationDispense.quantity	C	0..1	SimpleQuantity(4.0.1)	Amount dispensed Constraints: sqty-1
MedicationDispense.daysSupply	C	0..1	SimpleQuantity(4.0.1)	Amount of medication expressed as a timing amount Constraints: sqty-1
MedicationDispense.whenPrepared	Σ This element is included in summaries.	0..1	dateTime	When product was packaged and reviewed
MedicationDispense.whenHandedOver		0..1	dateTime	When product was given out
MedicationDispense.destination		0..1	Reference(Location)	Where the medication was sent
MedicationDispense.receiver		0..*	Reference(Patient | Practitioner)	Who collected the medication
MedicationDispense.note		0..*	Annotation	Information about the dispense
MedicationDispense.dosageInstruction		0..*	AUBaseDosage	How the medication is to be used by the patient or administered by the caregiver
MedicationDispense.substitution		0..1	BackboneElement	Whether a substitution was performed on the dispense
MedicationDispense.substitution.id		0..1	string	Unique id for inter-element referencing
MedicationDispense.substitution.extension		0..*	Extension	Additional content defined by implementations
MedicationDispense.substitution.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
MedicationDispense.substitution.wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
MedicationDispense.substitution.type		0..1	CodeableConcept	Code 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.
MedicationDispense.substitution.reason		0..1	CodeableConcept	Why was substitution made Binding: Medicine Substitution Reason (preferred)
MedicationDispense.substitution.responsibleParty		0..*	Reference(Practitioner | PractitionerRole)	Who is responsible for the substitution
MedicationDispense.detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
MedicationDispense.eventHistory		0..*	Reference(Provenance)	A list of relevant lifecycle events
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
MedicationDispense.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
MedicationDispense.status	Base	required	Medication dispense status codes	📍4.0.1	FHIR Std.
MedicationDispense.statusReason[x]	Base	example	Medication dispense status reason codes	📍4.0.1	FHIR Std.
MedicationDispense.category	Base	preferred	Medication dispense category codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.medication[x]:medicationCodeableConcept	Base	example	SNOMED CT Medication Codes	📍4.0.1	FHIR Std.
MedicationDispense.performer.​function	Base	example	Medication dispense performer function codes	📍4.0.1	FHIR Std.
MedicationDispense.type	Base	example	ActPharmacySupplyType	📦3.0.0	THO v7.4
MedicationDispense.substitution.​type	Base	example	ActSubstanceAdminSubstitutionCode	📦3.0.0	THO v7.4
MedicationDispense.substitution.​reason	Base	preferred	Medicine Substitution Reason	⏿1.0.1	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	MedicationDispense	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	MedicationDispense	If 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-4	error	MedicationDispense	If 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-5	error	MedicationDispense	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	MedicationDispense	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
mdd-1	error	MedicationDispense	whenHandedOver cannot be before whenPrepared	whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
sqty-1	error	MedicationDispense.quantity, MedicationDispense.daysSupply	The comparator is not used on a SimpleQuantity	comparator.empty()

This structure is derived from MedicationDispense

Summary

Structures

This structure refers to these other structures:

• AU Base Dosage (http://hl7.org.au/fhir/StructureDefinition/au-dosage)

Extensions

This structure refers to these extensions:

• http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
• http://hl7.org.au/fhir/StructureDefinition/dispense-number
• http://hl7.org.au/fhir/StructureDefinition/medication-type

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MedicationDispense.medication[x] (Closed)

Maturity: 2