StudyEpoch
A named period of the study that applies to every arm, such as screening, treatment and follow-up. Epochs are ordered with previousId and nextId.
- Kind
- Concrete class
- Group
- Study design
- Attributes
- 10, 4 required
- NCI code
- C71738
Official definition
A named time period defined in the protocol, wherein a study activity is specified and unchanging throughout the interval, to support a study-specific purpose.
In practice
In a protocol document: The column headings of the study schema: Screening, Treatment, Follow-up.
Attributes
10 attributes, 4 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 study epoch, i.e., the named time period defined in the protocol, wherein a study activity is specified and unchanging throughout the interval, to support a study-specific purpose. |
| label | string | cardinality 0..1 | The short descriptive designation for the study epoch. |
| description | string | cardinality 0..1 | A narrative representation of the study epoch. |
| typerequired | Code | cardinality 1 | A characterization or classification of the study epoch, i.e., the named time period defined in the protocol, wherein a study activity is specified and unchanging throughout the interval, to support a study-specific purpose.CDISC SDTM codelist C99079 (NCI EVS) |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the study epoch. |
| previousId | StudyEpochby id | cardinality 0..1 | A USDM relationship within the StudyEpoch class which identifies the study epoch that chronologically precedes the current study epoch. |
| nextId | StudyEpochby id | cardinality 0..1 | A USDM relationship within the StudyEpoch class which identifies the study epoch that chronologically follows the current study epoch. |
| 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 StudyEpoch
The attributes a JSON file must carry for a StudyEpoch, 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.
StudyEpoch, required attributes only
{
"id": "StudyEpoch_1",
"name": string,
"type": Code,
"instanceType": "StudyEpoch"
}
Where StudyEpoch is used
These classes hold or point to a StudyEpoch.
- ScheduledInstance.epochIdby id
- StudyCell.epochIdby id
- StudyDesign.epochsnested
- StudyEpoch.previousIdby id
- StudyEpoch.nextIdby id
Example
A StudyEpoch from the example study. Coded values are shortened to one line.
StudyEpoch_1
{
"id": "StudyEpoch_1",
"name": "SCREENING",
"label": "Screening",
"type": { "code": "C202487", "decode": "Screening Epoch", … },
"nextId": "StudyEpoch_2",
"instanceType": "StudyEpoch"
}
Related classes
Other classes in study design: