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.
In practice
In a protocol document: Explanatory notes and remarks.
Attributes
5 attributes, 3 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. |
| textrequired | string | cardinality 1 | An instance of unstructured text that represents the comment annotation. |
| codes | Code | cardinality 0..* | A symbol or combination of symbols which is assigned to the comment annotation. |
| 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 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.
- Abbreviation.notesnested
- Activity.notesnested
- AdministrableProduct.notesnested
- Administration.notesnested
- AnalysisPopulation.notesnested
- BiomedicalConcept.notesnested
- BiomedicalConceptCategory.notesnested
- BiomedicalConceptProperty.notesnested
- BiomedicalConceptSurrogate.notesnested
- EligibilityCriterion.notesnested
- Encounter.notesnested
- Estimand.notesnested
- Indication.notesnested
- MedicalDevice.notesnested
- PopulationDefinition.notesnested
- Procedure.notesnested
- StudyAmendment.notesnested
- StudyAmendmentImpact.notesnested
- StudyArm.notesnested
- StudyDefinitionDocument.notesnested
- StudyDefinitionDocumentVersion.notesnested
- StudyDesign.notesnested
- StudyElement.notesnested
- StudyEpoch.notesnested
- StudyIntervention.notesnested
- StudyRole.notesnested
- StudyVersion.notesnested
- SyntaxTemplate.notesnested
Related classes
Other classes in documents and narrative: