Procedures Endpoint

Overview

Description: This endpoint allows you to search through procedures that exist within the Ribbon API.

Endpoint: /v1/procedures

Status: Live

Example use-case: Creating a drop down list of procedures, which you power through GET requests to this endpoint, or facilitating search for a specific procedure by name or by billing code (e.g., CPT).

Search Parameters

Parameter	Type	Description	Example
`search`	`string`	Fuzzy search across the information in the procedure `display` `carrier_name`, and `uuid` fields.	Arm
`procedure_code`	`string`	Filter to the procedure that includes a specific billing code (e.g., CPT, DRG)	73222

Example Requests: List All Procedures and Procedure UUID Detail

You can make a basic GET request to list procedures:

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

Specifying a specific UUID in the reference will provide detail for a single procedure:

curl -X GET \
  'https://api.ribbonhealth.com/v1/procedures/0a9a245f-2f52-4cc0-a5c3-77a811acc6f7 \
  -H 'authorization: Token your_token'

Sample JSON output:

{
    "uuid": "0a9a245f-2f52-4cc0-a5c3-77a811acc6f7",
    "display": "MRI, arm",
    "procedure_code_count": 7,
    "procedure_codes": [
        {
            "code": "73222",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73219",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73218",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73221",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73220",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73225",
            "type": "CPT",
            "description": "MRI, arm"
        },
        {
            "code": "73223",
            "type": "CPT",
            "description": "MRI, arm"
        }
    ]
}

Example Requests: Searching the Procedures Reference

This reference can be searched, either through procedure_code to look up the procedure for a specific code, or through search to conduct a fuzzy search across both procedure codes and display names

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

Sample JSON output:

{
    "count": 6,
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "ebcfdb25-0103-4259-a397-eda8fbcca6c0",
            "display": "Arm muscle / tendon repair"
        },
        {
            "uuid": "f791ef79-f32b-4617-aa6f-a96f946f6447",
            "display": "CT, arm"
        },
        {
            "uuid": "0a9a245f-2f52-4cc0-a5c3-77a811acc6f7",
            "display": "MRI, arm"
        },
        {
            "uuid": "71cd12a4-af39-4ca7-93a8-f8cc62ef3025",
            "display": "X-ray, arm (infant)"
        },
        {
            "uuid": "53ccf0c4-8cf1-4aef-a842-309b92d1e3a7",
            "display": "Application of arm splint"
        },
        {
            "uuid": "56568606-7e03-4913-8f15-edb468bf2e8b",
            "display": "Compression wrapping for arm or leg ulcers"
        }
    ]
}