Using REST to Invoke HIPAASpace API

Introduction

This document is intended for developers who want to write applications that can
interact with the JSON/XML HIPAASpace REST API. With HIPAASpace Web Services,
you can create a customized services for your own website or application. You can
use the JSON/XML REST API to retrieve HIPAASpace Web Services results programmatically.

You can specify the how many results to return for the current search.

Valid values are integers between 1 and 100, inclusive.

If num is not used, a value of 30 is assumed.

friendlyprint

Returns a response with indentations and line breaks

If friendlyprint is not used, a “true” value is assumed. This is equivalent to friendlyprint=true.

Accepted values are:

true - the results returned by the server will be more “human readable”.

false - the results returned by the server will not have indentations and line breaks.

ICD9/ICD10 Parameters

codeType

Specifies whether ICD code is "dx"(Diagnosis) or "pcs"(Procedure).

Required for ICD only.

If you don't specify an codeType parameter this is equivalent to codeType=dx.

Accepted values are:

dx (diagnosis)

pcs (procedure)

NPI Related Parameters

qf

Specifies predicate in form of tuple "qf=City:true:Phoenix".

Expected to be one or many "qf" parameters in request.

Required for following operations:

validate

paginate_with_predicates

search_with_predicates

Tuple values are (order based):

NPI Field Name

NPI

Phone

Fax

FirstName

LastName

OrganizationName

OtherOrganizationName

Address1

Address2

Zip

City

State

IndividualOrganizationCode

Exact Match

true

false

Expected Field Value

orderField

Sort order field name

Expected to be one "orderField" parameter in request.

Required for following operations:

paginate_with_predicates

Values are:

NPI

Phone

Fax

FirstName

LastName

OrganizationName

OtherOrganizationName

Address1

Address2

Zip

City

State

IndividualOrganizationCode

pageNo

Page Number

Ordinal page number.

Required for following operations:

paginate_with_predicates

pageSize

Page Size

Expected page size.

Required for following operations:

paginate_with_predicates

HIPAASpace Coding Library - Quering NPI Registry - REST API Examples

Use Case #1 - I Need to Find Healthcare Provider (Doctor or Orgranization) Having Just Partial Information

So, you have to find healthcare provider having just partial information.
For instance all you have is "EYE doctor RANIA in REDMOND".
Strictly speaking, it is necessary to perform a search with minimum information and the maximum level of relevance of the result.

Coding example below demonstrates simplest implementation in C# language.
By default HIPAASpace full text search API returns 30 results and, as you may see below,
the first result in the list is "REDMOND EYE DOCTORS, PLLC" where dr. Rania Montecillo specified an owner.

Feel free to use and modify this code to find doctors you may know.
If you provide more or less meaningfull information you will be pleasantly surprised to see them in the search results.

Full Text Search Fundamentals

Facts

Everybody uses full text search.
Full-text search is the most common technique used in search engines.
The amount of information has just become too much to access it using navigation and categories alone.
Full-text search reduces the hassle of searching for a keyword in huge amounts of metadata, such as the World Wide Web and commercial-scale databases.
Full-text search became popular in late 1990s, when the Internet and Big Data began to became a part of everyday life.

How does it work

Users only provide keywords and expect the search engine to provide good results.
Relevancy of documents is expected to be good and users want the results they are looking to be present in the top ten.
How relevant a document is search engine decides based on scientifically proven algorithms.
Besides getting the best results the user wants to be supported during the search process.
Features like suggestions and highlighting on the result excerpt can help with this.

Full Text Search & HIPAASpace REST API

HIPAASpace REST API allows you to search the full text of healthcare providers database (NPI Registry).
To find the information you need and make your search easy, please use our REST API for automation,
or visit our NPI Lookup page for manual search ( NPI Number Lookup).
We are still improving and enhancing Full Text NPI Search based on users feedbacks.
Please email your comments and suggestions for improvement using our feedback page.

Use Case #2 - I Need to Find Detailed Healthcare Provider Information Using Known NPI Number

This is very common scenario. You want to get full replica of NPI record. It's as simple as the code you may find below.
Expected result may contain single NPI record, or empty list in case the provided NPI does not exist in the
CMS National Plan and Provider Enumeration System (NPPES) Registry.

Use Case #3 - I Need to Get Multiple Healthcare Providers Using List of NPI Numbers

You may need to perform bulk search for performance optimization.
The "getcodes" operation allows you to decrease number of round trips in orders of magnitude.
For instance you can get information about hundred NPI in one REST call, instead of sending NPI numbers to server one-by-one.

www.HIPAASpace.com privacy policies explain how we treat your personal data and protect your privacy
when you use our Services. By using our Services, you agree that www.HIPAASpace.com can use such data
in accordance with our privacy policies.

We respond to notices of alleged copyright infringement and terminate accounts of repeat infringers
according to the process set out in the U.S. Digital Millennium Copyright Act.

We provide information to help copyright holders manage their intellectual property online.
If you think somebody is violating your copyrights and want to notify us, you can find information
about submitting notices and www.HIPAASpace.com policy about responding to notices in our Help Center.