Abbreviation
An abbreviation and what it stands for, defined once on the study version and reused wherever the text needs it.
- Kind
- Concrete class
- Attributes
- 6, 4 required
- NCI code
- C42610
Official definition
A set of letters that are drawn from a word or from a sequence of words and that are used for brevity in place of the full word or phrase. (CDISC Glossary)
In practice
In a protocol document: The list of abbreviations at the front of the protocol.
Attributes
6 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. |
| abbreviatedTextrequired | string | cardinality 1 | The literal value of an instance of unstructured text that is used as the abbreviation. |
| expandedTextrequired | string | cardinality 1 | The full literal representation of the abbreviation. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the abbreviation. |
| 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 Abbreviation
The attributes a JSON file must carry for a Abbreviation, 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.
Abbreviation, required attributes only
{
"id": "Abbreviation_1",
"abbreviatedText": string,
"expandedText": string,
"instanceType": "Abbreviation"
}
Where Abbreviation is used
These classes hold or point to a Abbreviation.
- StudyVersion.abbreviationsnested
Related classes
Other classes in documents and narrative: