GuidesTry Ribbon!

Estimate Costs for a Procedure

Endpoint for estimating costs associated with a given procedure / procedure bundle

Suggest Edits

Overview

Description: The procedure cost estimate endpoint calculates estimated costs for a given procedure based on a user's location.

Endpoint: /v1/procedure_cost_estimate and /v1/procedures

Status: Live -- Please Contact Us to Learn More

Example use-case: Estimate the cost of a knee replacement surgery for a user in Boston so they can plan their personal finances accordingly.

Diving In

Use this endpoint to show users cost estimates across the most common "shoppable" procedures.

Example Request

See below for an example API request. Parameters include procedure_ids and member_zip.

curl -X GET \
  'https://api.ribbonhealth.com/v1/procedure_cost_estimate?
  procedure_ids=00000000-0000-0000-0000-000000000000
      &member_zip=10011' \
  -H 'authorization: Token your_token'

Example JSON Output

See below for an example JSON output for the call above. Median, minimum, and maximum values are displayed for the procedure's cost estimation.

{
    "parameters": {
        "procedures": [
            {
                "uuid": "00000000-0000-0000-0000-000000000000",
                "display": "MRI scan of lower spinal canal"
            }
        ],
        "member_zip": "60606"
    },
    "data": {
        "cost_estimates": {
            "minimum": 100.00,
            "median": 300.00,
            "maximum": 500.00
        }
    }
}

Reference Endpoint - /v1/procedures

🚧

Leverage the /v1/procedures endpoint to search for and see all relevant CPT codes for a procedure or bundle.

Example Request:

Request to list procedures

curl -X GET \
  'https://api.ribbonhealth.com/v1/procedures \
  -H 'authorization: Token your_token'

Request to view a single procedure detail

curl -X GET \
  'https://api.ribbonhealth.com/v1/procedures/00000000-0000-0000-0000-000000000000\
  -H 'authorization: Token your_token'

Sample JSON Output:

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "display": "MRI scan of lower spinal canal",
    "procedure_code_count": 1,
    "procedure_codes" : [
        {
            "code": "72148",
            "type": "CPT",
            "description": "MRI scan of lower spinal canal"
         }
    ]
}

❗️

Search Across Available Procedures - Coming Soon!

In the future, you will be able to leverage the "search" parameter at the /procedures/ endpoint to search for supported procedures. This parameter will conduct a 'fuzzy' search across the "display" fields for each procedure.

Please let us know if this is a priority for testing!

Updated 5 months ago