Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Care Plan Output

Output representation of the care plan and the associated benefit assignment and goal assignment records.

JSON example

1{
2  "benefitAssignments": {
3    "records": [
4      {
5        "benefitAssignmentTasks": {
6          "tasks": {
7            "records": [
8              {
9                "dueDate": "2022-09-20",
10                "id": "00TRM00000Jxna72AB",
11                "priority": "Low",
12                "relatedTo": "0nDRM0000004CGJ2A2",
13                "status": "Not Started",
14                "subject": "Benefit Task 1"
15              },
16              {
17                "id": "00TRM00000K3a3c2AB",
18                "priority": "Normal",
19                "relatedTo": "0nDRM0000004CGJ2A2",
20                "status": "In Progress",
21                "subject": "test task 0"
22              }
23            ]
24          }
25        },
26        "benefitId": "0jiRM00000000KGYAY",
27        "benefitName": "Test Benefit 1",
28        "customFields": {
29          "records": [
30            {
31              "dataType": "Boolean",
32              "fieldName": "CustomCheckbox__c",
33              "fieldValue": false
34            }
35          ]
36        },
37        "id": "0nDRM0000004CGJ2A2",
38        "participantId": "001RM000005LXQcYAO",
39        "priority": "Low"
40      }
41    ]
42  },
43  "carePlanTasks": {
44    "tasks": {
45      "records": [
46        {
47          "dueDate": "2022-09-10",
48          "id": "00TRM00000Jxna62AB",
49          "priority": "Low",
50          "relatedTo": "1spRM0000004CDZYA2",
51          "status": "Not Started",
52          "subject": "Test CPT task"
53        }
54      ]
55    }
56  },
57  "carePlanTemplateId": "1stRM000000001nYAA",
58  "carePlanTemplateName": "Test CPT_2",
59  "caseId": "500RM000003nux7YAA",
60  "customFields": {
61    "records": [
62      {
63        "dataType": "Boolean",
64        "fieldName": "CustomCheckBox__c",
65        "fieldValue": false
66      },
67      {
68        "dataType": "Boolean",
69        "fieldName": "CustomCheckbox3__c",
70        "fieldValue": false
71      },
72      {
73        "dataType": "Boolean",
74        "fieldName": "isChecked__c",
75        "fieldValue": false
76      },
77      {
78        "dataType": "Double",
79        "fieldName": "testNum__c",
80        "fieldValue": 433
81      }
82    ]
83  },
84  "goalAssignments": {
85    "records": [
86      {
87        "completionPercentage": 0,
88        "customFields": {
89          "records": [
90            {
91              "dataType": "Boolean",
92              "fieldName": "CustomCheckbox2__c",
93              "fieldValue": false
94            }
95          ]
96        },
97        "goalAssignmentTasks": {
98          "tasks": {
99            "records": [
100              {
101                "dueDate": "2022-10-01",
102                "id": "00TRM00000Jxna32AB",
103                "priority": "Low",
104                "relatedTo": "1pgRM0000004CCCYA2",
105                "status": "Not Started",
106                "subject": "Goal Task 1"
107              }
108            ]
109          }
110        },
111        "goalDefinitionId": "1gdRM0000004CBTYA2",
112        "goalDefinitionName": "Test Stra Goal 1",
113        "goalType": "Strategic",
114        "id": "1pgRM0000004CCCYA2",
115        "status": "Active"
116      },
117      {
118        "completionPercentage": 0,
119        "customFields": {
120          "records": [
121            {
122              "dataType": "Boolean",
123              "fieldName": "CustomCheckbox2__c",
124              "fieldValue": false
125            }
126          ]
127        },
128        "goalAssigneeId": "001RM000005MZefYAG",
129        "goalAssignmentTasks": {
130          "tasks": {
131            "records": [
132              {
133                "dueDate": "2022-10-01",
134                "id": "00TRM00000Jxna52AB",
135                "priority": "Low",
136                "relatedTo": "1pgRM0000004CCDYA2",
137                "status": "Not Started",
138                "subject": "Goal Task 1"
139              }
140            ]
141          }
142        },
143        "goalDefinitionId": "1gdRM000000001OYAQ",
144        "goalDefinitionName": "Test Ind Goal 1",
145        "goalType": "Individual",
146        "id": "1pgRM0000004CCDYA2",
147        "priority": "Low",
148        "status": "Active"
149      }
150    ]
151  },
152  "id": "1spRM0000004CDZYA2",
153  "name": "test CP",
154  "participantId": "001RM000005LXQcYAO",
155  "status": "Started",
156  "taskJobStatus": "Completed"
157}

Property Name	Type	Description	Filter Group and Version	Available Version
`benefitAssignments`	Benefit Assignment List	List of benefit assignments associated with the care plan record.	Small, 55.0	55.0
`carePlanTasks`	Care Plan Tasks	Tasks for a care plan.	Small, 56.0	56.0
`carePlanTemplateId`	String	ID of the service plan template associated with the care plan.	Small, 55.0	55.0
`carePlanTemplateName`	String	Name of the service plan template associated with the care plan.	Small, 55.0	55.0
`caseId`	String	Case associated with the care plan record.	Small, 55.0	55.0
`customFields`	Custom Field List	Custom fields details of the care plan.	Small, 56.0	56.0
`description`	String	Description of the care plan record.	Small, 55.0	55.0
`endDate`	String	Date until when the care plan is effective.	Small, 55.0	55.0
`goalAssignments`	Goal Assignment List	List of goal assignments associated with this care plan record.	Small, 55.0	55.0
`id`	String	ID of the care plan record.	Small, 55.0	55.0
`name`	String	Name of the care plan record.	Small, 55.0	55.0
`participantId`	String	ID of the account associated with the care plan.	Small, 55.0	55.0
`startDate`	String	Date from when the care plan is effective.	Small, 55.0	55.0
`status`	String	Status of the care plan.	Small, 55.0	55.0
taskJobAggregatedStatus	String	The aggregated status of the tasks associated with the care plan record.	Small, 57.0	58.0
`taskJobStatus`	String	Reserved for internal use.	Small, 56.0	56.0
`taskJobStatusReason`	String	Reserved for internal use.	Small, 56.0	56.0

Public Sector Developer Guide

Care Plan Output