MyHealth@Eu Hospital Discharge Report
9.1.0 - qa-preview 150

MyHealth@Eu Hospital Discharge Report - Local Development build (v9.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MedicationAdministration: HDR

Official URL: http://fhir.ehdsi.eu/hdr/StructureDefinition/medicationAdministration-hdr-myhealtheu Version: 9.1.0
Standards status: Draft Maturity Level: 1 Computable Name: MedicationAdministrationHdrMyHealthEu

This profile constrains the MedicationAdministration resource for the purpose of this guide, adapted from the MPD work.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministrationEuHdr Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Current state of the administration
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... Slices for medication[x] Σ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication (HDR))
.... medication[x]:medicationReference OΣ 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... subject OΣ 1..1 Reference(Patient: HDR) Who received medication
ObligationsActor
SHALL:handle HDR Handler
... effective[x] OΣ 1..1 Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: eHDSI Medication Reason With Exceptions (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG

Constraints

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

This structure is derived from MedicationAdministrationEuHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration MedicationAdministrationEuHdr
... status 1..1 code Current state of the administration
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: eHDSI Medication Status Reason With Exceptions (required)
... Slices for medication[x] 1..1 CodeableConcept, Reference(Medication (HDR)) What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationReference O 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... effective[x] O 1..1 dateTime, Period Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: eHDSI Medication Reason With Exceptions (required)
... dosage
.... route 0..1 CodeableConcept Path of substance into body
Binding: eHDSI Route of Administration (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministrationEuHdr Administration of medication to a patient
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Medication Administration Identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!Σ 1..1 code Current state of the administration
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: eHDSI Medication Status Reason With Exceptions (required)
... 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 What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication (HDR))
.... medication[x]:medicationReference OΣ 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... subject OΣ 1..1 Reference(Patient: HDR) Who received medication
ObligationsActor
SHALL:handle HDR Handler
... 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] OΣ 1..1 Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
.... 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: eHDSI Medication Reason With Exceptions (required)
... 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
Constraints: mad-1
.... 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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route 0..1 CodeableConcept Path of substance into body
Binding: eHDSI Route of Administration (extensible)
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... 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

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​category Base preferred Medication administration category codes 📦4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📦4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 This IG
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.

Constraints

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

This structure is derived from MedicationAdministrationEuHdr

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministrationEuHdr Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Current state of the administration
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... Slices for medication[x] Σ 1..1 What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication (HDR))
.... medication[x]:medicationReference OΣ 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... subject OΣ 1..1 Reference(Patient: HDR) Who received medication
ObligationsActor
SHALL:handle HDR Handler
... effective[x] OΣ 1..1 Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: eHDSI Medication Reason With Exceptions (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG

Constraints

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

Differential View

This structure is derived from MedicationAdministrationEuHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration MedicationAdministrationEuHdr
... status 1..1 code Current state of the administration
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: eHDSI Medication Status Reason With Exceptions (required)
... Slices for medication[x] 1..1 CodeableConcept, Reference(Medication (HDR)) What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationReference O 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... effective[x] O 1..1 dateTime, Period Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: eHDSI Medication Reason With Exceptions (required)
... dosage
.... route 0..1 CodeableConcept Path of substance into body
Binding: eHDSI Route of Administration (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministrationEuHdr Administration of medication to a patient
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Medication Administration Identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!Σ 1..1 code Current state of the administration
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: eHDSI Medication Status Reason With Exceptions (required)
... 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 What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication (HDR))
.... medication[x]:medicationReference OΣ 0..1 Reference(Medication: HDR) What was administered
ObligationsActor
SHALL:handle HDR Handler
... subject OΣ 1..1 Reference(Patient: HDR) Who received medication
ObligationsActor
SHALL:handle HDR Handler
... 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] OΣ 1..1 Start and end time of administration
ObligationsActor
SHALL:handle HDR Handler
.... 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: eHDSI Medication Reason With Exceptions (required)
... 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
Constraints: mad-1
.... 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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route 0..1 CodeableConcept Path of substance into body
Binding: eHDSI Route of Administration (extensible)
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... 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

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​category Base preferred Medication administration category codes 📦4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📦4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦9.1.0 This IG
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📦4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 This IG
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.

Constraints

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

This structure is derived from MedicationAdministrationEuHdr

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron