The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for different geographies on individual provider:
- Scores
- Prescriptions
- 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.
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 |
| parent_metric_id | integer | ID of the parent metric at a higher level |
| metric_id | integer | metric ID |
| metric_definition | string | metric definition |
| metric_low_is_good | string | “Y” or “N” |
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) |
| peer_days_supply_per_patient | decimal | HRR peer-based day’s supply for which the drug was dispensed |
| peer_drug_cost_per_prescription | decimal | HRR peer-based drug cost paid per prescription |
| adjusted_drug_cost_per_prescription | decimal | drug cost paid per prescription |
| peer_drug_cost_per_patient | decimal | HRR peer-based drug cost paid per patient |
| peer_drug_cost_per_prescription | decimal | HRR peer-based drug cost paid per prescription |
| adjusted_days_supply_per_patient | decimal | day’s supply for which this drug was dispensed |
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) |
| total_paid | decimal | Total Dollar amount paid by Medicare |
| panel_patients | integer | Total panel patient count |
| total_services | integer | Total service paid by Medicare |
| peer_total_paid_per_any_service | decimal | HRR peer-based dollar amount paid by Medicare per service |
| adjusted_total_paid_per_any_service | decimal | Dollar amount paid by Medicare per service |
| peer_total_paid_per_panel_patients | decimal | HRR peer-based dollar amount paid by Medicare per panel patient |
| adjusted_total_paid_per_panel_patients_adj | decimal | Dollar amount paid by Medicare per panel patient |