Care Plans (POST) | Public Sector Solutions Developer Guide

1/connect/careplan/care-plans

1https://yourInstance.salesforce.com/services/data/vXX.X
2/connect/careplan/care-plans

55.0

No

POST

Root XML tag

<CarePlan>

Properties

Name	Type	Description	Required or Optional	Available Version
`benefitAssignments`	Benefit Assignment Input[]	Details of the benefit assignment information of the care plan.	Optional	55.0
`carePlanTasks`	Care Plan Tasks Input	Task details of a care plan.	Optional	56.0
`carePlanTemplateId`	String	ID of the service plan template associated with the care plan.	Optional	55.0
`caseId`	String	Case associated with the care plan.	Required	55.0
`customFields`	Custom Field Input[]	Custom fields details of a care plan.	Optional	56.0
`description`	String	Description of the care plan record.	Optional	55.0
`endDate`	String	Date until when the care plan is effective.	Optional	55.0
`goalAssignments`	Goal Assignment Input[]	Represents the goal assignment information of the care plan.	Optional	55.0
`id`	String	ID of the care plan record.	Optional	55.0
`name`	String	Name of the care plan record.	Required	55.0
`participantId`	String	ID of the account associated with the care plan.	Optional	55.0
`problems`	Problem Definition Input[]	Details of the problems associated with the care plan.	Required	57.0
`startDate`	String	Date from when the care plan is effective.	Optional	55.0
`status`	String	Status of the care plan.	Required	55.0

JSON example

