Care Plan Definition Output

Output representation of the care plan definition record and its related goal definition and benefits.

JSON Example 

1{
2  "benefitDefinition": {
3    "associatedActionPlanTemplates": {
4      "records": [
5        {
6          "actionPlanTemplateItems": {
7            "records": [
8              {
9                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
10                "id": "0PJRM00000001fV4AQ",
11                "isRequired": false,
12                "itemEntityType": "Task",
13                "name": "benefit task 3"
14              },
15              {
16                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
17                "id": "0PJRM0000004DpS4AU",
18                "isRequired": false,
19                "itemEntityType": "Task",
20                "name": "benefit task 2"
21              },
22              {
23                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
24                "id": "0PJRM00000001fU4AQ",
25                "isRequired": false,
26                "itemEntityType": "Task",
27                "name": "benefit task 1"
28              }
29            ]
30          },
31          "id": "0PTRM0000004DIK4A2",
32          "name": "Benefit Tasks",
33          "status": "Final"
34        },
35        {
36          "actionPlanTemplateItems": {
37            "records": [
38              {
39                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
40                "id": "0PJRM00000001fV4AQ",
41                "isRequired": false,
42                "itemEntityType": "Task",
43                "name": "benefit task 3"
44              },
45              {
46                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
47                "id": "0PJRM0000004DpS4AU",
48                "isRequired": false,
49                "itemEntityType": "Task",
50                "name": "benefit task 2"
51              },
52              {
53                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
54                "id": "0PJRM00000001fU4AQ",
55                "isRequired": false,
56                "itemEntityType": "Task",
57                "name": "benefit task 1"
58              }
59            ]
60          },
61          "id": "0PTRM0000004DIK4A2",
62          "name": "Benefit Tasks",
63          "status": "Final"
64        },
65        {
66          "actionPlanTemplateItems": {
67            "records": [
68              {
69                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
70                "id": "0PJRM00000001fV4AQ",
71                "isRequired": false,
72                "itemEntityType": "Task",
73                "name": "benefit task 3"
74              },
75              {
76                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
77                "id": "0PJRM0000004DpS4AU",
78                "isRequired": false,
79                "itemEntityType": "Task",
80                "name": "benefit task 2"
81              },
82              {
83                "actionPlanTemplateVersion": "0PTRM0000004DIK4A2",
84                "id": "0PJRM00000001fU4AQ",
85                "isRequired": false,
86                "itemEntityType": "Task",
87                "name": "benefit task 1"
88              }
89            ]
90          },
91          "id": "0PTRM0000004DIK4A2",
92          "name": "Benefit Tasks",
93          "status": "Final"
94        }
95      ]
96    },
97    "id": "0jiRM00000000JwYAI",
98    "isActive": true,
99    "name": "benefit 1"
100  },
101  "id": "0jiRM00000000JwYAI"
102}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
benefitDefinitionBenefit OutputBenefit assignment details of the care plan template benefit.
Note: When goal definition ID is specified in the API request, this property is unspecified.
Small, 56.056.0
goalDefinitionGoal Definition OutputGoal assignment details of the care plan template goal.
Note: When benefit ID is specified in the API request, this property is unspecified.
Small, 56.056.0
idStringID of the definition record specified in the request.Small, 56.056.0
problemDefinitionProblem Definition OutputDetails of the problem definition records.Small, 57.057.0