JOjoincandidhealth
v1

Search Providers

Changed on

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.

get/patients/v1/search_providers

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/patients/v1/search_providers
  • Auth
    HTTP bearer

Query parameters

search_criteriastring required

Response

Response with status 200

type'PRIMARY' | 'REFERRING' | 'ATTENDING'
npistring
canonical_idstring

The unique identifier for a provider configured in the Candid system

faxstring
other_fax_numbersstring[]
emailsstring[]

Changes

  • 72fc5ca65ba5Revision changes
    • info

      added the optional property /// to the response with the status

  • 24b2d80d577aRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status