StudyDefinitionDocument

A document that defines the study, normally the protocol, with its language, template and versions.

Kind
Concrete class
Attributes
12, 6 required
NCI code
C215490

Official definition

Any physical or electronic document that is related to defining a study or part of a study.
Study Definition Document, CDISC USDM 4.0, NCI C215490

In practice

In a protocol document: The protocol document itself.

Attributes

12 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 definition document.
labelstringcardinality 0..1The short descriptive designation for the study definition document.
descriptionstringcardinality 0..1A narrative representation of the study definition document.
typerequiredCodecardinality 1A characterization or classification of the study definition document.USDM codelist C215477, 1 value
templateNamerequiredstringcardinality 1The literal identifier (i.e., distinctive designation) of the study definition document template.
languagerequiredCodecardinality 1The language in which the study definition document is written.Values: ISO 639 language value list
notesCommentAnnotationcardinality 0..*A brief written record relevant to the study definition document.
childIdsStudyDefinitionDocumentby idcardinality 0..*A USDM relationship within the StudyDefinitionDocument class which identifies the set of child documents of a study definition document.
versionsStudyDefinitionDocumentVersioncardinality 0..*A USDM relationship between the StudyDefinitionDocument and StudyDefinitionDocumentVersion classes which identifies the set of versions associated with the study definition document.
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 StudyDefinitionDocument that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.

typecodelist C215477, extensible

CodeTermDefinition
C70817ProtocolThe formal plan of an experiment or research activity, including the objective, rationale, design, materials and methods for the conduct of the study, intervention description, and method of data analysis.

Smallest valid StudyDefinitionDocument

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

StudyDefinitionDocument, required attributes only
{
  "id": "StudyDefinitionDocument_1",
  "name": string,
  "type": Code,
  "templateName": string,
  "language": Code,
  "instanceType": "StudyDefinitionDocument"
}

Where StudyDefinitionDocument is used

These classes hold or point to a StudyDefinitionDocument.

Example

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

StudyDefinitionDocument_1
{
  "id": "StudyDefinitionDocument_1",
  "name": "PROTOCOL",
  "label": "Clinical study protocol",
  "language": { "code": "en", "decode": "English", … },
  "type": { "code": "C70817", "decode": "Protocol", … },
  "templateName": "Sponsor protocol template",
  "versions": [
    {
      "id": "StudyDefinitionDocumentVersion_1",
      "version": "1.0",
      "status": { "code": "C25508", "decode": "Final", … },
      "contents": [
        {
          "id": "NarrativeContent_1",
          "name": "SECTION_4_1",
          "sectionNumber": "4.1",
          "sectionTitle": "Overall Design",
          "displaySectionNumber": true,
          "displaySectionTitle": true,
          "contentItemId": "NarrativeContentItem_1",
          "instanceType": "NarrativeContent"
        }
      ],
      "instanceType": "StudyDefinitionDocumentVersion"
    }
  ],
  "instanceType": "StudyDefinitionDocument"
}

Other classes in documents and narrative:

← All 86 classes