providerOutreach
Query to specify data request for individual healthcare providers and their accompanying contact information, including email, phone and fax.
Get Started with providerOutreach
If you have already setup CareQuery, run the below code to get started with your first providerOutreach query.
Example:
Request contact details for all orthopaedic hand surgeons in New Mexico and Colorado.
# import package
from care_query.care_query import CareQuery
# instantiate and connect
cq = CareQuery(email = "your-email",
token = "your-api-token")
# construct query
query = cq.providerOutreach(subspecialty = "orthopaedic surgery - hand surgery",
state = ["CO","NM"])
# estimate query size (optional)
estimate = query.estimate()
# return query sample data (optional)
sample = query.sample()
# execute query to return results
data = query.execute() Query Parameters
The following a parameters are available within the providerOutreach query, including details on the parameter values.
parameter | description | options |
|---|---|---|
| National Provider Identifier (NPI) of individual and | Any valid National |
| Primary taxonomy code of the individual provider | |
| Subspecialty of the individual provider record | |
| Specialty of the individual provider record | |
| Specialty category of the individual provider record | |
| First three digits of zip code for the individual provider record | First three digits of |
| Metropolitan and micropolitan statistical areas according to the US Census Bureau | |
| US State code of the individual provider record | |
| US State Division code of the individual provider record | |
| US State Region code of the individual provider record | |
| Number of rows returned in the data request | Integer or False |
| Binary indicator as to whether you'd like query to be printed | True or False |
Query Return Data
The providerOutreach query returns the all executive data that meet the criterion specified within the query.
The PROV_OUTREACH_TABLE offers provider contact information including descriptions, categorial mappings of their roles.
| feature | description | example |
|---|---|---|
| hcp_npi | National Provider Identifier (NPI) of the individual provider registered with NPPES. | 1588763981 |
| hcp_name | Full name of the individual provider record | randal aaberg |
| taxonomy | Primary taxonomy code of the individual provider | 367A00000X |
| subspecialty | Subspecialty of the individual provider record | urology - general |
| specialty | Specialty of the individual provider record | urology |
| specialty_category | Specialty category of the individual provider record | allopathic & osteopathic physicians |
| email1 | Primary email address of the individual provider | [email protected] |
| email2 | Secondary email address of the individual provider | [email protected] |
| address | Primary address on record for the individual provider record | 3288 moanalua rd |
| city | City of primary address for the individual provider record | honolulu |
| state | Two digit US State code of primary address for the individual provider record | HI |
| zip | Zip code of the primary address for the individual provider record | 96819 |
| phone | Primary phone number of the individual provider record | 808-432-8000 |
| fax | Primary fax number of the individual provider record | 808-432-8000 |
| update_date | The last date in which the provider contact details have been updated | 2023-09-01 |
| system_exec | Biary indicator of whether the executive is at the hospital or health system administrative level | 0 |
| update_date | The last date in which the hospital executive contact details have been updated | 2023-09-01 |
Advanced Query Logic & Recipes
providerOutreach gives users categorical groupings for ease of use, as well as SQL-like capabilities to tactfully specify AND and OR logic, right within the CareQuery API!
providerOutreach does not allow for nested lists within the query parameters
Please reference the following resources to better understand how to create rockstar queries!
Updated about 1 month ago