Clinical Provider

The Clinical Provider feature allows the user to view clinical provider details.

We now support the ability to search for Clinical Providers using a zip code and a distance, allowing partners to find a list of Clinical Providers within a specific geographic area. These parameters can only be used in conjunction with the existing search requirements, not as a replacement. See the existing Clinical Provider Search documentation under Administrative Functions for additional details on the required input criteria.

When calling the GET /clinicalproviders/search endpoint, partners can now specify a Zip and a Distance parameter. Both Zip and Distance are required for distance-based searching. The search results for a distance-based search will include both the Zip and a Distance value. The Distance value is the number of miles between the specified Zip and the Zip of the matching Clinical Provider's address. Only those matches with a Distance value less than or equal to the Distance parameter passed will be returned in the output.

Note: While the Distance value output is a decimal number, only integers are supported for input parameters. Also, any Clinical Provider results that are located within the specified Zip will show a distance of zero (0), since the calculation is between zip codes, not between locations within a zip code.

See the Clinical Provider Search documentation for additional details on the endpoints.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get information on given clinical provider

GET
/v1/{practiceid}/clinicalproviders/{clinicalproviderid}
Retrieves details of a specific clinical provider Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
clinicalproviderid integer clinicalproviderid
showdeleted boolean By default, a deleted clinical provider is not returned. Set to return if deleted.
shownpi integer Include NPI in output.
showfederalidnumber integer Include federal ID number in output.

Output Parameters

Expand all
address string The address of the clinical provider on file.
city string The city of the clinical provder on file.
clianumber string The CLIA number of the clinical provider on file.
clinicalproviderid integer The clinical provider ID.
deleted string The deleted state of the clinical provider.
fax string The fax phone number of the clinical provider on file.
federalidnumber string The federal ID number of the clinical provider on file.
firstname string First name of the clinical provider.
lastname string Last name of the clinical provider.
name string The name of the clinical provider
npi string The NPI of the clinical provider on file.
phone string The phone number of the clinical provider on file.
state string The state of the clinical provider on file.
zip string The zip code of the clinical provider on file.
Example Code

Get list of clinical providers - matching given criteria

GET
/v1/{practiceid}/clinicalproviders/search
Retrieves a list of Clinical providers based on the search criteria provided
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
firstname string First name of the clinical provider. Last name is also required if this field is passed. First name must match exactly.
distance integer The distance in miles to filter results by.
name string Name of the provider. This field should be used for non-person entities.
lastname string Last name of the clinical provider. First name is also required if this field is passed. Last name must match exactly.
phone string The phone number of the clinical provider on file.
clinicalprovidernpi integer The NPI ID of the provider, if applicable.
state string The state of the clinical provider on file. This should only be the two letter state abbreviation. CITY is also required if this field is passed and ZIP is not specified.
city string The city of the clinical provider on file. STATE is also required if this field is passed and ZIP is not specified.
zip integer The zip code of the clinical provider on file. Required if DISTANCE is provided.
fax string The fax phone number of the clinical provider on file.
address string The address of the clinical provider on file. This should only be the street address and not include city/state/zip. This field must also have a minimum of three non-whitespace characters.
ordertype string The type of facility to search for.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
address string The address of the clinical provider on file.
city string The city of the clinical provder on file.
clinicalproviderid string The clinical provider ID.
clinicalprovidernpi integer The NPI ID of the provider, if applicable.
distance string How far the provider is from the given zip code in miles.
fax string The fax phone number of the clinical provider on file.
firstname string First name of the clinical provider.
lastname string Last name of the clinical provider.
name string The name of the clinical provider
ncpdpid integer The NCPDP ID of the given facility, if applicable.
pharmacytype string For pharmacies, whether this is a RETAIL or MAILORDER pharmacy.
phone string The phone number of the clinical provider on file.
state string The state of the clinical provider on file.
zip string The zip code of the clinical provider on file.
Example Code