Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core MedicationAdministration

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medicationadministration-core-1 Version: 0.0.5
Draft as of 2024-09-12 Computable Name: ADHAMedicationAdministrationCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of a medication administration for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend MedicationAdministration that are supported.

This profile is designed to set a core MedicationAdministration standard for:

  • Query medications administered for a patient (current and historical)
  • Record or update a medication administration record for a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • See the Medicine information section for guidance.
  • MedicationAdministration resources can represent a medication using either a code, or reference a Medication resource.
    • When referencing a Medication resource, it is preferred the resource is contained but it may be an external resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* AUBaseMedicationAdministration A record of medication administered to a patient in an Australian healthcare context
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... statusReason S 0..* CodeableConcept Reason administration not performed
... category S 0..1 CodeableConcept Type of medication usage
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Medication
..... Slices for coding 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs S 0..* Coding Medication Codes
...... coding:amt S 0..* Coding Medication Codes
.... medication[x]:medicationReference 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... performer SC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... function S 0..1 CodeableConcept Type of performance
.... actor SC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... note S 0..* Annotation Information about the administration
... dosage S 0..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
.... route S 0..1 CodeableConcept Path of substance into body
.... method S 0..1 CodeableConcept How drug was administered
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Ratio, SimpleQuantity Dose quantity per unit of time

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* AUBaseMedicationAdministration A record of medication administered to a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 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.

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

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding Medication Codes
...... coding:amt SΣ 0..* Coding Medication Codes
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... medication[x]:medicationReference Σ 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SΣC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... note S 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
Binding: Body Site . (preferred)
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration . (preferred)
.... method S 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* AUBaseMedicationAdministration A record of medication administered to a patient in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 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.

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


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

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding Medication Codes
...... coding:amt SΣ 0..* Coding Medication Codes
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Medication primary text
.... medication[x]:medicationReference Σ 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SΣC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note S 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
Binding: Body Site . (preferred)
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration . (preferred)
.... method S 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Differential View

This structure is derived from AUBaseMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* AUBaseMedicationAdministration A record of medication administered to a patient in an Australian healthcare context
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... statusReason S 0..* CodeableConcept Reason administration not performed
... category S 0..1 CodeableConcept Type of medication usage
.... medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Medication
..... Slices for coding 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs S 0..* Coding Medication Codes
...... coding:amt S 0..* Coding Medication Codes
.... medication[x]:medicationReference 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... performer SC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... function S 0..1 CodeableConcept Type of performance
.... actor SC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... note S 0..* Annotation Information about the administration
... dosage S 0..1 BackboneElement Details of how medication was taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
.... route S 0..1 CodeableConcept Path of substance into body
.... method S 0..1 CodeableConcept How drug was administered
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Ratio, SimpleQuantity Dose quantity per unit of time

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* AUBaseMedicationAdministration A record of medication administered to a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 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.

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

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding Medication Codes
...... coding:amt SΣ 0..* Coding Medication Codes
....... Slices for extension Content/Rules for all slices
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... medication[x]:medicationReference Σ 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SΣC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... note S 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
Binding: Body Site . (preferred)
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration . (preferred)
.... method S 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Snapshot View

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

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 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.

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


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

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ 0..* Coding Medication Codes
...... coding:amt SΣ 0..* Coding Medication Codes
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Medication primary text
.... medication[x]:medicationReference Σ 0..1 Reference(ADHA Core Medication) Medication Reference
... subject SΣC 1..1 Reference(ADHA Core Patient) Who received medication
inv-dh-mad-01: At least reference or a valid identifier shall be present
... context S 0..1 Reference(ADHA Core Encounter) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣC 0..* BackboneElement Who performed the medication administration and what they did
inv-dh-mad-02: If present, an actor shall at least have a reference, an identifier or a display
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor SΣC 1..1 Reference(ADHA Authoring PractitionerRole | ADHA Authoring RelatedPerson | ADHA Core Patient) Who performed the medication administration
... reasonCode S 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note S 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... site S 0..1 CodeableConcept Body site administered to
Binding: Body Site . (preferred)
.... route S 0..1 CodeableConcept Path of substance into body
Binding: Route of Administration . (preferred)
.... method S 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... dose S 0..1 SimpleQuantity Amount of medication per dose
.... rate[x] S 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationAdministration.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationAdministration.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-mad-01errorMedicationAdministration.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-mad-02errorMedicationAdministration.performerIf present, an actor shall at least have a reference, an identifier or a display
: actor.exists() implies actor.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.