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.
Query
-
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.
API
-
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.
Tools
-
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.
Organization Nictiz /
Project Nictiz STU3 Zib 2017
HCIM AdministrationSchedule
This profile is based on the Dutch Health and Care Information (HCIM) models (Dutch: Zorginformatiebouwsteen or ZIB) InstructionsForUse-AdministeringSchedule version 1.1, year 2017.
Resources shown in this project should be considered unstable and not suited for immediate implementation. Stable versions can be found in the released packages. Implementation guides (IGs) that build on the packages in this project, may be found at informatiestandaarden.nictiz.nl. Each IG explicitly calls out which package version to use. Always consult the implementation guide for the correct package.
- type Profile on Timing
- FHIR STU3
- status prerelease
-
version2.1.6
Valid canonical
This resource matches a canonical claim from this project.
Claim: http://nictiz.nl/fhir/
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| Zib AdministrationSchedule (Timing) | Timing | Element idTiming AdministeringSchedule Alternate namesToedieningsschema DefinitionSpecifications of the times at which the medication is to be administered. This is indicated as follows: Time(s) (16:00) or indications (“before meals”) at which the medication is to be taken each day. A specific number of times the medication is to be taken each day ("3x a day"), indicated with the frequency A time interval between consecutive doses (“Every 2 hours”, “every 3 days”), indicated with the word Interval. Combined periods with an interval and duration (“1 daily for three out of four weeks: the pill schedule”) If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications: One or more week days on which the medication is to be administered (e.g. “Monday, Wednesday, Friday”) ”3x a week”, “2x a month”. The specified administration “infinite” is automatically to be repeated until: The end date and time has been reached The total administration duration has been reached (14 days) A specific amount of administrations has been reached (“20 doses”, “one-time only”), to be entered in the NumberOfDoses concept. 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 | There are no (further) constraints on this element 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 | There are no (further) constraints on this 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] DoseDuration Alternate namesDoseerduur DefinitionThe intended time duration for these dosing instructions.
| |
| boundsDuration | Duration | There are no (further) constraints on this element Data type | ||
| boundsRange | Range | There are no (further) constraints on this element Data type | ||
| boundsPeriod | Period | There are no (further) constraints on this element Data type | ||
| count | Σ | 0..1 | integer | There are no (further) constraints on this element 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 | There are no (further) constraints on this element 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).
|
| duration | Σ | 0..1 | decimal | Element idTiming.repeat.duration Duration of administration Alternate namesToedieninsgduur DefinitionDefines the amount of time during which medication is being administered. This is used especially in the context of administering liquids. 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 | There are no (further) constraints on this element 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 Duration unit of administration Alternate namesToedieninsgduur DefinitionDefines the unit for the amount of time during which medication is being administered. This is used especially in the context of administering liquids. A unit of time (units from UCUM). UnitsOfTime (required)Mappings
|
| frequency | Σ | 0..1 | integer | Element idTiming.repeat.frequency Frequency Alternate namesfrequentie, frequentie vaste waarde, frequentie min DefinitionThe frequency indicates the number of dose moments per time unit, usually per day. If this frequency is included, then the Interval will not have been included. Usually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). In that case, a reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). The time unit of the frequency must be the same as how it is indicated in the textual description of the dose. Example: for a '2x a day...' dose: amount = 2 time unit = 'day'. for a '3x a week...' dose: amount = 3 time unit = 'week'. 1
|
| frequencyMax | Σ | 0..1 | integer | Element idTiming.repeat.frequencyMax maximumValue Alternate namesmaximumWaarde DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency (min)] and [frequencyMax] times within the period or period range.
|
| period | Σ | 0..1 | decimal | Element idTiming.repeat.period Interval Alternate namesInterval, Frequentie DefinitionInterval indicates the time between dose times. If this is included, then the <i>Frequency </i>will not have been included. Examples: every 4 hours, every 3 weeks. The times can now be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics) In FHIR, the HCIM concepts Interval and Frequency are represented with the elements Timing.repeat.frequency, Timing.repeat.period and Timing.repeat.periodUnit.
|
| periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element 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.
|
| periodUnit | Σ | 0..1 | codeBinding | Element idTiming.repeat.periodUnit s | min | h | d | wk | mo | a - unit of time (UCUM) Alternate namesInterval, Frequentie DefinitionInterval indicates the time between dose times. If this is included, then the <i>Frequency </i>will not have been included. Examples: every 4 hours, every 3 weeks. The times can now be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics) The unit of time for the information given in Timing.repeat.period. In FHIR, the HCIM concepts Interval and Frequency are represented with the elements Timing.repeat.frequency, Timing.repeat.period and Timing.repeat.periodUnit. A unit of time (units from UCUM). UnitsOfTime (required)Mappings
|
| dayOfWeek | Σ | 0..* | codeBinding | Element idTiming.repeat.dayOfWeek WeekDay Alternate namesWeekdagen DefinitionWeekDay indicates a pattern of doses on fixed week days. Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. Permitted Values WeekdagCodelijst-to-days-of-week Mappings
|
| timeOfDay | Σ | 0..* | time | Element idTiming.repeat.timeOfDay AdministrationTime Alternate namesToedientijd DefinitionSpecified time of day for action to take place. If there's a timeOfDay, there cannot be a when, or vice versa.
|
| when | Σ | 0..* | codeBinding | Element idTiming.repeat.when TimeOfDay Alternate namesDagdeel DefinitionTime of day: morning, afternoon, evening, night. 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. EventTiming (required)Permitted Values DagdeelCodelijst-to-EventTiming Mappings
|
| offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element 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 | There are no (further) constraints on this element 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. TimingAbbreviation (preferred)Mappings
|
Last updated on