The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for:
- Providers
- Procedures
- 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.
API List:
Providers Endpoint
Endpoint: /v1/providers
Methods: GET
Search individual providers based on their NPI
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI) |
Response Values: Provider Data
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| overall_score | integer | Provider’s main score between 1 and 5 |
| cost_score | integer | Provider’s cost score between 1 and 5 |
| quality_score | integer | Provider’s quality score between 1 and 5 |
| efficiency_score | integer | Provider’s efficiency score between 1 and 5 |
| first_name | string | Provider’s first name |
| middle_name | string | Provider’s middle name |
| last_name | string | Provider’s last name |
| specialties | string | Provider’s specialties |
| procedures | string | List of procedures the provider performs |
| is_pcp | True/False | Is the provider a PCP |
| credentials | string | Provider’s degrees (e.g. MD, OD, PhD) |
| gender | string | Provider’s gender |
| graduation_year | string | Graduation year |
| medical_school | string | Medical school provider graduated from |
| locations | string | Provider’s known practice locations |
| peer_group | string | HRR/specialty/subspecialty |
Search individual providers based on their location and procedure ID
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| address | string | required | Location |
| procedure_ids | string | required | List of requested procedures |
Response Values: List of providers who match the criteria
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| overall_score | integer | Provider’s main score |
| cost_score | integer | Provider’s cost score |
| quality_score | integer | Provider’s quality score |
| appropriateness_score | integer | Provider’s appropriateness score |
| procedures | string | List of procedure ids |
Search individual providers based on their location and conditions
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| address | string | required | Location |
| condition_ids | string | required | List of requested conditions |
Response Values: List of providers who match the criteria
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| overall_score | integer | Provider’s main score between 1 and 5 |
| cost_score | integer | Provider’s cost score between 1 and 5 |
| quality_score | integer | Provider’s quality score between 1 and 5 |
| appropriateness_score | integer | Provider’s appropriateness score between 1 and 5 |
| condition_ids | string | List of condition ids |
Search individual providers based on their location and Overall Score
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| address | string | required | Location |
| overall_score | integer ( 1 – 5) | required | Provider’s main score |
Response Values: List of providers who have the Overall Score and above
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| overall_score | integer | Provider’s main score between 1 and 5 |
| cost_score | integer | Provider’s cost score between 1 and 5 |
| quality_score | integer | Provider’s quality score between 1 and 5 |
| appropriateness_score | integer | Provider’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
| Parameter | Data Type | Required/Optional | Description |
| zip_code | string | required | Location |
| procedure_id | string | required | Procedure code |
Response Values:
| Name | Data Type | Description |
| zip_code | string | The National Provider Identifier (NPI) |
| procedure | string | Procedure object |
| average_cost | decimal | cost estimate |
Facilities Endpoint
Endpoint: /v1/facilities
Methods: GET
Search for facilities based on NPI
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI) |
Response Values:
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| type | integer | Facility type (i.e. hospital, nursing home, surgery center) |
| name | string | Facility Name |
| overall_score | integer | Facility’s overall score between 1 and 5 |
| cost_score | integer | Facility’s cost score between 1 and 5 |
| quality_score | integer | Facility’s quality score between 1 and 5 |
| appropriateness_score | integer | Facility’s appropriateness score between 1 and 5 |
| state | string | State |
| zip_code | string | zip code |
Search for facilities based on location, type and Overall Score
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| address | string | required | Location |
| type | integer | required | Facility type (i.e. hospital, nursing home, surgery center) |
| overall_score | integer ( 1 – 5) | required | Facility main score |
Response Values: List of facilities that has the overall score and above
| Name | Data Type | Description |
| npi | string | The National Provider Identifier (NPI) |
| type | integer | Facility type (i.e. hospital, nursing home, surgery center) |
| overall_score | integer | Facility main score between 1 and 5 |
| cost_score | integer | Facility’s cost score between 1 and 5 |
| quality_score | integer | Facility’s quality score between 1 and 5 |
| appropriateness_score | integer | Facility’s appropriateness score between 1 and 5 |
| name | string | Facility Name |
| address | string | Facility Address |
| state | string | State |
| zip_code | string | zip code |