Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. 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 Tue Oct 22 00:00:00 AEDT 2019 as a draft by Health Level Seven Australia (Medications WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply 0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... dispense-number 0..1integerNumber of this Dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier 0..*(Slice Definition)External identifier
Slice: Unordered, Open by value:system, value:type
.... identifier:localDispenseIdentifier 0..*IdentifierLocal Dispense Identifier
..... type 1..1CodeableConceptCoded identifier type for local dispense identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
...... text 1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
..... system 1..1uriNamespace for local dispense record identifier
..... value 1..1stringDispense record identifier
..... assigner 1..1Reference(Organization)Organization that issued id (may be just text)
...... display 1..1stringText alternative for the resource
... medication[x] 1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Dispensed Medication
..... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (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(AU Base 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: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... dispense-number I0..1integerNumber of this Dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*(Slice Definition)External identifier
Slice: Unordered, Open by value:system, value:type
.... identifier:localDispenseIdentifier I0..*IdentifierLocal Dispense Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptCoded identifier type for local dispense identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
..... system ΣI1..1uriNamespace for local dispense record identifier
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringDispense record identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
... partOf I0..*Reference(Procedure)Event that dispense is part of
... status ?!ΣI1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
... statusReason[x] I0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example)
.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category I0..1CodeableConceptType of medication dispense
Binding: MedicationDispense Category Codes (preferred)
... medication[x] ΣI1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringMedication primary text
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Dispensed Medication
... subject ΣI0..1Reference(Patient | Group)Who the dispense is for
... context I0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation I0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function I0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example)
.... actor I1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)Individual who was performing
... location I0..1Reference(Location)Where the dispense occurred
... authorizingPrescription I0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... type I0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: V3 Value SetActPharmacySupplyType (example)
... quantity I0..1SimpleQuantityAmount dispensed
... daysSupply I0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ΣI0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver I0..1dateTimeWhen product was given out
... destination I0..1Reference(Location)Where the medication was sent
... receiver I0..*Reference(Patient | Practitioner)Who collected the medication
... note I0..*AnnotationInformation about the dispense
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted I1..1booleanWhether a substitution was or was not performed on the dispense
.... type I0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
.... reason I0..1CodeableConceptWhy was substitution made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
.... responsibleParty I0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue I0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory I0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply 0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... dispense-number 0..1integerNumber of this Dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... medication-brand-name 0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... identifier 0..*(Slice Definition)External identifier
Slice: Unordered, Open by value:system, value:type
.... identifier:localDispenseIdentifier 0..*IdentifierLocal Dispense Identifier
..... type 1..1CodeableConceptCoded identifier type for local dispense identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
...... text 1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
..... system 1..1uriNamespace for local dispense record identifier
..... value 1..1stringDispense record identifier
..... assigner 1..1Reference(Organization)Organization that issued id (may be just text)
...... display 1..1stringText alternative for the resource
... medication[x] 1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Dispensed Medication
..... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Medicines 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 for Medicines (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type 0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS Terminology (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(AU Base 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: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseA dispense record for a medication for a patient in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for Concurrent Supply of Medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
... dispense-number I0..1integerNumber of this Dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*(Slice Definition)External identifier
Slice: Unordered, Open by value:system, value:type
.... identifier:localDispenseIdentifier I0..*IdentifierLocal Dispense Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptCoded identifier type for local dispense identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
..... system ΣI1..1uriNamespace for local dispense record identifier
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringDispense record identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI1..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
... partOf I0..*Reference(Procedure)Event that dispense is part of
... status ?!ΣI1..1codepreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required)
... statusReason[x] I0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example)
.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category I0..1CodeableConceptType of medication dispense
Binding: MedicationDispense Category Codes (preferred)
... medication[x] ΣI1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Dispensed Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringMedication primary text
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Dispensed Medication
... subject ΣI0..1Reference(Patient | Group)Who the dispense is for
... context I0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation I0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function I0..1CodeableConceptWho performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example)
.... actor I1..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)Individual who was performing
... location I0..1Reference(Location)Where the dispense occurred
... authorizingPrescription I0..*Reference(AU Base Medication Request)Medication order that authorizes the dispense
... type I0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: V3 Value SetActPharmacySupplyType (example)
... quantity I0..1SimpleQuantityAmount dispensed
... daysSupply I0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ΣI0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver I0..1dateTimeWhen product was given out
... destination I0..1Reference(Location)Where the medication was sent
... receiver I0..*Reference(Patient | Practitioner)Who collected the medication
... note I0..*AnnotationInformation about the dispense
... dosageInstruction I0..*AUBaseDosageDosage information in an Australian healthcare context
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted I1..1booleanWhether a substitution was or was not performed on the dispense
.... type I0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
.... reason I0..1CodeableConceptWhy was substitution made
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1 (preferred)
.... responsibleParty I0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue I0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory I0..*Reference(Provenance)A list of relevant lifecycle events

doco 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