Characteristic
A characteristic that defines a cohort, written as templated text in the same way as a criterion.
- Kind
- Concrete class
- Attributes
- 9, 4 required
- NCI code
- C25447
Official definition
The distinguishing qualities or prominent aspects of an entity.
In practice
In a protocol document: The description of who belongs to a cohort.
Inheritance
Characteristic is a kind of SyntaxTemplate and inherits its attributes. Wherever the model asks for a SyntaxTemplate, a Characteristic can be used.
Attributes
9 attributes, 4 of them required by the USDM API schema and 1 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.Inherited from SyntaxTemplate |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the characteristic.Inherited from SyntaxTemplate |
| label | string | cardinality 0..1 | The short descriptive designation for the characteristic.Inherited from SyntaxTemplate |
| description | string | cardinality 0..1 | A narrative representation of the characteristic.Inherited from SyntaxTemplate |
| textrequired | string | cardinality 1 | An instance of structured text that represents the characteristic.Inherited from SyntaxTemplate |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the characteristic.Inherited from SyntaxTemplate |
| dictionaryId | SyntaxTemplateDictionaryby id | cardinality 0..1 | A USDM relationship between the Characteristic and SyntaxTemplateDictionary classes which provides the set of dictionary entries related to characteristics.Inherited from SyntaxTemplate |
| 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 Characteristic
The attributes a JSON file must carry for a Characteristic, 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.
Characteristic, required attributes only
{
"id": "Characteristic_1",
"name": string,
"text": string,
"instanceType": "Characteristic"
}
Where Characteristic is used
These classes hold or point to a Characteristic.
- StudyCohort.characteristicsnested
Related classes
Other classes in population and eligibility: