The HealthCorum API (Application Programming Interface) allows our partners to access HealthCorum data for:

  1. Providers – Individual physicians
  2. Facilities – Acute care facilities, skilled nursing facilities (SNF) and ambulatory surgery centers (ASC)
  3. Groups – Single or multi specialty group practices
  4. Experience – Matching CCS, CPT and DRG codes to individual providers and facilities
  5. 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
  6. 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.

Request Structure

The API is accessed through GET requests.

 API End Point

https://healthcorumnow.com/api/

API List:

Providers Endpoint

Endpoint: /v3/providers
Methods: GET

Search individual providers based on their NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma separated format
lower_limitdecimaloptionalLimits the response from our API to the providers with the quality score above or equal to the limit value

Response Values: JSON Array

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_quality_scoredecimalProvider’s overall quality score between 1 and 5
cost_efficiency_scoreintegerProvider’s cost efficiency score between 1 and 5
effectiveness_scoreintegerProvider’s effectiveness score between 1 and 5
appropriateness_scoreintegerProvider’s appropriateness score  between 1 and 5

 

Facilities Endpoint

Endpoint: /v3/facilities
Methods: GET

Search for facilities based on NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format
lower_limitdecimaloptionalLimits the response from our API to the facilities with the quality score above or equal to the limit value

Response Values: JSON Array

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
facility_typeintegerFacility type (i.e. hospital, nursing home, surgery center)
overall_quality_scoredecimalFacility’s overall quality score between 1 and 5
cost_efficiency_scoreintegerFacility’s cost efficiency score between 1 and 5
effectiveness_scoreintegerFacility’s effectiveness score between 1 and 5
appropriateness_scoreintegerFacility’s appropriateness score between 1 and 5

 

Groups Endpoint

Endpoint: /v3/groups
Methods: GET

Search for groups based on NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format
lower_limitdecimaloptionalLimits the response from our API to the provider groups with the quality score above or equal to the limit value

Response Values: JSON Array

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
overall_quality_scoredecimalGroup’s overall quality score between 1 and 5
cost_efficiency_scoreintegerGroup’s cost efficiency score between 1 and 5
effectiveness_scoreintegerGroup’s effectiveness score between 1 and 5
appropriateness_scoreintegerGroup’s appropriateness score between 1 and 5

 

Experience Endpoint

Endpoint: /v3/experience
Methods: GET

Search provider experience based on procedure code and location 

ParameterData TypeRequired/OptionalDescription
codestringrequiredCCS, CPT or DRG code
code_typeintegerrequiredCCS(1), CPT(2) for physican search and DRG(3) for facility search.
latitudefloatrequiredLatitude of desired location
longitudefloatrequiredLongitude of desired location
distanceintegeroptional (default is 10)Distance in miles

Response Values: JSON Array

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
servicesintegerCount of services performed by provider within a year

 

Insights Endpoint

Endpoint: /v3/insights
Methods: GET

Search provider insights based on NPI and user type 

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)
user_typeintegeroptional, default is 41-Clinician, 2-Referral Manager, 3-Care Navigator, 4-Patient, 5-Network Manager

Response Values: List of providers who match the criteria

NameData TypeDescription
descriptionstringSummarized 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 

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI), up to 20 within a single call can be passed in a comma seperated format
file_typestringoptional, default is PNG‘PNG’ or ‘PDF’. Default is ‘PNG’

Response Values: List of providers who match the criteria

NameData TypeDescription
linkstringTime limited URL link to the provider scorecard