Newer Version Available

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

CareProgram

Represents a set of activities, such as a patient therapy, financial assistance, education, wellness, or fitness plan, offered to participants by an employer or insurer.

Supported Calls

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

Fields

Field Name Details
BudgetAmount
Type
Currency
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Approved budget for the care program.
CareProgramName
Type
Text
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the care program.
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Represents the category of the care program.
Possible values are:
  • AdvancedTherapy
Description
Type
Long Text Area
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A short description explaining the program.
EndDate
Type
Date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Program termination date.
ParentProgram
Type
Lookup(Care Program)
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of another program that this program is a part of, if any.
ProgramSponsor
Type
Lookup(Account)
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the third-party program sponsor, if any.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the system from which the record was sourced.
StartDate
Type
Date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Effective start date of the program.
Status
Type
Pick list
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Status of the program.

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.

CareProgramChangeEvent (API version 59.0)
Change events are available for the object.
CareProgramFeed
Feed tracking is available for the object.
CareProgramHistory
History is available for tracked fields of the object.
CareProgramOwnerSharingRule
Sharing rules are available for the object.
CareProgramShare
Sharing is available for the object.