CommentAnnotation

A free-text note, optionally with codes, attached to another object. Most classes carry a notes list, added in version 4.0.

Kind
Concrete class
Attributes
5, 3 required
NCI code
C44272

Official definition

An explanatory or critical comment, or other in-context information (e.g., pattern, motif, link), that has been associated with data or other types of information.
Comment Annotation, CDISC USDM 4.0, NCI C44272

In practice

In a protocol document: Explanatory notes and remarks.

Attributes

5 attributes, 3 of them required by the USDM API schema.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
textrequiredstringcardinality 1An instance of unstructured text that represents the comment annotation.
codesCodecardinality 0..*A symbol or combination of symbols which is assigned to the comment annotation.
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 CommentAnnotation

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

CommentAnnotation, required attributes only
{
  "id": "CommentAnnotation_1",
  "text": string,
  "instanceType": "CommentAnnotation"
}

Where CommentAnnotation is used

These classes hold or point to a CommentAnnotation.

Other classes in documents and narrative:

← All 86 classes