AU Base 1.1.1 on FHIR STU3

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-medicationdispense

AU Base Medication Dispense [FMM Level 2]

This profile defines a medication dispense structure including core localisation concepts for use as a dispense record in an Australian context.

Medication Reference/Coding

Full medication definitions as a Medication resource can be referenced or codings are use be used to define relevant drug/medication concepts. This includes coding as:

PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding.
GTIN - Global Trade Item Number, physical product reference.
AMT Code - Australian Medicines Terminology, national drug terminology.
MIMS Package - commonly used medicine coding.

Identifiers

These definitions represent common data held in the MedicationDispense.identifier element:

Local Dispense Identifier - dispenser system identifier for this record ^[1]

Extensions

Extensions used in this profile:

Grounds for Concurrent Supply ^[1]
Dispense Number ^[1]
MedicationDispense.medication.coding: Medication Type ^[1] - used to distinguish a level classification when the same coding system is used.
Medication Brand Name ^[1] - Not to be used if medicationReference is used. This text-only extension is supplied to support a brand name where no brand concept coding is available. Use medicationCodeableConcept if a brand concept coding is available.
Medication Generic Drug Name ^[1] - Not to be used if medicationReference is used. This text-only extension is supplied to support a generic name where no generic concept coding is available. Use medicationCodeableConcept if a generic concept coding is available.
NOTE: if extensions Medication Brand Name or Medication Generic Drug Name are used then medicationCodeableConcept must also be used.

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-medicationdispense

This profile defines a medication dispense structure including core localisation concepts for use as a dispense record in an Australian context.

This profile builds on MedicationDispense.

This profile was published on Fri Apr 26 09:07:00 AEST 2019 as a draft by Health Level Seven Australia (Medications WG).

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

Name	Card.	Type	Description & Constraints
MedicationDispense	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
extension	0..*	Extension	Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
dispense-number	0..1	integer	Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
medication-brand-name	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
identifier	0..*	(Slice Definition)	Slice: Unordered, Open by value:system, value:type
identifier:localDispenseIdentifier	0..*	Identifier	Local Dispense Identifier
type	1..1	CodeableConcept	Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: LDI
text	1..1	string	Fixed Value: Local Dispense Identifier
system	1..1	uri	Namespace for local dispense record identifier
value	1..1	string	Dispense record identifier
assigner	1..1	Reference(Organization)
display	1..1	string
medication[x]	1..1	(Slice Definition)	Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept	0..1	CodeableConcept	Coded Dispensed Medication
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
system	1..1	uri	Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
system	1..1	uri	Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
extension	0..*	Extension	Slice: Unordered, Open by value:url
medication-type	0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	1..1	uri	Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
system	1..1	uri	Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
medication[x]:medicationReference	0..1	Reference(AU Base Medication)	Dispensed Medication
authorizingPrescription	0..*	Reference(AU Base Medication Request)
dosageInstruction	0..*	AUBaseDosage
method
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
substitution	0..1	BackboneElement
reason	0..*	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	I	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	I	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
dispense-number	I	0..1	integer	Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
medication-brand-name	I	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	I	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	(Slice Definition)	External identifier Slice: Unordered, Open by value:system, value:type
identifier:localDispenseIdentifier		0..*	Identifier	Local Dispense Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Local Dispense Identifier
system	Σ	1..1	uri	Namespace for local dispense record identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense record identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
partOf		0..*	Reference(Procedure)	Event that dispense is part of
status	?!Σ	0..1	code	preparation \| in-progress \| on-hold \| completed \| entered-in-error \| stopped Binding: MedicationDispenseStatus (required)
category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispenseCategory (preferred)
medication[x]	Σ	1..1	(Slice Definition)	What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication Codes (example)
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMED CT Medication Codes (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	(Slice Definition)	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	Σ	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
medication-type		0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	Σ	0..1	Reference(AU Base Medication)	Dispensed Medication
subject	Σ	0..1	Reference(Patient \| Group)	Who the dispense is for
context		0..1	Reference(Encounter \| EpisodeOfCare)	Encounter / Episode associated with event
supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
performer	I	0..*	BackboneElement	Who performed event
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor		1..1	Reference(Practitioner \| Organization \| Patient \| Device \| RelatedPerson)	Individual who was performing
onBehalfOf		0..1	Reference(Organization)	Organization organization was acting for
authorizingPrescription		0..*	Reference(AU Base Medication Request)	Medication order that authorizes the dispense
type		0..1	CodeableConcept	Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example)
quantity		0..1	SimpleQuantity	Amount dispensed
daysSupply		0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenPrepared	Σ	0..1	dateTime	When product was packaged and reviewed
whenHandedOver		0..1	dateTime	When product was given out
destination		0..1	Reference(Location)	Where the medication was sent
receiver		0..*	Reference(Patient \| Practitioner)	Who collected the medication
note		0..*	Annotation	Information about the dispense
dosageInstruction	I	0..*	AUBaseDosage	Dosage information in an Australian healthcare context
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (preferred)
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	Σ	0..1	Timing	When medication should be administered
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
route	Σ	0..1	CodeableConcept	How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMED CT Administration Method Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	(Slice Definition)	Code defined by a terminology system Slice: Unordered, Open by value:system
text	Σ	0..1	string	Plain text representation of the concept
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
substitution	I	0..1	BackboneElement	Whether a substitution was performed on the dispense
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
type		0..1	CodeableConcept	Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example)
reason		0..*	CodeableConcept	Why was substitution made Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
responsibleParty		0..*	Reference(Practitioner)	Who is responsible for the substitution
detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
notDone		0..1	boolean	Whether the dispense was or was not performed
notDoneReason[x]		0..1		Why a dispense was not performed
notDoneReasonCodeableConcept			CodeableConcept
notDoneReasonReference			Reference(DetectedIssue)
eventHistory		0..*	Reference(Provenance)	A list of releveant lifecycle events
Documentation for this format

