Skip to contents

Search the NPPES National Provider Identifier Registry API

Source: R/nppes_npi.R
nppes_npi_new.Rd

provider_nppes() allows you to search the NPPES NPI Registry's public API by many of the parameters defined in the API's documentation.

Usage

nppes_npi_new(
  npi = NULL,
  enum_type = NULL,
  first_name = NULL,
  last_name = NULL,
  org_name = NULL,
  taxonomy_desc = NULL,
  city = NULL,
  state = NULL,
  zip = NULL,
  country = NULL,
  limit = 200,
  skip = NULL,
  clean_names = TRUE
)

Source

Centers for Medicare & Medicaid Services

Arguments

npi

10-digit National Provider Identifier (NPI).

enum_type

The Read API can be refined to retrieve only Individual Providers (NPI-1 or Type 1) or Organizational Providers (NPI-2 or Type 2.) When not specified, both Type 1 and Type 2 NPIs will be returned. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.

first_name

Provider's first name. Applies to Individual Providers (NPI-1) only. 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

Provider's last name. Applies to Individual Providers (NPI-1) only. 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(;).

org_name

Healthcare organization's name. Applies to Organizational Providers (NPI-2) only. Trailing wildcard entries are permitted requiring at least two characters to be entered. All types of Organization Names (LBN, DBA, Former LBN, Other Name) 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. 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.

taxonomy_desc

Search for providers by their taxonomy by entering the taxonomy description.

city

City associated with the provider's address. 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

State abbreviation associated with the provider's address. This field cannot be used as the only input criterion. If this field is used, at least one other field, besides the prov_type and country, must be populated. Valid values for state abbreviations: https://npiregistry.cms.hhs.gov/help-api/state.

zip

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

Country abbreviation associated with the provider's address. 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 abbreviations: https://npiregistry.cms.hhs.gov/help-api/country.

limit

Maximum number of results to return; default is 200, maximum is 1200.

skip

Number of results to skip after searching the previous number; set in limit.

clean_names

Convert column names to snake case; default is TRUE.

Details

The NPPES NPI Registry Public Search is a free directory of all active National Provider Identifier (NPI) records. Healthcare providers acquire their unique 10-digit NPIs to identify themselves in a standard way throughout their industry. After CMS supplies an NPI, they publish the parts of the NPI record that have public relevance, including the provider’s name, taxonomy and practice address. It enables you to search for providers in the NPPES (National Plan and Provider Enumeration System.) All information produced by the NPI Registry is provided in accordance with the NPPES Data Dissemination Notice. There is no charge to use the NPI Registry.

Note

Update Frequency: Weekly