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: EHDSMedicationDispense - Detailed Descriptions

Draft as of 2024-09-18

Definitions for the EHDSMedicationDispense logical model.

Guidance on how to interpret the contents of this table can be found here

0. EHDSMedicationDispense
Definition

Logical model for medication dispensation (based on request or independently)

ShortMedication dispensation (model)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSMedicationDispense.identifier
Definition

Identifier for the dispense

ShortIdentifier for the dispense
Comments

Not explicitly in eHN guidelines

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. EHDSMedicationDispense.patient
Definition

The person for whom the medication is prescribed/ordered

ShortThe person for whom the medication is prescribed/ordered
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
6. EHDSMedicationDispense.receiver[x]
Definition

Identification of the person who received the dispensed medication, especially when it was not the patient

ShortIdentification of the person who received the dispensed medication, especially when it was not the patient
Comments

Added

Control0..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
8. EHDSMedicationDispense.dispenser[x]
Definition

The person who dispensed the product, and takes the responsibility of the dispensation

ShortThe person who dispensed the product, and takes the responsibility of the dispensation
Comments

Added device. Organisation is in eHN guidelines, but probably meant in combination with the pharmacist

Control1..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. EHDSMedicationDispense.relatedRequest
Definition

Prescription/request/order the dispense is related to

ShortPrescription/request/order the dispense is related to
Comments

No change

Control0..*
TypeReference(Medication Prescription (model))
12. EHDSMedicationDispense.medication
Definition

Exact dispensed product

ShortExact dispensed product
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication
14. EHDSMedicationDispense.dispensedQuantity
Definition

Number of dispensed packages if the pack size is known, or number of smaller items/units

ShortNumber of dispensed packages if the pack size is known, or number of smaller items/units
Comments

No change

Control1..1
TypeQuantity
16. EHDSMedicationDispense.timeOfDispensation
Definition

Date and time of dispensation

ShortDate and time of dispensation
Comments

No change

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHDSMedicationDispense.substitution
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Comments

No change but subelements added

Control0..1
TypeBackboneElement
20. EHDSMedicationDispense.substitution.substitutionOccurred
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. EHDSMedicationDispense.substitution.substitutionType
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Control0..1
TypeCodeableConcept
24. EHDSMedicationDispense.substitution.substitutionReason
Definition

Reason why the substitution was made

ShortReason why the substitution was made
Control0..*
TypeCodeableConcept
26. EHDSMedicationDispense.status
Definition

Status of the dispensation

ShortStatus of the dispensation
Comments

Added

Control1..1
TypeCodeableConcept
28. EHDSMedicationDispense.statusReason
Definition

Reason for the current status of dispensation, for example the reason why the dispensation was made invalid

ShortReason for the current status of dispensation, for example the reason why the dispensation was made invalid
Comments

Added

Control0..*
TypeCodeableConcept
30. EHDSMedicationDispense.statusReasonText
Definition

Textual reason for the current status of dispensation

ShortTextual reason for the current status of dispensation
Comments

Added

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSMedicationDispense.usageInstructions
Definition

Dosaging and administration instructions

ShortDosaging and administration instructions
Comments

Added

Control0..*
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging

Guidance on how to interpret the contents of this table can be found here

0. EHDSMedicationDispense
Definition

Logical model for medication dispensation (based on request or independently)


Base definition for all types defined in FHIR type system.

ShortMedication dispensation (model)Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSMedicationDispense.identifier
Definition

Identifier for the dispense

ShortIdentifier for the dispense
Comments

Not explicitly in eHN guidelines

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. EHDSMedicationDispense.patient
Definition

The person for whom the medication is prescribed/ordered

ShortThe person for whom the medication is prescribed/ordered
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
6. EHDSMedicationDispense.receiver[x]
Definition

Identification of the person who received the dispensed medication, especially when it was not the patient

ShortIdentification of the person who received the dispensed medication, especially when it was not the patient
Comments

Added

Control0..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
8. EHDSMedicationDispense.dispenser[x]
Definition

The person who dispensed the product, and takes the responsibility of the dispensation

ShortThe person who dispensed the product, and takes the responsibility of the dispensation
Comments

Added device. Organisation is in eHN guidelines, but probably meant in combination with the pharmacist

Control1..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. EHDSMedicationDispense.relatedRequest
Definition

Prescription/request/order the dispense is related to

ShortPrescription/request/order the dispense is related to
Comments

No change

Control0..*
TypeReference(Medication Prescription (model))
12. EHDSMedicationDispense.medication
Definition

Exact dispensed product

ShortExact dispensed product
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication
14. EHDSMedicationDispense.dispensedQuantity
Definition

Number of dispensed packages if the pack size is known, or number of smaller items/units

ShortNumber of dispensed packages if the pack size is known, or number of smaller items/units
Comments

No change

Control1..1
TypeQuantity
16. EHDSMedicationDispense.timeOfDispensation
Definition

Date and time of dispensation

ShortDate and time of dispensation
Comments

