Documentation

Home > Web Services > Documentation

NPI Data Services offer two ways for developers to integrate authentication into applications which leverage the Provider Web Services. Whether you need to authenticate within a SOAP header, or authenticate via parameter inside of the Web service method, we give you the flexibility to best fit your coding environment.

Authentication Passed as a Parameter within the Method: For situations where you want to authenticate using the parameters of a method, we have created a simple way to convert base WSDLs to accomodate this code. To use this authentication model, simply use the "WSDL without Header Implementation".

Authentication Passed in SOAP Headers: You can easily include authentication within the SOAP headers for your applications too. To use this authentication model, simply use the "WSDL with Header Implementation".

WSDLs: http://www.npidataservices.com/ProviderServices/ProviderWebService?wsdl (without Header Implementation)
http://www.npidataservices.com/ProviderServices/ProviderServiceWithHeader?wsdl (With Header Implementation)
http://www.npidataservices.com/ProviderServices/ProviderTrialWebService?wsdl (Trial Web Service)

Provider Webservices - Operations:

Search Rule 1 - FindProviderBYNPI (Expected # of Search key is 1):
Input: NPI#

Output: Returns only one provider record always.

Search Rule 2 - FindProviderBYUPIN (Expected # of Search key is 1):
Input:UPIN#

Output: Returns only one provider record always.

Search Rule 3 - FindProviderBYPhoneNoOrFaxNo (Expected # of Search keys are 2):
Input:Provider Business Practice Location Phone Number or Fax Number or Provider Business Mailing Phone Number or Fax Number; Entity Type – "I" for Individual or "O" for Organization

Output: Returns one or more provider records. The number of individual providers is identified in personCount and the number of organizations count is identified in organizationCount tags

Search Rule 4 - FindProviderByStateLicense (Expected # of Search keys are 2):
Input:State License Number and State Code (always Two characters). Download Statecodes by clicking State Codes List.

Output: Returns only one provider record always.

Search Rule 5 – FindIndividualProviderByName (Expected # of Search keys are 4):
Input:Provider Last Name, Provider First Name, Provider Business Practice Location Address State Code and Provider Business Practice Location Address City Name (or Provider Business Practice Location Address Postal Code). Minimum first three characters should be sent in Provider Last and First name for wild card search. Less than 3 characters will be matched exactly. The number of individual providers is identified in personCount and the number of organizations count is identified in organizationCount. State Code is two characters. Download Statecodes by clicking State Codes List.

Output: Returns one or more provider records.

Search Rule 6 - FindOrganizationProviderByName (Expected # of Search keys are 3):
Input:Provider Organization Name (Legal Business Name), Provider Business Practice Location Address State Code, Provider Business Practice Location Address City Name (or Provider Business Practice Location Address Postal Code). Minimum first three characters should be sent in Provider Organization name for wild card search. Less than 3 characters will be matched exactly. The number of individual providers is identified in personCount and the number of organizations count isidentified in organizationCount. State Code is two characters. Download Statecodes by clicking State Codes List.

Output: Returns one or more provider records.

Search Rule 7 – FindProvidersByTaxonomyCode (Expected # of Search keys are 4):
Input:Taxonomy code, Entity Type –"I" for Individual or "O" for Organization, Provider Business Practice Location Address State Code, Provider Business Practice Location Address City Name (or Provider Business Practice Location Address Postal Code). The number of individual providers is identified in personCount and the number of organizations count is identified in organizationCount tags. State Code is two characters. Download Statecodes by clicking State Codes List.

Output: Returns one or more provider records.

Search Rule 8 – FindProvidersByTaxonomyDescription (Expected # of Search keys are 4):
Input:Taxonomy Description, Entity Type –"I" for Individual or "O" for Organization, Provider Business Practice Location Address State Code, Provider Business Practice Location Address City Name (or Provider Business Practice Location Address Postal Code). The number of individual providers is identified in personCount and the number of organizations count is identified in organizationCount tags. Allowed "Taxonomy Description" are available here. State Code is two characters.
Download Statecodes by clicking State Codes List.

Output: Returns one or more provider records.

findSubscriptionInformation:

Get info about your remaining hits for the subscription and today.

loading..