--- schema_version: "1" id: f36b228979058453f05891c09521f049ea5809cee2e8ee50f07b65586fb745a7 title: ClinicalEncounter collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounter.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounter.htm source_site: developer.salesforce.com content_type: documentation content_hash: 346b1cba834b371adcc1b17348effb9ed25b58ced7ec3bf9eed5fb867bbf888f description: 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. --- # 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() ## 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 | - **[ClinicalEncounterDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterDiagnosis.htm)** Represents a diagnosis related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later. - **[ClinicalEncounterFacility](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterFacility.htm)** 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. - **[ClinicalEncounterIdentifier](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterIdentifier.htm)** Represents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later. - **[ClinicalEncounterProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterProvider.htm)** Represents the providers involved in an encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later. - **[ClinicalEncounterReason](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterReason.htm)** 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. - **[ClinicalEncounterSvcRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalEncounterSvcRequest.htm)** Represents the service requests related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later. ## Fields ### AdmissionSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the source of the admission. - **Possible values**: - 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**: - 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**: - 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**: - 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**: - 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**: - 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 ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [ClinicalEncounterFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object.