CareProgramEnrollee

Represents a participant enrolled in a care program.

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.
ClinicalServiceRequestId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The clinical service request associated with the care program enrollee. This field is a relationship field and is available in API version 60.0 and later. Relationship Name ClinicalServiceRequest Relationship Type Lookup Refers To ClinicalServiceRequest
CurrentWorkOrderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order that's currently being executed for the care program enrollee. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 58.0 and later. Relationship Name CurrentWorkOrder Relationship Type Lookup Refers To CarePgmEnrolleeWorkOrder
CurrentWorkOrderStepId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The work order step that's currently being executed for the care program enrollee. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 58.0 and later. Relationship Name CurrentWorkOrderStep Relationship Type Lookup Refers To CarePgmEnrolleeWkOrdStep
EnrollmentLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The service territory where an advanced therapy care program is executed. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 59.0 and later. Relationship Name EnrollmentLocation Relationship Type Lookup Refers To ServiceTerritory
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 for the Medication Management feature 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.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The UserId for the record owner. This field is a polymorphic relationship field. This field is available in API version 58.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 picklist 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. 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.

CareProgramEnrolleeChangeEvent (API version 59.0): Change events are available for the object.
CareProgramEnrolleeFeed: Feed tracking is available for the object.
CareProgramEnrolleeHistory: History is available for tracked fields of the object.

CareProgramEnrolleeOwnerSharingRule (API version 58.0): Sharing rules are available for the object.
CareProgramEnrolleeShare (API version 58.0): Sharing is available for the object.

Salesforce Health Cloud Developer Guide

CareProgramEnrollee

Supported Calls

Fields

Associated Objects