Clinical Areas Endpoint
Overview
Description: The Clinical Areas endpoint allows you to search through clinical areas available in the Ribbon API using related specialties (taxonomy defined by NPPES), conditions, and treatments that are associated with those clinical areas.
Endpoint: /v1/custom/clinical_areas/{uuid}
Status: Live
Methods: GET
Example use-case: Display a list of all Clinical Areas available in the Ribbon API related to a specific specialty, condition, or treatment - then use a subset of these conditions to search for relevant providers in your custom provider's index.
Diving In
We can use the search parameters to perform a fuzzy search against the key fields in each clinical_area object to return the most relevant options. We can also use the ID fields to find the clinical areas associated with specific specialties, conditions, or treatments.
A note about multiple search terms
Currently, this endpoint only supports the use of one parameter at a time. Within a parameter that accepts multiple inputs (
condition_ids,treatment_ids, andspecialty_ids) the endpoint performs an OR search, returning any results matchingclinical_area.
Search Parameters
| Parameter | Description | Example |
|---|---|---|
search | Fuzzy search based on a single string input Returns all clinical_areas objects with a matching display field for either the clinical area or display of any of the associated treatment or condition display fields. | X-ray |
clinical_area | Fuzzy search based on a single string input Returns all clinical_areas objects with a matching display field. | Nutrition |
specialty_ids | Exact search of comma-separated values of desired specialty uuids Returns all clinical_areas that have within them a matching specialty uuid | fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5,44b0284c-f360-4312-a17d-d601651cb0ea |
condition | Fuzzy search based on a single string input Returns all clinical_areas objects within them an associated condition that has a matching condition.display field. | Sleep Disorders |
condition_ids | Exact search of comma-separated values of desired condition uuids. Returns all clinical_areas that have within them a matching condition uuid within the clinical_areas’ condition list | 45c9a22c-7a0f-4405-b0c9-c5f8ad83ba32,219d3998-d7e2-4b9e-91d1-17c19cd0bbc2 |
treatment | Fuzzy search based on a single string input Returns all clinical_areas objects within them an associated treatment object within it that has a matching treatments.display field. | ACL Surgery |
treatment_ids | Exact search of comma-separated values of desired treatments uuids. Returns all clinical_areas that have within them a matching treatments uuid within the clinical_areas’ treatments list | bb2ca22c-7a0f-4405-b0c9-c5f8ad839898,2ce33998-d7e2-4b9e-91d1-17c19cd06012 |
type | Returns only clinical_areas that are associated with the given type. For example, type:locations would return only clinical_areas associated with at least one location.Options: providers or locationscan only be a single option (no lists) Defaults to returning all clinical areas of any type | providers |
Example Request
For example, we can use the treatment parameter to search for treatments related to addiction:
curl -X GET \
'https://api.ribbonhealth.com/v1/custom/clinical_areas?treatment=addiction'
-H 'authorization: Bearer <your_token>'
Example JSON Output
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"uuid": "f352b596-dfb0-494f-9a03-224794f5d182",
"display": "Substance Disorders (e.g. Opioid, Cocaine, Alcohol)",
"types": ["providers", "locations"],
"conditions": [
{
"uuid": "7df908f7-55d8-424e-ae6d-9bc13161149f",
"display": "Cocaine Addiction"
},
{
"uuid": "fc76f542-508b-4b79-8b95-9be000168a9f",
"display": "Alcohol Addiction"
},
{
"uuid": "f2895266-3371-4707-ab25-b9ba1c9930c7",
"display": "Substance Abuse"
},
{
"uuid": "74034fb4-01ba-47ef-a23b-4f0a5c6ba47a",
"display": "Medication Addiction"
},
{
"uuid": "6a38eda7-eb05-483f-ad1e-afea81b5e7e9",
"display": "Opioid Addiction"
},
{
"uuid": "27d2a62c-0757-48e8-9a48-cae0d11369f0",
"display": "Drug Addiction"
},
{
"uuid": "f2f79c5d-ba31-4c9a-9362-bba7b30c4829",
"display": "Marijuana Addiction"
}
],
"treatments": [
{
"uuid": "78d9d0aa-e701-4d36-9076-eb47f0cb9c8a",
"display": "Drug Test"
},
{
"uuid": "1553678b-e7a1-43ee-be80-bf69c73dc2be",
"display": "Treatment Of Addiction (e.g. Opioid, Alcohol, Cocaine)"
}
],
"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"
}
]
}
]
}
Updated 26 days ago