nppesDetail
Query to specify data request for individual and organizational provider detail, specialty, location and organizational status as reported to CMS's National Plan and Provider Enumeration System (NPPES) on a monthly basis.
Get Started with nppesDetail
If you have already setup CareQuery, run the below code to get started with your first nppesDetail query.
Example:
Request NPPES data for all cardio specialists in Colorado and New Mexico.
# 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.nppesDetail(specialty = "internal medicine - cardiovascular disease",
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 nppesDetail query, including details on the parameter values.
parameter | description | options |
|---|---|---|
| National Provider Identifier (NPI) of individual and/or | Any Valid NPI |
| Taxonomy of the organization or individual provider, 10-digit code that used to identify the type, classification, and area of specialization of an individual or organizational healthcare provider | |
| Specialty of the organization or individual provider(s), specific focus of a provider by patient population, disease, skill or philosophy | |
| Specialty category of the organization or individual provider(s), broad focus of a provider by patient population, disease, skill or philosophy | |
| Specialty subcategory of the organization or individual | |
| US State residence of the query patient population | |
| Nine distinct US State groupings as defined by the US Census Bureau | |
| Four major US State groupings as defined by the US Census Bureau | |
| Primary zip code of the individual or organizational provider | Valid US |
| Number of rows returned in the data request | Integer or False |
| Binary indicator as to whether you'd like | True or False |
Query Return Data
The nppesDetail query returns the NPPES_TABLE for all National Provider Identifiers (NPIs) that meet the criterion specified within the query.
The NPPES_TABLE offers NPPES's detail, credentials, taxonomies and contact information of registered providers.
| feature | description | example |
|---|---|---|
| npi | National Provider Identifier (NPI) of the individual/organizational provider registered with NPPES. | 1306587324 |
| name | Full name or organizational name of the individual/organizational provider registered with NPPES. | cristina papari |
| entity_type | Indicator of whether the corresponding provider is an individual or organization. | individual |
| gender | Gender of the individual provider. | f |
| credential | Medical credential of the individual provider. | md |
| primary_taxonomy_code | Primary taxonomy code of the individual/organizational provider. | 207Q00000X |
| secondary_taxonomy_code | Secondary taxonomy code of the individual/organizational provider. | 235Z00000X |
| address | Primary address of the individual/organizational provider, as reported to NPPES. | 200 hawkins dr |
| city | City, State of the primary address of the individual/organizational provider, as reported to NPPES. | iowa city |
| state | State of the primary address of the individual/organizational provider, as reported to NPPES. | IA |
| zip | Zip code of the primary address of the individual/organizational provider, as reported to NPPES. | 52242 |
| phone | Primary phone number of the individual/organizational provider, as reported to NPPES. | 3193847507 |
| fax | Primary fax number of the individual/organizational provider, as reported to NPPES. | 3193847822 |
| sole_proprietor | Binary indicator (yes, no) as to whether the provider is registered as a sole proprietor with NPPES. | No |
| org_subpart | Binary indicator (yes, no) as to whether the provider is registered as an organizational subpart with NPPES. | No |
| org_lbn | Legal business name of the parent organization associated with an NPI. | consumerhealth, inc. |
| update_date | The last date in which NPPES dataset has been updated | 2023-09-01 |
Advanced Query Logic & Recipes
nppesDetail 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!
nppesDetail 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