This page is part of the Medication IG DE (vballot1: Releases Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. 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
Draft as of 2025-07-11 |
Definitions for the TimingDgMP data type profile.
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
Definition | Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out. |
Short | A timing schedule that specifies an event that may occur multiple times |
Comments | Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events. A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. Timing.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 manageable, 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..* This element is affected by the following invariants: ele-1 |
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()) |
4. Timing.event | |
Definition | Identifies specific times when the event occurs. |
Short | When the event occurs |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
6. Timing.repeat | |
Definition | Eine Menge von Regeln, die beschreiben, wann das Ereignis geplant ist. A set of rules that describe when the event is scheduled. |
Short | Wann das Ereignis stattfinden sollWhen the event is to occur |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Element |
Must Support | true |
Summary | true |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))) tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists()) tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists()) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty()) tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0) TimingOnlyOneType: Only one kind of Timing is allowed. Current allowed timings: 4-Scheme, TimeOfDay, DayOfWeek, Interval, DayOfWeek and Time/4-Schema, Interval and Time/4-Schema ( ( /* 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* TimeOfDay */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
) or
/* Interval */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
) or
/* Interval and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.dayOfWeek.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
)TimingIntervalOnlyOneFrequency: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect Interval */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.when.empty()
and timing.repeat.timeOfDay.empty()
and timing.repeat.dayOfWeek.empty()
)
/* Only One Dosage allowed for Interval */
implies
(
(
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies (
%resource.dosageInstruction.count() = 1
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.count() = 1
)
)
)
)TimingOnlyOneWhen: Dosages Timings must not state the same period of day across multiple dosage instances ( ( /* Detect 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)TimingOnlyOneTimeOfDay: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect TimeOfDay */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
)
)
) )TimingOnlyOneDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.dayOfWeek.distinct().count() = %resource.dosageInstruction.timing.repeat.dayOfWeek.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.dayOfWeek.distinct().count() = %resource.dosage.timing.repeat.dayOfWeek.count())
)
)
) )TimingOnlyOnePeriodForDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek and Time/4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
)
) )TimingOnlyOneTimeForInterval: Dosages Timings must not state the same time of day across multiple dosage instances ( /*
Detect DayOfWeek and Time/4-Schema
This logic checks for dosage instructions that specify either timeOfDay or when,
but not both, and ensures certain consistency rules for frequency, period, and periodUnit.
*/
(
/* Combine dosage instructions from all relevant resource types */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
/* Check for required timing fields and ensure dayOfWeek is not used */
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.dayOfWeek.empty()
and (
/* Either timeOfDay is set (and when is not), or when is set (and timeOfDay is not) */
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty())
or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
/* For MedicationRequest or MedicationDispense */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across instructions */
%resource.dosageInstruction.timing.repeat.frequency.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.period.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each instruction must have a unique timeOfDay and when value */
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
and
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
)
and
(
/* For MedicationStatement resources */
%resource.ofType(MedicationStatement).exists()
implies
(
/* If MedicationRequest or MedicationDispense also exists */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across statements */
%resource.dosage.timing.repeat.frequency.distinct().count() = 1
and %resource.dosage.timing.repeat.period.distinct().count() = 1
and %resource.dosage.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each statement must have a unique timeOfDay and when value */
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
and
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)
)TimingOnlyOneBounds: Dosages Timings must not state the same bounds duration across multiple dosage instances ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
( /* only one different value and code are allowed*/
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
%resource.dosageInstruction.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosageInstruction.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosageInstruction.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosage.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosage.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
)
) ) |
8. Timing.repeat.bounds[x] | |
Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
Short | Länge/Bereich der Längen oder (Start- und/oder End-)GrenzenLength/Range of lengths, or (Start and/or end) limits |
Comments | tbd |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Duration, Period, Range |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Timing.repeat.bounds[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
10. Timing.repeat.bounds[x]:boundsDuration | |
Slice Name | boundsDuration |
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
Short | Dauer der Dosieranweisung ausgedrückt in UCUM-EinheitenLength/Range of lengths, or (Start and/or end) limits |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Duration, Period, Range |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Timing.repeat.bounds[x]:boundsDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Short | < | <= | >= | > - how to understand the value |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 )How the Quantity should be understood and represented. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Timing.repeat.bounds[x]:boundsDuration.unit | |
Definition | A human-readable form of the unit. |
Short | Unit representation |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Timing.repeat.bounds[x]:boundsDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Short | UCUM-Einheit für die DauerSystem that defines coded unit form |
Comments | Die UCUM-Einheit für die Dauer, z. B. d für Tag, h für Stunde, min für Minute. see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Fixed Value | http://unitsofmeasure.org |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Timing.repeat.bounds[x]:boundsDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Short | Coded form of the unit |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from For codes, see Zeiteinheiten für die DurationUnit in Dosierungen im dgMP (required to http://ig.fhir.de/igs/medication/ValueSet/DosageUnitsOfTimeDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Timing.repeat.count | |
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. |
Short | Number of times to repeat |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Repetitions may be limited by end time or total occurrences. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Timing.repeat.countMax | |
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
Short | Maximum number of times to repeat |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Timing.repeat.duration | |
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. |
Short | How long when it happens |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Timing.repeat.durationMax | |
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
Short | How long when it happens (Max) |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Timing.repeat.frequency | |
Definition | Die Anzahl der Wiederholungen innerhalb des angegebenen Zeitraums. Falls frequencyMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Häufigkeit an. The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. |
Short | Ereignis tritt frequency-mal pro Zeitraum aufEvent occurs frequency times per period |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. Timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Short | Event occurs up to frequencyMax times per period |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. Timing.repeat.period | |
Definition | Gibt die Zeitspanne an, über die die Wiederholungen stattfinden sollen; z. B. um „3-mal täglich“ auszudrücken, wäre 3 die Häufigkeit und „1 Tag“ der Zeitraum. Falls periodMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Zeitspanne an. Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. |
Short | Ereignis tritt frequency-mal pro Zeitraum aufEvent occurs frequency times per period |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Timing.repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Short | Upper limit of period (3-4 hours) |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Timing.repeat.periodUnit | |
Definition | Die Zeiteinheit für den Zeitraum, in UCUM-Einheiten. The units of time for the period in UCUM units. |
Short | s | min | h | d | wk | mo | a - Zeiteinheit (UCUM)s | min | h | d | wk | mo | a - unit of time (UCUM) |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Zeiteinheiten für PeriodUnit in Dosierungen im dgMPhttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://ig.fhir.de/igs/medication/ValueSet/PeriodUnitsOfTimeDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. Timing.repeat.dayOfWeek | |
Definition | Wenn ein oder mehrere Wochentage angegeben sind, findet die Aktion nur an den angegebenen Tagen statt. If one or more days of week is provided, then the action happens only on the specified day(s). |
Short | mon | tue | wed | thu | fri | sat | sun |
Comments | Wenn keine Tage angegeben sind, wird angenommen, dass die Aktion an jedem Tag wie sonst angegeben stattfindet. If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Timing.repeat.timeOfDay | |
Definition | Angegebene Tageszeit, zu der die Aktion stattfinden soll. Specified time of day for action to take place. |
Short | Tageszeit für die AktionTime of day for action |
Comments | Wenn eine Tageszeit angegeben ist, wird angenommen, dass die Aktion jeden Tag (ggf. gefiltert durch dayOfWeek) zu den angegebenen Zeiten stattfindet. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | time |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Timing.repeat.when | |
Definition | Ein ungefährer Zeitraum während des Tages, der möglicherweise mit einem Ereignis des täglichen Lebens verknüpft ist und angibt, wann die Aktion stattfinden soll. An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
Short | Code für den Zeitraum des AuftretensCode for time period of occurrence |
Comments | Wenn mehr als ein Ereignis angegeben ist, bezieht sich das Ereignis auf die Vereinigung der angegebenen Ereignisse. When more than one event is listed, the event is tied to the union of the specified events. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from TimingWhenDgMPhttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 (required to http://ig.fhir.de/igs/medication/ValueSet/TimingWhenDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. Timing.repeat.offset | |
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
Short | Minutes from event (before or after) |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. Timing.code | |
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). |
Short | BID | TID | QID | AM | PM | QD | QOD | + |
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation )Code for a known / defined timing pattern. |
Type | CodeableConcept |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
2. Timing.event | |
Control | 0..0 |
4. Timing.repeat | |
Control | 1..? |
Invariants | TimingOnlyOneType: Only one kind of Timing is allowed. Current allowed timings: 4-Scheme, TimeOfDay, DayOfWeek, Interval, DayOfWeek and Time/4-Schema, Interval and Time/4-Schema (( /* 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* TimeOfDay */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
) or
/* Interval */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
) or
/* Interval and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.dayOfWeek.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
)TimingIntervalOnlyOneFrequency: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect Interval */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.when.empty()
and timing.repeat.timeOfDay.empty()
and timing.repeat.dayOfWeek.empty()
)
/* Only One Dosage allowed for Interval */
implies
(
(
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies (
%resource.dosageInstruction.count() = 1
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.count() = 1
)
)
)
)TimingOnlyOneWhen: Dosages Timings must not state the same period of day across multiple dosage instances ( ( /* Detect 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)TimingOnlyOneTimeOfDay: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect TimeOfDay */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
)
)
) )TimingOnlyOneDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.dayOfWeek.distinct().count() = %resource.dosageInstruction.timing.repeat.dayOfWeek.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.dayOfWeek.distinct().count() = %resource.dosage.timing.repeat.dayOfWeek.count())
)
)
) )TimingOnlyOnePeriodForDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek and Time/4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
)
) )TimingOnlyOneTimeForInterval: Dosages Timings must not state the same time of day across multiple dosage instances ( /*
Detect DayOfWeek and Time/4-Schema
This logic checks for dosage instructions that specify either timeOfDay or when,
but not both, and ensures certain consistency rules for frequency, period, and periodUnit.
*/
(
/* Combine dosage instructions from all relevant resource types */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
/* Check for required timing fields and ensure dayOfWeek is not used */
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.dayOfWeek.empty()
and (
/* Either timeOfDay is set (and when is not), or when is set (and timeOfDay is not) */
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty())
or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
/* For MedicationRequest or MedicationDispense */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across instructions */
%resource.dosageInstruction.timing.repeat.frequency.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.period.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each instruction must have a unique timeOfDay and when value */
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
and
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
)
and
(
/* For MedicationStatement resources */
%resource.ofType(MedicationStatement).exists()
implies
(
/* If MedicationRequest or MedicationDispense also exists */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across statements */
%resource.dosage.timing.repeat.frequency.distinct().count() = 1
and %resource.dosage.timing.repeat.period.distinct().count() = 1
and %resource.dosage.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each statement must have a unique timeOfDay and when value */
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
and
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)
)TimingOnlyOneBounds: Dosages Timings must not state the same bounds duration across multiple dosage instances ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
( /* only one different value and code are allowed*/
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
%resource.dosageInstruction.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosageInstruction.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosageInstruction.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosage.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosage.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
)
) ) |
6. Timing.repeat.bounds[x] | |
Type | Duration, Period, Range |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
8. Timing.repeat.bounds[x]:boundsDuration | |
Slice Name | boundsDuration |
Type | Duration |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
10. Timing.repeat.bounds[x]:boundsDuration.unit | |
Control | 1..? |
Must Support | true |
12. Timing.repeat.bounds[x]:boundsDuration.system | |
Control | 1..? |
Must Support | true |
14. Timing.repeat.bounds[x]:boundsDuration.code | |
Control | 1..? |
Binding | The codes SHALL be taken from Zeiteinheiten für die DurationUnit in Dosierungen im dgMP (required to http://ig.fhir.de/igs/medication/ValueSet/DosageUnitsOfTimeDgMP ) |
Must Support | true |
16. Timing.repeat.count | |
Control | 0..0 |
18. Timing.repeat.countMax | |
Control | 0..0 |
20. Timing.repeat.duration | |
Control | 0..0 |
22. Timing.repeat.durationMax | |
Control | 0..0 |
24. Timing.repeat.durationUnit | |
Control | 0..0 |
26. Timing.repeat.frequencyMax | |
Control | 0..0 |
28. Timing.repeat.periodMax | |
Control | 0..0 |
30. Timing.repeat.periodUnit | |
Binding | The codes SHALL be taken from Zeiteinheiten für PeriodUnit in Dosierungen im dgMP (required to http://ig.fhir.de/igs/medication/ValueSet/PeriodUnitsOfTimeDgMP ) |
Must Support | true |
32. Timing.repeat.when | |
Binding | The codes SHALL be taken from TimingWhenDgMP (required to http://ig.fhir.de/igs/medication/ValueSet/TimingWhenDgMP ) |
34. Timing.repeat.offset | |
Control | 0..0 |
36. Timing.code | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
Definition | Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out. |
Short | A timing schedule that specifies an event that may occur multiple times |
Comments | Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events. A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. Timing.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 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
4. Timing.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 manageable, 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..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standard Status | Normative (from Normative) |
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 Timing.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Timing.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 manageable, 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..* This element is affected by the following invariants: ele-1 |
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() ) |
8. Timing.event | |
Definition | Identifies specific times when the event occurs. |
Short | When the event occurs |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. Timing.repeat | |
Definition | Eine Menge von Regeln, die beschreiben, wann das Ereignis geplant ist. |
Short | Wann das Ereignis stattfinden soll |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Element |
Must Support | true |
Summary | true |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) )tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0 )tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists() )tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists() )tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists() )tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists() )tim-10: If there's a timeOfDay, there cannot be a when, or vice versa ( timeOfDay.empty() or when.empty() )tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists() )tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0 )TimingOnlyOneType: Only one kind of Timing is allowed. Current allowed timings: 4-Scheme, TimeOfDay, DayOfWeek, Interval, DayOfWeek and Time/4-Schema, Interval and Time/4-Schema ( ( /* 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* TimeOfDay */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
) or
/* Interval */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
) or
/* DayOfWeek and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
) or
/* Interval and Time/4-Schema */
(%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
timing.repeat.frequency.exists() and
timing.repeat.period.exists() and
timing.repeat.periodUnit.exists() and
timing.repeat.dayOfWeek.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
)TimingIntervalOnlyOneFrequency: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect Interval */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.when.empty()
and timing.repeat.timeOfDay.empty()
and timing.repeat.dayOfWeek.empty()
)
/* Only One Dosage allowed for Interval */
implies
(
(
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies (
%resource.dosageInstruction.count() = 1
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.count() = 1
)
)
)
)TimingOnlyOneWhen: Dosages Timings must not state the same period of day across multiple dosage instances ( ( /* Detect 4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.when.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.timeOfDay.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)TimingOnlyOneTimeOfDay: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect TimeOfDay */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.timeOfDay.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.dayOfWeek.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
)
)
) )TimingOnlyOneDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
timing.repeat.when.empty() and
timing.repeat.timeOfDay.empty()
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(%resource.dosageInstruction.timing.repeat.dayOfWeek.distinct().count() = %resource.dosageInstruction.timing.repeat.dayOfWeek.count())
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(%resource.dosage.timing.repeat.dayOfWeek.distinct().count() = %resource.dosage.timing.repeat.dayOfWeek.count())
)
)
) )TimingOnlyOnePeriodForDayOfWeek: Dosages Timings must not state the same time of day across multiple dosage instances ( ( /* Detect DayOfWeek and Time/4-Schema */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.exists() and
timing.repeat.frequency.empty() and
timing.repeat.period.empty() and
timing.repeat.periodUnit.empty() and
(
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty()) or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
(
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosageInstruction.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosageInstruction.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
(
/* For each day of week */
/* if Mon occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'mon')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'mon').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('mon' in dayOfWeek).timeOfDay.count())
)) and
/* if tue occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'tue')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'tue').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('tue' in dayOfWeek).timeOfDay.count())
)) and
/* if wed occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'wed')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'wed').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('wed' in dayOfWeek).timeOfDay.count())
)) and
/* if thu occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'thu')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'thu').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('thu' in dayOfWeek).timeOfDay.count())
)) and
/* if fri occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'fri')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'fri').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('fri' in dayOfWeek).timeOfDay.count())
)) and
/* if sat occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sat')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sat').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sat' in dayOfWeek).timeOfDay.count())
)) and
/* if sun occurs multiple times */
((
%resource.dosage.timing.repeat.dayOfWeek
.where($this = 'sun')
.where(%resource.dosage.timing.repeat.dayOfWeek.where($this = 'sun').count() > 1)
.distinct()
) implies
(
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).when.count()) and
(%resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.distinct().count() = %resource.dosage.timing.repeat.where('sun' in dayOfWeek).timeOfDay.count())
))
)
)
)
) )TimingOnlyOneTimeForInterval: Dosages Timings must not state the same time of day across multiple dosage instances ( /*
Detect DayOfWeek and Time/4-Schema
This logic checks for dosage instructions that specify either timeOfDay or when,
but not both, and ensures certain consistency rules for frequency, period, and periodUnit.
*/
(
/* Combine dosage instructions from all relevant resource types */
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
)
.all(
(
/* Check for required timing fields and ensure dayOfWeek is not used */
timing.repeat.frequency.exists()
and timing.repeat.period.exists()
and timing.repeat.periodUnit.exists()
and timing.repeat.dayOfWeek.empty()
and (
/* Either timeOfDay is set (and when is not), or when is set (and timeOfDay is not) */
(timing.repeat.timeOfDay.exists() and timing.repeat.when.empty())
or
(timing.repeat.when.exists() and timing.repeat.timeOfDay.empty())
)
)
implies
(
/* For MedicationRequest or MedicationDispense */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across instructions */
%resource.dosageInstruction.timing.repeat.frequency.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.period.distinct().count() = 1
and %resource.dosageInstruction.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each instruction must have a unique timeOfDay and when value */
(%resource.dosageInstruction.timing.repeat.timeOfDay.distinct().count() = %resource.dosageInstruction.timing.repeat.timeOfDay.count())
and
(%resource.dosageInstruction.timing.repeat.when.distinct().count() = %resource.dosageInstruction.timing.repeat.when.count())
)
)
and
(
/* For MedicationStatement resources */
%resource.ofType(MedicationStatement).exists()
implies
(
/* If MedicationRequest or MedicationDispense also exists */
(
%resource.ofType(MedicationRequest).exists()
or %resource.ofType(MedicationDispense).exists()
)
implies
(
/* All intervals must be the same across statements */
%resource.dosage.timing.repeat.frequency.distinct().count() = 1
and %resource.dosage.timing.repeat.period.distinct().count() = 1
and %resource.dosage.timing.repeat.periodUnit.distinct().count() = 1
)
and
(
/* Each statement must have a unique timeOfDay and when value */
(%resource.dosage.timing.repeat.timeOfDay.distinct().count() = %resource.dosage.timing.repeat.timeOfDay.count())
and
(%resource.dosage.timing.repeat.when.distinct().count() = %resource.dosage.timing.repeat.when.count())
)
)
)
)
)TimingOnlyOneBounds: Dosages Timings must not state the same bounds duration across multiple dosage instances ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
( /* only one different value and code are allowed*/
(%resource.ofType(MedicationRequest).exists() or %resource.ofType(MedicationDispense).exists())
implies
%resource.dosageInstruction.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosageInstruction.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosageInstruction.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
and
(
%resource.ofType(MedicationStatement).exists()
implies
%resource.dosage.timing.repeat.boundsDuration.exists().not() or
(
(%resource.dosage.timing.repeat.boundsDuration.value.distinct().count() = 1)
and
(%resource.dosage.timing.repeat.boundsDuration.code.distinct().count() = 1)
)
)
)
) ) |
12. Timing.repeat.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 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
14. Timing.repeat.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 manageable, 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..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standard Status | Normative (from Normative) |
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 Timing.repeat.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Timing.repeat.bounds[x] | |
Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. |
Short | Länge/Bereich der Längen oder (Start- und/oder End-)Grenzen |
Comments | tbd |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Duration |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Timing.repeat.bounds[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
18. Timing.repeat.bounds[x]:boundsDuration | |
Slice Name | boundsDuration |
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
Short | Dauer der Dosieranweisung ausgedrückt in UCUM-Einheiten |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Duration |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Timing.repeat.bounds[x]:boundsDuration.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 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
22. Timing.repeat.bounds[x]:boundsDuration.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 manageable, 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..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Standard Status | Normative (from Normative) |
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 Timing.repeat.bounds[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
24. Timing.repeat.bounds[x]:boundsDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Short | Numerical value (with implicit precision) |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Timing.repeat.bounds[x]:boundsDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Short | < | <= | >= | > - how to understand the value |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 )How the Quantity should be understood and represented. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. Timing.repeat.bounds[x]:boundsDuration.unit | |
Definition | A human-readable form of the unit. |
Short | Unit representation |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. Timing.repeat.bounds[x]:boundsDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Short | UCUM-Einheit für die Dauer |
Comments | Die UCUM-Einheit für die Dauer, z. B. d für Tag, h für Stunde, min für Minute. |
Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Fixed Value | http://unitsofmeasure.org |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. Timing.repeat.bounds[x]:boundsDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Short | Coded form of the unit |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Zeiteinheiten für die DurationUnit in Dosierungen im dgMP (required to http://ig.fhir.de/igs/medication/ValueSet/DosageUnitsOfTimeDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Timing.repeat.count | |
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. |
Short | Number of times to repeat |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Repetitions may be limited by end time or total occurrences. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. Timing.repeat.countMax | |
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
Short | Maximum number of times to repeat |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. Timing.repeat.duration | |
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. |
Short | How long when it happens |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. Timing.repeat.durationMax | |
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
Short | How long when it happens (Max) |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. Timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. Timing.repeat.frequency | |
Definition | Die Anzahl der Wiederholungen innerhalb des angegebenen Zeitraums. Falls frequencyMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Häufigkeit an. |
Short | Ereignis tritt frequency-mal pro Zeitraum auf |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. Timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Short | Event occurs up to frequencyMax times per period |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
48. Timing.repeat.period | |
Definition | Gibt die Zeitspanne an, über die die Wiederholungen stattfinden sollen; z. B. um „3-mal täglich“ auszudrücken, wäre 3 die Häufigkeit und „1 Tag“ der Zeitraum. Falls periodMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Zeitspanne an. |
Short | Ereignis tritt frequency-mal pro Zeitraum auf |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. Timing.repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Short | Upper limit of period (3-4 hours) |
Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. Timing.repeat.periodUnit | |
Definition | Die Zeiteinheit für den Zeitraum, in UCUM-Einheiten. |
Short | s | min | h | d | wk | mo | a - Zeiteinheit (UCUM) |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Zeiteinheiten für PeriodUnit in Dosierungen im dgMP (required to http://ig.fhir.de/igs/medication/ValueSet/PeriodUnitsOfTimeDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. Timing.repeat.dayOfWeek | |
Definition | Wenn ein oder mehrere Wochentage angegeben sind, findet die Aktion nur an den angegebenen Tagen statt. |
Short | mon | tue | wed | thu | fri | sat | sun |
Comments | Wenn keine Tage angegeben sind, wird angenommen, dass die Aktion an jedem Tag wie sonst angegeben stattfindet. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from DaysOfWeek (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. Timing.repeat.timeOfDay | |
Definition | Angegebene Tageszeit, zu der die Aktion stattfinden soll. |
Short | Tageszeit für die Aktion |
Comments | Wenn eine Tageszeit angegeben ist, wird angenommen, dass die Aktion jeden Tag (ggf. gefiltert durch dayOfWeek) zu den angegebenen Zeiten stattfindet. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | time |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Timing.repeat.when | |
Definition | Ein ungefährer Zeitraum während des Tages, der möglicherweise mit einem Ereignis des täglichen Lebens verknüpft ist und angibt, wann die Aktion stattfinden soll. |
Short | Code für den Zeitraum des Auftretens |
Comments | Wenn mehr als ein Ereignis angegeben ist, bezieht sich das Ereignis auf die Vereinigung der angegebenen Ereignisse. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from TimingWhenDgMP (required to http://ig.fhir.de/igs/medication/ValueSet/TimingWhenDgMP ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. Timing.repeat.offset | |
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
Short | Minutes from event (before or after) |
Comments | 32 bit number; for values larger than this, use decimal |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. Timing.code | |
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). |
Short | BID | TID | QID | AM | PM | QD | QOD | + |
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation )Code for a known / defined timing pattern. |
Type | CodeableConcept |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |