The HealthCorum API (Application Programming Interface) allows our partners to access the HealthCorum insights for:
- Providers
- Facilities
- Groups
- Experience
- Insights
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: /v2/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) |
| name | string | Provider’s full name |
| overall_quality_score | integer | Provider’s overall quality score between 1 and 5 |
| cost_effeciency_score | integer | Provider’s cost efficiency score between 1 and 5 |
| effectiveness_score | integer | Provider’s effectiveness score between 1 and 5 |
| appropriateness_score | integer | Provider’s appropriateness score between 1 and 5 |
Facilities Endpoint
Endpoint: /v2/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_quality_score | integer | Facility’s overall quality score between 1 and 5 |
| cost_effeciency_score | integer | Facility’s cost effeciency score between 1 and 5 |
| effectiveness_score | integer | Facility’s effectiveness score between 1 and 5 |
| appropriateness_score | integer | Facility’s appropriateness score between 1 and 5 |
Groups Endpoint
Endpoint: /v2/groups
Methods: GET
Search for groups 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) |
| name | string | Group Name |
| overall_quality_score | integer | Group’s overall quality score between 1 and 5 |
| cost_effeciency_score | integer | Group’s cost effeciency score between 1 and 5 |
| effectiveness_score | integer | Group’s effectiveness score between 1 and 5 |
| appropriateness_score | integer | Group’s appropriateness score between 1 and 5 |
Experience Endpoint
Endpoint: /v2/experience
Methods: GET
Search provider experience based on procedure code and location
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| procedure_code | string | required | Procedure CPT code |
| latitude | float | required | Latitude of desired location |
| longitude | float | required | Longitude of desired location |
| radius | integer | optional (default is 10) | Distance in miles |
Response Values: List of providers who match the criteria
| Name | Data Type | Description |
| provicer_list | array of objects | JSON list of provider objects (maximum 10) |
Insights Endpoint
Endpoint: /v2/insights
Methods: GET
Search provider insights based on user type
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI) |
| user_type | integer | optional, default is 2 | 1-Clinician, 2-Referral Manager, 3-Care Navigator, 4-Patient, 5-Network Manager |
Response Values: List of providers who match the criteria
| Name | Data Type | Description |
| insights | string | ChatGPT 4.0 generated interpretation of provider scores and metrics in layman’s terms |