Condition
A condition under which something applies, written as templated text. It names what it is about (an activity, a procedure, a biomedical concept) and where on the schedule it holds.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 11, 4 required
- NCI code
- C25457
Official definition
A state of being.
In practice
In a protocol document: Conditional footnotes on the schedule of activities: only for women of childbearing potential, only if the dipstick result is positive.
Inheritance
Condition is a kind of SyntaxTemplate and inherits its attributes. Wherever the model asks for a SyntaxTemplate, a Condition can be used.
Attributes
11 attributes, 4 of them required by the USDM API schema and 3 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 condition.Inherited from SyntaxTemplate |
| label | string | cardinality 0..1 | The short descriptive designation for the condition.Inherited from SyntaxTemplate |
| description | string | cardinality 0..1 | A narrative representation of the condition.Inherited from SyntaxTemplate |
| textrequired | string | cardinality 1 | An instance of structured text that represents the condition.Inherited from SyntaxTemplate |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the condition.Inherited from SyntaxTemplate |
| dictionaryId | SyntaxTemplateDictionaryby id | cardinality 0..1 | A USDM relationship between the Condition and SyntaxTemplateDictionary classes which provides the set of dictionary entries related to conditions.Inherited from SyntaxTemplate |
| contextIds | Activity | ScheduledActivityInstanceby id | cardinality 0..* | A USDM relationship between the Condition and the ScheduledActivityInstance or Activity classes which identifies the scheduled activity instance or activity to which the condition belongs. |
| appliesToIds | BiomedicalConceptCategory | Procedure | Activity | BiomedicalConcept | BiomedicalConceptSurrogateby id | cardinality 0..* | A USDM relationship between the Condition and the Activity, Procedure, BiomedicalConcept, BiomedicalConceptSurrogate, or BiomedicalConceptCategory classes which identifies the procedure, activity, biomedical concept, biomedical concept surrogate, or biomedical concept category that applies to the condition. |
| 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 Condition
The attributes a JSON file must carry for a Condition, 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.
{
"id": "Condition_1",
"name": string,
"text": string,
"instanceType": "Condition"
}
Where Condition is used
These classes hold or point to a Condition.
- StudyVersion.conditionsnested
Related classes
Other classes in schedule and timing: