Salesforce Docs Portal

ClinicalEncounterReason

Represents the reasons for why the encounter was required. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

ClinicalEncounterId

  • Type: Master-detail reference
  • Properties: Create, Filter, Group, Sort
  • Description: The parent ClinicalEncounter record that this ClinicalEncounterReason record belongs to.
  • Referenced Objects:
    • ClinicalEncounter

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which a user referenced this record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which a user viewed this record.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The system-generated name of this encounter reason.

ReasonCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that indicates the reason why the encounter took place.
  • Referenced Objects:
    • CodeSetBundle

ReasonReferenceId

  • Type: Polymorphic reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The reason for the encounter.
  • Referenced Objects:
    • HealthCondition
    • CareObservation
    • PatientMedicalProcedure

Usage

Once the reasons for the encounter is recorded in the ClinicalEncounterReason record using the ReasonCodeId and ReasonReferenceId fields, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ClinicalEncounterReasonFeed
Feed tracking is available for the object.
ClinicalEncounterReasonHistory
History is available for tracked fields of the object.
ClinicalEncounterReasonChangeEvent (API version 61.0)
Change events are available for the object.