The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for different geographies on
- Providers
- Practices
- Hospitals
- 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.
API List:
provider-scores
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014
2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| metric_name | string | Metric name |
| metric_score | metric_score | Between 1 and 5 |
| metric_weight | decimal | decimal |
| metric_value | integer | integer |
| metric_level | integer | Can be 1, 2, or 3 |
provider-low-value
| Parameter | Data Type | Required/Optional | Description |
| npi | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| hcpcs_code | string | Includes Level 1 and Level 2 codes |
| description | string | Brief description of the code |
| amount | decimal | Total dollar amount |
provider-gifts
| Parameter | Data Type | Required/Optional | Description |
| npi | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| payment_amount | decimal | Dollar amount |
| payment_nature | string | Brief description |
| donor | string | Institution name |
provider-prescriptions
| Parameter | Data Type | Required/Optional | Description |
| npi | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| drug_name, | string | The name of the drug filled |
| total_day_supply | integer | The aggregate number of day’s supply for which this drug was dispensed |
| total_claim_count, | integer | The number of Medicare Part D claims. This includes original prescriptions and refills. |
| opioid_claim_count | integer | Total Claims of Opioid Drugs, Including Refills |
| total_drug_cost | decimal | The aggregate drug cost paid for all associated claims |
| beneficiary_count | integer | Medicare Beneficiaries |
| adjusted_drug_cost_per_patient | decimal | Dollar amount paid by Medicare per per patient |
| adjusted_days_supply_per_patient | decimal | Dollar amount paid by Medicare per per patient |
| adjusted_days_supply_per_patient | decimal | Days supply count per patient |
| adjusted_days_supply_per_patient | decimal | HRR peer-based dollar amount paid by Medicare per patient |
| adjusted_days_supply_per_patient | decimal | HRR peer-based dollar amount paid by Medicare per prescription |
| adjusted_days_supply_per_patient | decimal | HRR peer-based days supply count per patient |
provider-procedures
| Parameter | Data Type | Required/Optional | Description |
| npi | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| hcpcs_code | string | Includes Level 1 and Level 2 codes |
| description | string | Brief description of the code |
| unique_beneficiary_count | integer | Unique Medicare Beneficiaries |
| adjusted_paid_amount_per_service | decimal | Dollar amount paid by Medicare per per service |
| adjusted_paid_amount_per_panel_patient | decimal | Dollar amount paid by Medicare per per panel patient |
| peer_paid_amount_per_service | decimal | HRR peer-based dollar amount paid by Medicare per service |
| peer_paid_amount_per_panel_patient | decimal | HRR peer-based dollar amount paid by Medicare per panel patient |
hospital-low-value
| Parameter | Data Type | Required/Optional | Description |
| provider_id | string | required | The National Provider Identifier (NPI) |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| hospital_name | string | Includes Level 1 and Level 2 codes |
| hospital_type | string | Brief description of the code |
| hospital_ownership | string | Unique Medicare Beneficiaries |
| total_low_value_care | decimal | Dollar amount paid by Medicare per per service |
| low_value_pmpy | decimal | Dollar amount paid by Medicare per per panel patient |
zip-low-value
| Parameter | Data Type | Required/Optional | Description |
| zip | string | required | Postal zip code |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| specialty | string | Specialty name |
| low_value_care | string | Dollar amount paid by Medicare |
| low_value_pmpy | decimal | Dollar amount paid by Medicare per per patient |
county-low-value
| Parameter | Data Type | Required/Optional | Description |
| state | string | required | US state (two characters) |
| county | string | required | County Name |
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| specialty | string | Specialty name |
| low_value_care | string | Dollar amount paid by Medicare |
| low_value_pmpy | decimal | Dollar amount paid by Medicare per patient |
practice-scores
| Parameter | Data Type | Required/Optional | Description |
| group_pac_id | string | required | GroupPracticePACID
|
| year | integer | optional | 1 = 2014 2 = 2015 3 = 2016 4 = 2017 5 = 2018 (default) |
Response Values:
| Name | Data Type | Description |
| group_pac_id | string | GroupPracticePACID |
| practice_name | integer | Group Practice Name |
| score_name | string | Name of the score type. It can be one of the three main score types |
| score_rank | integer | Between 1 and 5 |
| score_weight | decimal | Importance of the score |
| score_value | integer | Actual value |