Get Multi

Beta

GET

/patients/v1/get_multi

GET

/patients/v1/get_multi

1 from candid import CandidApiClient
2 from candid.resources.pre_encounter.resources.common import SortDirection
3 
4 client = CandidApiClient(
5     client_id="YOUR_CLIENT_ID",
6     client_secret="YOUR_CLIENT_SECRET",
7 )
8 client.pre_encounter.patients.v_1.get_multi(
9     limit=1,
10     mrn="string",
11     page_token="string",
12     sort_field="string",
13     sort_direction=SortDirection.ASC,
14 )

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "biological_sex": "FEMALE",
5       "birth_date": "2023-01-01",
6       "contacts": [
7         {
8           "relationship": [
9             "SELF"
10           ],
11           "name": {
12             "family": "string",
13             "given": [
14               "string"
15             ],
16             "use": "USUAL",
17             "period": {
18               "start": "2023-01-01",
19               "end": "2023-01-01"
20             },
21             "suffix": "string"
22           },
23           "telecoms": [
24             {
25               "value": "string",
26               "use": "HOME",
27               "period": {
28                 "start": "2023-01-01",
29                 "end": "2023-01-01"
30               }
31             }
32           ],
33           "addresses": [
34             {
35               "use": "HOME",
36               "line": [
37                 "string"
38               ],
39               "city": "string",
40               "state": "string",
41               "postal_code": "string",
42               "country": "string",
43               "period": {
44                 "start": "2023-01-01",
45                 "end": "2023-01-01"
46               }
47             }
48           ],
49           "period": {
50             "start": "2023-01-01",
51             "end": "2023-01-01"
52           },
53           "hipaa_authorization": true
54         }
55       ],
56       "deactivated": true,
57       "filing_order": {
58         "coverages": [
59           "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
60         ]
61       },
62       "general_practitioners": [
63         {
64           "name": {
65             "family": "string",
66             "given": [
67               "string"
68             ],
69             "use": "USUAL",
70             "period": {
71               "start": "2023-01-01",
72               "end": "2023-01-01"
73             },
74             "suffix": "string"
75           },
76           "telecoms": [
77             {
78               "value": "string",
79               "use": "HOME",
80               "period": {
81                 "start": "2023-01-01",
82                 "end": "2023-01-01"
83               }
84             }
85           ],
86           "type": "PRIMARY",
87           "npi": "string",
88           "addresses": [
89             {
90               "use": "HOME",
91               "line": [
92                 "string"
93               ],
94               "city": "string",
95               "state": "string",
96               "postal_code": "string",
97               "country": "string",
98               "period": {
99                 "start": "2023-01-01",
100                 "end": "2023-01-01"
101               }
102             }
103           ],
104           "period": {
105             "start": "2023-01-01",
106             "end": "2023-01-01"
107           },
108           "canonical_id": "string",
109           "fax": "string"
110         }
111       ],
112       "id": "string",
113       "mrn": "string",
114       "name": {
115         "family": "string",
116         "given": [
117           "string"
118         ],
119         "use": "USUAL",
120         "period": {
121           "start": "2023-01-01",
122           "end": "2023-01-01"
123         },
124         "suffix": "string"
125       },
126       "organization_id": "string",
127       "other_addresses": [
128         {
129           "use": "HOME",
130           "line": [
131             "string"
132           ],
133           "city": "string",
134           "state": "string",
135           "postal_code": "string",
136           "country": "string",
137           "period": {
138             "start": "2023-01-01",
139             "end": "2023-01-01"
140           }
141         }
142       ],
143       "other_names": [
144         {
145           "family": "string",
146           "given": [
147             "string"
148           ],
149           "use": "USUAL",
150           "period": {
151             "start": "2023-01-01",
152             "end": "2023-01-01"
153           },
154           "suffix": "string"
155         }
156       ],
157       "other_telecoms": [
158         {
159           "value": "string",
160           "use": "HOME",
161           "period": {
162             "start": "2023-01-01",
163             "end": "2023-01-01"
164           }
165         }
166       ],
167       "primary_address": {
168         "use": "HOME",
169         "line": [
170           "string"
171         ],
172         "city": "string",
173         "state": "string",
174         "postal_code": "string",
175         "country": "string",
176         "period": {
177           "start": "2023-01-01",
178           "end": "2023-01-01"
179         }
180       },
181       "primary_telecom": {
182         "value": "string",
183         "use": "HOME",
184         "period": {
185           "start": "2023-01-01",
186           "end": "2023-01-01"
187         }
188       },
189       "updated_at": "2023-01-01T00:00:00Z",
190       "updating_user_id": "string",
191       "version": 0,
192       "authorizations": [
193         {
194           "payer_id": "string",
195           "payer_name": "string",
196           "authorization_number": "string",
197           "cpt_code": "string",
198           "units": "VISIT",
199           "additional_payer_information": {
200             "availity_eligibility_id": "string",
201             "availity_payer_id": "string",
202             "availity_payer_name": "string",
203             "availity_remittance_payer_id": "string"
204           },
205           "apply_for_all_cpt_codes": true,
206           "quantity": 0,
207           "period": {
208             "start": "2023-01-01",
209             "end": "2023-01-01"
210           },
211           "notes": "string"
212         }
213       ],
214       "deceased": "2023-01-01T00:00:00Z",
215       "disability_status": "DISABLED",
216       "do_not_invoice_reason": "BANKRUPTCY",
217       "electronic_communication_opt_in": true,
218       "email": "string",
219       "ethnicity": "HISPANIC_OR_LATINO",
220       "external_provenance": {
221         "external_id": "string",
222         "system_name": "string"
223       },
224       "gender": "MAN",
225       "guarantor": {
226         "name": {
227           "family": "string",
228           "given": [
229             "string"
230           ],
231           "use": "USUAL",
232           "period": {
233             "start": "2023-01-01",
234             "end": "2023-01-01"
235           },
236           "suffix": "string"
237         },
238         "birth_date": "2023-01-01",
239         "address": {
240           "use": "HOME",
241           "line": [
242             "string"
243           ],
244           "city": "string",
245           "state": "string",
246           "postal_code": "string",
247           "country": "string",
248           "period": {
249             "start": "2023-01-01",
250             "end": "2023-01-01"
251           }
252         },
253         "telecom": {
254           "value": "string",
255           "use": "HOME",
256           "period": {
257             "start": "2023-01-01",
258             "end": "2023-01-01"
259           }
260         },
261         "email": "string"
262       },
263       "language": "string",
264       "marital_status": "ANNULLED",
265       "multiple_birth": 0,
266       "non_insurance_payer_associations": [
267         {
268           "id": "string",
269           "member_id": "string",
270           "period": {
271             "start": "2023-01-01",
272             "end": "2023-01-01"
273           },
274           "clinical_trial_info": [
275             {
276               "id": "string",
277               "clinical_trial_arm": "string",
278               "period": {
279                 "start": "2023-01-01",
280                 "end": "2023-01-01"
281               }
282             }
283           ]
284         }
285       ],
286       "note_ids": [
287         "string"
288       ],
289       "other_identifiers": [
290         {
291           "value": "string",
292           "system": "string",
293           "period": {
294             "start": "2023-01-01",
295             "end": "2023-01-01"
296           }
297         }
298       ],
299       "photo": "string",
300       "primary_service_facility_id": "string",
301       "pronouns": [
302         "string"
303       ],
304       "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
305       "referrals": [
306         {
307           "provider": {
308             "name": {
309               "family": "string",
310               "given": [
311                 "string"
312               ],
313               "use": "USUAL",
314               "period": {
315                 "start": "2023-01-01",
316                 "end": "2023-01-01"
317               },
318               "suffix": "string"
319             },
320             "telecoms": [
321               {
322                 "value": "string",
323                 "use": "HOME",
324                 "period": {
325                   "start": "2023-01-01",
326                   "end": "2023-01-01"
327                 }
328               }
329             ],
330             "type": "PRIMARY",
331             "npi": "string",
332             "addresses": [
333               {
334                 "use": "HOME",
335                 "line": [
336                   "string"
337                 ],
338                 "city": "string",
339                 "state": "string",
340                 "postal_code": "string",
341                 "country": "string",
342                 "period": {
343                   "start": "2023-01-01",
344                   "end": "2023-01-01"
345                 }
346               }
347             ],
348             "period": {
349               "start": "2023-01-01",
350               "end": "2023-01-01"
351             },
352             "canonical_id": "string",
353             "fax": "string"
354           },
355           "referral_number": "string",
356           "period": {
357             "start": "2023-01-01",
358             "end": "2023-01-01"
359           },
360           "notes": "string"
361         }
362       ],
363       "self_pay": true,
364       "sexual_orientation": "HETEROSEXUAL",
365       "social_security_number": "string",
366       "tag_ids": [
367         "string"
368       ],
369       "non_insurance_payers": [
370         "string"
371       ]
372     }
373   ],
374   "total": 0,
375   "next_page_token": "string",
376   "prev_page_token": "string"
377 }

Searches for patients that match the query parameters.

Query parameters

limitintegerOptional

mrnstringOptional

page_tokenstringOptional

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

sort_fieldstringOptional

The field to order by. Valid values are either keys on the patient object or a special ordering “similar_name:<search_string>” (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient names to the search criteria.

sort_directionenumOptional

Defaults to ascending.

Allowed values:

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

Headers

Query parameters

Response