{ "opencollection": "1.0.0", "info": { "name": "ribbon-health Cost Estimates Focus Area Endpoints API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Focus Area Endpoints", "type": "folder" }, "items": [ { "info": { "name": "getClinicalAreas", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/clinical_areas", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The page of the results which was returned." }, { "name": "page_size", "value": "25", "type": "query", "description": "How many results are in each page." }, { "name": "search", "value": "X-ray", "type": "query", "description": "String input that fuzzy searches against key fields within each clinical area object to return the most relevant options." }, { "name": "clinical_area", "value": "Nutrition", "type": "query", "description": "String input that fuzzy searches on `display` field." }, { "name": "_excl_clinical_area_ids", "value": "ffce41b2-aba4-4202-beba-6aa9dc51ef37,fe7d808b-5f53-4024-af9d-2662515bcd83", "type": "query", "description": "Comma separated list of clinical area UUIDs to exclude from search results." }, { "name": "specialty_ids", "value": "fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5", "type": "query", "description": "Comma separated list of specialty UUIDs." }, { "name": "condition", "value": "Sleep Disorders", "type": "query", "description": "String input that fuzzy searches on `condition.display` field." }, { "name": "condition_ids", "value": "45c9a22c-7a0f-4405-b0c9-c5f8ad83ba32,219d3998-d7e2-4b9e-91d1-17c19cd0bbc2", "type": "query", "description": "Comma separated list of condition UUIDs." }, { "name": "treatment", "value": "ACL Surgery", "type": "query", "description": "String input that fuzzy searches on `treatment.display` field." }, { "name": "treatment_ids", "value": "bb2ca22c-7a0f-4405-b0c9-c5f8ad839898,2ce33998-d7e2-4b9e-91d1-17c19cd06012", "type": "query", "description": "Comma separated list of treatment UUIDs." }, { "name": "type", "value": "providers", "type": "query", "description": "String input of the type of clinical areas to return. Options for input are either `providers` or `locations`.\nNote: Defaults to returning all clinical areas of any type." } ] }, "docs": "Returns clinical areas that exist within the Ribbon API.\n" }, { "info": { "name": "getClinicalArea", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/clinical_areas/:clinical_area_uuid", "params": [ { "name": "clinical_area_uuid", "value": "", "type": "path", "description": "The UUID of the target clinical area." } ] }, "docs": "Retrieve data on a specific clinical area.\n" }, { "info": { "name": "getConditions", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/conditions", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The page of the results which was returned." }, { "name": "page_size", "value": "25", "type": "query", "description": "How many results are in each page." }, { "name": "search", "value": "depression", "type": "query", "description": "String input that fuzzy searches against key fields within each condition object to return the most relevant options." }, { "name": "_excl_condition_ids", "value": "2938baf9-f064-44d6-8251-6e4b9fbb6fd2,c9d21735-8a78-45fe-982b-d216cb94beb7", "type": "query", "description": "Comma separated list of condition UUIDs to exclude from search results." }, { "name": "specialty_ids", "value": "fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5", "type": "query", "description": "Comma separated list of specialty UUIDs." }, { "name": "module", "value": "focus_areas", "type": "query", "description": "String input of the type of clinical areas to return. Options for input are either `focus_areas` or `condition_cost_estimate`.\nNote: This input must be an exact string match to work" } ] }, "docs": "Returns conditions that exist within the Ribbon API.\n" }, { "info": { "name": "getCondition", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/conditions/:condition_uuid", "params": [ { "name": "condition_uuid", "value": "", "type": "path", "description": "The UUID of the target condition." } ] }, "docs": "Retrieve data on a specific condition.\n" }, { "info": { "name": "getTreatments", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/treatments", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The page of the results which was returned." }, { "name": "page_size", "value": "25", "type": "query", "description": "How many results are in each page." }, { "name": "search", "value": "Ankle X-Ray", "type": "query", "description": "String input that fuzzy searches against key fields within each treatment object to return the most relevant options." }, { "name": "_excl_treatment_ids", "value": "ffb31993-8265-45f6-98ac-18a495d614b5,ff36f4f1-7031-46b0-a297-e85b73aa8e90", "type": "query", "description": "Comma separated list of treatment UUIDs to exclude from search results." }, { "name": "specialty_ids", "value": "fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5", "type": "query", "description": "Comma separated list of specialty UUIDs." }, { "name": "type", "value": "providers", "type": "query", "description": "String input of the type of clinical areas to return. Options for input are either `providers` or `locations`.\nNote: Defaults to returning all clinical areas of any type." } ] }, "docs": "Returns treatments that exist within the Ribbon API.\n" }, { "info": { "name": "getTreatment", "type": "http" }, "http": { "method": "GET", "url": "https://api.ribbonhealth.com/v1/custom/treatments/:treatment_uuid", "params": [ { "name": "treatment_uuid", "value": "", "type": "path", "description": "The UUID of the target treatment." } ] }, "docs": "Retrieve data on a specific treatment.\n" } ] } ], "bundled": true }