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
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.
Study Encounter, CDISC USDM 4.0, NCI C215488

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).

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
namerequiredstringcardinality 1The literal identifier (i.e., distinctive designation) for a protocol-defined study encounter.
labelstringcardinality 0..1The short descriptive designation for the study encounter.
descriptionstringcardinality 0..1A narrative representation of the protocol-defined study encounter.
typerequiredCodecardinality 1A characterization or classification of the study encounter.USDM codelist C188728, 1 value
environmentalSettingsCodecardinality 0..*The environment/setting where the event, intervention, or finding occurred.CDISC SDTM codelist C127262 (NCI EVS)
contactModesCodecardinality 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)
notesCommentAnnotationcardinality 0..*A brief written record relevant to the study encounter.
transitionEndRuleTransitionRulecardinality 0..1A 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.
nextIdEncounterby idcardinality 0..1A USDM relationship within the Encounter class which identifies the encounter that chronologically follows the current encounter.
transitionStartRuleTransitionRulecardinality 0..1A 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.
scheduledAtIdTimingby idcardinality 0..1A USDM relationship between the Encounter and Timing classes which provides information related to the scheduled timing of an encounter.
previousIdEncounterby idcardinality 0..1A USDM relationship within the Encounter class which identifies the encounter that chronologically precedes the current encounter.
extensionAttributesExtensionAttributecardinality 0..*Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model.
instanceTyperequiredstringcardinality 1The 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

CodeTermDefinition
C25716VisitThe 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.

Encounter, required attributes only
{
  "id": "Encounter_1",
  "name": string,
  "type": Code,
  "instanceType": "Encounter"
}

Where Encounter is used

These classes hold or point to a Encounter.

Example

A Encounter from the example study. Coded values are shortened to one line.

Encounter_1
{
  "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"
}

Other classes in schedule and timing:

← All 86 classes