HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

This page is part of the HL7 Europe Imaging Study Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: Dosaging model

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDosaging Version: 0.1.0
Draft as of 2025-03-21 Computable Name: EHDSDosaging

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

Logical model for usage instructions for administring the requested product. Based on FHIR Dosage complex data type. When implemented, this model may be reduced significantly according to the specific use case.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

This structure is derived from Base

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSDosaging 0..* Base Dosaging model
Instances of this logical model can be the target of a Reference
... sequence 0..1 integer Order of the dosage instruction, in case one treatment consists of several dosaging schemes
... text 0..1 string Free text usage/dosage instructions
... additionalInstruction 0..* CodeableConcept Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc
... doseAndRate 0..* Base Amount of medication administered per one dose (= one timing)
.... type 0..1 CodeableConcept The kind of dose or rate specified (e.g calculated, ordered, etc).
.... dose[x] 0..1 Amount of medication per one dose. (1 tablet, 2-3 tablets, 20ml)
..... doseQuantity Quantity
..... doseRange Range
.... rate[x] 0..1 Time period during which one defined dose is administered (per 1 hour, per 5-10 minutes)
..... rateRatio Ratio
..... rateQuantity Quantity
..... rateRange Range
... timing 0..1 Base When medication should be administered (period, time of day, frequency, etc)
.... event 0..* dateTime Exact date and/or time of the administration
.... code 0..1 CodeableConcept Timing abbreviation (AM - morning, Q4H - once in every 4 hours, BID - twice a day, etc)
.... repeat 0..1 Base Repetition of the administration.
..... bounds 0..1 Base Time bounds for the treatment (current dosaging scheme). Only one of the following can exist.
...... duration 0..1 Quantity Number of time units, e.g 10 days
...... range 0..1 Range A range of numbers of time units, 5-10 days
...... period 0..1 Period Start and end date, 05.08.2023 - 10.08.2023
..... count 0..1 Base Number of times to repeat, exact or range
...... count 0..1 integer Number of times (e.g 'once', '10 times')
...... countMax 0..1 integer Maximum number of times (e.g 'maximum 10 times')
..... duration 0..1 Base Duration of one administration, exact or range
...... duration 0..1 Quantity Duration of administration (e.g '5 minutes', '1 hour')
...... durationMax 0..1 Quantity Maximum duration of administration (e.g 'maximum 1 hour')
..... frequency 0..1 Base Frequency of intake/administration (e.g 'three times a day')
...... numberOfTimes 0..1 integer Number of times per period (e.g '3 times')
...... maxNumberOfTimes 0..1 integer Maximum number of times per period (e.g. 'maximum 3 times')
...... period 0..1 Quantity Duration to which the frequency applies (e.g '... / 1 day')
...... periodMax 0..1 Quantity Upper limit of the period (e.g ... / 4-6 hours)
..... dayOfWeek 0..* CodeableConcept The day of the week of administration, e.g Mon, Tue, etc
..... timeOfDay 0..* time Time of day of administration (e.g '10:00')
..... eventTime 0..* Base An event the administration is bound to, e.g 'before meal', '30 min before meal'
...... when 0..* CodeableConcept Time period or event ('before meal', 'immediately', 'morning')
...... offset 0..1 integer minutes from event, before or after (?not sure how to show before/after with only positive integers)
... asNeeded 0..1 boolean Take as needed
... asNeededFor 0..* CodeableConcept Take as needed for the coded reason
... bodySite 0..1 CodeableConcept Body site of administration
... routeOfAdministration 0..1 CodeableConcept Route of administration
... methodOfAdministration 0..1 CodeableConcept Method of administration
... maxDose 0..* Base Maximum dose for the patient
.... maxDosePerPeriod 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration 0..1 Quantity Upper limit on medication per one administration
.... maxDosePerLifetime 0..1 Quantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

This structure is derived from Base

Summary

 

Other representations of profile: CSV, Excel