CareProgramEnrollee | Salesforce Health Cloud Developer Guide

Supported Calls

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

Fields

Field Name	Details
AccountId	Type Lookup(Account) Properties Create, Filter, Group, Nillable, Sort, Update Description Person Account representing the enrollee
CareProgramId	Type Master-Detail(Care Program) Properties Create, Filter, Group, Nillable, Sort, Update Description Look up for Care Program.
IsPatientInLtrmCareFacility	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the patient was at a long-term healthcare facility during outreach or enrollment to the care program. This field is available in API version 56.0 and later. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
LeadId	Type Lookup(Lead) Properties Create, Filter, Group, Nillable, Sort, Update Description Lead representing the enrollee.
Name	Type string Properties Create, Filter, Group, Sort, Update Description Name of the enrollee.
OptOutPeriodEndDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the patient’s opt out from the care program ends. This field is available in API version 56.0 and later.
OptOutPeriodStartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date that the patient opted out of the care program. This field is available in API version 56.0 and later.
OptOutReasonType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why the patient opted out of the care program. This field is available in API version 56.0 and later.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description System from which the enrollee record was sourced.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the system from which the enrollee record was sourced.
Status	Type Pick list Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the enrollee. Possible values are: `Active` `Inactive` `Unenroll`
UserId	Type Lookup(User) Properties Create, Filter, Group, Nillable, Sort, Update Description User representing the enrollee.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

CareProgramEnrolleeFeed: Feed tracking is available for the object.
CareProgramEnrolleeHistory: History is available for tracked fields of the object.