USDM object model

USDM 4.0 defines 86 classes with 833 attributes between them. This is a reference to all of them, generated from the official release, with each class on its own page.

Where the main classes sit

The boxes nest the way the JSON does. Select a class to see what it is and which classes it points to by id.

Structure
Schedule
Purpose
People

StudyVersion

study.versions[]

One version of the plan. It owns the titles, identifiers, organizations, interventions and one or more study designs, plus the amendments that produced it.

CDISC definition. A plan at a particular point in time for a study.

Points to, by id

  • documentVersionIdsStudyDefinitionDocumentVersion
1 in the example studyFull reference →

How to read the model

  • Classes become objects. Each object in a file names its class in instanceType. 6 of the 86 classes are abstract: they exist to share attributes between their subclasses and never appear in a file themselves.
  • Two kinds of relationship. An attribute either holds another object (nested) or holds its id (a reference). Reference attributes end in Id or Ids. The class pages mark which is which.
  • Cardinality. 1 is exactly one, 0..1 is optional, 0..* is any number and 1..* is at least one.
  • Coded values name their codelist. Where an attribute is a code, its page says which codelist the value must come from, and lists the values when the codelist is one USDM defines itself.
  • Required is stricter in the API. The pages mark an attribute as required when the USDM API schema requires it in a JSON file, which is what a parser will enforce.

Study, versions and amendments

The root of every USDM file: the study, each version of its plan, its titles and identifiers, and the amendments that moved it from one version to the next.

Organizations, roles and sites

Who is involved and in what capacity: sponsors, registries, CROs, sites, named people and who is masked.

Study design

The shape of the trial: arms, epochs, the cells where they meet, the elements inside each cell, and the indication under study.

Schedule and timing

The schedule of activities as data: visits, activities, the timeline that orders them, and the timings and windows between them.

Objectives, endpoints and estimands

What the study sets out to learn and how it will be measured, including the ICH E9(R1) estimand attributes.

Population and eligibility

Who can take part: the planned population, cohorts within it, and each inclusion and exclusion criterion.

Interventions and products

What participants receive: the intervention, how it is administered, and the product, ingredients, strengths and devices behind it.

Biomedical concepts

The data layer: what is actually collected when an activity is performed, down to the property and its allowed responses.

Documents and narrative

The protocol as a document: its versions, its sections of prose, and the templated text and abbreviations that prose uses.

Codes, quantities and extensions

The building blocks every other class uses: coded values, numbers with units, ranges, and the mechanism for carrying data the standard does not define.

Where this comes from

The class names, definitions, attributes, types and cardinalities on these pages are read from the USDM 4.0 release in the CDISC DDF-RA repository: the logical model for definitions and the API specification for which attributes a JSON file must carry. The grouping and the plain-language notes are Concordare’s. Where the two differ in emphasis, the standard is right. To look an attribute up by name, use the attribute index. See also the glossary.

Keep going