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

Logical Model: Medication Prescription (model)

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedicationPrescription Version: 0.1.0
Draft as of 2024-09-18 Computable Name: EHDSMedicationPrescription

Logical model for medication prescription. A prescription contains one or more prescription items.

Usage:

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred
NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(9 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSMedicationPrescription 0..* Base Medication Prescription (model)
Instances of this logical model are not marked to be the target of a Reference
... identifier 1..* Identifier Business identifier(s) for the prescription
... prescriber 1..1 EHDSHealthProfessional The person who made the prescription, and who takes the responsibility of the treatment
... issueDate 1..1 dateTime Time of issuing (signing) the prescription by health care practicioner
... category 0..* CodeableConcept Category or categories of prescription. For example type of reimbursement, or type of prescription (e.g. hospital, private, etc).
... validFrom 0..1 dateTime Effective date of the prescription. The prescription is not dispensable before this date. In most cases this information repeats issueDate
... validUntil 0..1 dateTime The validity period end date. The prescription is not dispensable after this date.
... recorder 0..1 EHDSHealthProfessional The recorder of the prescription/draft in the information system
... recordingDate 0..1 dateTime Time of authoring the prescription/draft in the information system
... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
... statusReasonText 0..1 string Textual reason for the current status of prescription
... comment 0..* string Additional information or comments
... prescriptionItem 1..* BackboneElement 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.
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 Identifier Identifier for a single line on prescription, if exists. In case of single-line prescription, this identifier is typically the same as prescription identifier.
.... medication 1..1 EHDSMedication Prescribed product, branded, generic, virtual, extemporal, etc
.... indication 0..* CodeableConcept Reason for the prescription (typically diagnosis, or a procedure)
Binding Description (No ValueSet): (preferred): shall we have a preferred binding here?


.... indicationText 0..1 string Reason for the prescription in textual form. This might not be allowed by some implementations.
.... treatmentPeriod 0..1 Period Period over which the medication is to be taken (in case of multiple dosaging schemes, this would be the overall period of all dosages.)
.... quantityPrescribed 0..1 Quantity Overall quantity of prescribed product (e.g number of packages or number of tablets).
.... usageInstructions 0..* EHDSDosaging Dosaging and administration instructions
.... preparationInstructions 0..1 string Additional instructions about preparation or dispense
.... substitution 0..1 BackboneElement Whether and which type of substitution is allowed for this medication treatment line
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... allowed 0..1 boolean Whether substitution is allowed or not.
..... type 1..1 CodeableConcept The type of substitution that is allowed.
..... typeReason[x] 0..1 Reason for the substitution requirement
...... typeReasonCodeableConcept CodeableConcept
...... typeReasonString string
.... status 1..1 CodeableConcept Status of the prescription, this should not be status of treatment
.... statusReason 0..* CodeableConcept Reason for the current status of prescription, for example the reason why the prescription was made invalid
.... statusReasonText 0..1 string Textual reason for the current status of prescription
.... comment 0..* string Additional information or comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSMedicationPrescription.prescriptionItem.indicationpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(9 nested mandatory elements)

 

Other representations of profile: CSV, Excel