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
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.
Study Design Element, CDISC USDM 4.0, NCI C142735

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).

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
namerequiredstringcardinality 1The literal identifier (i.e., distinctive designation) of the study design element.
labelstringcardinality 0..1The short descriptive designation for the study design element.
descriptionstringcardinality 0..1A narrative representation of the study design element.
notesCommentAnnotationcardinality 0..*A brief written record relevant to the study element.
transitionEndRuleTransitionRulecardinality 0..1A 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.
studyInterventionIdsStudyInterventionby idcardinality 0..*A USDM relationship between the StudyElement and StudyIntervention classes which identifies the set of study interventions associated with the study element.
transitionStartRuleTransitionRulecardinality 0..1A 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.
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 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.

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

Other classes in study design:

← All 86 classes