Search Providers | Candid

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.patients.v_1.search_providers( 8 search_criteria="string", 9 )

1 [ 2 { 3 "name": { 4 "family": "string", 5 "given": [ 6 "string" 7 ], 8 "use": "USUAL", 9 "period": { 10 "start": "2023-01-01", 11 "end": "2023-01-01" 12 }, 13 "suffix": "string" 14 }, 15 "telecoms": [ 16 { 17 "value": "string", 18 "use": "HOME", 19 "period": { 20 "start": "2023-01-01", 21 "end": "2023-01-01" 22 } 23 } 24 ], 25 "type": "PRIMARY", 26 "npi": "string", 27 "addresses": [ 28 { 29 "use": "HOME", 30 "line": [ 31 "string" 32 ], 33 "city": "string", 34 "state": "string", 35 "postal_code": "string", 36 "country": "string", 37 "period": { 38 "start": "2023-01-01", 39 "end": "2023-01-01" 40 } 41 } 42 ], 43 "period": { 44 "start": "2023-01-01", 45 "end": "2023-01-01" 46 }, 47 "canonical_id": "string", 48 "fax": "string" 49 } 50 ]

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

typeenumOptional

Defaults to ATTENDING.

Allowed values:

npistringOptional

addresseslist of objectsOptional

periodobjectOptional

canonical_idstringOptional

The unique identifier for a provider configured in the Candid system

faxstringOptional

Headers

Query parameters

Response