1{
2  "id": "",
3  "name": "Care Plan Success Demo",
4  "participantId": "001x0000008mGwlAAE",
5  "status": "Active",
6  "description": "CP Created from workbench",
7  "startDate": "2022-04-15T20:00:00.000Z",
8  "endDate": "2025-04-15T20:00:00.000Z",
9  "caseId": "500x0000004mPTVAA2",
10  "carePlanTemplateId": "1stx0000000002vAAA",
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": "1gdx000000000OLAAY",
19        "goalAssigneeId": "001x0000008mGwlAAE",
20        "priority": "High",
21        "customFields": {
22          "records": [
23            {
24              "fieldName": "BirthDate__c",
25              "fieldValue": "1996-01-01"
26            },
27            {
28              "fieldName": "RequestedAmount__c",
29              "fieldValue": 5
30            }
31          ]
32        },
33        "goalAssignmentTasks": {
34          "adhocTasks": {
35            "records": [
36              {
37                "subject": " GA Adhoc Task 14567deesfdf",
38                "dueDate": "2022-09-08T00:00:00.000Z",
39                "status": "Not Started",
40                "priority": "Low",
41                "comment": "First BA Adhoc task 34567",
42                "assignedTo": "005x0000000DecJ"
43              },
44              {
45                "subject": "GA Adhoc Task 2345sdsd",
46                "dueDate": "2022-12-08T00:00:00.000Z",
47                "status": "In Progress",
48                "priority": "High",
49                "comment": "Second Adhoc task 5678asdsfdas",
50                "assignedTo": "005x0000000DecJ"
51              },
52              {
53                "subject": "GA Adhoc Task 34567sadsd",
54                "dueDate": "2022-11-08T00:00:00.000Z",
55                "status": "Not Started",
56                "priority": "Medium",
57                "comment": "Third Adhoc task 123456sadadasdasd",
58                "assignedTo": "005x0000000DecJ"
59              },
60              {
61                "subject": "GA Adhoc Task 44567sadwqdwqd",
62                "dueDate": "2022-08-10T00:00:00.000Z",
63                "status": "Not Started",
64                "priority": "High",
65                "comment": "Fourth Adhoc task 34567sdsadasdasd",
66                "assignedTo": "005x0000000DecJ"
67              }
68            ]
69          }
70        }
71      },
72      {
73        "startDate": "2022-07-05T00:00:00.000Z",
74        "targetCompletionDate": "2022-07-09T00:00:00.000Z",
75        "completionPercentage": 78,
76        "goalAssigneeId": "001x0000008mGwlAAE",
77        "goalDefinitionId": "1gdx00000000QnKAAU",
78        "priority": "Medium",
79        "customFields": {
80          "records": [
81            {
82              "fieldName": "BirthDate__c",
83              "fieldValue": "1998-01-01"
84            },
85            {
86              "fieldName": "RequestedAmount__c",
87              "fieldValue": 5
88            }
89          ]
90        },
91        "goalAssignmentTasks": {
92          "adhocTasks": {
93            "records": [
94              {
95                "subject": " GA Adhoc Task 14567dawasfdasf",
96                "dueDate": "2022-09-08T00:00:00.000Z",
97                "status": "Not Started",
98                "priority": "Low",
99                "comment": "First GA Adhoc task 34567asdasdfdasfdaf",
100                "assignedTo": "005x0000000DecJ"
101              },
102              {
103                "subject": "BA Adhoc Task 2345wewrw",
104                "dueDate": "2022-12-08T00:00:00.000Z",
105                "status": "In Progress",
106                "priority": "High",
107                "comment": "Second Adhoc task 5678",
108                "assignedTo": "005x0000000DecJ"
109              },
110              {
111                "subject": "BA Adhoc Task 3456713eqasdasfddf",
112                "dueDate": "2022-11-08T00:00:00.000Z",
113                "status": "Not Started",
114                "priority": "Medium",
115                "comment": "Third Adhoc task 123456",
116                "assignedTo": "005x0000000DecJ"
117              },
118              {
119                "subject": "BA Adhoc Task 44567wqewqewqr",
120                "dueDate": "2022-08-10T00:00:00.000Z",
121                "status": "Not Started",
122                "priority": "High",
123                "comment": "Fourth Adhoc task 34567",
124                "assignedTo": "005x0000000DecJ"
125              }
126            ]
127          }
128        }
129      }
130    ]
131  },
132  "benefitAssignments": {
133    "records": [
134      {
135        "enrollmentCount": 5,
136        "entitlementAmount": 100,
137        "participantId": "001x0000008mGwlAAE",
138        "benefitId": "0jix000000000LgAAI",
139        "associatedGoalAssignment": {
140          "goalDefinitionId": "1gdx000000000ItAAI",
141          "startDate": "2022-07-05T00:00:00.000Z",
142          "targetCompletionDate": "2022-07-09T00:00:00.000Z",
143          "completionPercentage": "83",
144          "status": "Active",
145          "goalAssigneeId": "001x0000008mGwlAAE",
146          "priority": "High",
147          "goalAssignmentTasks": {
148            "adhocTasks": {
149              "records": [
150                {
151                  "subject": " GA Adhoc Task 14567dawasfdasf",
152                  "dueDate": "2022-09-08T00:00:00.000Z",
153                  "status": "Not Started",
154                  "priority": "Low",
155                  "comment": "First GA Adhoc task 34567asdasdfdasfdaf",
156                  "assignedTo": "005x0000000DecJ"
157                },
158                {
159                  "subject": "BA Adhoc Task 2345wewrw",
160                  "dueDate": "2022-12-08T00:00:00.000Z",
161                  "status": "In Progress",
162                  "priority": "High",
163                  "comment": "Second Adhoc task 5678",
164                  "assignedTo": "005x0000000DecJ"
165                },
166                {
167                  "subject": "BA Adhoc Task 3456713eqasdasfddf",
168                  "dueDate": "2022-11-08T00:00:00.000Z",
169                  "status": "Not Started",
170                  "priority": "Medium",
171                  "comment": "Third Adhoc task 123456",
172                  "assignedTo": "005x0000000DecJ"
173                },
174                {
175                  "subject": "BA Adhoc Task 44567wqewqewqr",
176                  "dueDate": "2022-08-10T00:00:00.000Z",
177                  "status": "Not Started",
178                  "priority": "High",
179                  "comment": "Fourth Adhoc task 34567",
180                  "assignedTo": "005x0000000DecJ"
181                }
182              ]
183            }
184          },
185          "customFields": {
186            "records": [
187              {
188                "fieldName": "BirthDate__c",
189                "fieldValue": "1998-01-01"
190              },
191              {
192                "fieldName": "RequestedAmount__c",
193                "fieldValue": 5
194              }
195            ]
196          }
197        },
198        "customFields": {
199          "records": [
200            {
201              "fieldName": "cust_date__c",
202              "fieldValue": "1998-01-01"
203            },
204            {
205              "fieldName": "cust_amount__c",
206              "fieldValue": 5
207            }
208          ]
209        },
210        "benefitAssignmentTasks": {
211          "adhocTasks": {
212            "records": [
213              {
214                "subject": " BA Adhoc Task Rec1",
215                "dueDate": "2022-09-08T00:00:00.000Z",
216                "status": "Not Started",
217                "priority": "Low",
218                "comment": "First BA Adhoc task Rec 1234",
219                "assignedTo": "005x0000000DecJ"
220              },
221              {
222                "subject": "BA Adhoc Task Rec 232143",
223                "dueDate": "2022-12-08T00:00:00.000Z",
224                "status": "In Progress",
225                "priority": "High",
226                "comment": "Second Adhoc task Rec 121324325",
227                "assignedTo": "005x0000000DecJ"
228              },
229              {
230                "subject": "BA Adhoc Task Rec 21325346457",
231                "dueDate": "2022-11-08T00:00:00.000Z",
232                "status": "Not Started",
233                "priority": "Medium",
234                "comment": "Third Adhoc task Rec 2324234235",
235                "assignedTo": "005x0000000DecJ"
236              },
237              {
238                "subject": "BA Adhoc Task Rec 1342432423",
239                "dueDate": "2022-08-10T00:00:00.000Z",
240                "status": "Not Started",
241                "priority": "High",
242                "comment": "Fourth Adhoc task Rec 2343242345",
243                "assignedTo": "005x0000000DecJ"
244              }
245            ]
246          }
247        }
248      }
249    ]
250  },
251  "customFields": {
252    "records": [
253      {
254        "fieldName": "tests1234__c",
255        "fieldValue": "demo text"
256      }
257    ]
258  },
259  "medicationTherapyReview": "",
260  "carePlanTasks": {
261    "adhocTasks": {
262      "records": [
263        {
264          "subject": "Adhoc Task 19087899",
265          "dueDate": "2022-08-09T00:00:00.000Z",
266          "status": "In Progress",
267          "priority": "High",
268          "comment": "First Adhoc task 19082343254325",
269          "assignedTo": "005x0000000DecJ"
270        },
271        {
272          "subject": "Adhoc Task 290889999",
273          "dueDate": "2022-08-31T00:00:00.000Z",
274          "status": "Not Started",
275          "priority": "High",
276          "comment": "Second Adhoc task 29083424324",
277          "assignedTo": "005x0000000DecJ"
278        },
279        {
280          "subject": "Adhoc Task 390821324324",
281          "dueDate": "2022-08-08T00:00:00.000Z",
282          "status": "Not Started",
283          "priority": "Low",
284          "comment": "Third Adhoc task 39082343243245",
285          "assignedTo": "005x0000000DecJ"
286        }
287      ]
288    }
289  }
290}

Generic Output