DSTU2
This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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": "2015-10-24T07:41:03.495+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": "other",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"description": "Base StructureDefinition for Timing Type",
"requirements": "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.0.2",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "datatype",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Element",
"snapshot": {
"element": [
{
"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": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "QSET<TS> (GTS)"
}
]
},
{
"path": "Timing.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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>"
}
]
},
{
"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-3",
"severity": "error",
"human": "Either frequency or when can exist, not both",
"xpath": "not((f:period or f:frequency) and f:when)"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"xpath": "not(exists(f:duration)) or exists(f:durationUnits)"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"xpath": "not(exists(f:period)) or exists(f:periodUnits)"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"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",
"xpath": "not(exists(f:durationMax)) or exists(f:duration)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Implies PIVL or EIVL"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
},
{
"code": "Range"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "IVL(TS) used in a QSI"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"xpath": "@value >= 0 or not(@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.repeat.durationUnits",
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"xpath": "@value >= 0 or not(@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.repeat.periodUnits",
"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"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.code",
"short": "QD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +",
"definition": "A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes.",
"comments": "A repeat should always be defined except for the common codes BID, TID, QID, AM and PM, which all systems are required to understand.",
"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": [
{
"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": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "QSET<TS> (GTS)"
}
]
},
{
"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>"
}
]
},
{
"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-3",
"severity": "error",
"human": "Either frequency or when can exist, not both",
"xpath": "not((f:period or f:frequency) and f:when)"
},
{
"key": "tim-1",
"severity": "error",
"human": "if there's a duration, there needs to be duration units",
"xpath": "not(exists(f:duration)) or exists(f:durationUnits)"
},
{
"key": "tim-2",
"severity": "error",
"human": "if there's a period, there needs to be period units",
"xpath": "not(exists(f:period)) or exists(f:periodUnits)"
},
{
"key": "tim-6",
"severity": "error",
"human": "If there's a periodMax, there must be a period",
"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",
"xpath": "not(exists(f:durationMax)) or exists(f:duration)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Implies PIVL or EIVL"
}
]
},
{
"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": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
},
{
"code": "Range"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "IVL(TS) used in a QSI"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "tim-4",
"severity": "error",
"human": "duration SHALL be a non-negative value",
"xpath": "@value >= 0 or not(@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase / EIVL.offset"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.repeat.durationUnits",
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "tim-5",
"severity": "error",
"human": "period SHALL be a non-negative value",
"xpath": "@value >= 0 or not(@value)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "PIVL.phase"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.repeat.periodUnits",
"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"
}
]
},
{
"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"
}
]
},
{
"path": "Timing.code",
"short": "QD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +",
"definition": "A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes.",
"comments": "A repeat should always be defined except for the common codes BID, TID, QID, AM and PM, which all systems are required to understand.",
"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 DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change