AU Base Implementation Guide
4.1.0 - Trial Use Australia flag

This page is part of the AU Base Implementation Guide 4.1.0. It is based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Medication Administration

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationadministration Version: 4.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: AUBaseMedicationAdministration

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

This profile defines a medication administration structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

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

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration D0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... Slices for coding 0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference 0..1Reference(Medication)Medication Reference
... dosage
.... site 0..1CodeableConceptBody site administered to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... route 0..1CodeableConceptPath of substance into body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationAdministration.dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(Medication)Medication Reference
... subject Σ1..1Reference(Patient | Group)Who received medication
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] Σ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... medication[x]:medicationReference Σ0..1Reference(Medication)Medication Reference
... subject Σ1..1Reference(Patient | Group)Who received medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode 0..*CodeableConceptReason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... route 0..1CodeableConceptPath of substance into body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
MedicationAdministration.dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

This structure is derived from MedicationAdministration

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 2

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration D0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... Slices for medication[x] 1..1CodeableConcept, Reference(Medication)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... Slices for coding 0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference 0..1Reference(Medication)Medication Reference
... dosage
.... site 0..1CodeableConceptBody site administered to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... route 0..1CodeableConceptPath of substance into body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationAdministration.dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(Medication)Medication Reference
... subject Σ1..1Reference(Patient | Group)Who received medication
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationA record of medication administered to a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] Σ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... medication[x]:medicationReference Σ0..1Reference(Medication)Medication Reference
... subject Σ1..1Reference(Patient | Group)Who received medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode 0..*CodeableConceptReason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... route 0..1CodeableConceptPath of substance into body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
MedicationAdministration.dosage.sitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

This structure is derived from MedicationAdministration

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron