,
Sam Parmar [ctb],
Matthias Grenié [rev] ,
Emily C. Zabor [rev] | Title: | Access the U.S. National Provider Identifier Registry API |
|---|---|
| Description: | Access the United States National Provider Identifier Registry API <https://npiregistry.cms.hhs.gov/api/>. Obtain and transform administrative data linked to a specific individual or organizational healthcare provider, or perform advanced searches based on provider name, location, type of service, credentials, and other attributes exposed by the API. |
| Authors: | Frank Farach [cre, aut, cph] ,
Sam Parmar [ctb],
Matthias Grenié [rev] ,
Emily C. Zabor [rev] |
| Maintainer: | Frank Farach <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.2.0.9000 |
| Built: | 2024-09-28 06:28:55 UTC |
| Source: | https://github.com/ropensci/npi |
npi_results objectS3 method to flatten an npi_results object
npi_flatten(df, cols, key)npi_flatten(df, cols, key)
df |
A data frame containing the results of a call to
|
cols |
If non-NULL, only the named columns specified here will be be
flattened and returned along with |
key |
A quoted column name from |
A data frame (tibble) with flattened list columns.
# Flatten all list columns data(npis) npi_flatten(npis) # Only flatten specified columns npi_flatten(npis, cols = c("basic", "identifiers"))# Flatten all list columns data(npis) npi_flatten(npis) # Only flatten specified columns npi_flatten(npis, cols = c("basic", "identifiers"))
This function takes an npi_results S3 object returned by
npi_search and flattens its list columns. It unnests the
lists columns and left joins them by npi. You can optionally specify
which columns from df to include.
## S3 method for class 'npi_results' npi_flatten(df, cols = NULL, key = "npi")## S3 method for class 'npi_results' npi_flatten(df, cols = NULL, key = "npi")
df |
A data frame containing the results of a call to
|
cols |
If non-NULL, only the named columns specified here will be be
flattened and returned along with |
key |
A quoted column name from |
The names of unnested columns are prefixed by the name of their originating list column to avoid name clashes and show their lineage. List columns containing all NULL data will be absent from the result because there are no columns to unnest.
A data frame (tibble) with flattened list columns.
# Flatten all list columns data(npis) npi_flatten(npis) # Only flatten specified columns npi_flatten(npis, cols = c("basic", "identifiers"))# Flatten all list columns data(npis) npi_flatten(npis) # Only flatten specified columns npi_flatten(npis, cols = c("basic", "identifiers"))
Check whether a number is a valid NPI number per the specifications detailed in the Final Rule for the Standard Unique Health Identifier for Health Care Providers (69 FR 3434).
npi_is_valid(x)npi_is_valid(x)
x |
10-digit candidate NPI number |
Boolean indicating whether npi is valid
npi_is_valid(1234567893) # TRUE npi_is_valid(1234567898) # FALSEnpi_is_valid(1234567893) # TRUE npi_is_valid(1234567898) # FALSE
Search the U.S. National Provider Identifier (NPI)
Registry using parameters exposed by the registry's API (Version 2.1).
Results are combined and returned
as a tibble with an S3 class of npi_results. See Value below
for a description of the returned object.
npi_search( number = NULL, enumeration_type = NULL, taxonomy_description = NULL, first_name = NULL, last_name = NULL, use_first_name_alias = NULL, organization_name = NULL, address_purpose = NULL, city = NULL, state = NULL, postal_code = NULL, country_code = NULL, limit = 10L )npi_search( number = NULL, enumeration_type = NULL, taxonomy_description = NULL, first_name = NULL, last_name = NULL, use_first_name_alias = NULL, organization_name = NULL, address_purpose = NULL, city = NULL, state = NULL, postal_code = NULL, country_code = NULL, limit = 10L )
number |
(Optional) 10-digit NPI number assigned to the provider. |
enumeration_type |
(Optional) Type of provider associated with the NPI, one of:
|
taxonomy_description |
(Optional) Scalar character vector with a taxonomy description or code from the NUCC Healthcare Provider Taxonomy. |
first_name |
(Optional) This field only applies to Individual Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered (e.g. "jo*" ). This field allows the following special characters: ampersand, apostrophe, colon, comma, forward slash, hyphen, left and right parentheses, period, pound sign, quotation mark, and semi-colon. |
last_name |
(Optional) This field only applies to Individual Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered. This field allows the following special characters: ampersand, apostrophe, colon, comma, forward slash, hyphen, left and right parentheses, period, pound sign, quotation mark, and semi-colon. |
use_first_name_alias |
(Optional) This field only applies to Individual Providers when not doing a wildcard search. When set to "True", the search results will include Providers with similar First Names. E.g., first_name=Robert, will also return Providers with the first name of Rob, Bob, Robbie, Bobby, etc. Valid Values are: TRUE: Will include alias/similar names; FALSE: Will only look for exact matches. |
organization_name |
(Optional) This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered. This field allows the following special characters: ampersand, apostrophe, "at" sign, colon, comma, forward slash, hyphen, left and right parentheses, period, pound sign, quotation mark, and semi-colon. Both the Organization Name and Other Organization Name fields associated with an NPI are examined for matching contents, therefore, the results might contain an organization name different from the one entered in the Organization Name criterion. |
address_purpose |
Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or any of Practice Location Addresses match the entered address information. Primary will only search against Primary Location Address. While Secondary will only search against Secondary Location Addresses. Valid values are: "location", "mailing", "primary", "secondary". |
city |
The City associated with the provider's address identified in Address Purpose. To search for a Military Address enter either APO or FPO into the City field. This field allows the following special characters: ampersand, apostrophe, colon, comma, forward slash, hyphen, left and right parentheses, period, pound sign, quotation mark, and semi-colon. |
state |
The State abbreviation associated with the provider's address identified in Address Purpose. This field cannot be used as the only input criterion. If this field is used, at least one other field, besides the Enumeration Type and Country, must be populated. Valid values for states: https://npiregistry.cms.hhs.gov/registry/API-State-Abbr |
postal_code |
The Postal Code associated with the provider's address identified in Address Purpose. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data. Trailing wildcard entries are permitted requiring at least two characters to be entered (e.g., "21*"). |
country_code |
The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States). Valid values for country codes: https://npiregistry.cms.hhs.gov/registry/API-Country-Abbr |
limit |
Maximum number of records to return, from 1 to 1200 inclusive.
The default is 10. Because the API returns up to 200 records per request,
values of |
By default, the function requests up to 10 records, but the
limit argument accepts values from 1 to the API's limit of 1200.
Data frame (tibble) containing the results of the search.
https://npiregistry.cms.hhs.gov/registry/help-api Data dictionary for fields returned
NUCC Healthcare Provider Taxonomy
## Not run: # 10 NPI records for New York City npi_search(city = "New York City") # 1O NPI records for New York City, organizations only npi_search(city = "New York City", enumeration_type = "org") # 1O NPI records for New York City, individuals only npi_search(city = "New York City", enumeration_type = "ind") # 1200 NPI records for New York City npi_search(city = "New York City", limit = 1200) # Nutritionists in Maine npi_search(state = "ME", taxonomy_description = "Nutritionist") # Record associated with NPI 1245251222 npi_search(number = 1245251222) ## End(Not run)## Not run: # 10 NPI records for New York City npi_search(city = "New York City") # 1O NPI records for New York City, organizations only npi_search(city = "New York City", enumeration_type = "org") # 1O NPI records for New York City, individuals only npi_search(city = "New York City", enumeration_type = "ind") # 1200 NPI records for New York City npi_search(city = "New York City", limit = 1200) # Nutritionists in Maine npi_search(state = "ME", taxonomy_description = "Nutritionist") # Record associated with NPI 1245251222 npi_search(number = 1245251222) ## End(Not run)
npi_results objectS3 method to summarize an npi_results object
npi_summarize(object, ...)npi_summarize(object, ...)
object |
An |
... |
Additional optional arguments |
Tibble containing the following columns:
npiNational Provider Identifier (NPI) number
nameProvider's first and last name for individual providers, organization name for organizational providers.
enumeration_typeType of provider associated with the NPI, either "Individual" or "Organizational"
primary_practice_addressFull address of the provider's primary practice location
phoneProvider's telephone number
primary_taxonomyPrimary taxonomy description
data(npis) npi_summarize(npis)data(npis) npi_summarize(npis)
npi_results S3 objectPrint a human-readable overview of each record return in the results from a
call to npi_search. The format of the summary is modeled after
the one offered on the NPI registry website.
## S3 method for class 'npi_results' npi_summarize(object, ...)## S3 method for class 'npi_results' npi_summarize(object, ...)
object |
An |
... |
Additional optional arguments |
Tibble containing the following columns:
npiNational Provider Identifier (NPI) number
nameProvider's first and last name for individual providers, organization name for organizational providers.
enumeration_typeType of provider associated with the NPI, either "Individual" or "Organizational"
primary_practice_addressFull address of the provider's primary practice location
phoneProvider's telephone number
primary_taxonomyPrimary taxonomy description
data(npis) npi_summarize(npis)data(npis) npi_summarize(npis)
A dataset containing 10 records returned from an NPI Registry search for providers with a primary address in New York City.
npisnpis
A tibble with 10 rows and 11 columns, organized as follows:
[integer] 10-digit National Provider Identifier number
[character] Type of provider NPI, either "Individual" or "Organizational".
[list of 1 tibble] Basic information about the provider.
[list of tibbles] Other names the provider goes by.
[list of tibbles] Other identifiers linked to the NPI.
[list of tibbles] Healthcare Provider Taxonomy classification.
[list of tibbles] Addresses for the provider's primary practice location and primary mailing address.
[list of tibbles] Addresses for the provider's other practice locations.
[list of tibbles] Details about provider's endpoints for health information exchange.
[datetime] Date NPI record was first created (UTC).
[datetime] UTC timestamp of the last time the NPI record was updated.
search_npi(city = "New York City", limit = 10)
https://npiregistry.cms.hhs.gov/registry/help-api