NarrativeContent

One section of a document: its number, title and position, with a pointer to the text of the section.

Kind
Concrete class
Attributes
12, 5 required
NCI code
C207592

Official definition

The container that holds an instance of unstructured text and which may include objects such as tables, figures, and images.
Narrative Content, CDISC USDM 4.0, NCI C207592

In practice

In a protocol document: A numbered section heading and its place in the table of contents.

Attributes

12 attributes, 5 of them required by the USDM API schema and 4 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 narrative content.
sectionNumberstringcardinality 0..1The numeric identifier assigned to a particular document section containing narrative content.
sectionTitlestringcardinality 0..1An identifying designation for the document section containing narrative content.
displaySectionTitlerequiredbooleancardinality 1An indication as to whether the section title is to be displayed in the document containing narrative content.
displaySectionNumberrequiredbooleancardinality 1An indication as to whether the section number is to be displayed in the document containing narrative content.
contentItemIdNarrativeContentItemby idcardinality 0..1A USDM relationship between the NarrativeContent and NarrativeContentItem classes which identifies the content item associated with the narrative content.
previousIdNarrativeContentby idcardinality 0..1A USDM relationship within the NarrativeContent class which identifies the narrative content that precedes the current narrative content in the display order.
nextIdNarrativeContentby idcardinality 0..1A USDM relationship within the NarrativeContent class which identifies the narrative content that follows the current narrative content in the display order.
childIdsNarrativeContentby idcardinality 0..*A USDM relationship within the NarrativeContent class which identifies the set of child content associated with an instance of narrative content.
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 NarrativeContent

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

NarrativeContent, required attributes only
{
  "id": "NarrativeContent_1",
  "name": string,
  "displaySectionTitle": boolean,
  "displaySectionNumber": boolean,
  "instanceType": "NarrativeContent"
}

Where NarrativeContent is used

These classes hold or point to a NarrativeContent.

Example

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

NarrativeContent_1
{
  "id": "NarrativeContent_1",
  "name": "SECTION_4_1",
  "sectionNumber": "4.1",
  "sectionTitle": "Overall Design",
  "displaySectionNumber": true,
  "displaySectionTitle": true,
  "contentItemId": "NarrativeContentItem_1",
  "instanceType": "NarrativeContent"
}

Other classes in documents and narrative:

← All 86 classes