Salesforce Docs Portal

ClinicalEncounterFacility

Represents information about the different facilities involved in an encounter, the time spent at those facilies, and other relevant details. This 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 clinical encounter that the clinical encounter facility record is related to,
  • Referenced Objects:
    • ClinicalEncounter

Duration

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The duration of time that the patient was present at the facility.

DurationUnitId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unit of time for the Duration field.
  • Referenced Objects:
    • UnitOfMeasure

EndDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The end date and time of the patient’s time at the facility during the encounter.

FacilityId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The healthcare facility where the encounter occurred.
  • Referenced Objects:
    • HealthcareFacility

FacilityTypeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the type of the facility, in the context of its physical structure.
  • Referenced Objects:
    • CodeSetBundle

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date and time when the record was last referenced.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The last date and time when the record was viewed.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The system-generated name of the ClinicalEncounterFacility record.

StartDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The start date and time of the patient’s time at the facility during the encounter.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: The status of the patient’s presence at the facility in the context of the patient’s encounter.
  • Possible values:
    • Active
    • Completed
    • Planned
    • Reserved

Usage

Once the facility-related information is recorded in the ClinicalEncounterFacility record, 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.

ClinicalEncounterFacilityFeed
Feed tracking is available for the object.
ClinicalEncounterFacilityHistory
History is available for tracked fields of the object.
ClinicalEncounterFacilityChangeEvent (API version 61.0)
Change events are available for the object.