Xt-EHR Logical Models Implementation Guide
0.1.0 - ci-build
Xt-EHR Logical Models Implementation Guide, 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-10-13 |
Definitions for the EHDSMedicationPrescription logical model.
Guidance on how to interpret the contents of this table can be found here
0. EHDSMedicationPrescription | |
Definition | Logical model for medication prescription. A prescription contains one or more prescription items. |
Short | Medication Prescription (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSMedicationPrescription.identifier | |
Definition | Business identifier(s) for the prescription |
Short | Business identifier(s) for the prescription |
Comments | No change |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. EHDSMedicationPrescription.prescriber | |
Definition | Question: would we want to add basic Practicioner model? |
Short | The person who made the prescription, and who takes the responsibility of the treatment |
Comments | No change |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
6. EHDSMedicationPrescription.issueDate | |
Definition | Time of issuing (signing) the prescription by health care practicioner |
Short | Time of issuing (signing) the prescription by health care practicioner |
Comments | No change |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. EHDSMedicationPrescription.patient | |
Definition | Question: would we want to add basic Patient model? |
Short | The person for whom the medication is prescribed/ordered |
Comments | No change (Patient model will be common for all use cases) |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
10. EHDSMedicationPrescription.category | |
Definition | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Short | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
12. EHDSMedicationPrescription.validFrom | |
Definition | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Short | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Comments | Added. Often the same as IssueDate (A 1.2.2) or Start of therapy (A 1.5.6) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSMedicationPrescription.validUntil | |
Definition | The validity period end date. The prescription is not dispensable after this date. |
Short | The validity period end date. The prescription is not dispensable after this date. |
Comments | No change (A.1.5.8) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSMedicationPrescription.recorder | |
Definition | The recorder of the prescription/draft in the information system |
Short | The recorder of the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
18. EHDSMedicationPrescription.recordingDate | |
Definition | Time of authoring the prescription/draft in the information system |
Short | Time of authoring the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSMedicationPrescription.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
22. EHDSMedicationPrescription.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
24. EHDSMedicationPrescription.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSMedicationPrescription.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSMedicationPrescription.prescriptionItem | |
Definition | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Short | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Control | 1..* |
Type | BackboneElement |
30. EHDSMedicationPrescription.prescriptionItem.identifier | |
Definition | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Short | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
32. EHDSMedicationPrescription.prescriptionItem.medication | |
Definition | Prescribed product, branded, generic, virtual, extemporal, etc |
Short | Prescribed product, branded, generic, virtual, extemporal, etc |
Comments | Medication model changed - described within that model |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
34. EHDSMedicationPrescription.prescriptionItem.indication | |
Definition | Reason for the prescription (typically diagnosis, or a procedure) |
Short | Reason for the prescription (typically diagnosis, or a procedure) |
Comments | No change (A.1.5.10) |
Control | 0..* |
Binding | shall we have a preferred binding here? |
Type | CodeableConcept |
36. EHDSMedicationPrescription.prescriptionItem.indicationText | |
Definition | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Short | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Comments | No change (code not required) A1.5.10 |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. EHDSMedicationPrescription.prescriptionItem.prescriptionIntent | |
Definition | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Short | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Control | 0..1 |
Type | CodeableConcept |
40. EHDSMedicationPrescription.prescriptionItem.treatmentPeriod | |
Definition | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Short | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Comments | Starting Date of Therapy A1.5.6. End date added. |
Control | 0..1 |
Type | Period |
42. EHDSMedicationPrescription.prescriptionItem.quantityPrescribed | |
Definition | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Short | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Comments | No change |
Control | 0..1 |
Type | Quantity |
44. EHDSMedicationPrescription.prescriptionItem.dosageInstructions | |
Definition | Dosaging and administration instructions |
Short | Dosaging and administration instructions |
Comments | Dosage model significantly changed towards more granularity. A.1.5.3-A.1.5.7 |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging |
46. EHDSMedicationPrescription.prescriptionItem.preparationInstructions | |
Definition | Additional instructions about preparation or dispense |
Short | Additional instructions about preparation or dispense |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. EHDSMedicationPrescription.prescriptionItem.substitution | |
Definition | Whether and which type of substitution is allowed for this medication treatment line |
Short | Whether and which type of substitution is allowed for this medication treatment line |
Comments | No change but subelements added. A 1.5.11 |
Control | 0..1 |
Type | BackboneElement |
50. EHDSMedicationPrescription.prescriptionItem.substitution.allowed | |
Definition | Whether substitution is allowed or not. |
Short | Whether substitution is allowed or not. |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. EHDSMedicationPrescription.prescriptionItem.substitution.type | |
Definition | The type of substitution that is allowed. |
Short | The type of substitution that is allowed. |
Control | 1..1 |
Type | CodeableConcept |
54. EHDSMedicationPrescription.prescriptionItem.substitution.typeReason[x] | |
Definition | Reason for the substitution requirement |
Short | Reason for the substitution requirement |
Control | 0..1 |
Type | Choice of: CodeableConcept, string |
[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 |
56. EHDSMedicationPrescription.prescriptionItem.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
58. EHDSMedicationPrescription.prescriptionItem.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
60. EHDSMedicationPrescription.prescriptionItem.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. EHDSMedicationPrescription.prescriptionItem.reasonForChange | |
Definition | The reason the prescription was changed from previous |
Short | The reason the prescription was changed from previous |
Comments | Added. Changed from which other (version of) prescription? |
Control | 0..1 |
Type | CodeableConcept |
64. EHDSMedicationPrescription.prescriptionItem.repeatsAllowed | |
Definition | How many times the prescription item can be dispensed in addition to the original dispense. |
Short | Number of refills authorized |
Comments | Added. A.1.5.9 Repeats |
Control | 0..1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. EHDSMedicationPrescription.prescriptionItem.minimumDispenseInterval | |
Definition | If a prescription allows for repeated dispensations, the interval between dispensations shall be stated here. |
Short | Minimum Dispense Interval |
Comments | Added, based on ISO 17532:2024 A.7.3 Minimum dispensing interval |
Control | 0..1 |
Type | Range |
68. EHDSMedicationPrescription.prescriptionItem.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Comments | Added. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. EHDSMedicationPrescription | |
Definition | Logical model for medication prescription. A prescription contains one or more prescription items. Base definition for all types defined in FHIR type system. |
Short | Medication Prescription (model)Base 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. EHDSMedicationPrescription.identifier | |
Definition | Business identifier(s) for the prescription |
Short | Business identifier(s) for the prescription |
Comments | No change |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. EHDSMedicationPrescription.prescriber | |
Definition | Question: would we want to add basic Practicioner model? |
Short | The person who made the prescription, and who takes the responsibility of the treatment |
Comments | No change |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
6. EHDSMedicationPrescription.issueDate | |
Definition | Time of issuing (signing) the prescription by health care practicioner |
Short | Time of issuing (signing) the prescription by health care practicioner |
Comments | No change |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. EHDSMedicationPrescription.patient | |
Definition | Question: would we want to add basic Patient model? |
Short | The person for whom the medication is prescribed/ordered |
Comments | No change (Patient model will be common for all use cases) |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
10. EHDSMedicationPrescription.category | |
Definition | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Short | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
12. EHDSMedicationPrescription.validFrom | |
Definition | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Short | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Comments | Added. Often the same as IssueDate (A 1.2.2) or Start of therapy (A 1.5.6) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSMedicationPrescription.validUntil | |
Definition | The validity period end date. The prescription is not dispensable after this date. |
Short | The validity period end date. The prescription is not dispensable after this date. |
Comments | No change (A.1.5.8) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSMedicationPrescription.recorder | |
Definition | The recorder of the prescription/draft in the information system |
Short | The recorder of the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
18. EHDSMedicationPrescription.recordingDate | |
Definition | Time of authoring the prescription/draft in the information system |
Short | Time of authoring the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSMedicationPrescription.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
22. EHDSMedicationPrescription.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
24. EHDSMedicationPrescription.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSMedicationPrescription.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSMedicationPrescription.prescriptionItem | |
Definition | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Short | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. EHDSMedicationPrescription.prescriptionItem.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()) |
32. EHDSMedicationPrescription.prescriptionItem.identifier | |
Definition | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Short | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
34. EHDSMedicationPrescription.prescriptionItem.medication | |
Definition | Prescribed product, branded, generic, virtual, extemporal, etc |
Short | Prescribed product, branded, generic, virtual, extemporal, etc |
Comments | Medication model changed - described within that model |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
36. EHDSMedicationPrescription.prescriptionItem.indication | |
Definition | Reason for the prescription (typically diagnosis, or a procedure) |
Short | Reason for the prescription (typically diagnosis, or a procedure) |
Comments | No change (A.1.5.10) |
Control | 0..* |
Binding | shall we have a preferred binding here? |
Type | CodeableConcept |
38. EHDSMedicationPrescription.prescriptionItem.indicationText | |
Definition | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Short | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Comments | No change (code not required) A1.5.10 |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSMedicationPrescription.prescriptionItem.prescriptionIntent | |
Definition | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Short | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Control | 0..1 |
Type | CodeableConcept |
42. EHDSMedicationPrescription.prescriptionItem.treatmentPeriod | |
Definition | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Short | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Comments | Starting Date of Therapy A1.5.6. End date added. |
Control | 0..1 |
Type | Period |
44. EHDSMedicationPrescription.prescriptionItem.quantityPrescribed | |
Definition | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Short | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Comments | No change |
Control | 0..1 |
Type | Quantity |
46. EHDSMedicationPrescription.prescriptionItem.dosageInstructions | |
Definition | Dosaging and administration instructions |
Short | Dosaging and administration instructions |
Comments | Dosage model significantly changed towards more granularity. A.1.5.3-A.1.5.7 |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging |
48. EHDSMedicationPrescription.prescriptionItem.preparationInstructions | |
Definition | Additional instructions about preparation or dispense |
Short | Additional instructions about preparation or dispense |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. EHDSMedicationPrescription.prescriptionItem.substitution | |
Definition | Whether and which type of substitution is allowed for this medication treatment line |
Short | Whether and which type of substitution is allowed for this medication treatment line |
Comments | No change but subelements added. A 1.5.11 |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. EHDSMedicationPrescription.prescriptionItem.substitution.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()) |
54. EHDSMedicationPrescription.prescriptionItem.substitution.allowed | |
Definition | Whether substitution is allowed or not. |
Short | Whether substitution is allowed or not. |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. EHDSMedicationPrescription.prescriptionItem.substitution.type | |
Definition | The type of substitution that is allowed. |
Short | The type of substitution that is allowed. |
Control | 1..1 |
Type | CodeableConcept |
58. EHDSMedicationPrescription.prescriptionItem.substitution.typeReason[x] | |
Definition | Reason for the substitution requirement |
Short | Reason for the substitution requirement |
Control | 0..1 |
Type | Choice of: CodeableConcept, string |
[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 |
60. EHDSMedicationPrescription.prescriptionItem.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
62. EHDSMedicationPrescription.prescriptionItem.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
64. EHDSMedicationPrescription.prescriptionItem.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. EHDSMedicationPrescription.prescriptionItem.reasonForChange | |
Definition | The reason the prescription was changed from previous |
Short | The reason the prescription was changed from previous |
Comments | Added. Changed from which other (version of) prescription? |
Control | 0..1 |
Type | CodeableConcept |
68. EHDSMedicationPrescription.prescriptionItem.repeatsAllowed | |
Definition | How many times the prescription item can be dispensed in addition to the original dispense. |
Short | Number of refills authorized |
Comments | Added. A.1.5.9 Repeats |
Control | 0..1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. EHDSMedicationPrescription.prescriptionItem.minimumDispenseInterval | |
Definition | If a prescription allows for repeated dispensations, the interval between dispensations shall be stated here. |
Short | Minimum Dispense Interval |
Comments | Added, based on ISO 17532:2024 A.7.3 Minimum dispensing interval |
Control | 0..1 |
Type | Range |
72. EHDSMedicationPrescription.prescriptionItem.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Comments | Added. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. EHDSMedicationPrescription | |
Definition | Logical model for medication prescription. A prescription contains one or more prescription items. |
Short | Medication Prescription (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSMedicationPrescription.identifier | |
Definition | Business identifier(s) for the prescription |
Short | Business identifier(s) for the prescription |
Comments | No change |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
4. EHDSMedicationPrescription.prescriber | |
Definition | Question: would we want to add basic Practicioner model? |
Short | The person who made the prescription, and who takes the responsibility of the treatment |
Comments | No change |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
6. EHDSMedicationPrescription.issueDate | |
Definition | Time of issuing (signing) the prescription by health care practicioner |
Short | Time of issuing (signing) the prescription by health care practicioner |
Comments | No change |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. EHDSMedicationPrescription.patient | |
Definition | Question: would we want to add basic Patient model? |
Short | The person for whom the medication is prescribed/ordered |
Comments | No change (Patient model will be common for all use cases) |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
10. EHDSMedicationPrescription.category | |
Definition | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Short | Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc). |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
12. EHDSMedicationPrescription.validFrom | |
Definition | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Short | Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate |
Comments | Added. Often the same as IssueDate (A 1.2.2) or Start of therapy (A 1.5.6) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSMedicationPrescription.validUntil | |
Definition | The validity period end date. The prescription is not dispensable after this date. |
Short | The validity period end date. The prescription is not dispensable after this date. |
Comments | No change (A.1.5.8) |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSMedicationPrescription.recorder | |
Definition | The recorder of the prescription/draft in the information system |
Short | The recorder of the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
18. EHDSMedicationPrescription.recordingDate | |
Definition | Time of authoring the prescription/draft in the information system |
Short | Time of authoring the prescription/draft in the information system |
Comments | Added. Not relevant for crossborder. |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSMedicationPrescription.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
22. EHDSMedicationPrescription.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
24. EHDSMedicationPrescription.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSMedicationPrescription.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSMedicationPrescription.prescriptionItem | |
Definition | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Short | Presription line for one medication. In many countries, only one line is allowed. In case multiple medications are allowed, all lines need to be authored together. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. EHDSMedicationPrescription.prescriptionItem.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 |
32. EHDSMedicationPrescription.prescriptionItem.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 EHDSMedicationPrescription.prescriptionItem.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. EHDSMedicationPrescription.prescriptionItem.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() ) |
36. EHDSMedicationPrescription.prescriptionItem.identifier | |
Definition | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Short | Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
38. EHDSMedicationPrescription.prescriptionItem.medication | |
Definition | Prescribed product, branded, generic, virtual, extemporal, etc |
Short | Prescribed product, branded, generic, virtual, extemporal, etc |
Comments | Medication model changed - described within that model |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
40. EHDSMedicationPrescription.prescriptionItem.indication | |
Definition | Reason for the prescription (typically diagnosis, or a procedure) |
Short | Reason for the prescription (typically diagnosis, or a procedure) |
Comments | No change (A.1.5.10) |
Control | 0..* |
Binding | shall we have a preferred binding here? |
Type | CodeableConcept |
42. EHDSMedicationPrescription.prescriptionItem.indicationText | |
Definition | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Short | Reason for the prescription in textual form. This might not be allowed by some implementations. |
Comments | No change (code not required) A1.5.10 |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. EHDSMedicationPrescription.prescriptionItem.prescriptionIntent | |
Definition | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Short | Intent of the prescription - prophylaxis, treatment, anesthesia, etc |
Control | 0..1 |
Type | CodeableConcept |
46. EHDSMedicationPrescription.prescriptionItem.treatmentPeriod | |
Definition | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Short | Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.) |
Comments | Starting Date of Therapy A1.5.6. End date added. |
Control | 0..1 |
Type | Period |
48. EHDSMedicationPrescription.prescriptionItem.quantityPrescribed | |
Definition | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Short | Overall quantity of prescribed product (e.g number of packages or number of tablets). |
Comments | No change |
Control | 0..1 |
Type | Quantity |
50. EHDSMedicationPrescription.prescriptionItem.dosageInstructions | |
Definition | Dosaging and administration instructions |
Short | Dosaging and administration instructions |
Comments | Dosage model significantly changed towards more granularity. A.1.5.3-A.1.5.7 |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging |
52. EHDSMedicationPrescription.prescriptionItem.preparationInstructions | |
Definition | Additional instructions about preparation or dispense |
Short | Additional instructions about preparation or dispense |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. EHDSMedicationPrescription.prescriptionItem.substitution | |
Definition | Whether and which type of substitution is allowed for this medication treatment line |
Short | Whether and which type of substitution is allowed for this medication treatment line |
Comments | No change but subelements added. A 1.5.11 |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. EHDSMedicationPrescription.prescriptionItem.substitution.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 |
58. EHDSMedicationPrescription.prescriptionItem.substitution.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 EHDSMedicationPrescription.prescriptionItem.substitution.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
60. EHDSMedicationPrescription.prescriptionItem.substitution.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() ) |
62. EHDSMedicationPrescription.prescriptionItem.substitution.allowed | |
Definition | Whether substitution is allowed or not. |
Short | Whether substitution is allowed or not. |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. EHDSMedicationPrescription.prescriptionItem.substitution.type | |
Definition | The type of substitution that is allowed. |
Short | The type of substitution that is allowed. |
Control | 1..1 |
Type | CodeableConcept |
66. EHDSMedicationPrescription.prescriptionItem.substitution.typeReason[x] | |
Definition | Reason for the substitution requirement |
Short | Reason for the substitution requirement |
Control | 0..1 |
Type | Choice of: CodeableConcept, string |
[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 |
68. EHDSMedicationPrescription.prescriptionItem.status | |
Definition | Status of the prescription, this should not be status of treatment |
Short | Status of the prescription, this should not be status of treatment |
Comments | Added. |
Control | 1..1 |
Type | CodeableConcept |
70. EHDSMedicationPrescription.prescriptionItem.statusReason | |
Definition | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Short | Reason for the current status of prescription, for example the reason why the prescription was made invalid |
Comments | Added. |
Control | 0..* |
Type | CodeableConcept |
72. EHDSMedicationPrescription.prescriptionItem.statusReasonText | |
Definition | Textual reason for the current status of prescription |
Short | Textual reason for the current status of prescription |
Comments | Added. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. EHDSMedicationPrescription.prescriptionItem.reasonForChange | |
Definition | The reason the prescription was changed from previous |
Short | The reason the prescription was changed from previous |
Comments | Added. Changed from which other (version of) prescription? |
Control | 0..1 |
Type | CodeableConcept |
76. EHDSMedicationPrescription.prescriptionItem.repeatsAllowed | |
Definition | How many times the prescription item can be dispensed in addition to the original dispense. |
Short | Number of refills authorized |
Comments | Added. A.1.5.9 Repeats |
Control | 0..1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
78. EHDSMedicationPrescription.prescriptionItem.minimumDispenseInterval | |
Definition | If a prescription allows for repeated dispensations, the interval between dispensations shall be stated here. |
Short | Minimum Dispense Interval |
Comments | Added, based on ISO 17532:2024 A.7.3 Minimum dispensing interval |
Control | 0..1 |
Type | Range |
80. EHDSMedicationPrescription.prescriptionItem.comment | |
Definition | Additional information or comments |
Short | Additional information or comments |
Comments | Added. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |