@salesforce/lds-adapters-industries-public-sector 0.1.0-dev1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +82 -0
- package/dist/es/es2018/industries-public-sector.js +4061 -0
- package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/adapters/createBenefitDisbursements.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/createCarePlanTasks.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/getCarePlanBenefitSessionDetails.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getCarePlanDefinition.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getCarePlanDetails.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/adapters/getCarePlanTasks.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getCarePlanTemplateDetails.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/postCarePlanDetails.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/postCarePlanTemplateDetails.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/adapters/updateCarePlanDetails.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/updateCarePlanTasks.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +23 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCareplanBenefitSessionByCarePlanId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCareplanCarePlansByCarePlanId.d.ts +20 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCareplanCarePlansTasksByCarePlanId.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCareplanCareplanTemplatesByCarePlanTemplateId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCareplanDefinitionsByDefinitionId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectCareplanCarePlansByCarePlanId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectCareplanCarePlansTasksByCarePlanId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectBenefitAssignmentBenefitDisbursementsByBenefitAssignmentId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCareplanCarePlans.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCareplanCarePlansTasksByCarePlanId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCareplanCareplanTemplatesActionsByActionTypeAndCarePlanTemplateId.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplateItemRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplateItemsRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplateListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplateRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/AdhocCarePlanTaskListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentInputRepresentation.d.ts +70 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentRepresentation.d.ts +79 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementForBenefitSessionInputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementsForBenefitSessionInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementsForBenefitSessionInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/BenefitListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitOutputRepresentation.d.ts +56 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBenefitSessionInfoListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBenefitSessionInfoRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBenefitSessionOutputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanDefinitionOutputRepresentation.d.ts +45 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanInputRepresentation.d.ts +68 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanRepresentation.d.ts +91 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanSessionEnrolleeInfoListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanSessionEnrolleeInfoRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTaskInputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTaskListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTaskListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTaskRepresentation.d.ts +59 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTasksInputRepresentation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTasksMapInputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTasksMapInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTasksMapRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTasksRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateAssociationsInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateAssociationsInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateBenefitInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateBenefitListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateBenefitListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateBenefitRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateGoalInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateGoalListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateGoalListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateGoalRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTemplateRepresentation.d.ts +57 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ExcludedCarePlanTaskInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/GenericOutputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentInputRepresentation.d.ts +73 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentRepresentation.d.ts +89 -0
- package/dist/es/es2018/types/src/generated/types/GoalDefinitionListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/GoalDefinitionOutputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
- package/package.json +77 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +4303 -0
- package/src/raml/api.raml +1363 -0
- package/src/raml/luvio.raml +123 -0
|
@@ -0,0 +1,1363 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '56.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v66.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
ActionPlanTemplateItemRepresentation:
|
|
29
|
+
description: Representation of Action Plan Tempate Item
|
|
30
|
+
type: object
|
|
31
|
+
properties:
|
|
32
|
+
displayOrder:
|
|
33
|
+
description: isRequired of the Action Plan template Item
|
|
34
|
+
type: integer
|
|
35
|
+
required: false
|
|
36
|
+
id:
|
|
37
|
+
description: ID of the Action Plan template Item
|
|
38
|
+
type: string
|
|
39
|
+
isRequired:
|
|
40
|
+
description: isRequired of the Action Plan template Item
|
|
41
|
+
type: boolean
|
|
42
|
+
required: false
|
|
43
|
+
itemEntityType:
|
|
44
|
+
description: itemEntityType of the Action Plan template Item
|
|
45
|
+
type: string
|
|
46
|
+
name:
|
|
47
|
+
description: Name of the Action Plan template Item
|
|
48
|
+
type: string
|
|
49
|
+
actionPlanTemplateVersion:
|
|
50
|
+
description: actionPlanTemplateVersion of the Action Plan template Item
|
|
51
|
+
type: string
|
|
52
|
+
required: false
|
|
53
|
+
ActionPlanTemplateItemsRepresentation:
|
|
54
|
+
description: Representation for list of Action Plan template Items
|
|
55
|
+
type: object
|
|
56
|
+
properties:
|
|
57
|
+
records:
|
|
58
|
+
description: List of action plan items
|
|
59
|
+
type: array
|
|
60
|
+
items:
|
|
61
|
+
type: ActionPlanTemplateItemRepresentation
|
|
62
|
+
ActionPlanTemplateListRepresentation:
|
|
63
|
+
description: Output Representation for List of Action Plan Templates
|
|
64
|
+
type: object
|
|
65
|
+
properties:
|
|
66
|
+
records:
|
|
67
|
+
description: list of Associated Action Plan Template records
|
|
68
|
+
type: array
|
|
69
|
+
items:
|
|
70
|
+
type: ActionPlanTemplateRepresentation
|
|
71
|
+
ActionPlanTemplateRepresentation:
|
|
72
|
+
description: Output Representation for Action Plan Template Record and it's items
|
|
73
|
+
type: object
|
|
74
|
+
properties:
|
|
75
|
+
actionPlanTemplateItems:
|
|
76
|
+
description: List of Action Plan Template Items
|
|
77
|
+
type: ActionPlanTemplateItemsRepresentation
|
|
78
|
+
required: false # TODO Hand-rolled W-9314597
|
|
79
|
+
id:
|
|
80
|
+
description: Id of Action Plan Template Record
|
|
81
|
+
type: string
|
|
82
|
+
status:
|
|
83
|
+
description: Status of Action Plan Template Record
|
|
84
|
+
type: string
|
|
85
|
+
AdhocCarePlanTaskListInputRepresentation:
|
|
86
|
+
description: Input representation for List of Adhoc Care Plan Tasks
|
|
87
|
+
type: object
|
|
88
|
+
properties:
|
|
89
|
+
records:
|
|
90
|
+
description: List of Adhoc Care Plan Tasks
|
|
91
|
+
type: array
|
|
92
|
+
items:
|
|
93
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
94
|
+
type: CarePlanTaskInputRepresentation
|
|
95
|
+
BenefitAssignmentInputRepresentation:
|
|
96
|
+
description: Input representation for BenefitAssignment
|
|
97
|
+
type: object
|
|
98
|
+
properties:
|
|
99
|
+
benefitAssignmentTasks:
|
|
100
|
+
description: Tasks for Benefit Assignment
|
|
101
|
+
type: CarePlanTaskInputRepresentation
|
|
102
|
+
required: false # TODO Hand-rolled W-9314597
|
|
103
|
+
benefitDisbursements:
|
|
104
|
+
description: Benefit disbursements of the Benefit Assignment
|
|
105
|
+
type: BenefitDisbursementListInputRepresentation
|
|
106
|
+
required: false # TODO Hand-rolled W-9314597
|
|
107
|
+
benefitFrequency:
|
|
108
|
+
description: BenefitFrequency of the BenefitAssignment
|
|
109
|
+
type: string
|
|
110
|
+
required: false # TODO Hand-rolled W-9314597
|
|
111
|
+
benefitId:
|
|
112
|
+
description: Benefit Id of the Benefit
|
|
113
|
+
type: string
|
|
114
|
+
customFields:
|
|
115
|
+
description: CustomFields of the BenefitAssignment
|
|
116
|
+
type: CustomFieldListInputRepresentation
|
|
117
|
+
required: false # TODO Hand-rolled W-9314597
|
|
118
|
+
endDate:
|
|
119
|
+
description: EndDate of the BenefitAssignment
|
|
120
|
+
type: string | nil
|
|
121
|
+
required: false # TODO Hand-rolled W-9314597
|
|
122
|
+
enrollmentCount:
|
|
123
|
+
description: EnrollmentCount of the BenefitAssignment
|
|
124
|
+
type: integer
|
|
125
|
+
required: false # TODO Hand-rolled W-9314597
|
|
126
|
+
entitlementAmount:
|
|
127
|
+
description: EntitlementAmount of the BenefitAssignment
|
|
128
|
+
format: double
|
|
129
|
+
type: number
|
|
130
|
+
required: false # TODO Hand-rolled W-9314597
|
|
131
|
+
id:
|
|
132
|
+
description: Id of the BenefitAssignment
|
|
133
|
+
type: string
|
|
134
|
+
required: false # TODO Hand-rolled W-9314597
|
|
135
|
+
maximumAmount:
|
|
136
|
+
description: MaximumAmount of the BenefitAssignment
|
|
137
|
+
format: double
|
|
138
|
+
type: number
|
|
139
|
+
required: false # TODO Hand-rolled W-9314597
|
|
140
|
+
participantId:
|
|
141
|
+
description: ParticipantId of the BenefitAssignment
|
|
142
|
+
type: string
|
|
143
|
+
payoutFrequency:
|
|
144
|
+
description: PayoutFrequency of the BenefitAssignment
|
|
145
|
+
type: string
|
|
146
|
+
required: false # TODO Hand-rolled W-9314597
|
|
147
|
+
priority:
|
|
148
|
+
description: Priority of the BenefitAssignment
|
|
149
|
+
type: string
|
|
150
|
+
required: false # TODO Hand-rolled W-9314597
|
|
151
|
+
startDate:
|
|
152
|
+
description: StartDate of BenefitAssignment
|
|
153
|
+
type: string | nil
|
|
154
|
+
required: false # TODO Hand-rolled W-9314597
|
|
155
|
+
status:
|
|
156
|
+
description: Status of the BenefitAssignment
|
|
157
|
+
type: string
|
|
158
|
+
required: false # TODO Hand-rolled W-9314597
|
|
159
|
+
BenefitAssignmentListInputRepresentation:
|
|
160
|
+
description: Input representation for List of BenefitAssignments
|
|
161
|
+
type: object
|
|
162
|
+
properties:
|
|
163
|
+
records:
|
|
164
|
+
description: List of BenefitAssignments
|
|
165
|
+
type: array
|
|
166
|
+
items:
|
|
167
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
168
|
+
type: BenefitAssignmentInputRepresentation
|
|
169
|
+
BenefitAssignmentListRepresentation:
|
|
170
|
+
description: List Representation of BenefitAssignment
|
|
171
|
+
type: object
|
|
172
|
+
properties:
|
|
173
|
+
records:
|
|
174
|
+
description: list of BenefitAssignment records
|
|
175
|
+
type: array
|
|
176
|
+
items:
|
|
177
|
+
type: BenefitAssignmentRepresentation
|
|
178
|
+
BenefitAssignmentRepresentation:
|
|
179
|
+
description: Output Representation of BenefitAssignment record
|
|
180
|
+
type: object
|
|
181
|
+
properties:
|
|
182
|
+
benefitAssignmentTasks:
|
|
183
|
+
description: Tasks for Benefit Assignment
|
|
184
|
+
type: CarePlanTasksRepresentation
|
|
185
|
+
required: false
|
|
186
|
+
benefitFrequency:
|
|
187
|
+
description: Frequency by which participant will get this benefit
|
|
188
|
+
type: string
|
|
189
|
+
required: false
|
|
190
|
+
benefitId:
|
|
191
|
+
description: Id of Benefit Record associated with this record
|
|
192
|
+
type: string
|
|
193
|
+
benefitName:
|
|
194
|
+
description: Name of Benefit Record associated with this record
|
|
195
|
+
type: string
|
|
196
|
+
customFields:
|
|
197
|
+
description: List of customFields associated with this BenefitAssignment record
|
|
198
|
+
type: CustomFieldListRepresentation
|
|
199
|
+
required: false
|
|
200
|
+
endDate:
|
|
201
|
+
description: End Date of BenefitAssignment record
|
|
202
|
+
type: string
|
|
203
|
+
required: false
|
|
204
|
+
enrollmentCount:
|
|
205
|
+
description: Enrollment count for this Benefit
|
|
206
|
+
type: integer
|
|
207
|
+
required: false
|
|
208
|
+
entitlementAmount:
|
|
209
|
+
description: Entitlement amount a participant will get from this benefit
|
|
210
|
+
format: double
|
|
211
|
+
type: number
|
|
212
|
+
required: false
|
|
213
|
+
id:
|
|
214
|
+
description: Id of BenefitAssignment record
|
|
215
|
+
type: string
|
|
216
|
+
maximumAmount:
|
|
217
|
+
description: Maximum amount a participant will get from this benefit
|
|
218
|
+
format: double
|
|
219
|
+
type: number
|
|
220
|
+
required: false
|
|
221
|
+
participantId:
|
|
222
|
+
description: Id of participant to whom this BenefitAssignment is assigned
|
|
223
|
+
type: string
|
|
224
|
+
participantName:
|
|
225
|
+
description: Name of participant to whom this BenefitAssignment is assigned
|
|
226
|
+
type: string
|
|
227
|
+
required: false
|
|
228
|
+
payoutFrequency:
|
|
229
|
+
description: Frequency by which participant will get this Payout
|
|
230
|
+
type: string
|
|
231
|
+
required: false
|
|
232
|
+
priority:
|
|
233
|
+
description: Priority of BenefitAssignment record
|
|
234
|
+
type: string
|
|
235
|
+
required: false
|
|
236
|
+
startDate:
|
|
237
|
+
description: Start Date of BenefitAssignment record
|
|
238
|
+
type: string
|
|
239
|
+
required: false
|
|
240
|
+
status:
|
|
241
|
+
description: Status of BenefitAssignment record
|
|
242
|
+
type: string
|
|
243
|
+
required: false
|
|
244
|
+
taskJobStatus:
|
|
245
|
+
description: TaskJobStatus of BenefitAssignment
|
|
246
|
+
type: string
|
|
247
|
+
required: false
|
|
248
|
+
taskJobStatusReason:
|
|
249
|
+
description: TaskJobStatusReason of BenefitAssignment
|
|
250
|
+
type: string
|
|
251
|
+
required: false
|
|
252
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
253
|
+
BenefitDisbursementsForBenefitSessionInputRepresentationWrapper:
|
|
254
|
+
description: Wrapper for BenefitDisbursementsForBenefitSessionInputRepresentation
|
|
255
|
+
type: object
|
|
256
|
+
properties:
|
|
257
|
+
benefitDisbursementRecord:
|
|
258
|
+
type: BenefitDisbursementsForBenefitSessionInputRepresentation
|
|
259
|
+
description: Benefit Disbursements For BenefitSession Input Representation
|
|
260
|
+
BenefitDisbursementForBenefitSessionInputRepresentation:
|
|
261
|
+
description: Input representation for Benefit Disbursement
|
|
262
|
+
type: object
|
|
263
|
+
properties:
|
|
264
|
+
actualCompletionDate:
|
|
265
|
+
description: date at which disbursement happened
|
|
266
|
+
type: string
|
|
267
|
+
benefitCategory:
|
|
268
|
+
description: Category of Benefit
|
|
269
|
+
type: string
|
|
270
|
+
required: false # TODO Hand-rolled W-9314597
|
|
271
|
+
benefitSessionId:
|
|
272
|
+
description: Benefit Session Id
|
|
273
|
+
type: string
|
|
274
|
+
description:
|
|
275
|
+
description: Description for Benefit Disbursement
|
|
276
|
+
type: string
|
|
277
|
+
required: false # TODO Hand-rolled W-9314597
|
|
278
|
+
disbursementStatus:
|
|
279
|
+
description: Benefit Disbursement Status
|
|
280
|
+
type: string
|
|
281
|
+
required: false # TODO Hand-rolled W-9314597
|
|
282
|
+
endDate:
|
|
283
|
+
description: date at which disbursement Ends
|
|
284
|
+
type: string
|
|
285
|
+
required: false # TODO Hand-rolled W-9314597
|
|
286
|
+
startDate:
|
|
287
|
+
description: date at which disbursement Starts
|
|
288
|
+
type: string
|
|
289
|
+
required: false # TODO Hand-rolled W-9314597
|
|
290
|
+
BenefitDisbursementListInputRepresentation:
|
|
291
|
+
description: Input representation for List of BenefitDisbursements
|
|
292
|
+
type: object
|
|
293
|
+
properties:
|
|
294
|
+
records:
|
|
295
|
+
description: List of Benefit Disbursements
|
|
296
|
+
type: array
|
|
297
|
+
items:
|
|
298
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
299
|
+
type: BenefitDisbursementForBenefitSessionInputRepresentation
|
|
300
|
+
BenefitDisbursementsForBenefitSessionInputRepresentation:
|
|
301
|
+
description: API to create Benefit Disbursements
|
|
302
|
+
type: object
|
|
303
|
+
properties:
|
|
304
|
+
benefitDisbursements:
|
|
305
|
+
description: Benefit Assignment Id
|
|
306
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
307
|
+
type: BenefitDisbursementListInputRepresentation
|
|
308
|
+
BenefitListRepresentation:
|
|
309
|
+
description: List of Records of Benefit
|
|
310
|
+
type: object
|
|
311
|
+
properties:
|
|
312
|
+
records:
|
|
313
|
+
description: List of Records of Benefit
|
|
314
|
+
type: array
|
|
315
|
+
items:
|
|
316
|
+
type: BenefitOutputRepresentation
|
|
317
|
+
BenefitOutputRepresentation:
|
|
318
|
+
description: Output Representation of Benefit
|
|
319
|
+
type: object
|
|
320
|
+
properties:
|
|
321
|
+
associatedActionPlanTemplates:
|
|
322
|
+
description: List of Associated Action Plan Template Records
|
|
323
|
+
type: ActionPlanTemplateListRepresentation
|
|
324
|
+
required: false
|
|
325
|
+
benefitFrequency:
|
|
326
|
+
description: Frequency of the Benefit
|
|
327
|
+
type: string
|
|
328
|
+
required: false
|
|
329
|
+
enrollmentCount:
|
|
330
|
+
description: EnrollmentCount of the Benefit
|
|
331
|
+
type: integer
|
|
332
|
+
required: false
|
|
333
|
+
id:
|
|
334
|
+
description: Id of the Benefit record
|
|
335
|
+
type: string
|
|
336
|
+
isActive:
|
|
337
|
+
description: Boolean value representing whether this benefit record is active
|
|
338
|
+
or not
|
|
339
|
+
type: boolean
|
|
340
|
+
maximumAmount:
|
|
341
|
+
description: Maximum allocated amount for the Benefit
|
|
342
|
+
format: double
|
|
343
|
+
type: number
|
|
344
|
+
required: false
|
|
345
|
+
name:
|
|
346
|
+
description: Name of the Benefit
|
|
347
|
+
type: string
|
|
348
|
+
payoutFrequency:
|
|
349
|
+
description: Frequency of the Payout
|
|
350
|
+
type: string
|
|
351
|
+
required: false
|
|
352
|
+
status:
|
|
353
|
+
description: Status of the Benefit
|
|
354
|
+
type: string
|
|
355
|
+
required: false
|
|
356
|
+
programId:
|
|
357
|
+
description: Associated Program attached to the benefit
|
|
358
|
+
type: string
|
|
359
|
+
required: false
|
|
360
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
361
|
+
CarePlanInputRepresentationWrapper:
|
|
362
|
+
description: Wrapper for CarePlanInputRepresentation
|
|
363
|
+
type: object
|
|
364
|
+
properties:
|
|
365
|
+
carePlanRecord:
|
|
366
|
+
type: CarePlanInputRepresentation
|
|
367
|
+
description: Care Plan Input Representation
|
|
368
|
+
CarePlanBenefitSessionInfoListRepresentation:
|
|
369
|
+
description: Benefit and Session Info List
|
|
370
|
+
type: object
|
|
371
|
+
properties:
|
|
372
|
+
records:
|
|
373
|
+
description: Benefit and Session Info List
|
|
374
|
+
type: array
|
|
375
|
+
required: false
|
|
376
|
+
items:
|
|
377
|
+
type: CarePlanBenefitSessionInfoRepresentation
|
|
378
|
+
CarePlanBenefitSessionInfoRepresentation:
|
|
379
|
+
description: Benefit and Session details
|
|
380
|
+
type: object
|
|
381
|
+
properties:
|
|
382
|
+
assignmentCount:
|
|
383
|
+
description: Enrollee count of the benefit
|
|
384
|
+
type: integer
|
|
385
|
+
required: false
|
|
386
|
+
benefitId:
|
|
387
|
+
description: Id of Benefit record
|
|
388
|
+
type: string
|
|
389
|
+
required: false
|
|
390
|
+
benefitName:
|
|
391
|
+
description: Name of the Benefit
|
|
392
|
+
type: string
|
|
393
|
+
required: false
|
|
394
|
+
sessionEnrolleeInfo:
|
|
395
|
+
description: Associated GoalDefinition Record
|
|
396
|
+
type: CarePlanSessionEnrolleeInfoListRepresentation
|
|
397
|
+
required: false
|
|
398
|
+
CarePlanBenefitSessionOutputRepresentation:
|
|
399
|
+
description: 'CarePlan Benefit and Session information representation '
|
|
400
|
+
type: object
|
|
401
|
+
properties:
|
|
402
|
+
benefitSessionInfo:
|
|
403
|
+
description: Benefit and Session Information list
|
|
404
|
+
type: CarePlanBenefitSessionInfoListRepresentation
|
|
405
|
+
required: false
|
|
406
|
+
carePlanId:
|
|
407
|
+
description: Id of CarePlan
|
|
408
|
+
type: string
|
|
409
|
+
required: false
|
|
410
|
+
CarePlanDefinitionOutputRepresentation:
|
|
411
|
+
description: "CarePlan Definition record and it's related representation items "
|
|
412
|
+
type: object
|
|
413
|
+
properties:
|
|
414
|
+
benefitDefinition:
|
|
415
|
+
description: respective benefit Definition Record
|
|
416
|
+
type: BenefitOutputRepresentation
|
|
417
|
+
required: false
|
|
418
|
+
goalDefinition:
|
|
419
|
+
description: respective goal definition Record
|
|
420
|
+
type: GoalDefinitionOutputRepresentation
|
|
421
|
+
required: false
|
|
422
|
+
id:
|
|
423
|
+
description: Id of CarePan Definition Record
|
|
424
|
+
type: string
|
|
425
|
+
CarePlanInputRepresentation:
|
|
426
|
+
description: Input representation for Care Plan
|
|
427
|
+
type: object
|
|
428
|
+
properties:
|
|
429
|
+
benefitAssignments:
|
|
430
|
+
description: BenefitAssignments of the CarePlan
|
|
431
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
432
|
+
type: BenefitAssignmentListInputRepresentation
|
|
433
|
+
required: false # TODO Hand-rolled W-9314597
|
|
434
|
+
carePlanTasks:
|
|
435
|
+
description: Tasks for a Care Plan
|
|
436
|
+
type: CarePlanTaskInputRepresentation
|
|
437
|
+
required: false # TODO Hand-rolled W-9314597
|
|
438
|
+
carePlanTemplateId:
|
|
439
|
+
description: CarePlanTemplateId of the CarePlan
|
|
440
|
+
type: string
|
|
441
|
+
required: false # TODO Hand-rolled W-9314597
|
|
442
|
+
caseId:
|
|
443
|
+
description: CaseId of the CarePlan
|
|
444
|
+
type: string
|
|
445
|
+
customFields:
|
|
446
|
+
description: CustomFields of the CarePlan
|
|
447
|
+
type: CustomFieldListInputRepresentation
|
|
448
|
+
required: false # TODO Hand-rolled W-9314597
|
|
449
|
+
description:
|
|
450
|
+
description: Description of the CarePlan
|
|
451
|
+
type: string
|
|
452
|
+
required: false # TODO Hand-rolled W-9314597
|
|
453
|
+
endDate:
|
|
454
|
+
description: EndDate of the CarePlan
|
|
455
|
+
type: string | nil
|
|
456
|
+
required: false # TODO Hand-rolled W-9314597
|
|
457
|
+
goalAssignments:
|
|
458
|
+
description: GoalAssignments of the CarePlan
|
|
459
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
460
|
+
type: GoalAssignmentListInputRepresentation
|
|
461
|
+
required: false # TODO Hand-rolled W-9314597
|
|
462
|
+
id:
|
|
463
|
+
description: Id of the CarePlan
|
|
464
|
+
type: string
|
|
465
|
+
required: false # TODO Hand-rolled W-9314597
|
|
466
|
+
medicationTherapyReview:
|
|
467
|
+
description: MedicationTherapyReview of the CarePlan
|
|
468
|
+
type: string
|
|
469
|
+
required: false # TODO Hand-rolled W-9314597
|
|
470
|
+
name:
|
|
471
|
+
description: Name of the CarePlan
|
|
472
|
+
type: string
|
|
473
|
+
participantId:
|
|
474
|
+
description: Participant of the CarePlan
|
|
475
|
+
type: string
|
|
476
|
+
startDate:
|
|
477
|
+
description: StartDate of the CarePlan
|
|
478
|
+
type: string | nil
|
|
479
|
+
required: false # TODO Hand-rolled W-9314597
|
|
480
|
+
status:
|
|
481
|
+
description: Status of the CarePlan
|
|
482
|
+
type: string
|
|
483
|
+
CarePlanRepresentation:
|
|
484
|
+
description: Output Representation of CarePlan and it's related records
|
|
485
|
+
type: object
|
|
486
|
+
properties:
|
|
487
|
+
benefitAssignments:
|
|
488
|
+
description: List of BenefitAssignment associated with this CarePlan record
|
|
489
|
+
type: BenefitAssignmentListRepresentation
|
|
490
|
+
required: false
|
|
491
|
+
carePlanTasks:
|
|
492
|
+
description: List of Tasks associated with CarePlan Record
|
|
493
|
+
type: CarePlanTasksRepresentation
|
|
494
|
+
required: false
|
|
495
|
+
carePlanTemplateId:
|
|
496
|
+
description: Care Plan Template Id for this CarePlan
|
|
497
|
+
type: string
|
|
498
|
+
required: false
|
|
499
|
+
carePlanTemplateName:
|
|
500
|
+
description: Name of Care Plan Template associated with this CarePlan
|
|
501
|
+
type: string
|
|
502
|
+
required: false
|
|
503
|
+
caseId:
|
|
504
|
+
description: Case Record Id for this CarePlan
|
|
505
|
+
type: string
|
|
506
|
+
customFields:
|
|
507
|
+
description: List of customFields associated with this CarePlan record
|
|
508
|
+
type: CustomFieldListRepresentation
|
|
509
|
+
required: false
|
|
510
|
+
description:
|
|
511
|
+
description: Description of CarePlan record
|
|
512
|
+
type: string
|
|
513
|
+
required: false
|
|
514
|
+
endDate:
|
|
515
|
+
description: End Date of CarePlan record
|
|
516
|
+
type: string
|
|
517
|
+
required: false
|
|
518
|
+
goalAssignments:
|
|
519
|
+
description: List of GoalAssignment associated with this CarePlan record
|
|
520
|
+
type: GoalAssignmentListRepresentation
|
|
521
|
+
required: false
|
|
522
|
+
id:
|
|
523
|
+
description: Id of CarePlan record
|
|
524
|
+
type: string
|
|
525
|
+
medicationTherapyReview:
|
|
526
|
+
description: MedicationTherapyReview of CarePlan record
|
|
527
|
+
type: string
|
|
528
|
+
required: false
|
|
529
|
+
name:
|
|
530
|
+
description: Name of CarePlan record
|
|
531
|
+
type: string
|
|
532
|
+
participantId:
|
|
533
|
+
description: ParticipantId of CarePlan record
|
|
534
|
+
type: string
|
|
535
|
+
participantName:
|
|
536
|
+
description: ParticipantName of CarePlan record
|
|
537
|
+
type: string
|
|
538
|
+
required: false
|
|
539
|
+
startDate:
|
|
540
|
+
description: Start Date of CarePlan record
|
|
541
|
+
type: string
|
|
542
|
+
required: false
|
|
543
|
+
status:
|
|
544
|
+
description: Status of CarePlan record
|
|
545
|
+
type: string
|
|
546
|
+
taskJobStatus:
|
|
547
|
+
description: TaskJobStatus of CarePlan record
|
|
548
|
+
type: string
|
|
549
|
+
required: false
|
|
550
|
+
taskJobStatusReason:
|
|
551
|
+
description: TaskJobStatusReason of CarePlan record
|
|
552
|
+
type: string
|
|
553
|
+
required: false
|
|
554
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
555
|
+
CarePlanTemplateAssociationsInputRepresentationWrapper:
|
|
556
|
+
description: Wrapper for CarePlanTemplateAssociationsInputRepresentation
|
|
557
|
+
type: object
|
|
558
|
+
properties:
|
|
559
|
+
carePlanTemplateRecord:
|
|
560
|
+
type: CarePlanTemplateAssociationsInputRepresentation
|
|
561
|
+
description: Care Plan Template Associations Input Representation
|
|
562
|
+
CarePlanSessionEnrolleeInfoListRepresentation:
|
|
563
|
+
description: List of Records of Enrollee Info of a Benefit assignment
|
|
564
|
+
type: object
|
|
565
|
+
properties:
|
|
566
|
+
records:
|
|
567
|
+
description: Session Enrollee info list
|
|
568
|
+
type: array
|
|
569
|
+
required: false
|
|
570
|
+
items:
|
|
571
|
+
type: CarePlanSessionEnrolleeInfoRepresentation
|
|
572
|
+
CarePlanSessionEnrolleeInfoRepresentation:
|
|
573
|
+
description: Benefit and session details of a an enrollee
|
|
574
|
+
type: object
|
|
575
|
+
properties:
|
|
576
|
+
benefitAssignmentId:
|
|
577
|
+
description: Id of Benefit Assignment
|
|
578
|
+
type: string
|
|
579
|
+
required: false
|
|
580
|
+
benefitEndDate:
|
|
581
|
+
description: End date of the Benefit Enrolled
|
|
582
|
+
type: string
|
|
583
|
+
required: false
|
|
584
|
+
benefitStartDate:
|
|
585
|
+
description: Start date of the Benefit Enrolled
|
|
586
|
+
type: string
|
|
587
|
+
required: false
|
|
588
|
+
enrolleeId:
|
|
589
|
+
description: Id of the Benefit Enrollee
|
|
590
|
+
type: string
|
|
591
|
+
enrolleeName:
|
|
592
|
+
description: Name of the Enrollee
|
|
593
|
+
type: string
|
|
594
|
+
sessionsEnrolled:
|
|
595
|
+
description: Sessions enrolled by an Enrollee
|
|
596
|
+
type: integer
|
|
597
|
+
required: false
|
|
598
|
+
CarePlanTaskInputRepresentation:
|
|
599
|
+
description: Input representation for Care Plan Task
|
|
600
|
+
type: object
|
|
601
|
+
properties:
|
|
602
|
+
assignedTo:
|
|
603
|
+
description: Care Plan Task assignee
|
|
604
|
+
type: string
|
|
605
|
+
required: false # TODO Hand-rolled W-9314597
|
|
606
|
+
comment:
|
|
607
|
+
description: Care Plan Task comment
|
|
608
|
+
type: string
|
|
609
|
+
required: false # TODO Hand-rolled W-9314597
|
|
610
|
+
dueDate:
|
|
611
|
+
description: Care Plan Task due date
|
|
612
|
+
type: string | nil
|
|
613
|
+
required: false # TODO Hand-rolled W-9314597
|
|
614
|
+
id:
|
|
615
|
+
description: Id of the Task
|
|
616
|
+
type: string
|
|
617
|
+
required: false # TODO Hand-rolled W-9314597
|
|
618
|
+
priority:
|
|
619
|
+
description: Care Plan Task priority
|
|
620
|
+
type: string
|
|
621
|
+
required: false # TODO Hand-rolled W-9314597
|
|
622
|
+
status:
|
|
623
|
+
description: Care Plan Task Status
|
|
624
|
+
type: string
|
|
625
|
+
required: false # TODO Hand-rolled W-9314597
|
|
626
|
+
subject:
|
|
627
|
+
description: Care Plan Task subject
|
|
628
|
+
type: string
|
|
629
|
+
required: false # TODO Hand-rolled W-9314597
|
|
630
|
+
isRequired:
|
|
631
|
+
description: isRequired field for Task record
|
|
632
|
+
type: boolean
|
|
633
|
+
required: false
|
|
634
|
+
CarePlanTaskListInputRepresentation:
|
|
635
|
+
description: Input representation for List of Care Plan Tasks
|
|
636
|
+
type: object
|
|
637
|
+
properties:
|
|
638
|
+
records:
|
|
639
|
+
description: List of Care Plan Tasks
|
|
640
|
+
type: array
|
|
641
|
+
items:
|
|
642
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
643
|
+
type: CarePlanTaskInputRepresentation
|
|
644
|
+
CarePlanTaskListRepresentation:
|
|
645
|
+
description: Output Representation for List of Care Plan Tasks
|
|
646
|
+
type: object
|
|
647
|
+
properties:
|
|
648
|
+
records:
|
|
649
|
+
description: List of Care Plan Tasks
|
|
650
|
+
type: array
|
|
651
|
+
required: false
|
|
652
|
+
items:
|
|
653
|
+
type: CarePlanTaskRepresentation
|
|
654
|
+
CarePlanTaskRepresentation:
|
|
655
|
+
description: Output Representation for Care Plan Task
|
|
656
|
+
type: object
|
|
657
|
+
properties:
|
|
658
|
+
assignedTo:
|
|
659
|
+
description: Care Plan Task Assignee
|
|
660
|
+
type: string
|
|
661
|
+
required: false
|
|
662
|
+
comment:
|
|
663
|
+
description: Care Plan Task comment
|
|
664
|
+
type: string
|
|
665
|
+
required: false
|
|
666
|
+
dueDate:
|
|
667
|
+
description: Care Plan Task due date
|
|
668
|
+
type: string
|
|
669
|
+
required: false
|
|
670
|
+
id:
|
|
671
|
+
description: Id of Task record
|
|
672
|
+
type: string
|
|
673
|
+
priority:
|
|
674
|
+
description: Care Plan Task priority
|
|
675
|
+
type: string
|
|
676
|
+
required: false
|
|
677
|
+
relatedTo:
|
|
678
|
+
description: Care Plan Task related to
|
|
679
|
+
type: string
|
|
680
|
+
required: false
|
|
681
|
+
status:
|
|
682
|
+
description: Care Plan Task status
|
|
683
|
+
type: string
|
|
684
|
+
required: false
|
|
685
|
+
subject:
|
|
686
|
+
description: Care Plan Task subject
|
|
687
|
+
type: string
|
|
688
|
+
required: false
|
|
689
|
+
dependentTasks:
|
|
690
|
+
description: Dependent tasks list
|
|
691
|
+
type: CarePlanTaskListRepresentation
|
|
692
|
+
required: false
|
|
693
|
+
displayOrder:
|
|
694
|
+
description: Dependent tasks display order
|
|
695
|
+
type: integer
|
|
696
|
+
required: false
|
|
697
|
+
isRequired:
|
|
698
|
+
description: isRequired field for Task record
|
|
699
|
+
type: boolean
|
|
700
|
+
required: false
|
|
701
|
+
CarePlanTasksInputRepresentation:
|
|
702
|
+
description: Input representation for Care Plan Tasks
|
|
703
|
+
type: object
|
|
704
|
+
properties:
|
|
705
|
+
adhocTasks:
|
|
706
|
+
description: Adhoc Tasks for a Care Plan
|
|
707
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
708
|
+
type: AdhocCarePlanTaskListInputRepresentation
|
|
709
|
+
excludedTasks:
|
|
710
|
+
description: Excluded Tasks for a Care Plan
|
|
711
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
712
|
+
type: ExcludedCarePlanTaskInputRepresentation
|
|
713
|
+
tasks:
|
|
714
|
+
description: Care Plan Tasks
|
|
715
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
716
|
+
type: CarePlanTaskListInputRepresentation
|
|
717
|
+
CarePlanTasksMapInputRepresentationWrapper:
|
|
718
|
+
description: Input representation for Care Plan Tasks Map
|
|
719
|
+
type: object
|
|
720
|
+
properties:
|
|
721
|
+
carePlanRecord:
|
|
722
|
+
description: Care Plan Tasks Map
|
|
723
|
+
type: CarePlanTasksMapInputRepresentation
|
|
724
|
+
CarePlanTasksMapInputRepresentation:
|
|
725
|
+
description: Input representation for Care Plan Tasks Map
|
|
726
|
+
type: object
|
|
727
|
+
properties:
|
|
728
|
+
parentEntityTasks:
|
|
729
|
+
description: Care Plan Tasks Map
|
|
730
|
+
type: object
|
|
731
|
+
properties:
|
|
732
|
+
//:
|
|
733
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
734
|
+
type: CarePlanTasksInputRepresentation
|
|
735
|
+
CarePlanTasksMapRepresentation:
|
|
736
|
+
description: Output Representation for Care Plan Tasks Map
|
|
737
|
+
type: object
|
|
738
|
+
properties:
|
|
739
|
+
parentEntityTasks:
|
|
740
|
+
description: Care Plan Tasks Map
|
|
741
|
+
type: object
|
|
742
|
+
properties:
|
|
743
|
+
//:
|
|
744
|
+
type: CarePlanTasksRepresentation
|
|
745
|
+
CarePlanTasksRepresentation:
|
|
746
|
+
description: Output Representation for Care Plan Tasks
|
|
747
|
+
type: object
|
|
748
|
+
properties:
|
|
749
|
+
tasks:
|
|
750
|
+
description: Care Plan Tasks
|
|
751
|
+
type: CarePlanTaskListRepresentation
|
|
752
|
+
CarePlanTemplateAssociationsInputRepresentation:
|
|
753
|
+
description: Input Representation for associating Care Plan Template benefit and
|
|
754
|
+
Care Plan Template Goal records to Care Plan Template
|
|
755
|
+
type: object
|
|
756
|
+
properties:
|
|
757
|
+
carePlanTemplateBenefits:
|
|
758
|
+
description: Object containing list of Benefits to be added to Care Plan template
|
|
759
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
760
|
+
type: CarePlanTemplateBenefitListInputRepresentation
|
|
761
|
+
required: false # TODO Hand-rolled W-9314597
|
|
762
|
+
carePlanTemplateGoals:
|
|
763
|
+
description: Object containing list of Goals to be added to Care Plan Template
|
|
764
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
765
|
+
type: CarePlanTemplateGoalListInputRepresentation
|
|
766
|
+
required: false # TODO Hand-rolled W-9314597
|
|
767
|
+
CarePlanTemplateBenefitInputRepresentation:
|
|
768
|
+
description: Input Representation for Care Plan Template Benefit Object
|
|
769
|
+
type: object
|
|
770
|
+
properties:
|
|
771
|
+
benefitId:
|
|
772
|
+
description: Benefit ID
|
|
773
|
+
type: string
|
|
774
|
+
priority:
|
|
775
|
+
description: Priority of the Benefit
|
|
776
|
+
type: string
|
|
777
|
+
required: false # TODO Hand-rolled W-9314597
|
|
778
|
+
CarePlanTemplateBenefitListInputRepresentation:
|
|
779
|
+
description: Input Representation for list of Care Plan Template benefit records
|
|
780
|
+
type: object
|
|
781
|
+
properties:
|
|
782
|
+
records:
|
|
783
|
+
description: List of Goals to be added to Care Plan Template
|
|
784
|
+
type: array
|
|
785
|
+
items:
|
|
786
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
787
|
+
type: CarePlanTemplateBenefitInputRepresentation
|
|
788
|
+
CarePlanTemplateBenefitListRepresentation:
|
|
789
|
+
description: List of Records of CarePlanTemplateBenefit
|
|
790
|
+
type: object
|
|
791
|
+
properties:
|
|
792
|
+
records:
|
|
793
|
+
description: List of Records of CarePlanTemplateBenefit
|
|
794
|
+
type: array
|
|
795
|
+
items:
|
|
796
|
+
type: CarePlanTemplateBenefitRepresentation
|
|
797
|
+
CarePlanTemplateBenefitRepresentation:
|
|
798
|
+
description: Record Representation of CarePlanTemplateBenefit
|
|
799
|
+
type: object
|
|
800
|
+
properties:
|
|
801
|
+
associatedBenefit:
|
|
802
|
+
description: Associated Benefit record CarePlanTemplateBenefit
|
|
803
|
+
type: BenefitOutputRepresentation
|
|
804
|
+
id:
|
|
805
|
+
description: Id of CarePlanTemplateBenefit Record
|
|
806
|
+
type: string
|
|
807
|
+
priority:
|
|
808
|
+
description: Priority of CarePlanTemplateBenefit Record
|
|
809
|
+
type: string
|
|
810
|
+
required: false
|
|
811
|
+
CarePlanTemplateGoalInputRepresentation:
|
|
812
|
+
description: Input Representation for Care Plan Template Goal Object
|
|
813
|
+
type: object
|
|
814
|
+
properties:
|
|
815
|
+
goalDefinitionId:
|
|
816
|
+
description: Goal Definition ID
|
|
817
|
+
type: string
|
|
818
|
+
priority:
|
|
819
|
+
description: Priority of the Goal
|
|
820
|
+
type: string
|
|
821
|
+
required: false # TODO Hand-rolled W-9314597
|
|
822
|
+
CarePlanTemplateGoalListInputRepresentation:
|
|
823
|
+
description: Input Representation for list of Care Plan Template benefit records
|
|
824
|
+
type: object
|
|
825
|
+
properties:
|
|
826
|
+
records:
|
|
827
|
+
description: List of Benefits to be added to Care Plan template
|
|
828
|
+
type: array
|
|
829
|
+
items:
|
|
830
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
831
|
+
type: CarePlanTemplateGoalInputRepresentation
|
|
832
|
+
CarePlanTemplateGoalListRepresentation:
|
|
833
|
+
description: List of Records of CarePlanTemplateGoal
|
|
834
|
+
type: object
|
|
835
|
+
properties:
|
|
836
|
+
records:
|
|
837
|
+
description: List of Records of CarePlanTemplateGoal
|
|
838
|
+
type: array
|
|
839
|
+
items:
|
|
840
|
+
type: CarePlanTemplateGoalRepresentation
|
|
841
|
+
CarePlanTemplateGoalRepresentation:
|
|
842
|
+
description: Record Representation of CarePlanTemplateGoal
|
|
843
|
+
type: object
|
|
844
|
+
properties:
|
|
845
|
+
associatedGoalDefinition:
|
|
846
|
+
description: Associated GoalDefinition Record
|
|
847
|
+
type: GoalDefinitionOutputRepresentation
|
|
848
|
+
id:
|
|
849
|
+
description: Id of CarePlanTemplateGoal Record
|
|
850
|
+
type: string
|
|
851
|
+
priority:
|
|
852
|
+
description: Priority of CarePlanTemplateGoal Record
|
|
853
|
+
type: string
|
|
854
|
+
required: false
|
|
855
|
+
CarePlanTemplateRepresentation:
|
|
856
|
+
description: CarePlanTemplate record and it's related CarePlanTemplateGoals and
|
|
857
|
+
CarePlanTemplateBenefits
|
|
858
|
+
type: object
|
|
859
|
+
properties:
|
|
860
|
+
associatedActionPlanTemplates:
|
|
861
|
+
description: List of Associated Action Plan Template Records
|
|
862
|
+
type: ActionPlanTemplateListRepresentation
|
|
863
|
+
required: false
|
|
864
|
+
carePlanTemplateBenefits:
|
|
865
|
+
description: List of Associated CarePlanTemplateBenefit Records
|
|
866
|
+
type: CarePlanTemplateBenefitListRepresentation
|
|
867
|
+
required: false
|
|
868
|
+
carePlanTemplateGoals:
|
|
869
|
+
description: List of Associated CarePlanTemplateGoal Records
|
|
870
|
+
type: CarePlanTemplateGoalListRepresentation
|
|
871
|
+
required: false
|
|
872
|
+
id:
|
|
873
|
+
description: Id of CarePanTemplate Record
|
|
874
|
+
type: string
|
|
875
|
+
name:
|
|
876
|
+
description: Name of CarePanTemplate Record
|
|
877
|
+
type: string
|
|
878
|
+
status:
|
|
879
|
+
description: Status of CarePanTemplate Record
|
|
880
|
+
type: string
|
|
881
|
+
CustomFieldInputRepresentation:
|
|
882
|
+
description: Input representation for Custom Field
|
|
883
|
+
type: object
|
|
884
|
+
properties:
|
|
885
|
+
dataType:
|
|
886
|
+
description: Data Type of custom field
|
|
887
|
+
type: string
|
|
888
|
+
required: false # TODO Hand-rolled W-9314597
|
|
889
|
+
enum:
|
|
890
|
+
- Boolean
|
|
891
|
+
- DateOnly
|
|
892
|
+
- DateTime
|
|
893
|
+
- MultiEnum
|
|
894
|
+
- Number
|
|
895
|
+
- String
|
|
896
|
+
- TimeOnly
|
|
897
|
+
fieldName:
|
|
898
|
+
description: Field Name of custom field
|
|
899
|
+
type: string
|
|
900
|
+
fieldValue:
|
|
901
|
+
description: Field Value of custom field
|
|
902
|
+
type: any
|
|
903
|
+
CustomFieldListInputRepresentation:
|
|
904
|
+
description: Input representation for List of CustomFields
|
|
905
|
+
type: object
|
|
906
|
+
properties:
|
|
907
|
+
records:
|
|
908
|
+
description: List of CustomFields
|
|
909
|
+
type: array
|
|
910
|
+
items:
|
|
911
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
912
|
+
type: CustomFieldInputRepresentation
|
|
913
|
+
CustomFieldListRepresentation:
|
|
914
|
+
description: Output Representation of custom field
|
|
915
|
+
type: object
|
|
916
|
+
properties:
|
|
917
|
+
records:
|
|
918
|
+
description: list of Custom Fields
|
|
919
|
+
type: array
|
|
920
|
+
items:
|
|
921
|
+
type: CustomFieldRepresentation
|
|
922
|
+
CustomFieldRepresentation:
|
|
923
|
+
description: Output Representation of CustomField
|
|
924
|
+
type: object
|
|
925
|
+
properties:
|
|
926
|
+
dataType:
|
|
927
|
+
description: DataType of Custom Field
|
|
928
|
+
type: string
|
|
929
|
+
required: false
|
|
930
|
+
fieldName:
|
|
931
|
+
description: Name of Custom Field
|
|
932
|
+
type: string
|
|
933
|
+
fieldValue:
|
|
934
|
+
description: Value of Custom Field
|
|
935
|
+
type: any
|
|
936
|
+
ExcludedCarePlanTaskInputRepresentation:
|
|
937
|
+
description: Input representation for Excluded Care Plan Tasks
|
|
938
|
+
type: object
|
|
939
|
+
properties:
|
|
940
|
+
tasks:
|
|
941
|
+
description: Excluded Sfdc Tasks for a Care Plan
|
|
942
|
+
type: array
|
|
943
|
+
items:
|
|
944
|
+
type: string
|
|
945
|
+
GenericOutputRepresentation:
|
|
946
|
+
description: Generic Output Representation
|
|
947
|
+
type: object
|
|
948
|
+
properties:
|
|
949
|
+
code:
|
|
950
|
+
description: API code
|
|
951
|
+
type: string
|
|
952
|
+
required: false
|
|
953
|
+
id:
|
|
954
|
+
description: id
|
|
955
|
+
type: string
|
|
956
|
+
isSuccess:
|
|
957
|
+
description: API success status
|
|
958
|
+
type: boolean
|
|
959
|
+
required: false
|
|
960
|
+
message:
|
|
961
|
+
description: API message
|
|
962
|
+
type: string
|
|
963
|
+
required: false
|
|
964
|
+
GoalAssignmentInputRepresentation:
|
|
965
|
+
description: Input representation for GoalAssignment
|
|
966
|
+
type: object
|
|
967
|
+
properties:
|
|
968
|
+
completionDate:
|
|
969
|
+
description: CompletionDate of the GoalAssignment
|
|
970
|
+
type: string | nil
|
|
971
|
+
required: false # TODO Hand-rolled W-9314597
|
|
972
|
+
completionPercentage:
|
|
973
|
+
description: CompletionPercentage of the GoalAssignment
|
|
974
|
+
format: double
|
|
975
|
+
type: number
|
|
976
|
+
required: false # TODO Hand-rolled W-9314597
|
|
977
|
+
customFields:
|
|
978
|
+
description: CustomFields of the GoalAssignment
|
|
979
|
+
type: CustomFieldListInputRepresentation
|
|
980
|
+
required: false # TODO Hand-rolled W-9314597
|
|
981
|
+
customGoalName:
|
|
982
|
+
description: The displayed name of the GoalAssignment
|
|
983
|
+
type: string
|
|
984
|
+
required: false # TODO Hand-rolled W-16973825
|
|
985
|
+
description:
|
|
986
|
+
description: Description of the Goal Assignment
|
|
987
|
+
type: string
|
|
988
|
+
required: false # TODO Hand-rolled W-9314597
|
|
989
|
+
goalAssigneeId:
|
|
990
|
+
description: GoalAssigneeId of the GoalAssignment
|
|
991
|
+
type: string
|
|
992
|
+
required: false # TODO Hand-rolled W-9314597
|
|
993
|
+
goalAssignmentTasks:
|
|
994
|
+
description: Tasks for Goal Assignment
|
|
995
|
+
type: CarePlanTaskInputRepresentation
|
|
996
|
+
required: false # TODO Hand-rolled W-9314597
|
|
997
|
+
goalDefinitionId:
|
|
998
|
+
description: GoalDefinitionId of the GoalAssignment
|
|
999
|
+
type: string
|
|
1000
|
+
id:
|
|
1001
|
+
description: Id of the GoalAssignment
|
|
1002
|
+
type: string
|
|
1003
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1004
|
+
priority:
|
|
1005
|
+
description: Priority of the GoalAssignment
|
|
1006
|
+
type: string
|
|
1007
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1008
|
+
startDate:
|
|
1009
|
+
description: StartDate of the GoalAssignment
|
|
1010
|
+
type: string | nil
|
|
1011
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1012
|
+
status:
|
|
1013
|
+
description: Status of the GoalAssignment
|
|
1014
|
+
type: string
|
|
1015
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1016
|
+
targetCompletionDate:
|
|
1017
|
+
description: TargetCompletionDate of the GoalAssignment
|
|
1018
|
+
type: string | nil
|
|
1019
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1020
|
+
associatedBenefitAssignments:
|
|
1021
|
+
description: Associated SubBenefit Assignments
|
|
1022
|
+
type: BenefitAssignmentListInputRepresentation
|
|
1023
|
+
required: false
|
|
1024
|
+
associatedSubGoalAssignments:
|
|
1025
|
+
description: Associated Sub Goal Assignments
|
|
1026
|
+
type: GoalAssignmentListInputRepresentation
|
|
1027
|
+
required: false
|
|
1028
|
+
GoalAssignmentListInputRepresentation:
|
|
1029
|
+
description: Input representation for List of GoalAssignment
|
|
1030
|
+
type: object
|
|
1031
|
+
properties:
|
|
1032
|
+
records:
|
|
1033
|
+
description: List of GoalAssignments
|
|
1034
|
+
type: array
|
|
1035
|
+
items:
|
|
1036
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1037
|
+
type: GoalAssignmentInputRepresentation
|
|
1038
|
+
GoalAssignmentListRepresentation:
|
|
1039
|
+
description: List Representation of GoalAssignment
|
|
1040
|
+
type: object
|
|
1041
|
+
properties:
|
|
1042
|
+
records:
|
|
1043
|
+
description: list of GoalAssignment records
|
|
1044
|
+
type: array
|
|
1045
|
+
items:
|
|
1046
|
+
type: GoalAssignmentRepresentation
|
|
1047
|
+
GoalAssignmentRepresentation:
|
|
1048
|
+
description: Output Representation of GoalAssignment
|
|
1049
|
+
type: object
|
|
1050
|
+
properties:
|
|
1051
|
+
completionDate:
|
|
1052
|
+
description: Completion Date of GoalAssignment record
|
|
1053
|
+
type: string
|
|
1054
|
+
required: false
|
|
1055
|
+
completionPercentage:
|
|
1056
|
+
description: Completion Percentage of GoalAssignment record
|
|
1057
|
+
format: double
|
|
1058
|
+
type: number
|
|
1059
|
+
required: false
|
|
1060
|
+
customFields:
|
|
1061
|
+
description: List of customFields associated with this GoalAssignment record
|
|
1062
|
+
type: CustomFieldListRepresentation
|
|
1063
|
+
required: false
|
|
1064
|
+
customGoalName:
|
|
1065
|
+
description: The displayed name of the GoalAssignment record
|
|
1066
|
+
type: string
|
|
1067
|
+
required: false
|
|
1068
|
+
description:
|
|
1069
|
+
description: description of a Goal Assignment
|
|
1070
|
+
type: string
|
|
1071
|
+
required: false
|
|
1072
|
+
goalAssigneeId:
|
|
1073
|
+
description: Id of Goal Assignee of this GoalAssignment record
|
|
1074
|
+
type: string
|
|
1075
|
+
required: false
|
|
1076
|
+
goalAssigneeName:
|
|
1077
|
+
description: Name of Goal Assignee of this GoalAssignment record
|
|
1078
|
+
type: string
|
|
1079
|
+
required: false
|
|
1080
|
+
goalAssignmentTasks:
|
|
1081
|
+
description: Task records for Goal Assignment
|
|
1082
|
+
type: CarePlanTasksRepresentation
|
|
1083
|
+
required: false # TODO Hand-rolled W-9314597
|
|
1084
|
+
goalDefinitionId:
|
|
1085
|
+
description: GoalDefinition Id for this GoalAssignment
|
|
1086
|
+
type: string
|
|
1087
|
+
goalDefinitionName:
|
|
1088
|
+
description: Name of Associated GoalDefinition with this record
|
|
1089
|
+
type: string
|
|
1090
|
+
goalType:
|
|
1091
|
+
description: Goal type of this record
|
|
1092
|
+
type: string
|
|
1093
|
+
required: false
|
|
1094
|
+
id:
|
|
1095
|
+
description: Id of GoalAssignment record
|
|
1096
|
+
type: string
|
|
1097
|
+
priority:
|
|
1098
|
+
description: Priority of GoalAssignment
|
|
1099
|
+
type: string
|
|
1100
|
+
required: false
|
|
1101
|
+
startDate:
|
|
1102
|
+
description: Start Date of GoalAssignment record
|
|
1103
|
+
type: string
|
|
1104
|
+
required: false
|
|
1105
|
+
status:
|
|
1106
|
+
description: Status of GoalAssignment record
|
|
1107
|
+
type: string
|
|
1108
|
+
required: false
|
|
1109
|
+
targetCompletionDate:
|
|
1110
|
+
description: Target Completion Date of GoalAssignment record
|
|
1111
|
+
type: string
|
|
1112
|
+
required: false
|
|
1113
|
+
taskJobStatus:
|
|
1114
|
+
description: TaskJobStatus of GoalAssignment
|
|
1115
|
+
type: string
|
|
1116
|
+
required: false
|
|
1117
|
+
taskJobStatusReason:
|
|
1118
|
+
description: TaskJobStatusReason of GoalAssignment
|
|
1119
|
+
type: string
|
|
1120
|
+
required: false
|
|
1121
|
+
associatedBenefitAssignments:
|
|
1122
|
+
description: Associated benefit assignments for Goal Assignment
|
|
1123
|
+
type: BenefitAssignmentListRepresentation
|
|
1124
|
+
required: false
|
|
1125
|
+
associatedSubGoalAssignments:
|
|
1126
|
+
description: Associated sub goals for Goal Assignment
|
|
1127
|
+
type: GoalAssignmentListRepresentation
|
|
1128
|
+
required: false
|
|
1129
|
+
GoalDefinitionListRepresentation:
|
|
1130
|
+
description: List of Records of GoalDefinition
|
|
1131
|
+
type: object
|
|
1132
|
+
properties:
|
|
1133
|
+
records:
|
|
1134
|
+
description: List of Records of GoalDefinition
|
|
1135
|
+
type: array
|
|
1136
|
+
items:
|
|
1137
|
+
type: GoalDefinitionOutputRepresentation
|
|
1138
|
+
GoalDefinitionOutputRepresentation:
|
|
1139
|
+
description: Output Representation of Goal Definition
|
|
1140
|
+
type: object
|
|
1141
|
+
properties:
|
|
1142
|
+
associatedActionPlanTemplates:
|
|
1143
|
+
description: List of Associated Action Plan Template Records
|
|
1144
|
+
type: ActionPlanTemplateListRepresentation
|
|
1145
|
+
required: false
|
|
1146
|
+
id:
|
|
1147
|
+
description: Record Id of goal Definition
|
|
1148
|
+
type: string
|
|
1149
|
+
isCustomGoalNameRequired:
|
|
1150
|
+
description: Indicates whether a custom goal name is required for a goal assignment related to the goal definition
|
|
1151
|
+
type: boolean
|
|
1152
|
+
required: false # TODO Hand-rolled W-16973825
|
|
1153
|
+
name:
|
|
1154
|
+
description: Name of Goal Definition
|
|
1155
|
+
type: string
|
|
1156
|
+
status:
|
|
1157
|
+
description: Status of Goal Definition
|
|
1158
|
+
type: string
|
|
1159
|
+
required: false
|
|
1160
|
+
type:
|
|
1161
|
+
description: Type of Goal Definition
|
|
1162
|
+
type: string
|
|
1163
|
+
required: false
|
|
1164
|
+
associatedBenefits:
|
|
1165
|
+
description: List of Associated Action Plan Template Records
|
|
1166
|
+
type: BenefitListRepresentation
|
|
1167
|
+
required: false
|
|
1168
|
+
associatedSubGoals:
|
|
1169
|
+
description: List of Associated Action Plan Template Records
|
|
1170
|
+
type: GoalDefinitionListRepresentation
|
|
1171
|
+
required: false
|
|
1172
|
+
usageType:
|
|
1173
|
+
description: Usage Type of Goal Definition
|
|
1174
|
+
type: string
|
|
1175
|
+
required: false
|
|
1176
|
+
/connect:
|
|
1177
|
+
/benefit-assignment/{benefitAssignmentId}/benefit-disbursements:
|
|
1178
|
+
post:
|
|
1179
|
+
description: API to create BenefitDisbursement
|
|
1180
|
+
responses:
|
|
1181
|
+
'200':
|
|
1182
|
+
description: Success
|
|
1183
|
+
body:
|
|
1184
|
+
application/json:
|
|
1185
|
+
type: GenericOutputRepresentation
|
|
1186
|
+
body:
|
|
1187
|
+
application/json:
|
|
1188
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1189
|
+
type: BenefitDisbursementsForBenefitSessionInputRepresentationWrapper
|
|
1190
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1191
|
+
#required: false
|
|
1192
|
+
(oas-body-name): benefitDisbursementRecord
|
|
1193
|
+
uriParameters:
|
|
1194
|
+
benefitAssignmentId:
|
|
1195
|
+
type: string
|
|
1196
|
+
required: true
|
|
1197
|
+
/careplan:
|
|
1198
|
+
/benefit-session/{carePlanId}:
|
|
1199
|
+
get:
|
|
1200
|
+
description: API to fetch data of CarePlanBenefitSessions
|
|
1201
|
+
responses:
|
|
1202
|
+
'200':
|
|
1203
|
+
description: Success
|
|
1204
|
+
body:
|
|
1205
|
+
application/json:
|
|
1206
|
+
type: CarePlanBenefitSessionOutputRepresentation
|
|
1207
|
+
uriParameters:
|
|
1208
|
+
carePlanId:
|
|
1209
|
+
type: string
|
|
1210
|
+
required: true
|
|
1211
|
+
/care-plans:
|
|
1212
|
+
post:
|
|
1213
|
+
description: API to create/update Care Plan
|
|
1214
|
+
responses:
|
|
1215
|
+
'200':
|
|
1216
|
+
description: Success
|
|
1217
|
+
body:
|
|
1218
|
+
application/json:
|
|
1219
|
+
type: GenericOutputRepresentation
|
|
1220
|
+
body:
|
|
1221
|
+
application/json:
|
|
1222
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1223
|
+
type: CarePlanInputRepresentationWrapper
|
|
1224
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1225
|
+
# required: false
|
|
1226
|
+
(oas-body-name): carePlanRecord
|
|
1227
|
+
/care-plans/{carePlanId}:
|
|
1228
|
+
get:
|
|
1229
|
+
description: API to fetch data of CarePlan and it's related record
|
|
1230
|
+
responses:
|
|
1231
|
+
'200':
|
|
1232
|
+
description: Success
|
|
1233
|
+
body:
|
|
1234
|
+
application/json:
|
|
1235
|
+
type: CarePlanRepresentation
|
|
1236
|
+
queryParameters:
|
|
1237
|
+
excludeCustomFields:
|
|
1238
|
+
type: boolean
|
|
1239
|
+
required: false
|
|
1240
|
+
default: false
|
|
1241
|
+
excludeTaskInfo:
|
|
1242
|
+
type: boolean
|
|
1243
|
+
required: false
|
|
1244
|
+
default: false
|
|
1245
|
+
patch:
|
|
1246
|
+
description: API to update data of CarePlan and it's related record
|
|
1247
|
+
responses:
|
|
1248
|
+
'200':
|
|
1249
|
+
description: Success
|
|
1250
|
+
body:
|
|
1251
|
+
application/json:
|
|
1252
|
+
type: GenericOutputRepresentation
|
|
1253
|
+
body:
|
|
1254
|
+
application/json:
|
|
1255
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1256
|
+
type: CarePlanInputRepresentationWrapper
|
|
1257
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1258
|
+
# required: false
|
|
1259
|
+
(oas-body-name): carePlanRecord
|
|
1260
|
+
uriParameters:
|
|
1261
|
+
carePlanId:
|
|
1262
|
+
type: string
|
|
1263
|
+
required: true
|
|
1264
|
+
/care-plans/{carePlanId}/tasks:
|
|
1265
|
+
get:
|
|
1266
|
+
description: API to fetch Tasks for a Care Plan
|
|
1267
|
+
responses:
|
|
1268
|
+
'200':
|
|
1269
|
+
description: Success
|
|
1270
|
+
body:
|
|
1271
|
+
application/json:
|
|
1272
|
+
type: CarePlanTasksMapRepresentation
|
|
1273
|
+
queryParameters:
|
|
1274
|
+
pageOffset:
|
|
1275
|
+
description: Offset for the current page default value is 0
|
|
1276
|
+
type: integer
|
|
1277
|
+
required: false
|
|
1278
|
+
default: 0
|
|
1279
|
+
patch:
|
|
1280
|
+
description: API to update task for a care plan
|
|
1281
|
+
responses:
|
|
1282
|
+
'200':
|
|
1283
|
+
description: Success
|
|
1284
|
+
body:
|
|
1285
|
+
application/json:
|
|
1286
|
+
type: GenericOutputRepresentation
|
|
1287
|
+
body:
|
|
1288
|
+
application/json:
|
|
1289
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1290
|
+
type: CarePlanTasksMapInputRepresentationWrapper
|
|
1291
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1292
|
+
# required: false
|
|
1293
|
+
(oas-body-name): carePlanRecord
|
|
1294
|
+
post:
|
|
1295
|
+
description: API to create task for a care plan
|
|
1296
|
+
responses:
|
|
1297
|
+
'200':
|
|
1298
|
+
description: Success
|
|
1299
|
+
body:
|
|
1300
|
+
application/json:
|
|
1301
|
+
type: GenericOutputRepresentation
|
|
1302
|
+
body:
|
|
1303
|
+
application/json:
|
|
1304
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1305
|
+
type: CarePlanTasksMapInputRepresentationWrapper
|
|
1306
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1307
|
+
# required: false
|
|
1308
|
+
(oas-body-name): carePlanRecord
|
|
1309
|
+
uriParameters:
|
|
1310
|
+
carePlanId:
|
|
1311
|
+
type: string
|
|
1312
|
+
required: true
|
|
1313
|
+
/careplan-templates/{carePlanTemplateId}:
|
|
1314
|
+
get:
|
|
1315
|
+
description: API to fetch data of CarePlanTemplateId and it's related record
|
|
1316
|
+
responses:
|
|
1317
|
+
'200':
|
|
1318
|
+
description: Success
|
|
1319
|
+
body:
|
|
1320
|
+
application/json:
|
|
1321
|
+
type: CarePlanTemplateRepresentation
|
|
1322
|
+
uriParameters:
|
|
1323
|
+
carePlanTemplateId:
|
|
1324
|
+
type: string
|
|
1325
|
+
required: true
|
|
1326
|
+
/careplan-templates/{carePlanTemplateId}/actions/{actionType}:
|
|
1327
|
+
post:
|
|
1328
|
+
description: Create Care Plan Template Benefit and Care Plan Template Goal records
|
|
1329
|
+
for specified Care Plan Template ID
|
|
1330
|
+
responses:
|
|
1331
|
+
'200':
|
|
1332
|
+
description: Success
|
|
1333
|
+
body:
|
|
1334
|
+
application/json:
|
|
1335
|
+
type: GenericOutputRepresentation
|
|
1336
|
+
body:
|
|
1337
|
+
application/json:
|
|
1338
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1339
|
+
type: CarePlanTemplateAssociationsInputRepresentationWrapper
|
|
1340
|
+
# TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
1341
|
+
# required: false
|
|
1342
|
+
(oas-body-name): carePlanTemplateRecord
|
|
1343
|
+
uriParameters:
|
|
1344
|
+
actionType:
|
|
1345
|
+
type: string
|
|
1346
|
+
required: true
|
|
1347
|
+
carePlanTemplateId:
|
|
1348
|
+
type: string
|
|
1349
|
+
required: true
|
|
1350
|
+
/definitions/{definitionId}:
|
|
1351
|
+
get:
|
|
1352
|
+
description: API to fetch definition data of careplan design time entites and
|
|
1353
|
+
it's related taskdefinitions
|
|
1354
|
+
responses:
|
|
1355
|
+
'200':
|
|
1356
|
+
description: Success
|
|
1357
|
+
body:
|
|
1358
|
+
application/json:
|
|
1359
|
+
type: CarePlanDefinitionOutputRepresentation
|
|
1360
|
+
uriParameters:
|
|
1361
|
+
definitionId:
|
|
1362
|
+
type: string
|
|
1363
|
+
required: true
|