EligibilityCriterionItem
The text of a criterion, kept separate so the same wording can be reused across designs and studies.
- Kind
- Concrete class
- Attributes
- 9, 4 required
- NCI code
- C215506
Official definition
An individual item within the container that holds an instance of an eligibility criterion.
In practice
In a protocol document: The sentence that states the criterion.
Inheritance
EligibilityCriterionItem is a kind of SyntaxTemplate and inherits its attributes. Wherever the model asks for a SyntaxTemplate, a EligibilityCriterionItem 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 eligibility criterion item.Inherited from SyntaxTemplate |
| label | string | cardinality 0..1 | The short descriptive designation for the eligibility criterion item.Inherited from SyntaxTemplate |
| description | string | cardinality 0..1 | A narrative representation of the eligibility criterion item.Inherited from SyntaxTemplate |
| textrequired | string | cardinality 1 | An instance of structured text that represents the eligibility criterion item.Inherited from SyntaxTemplate |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the eligibility criterion item.Inherited from SyntaxTemplate |
| dictionaryId | SyntaxTemplateDictionaryby id | cardinality 0..1 | A USDM relationship between the EligibilityCriterionItem and SyntaxTemplateDictionary classes which provides the dictionary entry associated with a eligibility criterion item.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 EligibilityCriterionItem
The attributes a JSON file must carry for a EligibilityCriterionItem, 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": "EligibilityCriterionItem_1",
"name": string,
"text": string,
"instanceType": "EligibilityCriterionItem"
}
Where EligibilityCriterionItem is used
These classes hold or point to a EligibilityCriterionItem.
- EligibilityCriterion.criterionItemIdby id
- StudyVersion.eligibilityCriterionItemsnested
Example
A EligibilityCriterionItem from the example study. Coded values are shortened to one line.
{
"id": "EligibilityCriterionItem_1",
"name": "IN01_ITEM",
"text": "Adult aged 18 to 75 years at the time of informed consent.",
"instanceType": "EligibilityCriterionItem"
}
Related classes
Other classes in population and eligibility: