ScheduleTimeline
An ordered schedule: an entry point, a sequence of scheduled instances, the timings between them and one or more exits. A study has one main timeline and may have others for sub-schedules.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 13, 6 required
- NCI code
- C201348
Official definition
A chronological schedule of planned temporal events.
In practice
In a protocol document: The schedule of activities table as a whole.
Attributes
13 attributes, 6 of them required by the USDM API schema and 1 holding the id of another object instead of the object itself (marked by id).
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the schedule timeline. |
| label | string | cardinality 0..1 | The short descriptive designation for the schedule timeline. |
| description | string | cardinality 0..1 | A narrative representation of the schedule timeline. |
| entryConditionrequired | string | cardinality 1 | A logical evaluation on which rests the validity of entry into a schedule timeline. |
| mainTimelinerequired | boolean | cardinality 1 | An indication as to whether the timeline or timeline component is part of the central or principal timeline. |
| plannedDuration | Duration | cardinality 0..1 | The period of time over which the scheduled timeline is intended to take place. |
| instances | ScheduledInstance | cardinality 0..* | A USDM relationship between the ScheduleTimeline and ScheduledInstance classes which identifies the set of scheduled instances (e.g., scheduled activity instances or scheduled decision instances) associated with the scheduled timeline. |
| entryIdrequired | ScheduledInstanceby id | cardinality 1 | A USDM relationship between the ScheduleTimeline and ScheduledInstance classes which defines the entry into a scheduled instance (e.g., scheduled activity instances or scheduled decision instances) for a timeline. |
| exits | ScheduleTimelineExit | cardinality 0..* | A USDM relationship between the ScheduleTimeline and ScheduleTimelineExit classes which identifies the set of exits from the scheduled timeline. |
| timings | Timing | cardinality 0..* | A USDM relationship between the ScheduleTimeline and Timing classes which identifies the set of timings associated with the scheduled timeline. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model. |
Smallest valid ScheduleTimeline
The attributes a JSON file must carry for a ScheduleTimeline, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.
{
"id": "ScheduleTimeline_1",
"name": string,
"entryCondition": string,
"mainTimeline": boolean,
"entryId": id of ScheduledInstance,
"instanceType": "ScheduleTimeline"
}
Where ScheduleTimeline is used
These classes hold or point to a ScheduleTimeline.
- Activity.timelineIdby id
- ScheduledActivityInstance.timelineIdby id
- StudyDesign.scheduleTimelinesnested
Example
A ScheduleTimeline from the example study. Coded values are shortened to one line.
{
"id": "ScheduleTimeline_1",
"name": "MAIN_TIMELINE",
"label": "Main timeline",
"description": "The schedule every participant follows from screening to follow-up.",
"mainTimeline": true,
"entryCondition": "Potential participant identified.",
"entryId": "ScheduledActivityInstance_1",
"plannedDuration": {
"id": "Duration_3",
"text": "16 weeks",
"quantity": {
"id": "Quantity_7",
"value": 16,
"unit": { "standardCode": { "code": "C29844", "decode": "Week", … }, … },
"instanceType": "Quantity"
},
"durationWillVary": false,
"instanceType": "Duration"
},
"instances": [
{
"id": "ScheduledActivityInstance_1",
"name": "SCREENING_INSTANCE",
"label": "Screening",
"epochId": "StudyEpoch_1",
"encounterId": "Encounter_1",
"activityIds": [
"Activity_1",
"Activity_2",
"Activity_3",
"Activity_4",
"Activity_5",
"Activity_6",
"Activity_11"
],
"defaultConditionId": "ScheduledActivityInstance_2",
"instanceType": "ScheduledActivityInstance"
},
{
"id": "ScheduledActivityInstance_2",
"name": "DAY_1_INSTANCE",
"label": "Day 1",
"epochId": "StudyEpoch_2",
"encounterId": "Encounter_2",
"activityIds": [
"Activity_2",
"Activity_4",
"Activity_6",
"Activity_7",
"Activity_8",
"Activity_10",
"Activity_11"
],
"defaultConditionId": "ScheduledActivityInstance_3",
"instanceType": "ScheduledActivityInstance"
},
{
"id": "ScheduledActivityInstance_3",
"name": "WEEK_2_INSTANCE",
"label": "Week 2",
"epochId": "StudyEpoch_2",
"encounterId": "Encounter_3",
"activityIds": [
"Activity_4",
"Activity_10",
"Activity_11"
],
"defaultConditionId": "ScheduledActivityInstance_4",
"instanceType": "ScheduledActivityInstance"
},
{
"id": "ScheduledActivityInstance_4",
"name": "WEEK_6_INSTANCE",
"label": "Week 6",
"epochId": "StudyEpoch_2",
"encounterId": "Encounter_4",
"activityIds": [
"Activity_4",
"Activity_6",
"Activity_8",
"Activity_9",
"Activity_10",
"Activity_11"
],
"defaultConditionId": "ScheduledActivityInstance_5",
"instanceType": "ScheduledActivityInstance"
},
{
"id": "ScheduledActivityInstance_5",
"name": "WEEK_12_INSTANCE",
"label": "Week 12",
"epochId": "StudyEpoch_2",
"encounterId": "Encounter_5",
"activityIds": [
"Activity_4",
"Activity_5",
"Activity_6",
"Activity_9",
"Activity_10",
"Activity_11"
],
"defaultConditionId": "ScheduledActivityInstance_6",
"instanceType": "ScheduledActivityInstance"
},
{
"id": "ScheduledActivityInstance_6",
"name": "FOLLOW_UP_INSTANCE",
"label": "Follow-up",
"epochId": "StudyEpoch_3",
"encounterId": "Encounter_6",
"activityIds": [
"Activity_10",
"Activity_11"
],
"timelineExitId": "ScheduleTimelineExit_1",
"instanceType": "ScheduledActivityInstance"
}
],
"timings": [
{
"id": "Timing_1",
"name": "SCREENING_TIMING",
"label": "Day -14",
"description": "Screening is planned 14 days before Day 1.",
"type": { "code": "C201357", "decode": "Before", … },
"value": "P14D",
"valueLabel": "14 days",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_1",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_2",
"windowLower": "P7D",
"windowUpper": "P7D",
"windowLabel": "-7..+7 days",
"instanceType": "Timing"
},
{
"id": "Timing_2",
"name": "DAY_1_TIMING",
"label": "Day 1",
"description": "Day 1 is the fixed reference point for the schedule.",
"type": { "code": "C201358", "decode": "Fixed Reference", … },
"value": "P1D",
"valueLabel": "Day 1",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_2",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_2",
"instanceType": "Timing"
},
{
"id": "Timing_3",
"name": "WEEK_2_TIMING",
"label": "Day 15",
"description": "Week 2 is planned 14 days after Day 1.",
"type": { "code": "C201356", "decode": "After", … },
"value": "P14D",
"valueLabel": "14 days",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_3",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_2",
"windowLower": "P2D",
"windowUpper": "P2D",
"windowLabel": "-2..+2 days",
"instanceType": "Timing"
},
{
"id": "Timing_4",
"name": "WEEK_6_TIMING",
"label": "Day 43",
"description": "Week 6 is planned 42 days after Day 1.",
"type": { "code": "C201356", "decode": "After", … },
"value": "P42D",
"valueLabel": "42 days",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_4",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_2",
"windowLower": "P3D",
"windowUpper": "P3D",
"windowLabel": "-3..+3 days",
"instanceType": "Timing"
},
{
"id": "Timing_5",
"name": "WEEK_12_TIMING",
"label": "Day 85",
"description": "Week 12 is planned 84 days after Day 1.",
"type": { "code": "C201356", "decode": "After", … },
"value": "P84D",
"valueLabel": "84 days",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_5",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_2",
"windowLower": "P3D",
"windowUpper": "P3D",
"windowLabel": "-3..+3 days",
"instanceType": "Timing"
},
{
"id": "Timing_6",
"name": "FOLLOW_UP_TIMING",
"label": "Day 99",
"description": "Follow-up is planned 14 days after the Week 12 visit.",
"type": { "code": "C201356", "decode": "After", … },
"value": "P14D",
"valueLabel": "14 days",
"relativeToFrom": { "code": "C201355", "decode": "Start to Start", … },
"relativeFromScheduledInstanceId": "ScheduledActivityInstance_6",
"relativeToScheduledInstanceId": "ScheduledActivityInstance_5",
"windowLower": "P3D",
"windowUpper": "P3D",
"windowLabel": "-3..+3 days",
"instanceType": "Timing"
}
],
"exits": [
{
"id": "ScheduleTimelineExit_1",
"instanceType": "ScheduleTimelineExit"
}
],
"instanceType": "ScheduleTimeline"
}
Related classes
Other classes in schedule and timing: