Xt-EHR
0.1.0 - ci-build
Xt-EHR
0.1.0 - ci-build
Xt-EHR, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions
| Draft as of 2024-09-18 |
Definitions for the EHDSMedicationAdministration logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSMedicationAdministration | |
| Definition | C.18 - EHDS refined base model for Medication administration |
| Short | Medication administration |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSMedicationAdministration.identifier | |
| Definition | Medication administration identifier |
| Short | C.18.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSMedicationAdministration.status | |
| Definition | Will generally be set to show that the administration has been completed, but might include other sttus codes (e.g. completed, not-done, on-hold, in-progress, unknown) |
| Short | C.18.2 - Status |
| Control | 1..1 |
| Binding | HL7 MedicationAdimnistrationStatusCodes |
| Type | CodeableConcept |
| 6. EHDSMedicationAdministration.statusReason | |
| Definition | Reason administration not performed |
| Short | C.18.3 - Status reason |
| Control | 0..* |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSMedicationAdministration.medication | |
| Definition | Administered medication |
| Short | C.18.4 - Medication |
| Control | 1..1 |
| Type | Reference(Medicinal product (model)) |
| 10. EHDSMedicationAdministration.occurance[x] | |
| Definition | Specific date/time or interval of time during which the administration took place (or did not take place) |
| Short | C.18.5 - Occurance |
| Control | 1..1 |
| Type | Choice of: dateTime, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. EHDSMedicationAdministration.reason | |
| Definition | Condition or observation that supports why the medication was administered |
| Short | C.18.6 - Reason |
| Control | 0..* |
| Type | Reference(Condition (model), Observation (model)) |
| 14. EHDSMedicationAdministration.note | |
| Definition | Information about the administration |
| Short | C.18.7 - Note |
| Control | 0..1 |
| Type | Narrative |
| 16. EHDSMedicationAdministration.dosage | |
| Definition | Details of how medication was taken |
| Short | C.18.8 - Dosage |
| Control | 0..1 |
| Type | BackboneElement |
| 18. EHDSMedicationAdministration.dosage.dosageDescription | |
| Definition | Free text dosage instructions |
| Short | C.18.8.1 - Dosage description |
| Control | 0..1 |
| Type | Narrative |
| 20. EHDSMedicationAdministration.dosage.site | |
| Definition | Body site administered to |
| Short | C.18.8.2 - Site |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 22. EHDSMedicationAdministration.dosage.route | |
| Definition | Path of substance into body |
| Short | C.18.8.3 - Route |
| Control | 0..1 |
| Binding | SNOMED CT, EDQM |
| Type | CodeableConcept |
| 24. EHDSMedicationAdministration.dosage.method | |
| Definition | How drug was administered |
| Short | C.18.8.4 - Method |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 26. EHDSMedicationAdministration.dosage.dose | |
| Definition | Amount of medication per dose |
| Short | C.18.8.5 - Dose |
| Control | 0..1 |
| Type | Quantity |
| 28. EHDSMedicationAdministration.dosage.rate[x] | |
| Definition | Dose quantity per unit of time |
| Short | C.18.8.6 - Rate |
| Control | 0..1 |
| Type | Choice of: Ratio, Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSMedicationAdministration | |
| Definition | C.18 - EHDS refined base model for Medication administration Base definition for all types defined in FHIR type system. |
| Short | Medication administrationBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSMedicationAdministration.identifier | |
| Definition | Medication administration identifier |
| Short | C.18.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSMedicationAdministration.status | |
| Definition | Will generally be set to show that the administration has been completed, but might include other sttus codes (e.g. completed, not-done, on-hold, in-progress, unknown) |
| Short | C.18.2 - Status |
| Control | 1..1 |
| Binding | HL7 MedicationAdimnistrationStatusCodes |
| Type | CodeableConcept |
| 6. EHDSMedicationAdministration.statusReason | |
| Definition | Reason administration not performed |
| Short | C.18.3 - Status reason |
| Control | 0..* |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSMedicationAdministration.medication | |
| Definition | Administered medication |
| Short | C.18.4 - Medication |
| Control | 1..1 |
| Type | Reference(Medicinal product (model)) |
| 10. EHDSMedicationAdministration.occurance[x] | |
| Definition | Specific date/time or interval of time during which the administration took place (or did not take place) |
| Short | C.18.5 - Occurance |
| Control | 1..1 |
| Type | Choice of: dateTime, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. EHDSMedicationAdministration.reason | |
| Definition | Condition or observation that supports why the medication was administered |
| Short | C.18.6 - Reason |
| Control | 0..* |
| Type | Reference(Condition (model), Observation (model)) |
| 14. EHDSMedicationAdministration.note | |
| Definition | Information about the administration |
| Short | C.18.7 - Note |
| Control | 0..1 |
| Type | Narrative |
| 16. EHDSMedicationAdministration.dosage | |
| Definition | Details of how medication was taken |
| Short | C.18.8 - Dosage |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. EHDSMedicationAdministration.dosage.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 20. EHDSMedicationAdministration.dosage.dosageDescription | |
| Definition | Free text dosage instructions |
| Short | C.18.8.1 - Dosage description |
| Control | 0..1 |
| Type | Narrative |
| 22. EHDSMedicationAdministration.dosage.site | |
| Definition | Body site administered to |
| Short | C.18.8.2 - Site |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 24. EHDSMedicationAdministration.dosage.route | |
| Definition | Path of substance into body |
| Short | C.18.8.3 - Route |
| Control | 0..1 |
| Binding | SNOMED CT, EDQM |
| Type | CodeableConcept |
| 26. EHDSMedicationAdministration.dosage.method | |
| Definition | How drug was administered |
| Short | C.18.8.4 - Method |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 28. EHDSMedicationAdministration.dosage.dose | |
| Definition | Amount of medication per dose |
| Short | C.18.8.5 - Dose |
| Control | 0..1 |
| Type | Quantity |
| 30. EHDSMedicationAdministration.dosage.rate[x] | |
| Definition | Dose quantity per unit of time |
| Short | C.18.8.6 - Rate |
| Control | 0..1 |
| Type | Choice of: Ratio, Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSMedicationAdministration | |
| Definition | C.18 - EHDS refined base model for Medication administration |
| Short | Medication administration |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSMedicationAdministration.identifier | |
| Definition | Medication administration identifier |
| Short | C.18.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSMedicationAdministration.status | |
| Definition | Will generally be set to show that the administration has been completed, but might include other sttus codes (e.g. completed, not-done, on-hold, in-progress, unknown) |
| Short | C.18.2 - Status |
| Control | 1..1 |
| Binding | HL7 MedicationAdimnistrationStatusCodes |
| Type | CodeableConcept |
| 6. EHDSMedicationAdministration.statusReason | |
| Definition | Reason administration not performed |
| Short | C.18.3 - Status reason |
| Control | 0..* |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSMedicationAdministration.medication | |
| Definition | Administered medication |
| Short | C.18.4 - Medication |
| Control | 1..1 |
| Type | Reference(Medicinal product (model)) |
| 10. EHDSMedicationAdministration.occurance[x] | |
| Definition | Specific date/time or interval of time during which the administration took place (or did not take place) |
| Short | C.18.5 - Occurance |
| Control | 1..1 |
| Type | Choice of: dateTime, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. EHDSMedicationAdministration.reason | |
| Definition | Condition or observation that supports why the medication was administered |
| Short | C.18.6 - Reason |
| Control | 0..* |
| Type | Reference(Condition (model), Observation (model)) |
| 14. EHDSMedicationAdministration.note | |
| Definition | Information about the administration |
| Short | C.18.7 - Note |
| Control | 0..1 |
| Type | Narrative |
| 16. EHDSMedicationAdministration.dosage | |
| Definition | Details of how medication was taken |
| Short | C.18.8 - Dosage |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. EHDSMedicationAdministration.dosage.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 20. EHDSMedicationAdministration.dosage.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on EHDSMedicationAdministration.dosage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. EHDSMedicationAdministration.dosage.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. EHDSMedicationAdministration.dosage.dosageDescription | |
| Definition | Free text dosage instructions |
| Short | C.18.8.1 - Dosage description |
| Control | 0..1 |
| Type | Narrative |
| 26. EHDSMedicationAdministration.dosage.site | |
| Definition | Body site administered to |
| Short | C.18.8.2 - Site |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 28. EHDSMedicationAdministration.dosage.route | |
| Definition | Path of substance into body |
| Short | C.18.8.3 - Route |
| Control | 0..1 |
| Binding | SNOMED CT, EDQM |
| Type | CodeableConcept |
| 30. EHDSMedicationAdministration.dosage.method | |
| Definition | How drug was administered |
| Short | C.18.8.4 - Method |
| Control | 0..1 |
| Binding | SNOMED CT |
| Type | CodeableConcept |
| 32. EHDSMedicationAdministration.dosage.dose | |
| Definition | Amount of medication per dose |
| Short | C.18.8.5 - Dose |
| Control | 0..1 |
| Type | Quantity |
| 34. EHDSMedicationAdministration.dosage.rate[x] | |
| Definition | Dose quantity per unit of time |
| Short | C.18.8.6 - Rate |
| Control | 0..1 |
| Type | Choice of: Ratio, Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
IG © 2022+ Xt-EHR. Package hl7.eu.fhir.xt-ehr.common#0.1.0 based on FHIR 5.0.0. Generated 2024-09-18
Links:
Table of Contents |
QA Report
The Xt-EHR action is co-funded by the European Union, EU4Health Program 2021-2027, under Grant Agreement Nr.º 101128085.
