ClinicalEncounter

Represents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of a patient’s healthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. 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

Field	Details
AdmissionSource	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the source of the admission. Possible values are: `Another Hospital` `Emergency Department` `General Practitioner Referral` `In-Hospital Birth` `Nursing Home` `Other` `Other Medical Practitioner Referral` `Outpatient Department` `Psychiatric Hospital` `Rehabilitation Facility`
CaseId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the clinical encounter of a patient with a care provider. This field is a relationship field. Relationship Name Case Refers To Case
Category	Type picklist Properties Create, Filter, Group, Sort, Update Description Specifies the classification of the encounter. Possible values are: `Ambulatory` `Emergency` `Home Health` `Inpatient Encounter`
DestinationFacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The facility to which the patient is transferred. Referenced Objects HealthcareFacility
DestinationOrganizationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The organization to which the patient is transferred. Referenced Objects Account
DietPreference	Type multipicklist Properties Create, Filter, Nillable, Update Description The diet preferences of the patient. Possible values are: `Dairy-Free` `Gluten-Free` `Halal` `Kosher` `Nut-Free` `Vegan` `Vegetarian`
DischargeDispositionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the patient at discharge. Referenced Objects CodeSetBundle
Duration	Type double Properties Create, Filter, Nillable, Sort, Update Description The duration of the patient encounter, in the given unit of measure.
DurationUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of measurement for the encounter duration. Referenced Objects UnitOfMeasure
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the encounter ended.
FacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The facility where the encounter took place. Referenced Objects HealthcareFacility
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 the clinical encouter record.
PatientId	Type reference Properties Create, Filter, Group, Sort Description The patient receiving the treatment. Referenced Objects Account
PreAdmissionIdentifierId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier for the encounter pre-admission. Referenced Objects ClinicalEncounterIdentified
PreviousFacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The patient's location before the admission. Referenced Objects HealthcareFacility
PreviousOrganizationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the organization where the patient was previously located. Referenced Objects Account
PriorityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the priority associated with the urgency of the encounter. Referenced Objects CodeSetBundle
ReadmissionCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code for the readmission. Referenced Objects CodeSetBundle
RelatedClinicalEncounterId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies an encounter that is related to this encounter. Referenced Objects ClinicalEncounter
ServiceAppointment	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The appointment associated with this clinical encounter. Referenced Objects ServiceAppointment
ServiceType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the classification of the type of service. Possible values are: `Homoeopathy` `Meditation` `Naturopathy` `Reflexology`
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the system this record came from.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of this record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which this item was last changed in the source system.
SpecialCourtesy	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies a class of courtesy extended to the patient. Possible values are: `Extended` `Normal` `Professional` `Staff` `Unknown` `VIP`
StartDate	Type dateTime Properties Create, Filter, Sort, Update Description The date on which the encounter began.
Status	Type picklist Properties Create, Filter, Group, Sort, Update Description Specifies the status of the patient encounter. Possible values are: `Arrived` `Cancelled` `Finished` `In Progress` `Planned` `Triaged`
TypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the type of the encounter. Referenced Objects CodeSetBundle

Additional Information for ClinicalEncounter in Other Objects

In addition to creating a record using these fields, you can add more details to your ClinicalEncounter record by creating records in certain other objects, and referencing your ClinicalEncounter record as the parent record. Here’s the list of objects you can associate to ClinicalEncounter in this way, the type of information they add, and the field they use to reference ClinicalEncounter.

Object	Type of Information	Reference Field
ClinicalEncounterDiagnosis	Specifies the different diagnoses from an encounter, and other diagnosis-related information.	ClinicalEncounterId
ClinicalEncounterFacility	Specifies the different healthcare facilities involved in an encounter, and other details relevant to the facility and the encounter.	ClinicalEncounterId
ClinicalEncounterIdentifier	Specifies identifiers for the encounter. The object is very similar to the standard Identifier object, but is exclusive to ClinicalEncounter.	ClinicalEncounterId
ClinicalEncounterProvider	Specifies the different providers involved in an encounter and the details of their involvement.	ClinicalEncounterId
ClinicalEncounterReason	Specifies the reasons for why the encounter happened or was required.	ClinicalEncounterId
ClinicalEncounterSvcRequest	Specifies service requests that the encounter was based on.	ClinicalEncounterId

Associated Objects

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

ClinicalEncounterChangeEvent (API version 58.0): Change events are available for the object.

ClinicalEncounterFeed: Feed tracking is available for the object.
ClinicalEncounterHistory: History is available for tracked fields of the object.

Salesforce Health Cloud Developer Guide

ClinicalEncounter

Supported Calls

Fields

Additional Information for ClinicalEncounter in Other Objects

Associated Objects