Care Plans (GET, PATCH)

Retrieve the care plan details. Fetches benefit assignments and goal assignments associated with the given care plan. Update a care plan record.

Resource

1/connect/careplan/care-plans/${carePlanId}

Resource Example

1https://{yourInstance}.salesforce.com/services/data/68.0
2/connect/careplan/care-plans/1spRM0000004CDZYA2

Available Version

55.0

Requires Chatter

HTTP Methods

GET, PATCH

PATCH is available in version 56.0 and later.

Response Body for GET

Care Plan Output

Request Body for PATCH

Care Plan Input

1{
2  "id": "1spxx000000026fAAA",
3  "name": "CP-(-678",
4  "participantId": "001xx000003HTqdAAG",
5  "status": "Draft",
6  "description": "CP Created from workbench",
7  "startDate": "2022-04-15T20:00:00.000Z",
8  "endDate": "2025-04-15T20:00:00.000Z",
9  "caseId": "500xx000000d0SXAAY",
10  "carePlanTemplateId": "1stxx0000000149AAA",
11  "goalAssignments": {
12    "records": [
13      {
14        "startDate": "2022-07-05T00:00:00.000Z",
15        "targetCompletionDate": "2022-07-09T00:00:00.000Z",
16        "completionPercentage": 34,
17        "status": "In Progress",
18        "goalDefinitionId": "1gdxx0000000G1ZAAU",
19        "id": "1pgxx00000000zJAAQ",
20        "priority": "High",
21        "customFields": {
22          "records": []
23        },
24        "goalAssignmentTasks": {
25          "excludedTasks": {
26            "tasks": [
27              "00Txx000003rMTaEAM",
28              "00Txx000003rMTxEAM",
29              "00Txx000003rMTdEAM"
30            ]
31          },
32          "adhocTasks": {
33            "records": [
34              {
35                "subject": "GA Adhoc Task 14567deesfdf",
36                "dueDate": "2022-09-08T00:00:00.000Z",
37                "status": "Not Started",
38                "priority": "Low",
39                "comment": "First BA Adhoc task 34567",
40                "assignedTo": "005xx000001YkA1AAK"
41              },
42              {
43                "subject": "GA Adhoc Task 2345sdsd",
44                "dueDate": "2022-12-08T00:00:00.000Z",
45                "status": "In Progress",
46                "priority": "High",
47                "comment": "Second Adhoc task 5678asdsfdas",
48                "assignedTo": "005xx000001YkA1AAK"
49              },
50              {
51                "subject": "GA Adhoc Task 34567sadsd",
52                "dueDate": "2022-11-08T00:00:00.000Z",
53                "status": "Not Started",
54                "priority": "Medium",
55                "comment": "Third Adhoc task 123456sadadasdasd",
56                "assignedTo": "005xx000001YkA1AAK"
57              },
58              {
59                "subject": "GA Adhoc Task 44567sadwqdwqd",
60                "dueDate": "2022-08-10T00:00:00.000Z",
61                "status": "Not Started",
62                "priority": "High",
63                "comment": "Fourth Adhoc task 34567sdsadasdasd",
64                "assignedTo": "005xx000001YkA1AAK"
65              }
66            ]
67          },
68          "tasks": {
69            "records": [
70              {
71                "subject": "Update CP Edit GOAL ASSIGNEMENT Task 990",
72                "dueDate": "2022-19-08T00:00:00.000Z",
73                "status": "Not Started",
74                "priority": "Low",
75                "comment": "Update CP Edit GOAL ASSIGNEMENT Task 990",
76                "assignedTo": "005xx000001YkA1AAK",
77                "id": "00Txx000003rMTcEAM"
78              },
79              {
80                "subject": "Update CP Edit GOAL ASSIGNMENT ADHOC TASK Task 7686970",
81                "dueDate": "2022-19-08T00:00:00.000Z",
82                "status": "In Progress",
83                "priority": "High",
84                "comment": "Update CP Edit GOAL ASSIGNMENT ADHOC TASK Task 7686970",
85                "assignedTo": "005xx000001YkA1AAK",
86                "id": "00Txx000003rMTuEAM"
87              }
88            ]
89          }
90        }
91      },
92      {
93        "startDate": "2022-07-05T00:00:00.000Z",
94        "targetCompletionDate": "2022-07-09T00:00:00.000Z",
95        "completionPercentage": 78,
96        "goalAssigneeId": "001xx000003HTqdAAG",
97        "goalDefinitionId": "1gdxx0000000FzxAAE",
98        "id": "1pgxx00000000zKAAQ",
99        "priority": "Medium",
100        "customFields": {
101          "records": []
102        },
103        "goalAssignmentTasks": {
104          "excludedTasks": {
105            "tasks": [
106              "00Txx000003rMTyEAM",
107              "00Txx000003rMTXEA2",
108              "00Txx000003rMTZEA2"
109            ]
110          },
111          "adhocTasks": {
112            "records": [
113              {
114                "subject": " GA Adhoc Task 14567dawasfdasf",
115                "dueDate": "2022-09-08T00:00:00.000Z",
116                "status": "Not Started",
117                "priority": "Low",
118                "comment": "First GA Adhoc task 34567asdasdfdasfdaf",
119                "assignedTo": "005xx000001YkA1AAK"
120              },
121              {
122                "subject": "BA Adhoc Task 2345wewrw",
123                "dueDate": "2022-12-08T00:00:00.000Z",
124                "status": "In Progress",
125                "priority": "High",
126                "comment": "Second Adhoc task 5678",
127                "assignedTo": "005xx000001YkA1AAK"
128              },
129              {
130                "subject": "BA Adhoc Task 3456713eqasdasfddf",
131                "dueDate": "2022-11-08T00:00:00.000Z",
132                "status": "Not Started",
133                "priority": "Medium",
134                "comment": "Third Adhoc task 123456",
135                "assignedTo": "005xx000001YkA1AAK"
136              },
137              {
138                "subject": "BA Adhoc Task 44567wqewqewqr",
139                "dueDate": "2022-08-10T00:00:00.000Z",
140                "status": "Not Started",
141                "priority": "High",
142                "comment": "Fourth Adhoc task 34567",
143                "assignedTo": "005xx000001YkA1AAK"
144              }
145            ]
146          },
147          "tasks": {
148            "records": [
149              {
150                "subject": "Update CP Edit GOAL ASSIGNEMENT Task 123124334",
151                "dueDate": "2022-19-08T00:00:00.000Z",
152                "status": "Not Started",
153                "priority": "Low",
154                "comment": "Update CP Edit GOAL ASSIGNEMENT Task 213213414",
155                "assignedTo": "005xx000001YkA1AAK",
156                "id": "00Txx000003rMTYEA2"
157              },
158              {
159                "subject": "Update CP Edit GOAL ASSIGNMENT ADHOC TASK Task 7686970",
160                "dueDate": "2022-19-08T00:00:00.000Z",
161                "status": "In Progress",
162                "priority": "High",
163                "comment": "Update CP Edit GOAL ASSIGNMENT ADHOC TASK Task 7686970",
164                "assignedTo": "005xx000001YkA1AAK",
165                "id": "00Txx000003rMU1EAM"
166              }
167            ]
168          }
169        }
170      }
171    ]
172  },
173  "benefitAssignments": {
174    "records": [
175      {
176        "enrollmentCount": 5,
177        "entitlementAmount": 100,
178        "participantId": "001xx000003HTqdAAG",
179        "id": "0nDxx00000000uTEAQ",
180        "benefitId": "0jixx00000000JNAAY",
181        "customFields": {
182          "records": []
183        },
184        "benefitAssignmentTasks": {
185          "excludedTasks": {
186            "tasks": [
187              "00Txx000003rMTeEAM",
188              "00Txx000003rMTfEAM",
189              "00Txx000003rMTgEAM"
190            ]
191          },
192          "adhocTasks": {
193            "records": [
194              {
195                "subject": " BA Adhoc Task Rec1",
196                "dueDate": "2022-09-08T00:00:00.000Z",
197                "status": "Not Started",
198                "priority": "Low",
199                "comment": "First BA Adhoc task Rec 1234",
200                "assignedTo": "005xx000001YkA1AAK"
201              },
202              {
203                "subject": "BA Adhoc Task Rec 232143",
204                "dueDate": "2022-12-08T00:00:00.000Z",
205                "status": "In Progress",
206                "priority": "High",
207                "comment": "Second Adhoc task Rec 121324325",
208                "assignedTo": "005xx000001YkA1AAK"
209              },
210              {
211                "subject": "BA Adhoc Task Rec 21325346457",
212                "dueDate": "2022-11-08T00:00:00.000Z",
213                "status": "Not Started",
214                "priority": "Medium",
215                "comment": "Third Adhoc task Rec 2324234235",
216                "assignedTo": "005xx000001YkA1AAK"
217              },
218              {
219                "subject": "BA Adhoc Task Rec 1342432423",
220                "dueDate": "2022-08-10T00:00:00.000Z",
221                "status": "Not Started",
222                "priority": "High",
223                "comment": "Fourth Adhoc task Rec 2343242345",
224                "assignedTo": "005xx000001YkA1AAK"
225              }
226            ]
227          },
228          "tasks": {
229            "records": [
230              {
231                "subject": "Update CP Edit Benefit Task 440",
232                "dueDate": "2022-19-08T00:00:00.000Z",
233                "status": "Not Started",
234                "priority": "Low",
235                "comment": "Update CP Edit Task 123243124 comment",
236                "assignedTo": "005xx000001YkA1AAK",
237                "id": "00Txx000003rMTiEAM"
238              },
239              {
240                "subject": "Update CP Edit Benefit Task 900",
241                "dueDate": "2022-19-08T00:00:00.000Z",
242                "status": "In Progress",
243                "priority": "High",
244                "comment": "Update CP Edit Benefit Task 12312312321 comment",
245                "assignedTo": "005xx000001YkA1AAK",
246                "id": "00Txx000003rMThEAM"
247              }
248            ]
249          }
250        }
251      }
252    ]
253  },
254  "customFields": {
255    "records": []
256  },
257  "carePlanTasks": {
258    "excludedTasks": {
259      "tasks": [
260        "00Txx000003rMTnEAM",
261        "00Txx000003rMTUEA2",
262        "00Txx000003rMTVEA2"
263      ]
264    },
265    "adhocTasks": {
266      "records": [
267        {
268          "subject": "Adhoc Task Update CP 121312321",
269          "dueDate": "2022-08-09T00:00:00.000Z",
270          "status": "In Progress",
271          "priority": "Low",
272          "comment": "Adhoc Task Update CP 121312321",
273          "assignedTo": "005xx000001YkA1AAK"
274        },
275        {
276          "subject": "Adhoc Task Update CP wdsf12312321",
277          "dueDate": "2022-08-31T00:00:00.000Z",
278          "status": "Not Started",
279          "priority": "Low",
280          "comment": "Adhoc Task Update CP wdsf12312321",
281          "assignedTo": "005xx000001YkA1AAK"
282        },
283        {
284          "subject": "Adhoc Task Update CP 21321312sdsd",
285          "dueDate": "2022-08-08T00:00:00.000Z",
286          "status": "Not Started",
287          "priority": "Low",
288          "comment": "Adhoc Task Update CP 21321312sdsd",
289          "assignedTo": "005xx000001YkA1AAK"
290        }
291      ]
292    },
293    "tasks": {
294      "records": [
295        {
296          "subject": "Update CP Edit Task One",
297          "dueDate": "2022-19-08T00:00:00.000Z",
298          "status": "Completed",
299          "priority": "High",
300          "comment": "Update CP Edit Task One",
301          "assignedTo": "005xx000001YkA1AAK",
302          "id": "00Txx000003rMTWEA2"
303        }
304      ]
305    }
306  }
307}

Response Body for PATCH

Generic Output