Newer Version Available

This content describes an older version of this product. View Latest

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        "benefitId": "0jiRN000000000aYAA",
6        "benefitName": "Fitness benefit",
7        "id": "0nDRN000000002w2AA",
8        "participantId": "001RN000002xgDZYAY",
9        "priority": "Low"
10      },
11      {
12        "benefitId": "0jiRN000000000fYAA",
13        "benefitName": "Meditation benefit",
14        "id": "0nDRN000000002v2AA",
15        "participantId": "001RN000002xgDZYAY",
16        "priority": "Low"
17      }
18    ]
19  },
20  "carePlanTemplateId": "1stRN000000000VYAQ",
21  "carePlanTemplateName": "CPT Test",
22  "caseId": "500RN000001ONfUYAW",
23  "goalAssignments": {
24    "records": [
25      {
26        "completionPercentage": 0,
27        "goalAssigneeId": "001RN000002xgDZYAY",
28        "goalDefinitionId": "1gdRN0000000006YAA",
29        "goalDefinitionName": "Career goal",
30        "goalType": "Individual",
31        "id": "1pgRN000000001TYAQ",
32        "priority": "Low",
33        "status": "Not Started"
34      }
35    ]
36  },
37  "id": "1spRN000000003PYAQ",
38  "name": "CP1",
39  "participantId": "001RN000002xgDZYAY",
40  "status": "Proposed"
41}
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
carePlanTemplateId String ID of the service plan template associated with the care plan. Small, 55.0 55.0
carePlanTemplate​Name 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
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