The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for:

  1. Providers
  2. Procedures
  3. Facilities

Using the API

The HealthCorum API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Our partners use the API by sending requests with a specific structure to our servers.

Getting Authenticated

The HealthCorum API uses API keys to authenticate requests and authentication to the API is performed via HTTP Basic Auth. The partners send HTTPS requests with the Authorization header that contains the word “Basic” followed by a space and a base64-encoded string username:password. 401 “Unauthorized” response is returned for requests with missing or incorrect credentials. This response includes the WWW-Authenticate header.

Request Structure

The API is accessed through GET requests.

 API End Point

https://healthcorumnow.com/api/

API List:

Providers Endpoint

Endpoint: /v1/providers
Methods: GET

Search individual providers based on their NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)

Response Values: Provider Data

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_scoreintegerProvider’s main score between 1 and 5
cost_scoreintegerProvider’s cost score between 1 and 5
quality_scoreintegerProvider’s quality score between 1 and 5
efficiency_scoreintegerProvider’s efficiency score  between 1 and 5
first_namestringProvider’s first name
middle_namestringProvider’s middle name
last_namestringProvider’s last name
specialtiesstringProvider’s specialties
proceduresstringList of procedures the provider performs
is_pcpTrue/FalseIs the provider a PCP
credentialsstringProvider’s degrees (e.g. MD, OD, PhD)
genderstringProvider’s gender
graduation_yearstringGraduation year
medical_schoolstringMedical school provider graduated from
locationsstringProvider’s known practice locations
peer_groupstringHRR/specialty/subspecialty

 

Search individual providers based on their location and procedure ID

ParameterData TypeRequired/OptionalDescription
addressstringrequiredLocation
procedure_idsstringrequiredList of requested procedures

Response Values: List of providers who match the criteria

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_scoreintegerProvider’s main score
cost_scoreintegerProvider’s cost score
quality_scoreintegerProvider’s quality score
appropriateness_scoreintegerProvider’s appropriateness score
proceduresstringList of procedure ids

 

Search individual providers based on their location and conditions

ParameterData TypeRequired/OptionalDescription
addressstringrequiredLocation
condition_idsstringrequiredList of requested conditions

Response Values: List of providers who match the criteria

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_scoreintegerProvider’s main score between 1 and 5
cost_scoreintegerProvider’s cost score between 1 and 5
quality_scoreintegerProvider’s quality score between 1 and 5
appropriateness_scoreintegerProvider’s appropriateness score between 1 and 5
condition_idsstringList of condition ids

Search individual providers based on their location and Overall Score

ParameterData TypeRequired/OptionalDescription
addressstringrequiredLocation
overall_scoreinteger ( 1 – 5)requiredProvider’s main score

Response Values: List of providers who have the Overall Score and above

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_scoreintegerProvider’s main score between 1 and 5
cost_scoreintegerProvider’s cost score between 1 and 5
quality_scoreintegerProvider’s quality score between 1 and 5
appropriateness_scoreintegerProvider’s appropriateness score between 1 and 5

Procedures Endpoint

Endpoint: /v1/procedures
Methods: GET

Search for estimated costs for a given procedure based on member’s location

ParameterData TypeRequired/OptionalDescription
zip_codestringrequiredLocation
procedure_idstringrequiredProcedure code

Response Values:

NameData TypeDescription
zip_codestringThe National Provider Identifier (NPI)
procedurestringProcedure object
average_costdecimalcost estimate

 

Facilities Endpoint

Endpoint: /v1/facilities
Methods: GET

Search for facilities based on NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)

Response Values:

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
typeintegerFacility type (i.e. hospital, nursing home, surgery center)
namestringFacility Name
overall_scoreintegerFacility’s overall score between 1 and 5
cost_scoreintegerFacility’s cost score between 1 and 5
quality_scoreintegerFacility’s quality score between 1 and 5
appropriateness_scoreintegerFacility’s appropriateness score between 1 and 5
statestringState
zip_codestringzip code

 

Search for facilities based on location, type and Overall Score

ParameterData TypeRequired/OptionalDescription
addressstringrequiredLocation
typeintegerrequiredFacility type (i.e. hospital, nursing home, surgery center)
overall_scoreinteger ( 1 – 5)requiredFacility main score

Response Values: List of facilities that has the overall score and above

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
typeintegerFacility type (i.e. hospital, nursing home, surgery center)
overall_scoreintegerFacility main score between 1 and 5
cost_scoreintegerFacility’s cost score between 1 and 5
quality_scoreintegerFacility’s quality score between 1 and 5
appropriateness_scoreintegerFacility’s appropriateness score between 1 and 5
namestringFacility Name
addressstringFacility Address
statestringState
zip_codestringzip code