Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2025-09-22 |
Definitions for the zib-AdministrationSchedule data type profile.
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
Definition | Specifications 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. |
Short | AdministeringSchedule |
Alternate Names | Toedieningsschema |
2. Timing.repeat | |
4. Timing.repeat.bounds[x] | |
Definition | The intended time duration for these dosing instructions. |
Short | DoseDuration |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Alternate Names | Doseerduur |
6. Timing.repeat.duration | |
Definition | Defines the amount of time during which medication is being administered. This is used especially in the context of administering liquids. |
Short | Duration of administration |
Alternate Names | Toedieninsgduur |
8. Timing.repeat.durationUnit | |
Definition | Defines the unit for the amount of time during which medication is being administered. This is used especially in the context of administering liquids. |
Short | Duration unit of administration |
Alternate Names | Toedieninsgduur |
10. Timing.repeat.frequency | |
Definition | The 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'. |
Short | Frequency |
Alternate Names | frequentie, frequentie vaste waarde, frequentie min |
12. Timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency (min)] and [frequencyMax] times within the period or period range. |
Short | maximumValue |
Alternate Names | maximumWaarde |
14. Timing.repeat.period | |
Definition | Interval 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) |
Short | Interval |
Comments | In FHIR, the HCIM concepts Interval and Frequency are represented with the elements Timing.repeat.frequency, Timing.repeat.period and Timing.repeat.periodUnit. |
Alternate Names | Interval, Frequentie |
16. Timing.repeat.periodUnit | |
Definition | Interval 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) |
Comments | 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. |
Alternate Names | Interval, Frequentie |
18. Timing.repeat.dayOfWeek | |
Definition | WeekDay indicates a pattern of doses on fixed week days. |
Short | WeekDay |
Comments | Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. |
Alternate Names | Weekdagen |
20. Timing.repeat.timeOfDay | |
Short | AdministrationTime |
Comments | If there's a timeOfDay, there cannot be a when, or vice versa. |
Alternate Names | Toedientijd |
22. Timing.repeat.when | |
Definition | Time of day: morning, afternoon, evening, night. |
Short | TimeOfDay |
Alternate Names | Dagdeel |
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
Definition | Specifications 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. 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. |
Short | AdministeringScheduleA timing schedule that specifies an event that may occur multiple times |
Comments | 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Alternate Names | Toedieningsschema |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Timing | |
Definition | Specifications 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. |
Short | AdministeringSchedule |
Comments | 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Alternate Names | Toedieningsschema |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) |
2. Timing.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
4. Timing.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Timing.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Timing.event | |
Definition | Identifies specific times when the event occurs. |
Short | When the event occurs |
Control | 0..* |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | In an MAR, for instance, you need to take a general specification, and turn it into a precise specification. |
8. Timing.repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Short | When the event is to occur |
Control | 0..1 |
Type | Element |
Summary | true |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) )tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0 )tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists() )tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists() )tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists() )tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists() )tim-10: If there's a timeOfDay, there cannot be be a when, or vice versa ( timeOfDay.empty() or when.empty() )tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists() )tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0 ) |
10. Timing.repeat.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
12. Timing.repeat.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on Timing.repeat.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. Timing.repeat.bounds[x] | |
Definition | The intended time duration for these dosing instructions. |
Short | DoseDuration |
Control | 0..1 |
Type | Choice of: Duration, Range, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Summary | true |
Alternate Names | Doseerduur |
16. Timing.repeat.count | |
Definition | A total count of the desired number of repetitions. |
Short | Number of times to repeat |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Repetitions may be limited by end time or total occurrences. |
18. Timing.repeat.countMax | |
Definition | A maximum value for the count of the desired repetitions (e.g. do something 6-8 times). |
Short | Maximum number of times to repeat |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
20. Timing.repeat.duration | |
Definition | Defines the amount of time during which medication is being administered. This is used especially in the context of administering liquids. |
Short | Duration of administration |
Comments | 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). |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Alternate Names | Toedieninsgduur |
22. Timing.repeat.durationMax | |
Definition | The upper limit of how long this thing happens for when it happens. |
Short | How long when it happens (Max) |
Comments | 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). |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
24. Timing.repeat.durationUnit | |
Definition | Defines the unit for the amount of time during which medication is being administered. This is used especially in the context of administering liquids. |
Short | Duration unit of administration |
Control | 0..1 |
Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 )A unit of time (units from UCUM). |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Toedieninsgduur |
26. Timing.repeat.frequency | |
Definition | The 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'. |
Short | Frequency |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | frequentie, frequentie vaste waarde, frequentie min |
Default Value | 1 |
28. Timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency (min)] and [frequencyMax] times within the period or period range. |
Short | maximumValue |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | maximumWaarde |
30. Timing.repeat.period | |
Definition | Interval 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) |
Short | Interval |
Comments | In FHIR, the HCIM concepts Interval and Frequency are represented with the elements Timing.repeat.frequency, Timing.repeat.period and Timing.repeat.periodUnit. |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Interval, Frequentie |
32. Timing.repeat.periodMax | |
Definition | 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. |
Short | Upper limit of period (3-4 hours) |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
34. Timing.repeat.periodUnit | |
Definition | Interval 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) |
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Comments | 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|3.0.2 )A unit of time (units from UCUM). |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Interval, Frequentie |
36. Timing.repeat.dayOfWeek | |
Definition | WeekDay indicates a pattern of doses on fixed week days. |
Short | WeekDay |
Comments | Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. |
Control | 0..* |
Binding | The codes SHALL be taken from DaysOfWeek (required to http://hl7.org/fhir/ValueSet/days-of-week|3.0.2 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Weekdagen |
38. Timing.repeat.timeOfDay | |
Definition | Specified time of day for action to take place. |
Short | AdministrationTime |
Comments | If there's a timeOfDay, there cannot be a when, or vice versa. |
Control | 0..* |
Type | time |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Toedientijd |
40. Timing.repeat.when | |
Definition | Time of day: morning, afternoon, evening, night. |
Short | TimeOfDay |
Comments | When more than one event is listed, the event is tied to the union of the specified events. |
Control | 0..* |
Binding | The codes SHALL be taken from EventTiming (required to http://hl7.org/fhir/ValueSet/event-timing|3.0.2 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Alternate Names | Dagdeel |
42. Timing.repeat.offset | |
Definition | 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. |
Short | Minutes from event (before or after) |
Control | 0..1 |
Type | unsignedInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
44. Timing.code | |
Definition | A 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). |
Short | BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + |
Comments | 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). |
Control | 0..1 |
Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation|3.0.2 )Code for a known / defined timing pattern. |
Type | CodeableConcept |
Summary | true |