GuidesTry Ribbon!

Conduct Network Analysis Based on Geography

Endpoint for analyzing provider networks based on geography

Suggest Edits

Overview

Description: This endpoint allows you to view a provider network across different geographies (i.e. counties).

Endpoint: /v1/network_analysis/

Status: Live -- Please Contact Us to Learn More

Example use-case: In looking to expand to a new region, analyze existing provider networks in the region to understand how best to construct your own.

Diving In

This endpoint allows users to understand the landscape of existing provider networks in a region so they can leverage that information to inform their own network design.

Networks can be viewed on a county basis (i.e. SSA county).

Example Request

Let's look at an example call, where we want to better understand a Cigna Healthspring network (f8825889-58c1-4a61-8e63-e42277aefa5a) in Cook County, Illinois (14141):

curl -X GET \
  'https://api.ribbonhealth.com/v1/network_analysis?insurance_id=f8825889-58c1-4a61-8e63-e42277aefa5a&ssa_codes=14141' \
  -H 'authorization: Bearer your_token'

Example JSON Output

Below, we can see the API response to the call above. The "parameter" section outlines the inputted parameters ("insurance_id" and "ssa_codes") as well as the total unique count of NPIs based on the inputted values ("total_count_npi"):

{
  "parameters": {
    "insurance_id": "f8825889-58c1-4a61-8e63-e42277aefa5a",
    "ssa_codes": [
      "14141"
    ],
    "count_npi": 2103
  },
  "data": [
    {
      "ssa_code": "14141",
      "display": "Cook, IL",
      "count_npi": 2103,
      "npis": [
        1234567890,
        1234567891,
  {...additional records...},
        1234567892,
        1234567893
      ]
    }
  ]

👍

You can input multiple SSA codes if you wish to see the network across multiple counties

The API parameter "ssa_codes" accepts multiple values in a comma separated fashion. If you include multiple SSA codes, you will receive back multiple objects in the response, each corresponding to one county.

For example, see below for the response when two SSA county codes are inputted:

{
  "parameters": {
    "insurance_id": "f8825889-58c1-4a61-8e63-e42277aefa5a",
    "ssa_codes": [
      "14141",
      "14150"
    ],
    "count_npi": 2999
  },
  "data": [
    {
      "ssa_code": "14141",
      "display": "Cook, IL",
      "count_npi": 2103,
      "npis": [
        1234567890,
        1234567891,
  {...additional records...},
        1234567892,
        1234567893
      ]
    },
    {
      "ssa_code": "14150",
      "display": "Crawford, IL",
      "count_npi": 1003,
      "npis": [
        1234567890,
        1234567891,
  {...additional records...},
        1234567892,
        1234567893
      ]
    }
  ]
}

📘

"parameters"."count_npi" is the count of unique NPIs across all inputted counties

The "count_npi" field in the "parameters" section of the JSON response is the count of unique NPIs across inputted counties. Therefore if there are NPIs that exist in multiple counties (as providers practice at multiple locations), "parameters"."count_npi" will only count each NPI once.

However, the "count_npi" field within each county object is the unique count of NPIs only in that county.

Parameters

Below are the available input parameters for this endpoint:

ParameterExample ValueDescription
insurance_idf8825889-58c1-4a61-8e63-e42277aefa5aA unique identifier for a single provider network. To see all available insurance networks, reference the Insurance Endpoint.
ssa_codes14141Comma separated list of SSA codes.
exclude_npisTrueTo change the default setting of displaying the NPIs within each county ("npis"), set this parameter equal to true, and the response will no longer include the NPIs, but will still include the high level counts by county.

Updated 26 days ago