DocumentContentReference

A pointer to a section of a study definition document, by section number and title.

Kind
Concrete class
Attributes
6, 5 required
NCI code
C215499

Official definition

A citation pointing to the location of specific content within a document.
Document Content Reference, CDISC USDM 4.0, NCI C215499

In practice

In a protocol document: The section references in an amendment's list of changes.

Attributes

6 attributes, 5 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.
sectionNumberrequiredstringcardinality 1The numeric identifier of a particular section for the document content reference.
sectionTitlerequiredstringcardinality 1An identifying designation for a particular section for the document content reference.
appliesToIdrequiredStudyDefinitionDocumentby idcardinality 1A USDM relationship between the DocumentContentReference and StudyDefinitionDocument classes which identifies the study definition document to which the document content reference applies.
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 DocumentContentReference

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

DocumentContentReference, required attributes only
{
  "id": "DocumentContentReference_1",
  "sectionNumber": string,
  "sectionTitle": string,
  "appliesToId": id of StudyDefinitionDocument,
  "instanceType": "DocumentContentReference"
}

Where DocumentContentReference is used

These classes hold or point to a DocumentContentReference.

Other classes in documents and narrative:

← All 86 classes