EHDS Logical Information Models
0.4.0 - draft

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.4.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: Dosage obligations

Official URL: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDosageObligations Version: 0.4.0
Draft as of 2026-02-22 Computable Name: EHDSDosageObligations

Obligations for the logical model for dosage.

Usages:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails 0..* Base Details of single dosage scheme step
.... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosage steps. When two schemes share the same sequence number, they are meant to be running in parallel.
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
..... dose[x] O 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
ObligationsActor
SHALL:able-to-populate Producer
...... doseQuantity Quantity
...... doseRange Range
..... rate[x] 0..1 Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
...... rateQuantity Quantity
...... rateRatio Ratio
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
...... boundsQuantity Quantity
...... boundsPeriod Period
..... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
Binding Description: (preferred): UCUM
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Exact time of day of administration (e.g '10:00')
..... eventTime 0..* CodeableConcept Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
.... asNeeded 0..1 boolean Take as needed
.... bodySite 0..1 EHDSBodyStructure Body site of administration
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
Binding Description: (preferred): EDQM Standard Terms
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EHDSDosage.dosageDetails.​doseAndRate.dose[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​doseAndRate.rate[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.bounds[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.duration Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.frequency.period Base preferred Not State Unknown
EHDSDosage.dosageDetails.​routeOfAdministration Base preferred Not State Unknown

This structure is derived from EHDSDosage

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate
..... dose[x] O 0..1 Quantity, Range Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
ObligationsActor
SHALL:able-to-populate Producer
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Quantity, Period Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
ObligationsActor
SHALL:able-to-populate Producer
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
ObligationsActor
SHALL:able-to-populate Producer
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails 0..* Base Details of single dosage scheme step
.... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosage steps. When two schemes share the same sequence number, they are meant to be running in parallel.
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
..... dose[x] O 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
ObligationsActor
SHALL:able-to-populate Producer
...... doseQuantity Quantity
...... doseRange Range
..... rate[x] 0..1 Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
...... rateQuantity Quantity
...... rateRatio Ratio
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
...... boundsQuantity Quantity
...... boundsPeriod Period
..... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
Binding Description: (preferred): UCUM
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Exact time of day of administration (e.g '10:00')
..... eventTime 0..* CodeableConcept Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
.... asNeeded 0..1 boolean Take as needed
.... bodySite 0..1 EHDSBodyStructure Body site of administration
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
Binding Description: (preferred): EDQM Standard Terms
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EHDSDosage.dosageDetails.​doseAndRate.dose[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​doseAndRate.rate[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.bounds[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.duration Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.frequency.period Base preferred Not State Unknown
EHDSDosage.dosageDetails.​routeOfAdministration Base preferred Not State Unknown

This structure is derived from EHDSDosage

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails 0..* Base Details of single dosage scheme step
.... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosage steps. When two schemes share the same sequence number, they are meant to be running in parallel.
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
..... dose[x] O 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
ObligationsActor
SHALL:able-to-populate Producer
...... doseQuantity Quantity
...... doseRange Range
..... rate[x] 0..1 Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
...... rateQuantity Quantity
...... rateRatio Ratio
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
...... boundsQuantity Quantity
...... boundsPeriod Period
..... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
Binding Description: (preferred): UCUM
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Exact time of day of administration (e.g '10:00')
..... eventTime 0..* CodeableConcept Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
.... asNeeded 0..1 boolean Take as needed
.... bodySite 0..1 EHDSBodyStructure Body site of administration
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
Binding Description: (preferred): EDQM Standard Terms
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EHDSDosage.dosageDetails.​doseAndRate.dose[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​doseAndRate.rate[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.bounds[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.duration Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.frequency.period Base preferred Not State Unknown
EHDSDosage.dosageDetails.​routeOfAdministration Base preferred Not State Unknown

Differential View

This structure is derived from EHDSDosage

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate
..... dose[x] O 0..1 Quantity, Range Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
ObligationsActor
SHALL:able-to-populate Producer
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Quantity, Period Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
ObligationsActor
SHALL:able-to-populate Producer
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
ObligationsActor
SHALL:able-to-populate Producer
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDosage 0..* EHDSDosage Dosage model
... renderedDosageInstruction O 0..1 string Full dosage information as human-readable text covering all dosage steps. Generating the text follows local rules and should include all locally implemented dosage data even when such elements are not present in this model.
ObligationsActor
SHOULD:able-to-populate Producer
... dosageDetails 0..* Base Details of single dosage scheme step
.... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosage steps. When two schemes share the same sequence number, they are meant to be running in parallel.
.... note O 0..1 string Patient oriented instructions as free text for this dosage step
ObligationsActor
SHOULD:able-to-populate Producer
.... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
..... dose[x] O 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
ObligationsActor
SHALL:able-to-populate Producer
...... doseQuantity Quantity
...... doseRange Range
..... rate[x] 0..1 Amount of medication per time period (e.g. 100mg per 1 hour). When rate is provided per 1 time unit, Quantity data type can be used with a suitable unit (e.g. mg/h, ug/min).
Binding Description: (preferred): UCUM (units of measurement), EDQM Standard Terms (units of presentation)
...... rateQuantity Quantity
...... rateRatio Ratio
.... repeat O 0..1 Base Repetition of the administration.
ObligationsActor
SHALL:able-to-populate Producer
..... bounds[x] O 0..1 Time bounds for the treatment (current dosage scheme), Quantity contains a number of time units (e.g 10 days), Period contains start and end date (e.g. 05.08.2023 - 10.08.2023).
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
...... boundsQuantity Quantity
...... boundsPeriod Period
..... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
Binding Description: (preferred): UCUM
..... frequency O 0..1 Base Frequency of intake/administration (e.g 'three times a day')
ObligationsActor
SHALL:able-to-populate Producer
...... numberOfTimes O 0..1 integer Number of times per period (e.g '3 times')
ObligationsActor
SHALL:able-to-populate Producer
...... period O 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
Binding Description: (preferred): UCUM
ObligationsActor
SHALL:able-to-populate Producer
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Exact time of day of administration (e.g '10:00')
..... eventTime 0..* CodeableConcept Time period or event when the administration should happen ('before meal', 'immediately', 'morning')
.... asNeeded 0..1 boolean Take as needed
.... bodySite 0..1 EHDSBodyStructure Body site of administration
.... routeOfAdministration O 0..1 CodeableConcept Route of administration
Binding Description: (preferred): EDQM Standard Terms
ObligationsActor
SHOULD:able-to-populate Producer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EHDSDosage.dosageDetails.​doseAndRate.dose[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​doseAndRate.rate[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.bounds[x] Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.duration Base preferred Not State Unknown
EHDSDosage.dosageDetails.​repeat.frequency.period Base preferred Not State Unknown
EHDSDosage.dosageDetails.​routeOfAdministration Base preferred Not State Unknown

This structure is derived from EHDSDosage

Summary

 

Other representations of profile: CSV, Excel