input | string | object | Input
The NPI or the search object exactly as sent. |
recordType | string | Record type
provider (a provider record) | summary (one per search: counts and why it stopped). |
position | integer | Position
Search rows only: 1-based position of the provider within its search. |
status | string | Status
ok | not_found | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged
Whether this record incurred its pay-per-event charge (provider-record; add-on charges are listed in chargedAddOns). |
chargedEvent | string | Charged event
Pay-per-event event charged for this record (present only when charged): provider-record. |
chargedCount | integer | Events charged
Events actually charged when the charge came back short of the requested count (present only then; a warning explains it). |
chargedAddOns | array | Charged add-ons
Add-on events charged for this record besides chargedEvent (present only then): exclusion-screening. |
source | string | Source
Upstream data source: nppes-npi-registry (screening: HHS-OIG LEIE). |
fetchedAt | string | Fetched at
ISO timestamp. |
error | object | Error
{ code, message, provider?, status? } when status is not ok. Codes: not_found (unknown NPI, or a search without results), invalid_input, client (NPPES refused the search); set by the runtime: budget_exhausted, free_plan_limit, unmetered, aborted, charge_failed, record_too_large, invalid_record, dataset_push_failed; upstream: http_error (with the HTTP status), network, tls_error, timeout, invalid_json, unexpected_type, too_large, invalid_response. |
warnings | array | Warnings
Notes about this record: a screening that was not charged or not available, a search capped by NPPES, the free plan or the budget. |
npi | string | null | NPI
10-digit National Provider Identifier. |
enumerationType | string | null | Enumeration type
NPI-1 (individual) or NPI-2 (organization). |
providerType | string | null | Provider type
individual | organization. |
npiStatus | string | null | NPI status
active (the registry lists active NPIs). |
name | string | null | Name
Organization name, or "FIRST MIDDLE LAST SUFFIX" for an individual. |
firstName | string | null | First name
Individual providers. |
middleName | string | null | Middle name
Individual providers. |
lastName | string | null | Last name
Individual providers. |
namePrefix | string | null | Name prefix
e.g. Dr. |
nameSuffix | string | null | Name suffix
e.g. Jr. |
credential | string | null | Credential
e.g. MD, RN, DDS (as the provider entered it). |
sex | string | null | Sex
F or M (individual providers). |
soleProprietor | boolean | null | Sole proprietor
Individual providers. |
organizationName | string | null | Organization name
Legal business name (organizations). |
organizationalSubpart | boolean | null | Subpart
The organization is a subpart of a parent organization. |
parentOrganizationName | string | null | Parent organization
Parent legal business name (subparts). |
parentOrganizationEin | string | null | Parent EIN
Parent organization EIN, when published. |
authorizedOfficial | object | null | Authorized official
Organizations: { firstName, middleName, lastName, namePrefix, nameSuffix, credential, title, phone }. |
primaryTaxonomy | object | null | Primary taxonomy
{ code, description, license, state, primary, group }: the provider's primary specialty (Health Care Provider Taxonomy code). |
taxonomies | array | Taxonomies
Every taxonomy { code, description, license, state, primary, group }. |
practiceAddress | object | null | Practice address
{ line1, line2, city, state, postalCode, countryCode, countryName, phone, fax } of the primary practice location. |
mailingAddress | object | null | Mailing address
Same shape as practiceAddress. |
otherPracticeLocations | array | Other practice locations
Secondary practice locations (same shape as practiceAddress). |
phone | string | null | Phone
Practice location phone (else the mailing address phone). |
fax | string | null | Fax
Practice location fax (else the mailing address fax). |
enumerationDate | string | null | Enumeration date
When the NPI was issued (YYYY-MM-DD). |
lastUpdated | string | null | Last updated
Last update of the registry record (YYYY-MM-DD). |
certificationDate | string | null | Certification date
Last certification of the record by the provider (YYYY-MM-DD), when present. |
otherNames | array | Other names
{ type, name, organizationName, firstName, middleName, lastName, credential }: former names, doing-business-as names. |
identifiers | array | Other identifiers
{ identifier, description, issuer, state }: Medicaid and other payer identifiers. |
endpoints | array | Endpoints
{ type, typeDescription, endpoint, use, affiliationName }: Direct messaging addresses and other health information exchange endpoints. |
registryUrl | string | null | Registry URL
The provider's page on npiregistry.cms.hhs.gov. |
exclusionScreening | object | null | Exclusion screening
Only with screenExclusions: { result (excluded | potential_match | no_match), matches: [{ matchedOn, name, lastName, firstName, middleName, businessName, general, specialty, npi, city, state, zip, exclusionType, exclusionTypeDescription, exclusionDate, waiverDate, waiverState }], list, listUpdated, listRecords, listStale? }; null when the screening was not delivered (see warnings). |
search | object | Search
Summary records: the search as sent to NPPES (firstName, lastName, organizationName, state, city, postalCode, taxonomy, enumerationType). |
screened | boolean | Screened
Summary records: whether the search's providers were screened. |
resultsDelivered | integer | Providers delivered
Summary records: provider records delivered (and charged) for the search. |
stopReason | string | Stop reason
Summary records: limit | end | free_plan | budget | aborted | deadline | empty_pages | max_pages | error. |
raw | object | Raw
Only with includeRaw: the unmodified NPPES registry record. |