Timing

$10 / year

Timing 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.

Complexity

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. The Timing data type allows modifier extensions.

If the timing schedule has repeating criteria, the repeat can occur a given number of times per the specified duration or in relation to some repeating real-world event. If no end condition is specified, the schedule will terminate on some criteria that are expressed elsewhere. Many systems avoid the complexity of the Timing structure by using a text field for timing instructions. This maps to Timing.code.text.

Note, though, that some systems include timing details in something like ‘Dosage instructions’ which is wider than just Timing; those systems do not use the Timing data type. Other systems use a set of ‘common’ codes – including, but usually not limited to, widely understood acronyms such as “bis in die (BID)” which means in Latin, twice a day. If a Timing.code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data (except for Timing.repeat.bounds, which applies to the code), and either the code or the data may be used to interpret the Timing. A structured timing specification should be provided whenever possible, unless the code is BID, ter in die (TID) which in Latin means three times a day, quater in die (QID) which in Latin means four times a day, ante meridiem (AM) which in Latin means Before Midday or Post Meridiem (PM) which in Latin means After Midday, which have a ubiquitous meaning.

These codes shall be understood as having the formal meanings. Note that 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, timeOfDay).

Timing is used in the following places:
– Dosage
– TriggerDefinition
– ActivityDefinition
– CarePlan
– ChargeItem
– Contract
– DeviceMetric
– DeviceRequest
– DeviceUseStatement
– EvidenceVariable
– NutritionOrder
– Observation
– PlanDefinition
– RequestGroup
– ResearchElementDefinition
– ServiceRequest
– SupplyDelivery
– SupplyRequest
– VerificationResult

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Timing Datatype, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItems
Timingid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
TimingextensionarrayMay 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.{'$ref': '#/definitions/Extension'}
TimingmodifierExtensionarrayMay 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).{'$ref': '#/definitions/Extension'}
TimingeventarrayIdentifies specific times when the event occurs.{'$ref': '#/definitions/dateTime'}
Timing_eventarrayExtensions for event{'$ref': '#/definitions/Element'}
Timingrepeat#/definitions/Timing_RepeatA set of rules that describe when the event is scheduled.
Timingcode#/definitions/CodeableConceptA 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).
Related Data Packages