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-medicationadministration

AU Base Medication Administration [FMM Level 2]

This profile defines a medication administration structure including core localisation concepts for use 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.

Extensions

Extensions used in this profile:

  • MedicationAdministration: Administration Witness [1]

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on MedicationAdministration.

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
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... medication[x] 1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... coding 0..*(Slice Definition)Medication Codes
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
.... medication[x]:medicationReference 0..1Reference(AU Base Medication)Medication Reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*MedicationAdministrationA record of medication administered to 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal identifier
... instantiates ΣI0..*uriInstantiates protocol or definition
... partOf ΣI0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!ΣI1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required)
... statusReason I0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example)
... category I0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred)
... medication[x] ΣI1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded 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)Medication Codes
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..1stringPlain text representation of the concept
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Medication Reference
... subject ΣI1..1Reference(Patient | Group)Who received medication
... context I0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation I0..*Reference(Resource)Additional information to support administration
... effective[x] ΣI1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer ΣI0..*BackboneElementWho performed the medication administration and what they did
.... 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..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example)
.... actor ΣI1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode I0..*CodeableConceptReason administration performed
Binding: ReasonMedicationGivenCodes (example)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request I0..1Reference(MedicationRequest)Request administration performed against
... device I0..*Reference(Device)Device used to administer
... note I0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... 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
.... text I0..1stringFree text dosage instructions e.g. SIG
.... site I0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route I0..1CodeableConceptPath of substance into body
Binding: SNOMEDCTRouteCodes (example)
.... method I0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... dose I0..1SimpleQuantityAmount of medication per dose
.... rate[x] I0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory I0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... medication[x] 1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... coding 0..*(Slice Definition)Medication Codes
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
.... medication[x]:medicationReference 0..1Reference(AU Base Medication)Medication Reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*MedicationAdministrationA record of medication administered to 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal identifier
... instantiates ΣI0..*uriInstantiates protocol or definition
... partOf ΣI0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!ΣI1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required)
... statusReason I0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example)
... category I0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred)
... medication[x] ΣI1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded 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)Medication Codes
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..1stringPlain text representation of the concept
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Medication Reference
... subject ΣI1..1Reference(Patient | Group)Who received medication
... context I0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation I0..*Reference(Resource)Additional information to support administration
... effective[x] ΣI1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer ΣI0..*BackboneElementWho performed the medication administration and what they did
.... 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..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example)
.... actor ΣI1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode I0..*CodeableConceptReason administration performed
Binding: ReasonMedicationGivenCodes (example)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request I0..1Reference(MedicationRequest)Request administration performed against
... device I0..*Reference(Device)Device used to administer
... note I0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... 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
.... text I0..1stringFree text dosage instructions e.g. SIG
.... site I0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route I0..1CodeableConceptPath of substance into body
Binding: SNOMEDCTRouteCodes (example)
.... method I0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... dose I0..1SimpleQuantityAmount of medication per dose
.... rate[x] I0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory I0..*Reference(Provenance)A list of events of interest in the lifecycle

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-medicationadministration

none defined