Encounter
A visit or other planned contact with the participant, with its setting and contact mode. An encounter is where activities happen; it does not hold the activities itself.
- Kind
- Concrete class
- Group
- Schedule and timing
- Attributes
- 15, 4 required
- NCI code
- C215488
Official definition
Any physical or virtual contact between two or more parties involved in a study, at which an assessment or activity takes place.
In practice
In a protocol document: A column in the schedule of activities: Screening, Day 1, Week 2.
Attributes
15 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. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) for a protocol-defined study encounter. |
| label | string | cardinality 0..1 | The short descriptive designation for the study encounter. |
| description | string | cardinality 0..1 | A narrative representation of the protocol-defined study encounter. |
| typerequired | Code | cardinality 1 | A characterization or classification of the study encounter.USDM codelist C188728, 1 value |
| environmentalSettings | Code | cardinality 0..* | The environment/setting where the event, intervention, or finding occurred.CDISC SDTM codelist C127262 (NCI EVS) |
| contactModes | Code | cardinality 0..* | The means by which an interaction occurs between the subject/participant and person or entity (e.g., a device).CDISC SDTM codelist C171445 (NCI EVS) |
| notes | CommentAnnotation | cardinality 0..* | A brief written record relevant to the study encounter. |
| transitionEndRule | TransitionRule | cardinality 0..1 | A USDM relationship between the Encounter and TransitionRule classes which provides the details associated with a transition rule used to trigger the end of an encounter. |
| nextId | Encounterby id | cardinality 0..1 | A USDM relationship within the Encounter class which identifies the encounter that chronologically follows the current encounter. |
| transitionStartRule | TransitionRule | cardinality 0..1 | A USDM relationship between the Encounter and TransitionRule classes which provides the details associated with a transition rule used to trigger the start of an encounter. |
| scheduledAtId | Timingby id | cardinality 0..1 | A USDM relationship between the Encounter and Timing classes which provides information related to the scheduled timing of an encounter. |
| previousId | Encounterby id | cardinality 0..1 | A USDM relationship within the Encounter class which identifies the encounter that chronologically precedes the current encounter. |
| 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. |
Allowed values
The coded attributes of Encounter that use a codelist defined by USDM, with every value in it. A file carries the code; the term is its decode.
typecodelist C188728, extensible
| Code | Term | Definition |
|---|---|---|
| C25716 | Visit | The act of going to see some person or place or thing; it can cover a short or long period but refers to a non-permanent arrangement. |
Smallest valid Encounter
The attributes a JSON file must carry for a Encounter, 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": "Encounter_1",
"name": string,
"type": Code,
"instanceType": "Encounter"
}
Where Encounter is used
These classes hold or point to a Encounter.
- Encounter.nextIdby id
- Encounter.previousIdby id
- ScheduledActivityInstance.encounterIdby id
- StudyDesign.encountersnested
Example
A Encounter from the example study. Coded values are shortened to one line.
{
"id": "Encounter_1",
"name": "SCREENING",
"label": "Screening",
"description": "Screening visit",
"type": { "code": "C25716", "decode": "Visit", … },
"environmentalSettings": [
{ "code": "C211570", "decode": "Clinic", … }
],
"contactModes": [
{ "code": "C175574", "decode": "In Person", … }
],
"scheduledAtId": "Timing_1",
"nextId": "Encounter_2",
"instanceType": "Encounter"
}
Related classes
Other classes in schedule and timing: