Timing
The time between two scheduled instances, with an optional window. Timings are either a fixed reference (the anchor, usually Day 1) or relative: a duration before or after another instance.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 15, 8 required
- NCI code
- C80484
Official definition
The chronological relationship between temporal events.
In practice
In a protocol document: The visit day row and the visit window row of the schedule of activities.
Attributes
15 attributes, 8 of them required by the USDM API schema and 2 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 timing. |
| label | string | cardinality 0..1 | The short descriptive designation for the timing. |
| description | string | cardinality 0..1 | A narrative representation of the chronological relationship between temporal events. |
| typerequired | Code | cardinality 1 | A characterization or classification of the chronological relationship between temporal events.USDM codelist C201264, 3 values |
| relativeToFromrequired | Code | cardinality 1 | The name of the reference event used to define the temporal relationship with another event.USDM codelist C201265, 4 values |
| valuerequired | string | cardinality 1 | The temporal value of the chronological relationship between temporal events. |
| valueLabelrequired | string | cardinality 1 | The short descriptive designation for the timing value. |
| windowLabel | string | cardinality 0..1 | The short descriptive designation for a time period, or other type of interval, during which a temporal event may be achieved, obtained, or observed. |
| windowLower | string | cardinality 0..1 | The earliest chronological value of an allowable period of time during which a temporal event takes place. |
| windowUpper | string | cardinality 0..1 | The latest chronological value of an allowable period of time during which a temporal event takes place. |
| relativeToScheduledInstanceId | ScheduledInstanceby id | cardinality 0..1 | A USDM relationship between the Timing and ScheduledInstance classes which identifies the scheduled instance (e.g., scheduled activity instances or scheduled decision instances) to which the timing is relative to. |
| relativeFromScheduledInstanceIdrequired | ScheduledInstanceby id | cardinality 1 | A USDM relationship between the Timing and ScheduledInstance classes which identifies the scheduled instance (e.g., scheduled activity instances or scheduled decision instances) to which the timing applies. |
| 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. |
Allowed values
The coded attributes of Timing that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.
typecodelist C201264, not extensible
| Code | Term | Definition |
|---|---|---|
| C201356 | After | A type of time point relationship that follows a point or period of time within a timeline. |
| C201357 | Before | A type of time point relationship that comes before a point or period of time within a timeline. |
| C201358 | Fixed Reference | A type of time point relationship that is fixed with respect to a timeline. |
relativeToFromcodelist C201265, not extensible
| Code | Term | Definition |
|---|---|---|
| C201352 | End to End | A timing relationship defined as the end of one event to the end of another event. |
| C201353 | End to Start | A timing relationship defined as the end of one event to the start of another event. |
| C201354 | Start to End | A timing relationship defined as the start of one event to the end of another event. |
| C201355 | Start to Start | A timing relationship defined as the start of one event to the start of another event. |
Smallest valid Timing
The attributes a JSON file must carry for a Timing, 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": "Timing_1",
"name": string,
"type": Code,
"relativeToFrom": Code,
"value": string,
"valueLabel": string,
"relativeFromScheduledInstanceId": id of ScheduledInstance,
"instanceType": "Timing"
}
Where Timing is used
These classes hold or point to a Timing.
- Encounter.scheduledAtIdby id
- ScheduleTimeline.timingsnested
Example
A Timing from the example study. Coded values are shortened to one line.
{
"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"
}
Related classes
Other classes in schedule and timing: