STU3 Candidate
FoundationThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for Timing
{
"resourceType": "StructureDefinition",
"id": "Timing",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Timing",
"name": "Timing",
"status": "draft",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for Timing Type",
"purpose": "Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals.",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "Timing",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Timing",
"path": "Timing",
"short": "A timing schedule that specifies an event that may occur multiple times",
"definition": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are 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.",
"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.",
"min": 0,
"max": "*",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "QSET<TS> (GTS)"
}
]
},
{
"id": "Timing.id",
"path": "Timing.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.extension",
"path": "Timing.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.event",
"path": "Timing.event",
"short": "When the event occurs",
"definition": "Identifies specific times when the event occurs.",
"requirements": "In an MAR, for instance, you need to take a general specification, and turn it into a precise specification.",
"min": 0,
"max": "*",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "QLIST<TS>"
}
]
},
{
"id": "Timing.repeat",
"path": "Timing.repeat",
"short": "When the event is to occur",
"definition": "A set of rules that describe when the event should occur.",
"requirements": "Many timing schedules are determined by regular repetitions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Element"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "tim-9",
"severity": "error",
"human": "If there's an offset, there must be a when",
"expression": "offset.empty() or when.exists()",
"xpath": "not(exists(f:offset)) or exists(f:when)"
},
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"expression": "period.exists() implies period >= 0",
"xpath": "f:period/@value >= 0 or not(f:period/@value)"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"expression": "periodMax.empty() or period.exists()",
"xpath": "not(exists(f:periodMax)) or exists(f:period)"
},
{
"key": "tim-7",
"severity": "error",
"human": "If there's a durationMax, there must be a duration",
"expression": "durationMax.empty() or duration.exists()",
"xpath": "not(exists(f:durationMax)) or exists(f:duration)"
},
{
"key": "tim-8",
"severity": "error",
"human": "If there's a countMax, there must be a count",
"expression": "countMax.empty() or count.exists()",
"xpath": "not(exists(f:countMax)) or exists(f:count)"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"expression": "duration.empty() or durationUnit.exists()",
"xpath": "not(exists(f:duration)) or exists(f:durationUnit)"
},
{
"key": "tim-10",
"severity": "error",
"human": "If there's a timeOfDay, there cannot be be a when, a frequency, or a period",
"expression": "timeOfDay.exists() implies (when.empty() and frequency.empty() and period.empty())",
"xpath": "not(exists(f:timeofDay)) or (not(exists(f:when)) and not(exists(f:frequency)) and not (exists(f:period)))"
},
{
"key": "tim-11",
"severity": "error",
"human": "If there's a dayOfWeek, there cannot be be a frequency, or a period",
"expression": "dayOfWeek.exists() implies (frequency.empty() and period.empty())",
"xpath": "not(exists(f:timeofDay)) or (not(exists(f:frequency)) and not (exists(f:period)))"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"expression": "period.empty() or periodUnit.exists()",
"xpath": "not(exists(f:period)) or exists(f:periodUnit)"
},
{
"key": "tim-3",
"severity": "error",
"human": "Either frequency or when can exist, not both",
"expression": "((period or frequency) and when).not()",
"xpath": "not((f:period or f:frequency) and f:when)"
},
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"expression": "duration.exists() implies duration >= 0",
"xpath": "f:duration/@value >= 0 or not(f:duration/@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Implies PIVL or EIVL"
}
]
},
{
"id": "Timing.repeat.id",
"path": "Timing.repeat.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.extension",
"path": "Timing.repeat.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.bounds[x]",
"path": "Timing.repeat.bounds[x]",
"short": "Length/Range of lengths, or (Start and/or end) limits",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
},
{
"code": "Range"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "IVL(TS) used in a QSI"
}
]
},
{
"id": "Timing.repeat.count",
"path": "Timing.repeat.count",
"short": "Number of times to repeat",
"definition": "A total count of the desired number of repetitions.",
"comments": "If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.",
"requirements": "Repetitions may be limited by end time or total occurrences.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.count"
}
]
},
{
"id": "Timing.repeat.countMax",
"path": "Timing.repeat.countMax",
"short": "Maximum number of times to repeat",
"definition": "A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.count"
}
]
},
{
"id": "Timing.repeat.duration",
"path": "Timing.repeat.duration",
"short": "How long when it happens",
"definition": "How long this thing happens for when it happens.",
"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).",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.durationMax",
"path": "Timing.repeat.durationMax",
"short": "How long when it happens (Max)",
"definition": "The upper limit of how long this thing happens for when it happens.",
"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).",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.durationUnit",
"path": "Timing.repeat.durationUnit",
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"definition": "The units of time for the duration, in UCUM units.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/units-of-time"
}
},
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase.unit"
}
]
},
{
"id": "Timing.repeat.frequency",
"path": "Timing.repeat.frequency",
"short": "Event occurs frequency times per period",
"definition": "The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"defaultValueInteger": 1,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.frequencyMax",
"path": "Timing.repeat.frequencyMax",
"short": "Event occurs up to frequencyMax times per period",
"definition": "If present, indicates that the frequency is a range - so repeat between [frequency] and [frequencyMax] times within the period or period range.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.period",
"path": "Timing.repeat.period",
"short": "Event occurs frequency times per period",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.periodMax",
"path": "Timing.repeat.periodMax",
"short": "Upper limit of period (3-4 hours)",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.periodUnit",
"path": "Timing.repeat.periodUnit",
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"definition": "The units of time for the period in UCUM units.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/units-of-time"
}
},
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase.unit"
}
]
},
{
"id": "Timing.repeat.dayOfWeek",
"path": "Timing.repeat.dayOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "If one or more days of week is provided, then the action happens only on the specified day(s).",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.timeOfDay",
"path": "Timing.repeat.timeOfDay",
"short": "Time of day for action",
"definition": "Specified time of day for action to take place.",
"comments": "When time of day is speciifed, 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.",
"min": 0,
"max": "*",
"type": [
{
"code": "time"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.when",
"path": "Timing.repeat.when",
"short": "Regular life events the event is tied to",
"definition": "A real world event that the occurrence of the event should be tied to.",
"requirements": "Timings are frequently determined by occurrences such as waking, eating and sleep.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Real world event that the relating to the schedule.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-timing"
}
},
"mapping": [
{
"identity": "rim",
"map": "EIVL.event"
}
]
},
{
"id": "Timing.repeat.offset",
"path": "Timing.repeat.offset",
"short": "Minutes from event (before or after)",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true
},
{
"id": "Timing.code",
"path": "Timing.code",
"short": "BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H +",
"definition": "A code for the timing pattern. 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.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "Code for a known / defined timing pattern.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/timing-abbreviation"
}
},
"mapping": [
{
"identity": "rim",
"map": "QSC.code"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Timing",
"path": "Timing",
"short": "A timing schedule that specifies an event that may occur multiple times",
"definition": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are 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.",
"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.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "QSET<TS> (GTS)"
}
]
},
{
"id": "Timing.event",
"path": "Timing.event",
"short": "When the event occurs",
"definition": "Identifies specific times when the event occurs.",
"requirements": "In an MAR, for instance, you need to take a general specification, and turn it into a precise specification.",
"min": 0,
"max": "*",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "QLIST<TS>"
}
]
},
{
"id": "Timing.repeat",
"path": "Timing.repeat",
"short": "When the event is to occur",
"definition": "A set of rules that describe when the event should occur.",
"requirements": "Many timing schedules are determined by regular repetitions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Element"
}
],
"constraint": [
{
"key": "tim-9",
"severity": "error",
"human": "If there's an offset, there must be a when",
"expression": "offset.empty() or when.exists()",
"xpath": "not(exists(f:offset)) or exists(f:when)"
},
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"expression": "period.exists() implies period >= 0",
"xpath": "f:period/@value >= 0 or not(f:period/@value)"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"expression": "periodMax.empty() or period.exists()",
"xpath": "not(exists(f:periodMax)) or exists(f:period)"
},
{
"key": "tim-7",
"severity": "error",
"human": "If there's a durationMax, there must be a duration",
"expression": "durationMax.empty() or duration.exists()",
"xpath": "not(exists(f:durationMax)) or exists(f:duration)"
},
{
"key": "tim-8",
"severity": "error",
"human": "If there's a countMax, there must be a count",
"expression": "countMax.empty() or count.exists()",
"xpath": "not(exists(f:countMax)) or exists(f:count)"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"expression": "duration.empty() or durationUnit.exists()",
"xpath": "not(exists(f:duration)) or exists(f:durationUnit)"
},
{
"key": "tim-10",
"severity": "error",
"human": "If there's a timeOfDay, there cannot be be a when, a frequency, or a period",
"expression": "timeOfDay.exists() implies (when.empty() and frequency.empty() and period.empty())",
"xpath": "not(exists(f:timeofDay)) or (not(exists(f:when)) and not(exists(f:frequency)) and not (exists(f:period)))"
},
{
"key": "tim-11",
"severity": "error",
"human": "If there's a dayOfWeek, there cannot be be a frequency, or a period",
"expression": "dayOfWeek.exists() implies (frequency.empty() and period.empty())",
"xpath": "not(exists(f:timeofDay)) or (not(exists(f:frequency)) and not (exists(f:period)))"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"expression": "period.empty() or periodUnit.exists()",
"xpath": "not(exists(f:period)) or exists(f:periodUnit)"
},
{
"key": "tim-3",
"severity": "error",
"human": "Either frequency or when can exist, not both",
"expression": "((period or frequency) and when).not()",
"xpath": "not((f:period or f:frequency) and f:when)"
},
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"expression": "duration.exists() implies duration >= 0",
"xpath": "f:duration/@value >= 0 or not(f:duration/@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Implies PIVL or EIVL"
}
]
},
{
"id": "Timing.repeat.bounds[x]",
"path": "Timing.repeat.bounds[x]",
"short": "Length/Range of lengths, or (Start and/or end) limits",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
},
{
"code": "Range"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "IVL(TS) used in a QSI"
}
]
},
{
"id": "Timing.repeat.count",
"path": "Timing.repeat.count",
"short": "Number of times to repeat",
"definition": "A total count of the desired number of repetitions.",
"comments": "If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.",
"requirements": "Repetitions may be limited by end time or total occurrences.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.count"
}
]
},
{
"id": "Timing.repeat.countMax",
"path": "Timing.repeat.countMax",
"short": "Maximum number of times to repeat",
"definition": "A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.count"
}
]
},
{
"id": "Timing.repeat.duration",
"path": "Timing.repeat.duration",
"short": "How long when it happens",
"definition": "How long this thing happens for when it happens.",
"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).",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.durationMax",
"path": "Timing.repeat.durationMax",
"short": "How long when it happens (Max)",
"definition": "The upper limit of how long this thing happens for when it happens.",
"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).",
"requirements": "Some activities are not instantaneous and need to be maintained for a period of time.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.durationUnit",
"path": "Timing.repeat.durationUnit",
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"definition": "The units of time for the duration, in UCUM units.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/units-of-time"
}
},
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase.unit"
}
]
},
{
"id": "Timing.repeat.frequency",
"path": "Timing.repeat.frequency",
"short": "Event occurs frequency times per period",
"definition": "The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"defaultValueInteger": 1,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"id": "Timing.repeat.frequencyMax",
"path": "Timing.repeat.frequencyMax",
"short": "Event occurs up to frequencyMax times per period",
"definition": "If present, indicates that the frequency is a range - so repeat between [frequency] and [frequencyMax] times within the period or period range.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.period",
"path": "Timing.repeat.period",
"short": "Event occurs frequency times per period",
"definition": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.periodMax",
"path": "Timing.repeat.periodMax",
"short": "Upper limit of period (3-4 hours)",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"id": "Timing.repeat.periodUnit",
"path": "Timing.repeat.periodUnit",
"short": "s | min | h | d | wk | mo | a - unit of time (UCUM)",
"definition": "The units of time for the period in UCUM units.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "A unit of time (units from UCUM).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/units-of-time"
}
},
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase.unit"
}
]
},
{
"id": "Timing.repeat.dayOfWeek",
"path": "Timing.repeat.dayOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "If one or more days of week is provided, then the action happens only on the specified day(s).",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.timeOfDay",
"path": "Timing.repeat.timeOfDay",
"short": "Time of day for action",
"definition": "Specified time of day for action to take place.",
"comments": "When time of day is speciifed, 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.",
"min": 0,
"max": "*",
"type": [
{
"code": "time"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Timing.repeat.when",
"path": "Timing.repeat.when",
"short": "Regular life events the event is tied to",
"definition": "A real world event that the occurrence of the event should be tied to.",
"requirements": "Timings are frequently determined by occurrences such as waking, eating and sleep.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Real world event that the relating to the schedule.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-timing"
}
},
"mapping": [
{
"identity": "rim",
"map": "EIVL.event"
}
]
},
{
"id": "Timing.repeat.offset",
"path": "Timing.repeat.offset",
"short": "Minutes from event (before or after)",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true
},
{
"id": "Timing.code",
"path": "Timing.code",
"short": "BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H +",
"definition": "A code for the timing pattern. 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.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "Code for a known / defined timing pattern.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/timing-abbreviation"
}
},
"mapping": [
{
"identity": "rim",
"map": "QSC.code"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change