This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-datatype-timing | Version: 2.1.0 | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: PASTiming | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.24.42.55 |
PAS constraints on the Timing datatype used in the various service requests.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Timing
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times | |
Slices for extension | Content/Rules for all slices | |||
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) |
repeat | ||||
bounds[x] | S | 0..1 | Duration | The number of periods over which the service is delivered. |
period | S | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
repeat | ΣC | 0..1 | Element | When the event is to occur ele-1: All FHIR elements must have a @value or children tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
bounds[x] | SΣ | 0..1 | Duration | The number of periods over which the service is delivered. ele-1: All FHIR elements must have a @value or children |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period ele-1: All FHIR elements must have a @value or children |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
bounds[x] | SΣ | 0..1 | Duration | The number of periods over which the service is delivered. |
count | Σ | 0..1 | positiveInt | Number of times to repeat |
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
duration | Σ | 0..1 | decimal | How long when it happens |
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | |
Timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
Timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard |
This structure is derived from Timing
Summary
Must-Support: 5 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from Timing
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times | |
Slices for extension | Content/Rules for all slices | |||
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) |
repeat | ||||
bounds[x] | S | 0..1 | Duration | The number of periods over which the service is delivered. |
period | S | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
repeat | ΣC | 0..1 | Element | When the event is to occur ele-1: All FHIR elements must have a @value or children tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
bounds[x] | SΣ | 0..1 | Duration | The number of periods over which the service is delivered. ele-1: All FHIR elements must have a @value or children |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period ele-1: All FHIR elements must have a @value or children |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Timing | 0..* | Timing | A timing schedule that specifies an event that may occur multiple times | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
calendarPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingcalendarpattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/07/00/678 (required): Codes which specifies the routine shipments, deliveries, or calendar pattern. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
deliveryPattern | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-timingdeliverypattern Binding: https://valueset.x12.org/x217/005010/request/2000F/HSD/1/08/00/679 (required) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
bounds[x] | SΣ | 0..1 | Duration | The number of periods over which the service is delivered. |
count | Σ | 0..1 | positiveInt | Number of times to repeat |
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
duration | Σ | 0..1 | decimal | How long when it happens |
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
Timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | |
Timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
Timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard |
This structure is derived from Timing
Summary
Must-Support: 5 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron