@evokegroup/nppes v1.0.0

@evokegroup/nppes

Library for querying the NPPES NPI Registry. See the NPPES API help page.

NppesClient

constructor()

Methods

search()

returns Promise<ISearchResults>

Example

Get a result for a single NPI number.

import { NppesClient } from '@evokegroup/nppes';

const client = new NppesClient();
client.search({ number: '0123456789' })
  .then((searchResults) => {
    // do something
  })
  .catch((ex) => {
    // do something
  });

Example

Get all individuals in a given city/state with a given last name

import { NppesClient, EnumerationType } from '@evokegroup/nppes';

const client = new NppesClient();
client.search({
  enumeration_type: EnumerationType.Individual,
  last_name: 'Doe',
  city: 'Brooklyn',
  state: 'NY'
}, {
  retrieveAll: true
})
  .then((searchResults) => {
    // do something
  })
  .catch((ex) => {
    // do something
  });

Example

Get all individuals in a given postal code who have a given specialty

import { NppesClient, EnumerationType } from '@evokegroup/nppes';

const client = new NppesClient();
client.search({
  enumeration_type: EnumerationType.Individual,
  taxonomy_description: 'gastro*',
  postal_code: '12345'
}, {
  retrieveAll: true
})
  .then((searchResults) => {
    // do something
  })
  .catch((ex) => {
    // do something
  });

EnumerationType

NamePurpose

'AO' | 'Provider'

AddressPurpose

'LOCATION' | 'MAILING' | 'PRIMARY' | 'SECONDARY'

ISearchParams

ISearchOpts

ISearchResults

ISearchResult

IResultBasic

IResultIndividualName

extends IResultBasic

IResultOrganizationName

extends IResultBasic

IResultOtherName

IResultIndividualOtherName

extends IResultOtherName

IResultOrganizationOtherName

extends IResultOtherName

IResultAddress

IResultTaxonomy

IResultIdentifier

IResultEndpoint