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.
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).
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the narrative content. |
| sectionNumber | string | cardinality 0..1 | The numeric identifier assigned to a particular document section containing narrative content. |
| sectionTitle | string | cardinality 0..1 | An identifying designation for the document section containing narrative content. |
| displaySectionTitlerequired | boolean | cardinality 1 | An indication as to whether the section title is to be displayed in the document containing narrative content. |
| displaySectionNumberrequired | boolean | cardinality 1 | An indication as to whether the section number is to be displayed in the document containing narrative content. |
| contentItemId | NarrativeContentItemby id | cardinality 0..1 | A USDM relationship between the NarrativeContent and NarrativeContentItem classes which identifies the content item associated with the narrative content. |
| previousId | NarrativeContentby id | cardinality 0..1 | A USDM relationship within the NarrativeContent class which identifies the narrative content that precedes the current narrative content in the display order. |
| nextId | NarrativeContentby id | cardinality 0..1 | A USDM relationship within the NarrativeContent class which identifies the narrative content that follows the current narrative content in the display order. |
| childIds | NarrativeContentby id | cardinality 0..* | A USDM relationship within the NarrativeContent class which identifies the set of child content associated with an instance of narrative content. |
| 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. |
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.
- NarrativeContent.previousIdby id
- NarrativeContent.nextIdby id
- NarrativeContent.childIdsby id
- StudyDefinitionDocumentVersion.contentsnested
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"
}
Related classes
Other classes in documents and narrative: