ProgramEnrollment

AccountId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the account that’s associated with an individual or an organization enrolled in the program.

  This field is a relationship field.

• Relationship Name: Account
• Relationship Type: Lookup
• Refers To: Account

ApplicationDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the enrollee applied to the program.

ContactId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the contact that’s associated with an individual enrolled in the program.

  This field is a relationship field.

• Relationship Name: Contact
• Relationship Type: Lookup
• Refers To: Contact

CurrentMonthDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed to the enrollee in the current month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

CurrentYearDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed to the enrollee in the current year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

EligibilityLastVerifiedDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the enrollee's program eligibility status was last verified.

EndDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The end date of the enrollment in the program.

IsActive

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the enrollment for the participant in the program is active (true) or not (false).
• Default value: false

IsAnonymous

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the participant enrolled to the program anonymously (true) or not (false).
• Default value: false

LastReferencedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view.

Name

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: The name of the program enrollment record.

OwnerId

• Type: reference
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: The user who owns the object.

  This field is a polymorphic relationship field.

• Relationship Name: Owner
• Relationship Type: Lookup
• Refers To: Group, User

PreviousMonthDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefit disbursed to the enrollee in the previous month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

PreviousYearDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed to the enrollee in the previous year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

ProgramId

• Type: reference
• Properties: Create, Filter, Group, Sort
• Description: The identifier of the program that's associated with the enrollee.

  This field is a relationship field.

• Relationship Name: Program
• Relationship Type: Master-Detail
• Refers To: Program

SessionsAbsentCount

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The total number of benefit sessions for the program that were scheduled for the participant but not attended.

  This field is available from API version 65.0 and later.

SessionsAttendanceRate

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The percentage of scheduled benefit sessions for the program that the participant attended. The value of this field is calculated by a formula: (Attended Sessions Count) / (Attended Sessions Count + Absent Sessions Count)

  This field is available from API version 65.0 and later.

SessionsAttendedCount

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The total number of benefit sessions for the program that were scheduled for and attended by the participant.

  This field is available from API version 65.0 and later.

StartDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The start date of the enrollment in the program.

Status

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: The enrollment status of the enrollee for the program.
• Default value: Applied
• Possible values:
  • Applied
  • Completed
  • Denied
  • In Progress
  • Waitlisted
  • Withdrawn

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.

ProgramEnrollmentFeed

Feed tracking is available for the object.

ProgramEnrollmentHistory

History is available for tracked fields of the object.

ProgramEnrollmentOwnerSharingRule

Sharing rules are available for the object.

ProgramEnrollmentShare

Sharing is available for the object.