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

  1. Providers
  2. Practices
  3. Hospitals
  4. Low-value care reports

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_levelintegerCan be 1, 2, or 3

provider-low-value

 

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)
hcpcs_codestringIncludes Level 1 and Level 2 codes
descriptionstringBrief description of the code
amountdecimalTotal dollar amount

 

provider-gifts

 

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)
payment_amountdecimalDollar amount
payment_naturestringBrief description
donorstringInstitution name

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)
drug_name,stringThe name of the drug filled
total_day_supplyintegerThe aggregate number of day’s supply for which this drug was dispensed
total_claim_count,integerThe number of Medicare Part D claims. This includes original prescriptions and refills.
opioid_claim_countintegerTotal Claims of Opioid Drugs, Including Refills
total_drug_costdecimalThe aggregate drug cost paid for all associated claims
beneficiary_countintegerMedicare Beneficiaries
adjusted_drug_cost_per_patientdecimalDollar amount paid by Medicare per
per patient
adjusted_days_supply_per_patientdecimalDollar amount paid by Medicare per
per patient
adjusted_days_supply_per_patientdecimalDays supply count per patient
adjusted_days_supply_per_patientdecimalHRR peer-based dollar amount
paid by Medicare per patient
adjusted_days_supply_per_patientdecimalHRR peer-based dollar amount
paid by Medicare per prescription
adjusted_days_supply_per_patientdecimalHRR peer-based days supply count
per patient

 

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)
hcpcs_codestringIncludes Level 1 and Level 2 codes
descriptionstringBrief description of the code
unique_beneficiary_countintegerUnique Medicare Beneficiaries
adjusted_paid_amount_per_servicedecimal

Dollar amount paid by Medicare per

per service

adjusted_paid_amount_per_panel_patientdecimal

Dollar amount paid by Medicare per

per panel patient

peer_paid_amount_per_servicedecimal

HRR peer-based dollar amount

paid by Medicare per service

peer_paid_amount_per_panel_patientdecimal

HRR peer-based dollar amount

paid by Medicare per panel

patient

hospital-low-value

 

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

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

NameData TypeDescription
hospital_namestringIncludes Level 1 and Level 2 codes
hospital_typestringBrief description of the code
hospital_ownershipstringUnique Medicare Beneficiaries
total_low_value_caredecimal

Dollar amount paid by Medicare per

per service

low_value_pmpydecimal

Dollar amount paid by Medicare per

per panel patient

 

zip-low-value

 

ParameterData TypeRequired/OptionalDescription
zipstringrequiredPostal zip code
yearintegeroptional

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

 

NameData TypeDescription
specialtystringSpecialty name
low_value_carestringDollar amount paid by Medicare
low_value_pmpydecimal

Dollar amount paid by Medicare per

per patient

county-low-value

ParameterData TypeRequired/OptionalDescription
statestringrequiredUS state (two characters)
countystringrequiredCounty Name
yearintegeroptional

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

 

NameData TypeDescription
specialtystringSpecialty name
low_value_carestringDollar amount paid by Medicare
low_value_pmpydecimalDollar amount paid by Medicare per patient

practice-scores

 

ParameterData TypeRequired/OptionalDescription
group_pac_idstringrequired

GroupPracticePACID

 

yearintegeroptional

1 = 2014

2 = 2015

3 = 2016

4 = 2017

5 = 2018 (default)

Response Values:

 

NameData TypeDescription
group_pac_idstringGroupPracticePACID
practice_nameintegerGroup Practice Name
score_namestringName of the score type. It can be one of the three main score types
score_rankintegerBetween 1 and 5
score_weightdecimalImportance of the score
score_valueintegerActual value