Activity
Something planned to be done or observed: a procedure, an assessment, a questionnaire, dispensing drug. Activities can be nested with childIds to form groups.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 15, 3 required
- NCI code
- C71473
Official definition
An action, undertaking, or event, which is anticipated to be performed or observed, or was performed or observed, according to the study protocol during the execution of the study.
In practice
In a protocol document: A row in the schedule of activities.
Attributes
15 attributes, 3 of them required by the USDM API schema and 7 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 activity. |
| label | string | cardinality 0..1 | The short descriptive designation for the study activity. |
| description | string | cardinality 0..1 | A narrative representation of the study activity. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the activity. |
| definedProcedures | Procedure | cardinality 0..* | A USDM relationship between the Activity and Procedure classes which identifies the set of defined procedures associated with the activity. |
| biomedicalConceptIds | BiomedicalConceptby id | cardinality 0..* | A USDM relationship between the Activity and BiomedicalConcept classes which identifies the set of biomedical concepts associated with the activity. |
| nextId | Activityby id | cardinality 0..1 | A USDM relationship within the Activity class which identifies the activity that follows the current activity in the display order. |
| timelineId | ScheduleTimelineby id | cardinality 0..1 | A USDM relationship between the Activity and ScheduleTimeline classes which provides the details associated with an instance of the scheduled timeline related to the activity. |
| childIds | Activityby id | cardinality 0..* | A USDM relationship within the Activity class which identifies the set of child activities associated with an activity. |
| previousId | Activityby id | cardinality 0..1 | A USDM relationship within the Activity class which identifies the activity that precedes the current activity in the display order. |
| bcSurrogateIds | BiomedicalConceptSurrogateby id | cardinality 0..* | A USDM relationship between the Activity and BiomedicalConceptSurrogate classes which identifies the set of biomedical concept surrogates associated with the activity. |
| bcCategoryIds | BiomedicalConceptCategoryby id | cardinality 0..* | A USDM relationship between the Activity and BiomedicalConceptCategory classes which identifies the set of biomedical concept categories associated with the activity. |
| 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 Activity
The attributes a JSON file must carry for a Activity, 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.
Activity, required attributes only
{
"id": "Activity_1",
"name": string,
"instanceType": "Activity"
}
Where Activity is used
These classes hold or point to a Activity.
- Activity.nextIdby id
- Activity.childIdsby id
- Activity.previousIdby id
- Condition.contextIdsby id
- Condition.appliesToIdsby id
- ScheduledActivityInstance.activityIdsby id
- StudyDesign.activitiesnested
Example
A Activity from the example study. Coded values are shortened to one line.
Activity_1
{
"id": "Activity_1",
"name": "INFORMED_CONSENT",
"label": "Informed consent",
"description": "Obtain written informed consent before any study procedure.",
"nextId": "Activity_2",
"instanceType": "Activity"
}
Related classes
Other classes in schedule and timing: