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)
Abbreviation, CDISC USDM 4.0, NCI C42610

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.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
abbreviatedTextrequiredstringcardinality 1The literal value of an instance of unstructured text that is used as the abbreviation.
expandedTextrequiredstringcardinality 1The full literal representation of the abbreviation.
notesCommentAnnotationcardinality 0..*A brief written record relevant to the abbreviation.
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 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.

Other classes in documents and narrative:

← All 86 classes