Differential View

Name	Card.	Type	Description & Constraints
MedicationDispense	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
extension	0..*	Extension	Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
dispense-number	0..1	integer	Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
medication-brand-name	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
identifier	0..*	(Slice Definition)	Slice: Unordered, Open by value:system, value:type
identifier:localDispenseIdentifier	0..*	Identifier	Local Dispense Identifier
type	1..1	CodeableConcept	Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required)
coding	1..1	Coding
system	1..1	uri	Fixed Value: http://hl7.org.au/fhir/v2/0203
code	1..1	code	Fixed Value: LDI
text	1..1	string	Fixed Value: Local Dispense Identifier
system	1..1	uri	Namespace for local dispense record identifier
value	1..1	string	Dispense record identifier
assigner	1..1	Reference(Organization)
display	1..1	string
medication[x]	1..1	(Slice Definition)	Slice: Unordered, Closed by type:$this
medication[x]:medicationCodeableConcept	0..1	CodeableConcept	Coded Dispensed Medication
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
system	1..1	uri	Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
system	1..1	uri	Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
extension	0..*	Extension	Slice: Unordered, Open by value:url
medication-type	0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	1..1	uri	Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
system	1..1	uri	Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
medication[x]:medicationReference	0..1	Reference(AU Base Medication)	Dispensed Medication
authorizingPrescription	0..*	Reference(AU Base Medication Request)
dosageInstruction	0..*	AUBaseDosage
method
coding	0..*	(Slice Definition)	Slice: Unordered, Open by value:system
substitution	0..1	BackboneElement
reason	0..*	CodeableConcept	Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MedicationDispense	I	0..*	MedicationDispense	A dispense record for a medication for a patient in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
grounds-for-concurrent-supply	I	0..1	Coding	Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
dispense-number	I	0..1	integer	Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
medication-brand-name	I	0..1	string	Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
medication-generic-name	I	0..1	string	Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	(Slice Definition)	External identifier Slice: Unordered, Open by value:system, value:type
identifier:localDispenseIdentifier		0..*	Identifier	Local Dispense Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Local Dispense Identifier
system	Σ	1..1	uri	Namespace for local dispense record identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense record identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organization that issued id (may be just text)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Text alternative for the resource
partOf		0..*	Reference(Procedure)	Event that dispense is part of
status	?!Σ	0..1	code	preparation \| in-progress \| on-hold \| completed \| entered-in-error \| stopped Binding: MedicationDispenseStatus (required)
category		0..1	CodeableConcept	Type of medication dispense Binding: MedicationDispenseCategory (preferred)
medication[x]	Σ	1..1	(Slice Definition)	What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication Codes (example)
medicationCodeableConcept			CodeableConcept
medicationReference			Reference(Medication)
medication[x]:medicationCodeableConcept	Σ	0..1	CodeableConcept	Coded Dispensed Medication Binding: SNOMED CT Medication Codes (example)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	(Slice Definition)	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	Σ	0..*	Coding	PBS Item Code Binding: PBS Medicines Item Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
medication-type		0..1	Coding	Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS Terminology (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Medication primary text
medication[x]:medicationReference	Σ	0..1	Reference(AU Base Medication)	Dispensed Medication
subject	Σ	0..1	Reference(Patient \| Group)	Who the dispense is for
context		0..1	Reference(Encounter \| EpisodeOfCare)	Encounter / Episode associated with event
supportingInformation		0..*	Reference(Resource)	Information that supports the dispensing of the medication
performer	I	0..*	BackboneElement	Who performed event
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
actor		1..1	Reference(Practitioner \| Organization \| Patient \| Device \| RelatedPerson)	Individual who was performing
onBehalfOf		0..1	Reference(Organization)	Organization organization was acting for
authorizingPrescription		0..*	Reference(AU Base Medication Request)	Medication order that authorizes the dispense
type		0..1	CodeableConcept	Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example)
quantity		0..1	SimpleQuantity	Amount dispensed
daysSupply		0..1	SimpleQuantity	Amount of medication expressed as a timing amount
whenPrepared	Σ	0..1	dateTime	When product was packaged and reviewed
whenHandedOver		0..1	dateTime	When product was given out
destination		0..1	Reference(Location)	Where the medication was sent
receiver		0..*	Reference(Patient \| Practitioner)	Who collected the medication
note		0..*	Annotation	Information about the dispense
dosageInstruction	I	0..*	AUBaseDosage	Dosage information in an Australian healthcare context
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
sequence	Σ	0..1	integer	The order of the dosage instructions
text	Σ	0..1	string	Free text dosage instructions e.g. SIG
additionalInstruction	Σ	0..*	CodeableConcept	Supplemental instruction - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (preferred)
patientInstruction	Σ	0..1	string	Patient or consumer oriented instructions
timing	Σ	0..1	Timing	When medication should be administered
asNeeded[x]	Σ	0..1		Take "as needed" (for x) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
site	Σ	0..1	CodeableConcept	Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
route	Σ	0..1	CodeableConcept	How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
method	Σ	0..1	CodeableConcept	Technique for administering medication Binding: SNOMED CT Administration Method Codes (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	(Slice Definition)	Code defined by a terminology system Slice: Unordered, Open by value:system
text	Σ	0..1	string	Plain text representation of the concept
dose[x]	Σ	0..1		Amount of medication per dose
doseRange			Range
doseQuantity			Quantity(SimpleQuantity)
maxDosePerPeriod	Σ	0..1	Ratio	Upper limit on medication per unit of time
maxDosePerAdministration	Σ	0..1	SimpleQuantity	Upper limit on medication per administration
maxDosePerLifetime	Σ	0..1	SimpleQuantity	Upper limit on medication per lifetime of the patient
rate[x]	Σ	0..1		Amount of medication per unit of time
rateRatio			Ratio
rateRange			Range
rateQuantity			Quantity(SimpleQuantity)
substitution	I	0..1	BackboneElement	Whether a substitution was performed on the dispense
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
wasSubstituted		1..1	boolean	Whether a substitution was or was not performed on the dispense
type		0..1	CodeableConcept	Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example)
reason		0..*	CodeableConcept	Why was substitution made Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
responsibleParty		0..*	Reference(Practitioner)	Who is responsible for the substitution
detectedIssue		0..*	Reference(DetectedIssue)	Clinical issue with action
notDone		0..1	boolean	Whether the dispense was or was not performed
notDoneReason[x]		0..1		Why a dispense was not performed
notDoneReasonCodeableConcept			CodeableConcept
notDoneReasonReference			Reference(DetectedIssue)
eventHistory		0..*	Reference(Provenance)	A list of releveant lifecycle events
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-medicationdispense

none defined