Search Providers

Beta

GET

/patients/v1/search_providers

GET

/patients/v1/search_providers

1 curl -G https://pre-api.joincandidhealth.com/patients/v1/search_providers \
2      -H "Authorization: Bearer <token>" \
3      -d search_criteria=search_criteria

Try it

200Retrieved

1 [
2   {
3     "name": {
4       "family": "family",
5       "given": [
6         "given",
7         "given"
8       ],
9       "use": "USUAL",
10       "period": {
11         "start": "2023-01-15",
12         "end": "2023-01-15"
13       },
14       "suffix": "suffix"
15     },
16     "telecoms": [
17       {
18         "value": "value",
19         "use": "HOME",
20         "period": {
21           "start": "2023-01-15",
22           "end": "2023-01-15"
23         }
24       },
25       {
26         "value": "value",
27         "use": "HOME",
28         "period": {
29           "start": "2023-01-15",
30           "end": "2023-01-15"
31         }
32       }
33     ],
34     "type": "PRIMARY",
35     "npi": "npi",
36     "addresses": [
37       {
38         "use": "HOME",
39         "line": [
40           "line",
41           "line"
42         ],
43         "city": "city",
44         "state": "state",
45         "postal_code": "postal_code",
46         "country": "country",
47         "period": {
48           "start": "2023-01-15",
49           "end": "2023-01-15"
50         }
51       },
52       {
53         "use": "HOME",
54         "line": [
55           "line",
56           "line"
57         ],
58         "city": "city",
59         "state": "state",
60         "postal_code": "postal_code",
61         "country": "country",
62         "period": {
63           "start": "2023-01-15",
64           "end": "2023-01-15"
65         }
66       }
67     ],
68     "period": {
69       "start": "2023-01-15",
70       "end": "2023-01-15"
71     },
72     "canonical_id": "canonical_id",
73     "fax": "fax"
74   },
75   {
76     "name": {
77       "family": "family",
78       "given": [
79         "given",
80         "given"
81       ],
82       "use": "USUAL",
83       "period": {
84         "start": "2023-01-15",
85         "end": "2023-01-15"
86       },
87       "suffix": "suffix"
88     },
89     "telecoms": [
90       {
91         "value": "value",
92         "use": "HOME",
93         "period": {
94           "start": "2023-01-15",
95           "end": "2023-01-15"
96         }
97       },
98       {
99         "value": "value",
100         "use": "HOME",
101         "period": {
102           "start": "2023-01-15",
103           "end": "2023-01-15"
104         }
105       }
106     ],
107     "type": "PRIMARY",
108     "npi": "npi",
109     "addresses": [
110       {
111         "use": "HOME",
112         "line": [
113           "line",
114           "line"
115         ],
116         "city": "city",
117         "state": "state",
118         "postal_code": "postal_code",
119         "country": "country",
120         "period": {
121           "start": "2023-01-15",
122           "end": "2023-01-15"
123         }
124       },
125       {
126         "use": "HOME",
127         "line": [
128           "line",
129           "line"
130         ],
131         "city": "city",
132         "state": "state",
133         "postal_code": "postal_code",
134         "country": "country",
135         "period": {
136           "start": "2023-01-15",
137           "end": "2023-01-15"
138         }
139       }
140     ],
141     "period": {
142       "start": "2023-01-15",
143       "end": "2023-01-15"
144     },
145     "canonical_id": "canonical_id",
146     "fax": "fax"
147   }
148 ]

Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results.

Query parameters

search_criteriastringRequired

Response

This endpoint returns a list of objects.

nameobject

telecomslist of objects

typeenum or null

Defaults to ATTENDING.

Allowed values:

npistring or null

addresseslist of objects or null

periodobject or null

canonical_idstring or null

The unique identifier for a provider configured in the Candid system

faxstring or null

Headers

Query parameters

Response