Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
ActionPlanTemplateAssignment
AsmtQstnRespRecommendation
CareEpisode
CareEpisodeDetail
CarePlan
CarePlanActivity
CarePlanActivityDetail
CarePlanDetail
CarePlanTemplate
CarePlanTemplateGoal
CarePlanTemplateProblem
GoalAssignment
GoalAssignmentDetail
GoalDefinition
ProblemDefinition
ProblemGoalDefinition
CareGap
ClinicalMeasure
ClinicalMeasureCriteria
ClinicalMeasureCriteriaGrp
CareGapCriteriaResult
CareTask
CareTaskDetail
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

CareEpisode

Records details of the interaction between a patient and a healthcare provider for the period during which the patient receives healthcare services from the provide. This object is based on the EpisodeOfCare FHIR resource. This object is available in API version 57.0 and later.

Supported Calls

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

Fields

Field Details
CareCoordinatorId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The care coordinator who orchestrates care for the patient during the episode of care.
Relationship Name
CareCoordinator
Refers To
  • HealthcarePractitionerFacility
  • HealthcareProvider
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the episode of care ends.
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 date and time when the record was last viewed.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the record.
OwnerId
Type
Polymorphic lookup
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
  • Group
  • User
PatientId
Type
Master-detail
Properties
Create, Filter, Group, Sort
Description
The patient that’s part of the episode of care.
Relationship Name
Patient
Refers To
Account
ResponsibleOrganizationId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The organization that’s responsible for managing the patient’s care during the episode of care.
This field is a polymorphic relationship field.
Relationship Name
ResponsibleOrganization
Refers To
  • Account
  • HealthcareProvider
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source system from where the record was brought into Salesforce.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier of the record in its source system.
SourceSystemModified
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the record was last modified in its source system.
StartDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the episode of care started.
Status
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
The status of the eipsode of care.
Possible values are:
  • Active
  • Cancelled
  • Entered-in-Error
  • Finished
  • On Hold
  • Planned
  • Wait List
Type
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
The type od te episode of care.
Possible values are:
  • cacp - Community-Based Aged Care
  • da - Drug and Alcohol Rehabilitation
  • diab - Post-Coordinated Diabetes Program
  • hacc - Home and Community Care
  • pac - Post-Acute Care

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

CareEpisodeFeed
Feed tracking is available for the object.
CareEpisodeHistory
History is available for tracked fields of the object.
CareEpisodeOwnerSharingRule
Sharing rules are available for the object.
CareEpisodeShare
Sharing is available for the object.