The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for different geographies on individual provider:

  1. Scores
  2. Prescriptions
  3. Procedures

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:

provider-scores

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)
yearintegeroptional

1 = 2014

 

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

 

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
metric_namestringMetric name
metric_scoremetric_scoreBetween 1 and 5
metric_weightdecimaldecimal
metric_valueintegerinteger
metric_levelinteger

Can be 1, 2, or 3

parent_metric_idinteger

ID of the parent metric at a higher level

metric_idinteger

metric ID

metric_definitionstring

metric definition

metric_low_is_goodstring

“Y” or “N”

provider-prescriptions

 

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)
yearintegeroptional

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
peer_days_supply_per_patientdecimalHRR peer-based day’s supply for which the drug was dispensed
peer_drug_cost_per_prescriptiondecimalHRR peer-based drug cost paid per prescription
adjusted_drug_cost_per_prescriptiondecimaldrug cost paid per prescription
peer_drug_cost_per_patientdecimalHRR peer-based drug cost paid per patient
peer_drug_cost_per_prescriptiondecimalHRR peer-based drug cost paid per prescription
adjusted_days_supply_per_patientdecimalday’s supply for which this drug was dispensed

 

provider-procedures

 

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)
yearintegeroptional

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

 

Response Values:

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
total_paiddecimalTotal Dollar amount paid by Medicare
panel_patientsintegerTotal panel patient count
total_servicesintegerTotal service paid by Medicare
peer_total_paid_per_any_servicedecimal

HRR peer-based dollar amount paid by Medicare per service

adjusted_total_paid_per_any_servicedecimal

Dollar amount paid by Medicare per service

peer_total_paid_per_panel_patientsdecimal

HRR peer-based dollar amount paid by Medicare per panel patient

adjusted_total_paid_per_panel_patients_adjdecimal

Dollar amount paid by Medicare per panel patient