Beta

Get Multi Paginated

GET

/coverages/v1//get-multi-paginated

GET

1 from candid import CandidApiClient
2 
3 client = CandidApiClient(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.pre_encounter.coverages.v_1.get_multi_paginated(
8     patient_id="string",
9     payer_plan_group_id="string",
10     page_token="string",
11     limit=1,
12 )

Play

200Retrieved

1 {
2   "items": [
3     {
4       "deactivated": true,
5       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6       "insurance_plan": {
7         "member_id": "string",
8         "payer_id": "string",
9         "payer_name": "string",
10         "additional_payer_information": {
11           "availity_eligibility_id": "string",
12           "availity_payer_id": "string",
13           "availity_payer_name": "string",
14           "availity_remittance_payer_id": "string"
15         },
16         "group_number": "string",
17         "name": "string",
18         "plan_type": "09",
19         "type": "01",
20         "period": {
21           "start": "2023-01-01",
22           "end": "2023-01-01"
23         },
24         "insurance_card_image_locator": "string",
25         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26       },
27       "organization_id": "string",
28       "patient": "string",
29       "relationship": "SELF",
30       "status": "ACTIVE",
31       "subscriber": {
32         "name": {
33           "family": "string",
34           "given": [
35             "string"
36           ],
37           "use": "USUAL",
38           "period": {
39             "start": "2023-01-01",
40             "end": "2023-01-01"
41           }
42         },
43         "date_of_birth": "2023-01-01",
44         "biological_sex": "FEMALE",
45         "address": {
46           "use": "HOME",
47           "line": [
48             "string"
49           ],
50           "city": "string",
51           "state": "string",
52           "postal_code": "string",
53           "country": "string",
54           "period": {
55             "start": "2023-01-01",
56             "end": "2023-01-01"
57           }
58         }
59       },
60       "updated_at": "2023-01-01T00:00:00Z",
61       "updating_user_id": "string",
62       "verified": true,
63       "version": 0,
64       "benefits": {
65         "plan_coverage": {
66           "in_network": {
67             "deductible": {
68               "family": 1,
69               "individual": 1,
70               "employeeAndSpouse": 1,
71               "employeeAndChildren": 1
72             },
73             "deductible_contract": {
74               "family": 1,
75               "individual": 1,
76               "employeeAndSpouse": 1,
77               "employeeAndChildren": 1
78             },
79             "deductible_remaining": {
80               "family": 1,
81               "individual": 1,
82               "employeeAndSpouse": 1,
83               "employeeAndChildren": 1
84             },
85             "deductible_year_to_date": {
86               "family": 1,
87               "individual": 1,
88               "employeeAndSpouse": 1,
89               "employeeAndChildren": 1
90             },
91             "oop_max": {
92               "family": 1,
93               "individual": 1,
94               "employeeAndSpouse": 1,
95               "employeeAndChildren": 1
96             },
97             "oop_max_contract": {
98               "family": 1,
99               "individual": 1,
100               "employeeAndSpouse": 1,
101               "employeeAndChildren": 1
102             },
103             "oop_max_remaining": {
104               "family": 1,
105               "individual": 1,
106               "employeeAndSpouse": 1,
107               "employeeAndChildren": 1
108             },
109             "oop_max_year_to_date": {
110               "family": 1,
111               "individual": 1,
112               "employeeAndSpouse": 1,
113               "employeeAndChildren": 1
114             },
115             "additional_notes": "string"
116           },
117           "in_network_flat": [
118             {
119               "type": "DEDUCTIBLE",
120               "coverageLevel": "EMPLOYEE_AND_CHILDREN",
121               "unit": "PERCENT",
122               "value": 1,
123               "additional_notes": "string"
124             }
125           ],
126           "out_of_network": {
127             "deductible": {
128               "family": 1,
129               "individual": 1,
130               "employeeAndSpouse": 1,
131               "employeeAndChildren": 1
132             },
133             "deductible_contract": {
134               "family": 1,
135               "individual": 1,
136               "employeeAndSpouse": 1,
137               "employeeAndChildren": 1
138             },
139             "deductible_remaining": {
140               "family": 1,
141               "individual": 1,
142               "employeeAndSpouse": 1,
143               "employeeAndChildren": 1
144             },
145             "deductible_year_to_date": {
146               "family": 1,
147               "individual": 1,
148               "employeeAndSpouse": 1,
149               "employeeAndChildren": 1
150             },
151             "oop_max": {
152               "family": 1,
153               "individual": 1,
154               "employeeAndSpouse": 1,
155               "employeeAndChildren": 1
156             },
157             "oop_max_contract": {
158               "family": 1,
159               "individual": 1,
160               "employeeAndSpouse": 1,
161               "employeeAndChildren": 1
162             },
163             "oop_max_remaining": {
164               "family": 1,
165               "individual": 1,
166               "employeeAndSpouse": 1,
167               "employeeAndChildren": 1
168             },
169             "oop_max_year_to_date": {
170               "family": 1,
171               "individual": 1,
172               "employeeAndSpouse": 1,
173               "employeeAndChildren": 1
174             },
175             "additional_notes": "string"
176           },
177           "out_of_network_flat": [
178             {
179               "type": "DEDUCTIBLE",
180               "coverageLevel": "EMPLOYEE_AND_CHILDREN",
181               "unit": "PERCENT",
182               "value": 1,
183               "additional_notes": "string"
184             }
185           ]
186         },
187         "service_specific_coverage": [
188           {
189             "service_code": "1",
190             "in_network": {
191               "copay": {
192                 "family": 1,
193                 "individual": 1,
194                 "employeeAndSpouse": 1,
195                 "employeeAndChildren": 1
196               },
197               "coinsurance": {
198                 "family": 1,
199                 "individual": 1,
200                 "employeeAndSpouse": 1,
201                 "employeeAndChildren": 1
202               },
203               "visits": {
204                 "family": 1,
205                 "individual": 1,
206                 "employeeAndSpouse": 1,
207                 "employeeAndChildren": 1
208               },
209               "visits_remaining": {
210                 "family": 1,
211                 "individual": 1,
212                 "employeeAndSpouse": 1,
213                 "employeeAndChildren": 1
214               },
215               "additional_notes": "string"
216             },
217             "in_network_flat": [
218               {
219                 "type": "DEDUCTIBLE",
220                 "coverageLevel": "EMPLOYEE_AND_CHILDREN",
221                 "unit": "PERCENT",
222                 "value": 1,
223                 "additional_notes": "string"
224               }
225             ],
226             "out_of_network": {
227               "copay": {
228                 "family": 1,
229                 "individual": 1,
230                 "employeeAndSpouse": 1,
231                 "employeeAndChildren": 1
232               },
233               "coinsurance": {
234                 "family": 1,
235                 "individual": 1,
236                 "employeeAndSpouse": 1,
237                 "employeeAndChildren": 1
238               },
239               "visits": {
240                 "family": 1,
241                 "individual": 1,
242                 "employeeAndSpouse": 1,
243                 "employeeAndChildren": 1
244               },
245               "visits_remaining": {
246                 "family": 1,
247                 "individual": 1,
248                 "employeeAndSpouse": 1,
249                 "employeeAndChildren": 1
250               },
251               "additional_notes": "string"
252             },
253             "out_of_network_flat": [
254               {
255                 "type": "DEDUCTIBLE",
256                 "coverageLevel": "EMPLOYEE_AND_CHILDREN",
257                 "unit": "PERCENT",
258                 "value": 1,
259                 "additional_notes": "string"
260               }
261             ]
262           }
263         ],
264         "benefits_related_entities": [
265           {
266             "entityIdentifier": "string",
267             "entityType": "string",
268             "entityName": "string",
269             "contactInformation": [
270               {
271                 "mode": "string",
272                 "value": "string"
273               }
274             ],
275             "serviceTypeCodes": [
276               "1"
277             ]
278           }
279         ],
280         "notes": "string"
281       },
282       "eligibility_checks": [
283         {
284           "check_id": "string",
285           "service_code": "1",
286           "status": "COMPLETED",
287           "initiated_by": "string",
288           "initiated_at": "2023-01-01T00:00:00Z"
289         }
290       ],
291       "latest_eligibility_check": {
292         "check_id": "string",
293         "status": "ACTIVE",
294         "initiated_at": "2023-01-01T00:00:00Z"
295       }
296     }
297   ],
298   "total": 0,
299   "next_page_token": "string",
300   "prev_page_token": "string"
301 }

Returns a page of Coverages based on the search criteria.

Query parameters

patient_idstringOptional

payer_plan_group_idstringOptional

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

limitintegerOptional

Must be between 0 and 1000. Defaults to 100

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

Get Multi Paginated

Headers

Query parameters

Response

Errors