FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
Timing
Base StructureDefinition for Timing Type
- type Profile on Timing
- FHIR STU3
- status Draft
-
versionnone
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
Timing | Element | Element idTiming A timing schedule that specifies an event that may occur multiple times DefinitionSpecifies 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. A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idTiming.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idTiming.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
event | Σ | 0..* | dateTime | Element idTiming.event When the event occurs DefinitionIdentifies specific times when the event occurs. In an MAR, for instance, you need to take a general specification, and turn it into a precise specification.
|
repeat | Σ I | 0..1 | Element | Element idTiming.repeat When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTiming.repeat.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idTiming.repeat.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
bounds[x] | Σ | 0..1 | Element idTiming.repeat.bounds[x] Length/Range of lengths, or (Start and/or end) limits DefinitionEither 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.
| |
boundsDuration | Duration | Data type | ||
boundsRange | Range | Data type | ||
boundsPeriod | Period | Data type | ||
count | Σ | 0..1 | integer | Element idTiming.repeat.count Number of times to repeat DefinitionA total count of the desired number of repetitions. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
|
countMax | Σ | 0..1 | integer | Element idTiming.repeat.countMax Maximum number of times to repeat DefinitionA maximum value for the count of the desired repetitions (e.g. do something 6-8 times). 32 bit number; for values larger than this, use decimal
|
duration | Σ | 0..1 | decimal | Element idTiming.repeat.duration How long when it happens DefinitionHow long this thing happens for when it happens. Some activities are not instantaneous and need to be maintained for a period of time. 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 | Σ | 0..1 | decimal | Element idTiming.repeat.durationMax How long when it happens (Max) DefinitionThe upper limit of how long this thing happens for when it happens. Some activities are not instantaneous and need to be maintained for a period of time. 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 | Σ | 0..1 | codeBinding | Element idTiming.repeat.durationUnit s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units. A unit of time (units from UCUM). ?? (required)Constraints
|
frequency | Σ | 0..1 | integer | Element idTiming.repeat.frequency Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). 32 bit number; for values larger than this, use decimal
1
|
frequencyMax | Σ | 0..1 | integer | Element idTiming.repeat.frequencyMax Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. 32 bit number; for values larger than this, use decimal
|
period | Σ | 0..1 | decimal | Element idTiming.repeat.period Event occurs frequency times per period DefinitionIndicates 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. Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodMax | Σ | 0..1 | decimal | Element idTiming.repeat.periodMax Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodUnit | Σ | 0..1 | codeBinding | Element idTiming.repeat.periodUnit s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units. A unit of time (units from UCUM). ?? (required)Constraints
|
dayOfWeek | Σ | 0..* | codeBinding | Element idTiming.repeat.dayOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIf 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. The elements frequency and period cannot be used as well as dayOfWeek. ?? (required) Constraints
|
timeOfDay | Σ | 0..* | time | Element idTiming.repeat.timeOfDay Time of day for action DefinitionSpecified 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 | Σ | 0..* | codeBinding | Element idTiming.repeat.when Regular life events the event is tied to DefinitionReal world events that the occurrence of the event should be tied to. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real world event relating to the schedule. ?? (required)Constraints
|
offset | Σ | 0..1 | unsignedInt | Element idTiming.repeat.offset Minutes from event (before or after) DefinitionThe 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 | Σ | 0..1 | CodeableConceptBinding | Element idTiming.code BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + DefinitionA code for the timing schedule. 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 the a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. ?? (preferred)Constraints
|