StudyArm

A planned path through the study that a participant is assigned to, such as active treatment or placebo.

Kind
Concrete class
Attributes
11, 6 required
NCI code
C174447

Official definition

A planned pathway assigned to the subject as they progress through the study, usually referred to by a name that reflects one or more treatments, exposures, and/or controls included in the path.
Study Arm, CDISC USDM 4.0, NCI C174447

In practice

In a protocol document: The arms in the study schema diagram and the treatment groups section.

Attributes

11 attributes, 6 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 arm.
labelstringcardinality 0..1The short descriptive designation for the study arm.
descriptionstringcardinality 0..1A narrative representation of the study arm.
typerequiredCodecardinality 1A characterization or classification of the study arm.CDISC Protocol codelist C174222 (NCI EVS)
dataOriginTyperequiredCodecardinality 1A characterization or classification of the study arm with respect to where the study arm data originates.USDM codelist C188727, 4 values
dataOriginDescriptionrequiredstringcardinality 1The textual representation of the study arm data origin.
notesCommentAnnotationcardinality 0..*A brief written record relevant to the study arm.
populationIdsPopulationDefinitionby idcardinality 0..*A USDM relationship between the StudyArm and PopulationDefinition classes which identifies the set of populations associated with the study arm.
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.

Allowed values

The coded attributes of StudyArm that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.

dataOriginTypecodelist C188727, extensible

CodeTermDefinition
C188866Data Generated Within StudyData that are generated from within the current study.
C188864Historical DataData from studies that have occurred in the past.
C165830Real World DataData relating to patient health status and/or the delivery of health care routinely collected from sources other than traditional clinical trials. NOTE: Examples of sources include data derived from electronic health records (EHRs); medical claims and billing data; data from product and disease registries; patient-generated data, including from in-home-use settings; and data gathered from other sources that can inform on health status, such as mobile devices. [After 21 U.S.C. 355g(b)).5 and Framework for FDA's Real-World Evidence Program December 2018] See also Real-World Evidence (RWE)
C176263Synthetic DataData that are artificially created rather than being generated by actual events. NOTE: Data are often created with the help of algorithms and used for a wide range of activities, including as test data for new products and tools, for model validation, and in AI optimization. [After The Ultimate Guide to Synthetic Data in 2020, August 29, 2020]. See also artificial intelligence.

Smallest valid StudyArm

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

StudyArm, required attributes only
{
  "id": "StudyArm_1",
  "name": string,
  "type": Code,
  "dataOriginType": Code,
  "dataOriginDescription": string,
  "instanceType": "StudyArm"
}

Where StudyArm is used

These classes hold or point to a StudyArm.

Example

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

StudyArm_1
{
  "id": "StudyArm_1",
  "name": "EX101_10MG",
  "label": "EX-101 10 mg",
  "description": "EX-101 10 mg once daily for 12 weeks",
  "type": { "code": "C174266", "decode": "Investigational Arm", … },
  "dataOriginDescription": "Data collected from participants in this study",
  "dataOriginType": { "code": "C188866", "decode": "Data Generated Within Study", … },
  "instanceType": "StudyArm"
}

Other classes in study design:

← All 86 classes