Name Flags Card. Type Description & Constraints <a href="datatypes-definitions.html#Timing" title="Timing : 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.">Timing ΣN Element A timing schedule that specifies an event that may occur multiple times Elements defined in Ancestors: id, <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension, <a href="types.html#BackboneType" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension #xD; event Σ 0..* dateTime When the event occurs #xD; repeat ΣC 0..1 Element When the event is to occur + Rule: if there's a duration, there needs to be duration units + Rule: if there's a period, there needs to be period units + Rule: duration SHALL be a non-negative value + Rule: period SHALL be a non-negative value + Rule: If there's a periodMax, there must be a period + Rule: If there's a durationMax, there must be a duration + Rule: If there's a countMax, there must be a count + Rule: If there's an offset, there must be a when (and not C, CM, CD, CV) + Rule: If there's a timeOfDay, there cannot be a when, or vice versa + Rule: Only use startOffset when frequency is present and > 1 + Rule: Only use endOffset when frequency is present and > 1 #xD; bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits #xD; boundsDuration Duration #xD; boundsRange Range #xD; boundsPeriod Period #xD; count ΣC 0..1 positiveInt Number of times to repeat #xD; countMax ΣC 0..1 positiveInt Maximum number of times to repeat #xD; duration ΣC 0..1 decimal How long when it happens #xD; durationMax ΣC 0..1 decimal How long when it happens (Max) #xD; durationUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (Required) #xD; frequency Σ 0..1 positiveInt Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period #xD; frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period #xD; period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period #xD; periodMax ΣC 0..1 decimal Upper limit of period (3-4 hours) #xD; periodUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (Required) #xD; startOffset Σ 0..1 SimpleQuantity Events within the repeat period do not start until startOffset has elapsed #xD; endOffset Σ 0..1 SimpleQuantity Events within the repeat period step once endOffset before the end of the period #xD; dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun Binding: Days Of Week (Required) #xD; timeOfDay ΣC 0..* time Time of day for action #xD; when ΣC 0..* code Code for time period of occurrence Binding: EventTiming (Required) #xD; offset ΣC 0..1 unsignedInt Minutes from event (before or after) #xD; <a href="datatypes-definitions.html#Timing.code" title="Timing.code : 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).">code Σ 0..1 CodeableConcept C | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (Preferred) #xD; Documentation for this format
Timing Type: 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.
Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals.
A timing schedule that specifies an event that may occur multiple times
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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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](extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Identifies specific times when the event occurs.
In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
A set of rules that describe when the event is scheduled.
Many timing schedules are determined by regular repetitions.
All FHIR elements must have a @value or children or both
if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
if there's a period, there needs to be period units
If there's a periodMax, there must be a period
If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
If there's a countMax, there must be a count
If there's an offset, there must be a when (and not C, CM, CD, CV)
offset.empty() or (when.exists() and when.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())
If there's a timeOfDay, there cannot be a when, or vice versa
Only use startOffset when frequency is present and > 1
startOffset.exists() implies (frequency > 1)
Only use endOffset when frequency is present and > 1
endOffset.exists() implies (frequency > 1)
Length/Range of lengths, or (Start and/or end) limits
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.
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.
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Repetitions may be limited by end time or total occurrences.
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
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.
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).
Some activities are not instantaneous and need to be maintained for a period of time.
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
s | min | h | d | wk | mo | a - unit of time (UCUM)
The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
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.
If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Event occurs up to frequencyMax times per period
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
The duration to which the frequency applies. I.e. Event occurs frequency times per period
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.
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.
The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
Events within the repeat period do not start until startOffset has elapsed
Indicates that the events within the period of the repeat do not start until startOffset has elapsed.
This element is defined to support interlaced schedules, e.g. for different actions that happen on different days, but that have repeat cycles that are tied together by the context. This is a usually encountered in Dosages.
Events within the repeat period step once endOffset before the end of the period
Indicates that the events within the period of the repeat step endOffset before the period ends.
This element is defined for medication schedules that cycle like 'do something for X days, and then stop for Y days'. This can only apply where the window for repeats has a defined or known end time.
If one or more days of week is provided, then the action happens only on the specified day(s).
If no days are specified, the action is assumed to happen every day as otherwise specified.
Specified time of day for action to take place.
When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa.
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
When more than one event is listed, the event is tied to the union of the specified events.
Timings are frequently determined by occurrences such as waking, eating and sleep.
Real-world event relating to the schedule.
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.
C | BID | TID | QID | AM | PM | QD | QOD | +
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).
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).
Code for a known / defined timing pattern.