No change

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHDSMedicationDispense.substitution
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Comments

No change but subelements added

Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. EHDSMedicationDispense.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).

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
22. EHDSMedicationDispense.substitution.substitutionOccurred
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. EHDSMedicationDispense.substitution.substitutionType
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Control0..1
TypeCodeableConcept
26. EHDSMedicationDispense.substitution.substitutionReason
Definition

Reason why the substitution was made

ShortReason why the substitution was made
Control0..*
TypeCodeableConcept
28. EHDSMedicationDispense.status
Definition

Status of the dispensation

ShortStatus of the dispensation
Comments

Added

Control1..1
TypeCodeableConcept
30. EHDSMedicationDispense.statusReason
Definition

Reason for the current status of dispensation, for example the reason why the dispensation was made invalid

ShortReason for the current status of dispensation, for example the reason why the dispensation was made invalid
Comments

Added

Control0..*
TypeCodeableConcept
32. EHDSMedicationDispense.statusReasonText
Definition

Textual reason for the current status of dispensation

ShortTextual reason for the current status of dispensation
Comments

Added

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. EHDSMedicationDispense.usageInstructions
Definition

Dosaging and administration instructions

ShortDosaging and administration instructions
Comments

Added

Control0..*
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging

Guidance on how to interpret the contents of this table can be found here

0. EHDSMedicationDispense
Definition

Logical model for medication dispensation (based on request or independently)

ShortMedication dispensation (model)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSMedicationDispense.identifier
Definition

Identifier for the dispense

ShortIdentifier for the dispense
Comments

Not explicitly in eHN guidelines

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. EHDSMedicationDispense.patient
Definition

The person for whom the medication is prescribed/ordered

ShortThe person for whom the medication is prescribed/ordered
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
6. EHDSMedicationDispense.receiver[x]
Definition

Identification of the person who received the dispensed medication, especially when it was not the patient

ShortIdentification of the person who received the dispensed medication, especially when it was not the patient
Comments

Added

Control0..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
8. EHDSMedicationDispense.dispenser[x]
Definition

The person who dispensed the product, and takes the responsibility of the dispensation

ShortThe person who dispensed the product, and takes the responsibility of the dispensation
Comments

Added device. Organisation is in eHN guidelines, but probably meant in combination with the pharmacist

Control1..1
TypeChoice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. EHDSMedicationDispense.relatedRequest
Definition

Prescription/request/order the dispense is related to

ShortPrescription/request/order the dispense is related to
Comments

No change

Control0..*
TypeReference(Medication Prescription (model))
12. EHDSMedicationDispense.medication
Definition

Exact dispensed product

ShortExact dispensed product
Comments

No change

Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication
14. EHDSMedicationDispense.dispensedQuantity
Definition

Number of dispensed packages if the pack size is known, or number of smaller items/units

ShortNumber of dispensed packages if the pack size is known, or number of smaller items/units
Comments

No change

Control1..1
TypeQuantity
16. EHDSMedicationDispense.timeOfDispensation
Definition

Date and time of dispensation

ShortDate and time of dispensation
Comments

No change

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHDSMedicationDispense.substitution
Definition

Question: is this relevant? It is in eHDSI dispensation.

ShortIndicated whether substitution was made by the dispenser
Comments

No change but subelements added

Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. EHDSMedicationDispense.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.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. EHDSMedicationDispense.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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on EHDSMedicationDispense.substitution.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 24. EHDSMedicationDispense.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).

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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 Namesextensions, user content, modifiers
    Invariantsele-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())
    26. EHDSMedicationDispense.substitution.substitutionOccurred
    Definition

    Question: is this relevant? It is in eHDSI dispensation.

    ShortIndicated whether substitution was made by the dispenser
    Control0..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. EHDSMedicationDispense.substitution.substitutionType
    Definition

    Question: is this relevant? It is in eHDSI dispensation.

    ShortIndicated whether substitution was made by the dispenser
    Control0..1
    TypeCodeableConcept
    30. EHDSMedicationDispense.substitution.substitutionReason
    Definition

    Reason why the substitution was made

    ShortReason why the substitution was made
    Control0..*
    TypeCodeableConcept
    32. EHDSMedicationDispense.status
    Definition

    Status of the dispensation

    ShortStatus of the dispensation
    Comments

    Added

    Control1..1
    TypeCodeableConcept
    34. EHDSMedicationDispense.statusReason
    Definition

    Reason for the current status of dispensation, for example the reason why the dispensation was made invalid

    ShortReason for the current status of dispensation, for example the reason why the dispensation was made invalid
    Comments

    Added

    Control0..*
    TypeCodeableConcept
    36. EHDSMedicationDispense.statusReasonText
    Definition

    Textual reason for the current status of dispensation

    ShortTextual reason for the current status of dispensation
    Comments

    Added

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. EHDSMedicationDispense.usageInstructions
    Definition

    Dosaging and administration instructions

    ShortDosaging and administration instructions
    Comments

    Added

    Control0..*
    Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging