ScheduledActivityInstance

One planned point on a timeline: these activities, at this encounter, in this epoch. It is the object that ties what to when.

Kind
Concrete class
Attributes
12, 3 required
NCI code
C201350

Official definition

A scheduled occurrence of an activity event.
Scheduled Activity Instance, CDISC USDM 4.0, NCI C201350

In practice

In a protocol document: One column of X marks in the schedule of activities.

Inheritance

ScheduledActivityInstance is a kind of ScheduledInstance and inherits its attributes. Wherever the model asks for a ScheduledInstance, a ScheduledActivityInstance can be used.

Attributes

12 attributes, 3 of them required by the USDM API schema and 6 holding the id of another object instead of the object itself (marked by id).

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.Inherited from ScheduledInstance
namerequiredstringcardinality 1The literal identifier (i.e., distinctive designation) of the scheduled activity instance.Inherited from ScheduledInstance
labelstringcardinality 0..1The short descriptive designation for the scheduled activity instance.Inherited from ScheduledInstance
descriptionstringcardinality 0..1A narrative representation of the scheduled activity instance.Inherited from ScheduledInstance
defaultConditionIdScheduledInstanceby idcardinality 0..1A USDM relationship within the ScheduledActivityInstance class which identifies the default condition within a scheduled activity instance.Inherited from ScheduledInstance
epochIdStudyEpochby idcardinality 0..1A USDM relationship between the ScheduledActivityInstance and StudyEpoch classes which identifies the study epoch associated with a scheduled activity instance.Inherited from ScheduledInstance
activityIdsActivityby idcardinality 0..*A USDM relationship between the ScheduledActivityInstance and Activity classes which identifies the set of activities associated with a scheduled activity instance.
encounterIdEncounterby idcardinality 0..1A USDM relationship between the ScheduledActivityInstance and Encounter classes which defines the subject encounter associated with the ScheduleActivityInstance.
timelineIdScheduleTimelineby idcardinality 0..1A USDM relationship between the ScheduledActivityInstance and ScheduleTimeline classes which provides the details associated with an instance of a scheduled timeline related to a scheduled activity instance.
timelineExitIdScheduleTimelineExitby idcardinality 0..1A USDM relationship between the ScheduledActivityInstance and ScheduleTimelineExit classes which provides the details associated with the exit from a timeline related to a scheduled activity instance.
extensionAttributesExtensionAttributecardinality 0..*Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model.
instanceTyperequiredstringcardinality 1The 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 ScheduledActivityInstance

The attributes a JSON file must carry for a ScheduledActivityInstance, 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.

ScheduledActivityInstance, required attributes only
{
  "id": "ScheduledActivityInstance_1",
  "name": string,
  "instanceType": "ScheduledActivityInstance"
}

Where ScheduledActivityInstance is used

These classes hold or point to a ScheduledActivityInstance.

Example

A ScheduledActivityInstance from the example study. Coded values are shortened to one line.

ScheduledActivityInstance_1
{
  "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"
}

Other classes in schedule and timing:

← All 86 classes