AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base MedicationAdministration

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationadministration Version: 7.0.0-ci-build
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.

The GTIN (Global Trade Item Number) additional binding on MedicationAdministration.medicationCodeableConcept was removed in AU Base 7.0.0 as the value set definition that was used, GTIN, was determined to be incorrect. Further community discussion is taking place to determine an appropriate replacement. In the interim, implementers representing GTIN codes are advised to use the appropriate canonical URL https://www.gs1.org/gtin in preference to the previous definition. Feedback is sought on use of GTIN as an identifier and/or a code from the implementer community.

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.medicationCodeableConcept, this profile includes coding as:
    • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding
    • AMT Medicines - Australian Medicines Terminology, national drug terminology
    • MIMS Package - commonly used medicine coding
  • If a medication is compounded and is a list of ingredients, MedicationAdministration.medicationCodeableConcept 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.medicationCodeableConcept and use of extensions, see guidance on AU Base Medication.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    MedicationAdministration.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    MedicationAdministration.status This element is a modifier element. This element is included in summaries. 1..1 code in-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.
    MedicationAdministration.Slices for medication[x] This element is included in summaries. 1..1 Medication Detail
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
    MedicationAdministration.Slices for medication[x].medicationCodeableConcept CodeableConcept
    MedicationAdministration.Slices for medication[x].medicationReference Reference(Medication)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept This element is included in summaries. 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding This element is included in summaries. 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference This element is included in summaries. 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.subject This element is included in summaries. 1..1 Reference(Patient | Group) Who received medication
    MedicationAdministration.effective[x] This element is included in summaries. 1..1 Start and end time of administration
    MedicationAdministration.effective[x].effectiveDateTime dateTime
    MedicationAdministration.effective[x].effectivePeriod Period

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error MedicationAdministration If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from MedicationAdministration

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.Slices for medication[x] 1..1 CodeableConcept, Reference(Medication) Medication Detail
    Slice: Unordered, Closed by type:$this
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.dosage
    MedicationAdministration.dosage.site 0..1 CodeableConcept Body site administered to
    Binding: Body Site (preferred)
    MedicationAdministration.dosage.route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration (preferred)
    MedicationAdministration.dosage.method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example Not State Unknown
    MedicationAdministration.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.method Base preferred Not State Unknown
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.id This element is included in summaries. 0..1 id Logical id of this artifact
    MedicationAdministration.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    MedicationAdministration.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    MedicationAdministration.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    MedicationAdministration.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    MedicationAdministration.contained 0..* Resource Contained, inline Resources
    MedicationAdministration.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    MedicationAdministration.identifier 0..* Identifier External identifier
    MedicationAdministration.instantiates This element is included in summaries. 0..* uri Instantiates protocol or definition
    MedicationAdministration.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
    MedicationAdministration.status This element is a modifier element. This element is included in summaries. 1..1 code in-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.
    MedicationAdministration.statusReason 0..* CodeableConcept Reason administration not performed
    Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
    MedicationAdministration.category 0..1 CodeableConcept Type of medication usage
    Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
    MedicationAdministration.Slices for medication[x] This element is included in summaries. 1..1 Medication Detail
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
    MedicationAdministration.Slices for medication[x].medicationCodeableConcept CodeableConcept
    MedicationAdministration.Slices for medication[x].medicationReference Reference(Medication)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept This element is included in summaries. 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding This element is included in summaries. 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.system This element is included in summaries. 0..1 uri Identity of the terminology system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.version This element is included in summaries. 0..1 string Version of the system - if relevant
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.display This element is included in summaries. 0..1 string Representation defined by the system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference This element is included in summaries. 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.subject This element is included in summaries. 1..1 Reference(Patient | Group) Who received medication
    MedicationAdministration.context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
    MedicationAdministration.supportingInformation 0..* Reference(Resource) Additional information to support administration
    MedicationAdministration.effective[x] This element is included in summaries. 1..1 Start and end time of administration
    MedicationAdministration.effective[x].effectiveDateTime dateTime
    MedicationAdministration.effective[x].effectivePeriod Period
    MedicationAdministration.performer This element is included in summaries. 0..* BackboneElement Who performed the medication administration and what they did
    MedicationAdministration.performer.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.performer.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    MedicationAdministration.performer.function 0..1 CodeableConcept Type of performance
    Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.
    MedicationAdministration.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
    MedicationAdministration.reasonCode 0..* CodeableConcept Reason administration performed
    Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
    MedicationAdministration.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
    MedicationAdministration.request 0..1 Reference(MedicationRequest) Request administration performed against
    MedicationAdministration.device 0..* Reference(Device) Device used to administer
    MedicationAdministration.note 0..* Annotation Information about the administration
    MedicationAdministration.dosage C 0..1 BackboneElement Details of how medication was taken
    Constraints: mad-1
    MedicationAdministration.dosage.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.dosage.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    MedicationAdministration.dosage.text 0..1 string Free text dosage instructions e.g. SIG
    MedicationAdministration.dosage.site 0..1 CodeableConcept Body site administered to
    Binding: Body Site (preferred)
    MedicationAdministration.dosage.route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration (preferred)
    MedicationAdministration.dosage.method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    MedicationAdministration.dosage.dose C 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
    Constraints: sqty-1
    MedicationAdministration.dosage.rate[x] 0..1 Dose quantity per unit of time
    MedicationAdministration.dosage.rate[x].rateRatio Ratio
    MedicationAdministration.dosage.rate[x].rateQuantity Quantity(SimpleQuantity)
    MedicationAdministration.eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
    MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.method Base preferred SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error MedicationAdministration If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()
    sqty-1 error MedicationAdministration.dosage.dose The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from MedicationAdministration

    Summary

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

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

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    MedicationAdministration.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    MedicationAdministration.status This element is a modifier element. This element is included in summaries. 1..1 code in-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.
    MedicationAdministration.Slices for medication[x] This element is included in summaries. 1..1 Medication Detail
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
    MedicationAdministration.Slices for medication[x].medicationCodeableConcept CodeableConcept
    MedicationAdministration.Slices for medication[x].medicationReference Reference(Medication)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept This element is included in summaries. 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding This element is included in summaries. 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference This element is included in summaries. 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.subject This element is included in summaries. 1..1 Reference(Patient | Group) Who received medication
    MedicationAdministration.effective[x] This element is included in summaries. 1..1 Start and end time of administration
    MedicationAdministration.effective[x].effectiveDateTime dateTime
    MedicationAdministration.effective[x].effectivePeriod Period

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error MedicationAdministration If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Differential View

    This structure is derived from MedicationAdministration

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.Slices for medication[x] 1..1 CodeableConcept, Reference(Medication) Medication Detail
    Slice: Unordered, Closed by type:$this
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.dosage
    MedicationAdministration.dosage.site 0..1 CodeableConcept Body site administered to
    Binding: Body Site (preferred)
    MedicationAdministration.dosage.route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration (preferred)
    MedicationAdministration.dosage.method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example Not State Unknown
    MedicationAdministration.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.method Base preferred Not State Unknown

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    MedicationAdministration 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    MedicationAdministration.id This element is included in summaries. 0..1 id Logical id of this artifact
    MedicationAdministration.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    MedicationAdministration.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    MedicationAdministration.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    MedicationAdministration.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    MedicationAdministration.contained 0..* Resource Contained, inline Resources
    MedicationAdministration.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    MedicationAdministration.identifier 0..* Identifier External identifier
    MedicationAdministration.instantiates This element is included in summaries. 0..* uri Instantiates protocol or definition
    MedicationAdministration.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
    MedicationAdministration.status This element is a modifier element. This element is included in summaries. 1..1 code in-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.
    MedicationAdministration.statusReason 0..* CodeableConcept Reason administration not performed
    Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
    MedicationAdministration.category 0..1 CodeableConcept Type of medication usage
    Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
    MedicationAdministration.Slices for medication[x] This element is included in summaries. 1..1 Medication Detail
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
    MedicationAdministration.Slices for medication[x].medicationCodeableConcept CodeableConcept
    MedicationAdministration.Slices for medication[x].medicationReference Reference(Medication)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept This element is included in summaries. 0..1 CodeableConcept Coded Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding This element is included in summaries. 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension Content/Rules for all slices
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.Slices for extension.extension:medicationType 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.system This element is included in summaries. 0..1 uri Identity of the terminology system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.version This element is included in summaries. 0..1 string Version of the system - if relevant
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.display This element is included in summaries. 0..1 string Representation defined by the system
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.coding.coding:All Slices.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    MedicationAdministration.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
    MedicationAdministration.Slices for medication[x].medication[x]:medicationReference This element is included in summaries. 0..1 Reference(Medication) Medication Reference
    MedicationAdministration.subject This element is included in summaries. 1..1 Reference(Patient | Group) Who received medication
    MedicationAdministration.context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
    MedicationAdministration.supportingInformation 0..* Reference(Resource) Additional information to support administration
    MedicationAdministration.effective[x] This element is included in summaries. 1..1 Start and end time of administration
    MedicationAdministration.effective[x].effectiveDateTime dateTime
    MedicationAdministration.effective[x].effectivePeriod Period
    MedicationAdministration.performer This element is included in summaries. 0..* BackboneElement Who performed the medication administration and what they did
    MedicationAdministration.performer.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.performer.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    MedicationAdministration.performer.function 0..1 CodeableConcept Type of performance
    Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.
    MedicationAdministration.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
    MedicationAdministration.reasonCode 0..* CodeableConcept Reason administration performed
    Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
    MedicationAdministration.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
    MedicationAdministration.request 0..1 Reference(MedicationRequest) Request administration performed against
    MedicationAdministration.device 0..* Reference(Device) Device used to administer
    MedicationAdministration.note 0..* Annotation Information about the administration
    MedicationAdministration.dosage C 0..1 BackboneElement Details of how medication was taken
    Constraints: mad-1
    MedicationAdministration.dosage.id 0..1 string Unique id for inter-element referencing
    MedicationAdministration.dosage.extension 0..* Extension Additional content defined by implementations
    MedicationAdministration.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    MedicationAdministration.dosage.text 0..1 string Free text dosage instructions e.g. SIG
    MedicationAdministration.dosage.site 0..1 CodeableConcept Body site administered to
    Binding: Body Site (preferred)
    MedicationAdministration.dosage.route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration (preferred)
    MedicationAdministration.dosage.method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    MedicationAdministration.dosage.dose C 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
    Constraints: sqty-1
    MedicationAdministration.dosage.rate[x] 0..1 Dose quantity per unit of time
    MedicationAdministration.dosage.rate[x].rateRatio Ratio
    MedicationAdministration.dosage.rate[x].rateQuantity Quantity(SimpleQuantity)
    MedicationAdministration.eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
    MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​medication[x]:medicationCodeableConcept Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
    MedicationAdministration.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
    MedicationAdministration.​dosage.method Base preferred SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error MedicationAdministration If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error MedicationAdministration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice MedicationAdministration A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    mad-1 error MedicationAdministration.dosage SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()
    sqty-1 error MedicationAdministration.dosage.dose The comparator is not used on a SimpleQuantity comparator.empty()

    This structure is derived from MedicationAdministration

    Summary

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

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

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron