StudyElement
A building block of time inside a cell, with a rule for when it starts and optionally when it ends, and the interventions given during it.
- Kind
- Concrete class
- Group
- Study design
- Attributes
- 10, 3 required
- NCI code
- C142735
Official definition
A basic building block for time within a clinical study comprising the following characteristics: a description of what happens to the subject during the element; a definition of the start of the element; a rule for ending the element.
In practice
In a protocol document: A treatment period, washout or run-in as drawn in the study schema.
Attributes
10 attributes, 3 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 study design element. |
| label | string | cardinality 0..1 | The short descriptive designation for the study design element. |
| description | string | cardinality 0..1 | A narrative representation of the study design element. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the study element. |
| transitionEndRule | TransitionRule | cardinality 0..1 | A USDM relationship between the StudyElement and TransitionRule classes which provides the details associated with a transition rule used to trigger the end of a study element. |
| studyInterventionIds | StudyInterventionby id | cardinality 0..* | A USDM relationship between the StudyElement and StudyIntervention classes which identifies the set of study interventions associated with the study element. |
| transitionStartRule | TransitionRule | cardinality 0..1 | A USDM relationship between the StudyElement and TransitionRule classes which provides the details associated with a transition rule used to trigger the start of a study element. |
| 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 StudyElement
The attributes a JSON file must carry for a StudyElement, 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.
StudyElement, required attributes only
{
"id": "StudyElement_1",
"name": string,
"instanceType": "StudyElement"
}
Where StudyElement is used
These classes hold or point to a StudyElement.
- StudyCell.elementIdsby id
- StudyDesign.elementsnested
Example
A StudyElement from the example study. Coded values are shortened to one line.
StudyElement_1
{
"id": "StudyElement_1",
"name": "SCREENING",
"label": "Screening",
"transitionStartRule": {
"id": "TransitionRule_1",
"name": "SCREENING_START",
"text": "Informed consent signed.",
"instanceType": "TransitionRule"
},
"instanceType": "StudyElement"
}
Related classes
Other classes in study design: