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

CareTask

Represents additional information about a healthcare-related task such as process status, beneficiary, and related tasks. This object is available in API version 61.0 and later.

Supported Calls

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

Fields

Field Details
ActionCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A name or code that describes the task.
This field is a polymorphic relationship field.
Relationship Name
ActionCode
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
ActualEndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the task ends.
ActualStartDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the task starts.
BeneficiaryId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The party who benefits from the task.
This field is a polymorphic relationship field.
Relationship Name
Beneficiary
Relationship Type
Lookup
Refers To
Account, HealthcareProvider
ClinicalEncounterId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The associated clinical encounter for which the task was created.
This field is a relationship field.
Relationship Name
ClinicalEncounter
Relationship Type
Lookup
Refers To
ClinicalEncounter
ContentResource
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the endpoints or URLs to relevant educational resources such as PDFs.
ExpectedEndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the task is expected to end.
ExpectedStartDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the task is expected to start.
ExtlTaskDefIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID or URL of the external task definition in the source system.
GroupIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The shared ID of multiple independent tasks.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced the record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed the record.
LocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The location where the task is performed.
This field is a polymorphic relationship field.
Relationship Name
Location
Relationship Type
Lookup
Refers To
HealthcareFacility, Location
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the care task record.
OwnedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The party who's responsible for executing the task.
This field is a polymorphic relationship field.
Relationship Name
OwnedBy
Relationship Type
Lookup
Refers To
Account, CareRegisteredDevice, Contact, User
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the care task record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParentCareTaskId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The associated care task.
This field is a relationship field.
Relationship Name
ParentCareTask
Relationship Type
Lookup
Refers To
CareTask
ProcessStatusId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The business-specific process status of the task.
This field is a polymorphic relationship field.
Relationship Name
ProcessStatus
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
RequestedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The party who created the task.
This field is a polymorphic relationship field.
Relationship Name
RequestedBy
Relationship Type
Lookup
Refers To
Account, CareRegisteredDevice, Contact, HealthcareProvider, User
SequenceNumber
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The sequence number in which the task is performed.
ShouldIgnore
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the action specified in the task should be ignored or performed.
The default value is false.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the record in the external source system.
SourceSystemModifiedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the record was last modified in the external source system.
SourceSystemName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the external source system from which the record was imported.
StatusReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reason for the status of the task.
TaskId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The task associated with the care task.
This field is a relationship field.
Relationship Name
Task
Relationship Type
Lookup
Refers To
Task

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.

CareTaskChangeEvent
Change events are available for the object.
CareTaskFeed
Feed tracking is available for the object.
CareTaskHistory
History is available for tracked fields of the object.
CareTaskShare
Sharing is available for the object.