This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
AU Base Medication Administration [FMM Level 2]
This profile defines a medication administration structure including core localisation concepts for use in an Australian context.
Full medication definitions as a Medication resource can be referenced or codings are use be used to define relevant drug/medication concepts. This includes coding as:
Extensions used in this profile:
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-medicationadministration
This profile defines a medication administration structure including core localisation concepts for use in an Australian context.
This profile builds on MedicationAdministration.
This profile was published on Mon Nov 19 00:00:00 AEDT 2018 as a draft by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | I | 0..* | MedicationAdministration | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 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 | |
definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) | Instantiates protocol or definition |
partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
status | ?!Σ | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatus (required) |
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred) | |
medication[x] | Σ | 1..1 | (Slice Definition) | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication Codes (example) |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMED CT Medication Codes (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Medication Codes Slice: Unordered, Open by value:system |
coding:pbs | Σ | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
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 |
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
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 |
coding:amt | Σ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
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 |
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
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 | Plain text representation of the concept |
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Base Medication) | Medication Reference |
subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | ΣI | 0..* | BackboneElement | Medication adminstration participants |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-administration-witness | I | 0..* | Reference(PractitionerRole | Practitioner) | Witness to administration URL: http://hl7.org.au/fhir/StructureDefinition/medication-administration-witness |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | Σ | 1..1 | Reference(Practitioner | Patient | RelatedPerson | Device) | Individual who was performing |
onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
notGiven | ?!Σ | 0..1 | boolean | True if medication not administered |
reasonNotGiven | I | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMED CT Reason Medication Not Given Codes (example) |
reasonCode | I | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example) |
reasonReference | 0..* | Reference(Condition | Observation) | Condition or Observation that supports why the medication was administered | |
prescription | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
device | 0..* | Reference(Device) | Device used to administer | |
note | 0..* | Annotation | Information about the administration | |
dosage | I | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) | |
route | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMED CT Route Codes (example) | |
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMED CT Administration Method Codes (example) | |
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |
rate[x] | 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 | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | I | 0..* | MedicationAdministration | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 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 | |
definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) | Instantiates protocol or definition |
partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
status | ?!Σ | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatus (required) |
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministrationCategory (preferred) | |
medication[x] | Σ | 1..1 | (Slice Definition) | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication Codes (example) |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMED CT Medication Codes (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Medication Codes Slice: Unordered, Open by value:system |
coding:pbs | Σ | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
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 |
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
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 |
coding:amt | Σ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
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 |
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
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 | Plain text representation of the concept |
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Base Medication) | Medication Reference |
subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | ΣI | 0..* | BackboneElement | Medication adminstration participants |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
medication-administration-witness | I | 0..* | Reference(PractitionerRole | Practitioner) | Witness to administration URL: http://hl7.org.au/fhir/StructureDefinition/medication-administration-witness |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | Σ | 1..1 | Reference(Practitioner | Patient | RelatedPerson | Device) | Individual who was performing |
onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
notGiven | ?!Σ | 0..1 | boolean | True if medication not administered |
reasonNotGiven | I | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMED CT Reason Medication Not Given Codes (example) |
reasonCode | I | 0..* | CodeableConcept | Reason administration performed Binding: Reason Medication Given Codes (example) |
reasonReference | 0..* | Reference(Condition | Observation) | Condition or Observation that supports why the medication was administered | |
prescription | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
device | 0..* | Reference(Device) | Device used to administer | |
note | 0..* | Annotation | Information about the administration | |
dosage | I | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) | |
route | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMED CT Route Codes (example) | |
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMED CT Administration Method Codes (example) | |
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |
rate[x] | 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 | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-medicationadministration
none defined