Newer Version Available

This content describes an older version of this product. View Latest

CarePlan

Represents an instantiation of a care plan template for a particular individual in order to reach specific goals. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

Field Details
CarePlanTemplateId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The care plan template associated with the care plan.
This is a relationship field.
Relationship Name
CarePlanTemplate
Relationship Type
Lookup
Refers To
CarePlanTemplate
CaseId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The case associated with the care plan.
This is a relationship field.
Relationship Name
Case
Relationship Type
Lookup
Refers To
Case
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description for the care plan record.
EndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date until when the care plan is effective.
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
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the care plan record.
ParticipantId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The account associated with the care plan.
This is a polymorphic relationship field.
Relationship Name
Participant
Relationship Type
Lookup
Refers To
Account, Contact
StartDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date from when the care plan is effective.
Status
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Specifies the status of the care plan.
Possible values are:
  • Active
  • Cancelled
  • Completed
  • Draft
  • Proposed
TaskJobStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the status of the task in the task queue.
Possible values are:
  • Completed
  • Failed
  • InProgress
  • Submitted
TaskJobStatusMessage
Type
textarea
Properties
Nillable
Description
The message that describes the status of the task in the queue.