Mentoring Benefit Assignment Details

Output representation of the benefit assignment record that’s updated with provider details.

JSON Example 

This JSON example shows the updated providerId details.

1{
2  "mentoringBenefitAssignment": {
3    "benefitId": "0jixx0000000001AAA",
4    "createdById": "005xx000001X7rlAAC",
5    "createdDate": "2023-10-31T04:34:46.000+0000",
6    "endDateTime": "2023-11-11T20:00:00.000+0000",
7    "enrolleeId": "003xx000004WhHQAA0",
8    "enrollmentCount": "1",
9    "entitlementAmount": "1.00",
10    "id": "0nDxx0000000001EAA",
11    "lastModifiedById": "005xx000001X7rlAAC",
12    "lastModifiedDate": "2023-11-01T00:38:55.000+0000",
13    "maximumBenefitAmount": "1.00",
14    "minimumBenefitAmount": "1.00",
15    "name": "BA-000000001",
16    "parentRecordId": "11Xxx0000004GfjEAE",
17    "priority": "High",
18    "programEnrollmentId": "11Xxx0000004GfjEAE",
19    "providerId": "003xx000004WhJ2AAK",
20    "startDateTime": "2023-10-30T19:00:00.000+0000",
21    "status": "Enrolled",
22    "taskJobStatus": "NA",
23    "taskJobStatusMessage": "NA",
24    "unitOfMeasureId": "0hExx0000000001EAA"
25  }
26}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
benefitIdStringID of the benefit associated with the benefit assignment.Small, 60.060.0
createdByIdStringID of the user who created the benefit assignment.Small, 60.060.0
createdDateStringDate when the benefit assignment record was created.Small, 60.060.0
endDateTimeStringDate and time until when the assignment is valid.Small, 60.060.0
enrolleeIdStringID of the participant who enrolls for the benefit assignment.Small, 60.060.0
enrollment​CountStringNumber of times that the benefit is applicable to an individual.Small, 60.060.0
entitlement​AmountStringAmount that a participant is entitled to receive from the assignment.Small, 60.060.0
idStringID of the benefit assignment record.Small, 60.060.0
lastModified​ByIdStringID of the user who updated the benefit assignment record.Small, 60.060.0
lastModified​DateStringDate when the benefit assignment record was last modified.Small, 60.060.0
maximum​BenefitAmountStringMaximum amount that’s disbursed during an assignment period.Small, 60.060.0
minimum​BenefitAmountStringMinimum amount that’s disbursed during an assignment period.Small, 60.060.0
nameStringName of the benefit assignment.Small, 60.060.0
parent​RecordIdStringID of the parent record that’s associated with the benefit assignment.Small, 60.060.0
priorityStringPriority of the benefit assignment record.Small, 60.060.0
program​EnrollmentIdStringID of the enrollment program record created for the participant that this benefit is assigned to.Small, 60.060.0
providerIdStringID of the contact who provides the benefit that’s associated with the benefit assignment.Small, 60.060.0
startDate​TimeStringDate and time when the benefit assignment was first available.Small, 60.060.0
statusStringStatus of the benefit assignment.Small, 60.060.0
taskJob​StatusStringStatus of the task that’s associated with the benefit assignment.Small, 60.060.0
taskJob​StatusMessageStringStatus message of the task that’s associated with the benefit assignment.Small, 60.060.0
unitOf​MeasureIdStringID of the unit of measure that’s associated with the benefit assignment.Small, 60.060.0