Timing | Medplum
Base StructureDefinition for 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.
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details 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. 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. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details 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). 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. |
|
| event | dateTime[] | When the event occurs Details Identifies specific times when the event occurs. |
|
| repeat | Element | When the event is to occur Details A set of rules that describe when the event is scheduled. |
|
| bounds[x] | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Details 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. |
|
| count | positiveInt | Number of times to repeat Details 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. |
|
| countMax | positiveInt | Maximum number of times to repeat Details If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
|
| duration | decimal | How long when it happens Details 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). |
|
| durationMax | decimal | How long when it happens (Max) Details If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. 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). |
|
| durationUnit | code | s | |
| frequency | positiveInt | Event occurs frequency times per period Details 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. |
|
| frequencyMax | positiveInt | Event occurs up to frequencyMax times per period Details If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
|
| period | decimal | Event occurs frequency times per period Details 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. |
|
| periodMax | decimal | Upper limit of period (3-4 hours) Details 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. |
|
| periodUnit | code | s | |
| dayOfWeek | code[] | mon | |
| timeOfDay | time[] | Time of day for action Details 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. The elements when, frequency and period cannot be used as well as timeOfDay. |
|
| when | code[] | Code for time period of occurrence Details 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. |
|
| offset | unsignedInt | Minutes from event (before or after) Details 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. |
|
| code | CodeableConcept | BID |