Get Multi

Beta

GET

/patients/v1/get_multi

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_direction"asc" or "desc"Optional

Defaults to ascending.

Allowed values: ascdesc

Response

This endpoint returns an object.

itemslist of objects

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

1 curl -G https://pre-api.joincandidhealth.com/patients/v1/get_multi \
2      -H "Authorization: Bearer <token>" \
3      -d limit=0 \
4      -d mrn=string

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

Built with

1	curl -G https://pre-api.joincandidhealth.com/patients/v1/get_multi \
2	-H "Authorization: Bearer <token>" \
3	-d limit=0 \
4	-d mrn=string

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