Treatments Endpoint

Overview

Description: The Treatments endpoint allows you to search through the treatments objects available within the Ribbon API.

Endpoint: /v1/custom/treatments/{uuid}

Status: Live

Methods: GET

Example use-case: Identify a list of treatments related to a search term. Then, use that list to inform a search in the custom providers endpoint.

Diving In

You are able to search for treatments in two ways:

Fuzzy search by name
Exact search of comma-separated values for related specialties

Parameters

Parameter	Description	Example
`search`	Fuzzy search based on a single string input. Returns any treatments with a `display` field related to the search term.	Ankle X-Ray
`specialty_ids`	Exact search of comma-separated values of desired specialty uuids Returns all treatments that have within them a matching specialty uuid	fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5,44b0284c-f360-4312-a17d-d601651cb0ea
`type`	Returns only treatments that are associated with the given type. For example, `type:locations` would return only treatments associated with at least one location. options: `providers` or `locations` can only be a single option (no lists) Defaults to returning all treatments of any type	locations

Example Request

For example we can search for treatments related to knee surgery with search = knee:

curl -X GET \
'https://api.ribbonhealth.com/v1/custom/treatments?search=knee
 -H 'authorization: Bearer <your_token>'

Example JSON Output

{
    "count": 3,
    "next": null,
    "previous": null,
    "parameters": {
        "search": "knee"
    },
    "results": [
        {
            "uuid": "88a70b34-d0a7-47e2-89ac-4fed203eca2f",
            "display": "Knee Replacement",
            "type": ["providers", "locations"],
            "specialties": [
                {
                    "uuid": "b942991d-777e-4d1c-9e43-12ea6cff0a51",
                    "display": "Orthopaedic Surgery"
                },
                {
                    "uuid": "15eda355-f5e5-44f1-86d2-00b9fec264a3",
                    "display": "Orthopaedic Surgery - Adult Reconstructive"
                },
                {
                    "uuid": "3d923785-c42d-48c2-9962-31bd9860cd79",
                    "display": "Orthopaedic Surgery - Foot and Ankle"
                },
                {
                    "uuid": "7e817eec-465e-4668-9e75-19c9f72e0674",
                    "display": "Orthopaedic Surgery - Hand"
                },
                {
                    "uuid": "09d96cba-1a55-4440-9b40-ce7b162654a1",
                    "display": "Orthopaedic Surgery - Spine"
                },
                {
                    "uuid": "ffbc61e5-92dd-405f-8c38-c26b001eac38",
                    "display": "Orthopaedic Surgery - Sports Medicine"
                },
                {
                    "uuid": "66df60de-a121-4368-b6eb-3a6ed4e7a34c",
                    "display": "Orthopaedic Surgery - Trauma"
                },
                {
                    "uuid": "0e129489-a302-4f65-bb53-05d2d657d1b2",
                    "display": "Pediatric Orthopaedic Surgery"
                },
                {
                    "uuid": "a848aa7d-fe33-4bc8-a17f-ae56290f7753",
                    "display": "Surgery - Hand"
                }
            ]
        },
        {
            "uuid": "0df1dfd8-790a-4081-9144-654e345c5043",
            "display": "Knee Scope",
            "specialties": [
                {
                    "uuid": "b942991d-777e-4d1c-9e43-12ea6cff0a51",
                    "display": "Orthopaedic Surgery"
                },
                {
                    "uuid": "15eda355-f5e5-44f1-86d2-00b9fec264a3",
                    "display": "Orthopaedic Surgery - Adult Reconstructive"
                },
                {
                    "uuid": "3d923785-c42d-48c2-9962-31bd9860cd79",
                    "display": "Orthopaedic Surgery - Foot and Ankle"
                },
                {
                    "uuid": "7e817eec-465e-4668-9e75-19c9f72e0674",
                    "display": "Orthopaedic Surgery - Hand"
                },
                {
                    "uuid": "09d96cba-1a55-4440-9b40-ce7b162654a1",
                    "display": "Orthopaedic Surgery - Spine"
                },
                {
                    "uuid": "ffbc61e5-92dd-405f-8c38-c26b001eac38",
                    "display": "Orthopaedic Surgery - Sports Medicine"
                },
                {
                    "uuid": "66df60de-a121-4368-b6eb-3a6ed4e7a34c",
                    "display": "Orthopaedic Surgery - Trauma"
                },
                {
                    "uuid": "0e129489-a302-4f65-bb53-05d2d657d1b2",
                    "display": "Pediatric Orthopaedic Surgery"
                },
                {
                    "uuid": "a848aa7d-fe33-4bc8-a17f-ae56290f7753",
                    "display": "Surgery - Hand"
                }
            ]
        },
        {
            "uuid": "1e29cf84-2d15-420a-8383-019928fd1c41",
            "display": "Knee X-ray",
            "specialties": [
                {
                    "uuid": "b942991d-777e-4d1c-9e43-12ea6cff0a51",
                    "display": "Orthopaedic Surgery"
                },
                {
                    "uuid": "15eda355-f5e5-44f1-86d2-00b9fec264a3",
                    "display": "Orthopaedic Surgery - Adult Reconstructive"
                },
                {
                    "uuid": "3d923785-c42d-48c2-9962-31bd9860cd79",
                    "display": "Orthopaedic Surgery - Foot and Ankle"
                },
                {
                    "uuid": "7e817eec-465e-4668-9e75-19c9f72e0674",
                    "display": "Orthopaedic Surgery - Hand"
                },
                {
                    "uuid": "09d96cba-1a55-4440-9b40-ce7b162654a1",
                    "display": "Orthopaedic Surgery - Spine"
                },
                {
                    "uuid": "ffbc61e5-92dd-405f-8c38-c26b001eac38",
                    "display": "Orthopaedic Surgery - Sports Medicine"
                },
                {
                    "uuid": "66df60de-a121-4368-b6eb-3a6ed4e7a34c",
                    "display": "Orthopaedic Surgery - Trauma"
                },
                {
                    "uuid": "0e129489-a302-4f65-bb53-05d2d657d1b2",
                    "display": "Pediatric Orthopaedic Surgery"
                },
                {
                    "uuid": "a848aa7d-fe33-4bc8-a17f-ae56290f7753",
                    "display": "Surgery - Hand"
                }
            ]
        }
    ]
}