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

  1. Providers
  2. Facilities
  3. Groups
  4. Experience
  5. 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.

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: /v2/providers
Methods: GET

Search individual providers based on their NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)

Response Values: Provider Data

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
namestringProvider’s full name
overall_quality_scorefloatProvider’s overall quality score between 1 and 5
cost_effeciency_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: /v2/facilities
Methods: GET

Search for facilities based on NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)

Response Values:

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
typeintegerFacility type (i.e. hospital, nursing home, surgery center)
namestringFacility Name
overall_quality_scorefloatFacility’s overall quality score between 1 and 5
cost_effeciency_scoreintegerFacility’s cost effeciency 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: /v2/groups
Methods: GET

Search for groups based on NPI

ParameterData TypeRequired/OptionalDescription
npistringrequiredThe National Provider Identifier (NPI)

Response Values:

NameData TypeDescription
npistringThe National Provider Identifier (NPI)
namestringGroup Name
overall_quality_scorefloatGroup’s overall quality score between 1 and 5
cost_effeciency_scoreintegerGroup’s cost effeciency 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: /v2/experience
Methods: GET

Search provider experience based on procedure code and location 

ParameterData TypeRequired/OptionalDescription
procedure_codestringrequiredProcedure CPT code
latitudefloatrequiredLatitude of desired location
longitudefloatrequiredLongitude of desired location
radiusintegeroptional (default is 10)Distance in miles

Response Values: List of providers who match the criteria

NameData TypeDescription
provider_listarray of objectsJSON list of provider objects (maximum 10)

 

Insights Endpoint

Endpoint: /v2/insights
Methods: GET

Search provider insights based on user type 

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

Response Values: List of providers who match the criteria

NameData TypeDescription
insightsstringChatGPT 4.0 generated interpretation of provider scores and metrics in layman’s terms