AU Base Implementation Guide
5.0.1-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 5.0.1-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 Medication Administration

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

Usage Notes

Profile specific implementation guidance:

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

Usage:

Changes since version 5.0.0:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from MedicationAdministration

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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    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
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationAdministration D 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... status ?!Σ 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.


    ele-1: All FHIR elements must have a @value or children
    .... 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

    ele-1: All FHIR elements must have a @value or children
    ..... coding Σ 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    ele-1: All FHIR elements must have a @value or children
    ...... coding:All Slices Content/Rules for all slices
    ....... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ........ extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... text Σ 0..1 string Medication primary text
    ele-1: All FHIR elements must have a @value or children
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Medication Reference
    ele-1: All FHIR elements must have a @value or children
    ... subject Σ 1..1 Reference(Patient | Group) Who received medication
    ele-1: All FHIR elements must have a @value or children
    ... effective[x] Σ 1..1 Start and end time of administration
    ele-1: All FHIR elements must have a @value or children
    .... effectiveDateTime dateTime
    .... effectivePeriod Period

    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.medication[x]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationAdministration D 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: 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 ?!Σ 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 0..* CodeableConcept Reason administration not performed
    Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


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

    ... Slices for medication[x] Σ 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
    ..... coding Σ 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    ...... coding:All Slices Content/Rules for all slices
    ....... id 0..1 string Unique id for inter-element referencing
    ....... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ........ extension: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(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 Σ 0..* BackboneElement Who performed the medication administration and what they did
    .... 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 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 Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
    ... reasonCode 0..* CodeableConcept Reason administration performed
    Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


    ... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
    ... request 0..1 Reference(MedicationRequest) Request administration performed against
    ... device 0..* Reference(Device) Device used to administer
    ... note 0..* Annotation Information about the administration
    ... dosage C 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 0..1 string Free text dosage instructions e.g. SIG
    .... site 0..1 CodeableConcept Body site administered to
    Binding: Body Site . (preferred)
    .... route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration . (preferred)
    .... method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    .... 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    MedicationAdministration.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    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
    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
    dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
    : dose.exists() or rate.exists()

    This structure is derived from MedicationAdministration

    Summary

    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

    Differential View

    This structure is derived from MedicationAdministration

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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    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

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationAdministration D 0..* MedicationAdministration A record of medication administered to a patient in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... status ?!Σ 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.


    ele-1: All FHIR elements must have a @value or children
    .... 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

    ele-1: All FHIR elements must have a @value or children
    ..... coding Σ 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    ele-1: All FHIR elements must have a @value or children
    ...... coding:All Slices Content/Rules for all slices
    ....... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ........ extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... text Σ 0..1 string Medication primary text
    ele-1: All FHIR elements must have a @value or children
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Medication Reference
    ele-1: All FHIR elements must have a @value or children
    ... subject Σ 1..1 Reference(Patient | Group) Who received medication
    ele-1: All FHIR elements must have a @value or children
    ... effective[x] Σ 1..1 Start and end time of administration
    ele-1: All FHIR elements must have a @value or children
    .... effectiveDateTime dateTime
    .... effectivePeriod Period

    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.medication[x]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationAdministration.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard

    Constraints

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

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationAdministration D 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: 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 ?!Σ 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 0..* CodeableConcept Reason administration not performed
    Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


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

    ... Slices for medication[x] Σ 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
    ..... coding Σ 0..* Coding Medication Codes
    Slice: Unordered, Open by value:system
    ...... coding:All Slices Content/Rules for all slices
    ....... id 0..1 string Unique id for inter-element referencing
    ....... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ........ extension: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(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 Σ 0..* BackboneElement Who performed the medication administration and what they did
    .... 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 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 Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
    ... reasonCode 0..* CodeableConcept Reason administration performed
    Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


    ... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
    ... request 0..1 Reference(MedicationRequest) Request administration performed against
    ... device 0..* Reference(Device) Device used to administer
    ... note 0..* Annotation Information about the administration
    ... dosage C 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 0..1 string Free text dosage instructions e.g. SIG
    .... site 0..1 CodeableConcept Body site administered to
    Binding: Body Site . (preferred)
    .... route 0..1 CodeableConcept Path of substance into body
    Binding: Route of Administration . (preferred)
    .... method 0..1 CodeableConcept How drug was administered
    Binding: SNOMEDCTAdministrationMethodCodes (preferred)
    .... 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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    MedicationAdministration.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    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
    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
    dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
    : dose.exists() or rate.exists()

    This structure is derived from MedicationAdministration

    Summary

    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