Care Plans (POST)

Create care plan records. Associate benefit assignments and goal assignments when creating a care plan.

Resource

1/connect/careplan/care-plans

Resource example

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

Available version

55.0

Requires Chatter

HTTP methods

POST

Request body for POST

Root XML tag

<CarePlan>

JSON example

1{
2  "id": "",
3  "name": "CP FROM WORKBENCH",
4  "participantId": "001RN000002xgDZYAY",
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": "500RN000001OR0VYAW",
10  "carePlanTemplateId": "1stRN000000000fYAA",
11  "goalAssignments": {
12    "records": [
13      {
14        "id": "",
15        "startDate": "2022-04-15T20:00:00.000Z",
16        "targetCompletionDate": "2025-04-15T20:00:00.000Z",
17        "completionPercentage": "10",
18        "status": "Not Started",
19        "goalAssigneeId": "001RN000002xgDZYAY",
20        "goalDefinitionId": "1gdRN0000000006YAA",
21        "priority": "High"
22      },
23      {
24        "id": "",
25        "startDate": "2022-04-15T20:00:00.000Z",
26        "targetCompletionDate": "2025-04-15T20:00:00.000Z",
27        "completionPercentage": "10",
28        "status": "Not Started",
29        "goalAssigneeId": "001RN000002xgDZYAY",
30        "goalDefinitionId": "1gdRN000000000BYAQ",
31        "priority": "Low"
32      }
33    ]
34  },
35  "benefitAssignments": {
36    "records": [
37      {
38        "id": "",
39        "startDate": "2022-04-15T20:00:00.000Z",
40        "endDate": "2025-04-15T20:00:00.000Z",
41        "enrollmentCount": "10",
42        "entitlementAmount": "100",
43        "maximumAmount": "1000",
44        "participantId": "001RN000002xgDZYAY",
45        "benefitId": "0jiRN000000000aYAA",
46        "priority": "High"
47      },
48      {
49        "id": "",
50        "startDate": "2022-04-15T20:00:00.000Z",
51        "endDate": "2025-04-15T20:00:00.000Z",
52        "enrollmentCount": "10",
53        "entitlementAmount": "100",
54        "maximumAmount": "1000",
55        "participantId": "001RN000002xgDZYAY",
56        "benefitId": "0jiRN000000000kYAA",
57        "priority": "Low",
58        "associatedGoalAssignment": {
59          "id": "",
60          "startDate": "2022-04-15T20:00:00.000Z",
61          "targetCompletionDate": "2025-04-15T20:00:00.000Z",
62          "completionPercentage": "10",
63          "status": "Not Started",
64          "goalAssigneeId": "001RN000002xgDZYAY",
65          "goalDefinitionId": "1gdRN000000000GYAQ",
66          "priority": "Low"
67        }
68      }
69    ]
70  }
71}

Properties

Name	Type	Description	Required or Optional	Available Version
`benefitAssignments`	Benefit Assignment Input[]	Represents the benefit assignment information of the care plan.	Optional	55.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
`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
`startDate`	String	Date from when the care plan is effective.	Optional	55.0
`status`	String	Status of the care plan.	Required	55.0

Response body for POST

Generic Output

Public Sector Solutions Developer Guide

Care Plans (POST)