StudyDefinitionDocumentVersion
One version of a document, with its status (draft, final, approved), its dates and its sections.
- Kind
- Concrete class
- Attributes
- 8, 4 required
- NCI code
- C215491
Official definition
A representation of a particular edition or snapshot of the study definition document as it exists at a particular point in time.
In practice
In a protocol document: Protocol version 2.0, dated and approved.
Attributes
8 attributes, 4 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| statusrequired | Code | cardinality 1 | A condition of the study definition document at a point in time with respect to its state of readiness for implementation.USDM codelist C188723, 5 values |
| versionrequired | string | cardinality 1 | A sequence of characters used to identify the version of the study definition document. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the study definition document version. |
| dateValues | GovernanceDate | cardinality 0..* | A USDM relationship between the StudyDefinitionDocumentVersion and GovernanceDate classes which provides the set of governance dates associated with the study definition document version. |
| contents | NarrativeContent | cardinality 0..* | A USDM relationship between the StudyDefinitionDocumentVersion and NarrativeContent classes which identifies the set of narrative content associated with the version of the study definition document. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The 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 StudyDefinitionDocumentVersion that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.
statuscodelist C188723, not extensible
| Code | Term | Definition |
|---|---|---|
| C25425 | Approved | Acceptance as satisfactory by an authoritative body; established by authority; given authoritative approval. |
| C85255 | Draft | A preliminary version of a written work, design, or picture. |
| C25508 | Final | Conclusive in a process or progression. |
| C63553 | Obsolete | No longer in use or valid; old. |
| C188862 | Pending Reviewalso: Draft Pending Review | A preliminary version of a written work, design, or picture that is awaiting review. |
Smallest valid StudyDefinitionDocumentVersion
The attributes a JSON file must carry for a StudyDefinitionDocumentVersion, 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.
{
"id": "StudyDefinitionDocumentVersion_1",
"status": Code,
"version": string,
"instanceType": "StudyDefinitionDocumentVersion"
}
Where StudyDefinitionDocumentVersion is used
These classes hold or point to a StudyDefinitionDocumentVersion.
- StudyDefinitionDocument.versionsnested
- StudyDesign.documentVersionIdsby id
- StudyVersion.documentVersionIdsby id
Example
A StudyDefinitionDocumentVersion from the example study. Coded values are shortened to one line.
{
"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"
}
Related classes
Other classes in documents and narrative: