Conditions Endpoint

Overview

Description: The Conditions endpoint allows you to search through conditions treated by providers in the Ribbon API, that are used for both the Focus Areas product and the Condition Cost Estimates product.

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

Status: Live

Example use-case: Display a list of all conditions that a provider may treat. Then use a subset of these conditions to search for relevant providers.

Diving In

You are able to search for conditions in two ways:

❗️

Default Version Control for /conditions/ endpoint

Note: This conditions endpoint is different from the conditions content endpoint.

In order to switch between the two versions of the /conditions/ endpoint, you must include a header variable in your API request:

  • Ribbon-Version = 2021-05-03 for this /conditions/ endpoint
  • Ribbon-Version = 2019-11-19 for the /conditions/ content endpoint (docs)

Depending on your use case, we will set one or the other as your default API version, so you only need to use the header for the non-default use case. Please contact us for more information about this and to make sure your default is set correctly!

Parameters

Below are the parameters accepted at this end point.

📘

Note

You MUST enter a module parameter (see below for accepted values) to indicate which product you are using the conditions reference endpoint for.

Parameter

Description

search

Fuzzy search based on a single string input.

Returns all conditions with a display field related to the search string.

specialty_ids

Exact search of comma-separated values of desired specialty uuids

Returns all conditions that have within them a matching specialty uuid

module

Exact search, accepts single string input

Options:
focus_areas
condition_cost_estimate

Returns conditions objects that have a matching modules field

Example Request

Below is an example searching for 'Depression' related terms for the Focus Areas product.

curl -X GET \
'https://api.ribbonhealth.com/v1/custom/conditions?module=focus_areas&search=depression'
 -H 'authorization: Token <your_token>'

Example JSON Output

This is what we get in return:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
            "uuid": "fd7c10f3-fbec-482a-929b-be94a8bb3bc1",
            "display": "Depression",
            "modules": [
                "focus_areas"
            ],
            "specialties": [
                {
                    "uuid": "afbe1f3a-b8c7-4ed0-864c-52f6811ea662",
                    "display": "Assistant Behavior Analyst"
                },
                {
                    "uuid": "d49c4282-d8f3-4e2d-9761-0e4861081753",
                    "display": "Behavior Technician"
                },
                {
                    "uuid": "002f7b76-337b-413d-9283-2bb11bc1aeeb",
                    "display": "Behavioral Analyst"
                },
                {
                    "uuid": "6d0d1ced-3932-4ee8-8008-9daf30c5a1c5",
                    "display": "Clinical Neuropsychologist"
                },
                {
                    "uuid": "512b8cb3-fcf5-4ff5-bd74-1224144cab45",
                    "display": "Counselor"
                },
                {
                    "uuid": "b9b30b13-90d4-4cfe-a12f-b939e93efa60",
                    "display": "Counselor - Addiction (Substance Use Disorder)"
                },
                {
                    "uuid": "86566aeb-f050-4321-aeb0-1bddfdc32b01",
                    "display": "Counselor - Mental Health"
                },
                {
                    "uuid": "1f93c060-aebe-4d7c-86a4-e869a23af2e2",
                    "display": "Counselor - Pastoral"
                },
                {
                    "uuid": "bfc308a8-cffd-4988-95ae-fa458b199e4b",
                    "display": "Counselor - Professional"
                },
                {
                    "uuid": "18d8ad26-7e5f-44ac-9afa-966efb375344",
                    "display": "Family Medicine"
                },
                {
                    "uuid": "a1539b13-b557-437b-aae4-9ff241171020",
                    "display": "Family Medicine - Adolescent Medicine"
                },
                {
                    "uuid": "ec41ff31-571d-422e-a8b5-806bed6a6c04",
                    "display": "Family Medicine - Adult Medicine"
                },
                {
                    "uuid": "058148f1-3a99-4bbe-9722-6c2a54ddb860",
                    "display": "Family Medicine - Geriatric Medicine"
                },
                {
                    "uuid": "e5047409-3007-4a04-aff9-07604bd10287",
                    "display": "General Practice"
                },
                {
                    "uuid": "475b20fc-c188-4ca1-8e3a-b0614b8f8ce2",
                    "display": "Internal Medicine"
                },
                {
                    "uuid": "31ff2eb3-559e-4b32-88e3-19654457633e",
                    "display": "Internal Medicine - Adolescent Medicine"
                },
                {
                    "uuid": "70da755b-f382-4957-a0d0-cb41b2d45d70",
                    "display": "Internal Medicine - Geriatric Medicine"
                },
                {
                    "uuid": "3e1ebb4c-72c2-4836-8b75-260f83899969",
                    "display": "Marriage and Family Therapist"
                },
                {
                    "uuid": "066e8fe9-45e1-486c-b80f-7b93708bb329",
                    "display": "Nurse Practitioner - Family"
                },
                {
                    "uuid": "74a88d8d-6dcc-45d2-ac9c-5bbff6a2fc6b",
                    "display": "Nurse Practitioner - Gerontology"
                },
                {
                    "uuid": "bf8fb610-7aa8-4ced-b9e1-98d1ec13c2e2",
                    "display": "Nurse Practitioner - Pediatric"
                },
                {
                    "uuid": "5d8058f9-b2c7-4556-8870-22d47b2ec03c",
                    "display": "Nurse Practitioner - Primary Care"
                },
                {
                    "uuid": "c350d7ac-f912-4909-8a3d-7aebd46c5c70",
                    "display": "Nurse Practitioner - Women's Health"
                },
                {
                    "uuid": "d6f8893a-9637-4565-8202-1173e02c0979",
                    "display": "Pediatrics"
                },
                {
                    "uuid": "210f358e-d037-49aa-9891-f1f655fc64ec",
                    "display": "Pediatrics - Adolescent Medicine"
                },
                {
                    "uuid": "7903397e-2fa7-4bc4-a65b-358d9b88d1bd",
                    "display": "Poetry Therapist"
                },
                {
                    "uuid": "4a49b266-75ab-415b-8ccc-9d0e242d37c9",
                    "display": "Psychiatry and Neurology - Addiction Medicine"
                },
                {
                    "uuid": "0e3fda94-4f6f-43f5-bcf0-9a0b28d6f077",
                    "display": "Psychiatry and Neurology - Addiction Psychiatry"
                },
                {
                    "uuid": "62e859df-0e24-4a36-b494-2e009b3be308",
                    "display": "Psychiatry and Neurology - Child and Adolescent Psychiatry"
                },
                {
                    "uuid": "c3586a72-bf12-4c07-9289-860739750f02",
                    "display": "Psychiatry and Neurology - Forensic Psychiatry"
                },
                {
                    "uuid": "ef17471b-08bd-4bc1-a629-41e0116b22cd",
                    "display": "Psychiatry and Neurology - Geriatric Psychiatry"
                },
                {
                    "uuid": "4ed7a651-e44e-4848-89e5-ae40a5e3c824",
                    "display": "Psychiatry and Neurology - Hospice and Palliative Medicine"
                },
                {
                    "uuid": "bca4c122-677c-485b-b8d2-7a39f93aa9db",
                    "display": "Psychiatry and Neurology - Obesity Medicine"
                },
                {
                    "uuid": "c741df78-8460-46f6-a2ce-93de36eb7205",
                    "display": "Psychiatry and Neurology - Psychiatry"
                },
                {
                    "uuid": "b3640eb5-d87a-4f13-bb86-e6ca56525415",
                    "display": "Psychiatry and Neurology - Psychosomatic Medicine"
                },
                {
                    "uuid": "39148d52-5389-4d6a-9fa6-b1d09a0ab56f",
                    "display": "Psychoanalyst"
                },
                {
                    "uuid": "adfb5cae-37f0-4472-a92f-5448c0ff3d66",
                    "display": "Psychologist"
                },
                {
                    "uuid": "d180bfa0-434a-49e9-87ee-8f9c698578dc",
                    "display": "Psychologist - Addiction (Substance Use Disorder)"
                },
                {
                    "uuid": "07ba6ad7-5b77-4615-bfae-00966ca2639c",
                    "display": "Psychologist - Adult Development and Aging"
                },
                {
                    "uuid": "be90c33a-6e02-4267-b5e3-d3b3c3a1426f",
                    "display": "Psychologist - Clinical"
                },
                {
                    "uuid": "31c810b6-cf1f-44dc-af23-f63b91b3710f",
                    "display": "Psychologist - Clinical Child and Adolescent"
                },
                {
                    "uuid": "dabcc541-1119-4c4a-b7d9-b3d25caf6a68",
                    "display": "Psychologist - Cognitive and Behavioral"
                },
                {
                    "uuid": "c344f313-9821-4e8a-a787-4346e1362af2",
                    "display": "Psychologist - Counseling"
                },
                {
                    "uuid": "e8a997a2-d9b7-49f6-b39a-9371c7d5e1f5",
                    "display": "Psychologist - Educational"
                },
                {
                    "uuid": "eef0601c-403f-49eb-ac40-9acef1277f08",
                    "display": "Psychologist - Exercise and Sports"
                },
                {
                    "uuid": "3d5df1db-6308-42a0-8c57-2761cfd0af56",
                    "display": "Psychologist - Family"
                },
                {
                    "uuid": "5fd7f294-d110-452c-9a33-1b4ef642abbf",
                    "display": "Psychologist - Forensic"
                },
                {
                    "uuid": "6b1f70f9-b51f-4db5-b592-68550dbdca4d",
                    "display": "Psychologist - Group Psychotherapy"
                },
                {
                    "uuid": "6893a711-ca46-4452-99ad-caa372bb0006",
                    "display": "Psychologist - Health"
                },
                {
                    "uuid": "ebfa91da-d8f7-478c-89f8-44419da9293a",
                    "display": "Psychologist - Health Service"
                },
                {
                    "uuid": "8802f445-d602-483b-a0b9-d5005c0fb62d",
                    "display": "Psychologist - Men and Masculinity"
                },
                {
                    "uuid": "0e5590eb-96da-4d86-a8c6-690a267406c4",
                    "display": "Psychologist - Mental Retardation and Developmental Disabilities"
                },
                {
                    "uuid": "4bc9c349-cca4-489e-b5f4-2d63a6eb56a1",
                    "display": "Psychologist - Prescribing (Medical)"
                },
                {
                    "uuid": "55b29b01-05d5-4f1d-bd37-a5ccd2f3d22f",
                    "display": "Psychologist - Psychoanalysis"
                },
                {
                    "uuid": "1de9dfac-98b8-4f2d-bbff-bb5a20b32ead",
                    "display": "Psychologist - Psychotherapy"
                },
                {
                    "uuid": "ab64dfbf-11b8-4f75-8a66-590c11e85fdc",
                    "display": "Psychologist - Rehabilitation"
                },
                {
                    "uuid": "719c1157-6b74-45f1-9137-0e096f3730be",
                    "display": "Psychologist - Women"
                },
                {
                    "uuid": "cfe6a8b1-6b0a-48d7-ad40-8c2ac1f288b5",
                    "display": "Social Worker"
                },
                {
                    "uuid": "11d9c64b-1139-4670-b927-5d2a33d1e4b0",
                    "display": "Social Worker - Clinical"
                }
            ]
        },
    {
            "uuid": "99f4762e-c4c2-4d1d-983a-2b8b303e691d",
            "display": "Chronic Depression",
            "modules": [
                "focus_areas"
            ],
            "specialties": [
                {
                    "uuid": "afbe1f3a-b8c7-4ed0-864c-52f6811ea662",
                    "display": "Assistant Behavior Analyst"
                },
                {
                    "uuid": "d49c4282-d8f3-4e2d-9761-0e4861081753",
                    "display": "Behavior Technician"
                },
                {
                    "uuid": "002f7b76-337b-413d-9283-2bb11bc1aeeb",
                    "display": "Behavioral Analyst"
                },
                {
                    "uuid": "6d0d1ced-3932-4ee8-8008-9daf30c5a1c5",
                    "display": "Clinical Neuropsychologist"
                },
                {
                    "uuid": "512b8cb3-fcf5-4ff5-bd74-1224144cab45",
                    "display": "Counselor"
                },
                {
                    "uuid": "b9b30b13-90d4-4cfe-a12f-b939e93efa60",
                    "display": "Counselor - Addiction (Substance Use Disorder)"
                },
                {
                    "uuid": "86566aeb-f050-4321-aeb0-1bddfdc32b01",
                    "display": "Counselor - Mental Health"
                },
                {
                    "uuid": "1f93c060-aebe-4d7c-86a4-e869a23af2e2",
                    "display": "Counselor - Pastoral"
                },
                {
                    "uuid": "bfc308a8-cffd-4988-95ae-fa458b199e4b",
                    "display": "Counselor - Professional"
                },
                {
                    "uuid": "3e1ebb4c-72c2-4836-8b75-260f83899969",
                    "display": "Marriage and Family Therapist"
                },
                {
                    "uuid": "7903397e-2fa7-4bc4-a65b-358d9b88d1bd",
                    "display": "Poetry Therapist"
                },
                {
                    "uuid": "4a49b266-75ab-415b-8ccc-9d0e242d37c9",
                    "display": "Psychiatry and Neurology - Addiction Medicine"
                },
                {
                    "uuid": "0e3fda94-4f6f-43f5-bcf0-9a0b28d6f077",
                    "display": "Psychiatry and Neurology - Addiction Psychiatry"
                },
                {
                    "uuid": "62e859df-0e24-4a36-b494-2e009b3be308",
                    "display": "Psychiatry and Neurology - Child and Adolescent Psychiatry"
                },
                {
                    "uuid": "c3586a72-bf12-4c07-9289-860739750f02",
                    "display": "Psychiatry and Neurology - Forensic Psychiatry"
                },
                {
                    "uuid": "ef17471b-08bd-4bc1-a629-41e0116b22cd",
                    "display": "Psychiatry and Neurology - Geriatric Psychiatry"
                },
                {
                    "uuid": "4ed7a651-e44e-4848-89e5-ae40a5e3c824",
                    "display": "Psychiatry and Neurology - Hospice and Palliative Medicine"
                },
                {
                    "uuid": "bca4c122-677c-485b-b8d2-7a39f93aa9db",
                    "display": "Psychiatry and Neurology - Obesity Medicine"
                },
                {
                    "uuid": "c741df78-8460-46f6-a2ce-93de36eb7205",
                    "display": "Psychiatry and Neurology - Psychiatry"
                },
                {
                    "uuid": "b3640eb5-d87a-4f13-bb86-e6ca56525415",
                    "display": "Psychiatry and Neurology - Psychosomatic Medicine"
                },
                {
                    "uuid": "39148d52-5389-4d6a-9fa6-b1d09a0ab56f",
                    "display": "Psychoanalyst"
                },
                {
                    "uuid": "adfb5cae-37f0-4472-a92f-5448c0ff3d66",
                    "display": "Psychologist"
                },
                {
                    "uuid": "d180bfa0-434a-49e9-87ee-8f9c698578dc",
                    "display": "Psychologist - Addiction (Substance Use Disorder)"
                },
                {
                    "uuid": "07ba6ad7-5b77-4615-bfae-00966ca2639c",
                    "display": "Psychologist - Adult Development and Aging"
                },
                {
                    "uuid": "be90c33a-6e02-4267-b5e3-d3b3c3a1426f",
                    "display": "Psychologist - Clinical"
                },
                {
                    "uuid": "31c810b6-cf1f-44dc-af23-f63b91b3710f",
                    "display": "Psychologist - Clinical Child and Adolescent"
                },
                {
                    "uuid": "dabcc541-1119-4c4a-b7d9-b3d25caf6a68",
                    "display": "Psychologist - Cognitive and Behavioral"
                },
                {
                    "uuid": "c344f313-9821-4e8a-a787-4346e1362af2",
                    "display": "Psychologist - Counseling"
                },
                {
                    "uuid": "e8a997a2-d9b7-49f6-b39a-9371c7d5e1f5",
                    "display": "Psychologist - Educational"
                },
                {
                    "uuid": "eef0601c-403f-49eb-ac40-9acef1277f08",
                    "display": "Psychologist - Exercise and Sports"
                },
                {
                    "uuid": "3d5df1db-6308-42a0-8c57-2761cfd0af56",
                    "display": "Psychologist - Family"
                },
                {
                    "uuid": "5fd7f294-d110-452c-9a33-1b4ef642abbf",
                    "display": "Psychologist - Forensic"
                },
                {
                    "uuid": "6b1f70f9-b51f-4db5-b592-68550dbdca4d",
                    "display": "Psychologist - Group Psychotherapy"
                },
                {
                    "uuid": "6893a711-ca46-4452-99ad-caa372bb0006",
                    "display": "Psychologist - Health"
                },
                {
                    "uuid": "ebfa91da-d8f7-478c-89f8-44419da9293a",
                    "display": "Psychologist - Health Service"
                },
                {
                    "uuid": "8802f445-d602-483b-a0b9-d5005c0fb62d",
                    "display": "Psychologist - Men and Masculinity"
                },
                {
                    "uuid": "0e5590eb-96da-4d86-a8c6-690a267406c4",
                    "display": "Psychologist - Mental Retardation and Developmental Disabilities"
                },
                {
                    "uuid": "4bc9c349-cca4-489e-b5f4-2d63a6eb56a1",
                    "display": "Psychologist - Prescribing (Medical)"
                },
                {
                    "uuid": "55b29b01-05d5-4f1d-bd37-a5ccd2f3d22f",
                    "display": "Psychologist - Psychoanalysis"
                },
                {
                    "uuid": "1de9dfac-98b8-4f2d-bbff-bb5a20b32ead",
                    "display": "Psychologist - Psychotherapy"
                },
                {
                    "uuid": "ab64dfbf-11b8-4f75-8a66-590c11e85fdc",
                    "display": "Psychologist - Rehabilitation"
                },
                {
                    "uuid": "719c1157-6b74-45f1-9137-0e096f3730be",
                    "display": "Psychologist - Women"
                },
                {
                    "uuid": "cfe6a8b1-6b0a-48d7-ad40-8c2ac1f288b5",
                    "display": "Social Worker"
                },
                {
                    "uuid": "11d9c64b-1139-4670-b927-5d2a33d1e4b0",
                    "display": "Social Worker - Clinical"
                }
            ]
        }
  ]
}