APIs
The HealthCorum API (Application Programming Interface) allows our partners to access HealthCorum data for:
- Providers – Individual physicians
- Facilities – Acute care facilities, skilled nursing facilities (SNF) and ambulatory surgery centers (ASC)
- Groups – Single or multi specialty group practices
- Experience – Matching CCS, CPT and DRG codes to individual providers and facilities
- Insights – HealthCorum generative AI model distills provider scores and metrics into text, written in layman’s terms, enabling patients and care navigators to obtain a deeper level of understanding on the providers they are considering
- Scorecards – Detailed scorecard image for individual providers
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.
Our API infrastructure is completely supported by our company security and privacy policies, which are compliant with SOC2 and HIPAA standards.
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: /v3/providers
Methods: GET
Search individual providers based on their NPI
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma separated format |
| lower_limit | decimal | optional | Limits the response from our API to the providers with the quality score above or equal to the limit value |
Facilities Endpoint
Endpoint: /v3/facilities
Methods: GET
Search for facilities based on NPI
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format |
| lower_limit | decimal | optional | Limits the response from our API to the facilities with the quality score above or equal to the limit value |
Response Values (JSON Array)
| Name | Data Type | Description |
|---|---|---|
| npi | string | The National Provider Identifier (NPI) |
| facility_type | integer | Facility type (i.e. hospital, nursing home, surgery center) |
| overall_quality_score | decimal | Facility's overall quality score between 1 and 5 |
| cost_efficiency_score | integer | Facility's cost efficiency 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: /v3/groups
Methods: GET
Search for groups based on NPI
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format |
| lower_limit | decimal | optional | Limits the response from our API to the provider groups with the quality score above or equal to the limit value |
Response Values (JSON Array)
| Name | Data Type | Description |
|---|---|---|
| npi | string | The National Provider Identifier (NPI) |
| overall_quality_score | decimal | Group's overall quality score between 1 and 5 |
| cost_efficiency_score | integer | Group's cost efficiency 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: /v3/experience
Methods: GET
Search provider experience based on procedure code and location
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| code | string | required | CCS, CPT or DRG code |
| code_type | integer | required | CCS(1), CPT(2) for physician search and DRG(3) for facility search |
| latitude | float | required | Latitude of desired location |
| longitude | float | required | Longitude of desired location |
| distance | integer | optional (default 10) | Distance in miles |
Response Values (JSON Array)
| Name | Data Type | Description |
|---|---|---|
| npi | string | The National Provider Identifier (NPI) |
| services | integer | Count of services performed by provider within a year |
Insights Endpoint
Endpoint: /v3/insights
Methods: GET
Search provider insights based on NPI and user type
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI) |
| user_type | integer | optional, default is 4 | 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 |
|---|---|---|
| description | string | Summarized description of provider scores and practice patterns, tailored for the selected user type |
Scorecards Endpoint
Endpoint: /v3/scorecards
Methods: GET
Search provider scorecards based on NPI and file format
| Parameter | Data Type | Required/Optional | Description |
|---|---|---|---|
| npi | string | required | The National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format |
| file_type | string | optional, default is PNG | 'PNG' or 'PDF'. Default is 'PNG' |
Response Values: List of providers who match the criteria
| Name | Data Type | Description |
|---|---|---|
| link | string | Time limited URL link to the provider scorecard |