Procedure
A coded procedure that an activity involves, with a pointer to an external dictionary code.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 10, 5 required
- NCI code
- C98769
Official definition
Any activity performed by manual and/or instrumental means for the purpose of diagnosis, assessment, therapy, prevention, or palliative care.
In practice
In a protocol document: The procedure descriptions in the study assessments section.
Attributes
10 attributes, 5 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the procedure. |
| label | string | cardinality 0..1 | The short descriptive designation for the procedure. |
| description | string | cardinality 0..1 | A narrative representation of the procedure. |
| procedureTyperequired | string | cardinality 1 | A characterization or classification of the study procedure. |
| coderequired | Code | cardinality 1 | A symbol or combination of symbols which is assigned to medical procedure.Values: External dictionary like CPT, MedDRA, SNOMEDCT, etc. |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the procedure. |
| studyInterventionId | StudyInterventionby id | cardinality 0..1 | A USDM relationship between the Procedure and StudyInterventionclasses which provides the details associated with an instance of an intervention performed during the conduct of a procedure. |
| 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 Procedure
The attributes a JSON file must carry for a Procedure, 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.
Procedure, required attributes only
{
"id": "Procedure_1",
"name": string,
"procedureType": string,
"code": Code,
"instanceType": "Procedure"
}
Where Procedure is used
These classes hold or point to a Procedure.
Related classes
Other classes in schedule and timing: