Check Member Eligibility

<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp isRefPage "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1739992711721"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.284.0"><meta name="readme-subdomain" content="ribbon"><meta name="readme-version" content="2.2"><title>Check Member Eligibility</title><meta name="description" content="Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services. Example Use Case Inform a member of their current progress against ..."><meta property="og:title" content="Check Member Eligibility"><meta property="og:description" content="Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services. Example Use Case Inform a member of their current progress against ..."><meta property="og:site_name" content="H1 API Docs"><meta name="twitter:title" content="Check Member Eligibility"><meta name="twitter:description" content="Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services. Example Use Case Inform a member of their current progress against ..."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png"><meta name="twitter:image" content="https://files.readme.io/1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/ea171b287c6a8fb267f6151e05a72355433eb125a4f478552bc83ef46d8709f7-small-favicon-128x128.png" type="image/png"><link rel="canonical" href="https://ribbon.readme.io/reference/geteligibility"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1739992711721"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.10afbae1f52ee2489bb8.css"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.bac51c5bb29bb9d7aab2.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.9ae78229246dc26717ce.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.437f73cd40b5d152e9f9.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.10afbae1f52ee2489bb8.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.571e99fd5e02a59c06dd.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.862d4391741934767cc6.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.0e8e0b4dc46a0a17b23c.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.b1e5365bb2c53d6f36dd.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.17077f1007fd28bfacf2.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3622.30b9cb2443fabb238262.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.4f5b31df3dc44b53f8ec.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.01a0e639a7ef9538f97e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.ccf876992083e861c716.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6471.7c35c1a3aaf54575282a.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1095.0021a98e29fa5ae0423e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/777.ef77d501263107e85d40.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6969.f532cda08d88de16b98a.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.8f091338ee9df50fd3c2.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.fdde3006d3bddb71d71f.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.cada933b93538b08b34f.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.11c1ea4eab468ae0b7f7.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.3803f927cf157eaa6fe4.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.8514b725f5cc2d3b093c.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.31d152eb3e55e8474e47.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.654b955d56546578946f.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.a7fc6699ce547c746349.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.801356cb5016084f6850.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.5ab372d0c14f798d16e3.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1525.d1de226102472ceacba6.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.b95f6aef50c6c4b838ab.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.b6e98482708fa5a1b7e2.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2541.0453880796b8f2209146.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.414da433f0aa4db22430.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.431870cb4b4bcf334308.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.d9bd1d5feebc743d66ee.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.541858d9d3864fc7d303.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.e970f190e6b0f9676c06.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.922078b47615946064e5.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.6011119cd662e9e6f233.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.dc3b5b02d7c889ec94bf.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.62a9fb1d734b15803ce5.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.59ae63b23834934d50c8.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.b1e5365bb2c53d6f36dd.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.0e8e0b4dc46a0a17b23c.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.862d4391741934767cc6.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.571e99fd5e02a59c06dd.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.10afbae1f52ee2489bb8.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.437f73cd40b5d152e9f9.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.9ae78229246dc26717ce.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.bac51c5bb29bb9d7aab2.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.10afbae1f52ee2489bb8.css"><style title="rm-custom-css">:root{--project-color-primary:#064997;--project-color-inverse:#fff;--recipe-button-color:#064997;--recipe-button-color-hover:#021a35;--recipe-button-color-active:#000204;--recipe-button-color-focus:rgba(6, 73, 151, 0.25);--recipe-button-color-disabled:#70aff9}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#064997;--project-color-inverse:#fff}a{color:var(--color-link-primary,#064997)}a:hover{color:var(--color-link-primary-darken-5,#021a35)}a.text-muted:hover{color:var(--color-link-primary,#064997)}.btn.btn-primary{background-color:#064997}.btn.btn-primary:hover{background-color:#021a35}.theme-line #hub-landing-top h2{color:#064997}#hub-landing-top .btn:hover{color:#064997}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#064997}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#064997,#002550)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#064997}.theme-line header#hub-header #header-top .btn{background-color:#064997}header#hub-header #header-top #header-logo{width:66px;height:40px;margin-top:0;background-image:url(https://files.readme.io/615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#064997}#subheader-links a.active{color:#064997!important;box-shadow:inset 0 -2px 0 #064997}#subheader-links a:hover{color:#064997!important;box-shadow:inset 0 -2px 0 #064997;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#064997}section#hub-discuss .discussion a .discuss-body h4{color:#064997}section#hub-discuss .discussion a:hover .discuss-body h4{color:#021a35}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#064997}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#064997}#hub-search-results h3 em{color:#064997}.main_background,.tag-item{background:#064997!important}.main_background:hover{background:#021a35!important}.main_color{color:#064997!important}.border_bottom_main_color{border-bottom:2px solid #064997}.main_color_hover:hover{color:#064997!important}section#hub-discuss h1{color:#064997}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#064997;background-color:#064997}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#021a35;border-color:#021a35}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#064997;color:#064997}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#064997);border-color:var(--project-color-primary,#064997)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#021a35;border-color:#021a35}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#064997;fill:var(--project-color-primary,#064997)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#064997}.main-color-accent{border-bottom:3px solid #064997;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */.p{font-family:'avenir next';font-size:20px;font-weight:700}.content-body code{display:inline;word-break:normal}.Header-leftADQdGVqx1wqU a.Button.Header-link2tXYTgXq85zW:last-child{padding:1px 12px 0;background:#9b255f;color:#fff;outline:0}#custom-banner{background-color:#262f38}#inner-banner{max-width:1370px;margin:0 auto;padding:10px 35px}#inner-banner>h4,#inner-banner>h4>a{color:#fff;font-size:16px;font-weight:400;margin:0;text-align:center}#inner-banner>h4>a{font-weight:600;margin-left:4px}@media screen and (max-width:768px){#inner-banner{padding:10px 26px}#inner-banner>h4,#inner-banner>h4>a{font-size:12px}}/*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="ribbon"><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.284.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal hub-full"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#064997;--color-primary-inverse:#fff;--color-primary-alt:#002550;--color-primary-darken-10:#043166;--color-primary-darken-20:#021a35;--color-primary-alpha-25:rgba(6, 73, 151, 0.25);--color-link-primary:#064997;--color-link-primary-darken-5:#053d7e;--color-link-primary-darken-10:#043166;--color-link-primary-darken-20:#021a35;--color-link-primary-alpha-50:rgba(6, 73, 151, 0.5);--color-link-primary-alpha-25:rgba(6, 73, 151, 0.25);--color-link-background:rgba(6, 73, 151, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="H1 API Docs" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/docs" target="_self">Guides</a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text rm-Header-top-link_active Header-link2tXYTgXq85zW active" href="/reference" target="_self">API Reference</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://h1.co/request-demo/" target="_self" to="https://h1.co/request-demo/">Try H1!</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option selected="" data-url="#" value="2.2">v2.2</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/docs" target="_self">Guides</a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 active" href="/reference" target="_self">API Reference</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://h1.co/request-demo/" rel="noopener" target="_blank" to="https://h1.co/request-demo/">Try H1!</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="H1 API Docs" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-references Header-left-nav-icon10glJKFwewOv"></i>API Reference</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span>v2.2</span><i class="icon icon-chevron-down"></i></button></div><div class="Dropdown Dropdown_closed"><div class="Dropdown-toggle" aria-haspopup="dialog"><button class="rm-Header-link rm-Header-bottom-link undefined Button Button_slate_text Button_md" type="button"><span>API Reference</span><i class="undefined icon-chevron-down"></i></button></div></div></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Check Member Eligibility</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-ReferenceMain rm-Container rm-Container_flex loading" id="Explorer"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj" id="reference-sidebar"><div class="Main-QuickNav-container1OiLvjSDusO6"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Ribbon Health API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Providers" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Providers</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Providers</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovider"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomprovider"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify Provider Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Locations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify Provider Location Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderprimaryspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify A Provider's Primary Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocationinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Insurances At A Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocationorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Organizations At A Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviderfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Filters" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Filters</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviderfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider Filters</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createcustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/editcustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location Filters</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createcustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/editcustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Locations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Locations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Locations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add or Edit Location Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Organizations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Reference Endpoints" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Reference Endpoints</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Insurance Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Specialty Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovidertypes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Provider Types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Provider Type Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationtypes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Location Types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Location Type Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Procedure</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getlanguages"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Languages</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Focus Area Endpoints" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Focus Area Endpoints</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalarea"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Clinical Area</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getconditions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Conditions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcondition"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Condition</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettreatments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Treatments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettreatment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Treatment</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Organizations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Organizations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Organizations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Organization</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/gettins"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for TINs" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">TINs</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettins"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search TINs</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomtin"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get TIN</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Price Transparency" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Price Transparency</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Price Search</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Procedure Pricing</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedurelocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Location Procedure Pricing</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarriers"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List Carriers</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarrier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Carrier</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarriernames"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Carrier Names</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-label="Deprecated" tabindex="-1"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingversioncarrier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Carrier Data Versions By Name</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-label="Deprecated" tabindex="-1"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibility"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Cost Estimates" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Cost Estimates</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/geteligibility"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Check Member Eligibility</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibilityinsurancepartners"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Supported Eligibility Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibilityinsurancepartner"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Eligibility Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedurecostestimate"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Procedure Cost Estimate</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getnetworkanalysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Networks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Networks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getnetworkanalysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Network Analysis Based on Geography</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section></div></nav><article class="rm-Article" id="content"><header class="headline-container21aRBSn8Bqg6 " data-raycast-oas="[object Object]"><div class="headline-container-grid-itemGdPV-VbhShYs button-containerobFfV0vf6giV"><div class="reference-flyout"><button aria-label="Toggle reference sidebar" class="icon-menu reference-sidebar-mobile-button26mqim6Chewq " type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj mobile" id="reference-sidebar"><div class="ref-QuickNav-mobile-containerARtvyEDVpRhW"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Ribbon Health API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Providers" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Providers</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Providers</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovider"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomprovider"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify Provider Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Locations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify Provider Location Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderprimaryspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Modify A Provider's Primary Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocationinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Insurances At A Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomproviderlocationorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Provider Organizations At A Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviderfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Filters" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Filters</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomproviderfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider Filters</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createcustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/editcustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomproviderfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Provider Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationfilters"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location Filters</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/createcustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/editcustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocationfilter"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location Filter</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Locations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Locations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Locations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomlocations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add or Edit Location Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Organizations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add Or Remove Location Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Reference Endpoints" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Reference Endpoints</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getinsurances"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Insurance Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustominsurance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getspecialties"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Specialties</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Specialty Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomspecialty"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Specialty</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovidertypes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Provider Types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Provider Type Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomprovidertype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Provider Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationtypes"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Location Types</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/postcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/putcustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Edit Location Type Fields</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_put Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">put</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/deletecustomlocationtype"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Delete Location Type</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_delete Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">delete</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Procedure</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getlanguages"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Languages</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Focus Area Endpoints" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Focus Area Endpoints</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalareas"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Clinical Areas</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getclinicalarea"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Clinical Area</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getconditions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Conditions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcondition"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Condition</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettreatments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Treatments</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettreatment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Treatment</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Organizations" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Organizations</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganizations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Organizations</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getorganization"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Organization</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/gettins"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for TINs" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">TINs</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/gettins"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search TINs</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getcustomtin"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get TIN</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Price Transparency" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Price Transparency</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviders"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Price Search</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedures"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Procedures</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Procedure Pricing</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingproviderprocedurelocation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Provider Location Procedure Pricing</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarriers"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List Carriers</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarrier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Carrier</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingcarriernames"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Carrier Names</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-label="Deprecated" tabindex="-1"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_deprecated2xLRLrwYS-C8 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getpricingversioncarrier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Carrier Data Versions By Name</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy Sidebar-link_deprecated-icon1TLWr7KfHfCp"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="alert-circle" role="img" style="--icon-color:var(--color-text-minimum);--icon-size:var(--icon-md);--icon-stroke-width:2px" aria-label="Deprecated" tabindex="-1"><g stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" clip-path="url(#alert-circle_svg__a)" class="icon-stroke-width"><path d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10ZM12 8v4M12 16h.01"></path></g><defs><clipPath id="alert-circle_svg__a"><path fill="currentColor" d="M0 0h24v24H0z"></path></clipPath></defs></svg></span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibility"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Cost Estimates" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Cost Estimates</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/geteligibility"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Check Member Eligibility</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">post</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibilityinsurancepartners"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Search Supported Eligibility Insurances</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/geteligibilityinsurancepartner"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get Eligibility Insurance</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getprocedurecostestimate"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Procedure Cost Estimate</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/getnetworkanalysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Networks" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Networks</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/getnetworkanalysis"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Network Analysis Based on Geography</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section></div></nav></div></div></div><header id="content-head"><h1>Check Member Eligibility</h1></header></div><div class="headline-container-article-info2GaOf2jMpV0r"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post headline-container-api-method1Hc-Fm7uaccR" data-testid="http-method">post</span> <span class="headline-container-article-info-url2nV_XrjpFuVQ" data-testid="serverurl" title="https://api.ribbonhealth.com/v1/eligibility">https://api.ribbonhealth.com/v1/eligibility</span></div><div role="doc-subtitle" class="rm-Markdown markdown-body undefined excerptT2m-MzSJGRK7" data-testid="RDMD"><p>Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services.</p> <h4 class="heading heading-4 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-use-case"></div><div class="heading-text"><div id="section-example-use-case" class="heading-anchor_backwardsCompatibility"></div>Example Use Case</div><a aria-label="Skip link to Example Use Case" class="heading-anchor-icon fa fa-anchor" href="#example-use-case"></a></h4> <p>Inform a member of their current progress against their Deductible as well as their Copay and Coinsurance summaries so they can better estimate their out-of pocket costs.</p></div></header><div class="ModalWrapper" id="response-schema-modal-target"></div></article><div id="ReferencePlayground" class="rm-Playground PlaygroundC7DInM9NFvBg "><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Language</div></header><div class="LanguagePickerSIxXDuYmeYsW rm-LanguagePicker"><div class="LanguagePicker-languages1qVVo_v6AlP9"><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton_active rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-curl"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Shell</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-node"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Node</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-ruby"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Ruby</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-php"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>PHP</button><button class="LanguagePicker-button1E91woqg9Y0e rm-LanguageButton" type="button"><i class="LanguagePicker-button-icon1vy2AqvvY7se icon-python"><span class="path1"></span><span class="path2"></span><span class="path3"></span><span class="path4"></span><span class="path5"></span><span class="path6"></span><span class="path7"></span><span class="path8"></span></i>Python</button><div class="LanguagePicker-divider Dropdown Dropdown_closed"><button aria-label="More Languages" aria-haspopup="dialog" class="Button Button_md LanguagePicker-more2w3Eqm0IH_K7 rm-LanguageButton-more Dropdown-toggle Button_primary_ghost Button_primary" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="more-vertical" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-label="More ellipsis"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M12 13a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 6a1 1 0 1 0 0-2 1 1 0 0 0 0 2ZM12 20a1 1 0 1 0 0-2 1 1 0 0 0 0 2Z" class="icon-stroke-width"></path></svg></span></button></div></div></div></section><section class="Playground-section3VTXuaYZivJK " data-notranslate="true"><section class="APIAuth rm-APIAuth" data-testid="api-auth"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader"><div class="APISectionHeader-heading4MUMLbp4_nLs">Credentials</div><div><div class="Info-infoBadge3luOwOnjfNiR Info-infoBadge_tooltip24vnuq69qR2X" role="button" tabindex="0"><div>Bearer</div><i aria-label="Information" class="Info-infoBadge-icon1VOz2gcy65SK icon-info1" role="img"></i></div></div></header><section align="stretch" class="Flex Flex_row InputGroup " justify="between" style="--flex-gap:var(--xs)"><header align="start" class="Flex Flex_row InputGroup-dropdown-parent" justify="between" style="--flex-gap:var(--xs)"><div class="InputGroup-dropdown Dropdown Dropdown_closed"><button class="Button Button_sm InputGroup-button Dropdown-toggle" data-testid="api-auth-security-button" disabled="" aria-haspopup="dialog"><span>Bearer</span></button></div></header><div class="InputGroup-input-parent "><div class="InputGroup-dropdown-inputs "><input type="text" autoComplete="off" class="InputGroup-input " id="APIAuth-token" placeholder="token" required="" spellcheck="false" value=""/><button aria-label="Hide" class="Button Button_xs rm-APIAuth-lock undefined Button_minimum Button_minimum_text Button_uppercase" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="lock" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M19 11H5a2 2 0 0 0-2 2v7a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7a2 2 0 0 0-2-2ZM7 11V7a5 5 0 1 1 10 0v4" class="icon-stroke-width"></path></svg></span></button></div></div></section></section></section><section class="Playground-section3VTXuaYZivJK Playground-section_sticky_fBLN0qIkmEd " data-notranslate="true"></section></div><div class="ModalWrapper" id="response-headers-modal-root"></div><div class="ModalWrapper" id="tutorialmodal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-desktop" id="QuickNav-modal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-mobile" id="QuickNav-mobile-modal-root"></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"64e4b17b751ef3002b3800bf","project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","isAPI":false,"reference":false,"createdAt":"2018-01-29T18:23:11.576Z","from_sync":false,"order":0,"slug":"overview","title":"Overview","__v":0,"pages":[{"_id":"64e4b17b751ef3002b3800fc","category":"64e4b17b751ef3002b3800bf","createdAt":"2018-07-16T18:19:12.202Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get","examples":{"codes":[]}},"isReference":false,"order":0,"slug":"welcome-to-the-ribbon-health-api","type":"basic","title":"Getting Started","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64e535518b46ca0025b00dee","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Authentication","icon":"","type":"basic","slug":"authentication","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800bf","createdAt":"2023-08-22T22:23:13.966Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66573e418b6a2b003872f192","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Ribbon Products","icon":"","type":"basic","slug":"ribbon-products","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800bf","createdAt":"2024-05-29T14:40:01.755Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e537b0059c3f000dcc819a","title":"Ribbon data","slug":"ribbon-data","order":1,"reference":false,"project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","createdAt":"2023-08-22T22:33:20.576Z","__v":0,"pages":[{"_id":"64e5392b3ce2dc00739d538b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Ribbon Directory","icon":"","type":"basic","slug":"ribbon-directory","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:39:39.363Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e537bfb91562023f2eb237","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Confidence Scores","icon":"","type":"basic","slug":"confidence-scores","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:33:35.387Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e537d9f00e690013e89b6c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"NPI (National Provider Identifier)","icon":"","type":"basic","slug":"npi-national-provider-identifier","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:34:01.811Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e537e25edfdd005db7b2e5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Networks","icon":"","type":"basic","slug":"insurances","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:34:10.608Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e538db85e43a002b1449fe","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Focus Areas","icon":"","type":"basic","slug":"focus-areas","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:38:19.487Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e538e993007b0024a80df9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Eligibility","icon":"","type":"basic","slug":"eligibility","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:38:33.104Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e538f2c4df92029f3f66c2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cost & Quality","icon":"","type":"basic","slug":"cost-quality","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:38:42.553Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e53920ecd9ae00399e8b65","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Specialties","icon":"","type":"basic","slug":"specialties","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:39:28.883Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e539343d78bb000c58c24b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Organizations","icon":"","type":"basic","slug":"organizations-1","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-08-22T22:39:48.112Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64f92bf122fa910013ce83a4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Procedures","icon":"","type":"basic","slug":"procedures","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-09-07T01:48:33.147Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64f93094dcc2cb000f3fbfb4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Location Types","icon":"","type":"basic","slug":"location-types","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2023-09-07T02:08:20.264Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66a14e2ed48cc90063236600","api":{"method":"get","url":"","auth":"required","params":[]},"title":"TINs","icon":"","type":"basic","slug":"tins","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e537b0059c3f000dcc819a","createdAt":"2024-07-24T18:55:42.571Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e53563c6633f003f520238","title":"Workflow Guides","slug":"workflow-guides","order":2,"reference":false,"project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","createdAt":"2023-08-22T22:23:31.071Z","__v":0,"pages":[{"_id":"64e53570069c05005e0f8c76","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Introduction","icon":"","type":"basic","slug":"introduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:23:44.112Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e535ce5ef1b8002cd36018","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Provider Search","icon":"","type":"basic","slug":"provider-search","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:25:18.894Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64ece7276d3faf0066241125","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Provider Search Basics","icon":"","type":"basic","slug":"provider-search-basics","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-28T18:27:51.254Z","isBodyEmpty":false,"children":[]},{"_id":"64e5364efb0cce006c229042","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search for Specialties","icon":"","type":"basic","slug":"search-for-specialties","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:27:26.427Z","isBodyEmpty":false,"children":[]},{"_id":"64e53666972e0f004d38876e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search for In-Network Providers","icon":"","type":"basic","slug":"search-networks","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"search-networks-tbu-rj","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:27:50.684Z","isBodyEmpty":false,"children":[]},{"_id":"64ecf6ff75cbfe00498249bf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Find a Specific Provider","icon":"","type":"basic","slug":"find-a-specific-provider","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-28T19:35:27.865Z","isBodyEmpty":false,"children":[]},{"_id":"64e536397a0560005ac6900f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search for Procedures","icon":"","type":"basic","slug":"search-for-procedures","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:27:05.320Z","isBodyEmpty":false,"children":[]},{"_id":"64ee8a8ee564a500624a90bb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search by Organization (Providers)","icon":"","type":"basic","slug":"search-for-providers-by-organization","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e535ce5ef1b8002cd36018","category":"64e53563c6633f003f520238","createdAt":"2023-08-30T00:17:18.888Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e536a9b1b583000d47d965","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Location Search","icon":"","type":"basic","slug":"location-search","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:28:57.156Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64ecbaa85ce44c000b7e95cd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Location Search Basics","icon":"","type":"basic","slug":"location-search-basics","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e536a9b1b583000d47d965","category":"64e53563c6633f003f520238","createdAt":"2023-08-28T15:18:00.267Z","isBodyEmpty":false,"children":[]},{"_id":"64e536b58cc625006fb12268","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search for Location Types","icon":"","type":"basic","slug":"search-for-location-types","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e536a9b1b583000d47d965","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:29:09.694Z","isBodyEmpty":false,"children":[]},{"_id":"64e536c4d00b1b0012865861","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Search by Organization (Locations)","icon":"","type":"basic","slug":"search-for-organizations-1","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e536a9b1b583000d47d965","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:29:24.391Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e53727ecd9ae00399e7ac0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cost & Quality Search","icon":"","type":"basic","slug":"search-for-high-quality-providers","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:31:03.390Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64e53738ec0f94028856a6de","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Aggregate Cost/Quality Scores","icon":"","type":"basic","slug":"aggregate-costquality-scores","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e53727ecd9ae00399e7ac0","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:31:20.905Z","isBodyEmpty":false,"children":[]},{"_id":"64e5375a2e4d19005a7c7bed","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Procedure-Level Cost & Experience","icon":"","type":"basic","slug":"procedure-level-cost-experience","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e53727ecd9ae00399e7ac0","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:31:54.380Z","isBodyEmpty":false,"children":[]},{"_id":"64e5376b6aabc4003104b21c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Patient Satisfaction Rating","icon":"","type":"basic","slug":"patient-satisfaction-rating","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e53727ecd9ae00399e7ac0","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:32:11.554Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e79b10c8737c0026de14b9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Network Data","icon":"","type":"basic","slug":"network-data","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-24T18:01:52.509Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64e79b692f007b148a350f46","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"User Dropdown","icon":"","type":"basic","slug":"user-dropdown","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e79b10c8737c0026de14b9","category":"64e53563c6633f003f520238","createdAt":"2023-08-24T18:03:21.580Z","isBodyEmpty":false,"children":[]},{"_id":"64e79b9d1d9d0c000b86c498","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Network Mapping","icon":"","type":"basic","slug":"network-mapping","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e79b10c8737c0026de14b9","category":"64e53563c6633f003f520238","createdAt":"2023-08-24T18:04:13.791Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e536e369fbcf0039da34f9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Filtering/Ranking","icon":"","type":"basic","slug":"filteringranking","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:29:55.257Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64e536f7b5a956002be6478e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a Boost Filter","icon":"","type":"basic","slug":"create-a-boost-filter","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e536e369fbcf0039da34f9","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:30:15.963Z","isBodyEmpty":false,"children":[]},{"_id":"64e5370684f2a9004141da0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a Custom Filter","icon":"","type":"basic","slug":"create-a-custom-filter","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"64e536e369fbcf0039da34f9","category":"64e53563c6633f003f520238","createdAt":"2023-08-22T22:30:30.889Z","isBodyEmpty":false,"children":[]},{"_id":"64edec142ea71f0020988d4d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using Weighted Custom Filters","icon":"","type":"basic","slug":"using-weighted-custom-filters","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"using-filter-scoring","parentDoc":"64e536e369fbcf0039da34f9","category":"64e53563c6633f003f520238","createdAt":"2023-08-29T13:01:08.830Z","isBodyEmpty":false,"children":[]}]},{"_id":"64e4b17b751ef3002b380122","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"params":[],"examples":{"codes":[]}},"title":"Eligibility Check","type":"basic","slug":"eligibility-check","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-04-07T18:40:15.714Z","category":"64e53563c6633f003f520238","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"64e53b81b6b872005fff1f51","title":"API Information","slug":"api-information","order":3,"reference":false,"project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","createdAt":"2023-08-22T22:49:37.765Z","__v":0,"pages":[{"_id":"64e53ceed7aef9006356101b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Latency","icon":"","type":"basic","slug":"latency","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53b81b6b872005fff1f51","createdAt":"2023-08-22T22:55:42.052Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e53d0186e7f0000c80ef77","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Include/Exclude Fields from API Response","icon":"","type":"basic","slug":"includeexclude-fields","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53b81b6b872005fff1f51","createdAt":"2023-08-22T22:56:01.549Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64e53d174cdebb00560c09b9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rate Limits","icon":"","type":"basic","slug":"rate-limits","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64e53b81b6b872005fff1f51","createdAt":"2023-08-22T22:56:23.298Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"64e4b17b751ef3002b3800cb","title":"Ribbon Health API","slug":"ribbon-health-api-1","order":9999,"reference":true,"project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","createdAt":"2023-06-21T18:33:17.571Z","__v":0,"pages":[{"_id":"64e4b17b751ef3002b380173","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Providers","icon":"","type":"basic","slug":"providers","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Providers","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T16:41:44.311Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380139","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Providers","icon":"","type":"endpoint","slug":"getcustomproviders","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomProviders","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.132Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Provider","icon":"","type":"endpoint","slug":"getcustomprovider","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomProvider","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.132Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013b","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Modify Provider Fields","icon":"","type":"endpoint","slug":"putcustomprovider","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProvider","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.132Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013c","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Locations","icon":"","type":"endpoint","slug":"putcustomproviderlocations","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderLocations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.133Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013d","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Modify Provider Location Fields","icon":"","type":"endpoint","slug":"putcustomproviderlocation","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderLocation","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.133Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013e","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Specialties","icon":"","type":"endpoint","slug":"putcustomproviderspecialties","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderSpecialties","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.133Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38013f","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Modify A Provider's Primary Specialties","icon":"","type":"endpoint","slug":"putcustomproviderprimaryspecialties","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderPrimarySpecialties","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.133Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"659d7551d51a250016f75ad4","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Procedures","icon":"","type":"endpoint","slug":"putcustomproviderprocedures","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderProcedures","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-01-09T16:33:21.421Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"659d7551d51a250016f75ad5","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Clinical Areas","icon":"","type":"endpoint","slug":"putcustomproviderclinicalareas","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderClinicalAreas","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-01-09T16:33:21.422Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380140","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Insurances At A Location","icon":"","type":"endpoint","slug":"putcustomproviderlocationinsurances","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderLocationInsurances","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.134Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"659d7551d51a250016f75ad6","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Provider Organizations At A Location","icon":"","type":"endpoint","slug":"putcustomproviderlocationorganizations","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderLocationOrganizations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-01-09T16:33:21.423Z","parentDoc":"64e4b17b751ef3002b380173","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380174","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Filters","icon":"","type":"basic","slug":"filters","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Filters","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T16:41:44.312Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380169","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Provider Filters","icon":"","type":"endpoint","slug":"getcustomproviderfilters","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomProviderFilters","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.509Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38016a","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Provider Filter","icon":"","type":"endpoint","slug":"createcustomproviderfilter","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"createCustomProviderFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.510Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"651d91e552ce700c18e6decd","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Provider Filter","icon":"","type":"endpoint","slug":"editcustomproviderfilter","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"editCustomProviderFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-10-04T16:25:09.875Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"651d91e552ce700c18e6dece","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Provider Filter","icon":"","type":"endpoint","slug":"deletecustomproviderfilter","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomProviderFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-10-04T16:25:09.876Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38016b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Location Filters","icon":"","type":"endpoint","slug":"getcustomlocationfilters","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomLocationFilters","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.511Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38016c","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Location Filter","icon":"","type":"endpoint","slug":"createcustomlocationfilter","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"createCustomLocationFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.512Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"651d91e552ce700c18e6decf","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Location Filter","icon":"","type":"endpoint","slug":"editcustomlocationfilter","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"editCustomLocationFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-10-04T16:25:09.879Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"651d91e552ce700c18e6ded0","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Location Filter","icon":"","type":"endpoint","slug":"deletecustomlocationfilter","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomLocationFilter","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-10-04T16:25:09.880Z","parentDoc":"64e4b17b751ef3002b380174","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380175","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Locations","icon":"","type":"basic","slug":"locations","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Locations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T16:41:44.312Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380141","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Locations","icon":"","type":"endpoint","slug":"getcustomlocations","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomLocations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.134Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38017e","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Location","icon":"","type":"endpoint","slug":"postcustomlocations","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postCustomLocations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-29T15:51:17.158Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380142","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Location","icon":"","type":"endpoint","slug":"getcustomlocation","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomLocation","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.134Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380143","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add or Edit Location Fields","icon":"","type":"endpoint","slug":"putcustomlocation","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomLocation","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.135Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380144","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Location","icon":"","type":"endpoint","slug":"deletecustomlocation","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomLocation","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.135Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380145","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Location Insurances","icon":"","type":"endpoint","slug":"putcustomlocationinsurances","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomLocationInsurances","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.135Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"659d7551d51a250016f75ad7","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Location Organizations","icon":"","type":"endpoint","slug":"putcustomlocationorganizations","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomLocationOrganizations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-01-09T16:33:21.432Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"659d7551d51a250016f75ad8","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Add Or Remove Location Clinical Areas","icon":"","type":"endpoint","slug":"putcustomlocationclinicalareas","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomLocationClinicalAreas","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-01-09T16:33:21.433Z","parentDoc":"64e4b17b751ef3002b380175","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380138","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Reference Endpoints","icon":"","type":"basic","slug":"reference-endpoints","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Reference Endpoints","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:18.528Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380146","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Insurances","icon":"","type":"endpoint","slug":"getinsurances","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getInsurances","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.136Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380147","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Insurance","icon":"","type":"endpoint","slug":"postcustominsurance","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postCustomInsurance","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.136Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380148","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Insurance","icon":"","type":"endpoint","slug":"getcustominsurance","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomInsurance","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.136Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380149","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Insurance Fields","icon":"","type":"endpoint","slug":"putcustominsurance","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomInsurance","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.136Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014a","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Insurance","icon":"","type":"endpoint","slug":"deletecustominsurance","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomInsurance","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.137Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Specialties","icon":"","type":"endpoint","slug":"getspecialties","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getSpecialties","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.137Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014c","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Specialty","icon":"","type":"endpoint","slug":"postcustomspecialty","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postCustomSpecialty","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.137Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Specialty","icon":"","type":"endpoint","slug":"getcustomspecialty","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomSpecialty","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.138Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014e","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Specialty Fields","icon":"","type":"endpoint","slug":"putcustomspecialty","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomSpecialty","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.138Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38014f","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Specialty","icon":"","type":"endpoint","slug":"deletecustomspecialty","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomSpecialty","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-21T18:33:19.138Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380154","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Provider Types","icon":"","type":"endpoint","slug":"getcustomprovidertypes","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomProviderTypes","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.697Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380155","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Provider Type","icon":"","type":"endpoint","slug":"postcustomprovidertype","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postCustomProviderType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.698Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380156","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Provider Type","icon":"","type":"endpoint","slug":"getcustomprovidertype","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomProviderType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.699Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380157","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Provider Type Fields","icon":"","type":"endpoint","slug":"putcustomprovidertype","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomProviderType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.699Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380158","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Provider Type","icon":"","type":"endpoint","slug":"deletecustomprovidertype","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomProviderType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.700Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380159","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Location Types","icon":"","type":"endpoint","slug":"getcustomlocationtypes","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomLocationTypes","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.700Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015a","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Create Location Type","icon":"","type":"endpoint","slug":"postcustomlocationtype","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"postCustomLocationType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.701Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Location Type","icon":"","type":"endpoint","slug":"getcustomlocationtype","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomLocationType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.702Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015c","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Edit Location Type Fields","icon":"","type":"endpoint","slug":"putcustomlocationtype","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"putCustomLocationType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.702Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015d","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Delete Location Type","icon":"","type":"endpoint","slug":"deletecustomlocationtype","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"deleteCustomLocationType","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.703Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Procedures","icon":"","type":"endpoint","slug":"getprocedures","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getProcedures","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.705Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38015f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Procedure","icon":"","type":"endpoint","slug":"getprocedure","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getProcedure","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.705Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380160","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Languages","icon":"","type":"endpoint","slug":"getlanguages","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getLanguages","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.706Z","parentDoc":"64e4b17b751ef3002b380138","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380176","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Focus Area Endpoints","icon":"","type":"basic","slug":"focus-area-endpoints","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Focus Area Endpoints","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.699Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380177","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Clinical Areas","icon":"","type":"endpoint","slug":"getclinicalareas","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getClinicalAreas","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.878Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380178","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Clinical Area","icon":"","type":"endpoint","slug":"getclinicalarea","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getClinicalArea","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.879Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380179","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Conditions","icon":"","type":"endpoint","slug":"getconditions","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getConditions","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.879Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38017a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Condition","icon":"","type":"endpoint","slug":"getcondition","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCondition","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.879Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38017b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Treatments","icon":"","type":"endpoint","slug":"gettreatments","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getTreatments","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.880Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b38017c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Treatment","icon":"","type":"endpoint","slug":"gettreatment","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getTreatment","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-26T19:17:22.880Z","parentDoc":"64e4b17b751ef3002b380176","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380150","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Organizations","icon":"","type":"basic","slug":"organizations","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Organizations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.291Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380152","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Organizations","icon":"","type":"endpoint","slug":"getorganizations","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getOrganizations","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.696Z","parentDoc":"64e4b17b751ef3002b380150","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380153","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Organization","icon":"","type":"endpoint","slug":"getorganization","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getOrganization","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.697Z","parentDoc":"64e4b17b751ef3002b380150","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"66d9d71f0df2b4001061158b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"TINs","icon":"","type":"basic","slug":"tins-1","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__TINs","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-09-05T16:06:55.811Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"66d9d7200df2b4001061158d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search TINs","icon":"","type":"endpoint","slug":"gettins","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getTins","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-09-05T16:06:56.008Z","parentDoc":"66d9d71f0df2b4001061158b","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"66d9d7200df2b4001061158e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get TIN","icon":"","type":"endpoint","slug":"getcustomtin","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getCustomTin","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2024-09-05T16:06:56.008Z","parentDoc":"66d9d71f0df2b4001061158b","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380151","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Price Transparency","icon":"","type":"basic","slug":"price-transparency-1","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Price Transparency","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.292Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b380161","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Provider Price Search","icon":"","type":"endpoint","slug":"getpricingproviders","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingProviders","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.706Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380162","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Provider Procedures","icon":"","type":"endpoint","slug":"getpricingproviderprocedures","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingProviderProcedures","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.707Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380163","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Provider Procedure Pricing","icon":"","type":"endpoint","slug":"getpricingproviderprocedure","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingProviderProcedure","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.708Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380164","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Provider Location Procedure Pricing","icon":"","type":"endpoint","slug":"getpricingproviderprocedurelocation","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingProviderProcedureLocation","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.708Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380165","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"List Carriers","icon":"","type":"endpoint","slug":"getpricingcarriers","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingCarriers","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.709Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"650b1da7c9485e0073005d77","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Carrier","icon":"","type":"endpoint","slug":"getpricingcarrier","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getPricingCarrier","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-09-20T16:28:23.218Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"650b1da7c9485e0073005d78","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Carrier Names","icon":"","type":"endpoint","slug":"getpricingcarriernames","order":6,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"getPricingCarrierNames","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-09-20T16:28:23.220Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380166","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Carrier Data Versions By Name","icon":"","type":"endpoint","slug":"getpricingversioncarrier","order":7,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"getPricingVersionCarrier","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T17:33:01.710Z","parentDoc":"64e4b17b751ef3002b380151","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b380168","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Cost Estimates","icon":"","type":"basic","slug":"cost-estimates","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Cost Estimates","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.005Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b38016f","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Check Member Eligibility","icon":"","type":"endpoint","slug":"geteligibility","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getEligibility","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.525Z","parentDoc":"64e4b17b751ef3002b380168","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"64e4b17b751ef3002b380170","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Search Supported Eligibility Insurances","icon":"","type":"endpoint","slug":"geteligibilityinsurancepartners","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getEligibilityInsurancePartners","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.525Z","parentDoc":"64e4b17b751ef3002b380168","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64e4b17b751ef3002b380171","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Get Eligibility Insurance","icon":"","type":"endpoint","slug":"geteligibilityinsurancepartner","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getEligibilityInsurancePartner","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.526Z","parentDoc":"64e4b17b751ef3002b380168","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64e4b17b751ef3002b380172","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Procedure Cost Estimate","icon":"","type":"endpoint","slug":"getprocedurecostestimate","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getProcedureCostEstimate","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-22T18:00:58.526Z","parentDoc":"64e4b17b751ef3002b380168","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"64e4b17b751ef3002b38017d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Networks","icon":"","type":"basic","slug":"networks","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Networks","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-29T15:51:16.971Z","mdx":{},"isBodyEmpty":true,"children":[{"_id":"64e4b17b751ef3002b38017f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"title":"Network Analysis Based on Geography","icon":"","type":"endpoint","slug":"getnetworkanalysis","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getNetworkAnalysis","link_url":"","link_external":false,"previousSlug":"","category":"64e4b17b751ef3002b3800cb","createdAt":"2023-06-29T15:51:17.171Z","parentDoc":"64e4b17b751ef3002b38017d","mdx":{},"isBodyEmpty":false,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"YTQ4NjI4YWRhMmYwOWE1MzIwM2RmOWZhMzc4NTIxYmM2ZjAzNDY5YmM4MjAwMTExN2M4MDI0NTBlMWU3MDA0MXRhZ0ZpbHRlcnM9KHByb2plY3Q6NWIwZjQ2NjQ3ZTBhZjUwMDAzMmNjOWEzKSwodmVyc2lvbjpub25lLHZlcnNpb246NjRlNGIxN2I3NTFlZjMwMDJiMzgwMWEwKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":true,"logs":false,"tutorials":false,"graphql":false},"id":"5b0f46647e0af500032cc9a3","name":"H1 API Docs","subdomain":"ribbon","subpath":"","nav_names":{"discuss":"","reference":"","docs":"","changelog":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"ribbon"},"version":"2.2"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"64e4b17b751ef3002b3800cc"},"swagger":{"path":"/eligibility"},"next":{"description":"","pages":[]},"algolia":{"recordCount":1,"publishPending":false,"translationFailure":false,"updatedAt":"2023-09-12T17:10:57.629Z"},"title":"Check Member Eligibility","icon":"","updates":[],"type":"endpoint","slug":"geteligibility","excerpt":"Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services.\n\n#### Example Use Case\nInform a member of their current progress against their Deductible as well as their Copay and Coinsurance summaries so they can better estimate their out-of pocket costs.","body":"","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"getEligibility","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2023-06-22T06:31:50.442Z","revision":58,"_id":"64e4b17b751ef3002b38016f","category":{"title":"Ribbon Health API","slug":"ribbon-health-api-1","order":9999,"reference":true,"_id":"64e4b17b751ef3002b3800cb","project":"5b0f46647e0af500032cc9a3","version":"64e4b17b751ef3002b3801a0","createdAt":"2023-06-21T18:33:17.571Z","__v":0,"type":"reference","id":"64e4b17b751ef3002b3800cb"},"createdAt":"2023-06-22T18:00:58.525Z","updatedAt":"2023-11-02T18:38:20.138Z","parentDoc":"64e4b17b751ef3002b380168","version":{"version":"2.2","version_clean":"2.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["64e4b17b751ef3002b3800b9","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","64e4b17b751ef3002b3800ba","64e4b17b751ef3002b3800bb","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","64e4b17b751ef3002b3800bc","64e4b17b751ef3002b3800bd","64e4b17b751ef3002b3800be","64e4b17b751ef3002b3800bf","5b325c97d19cf700032b17e9","64e4b17b751ef3002b3800c0","64e4b17b751ef3002b3800c1","64e4b17b751ef3002b3800c2","64e4b17b751ef3002b3800c3","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","64e4b17b751ef3002b3800c4","64e4b17b751ef3002b3800c5","64e4b17b751ef3002b3800c6","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","64e4b17b751ef3002b3800c7","64e4b17b751ef3002b3800c8","64e4b17b751ef3002b3800c9","64e4b17b751ef3002b3800ca","6376b41e081e400003bac1b3","64e4b17b751ef3002b3800cb","64e4b17b751ef3002b3801a2","64e53563c6633f003f520238","64e537b0059c3f000dcc819a","64e53b81b6b872005fff1f51"],"pdfStatus":"","_id":"64e4b17b751ef3002b3801a0","project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2023-08-22T13:00:43.284Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-09-07T18:14:48.285Z"},"project":"5b0f46647e0af500032cc9a3","__v":1,"lastUpdatedHash":"f27a5ac924753f9ac3bd6fd34877c06530e613a0","mdxAltBody":"","isApi":true,"tutorials":[],"id":"64e4b17b751ef3002b38016f"},"glossaryTerms":[],"hideTOC":false,"loginUrl":"https://dash.readme.com/to/ribbon","meta":{"_id":"64e4b17b751ef3002b38016f","description":"Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services. Example Use Case Inform a member of their current progress against ...","hidden":false,"image":[],"keywords":"","metaTitle":"Check Member Eligibility","parent":"64e4b17b751ef3002b380168","robots":"index","slug":"geteligibility","title":"Check Member Eligibility","type":"reference"},"oasDefinition":{"openapi":"3.1.0","info":{"title":"Ribbon Health API","version":"1.0.0","description":"An API for interacting with the data provided by Ribbon Health, including information about healthcare providers, locations, insurances, and more.\n"},"servers":[{"url":"https://api.ribbonhealth.com/v1"}],"paths":{"/custom/providers":{"get":{"summary":"Search Providers","description":"Allows you to quickly list doctors based on important search criteria.\n","operationId":"getCustomProviders","tags":["Providers"],"parameters":[{"name":"Pagination and Search Configuration Options","in":"query","required":false,"description":"Options to control what data gets returned to you.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page. \n\nNote that page_size is generally capped to 200 given the strict `max_locations * page_size <= 1000` requirement.\n"},"max_locations":{"type":"integer","example":5,"description":"The maximum number of locations that will be attached to any given provider. Note that there is a strict `max_locations * page_size <= 1000` requirement.\n\nDefaults to 5.\n"},"fields":{"type":"string","example":"locations,age","description":"Comma separated list of fields within the provider object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nCannot be used in tandem with `_excl_fields`.\n"},"_excl_fields":{"type":"string","example":"locations,age","description":"Comma separated list of fields within the provider object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use."}}}},{"name":"Provider Search Criteria","in":"query","required":false,"description":"Search criteria based on aspects of the providers themselves.","explode":true,"schema":{"type":"object","properties":{"npis":{"type":"string","description":"Comma separated list of desired NPIs (i.e. use this to search for 5 specific doctors).\n\nA maximum of `100` NPIs can be passed in per request.\n\nNote: This parameter cannot be used in combination with most other parameters. You may combine this parameter with `fields` or `_excl_fields`. You may use geographic search parameters `location` or `address`, which will be used to populate the `distance` on the returned providers but will **not** be used to filter them. All other parameters will be ignored.\n","example":1234567890},"name":{"type":"string","description":"String input of a full, first, last, or partial name.","example":"Doe"},"provider_types":{"type":"string","description":"A comma-separated list of 'types' of providers you are searching for. Provider types are higher level groupings of specialties. Here are a few key provider types:\n- Doctor\n- Nursing\n- Dental Providers\n- Optometry\n- Chiropractic Providers\n\nSee the Specialties Reference Endpoint for a list of all specialties and their provider types.\n","example":"Optometry"},"_excl_provider_types":{"type":"string","description":"A comma-separated list of 'types' of providers to exclude. Excludes providers with a matching provider type.\n","example":"Optometry"},"gender":{"type":"string","enum":["m","f"],"description":"String input of either m or f to filter to only medical providers of the inputted gender.","example":"m"},"max_age":{"type":"integer","description":"Integer input (i.e. 50) to filter to only medical providers under the inputted age.","example":70},"min_age":{"type":"integer","description":"Integer input (i.e. 50) to filter to only medical providers above the inputted age.","example":45},"language":{"type":"string","description":"Fuzzy search based on a string input (i.e. English) to filter to only medical providers providers who speak / whose office staff speak the inputted language.","example":"English"},"_excl_language":{"type":"string","description":"Fuzzy search based on a string input (i.e. English) to exclude medical providers providers who speak / whose office staff speak the inputted language.","example":"English"},"min_rating":{"type":"integer","minimum":0,"maximum":10,"description":"Integer input (from 0 to 10) to filter to only providers above the inputted value for the ratings_avg field.","example":6}}}},{"name":"Location Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on the locations at which they practice.","explode":true,"schema":{"type":"object","properties":{"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"New York, NY"},"location_ids":{"type":"string","description":"Comma separated list of desired practice location uuids. See all providers who see patients at any of the given practice locations.","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"_excl_location_ids":{"type":"string","description":"Comma separated list of practice location uuids to exclude. Excludes providers who see patients at any of the given practice locations.","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"location":{"type":"string","description":"Latitude/longitude pair of coordinates in lieu of a string address.","example":"37.7489816,-122.4802092"},"min_location_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence threshold for returned provider locations. min_location_confidence=3 will only display providers' locations that have a confidence 3 or higher. If a provider has a 5 locations, one of which is greater than 3, only the high confidence location will be included in the returned JSON output.\n\nNote: when this parameter is in use, the maximum number of records accessible is 1000 (i.e. if you maintain the default page_size of 25, the last page that can be paginated to is 40)\n","example":3},"min_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence location you wish the returned providers to have (i.e. min_confidence=4 will only display providers who have a location with confidence 4 or higher). This is a more performant but 'simpler' version of `min_location_confidence` parameter.","example":3},"distance":{"type":"integer","example":10,"description":"The proximity radius of providers returned.\n\n Note: When using `min_location_confidence` and `location_insurance_ids` parameters, limit `distance` to be less than 50 miles to ensure high quality results.\n"},"state":{"type":"string","example":"NY","description":"Two-letter state abbreviation of provider locations to filter to. Note that this parameter will override `address` and `location` parameters if used together."}}}},{"name":"Insurance Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on the insurances they accept.","explode":true,"schema":{"type":"object","properties":{"insurance_ids":{"type":"string","description":"Please use the location_insurance_ids parameter instead. These parameters have the same behavior and filter for insurance objects at the provider.location level.","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"_excl_insurance_ids":{"type":"string","description":"Comma separated list of insurance uuids to exclude. Exclude providers who accept a given insurance(s).","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"insurance_carrier_name":{"type":"string","description":"String input of carrier_name in order to search for all providers that take at least one plan from a given insurance carrier.\n\nFind the individual valid carrier_name values from the insurance objects returned in the Insurances Reference Endpoint.\n\nNote: This input must be an exact string match to work\n","example":"Aetna"},"location_insurance_ids":{"type":"string","description":"Comma separated list of desired insurance uuids. See all provider locations that accept a given insurance(s).\n\nNote, this parameter cannot be combined with `insurance_ids` to filter on provider insurances and provider location insurances.\n","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"_excl_location_insurance_ids":{"type":"string","description":"Comma separated list of insurance uuids to exclude. Excludes provider locations that accept a given insurance(s).","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"national_bluecard":{"type":"boolean","example":true,"description":"Boolean input that enables an API search to automatically default to the National BlueCard EPO/PPO Network whenever a member searches for out-of-state, in-network care and is covered by a BCBS Association PPO insurance plan. Use the parameter in conjunction with the address parameter and either the insurance_ids or insurance fuzzy search parameters. Defaults to true unless otherwise specified."}}}},{"name":"Specialty Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on their specialties.","explode":true,"schema":{"type":"object","properties":{"specialty_ids":{"type":"string","description":"Comma separated list of desired specialty uuids. See all providers who specialize in the given specialties.\n\nCannot be used in tandem with `specialty_ids_primary`, `specialty`, or `specialty_primary`.\n","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"_excl_specialty_ids":{"type":"string","description":"Comma separated list of specialties uuids to exclude. Exclude providers who specialize in the given specialties.","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"specialty":{"type":"string","description":"String input of a provider specialty that will be interpreted and matched to the single closest specialty, dealing with basic typos and colloquial names for providers. For example, to find Gastroenterologists you could search any of the following\n- gastroenterology\n- gastroenterologist\n- gastro\n- stomach doc\n- gastrooentrology\n\nThis parameter can make use of our specialty grouping logic. To learn more about this logic and/or to opt out, please use the `apply_specialty_grouping` parameter.\n\nCannot be used in tandem with `specialty_primary`, `specialty_ids`, or `specialty_ids_primary`.\n","example":"gastroenterology"},"specialty_ids_primary":{"type":"string","description":"Comma separated list of specialty uuids. See all providers whose primary specialties are in the given specialties.\n\nCannot be used in tandem with `specialty_ids`, `specialty`, or `specialty_primary`.\n","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"_excl_specialty_ids_primary":{"type":"string","description":"Comma separated list of specialties uuids to exclude. Exclude providers whose primary specialties are in the given specialties.","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"specialty_primary":{"type":"string","description":"String input of a provider specialty that will be interpreted and matched to the single closest specialty, similar to the `specialty` parameter. See all providers whose primary specialty is the given specialty.\n\nCannot be used in tandem with `specialty`, `specialty_ids` or `specialty_ids_primary`.\n","example":"gastroenterology"},"apply_specialty_grouping":{"type":"boolean","description":"Boolean input that enables an API search to automatically default to apply the inclusions and exclusions logic for grouping relevant specialties when using the `specialty` or `specialty_primary` parameter. Defaults to `true`.\nFor details, please read [our guide on searching by specialties](https://ribbon.readme.io/docs/search-for-specialties).\n","example":false}}}},{"name":"Procedure Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on procedures they perform.","explode":true,"schema":{"type":"object","properties":{"procedure_ids":{"type":"string","description":"Comma separated list of desired procedure uuids. Filter to only providers who perform the given procedure.","example":"9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"},"_excl_procedure_ids":{"type":"string","description":"Comma separated list of procedure uuids to exclude. Exclude providers who perform the given procedure.","example":"9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"},"procedure":{"type":"string","description":"String input that is fuzzy matched to the most relevant procedure `display` field. Only a single procedure will be selected. Filter to only providers who perform the given procedure.","example":"MRI, thoracic spine"},"min_experience_index":{"type":"float","description":"Float input of the minimum experience index for procedures. min_experience_index=4 will only return providers that have an experience index of 4 or higher for at least one of the given procedure uuids.\n\nNote: This parameter must be used with `procedure_ids`.\n","example":4},"max_cost_index":{"type":"float","description":"Float input of the maximum cost index for procedures. max_cost_index=4 will only return providers that have a cost index of 4 or less for at least one of the given procedure uuids.\n\nNote: This parameter must be used with `procedure_ids`.\n","example":4}}}},{"name":"Focus Area Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on their Focus Areas.","explode":true,"schema":{"type":"object","properties":{"clinical_area":{"type":"string","description":"String input that is fuzzy matched to the most relevant `clinical_area.display` field. Only a single clinical area will be selected.\n\nReturns all providers with this clinical area.\n","example":"Mental Health"},"clinical_area_ids":{"type":"string","description":"Comma-separated list of desired clinical area ids.\n\nReturns all providers with a clinical area exactly matching any of the entered IDs.\n\n(Note: Use the `/clinical_areas/` reference endpoint to identify relevant IDs)\n","example":"a7da792c-fae3-4b46-bab7-220e0c54e376"},"_excl_clinical_area_ids":{"type":"string","description":"Comma-separated list of clinical area ids to exclude.\n\nReturns all providers without a clinical area exactly matching any of the entered IDs.\n\n(Note: Use the `/clinical_areas/` reference endpoint to identify relevant IDs)\n","example":"a7da792c-fae3-4b46-bab7-220e0c54e376"},"condition":{"type":"string","description":"String input that is fuzzy matched to the most relevant `condition.display` field. Only a single condition will be selected.\n\nReturns all providers with this condition.\n","example":"depression"},"condition_ids":{"type":"string","description":"Comma-separated list of desired condition ids.\nReturns all providers with a `conditions.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the `/conditions/` reference endpoint to identify relevant IDs)\n","example":"fd7c10f3-fbec-482a-929b-be94a8bb3bc1"},"_excl_condition_ids":{"type":"string","description":"Comma-separated list of condition ids to exclude.\nReturns all providers without a `conditions.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the `/conditions/` reference endpoint to identify relevant IDs)\n","example":"fd7c10f3-fbec-482a-929b-be94a8bb3bc1"},"treatment":{"type":"string","description":"String input that is fuzzy matched to the most relevant `treatments.display` field. Only a single treatment will be selected.\n\nReturns all providers with this treatment.\n","example":"Psychological Therapy"},"treatment_ids":{"type":"string","description":"Comma-separated list of desired treatment ids.\nReturns all providers with a `treatments.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":"11016779-e286-4b17-bd45-2d78660a9f28"},"_excl_treatment_ids":{"type":"string","description":"Comma-separated list of treatment ids to exclude.\nReturns all providers without a `treatments.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":"11016779-e286-4b17-bd45-2d78660a9f28"},"panel_ages":{"type":"string","description":"Comma-separated list of desired Panel Ages strings. Options are:\n `Pediatric (0-12)`\n `Adolescent (13-21)`\n `Adult (22-44)`\n `Adult (45-64)`\n `Senior (65 and over)`\n\nReturns all providers with a `panel_ages` label field exactly matching any of the entered strings.\n","example":"Pediatric (0-12),Adolescent (13-21)"},"_excl_panel_ages":{"type":"string","description":"Comma-separated list of Panel Ages strings to exclude. Options are:\n `Pediatric (0-12)`\n `Adolescent (13-21)`\n `Adult (22-44)`\n `Adult (45-64)`\n `Senior (65 and over)`\n\nReturns all providers without a `panel_ages` label field exactly matching any of the entered strings.\n","example":"Pediatric (0-12),Adolescent (13-21)"},"panel_sexes":{"type":"string","description":"Desired Panel Sexes string. Options are:\n\n `Both female and male`\n `Primarily female`\n `Primarily male`\n\nReturns all providers with a panel sexes label field exactly matching the entered string.\n","example":"Primarily female"}}}},{"name":"Cost and Quality Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on Cost and Quality scores.","explode":true,"schema":{"type":"object","properties":{"min_outcomes_index":{"type":"integer","minimum":1,"maximum":5,"description":"Accepts a single integer input between 1 and 5.\n\nReturns providers with an aggregate Outcomes Quality score (field: `performance.aggregate.quality.outcomes_index`) greater than or equal to the entered parameter.\n"},"min_efficiency_index":{"type":"integer","minimum":1,"maximum":5,"description":"Accepts a single integer input between 1 and 5.\n\nReturns providers with an aggregate Cost Efficiency score (field: `performance.aggregate.cost.efficiency_index`) greater than or equal to the entered parameter.\n"},"max_unit_cost_index":{"type":"integer","minimum":1,"maximum":10,"description":"Accepts a single integer input between 1 and 10.\n\nReturns providers with an aggregate Unit Cost Index score (field: `performance.aggregate.cost.unit_cost_index`) less than or equal to the entered parameter.\n"},"max_ribbon_cost_score":{"type":"integer","minimum":1,"maximum":10,"description":"Accepts a single integer input between 1 and 10.\n\nReturns providers with an aggregate Ribbon Cost Score (field: `performance.aggregate.cost.ribbon_cost_score`) less than or equal to the entered parameter.\n\nNote: this search parameter is only available to customers that have purchased our Cost and Quality data.\n"}}}},{"name":"Organization Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on the organizations they belong to.","explode":true,"schema":{"type":"object","properties":{"location_organization_ids":{"type":"string","description":"Comma separated list of desired organization uuids. Filters to only providers who have the given organization uuid(s) listed in the `provider.organizations` field.\n\nUsing this parameter will also filter the `provider.locations` returned in order to only surface `provider.locations` that have the given organization(s) in the `provider.locations.organizations` field.\n","example":"497a1ac1-52cc-43a9-b796-844dabde10fc"},"_excl_location_organization_ids":{"type":"string","description":"Comma separated list of organization uuids to exclude. Excludes providers who have the given organization uuid(s) listed in the `provider.organizations` field.","example":"497a1ac1-52cc-43a9-b796-844dabde10fc"}}}},{"name":"TINs Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on the TINs they are associated with.","explode":true,"schema":{"type":"object","properties":{"tin_ids":{"type":"string","description":"Comma separated list of desired TINs. Filters to only providers who have the given TINs listed in the `provider.location` field.\nNote: This parameter cannot be used in combination with any other TINs related parameters. All other TINs related parameters will be ignored.\n"},"tin_name":{"type":"string","description":"String input that is fuzzy matched against the `tins.name` field. Filters to only providers who have the given TINs name listed in the `provider.location` field."},"tin_legal_name":{"type":"string","description":"String input that is fuzzy matched against the `tins.legal_name` field. Filters to only providers who have the given TINs legal name listed in the `provider.location` field."}}}}],"responses":{"200":{"description":"Returns an ordered list of matching providers","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"allOf":[{"type":"object","properties":{"total_count":{"type":"integer","example":141,"description":"The total number of results matched, across all pages."},"sort_by":{"type":"string","example":"distance","description":"The main criteria used to sort results in the record set."},"geo":{"type":"object","properties":{"latitude":{"type":"number","example":40.7351327,"description":"The latitude the search was focused on."},"longitude":{"type":"number","example":-73.9881657,"description":"The longitude the search was focused on."}}}}},{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"max_locations":{"type":"integer","example":5,"description":"The maximum number of locations attached to any given provider. Defaults to 5 (not shown if unspecified)."},"fields":{"type":"array","items":{"type":"string","example":"locations"},"example":["locations","age"],"description":"List of fields within the provider object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nCannot be used in tandem with `_excl_fields`\n"},"_excl_fields":{"type":"array","items":{"type":"string","example":"locations"},"example":["locations","age"],"description":"List of fields within the provider object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use."}}},{"type":"object","properties":{"npis":{"type":"array","items":{"type":"string","example":1234567890},"description":"List of desired NPIs (i.e. use this to search for 5 specific doctors).\n\nNote: This parameter cannot be used in combination with any other parameters. All other parameters will be ignored.\n","example":[1234567890]},"name":{"type":"string","description":"String input of a full, first, last, or partial name.","example":"Doe"},"provider_types":{"type":"array","items":{"type":"string","example":"Optometry"},"description":"The 'types' of providers you searched for. Provider types are higher level groupings of specialties. Here are a few key provider types:\n- Doctor\n- Nursing\n- Dental Providers\n- Optometry\n- Chiropractic Providers\n\nSee the Specialties Reference Endpoint for a list of all specialties and their provider types.\n","example":["Optometry"]},"gender":{"type":"string","enum":["m","f"],"description":"String input of either m or f to filter to only medical providers of the inputted gender.","example":"m"},"max_age":{"type":"integer","description":"Integer input (i.e. 50) to filter to only medical providers under the inputted age.","example":70},"min_age":{"type":"integer","description":"Integer input (i.e. 50) to filter to only medical providers above the inputted age.","example":45},"language":{"type":"object","properties":{"results":{"type":"array","items":{"type":"string","example":"french"},"description":"The languages that matched the given `language` parameter"},"value":{"type":"string","example":"English"},"description":"The given input to the `language` parameter"}},"min_rating":{"type":"integer","minimum":0,"maximum":10,"description":"Integer input (from 0 to 10) to filter to only providers above the inputted value for the ratings_avg field.","example":6}}},{"type":"object","properties":{"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"New York, NY"},"location_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"description":"List of desired practice location uuids. See all providers who see patients at any of the given practice locations.","example":["34ecc98a-e49e-49e3-84f9-b0ab2ff00495"]},"min_location_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence threshold for returned provider locations. min_location_confidence=3 will only display providers' locations that have a confidence 3 or higher. If a provider has a 5 locations, one of which is greater than 3, only the high confidence location will be included in the returned JSON output.\n\nNote: when this parameter is in use, the maximum number of records accessible is 1000 (i.e. if you maintain the default page_size of 25, the last page that can be paginated to is 40)\n","example":3},"min_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence location you wish the returned providers to have (i.e. min_confidence=4 will only display providers who have a location with confidence 4 or higher). This is a more performant but 'simpler' version of `min_location_confidence` parameter.","example":3},"distance":{"type":"integer","example":10,"description":"The proximity radius of providers returned.\n\n Note: When using `min_location_confidence` and `location_insurance_ids` parameters, limit `distance` to be less than 50 miles to ensure high quality results.\n"},"state":{"type":"string","example":"NY","description":"Two-letter state abbreviation of provider locations to filter to. Note that this parameter will override `address` and `location` parameters if used together."}}},{"type":"object","properties":{"insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"description":"List of desired insurance uuids. See all providers who accept a given insurance(s).","example":["e527f6e3-fe42-4932-bf34-d81f1c1fd652"]},"insurance_carrier_name":{"type":"string","description":"String input of carrier_name in order to search for all providers that take at least one plan from a given insurance carrier.\n\nFind the individual valid carrier_name values from the insurance objects returned in the Insurances Reference Endpoint.\n\nNote: This input must be an exact string match to work\n","example":"Aetna"},"location_insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"description":"List of desired insurance uuids. See all provider locations that accept a given insurance(s).\n\nNote, this parameter cannot be combined with `insurance_ids` to filter on provider insurances and provider location insurances.\n","example":["34ecc98a-e49e-49e3-84f9-b0ab2ff00495"]},"national_bluecard":{"type":"boolean","example":true,"description":"Boolean input that enables an API search to automatically default to the National BlueCard EPO/PPO Network whenever a member searches for out-of-state, in-network care and is covered by a BCBS Association PPO insurance plan. Use the parameter in conjunction with the address parameter and either the insurance_ids or insurance fuzzy search parameters. Defaults to true unless otherwise specified."}}},{"type":"object","properties":{"specialty_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"description":"List of desired specialty uuids. See all providers who specialize in the given specialties.\n\nCannot be used in tandem with `specialty_ids_primary` or `specialty_primary`.\n","example":["1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"]},"specialty":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"},"specialty_ids_primary":{"type":"array","items":{"type":"string","format":"uuid","example":"1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"},"description":"List of specialty uuids. See all providers whose primary specialties are in the given specialties.\n\nCannot be used in tandem with `specialty_ids` or `specialty`.\n","example":["1de33770-eb1c-47fa-ab3e-f9a4ab924d9d"]},"primary_specialty":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"},"apply_specialty_grouping":{"type":"boolean","description":"Boolean input that enables an API search to automatically default to apply the inclusions and exclusions logic for grouping relevant specialties when using the `specialty` or `specialty_primary` parameter. Defaults to `true`.\nFor details, please read [our guide on searching by specialties](https://ribbon.readme.io/docs/search-for-specialties).\n","example":false}}},{"type":"object","properties":{"procedure_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"},"description":"Comma separated list of desired procedure uuids. Filter to only providers who perform the given procedure.","example":["9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"]},"procedure":{"$ref":"#/paths/~1procedures~1%7Bprocedure_uuid%7D/get/responses/200/content/application~1json/schema"},"min_experience_index":{"type":"float","minimum":0,"description":"Float input of the minimum experience index for procedures. min_experience_index=4 will only return providers that have an experience index of 4 or higher for at least one of the given procedure uuids.\n\nNote: This parameter must be used with `procedure_ids`.\n","example":4},"max_cost_index":{"type":"float","minimum":0,"description":"Float input of the maximum cost index for procedures. max_cost_index=4 will only return providers that have a cost index of 4 or less for at least one of the given procedure uuids.\n\nNote: This parameter must be used with `procedure_ids`.\n","example":4}}},{"type":"object","properties":{"clinical_area":{"type":"string","description":"String input that is fuzzy matched to the most relevant `clinical_area.display` field. Only a single clinical area will be selected.\n\nReturns all providers with this clinical area.\n","example":"Mental Health"},"clinical_area_ids":{"$ref":"#/paths/~1custom~1clinical_areas~1%7Bclinical_area_uuid%7D/get/responses/200/content/application~1json/schema"},"condition":{"$ref":"#/paths/~1custom~1conditions~1%7Bcondition_uuid%7D/get/responses/200/content/application~1json/schema"},"condition_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"fd7c10f3-fbec-482a-929b-be94a8bb3bc1"},"description":"List of desired condition ids.\nReturns all providers with a `conditions.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the `/conditions/` reference endpoint to identify relevant IDs)\n","example":["fd7c10f3-fbec-482a-929b-be94a8bb3bc1"]},"treatment":{"$ref":"#/paths/~1custom~1treatments~1%7Btreatment_uuid%7D/get/responses/200/content/application~1json/schema"},"treatment_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"11016779-e286-4b17-bd45-2d78660a9f28"},"description":"List of desired treatment ids.\nReturns all providers with a `treatments.uuid` field exactly matching any of the entered IDs.\n\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":["11016779-e286-4b17-bd45-2d78660a9f28"]},"panel_ages":{"type":"array","items":{"type":"string","example":["Pediatric (0-12)"]},"description":"List of desired Panel Ages strings. Options are:\n `Pediatric (0-12)`\n `Adolescent (13-21)`\n `Adult (22-44)`\n `Adult (45-64)`\n `Senior (65 and over)`\n\nReturns all providers with a `panel_ages` label field exactly matching any of the entered strings.\n","example":["Pediatric (0-12)","Adolescent (13-21)"]},"panel_sexes":{"type":"string","description":"Desired Panel Sexes string. Options are:\n\n `Both female and male`\n `Primarily female`\n `Primarily male`\n\nReturns all providers with a panel sexes label field exactly matching the entered string.\n","example":"Primarily female"}}},{"$ref":"#/paths/~1custom~1providers/get/parameters/7/schema"},{"type":"object","properties":{"location_organization_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"497a1ac1-52cc-43a9-b796-844dabde10fc"},"description":"List of desired organization uuids. Filters to only providers who have the given organization uuid(s) listed in the `provider.organizations` field.\n\nUsing this parameter will also filter the `provider.locations` returned in order to only surface `provider.locations` that have the given organization(s) in the `provider.locations.organizations` field.\n","example":["497a1ac1-52cc-43a9-b796-844dabde10fc"]}}},{"type":"object","properties":{"tin_ids":{"type":"string","description":"List of desired TINs."},"tin_name":{"type":"string"},"tin_legal_name":{"type":"string"}}},{"type":"object","properties":{"inclusions":{"type":"object","properties":{"specialty_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"ec41ff31-571d-422e-a8b5-806bed6a6c04"},"example":["ec41ff31-571d-422e-a8b5-806bed6a6c04"],"description":"A list of specialty IDs included in the search based on the fuzzy-matched `specialty` parameter."},"specialty_ids_primary":{"type":"array","items":{"type":"string","format":"uuid","example":"ec41ff31-571d-422e-a8b5-806bed6a6c04"},"example":["ec41ff31-571d-422e-a8b5-806bed6a6c04"],"description":"A list of primary specialty IDs included in the search based on the fuzzy-matched `specialty_primary` parameter."}}}}},{"type":"object","properties":{"exclusions":{"type":"object","properties":{"provider_types":{"type":"array","items":{"type":"string","example":"Optometry"},"description":"List of 'types' of providers excluded. Excludes any providers with a matching provider type.","example":["Optometry"]},"insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"description":"List of insurance uuids excluded. Excludes any providers who accept a given insurance(s).","example":["e527f6e3-fe42-4932-bf34-d81f1c1fd652"]},"location_insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"description":"List of insurance uuids excluded. Excludes any provider locations that accept a given insurance(s).","example":["34ecc98a-e49e-49e3-84f9-b0ab2ff00495"]},"location_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"},"description":"List of practice location uuids to exclude. Excludes providers who see patients at any of the given practice locations.","example":["34ecc98a-e49e-49e3-84f9-b0ab2ff00495"]},"location_organization_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"497a1ac1-52cc-43a9-b796-844dabde10fc"},"description":"List of organization uuids to exclude. Excludes providers who have the given organization uuid(s) listed in the `provider.organizations` field.","example":["497a1ac1-52cc-43a9-b796-844dabde10fc"]},"specialty_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"ec41ff31-571d-422e-a8b5-806bed6a6c04"},"example":["ec41ff31-571d-422e-a8b5-806bed6a6c04"],"description":"A list of specialty IDs excluded from the search. This can be the result of using `_excl_specialty_ids` or exclusions based on the fuzzy-matched `specialty` parameter."},"specialty_ids_primary":{"type":"array","items":{"type":"string","format":"uuid","example":"ec41ff31-571d-422e-a8b5-806bed6a6c04"},"example":["ec41ff31-571d-422e-a8b5-806bed6a6c04"],"description":"A list of primary specialty IDs excluded from the search. This can be the result of using `_excl_specialty_ids_primary` or exclusions based on the fuzzy-matched `specialty_primary` parameter."},"procedure_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"},"description":"Comma separated list of procedure uuids to exclude. Exclude providers who perform the given procedure.","example":["9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae"]},"language":{"type":"object","properties":{"value":{"type":"string","example":"english"},"results":{"type":"array","items":{"type":"string","example":"english"},"example":["english"]}},"description":"Fuzzy search based on a string input (i.e. English) to exclude medical providers providers who speak / whose office staff speak the inputted language."}}}}}]},"data":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/responses/200/content/application~1json/schema"},{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/paths/~1custom~1locations/get/responses/200/content/application~1json/schema/properties/data/items"},"description":"List of all locations this provider is known to practice at including any known phone numbers at these locations"}}}]}}}}}}},"400":{"description":"The search could not be completed as requested","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}":{"get":{"summary":"Get Provider","description":"Retrieve detailed information for any provider given their NPI, such as locations, contact information, education, patient satisfaction, etc.\n","operationId":"getCustomProvider","tags":["Providers"],"parameters":[{"name":"npi","in":"path","required":true,"description":"The 10-digit National Provider Identifier (NPI) of the healthcare provider to fetch.","schema":{"type":"string","pattern":"^\\d{10}$","example":"1861664294"}},{"name":"max_insurances","in":"query","required":false,"description":"If provided, returns only up to this many insurances per provider. Useful to limit the amount of data returned when you do not need the entire list of accepted insurances.","schema":{"type":"integer","example":50}}],"responses":{"200":{"description":"Returns a single provider","content":{"application/json":{"schema":{"type":"object","properties":{"npi":{"type":"string","pattern":"^\\d{10}$","example":"1861664294","description":"The healthcare provider's 10-digit National Provider Identifier (NPI)"},"first_name":{"type":"string","example":"Jane","description":"First name of the provider"},"middle_name":{"type":["string","null"],"example":"J","description":"Middle name of the provider"},"last_name":{"type":"string","example":"Doe","description":"Last name of the provider"},"age":{"type":["integer","null"],"example":38,"description":"The estimated age of the provider"},"gender":{"type":"string","enum":["m","f"],"description":"The gender of the provider"},"ratings_count":{"type":"integer","example":20,"description":"Total number of ratings collected across different sources"},"ratings_avg":{"type":["number","null"],"example":9.8,"description":"Average patient satisfaction rating out of 10 points across multiple sources"},"degrees":{"type":"array","items":{"type":"string","example":"MD"},"description":"Lists all degrees associated with this provider (e.g. MD, OD, PhD)"},"specialties":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"},"description":"This lists all the specialties for a given provider"},"languages":{"type":"array","items":{"type":"string","example":"english"},"description":"List of confirmed languages spoken"},"educations":{"type":"array","items":{"type":"object","required":["education","type","year"],"properties":{"education":{"type":"object","properties":{"name":{"type":"string","example":"Stritch School of Medicine"},"uuid":{"type":"string","format":"uuid","example":"0b26c31a-d74a-4327-9702-57753b82a126"}}},"type":{"type":["string","null"]},"year":{"type":["integer","null"],"example":2007}}},"description":"List of the schools attended by the provider"},"insurances":{"type":"array","items":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"},"description":"List of insurances the provider accepts"},"provider_types":{"type":"array","items":{"type":"string","example":"Doctor"},"description":"There are high level classifications for different provider types -- e.g. \"Doctor\", \"Optometry\", \"Dental Providers\", \"Nursing\", etc."},"locations":{"type":"array","items":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema"},"description":"List of all locations this provider is known to practice at including any known phone numbers at these locations"},"online_profiles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"}}},"description":"We aggregate profiles across a variety of different online sources, including booking platforms"}}}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Modify Provider Fields","description":"Edit all fields that do not fall under `specialties`, `locations`, or `insurances`. You may also add new fields or remove existing fields.\n\n#### Looking For The Old Documentation?\nWe're in the process of revamping our documentation. You can find the old page for this endpoint [here](https://ribbon.readme.io/docs/add-or-edit-provider-fields-old).\n","operationId":"putCustomProvider","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"type":"object","properties":{"remove_fields":{"type":"array","items":{"type":"string"},"description":"An optional list of custom fields name to remove."}},"additionalProperties":{"type":["string","integer","boolean","null"]},"example":{"c_section_rate":7.8,"c_section_sample_size":435}}}}},"responses":{"200":{"description":"The specified fields were successfully updated or added","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update fields which cannot be customized or attempted to set a provider_type value which does not exist.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/locations":{"put":{"summary":"Add Or Remove Provider Locations","description":"Add or remove locations a provider practices at using our standard location UUIDs.\n","operationId":"putCustomProviderLocations","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's locations.","content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string","format":"uuid","example":"003aa14f-31ed-4c20-8888-07055d69afb6"},"description":"A list of UUIDs to add to this provider's set.","example":["003aa14f-31ed-4c20-8888-07055d69afb6"]},"remove":{"type":"array","items":{"type":"string","format":"uuid","example":"000914b4-d165-4343-bd17-0054505faaa5"},"description":"A list of UUIDs to remove to this provider's set.","example":["000914b4-d165-4343-bd17-0054505faaa5"]},"override":{"type":"array","items":{"type":"string","format":"uuid","example":"000914b4-d165-4343-bd17-0054505faaa5"},"description":"A list of UUIDs to remove to completely replace this provider's set with.\nNot supported in combination with either `add` or `remove`."}},"example":{"add":["003aa14f-31ed-4c20-8888-07055d69afb6"],"remove":["000914b4-d165-4343-bd17-0054505faaa5"]}}}}},"responses":{"200":{"description":"The locations list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/locations/{location_uuid}":{"put":{"summary":"Modify Provider Location Fields","description":"Edit all fields that do not fall under `uuid`, `google_maps_link`, `latitude`, or `longitude`. You may also add new fields or remove existing fields.\nThese updates are provider-specific and will not affect other providers practicing at the same location.\n","operationId":"putCustomProviderLocation","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The location was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI or location cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/specialties":{"put":{"summary":"Add Or Remove Provider Specialties","description":"Add or remove specialties for a provider using our standard specialty UUIDs.\n","operationId":"putCustomProviderSpecialties","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's specialties.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"},{"type":"object","properties":{"is_primary":{"type":"boolean","example":false,"description":"Whether or not these specialties are the provider's primary specialties. When not provided, defaults to `false`.\nNot supported in combination with `remove`."}}}]}}}},"responses":{"200":{"description":"The specialties list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1specialties/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported or use items that are not valid UUIDs.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/specialties/{specialty_uuid}":{"put":{"summary":"Modify A Provider's Primary Specialties","description":"Edit whether a single specialty is one of the provider's primary specialties.\n","operationId":"putCustomProviderPrimarySpecialties","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"Whether or not this specialty is a primary specialty.","content":{"application/json":{"schema":{"type":"object","required":["is_primary"],"properties":{"is_primary":{"type":"boolean","example":false,"description":"Whether or not this specialty is one of the provider's primary specialties."}}}}}},"responses":{"200":{"description":"The specialty was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1specialties~1%7Bspecialty_uuid%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI or specialty cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/procedures":{"put":{"summary":"Add Or Remove Provider Procedures","description":"Add or remove procedures for a provider using our standard procedure UUIDs.\n","operationId":"putCustomProviderProcedures","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's procedures.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The procedures list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported or use items that are not valid UUIDs.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/clinical_areas":{"put":{"summary":"Add Or Remove Provider Clinical Areas","description":"Add or remove clinical areas for a provider using our standard clinical area UUIDs.\n","operationId":"putCustomProviderClinicalAreas","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's clinical areas.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The clinical areas list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported or use items that are not valid UUIDs.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/locations/{location_uuid}/insurances":{"put":{"summary":"Add Or Remove Provider Insurances At A Location","description":"Add or remove insurances accepted by a provider at a specific location using our standard insurance UUIDs.\n","operationId":"putCustomProviderLocationInsurances","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's insurances at this location.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The insurances list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported or use items that are not valid UUIDs.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI or location UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/{npi}/locations/{location_uuid}/organizations":{"put":{"summary":"Add Or Remove Provider Organizations At A Location","description":"Add or remove organizations accepted by a provider at a specific location using our standard organization UUIDs.\n","operationId":"putCustomProviderLocationOrganizations","tags":["Providers"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the provider's organizations at this location.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The organizations list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D~1locations/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported or use items that are not valid UUIDs.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Trial accounts do not have access to custom provider directories","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given NPI or location UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/providers/filters":{"get":{"summary":"Get Provider Filters","description":"Fetch all previously created filters for providers.\n","operationId":"getCustomProviderFilters","tags":["Filters"],"responses":{"200":{"description":"Returns a list of provider filters","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1custom~1providers~1filters/post/responses/201/content/application~1json/schema/properties/data"}}}}}}}}},"post":{"summary":"Create Provider Filter","description":"Create new filters to be used when searching for providers in the [Search Providers](./getcustomproviders) endpoint. \nYou can create filters for both Ribbon's existing data fields as well as any custom data fields you create.\n\n#### Example Use Case:\nLet's say you add a new field to a bunch of providers that match your use case, for instance `c_section_rate`. You could make this field searchable so that your search through [Search Providers](./getcustomproviders) when you pass through a certain parameter that specifies a maximum threshold.\n","operationId":"createCustomProviderFilter","tags":["Filters"],"requestBody":{"required":true,"description":"The new filter to create","content":{"application/json":{"schema":{"type":"object","required":["parameter","field","value_type","filter_type"],"properties":{"parameter":{"type":"string","description":"The name of filter which will be used when applying to a search\n","example":"max_c_section_rate"},"field":{"type":"string","description":"The name of the field that the filter will be applied to\n\nYou can specify nested fields by placing a `.` between each level within the JSON object. For example, `educations.education.uuid`\n","example":"c_section_rate"},"value_type":{"type":"string","enum":["string","float","integer","boolean","list"],"description":"The data type of the value passed into this filter"},"filter_type":{"type":"string","enum":["less_than","greater_than","equals","contains","boost","equals_any","contains_any","fuzzy"],"description":"The type of comparison that will occur between the value passed into this filter and the field specified in the `field` parameter\n\nNote that `boost` filters have several limitations:\n- A Boost Filter cannot use the following `value_type`s: `float`\n- If a Boost Filter's `field` targets something that is within a list of objects, such as ‘educations.education.name’, we will not reorder the list to bring these items to the front. We will merely boost records where there is an entry in the list that matches the filter, wherever it is.\n - There is one exception to this: `locations`. If you search for a provider and boost fields nested within the `locations` list, we will reorder the locations to put matching locations first.\n"}}}}}},"responses":{"201":{"description":"The specified filter was successfully created","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["uuid","filter"],"properties":{"uuid":{"type":"string","format":"uuid","description":"A UUID uniquely identifying this filter","example":"9da04268-65e4-4422-a095-98208695b8b9"},"filter":{"$ref":"#/paths/~1custom~1providers~1filters/post/requestBody/content/application~1json/schema"}}}}}}}},"400":{"description":"The filter you attempted to create was malformed","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"A filter with the given `parameter` name already exists","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/custom/providers/filters/{filter_uuid}":{"put":{"summary":"Edit Provider Filter","description":"Edit any of the fields in a custom provider filter you have already created.\n","operationId":"editCustomProviderFilter","tags":["Filters"],"parameters":[{"name":"filter_uuid","in":"path","required":true,"description":"The UUID of the filter you want to edit.","schema":{"type":"string","format":"uuid","example":"b5458763-968e-4690-bc70-f29d3a7459a9"}}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1filters/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The specified filter was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1filters/post/responses/201/content/application~1json/schema/properties/data"}}}}}},"400":{"description":"The filter updates you are trying to make are invalid or malformed.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given filter UUID cannot be found.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"A filter with the given parameter already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Provider Filter","description":"Delete a provider filter.\n","operationId":"deleteCustomProviderFilter","tags":["Filters"],"parameters":[{"name":"filter_uuid","in":"path","required":true,"description":"The UUID of the filter you want to delete.","schema":{"type":"string","format":"uuid","example":"b5458763-968e-4690-bc70-f29d3a7459a9"}}],"responses":{"204":{"description":"Filter was successfully deleted"},"404":{"description":"The given filter UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/locations":{"get":{"summary":"Search Locations","description":"Allows you to search for different service locations, including specific location types.\n","operationId":"getCustomLocations","tags":["Locations"],"parameters":[{"name":"Pagination and Search Configuration Options","in":"query","required":false,"description":"Options to control what data gets returned to you.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"fields":{"type":"string","example":"name,address","description":"Comma separated list of fields within the location object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\nCannot be used in tandem with `_excl_fields`\n"},"_excl_fields":{"type":"string","example":"phone_numbers,insurances","description":"Comma separated list of fields within the location object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use."}}}},{"name":"Location Search Options","in":"query","required":false,"description":"Search options based on aspects of the location objects.","explode":true,"schema":{"type":"object","properties":{"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"New York, NY"},"name":{"type":"string","description":"String input for a 'fuzzy' search on location name.","example":"Citymd Urgent Care"},"distance":{"type":"integer","example":10,"description":"The proximity radius of locations returned.\n"},"location_types":{"type":"string","description":"Comma separated list of values that filter to what type of facilities to show. We categorize locations into 36 types. Clients can add their own locations with unique location_types, and they will also be included in the search.\nSee the Location Types Reference Endpoint for a list of all location types.\n","example":"Urgent Care"},"_excl_location_types":{"type":"string","description":"Comma separated list of the 'types' of locations to exclude. Excludes locations with a matching location type.\n","example":"Urgent Care"},"location":{"type":"string","description":"Latitude/longitude pair of coordinates in lieu of a string address.","example":"37.7489816,-122.4802092"},"location_ids":{"type":"string","description":"Comma separated list of desired practice location uuids.","example":"48d4eb27-d82b-4ea4-8ad0-4bcb2c46a960"},"_excl_location_ids":{"type":"string","description":"Comma separated list of practice location uuids to exclude.","example":"48d4eb27-d82b-4ea4-8ad0-4bcb2c46a960"},"insurance_ids":{"type":"string","description":"Comma separated list of desired insurance uuids. See all locations that accept a given insurance(s).","example":"24617022-92b3-4b9f-af1c-4df21ad6fb6f"},"_excl_insurance_ids":{"type":"string","description":"Comma separated list of insurance uuids to exclude. Exclude locations that accept a given insurance(s).","example":"24617022-92b3-4b9f-af1c-4df21ad6fb6f"},"insurance_carrier_name":{"type":"string","description":"String input of carrier_name in order to search for all locations that take at least one plan from a given insurance carrier.\nFind the individual valid carrier_name values from the insurance objects returned in the Insurances Reference Endpoint.\nNote: This input must be an exact string match to work\n","example":"Aetna"},"min_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence threshold for returned locations. min_location_confidence=4 will only display locations that have a confidence 4 or higher.\n"},"national_bluecard":{"type":"boolean","example":true,"description":"Boolean input that enables an API search to automatically default to the National BlueCard EPO/PPO Network whenever a member searches for out-of-state, in-network care and is covered by a BCBS Association PPO insurance plan. Use the parameter in conjunction with the address parameter and either the insurance_ids or insurance fuzzy search parameters. Defaults to true unless otherwise specified."}}}},{"name":"Organization Search Criteria","in":"query","required":false,"description":"Criteria used to search for locations based on the organizations they belong to.","explode":true,"schema":{"type":"object","properties":{"organization_ids":{"type":"string","description":"Comma separated list of desired organization uuids. Filters to only locations that are affiliated with the given organization uuid(s).\n","example":"86722ebb-1dd1-4846-a1a9-a7a9e36c944d"},"_excl_organization_ids":{"type":"string","description":"Comma separated list of organization uuids to exclude. Excludes locations that are affiliated with the given organization uuid(s).","example":"86722ebb-1dd1-4846-a1a9-a7a9e36c944d"}}}},{"name":"Focus Area Search Criteria","in":"query","required":false,"description":"Criteria used to search for locations based on their Focus Areas.","explode":true,"schema":{"type":"object","properties":{"clinical_area":{"type":"string","description":"String input that is fuzzy matched to the most relevant `clinical_area.display` field. Only a single clinical area will be selected.\nReturns all location with this clinical area.\n","example":"CT"},"clinical_area_ids":{"type":"string","description":"Comma-separated list of desired clinical area ids.\nReturns all locations with a clinical area exactly matching any of the entered IDs.\n(Note: Use the `/clinical_areas/` reference endpoint to identify relevant IDs)\n","example":"4c03ddb4-f6c0-4574-a51e-508f83c43d69"},"_excl_clinical_area_ids":{"type":"string","description":"Comma-separated list of clinical area ids to exclude.\nReturns all locations without a clinical area exactly matching any of the entered IDs.\n(Note: Use the `/clinical_areas/` reference endpoint to identify relevant IDs)\n","example":"4c03ddb4-f6c0-4574-a51e-508f83c43d69"},"treatment":{"type":"string","description":"String input that is fuzzy matched to the most relevant `treatments.display` field. Only a single treatment will be selected.\nReturns all locations with this treatment.\n","example":"Neck X-ray"},"treatment_ids":{"type":"string","description":"Comma-separated list of desired treatment ids.\nReturns all locations with a `treatments.uuid` field exactly matching any of the entered IDs.\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":"e3079513-bf55-41cc-87c6-f7ff5f923085"},"_excl_treatment_ids":{"type":"string","description":"Comma-separated list of treatment ids to exclude.\nReturns all locations without a `treatments.uuid` field exactly matching any of the entered IDs.\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":"e3079513-bf55-41cc-87c6-f7ff5f923085"}}}},{"name":"TINs Search Criteria","in":"query","required":false,"description":"Criteria used to search for locations based on the TINs they are associated with.","explode":true,"schema":{"type":"object","properties":{"tin_ids":{"type":"string","description":"Comma separated list of desired TINs. Filters to only locations that are affiliated with the given TINs.\nNote: This parameter cannot be used in combination with any other TINs related parameters. All other TINs related parameters will be ignored.\n"},"tin_name":{"type":"string","description":"String input that is fuzzy matched against the `tins.name` field. Filters to only locations that are affiliated with the given TINs name."},"tin_legal_name":{"type":"string","description":"String input that is fuzzy matched against the `tins.legal_name` field. Filters to only locations that are affiliated with the given TINs legal name."}}}}],"responses":{"200":{"description":"Returns an ordered list of matching locations","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"allOf":[{"type":"object","properties":{"total_count":{"type":"integer","example":141,"description":"The total number of results matched, across all pages."},"sort_by":{"type":"string","example":"distance","description":"The main criteria used to sort results in the record set."},"geo":{"type":"object","properties":{"latitude":{"type":"number","example":40.7351327,"description":"The latitude the search was focused on."},"longitude":{"type":"number","example":-73.9881657,"description":"The longitude the search was focused on."}}}}},{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"fields":{"type":"array","items":{"type":"string","example":"locations"},"example":["locations","age"],"description":"List of fields within the location object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nCannot be used in tandem with `_excl_fields`\n"},"_excl_fields":{"type":"array","items":{"type":"string","example":"locations"},"example":["locations","age"],"description":"List of fields within the location object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use."}}},{"type":"object","properties":{"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"New York, NY"},"name":{"type":"string","description":"String input for a fuzzy search on location name.","example":"Citymd Urgent Care"},"distance":{"type":"integer","example":10,"description":"The proximity radius of locations returned.\n"},"location_types":{"type":"array","items":{"type":"string","example":"Urgent Care"},"description":"List of values that filter to what type of facilities to show. We categorize locations into 34 types. Clients can add their own locations with unique location_types, and they will also be included in the search.\nSee the Location Types Reference Endpoint for a list of all location types.\n","example":["Urgent Care"]},"_excl_location_types":{"type":"array","items":{"type":"string","example":"Urgent Care"},"description":"List of the 'types' of locations to exclude. Excludes locations with a matching location type.\n","example":["Urgent Care"]},"insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"description":"List of desired insurance uuids. See all locations that accept a given insurance(s).","example":["e527f6e3-fe42-4932-bf34-d81f1c1fd652"]},"_excl_insurance_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"e527f6e3-fe42-4932-bf34-d81f1c1fd652"},"description":"List of insurance uuids to exclude. Exclude locations that accept a given insurance(s).","example":["e527f6e3-fe42-4932-bf34-d81f1c1fd652"]},"insurance_carrier_name":{"type":"string","description":"String input of carrier_name in order to search for all locations that take at least one plan from a given insurance carrier.\nFind the individual valid carrier_name values from the insurance objects returned in the Insurances Reference Endpoint.\nNote: This input must be an exact string match to work\n","example":"Aetna"},"min_confidence":{"type":"integer","minimum":0,"maximum":5,"description":"Integer input (0-5) of the minimum confidence threshold for returned locations. min_location_confidence=4 will only display locations that have a confidence 4 or higher.\n"},"national_bluecard":{"type":"boolean","example":true,"description":"Boolean input that enables an API search to automatically default to the National BlueCard EPO/PPO Network whenever a member searches for out-of-state, in-network care and is covered by a BCBS Association PPO insurance plan. Use the parameter in conjunction with the address parameter and either the insurance_ids or insurance fuzzy search parameters. Defaults to true unless otherwise specified."}}},{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"string","example":"86722ebb-1dd1-4846-a1a9-a7a9e36c944d"},"description":"Comma separated list of desired organization uuids. Filters to only locations that are affiliated with the given organization uuid(s).\n","example":["86722ebb-1dd1-4846-a1a9-a7a9e36c944d"]},"_excl_organization_ids":{"type":"array","items":{"type":"string","example":"497a1ac1-52cc-43a9-b796-844dabde10fc"},"description":"Comma separated list of organization uuids to exclude. Excludes locations that are affiliated with the given organization uuid(s).","example":["86722ebb-1dd1-4846-a1a9-a7a9e36c944d"]}}},{"type":"object","properties":{"clinical_area":{"$ref":"#/paths/~1custom~1clinical_areas~1%7Bclinical_area_uuid%7D/get/responses/200/content/application~1json/schema"},"clinical_area_ids":{"type":"array","items":{"type":"string","example":"4c03ddb4-f6c0-4574-a51e-508f83c43d69"},"description":"List of desired clinical area ids.\nReturns all locations with a clinical area exactly matching any of the entered IDs.\n(Note: Use the `/clinical_areas/` reference endpoint to identify relevant IDs)\n","example":["4c03ddb4-f6c0-4574-a51e-508f83c43d69"]},"treatment":{"$ref":"#/paths/~1custom~1treatments~1%7Btreatment_uuid%7D/get/responses/200/content/application~1json/schema"},"treatment_ids":{"type":"array","items":{"type":"string","example":"e3079513-bf55-41cc-87c6-f7ff5f923085"},"description":"List of desired treatment ids.\nReturns all providers with a `treatments.uuid` field exactly matching any of the entered IDs.\n(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs)\n","example":["e3079513-bf55-41cc-87c6-f7ff5f923085"]}}},{"type":"object","properties":{"tin_ids":{"type":"string","description":"List of desired TINs."},"tin_name":{"type":"string"},"tin_legal_name":{"type":"string"}}}]},"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"distance":{"type":"number","example":0.4,"description":"This location's distance from the center of a geographic search, in miles."}}},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema"}]}}}}}}},"400":{"description":"The search could not be completed as requested","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"Account does not have access to custom locations directory","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}}}},"post":{"summary":"Create Location","description":"Create new locations and facilities.\n\n#### Example Use Case\nYou want to add new urgent care locations (or labs, imaging centers, therapy centers, etc.) to an area that are not yet included in the existing Ribbon locations listings.\n","operationId":"postCustomLocations","tags":["Locations"],"requestBody":{"required":true,"description":"A JSON object describing the location you want to create.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"f38b9fd5-1e28-4f6e-953c-1e1493b68e21","description":"A UUID uniquely identifying this location"},"name":{"type":["string","null"]},"address":{"type":"string","example":"185 Berry St # 130, San Francisco, CA 94107, US"},"address_details":{"type":"object","properties":{"street":{"type":"string","example":"185 Berry St # 130"},"address_line_1":{"type":"string","example":"185 Berry St"},"address_line_2":{"type":["string","null"],"example":"# 130"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":94107}}},"latitude":{"type":"number","example":37.7765973},"longitude":{"type":"number","example":-122.3919488},"google_maps_link":{"type":"string","format":"url","example":"https://www.google.com/maps/@37.7765973-122.3919488?q=185%20Berry%20St%20%23%20130%2C%20SF%2C%20CA%2094107%2C%20US"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":4155146410},"details":{"type":"string","example":"primary"}}}},"faxes":{"type":"array","description":"Fax numbers associated with this location.\n\nThis property only appears for customers purchasing fax data. If you would like this property and are not receiving it, please reach out to support.\n","items":{"type":"object","properties":{"phone":{"type":"string","example":2121234567},"details":{"type":"string","example":"secondary"},"confidence":{"type":"integer","example":3}}}},"confidence":{"type":["integer","null"],"example":2,"description":"Each location contains a confidence score. This score indicates the probability of the given provider practicing at said location with the included contact information\n\nThis field will only be populated for Ribbon-provided locations. Locations you create yourself will have a confidence score of `null`.\n"},"insurances":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of insurances UUIDs accepted at this location"},"tins":{"type":"string","description":"Comma separated list of standard 9-digit identification code(s) used by the IRS for business entities and used for contracting and paying provider/facility claims.\n"}}}}}},"responses":{"201":{"description":"Location was successfully created.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"A location with this `address` and `name` pair already exists.","content":{"application/json":{"schema":{"type":"object","description":"Resource with given fields aready exists","required":["error"],"properties":{"error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","example":409},"code":{"type":"string","enum":["conflict"]},"message":{"type":"string","enum":["resource already exists"]}}}}}}}}}}},"/custom/locations/{location_uuid}":{"get":{"summary":"Get Location","description":"Retrieve data on a specific location.\n","operationId":"getCustomLocation","tags":["Locations"],"parameters":[{"name":"location_uuid","in":"path","required":true,"description":"The UUID of the target location.","schema":{"type":"string","format":"uuid","example":"34ecc98a-e49e-49e3-84f9-b0ab2ff00495"}}],"responses":{"200":{"description":"Returns a single location","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"f38b9fd5-1e28-4f6e-953c-1e1493b68e21","description":"A UUID uniquely identifying this location"},"name":{"type":["string","null"]},"address":{"type":"string","example":"185 Berry St # 130, San Francisco, CA 94107, US"},"address_details":{"type":"object","properties":{"street":{"type":"string","example":"185 Berry St # 130"},"address_line_1":{"type":"string","example":"185 Berry St"},"address_line_2":{"type":["string","null"],"example":"# 130"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":94107}}},"latitude":{"type":"number","example":37.7765973},"longitude":{"type":"number","example":-122.3919488},"google_maps_link":{"type":"string","format":"url","example":"https://www.google.com/maps/@37.7765973-122.3919488?q=185%20Berry%20St%20%23%20130%2C%20SF%2C%20CA%2094107%2C%20US"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":4155146410},"details":{"type":"string","example":"primary"}}}},"faxes":{"type":"array","description":"Fax numbers associated with this location.\n\nThis property only appears for customers purchasing fax data. If you would like this property and are not receiving it, please reach out to support.\n","items":{"type":"object","properties":{"phone":{"type":"string","example":2121234567},"details":{"type":"string","example":"secondary"},"confidence":{"type":"integer","example":3}}}},"confidence":{"type":["integer","null"],"example":2,"description":"Each location contains a confidence score. This score indicates the probability of the given provider practicing at said location with the included contact information\n\nThis field will only be populated for Ribbon-provided locations. Locations you create yourself will have a confidence score of `null`.\n"},"insurances":{"type":"array","items":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"},"description":"List of insurances the accepted at this location"},"tins":{"type":"string","description":"Comma separated list of standard 9-digit identification code(s) used by the IRS for business entities and used for contracting and paying provider/facility claims.\n"}}}}}},"404":{"description":"The given location UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Add or Edit Location Fields","description":"Edit all fields that do not fall under `insurances`, `google_maps_link`, `latitude`, or `longitude`. You may also add new fields or remove existing fields.\n","operationId":"putCustomLocation","tags":["Locations"],"parameters":[{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"type":"object","properties":{"remove_fields":{"type":"array","items":{"type":"string"},"description":"An optional list of custom fields name to remove from the location"}},"additionalProperties":{"type":["string","integer","boolean","null"]},"example":{"location_types":"Imaging Center","priority_flag":true}}}}},"responses":{"200":{"description":"The specified fields were successfully updated or added","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update fields which cannot be customized or attempted to set a location_type value which does not exist.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given location UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Location","description":"Delete a location.\n","operationId":"deleteCustomLocation","tags":["Locations"],"parameters":[{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"responses":{"204":{"description":"Location was successfully deleted"},"404":{"description":"The given location UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/locations/{location_uuid}/insurances":{"put":{"summary":"Add Or Remove Location Insurances","description":"Add or remove insurances from a location using our standard insurance UUIDs.\n","operationId":"putCustomLocationInsurances","tags":["Locations"],"parameters":[{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the location's insurances.","content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string","format":"uuid","example":"003aa14f-31ed-4c20-8888-07055d69afb6"},"description":"A list of UUIDs to add to this location's set.","example":["003aa14f-31ed-4c20-8888-07055d69afb6"]},"remove":{"type":"array","items":{"type":"string","format":"uuid","example":"000914b4-d165-4343-bd17-0054505faaa5"},"description":"A list of UUIDs to remove to this location's set.","example":["000914b4-d165-4343-bd17-0054505faaa5"]},"override":{"type":"array","items":{"type":"string","format":"uuid","example":"000914b4-d165-4343-bd17-0054505faaa5"},"description":"A list of UUIDs to remove to completely replace this location's set with.\nNot supported in combination with either `add` or `remove`."}},"example":{"add":["003aa14f-31ed-4c20-8888-07055d69afb6"],"remove":["000914b4-d165-4343-bd17-0054505faaa5"]}}}}},"responses":{"200":{"description":"The insurances list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D~1insurances/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported, or attempted to use invalid value type.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given location UUID cannot be found, or NPI in request path is not in custom provider directory.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/locations/{location_uuid}/organizations":{"put":{"summary":"Add Or Remove Location Organizations","description":"Add or remove organizations from a location using our standard organization UUIDs.\n","operationId":"putCustomLocationOrganizations","tags":["Locations"],"parameters":[{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the location's organizations.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D~1insurances/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The organizations list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D~1insurances/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported, or attempted to use invalid value type.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given location UUID cannot be found, or NPI in request path is not in custom provider directory.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/locations/{location_uuid}/clinical_areas":{"put":{"summary":"Add Or Remove Location Clinical Areas","description":"Add or remove clinical areas from a location using our standard clinical area UUIDs.\n","operationId":"putCustomLocationClinicalAreas","tags":["Locations"],"parameters":[{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A set of instructions for how to update the location's clinical areas.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D~1insurances/put/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The clinical areas list was successfully modified.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D~1insurances/put/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to use fields which are not supported, or attempted to use invalid value type.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given location UUID cannot be found, or NPI in request path is not in custom provider directory.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/locations/filters":{"get":{"summary":"Get Location Filters","description":"Fetch all previously created custom filters for locations.\n","operationId":"getCustomLocationFilters","tags":["Filters"],"responses":{"200":{"description":"Returns a list of location filters","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1custom~1providers~1filters/post/responses/201/content/application~1json/schema/properties/data"}}}}}}}}},"post":{"summary":"Create Location Filter","description":"Create new filters to be used when searching for locations in the [Search Locations](./getcustomlocations) endpoint. \nYou can create filters for both Ribbon's existing data fields as well as any custom data fields you create.\n\n#### Example Use Case:\nLet's say you add a new field to a bunch of locations that match your use case, for instance `c_section_rate`. You could make this field searchable so that your search through [Search Locations](./getcustomlocations) when you pass through a certain parameter that specifies a maximum threshold.\n","operationId":"createCustomLocationFilter","tags":["Filters"],"requestBody":{"required":true,"description":"The new filter to create","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1providers~1filters/post/requestBody/content/application~1json/schema"}}}},"responses":{"201":{"description":"The specified filter was successfully created","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1providers~1filters/post/responses/201/content/application~1json/schema/properties/data"}}}}}},"400":{"description":"The filter you attempted to create was malformed","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"A filter with the given `parameter` name already exists","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/custom/locations/filters/{filter_uuid}":{"put":{"summary":"Edit Location Filter","description":"Edit any of the fields in a custom location filter you have already created.\n","operationId":"editCustomLocationFilter","tags":["Filters"],"parameters":[{"name":"filter_uuid","in":"path","required":true,"description":"The UUID of the filter you want to edit.","schema":{"type":"string","format":"uuid","example":"b5458763-968e-4690-bc70-f29d3a7459a9"}}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value.","content":{"application/json":{"schema":{"type":"object","required":["parameter","field","value_type","filter_type"],"properties":{"parameter":{"type":"string","description":"The name of filter which will be used when applying to a search\n","example":"location_types_filter"},"field":{"type":"string","description":"The name of the field that the filter will be applied to\n\nYou can specify nested fields by placing a `.` between each level within the JSON object. For example, `address_details.state`\n","example":"location_types"},"value_type":{"type":"string","enum":["string","float","integer","boolean","list"],"description":"The data type of the value passed into this filter","example":"list"},"filter_type":{"type":"string","enum":["less_than","greater_than","equals","contains","boost","equals_any","contains_any","fuzzy"],"description":"The type of comparison that will occur between the value passed into this filter and the field specified in the `field` parameter\n\nNote that `boost` filters have several limitations:\n- A Boost Filter cannot use the following `value_type`s: `float`\n- If a Boost Filter's `field` targets something that is within a list of objects, such as ‘educations.education.name’, we will not reorder the list to bring these items to the front. We will merely boost records where there is an entry in the list that matches the filter, wherever it is.\n - There is one exception to this: `locations`. If you search for a provider and boost fields nested within the `locations` list, we will reorder the locations to put matching locations first.\n","example":"contains_any"}}}}}},"responses":{"200":{"description":"The specified filter was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["uuid","filter"],"properties":{"uuid":{"type":"string","format":"uuid","description":"A UUID uniquely identifying this filter","example":"9da04268-65e4-4422-a095-98208695b8b9"},"filter":{"$ref":"#/paths/~1custom~1locations~1filters~1%7Bfilter_uuid%7D/put/requestBody/content/application~1json/schema"}}}}}}}},"400":{"description":"The filter updates you are trying to make are invalid or malformed.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given filter UUID cannot be found.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"A filter with the given parameter already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Location Filter","description":"Delete a location filter.\n","operationId":"deleteCustomLocationFilter","tags":["Filters"],"parameters":[{"name":"filter_uuid","in":"path","required":true,"description":"The UUID of the filter you want to delete.","schema":{"type":"string","format":"uuid","example":"b5458763-968e-4690-bc70-f29d3a7459a9"}}],"responses":{"204":{"description":"Filter was successfully deleted"},"404":{"description":"The given filter UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/insurances":{"get":{"summary":"Search Insurances","description":"Search and list insurances that exist within the Ribbon API.\n","operationId":"getInsurances","tags":["Reference Endpoints"],"parameters":[{"name":"Insurance Search Parameters","in":"query","required":false,"description":"Search parameters for the insurances reference endpoint.","explode":true,"schema":{"type":"object","properties":{"search":{"type":"string","description":"String input that fuzzy searches across `display_name`, `carrier_name`, and `uuid`.\n","example":"Aetna"},"carrier_association":{"type":"string","description":"Comma separated list of the carrier association of insurances you are searching for.\n\nNote: This input must be an exact string match to work\n","example":"BCBS Association"},"carrier_brand":{"type":"string","description":"Comma separated list of the carrier brand of insurances you are searching for.\n\nNote: This input must be an exact string match to work\n","example":"BCBS"},"carrier_name":{"type":"string","description":"Comma separated list of the carrier name of insurances you are searching for.\n\nNote: This input must be an exact string match to work\n","example":"Blue Cross Blue Shield of Illinois"},"state":{"type":"string","description":"Two letter abbreviated state code of insurances you are searching for.","example":"NY"},"plan_name":{"type":"string","description":"Exact string input of the plan name of insurances you are searching for.","example":"BlueCare Direct"},"plan_type":{"type":"string","description":"Exact string input of the plan type of insurances you are searching for.","example":"PPO"},"display_name":{"type":"string","description":"Exact string input of the display name of insurances you are searching for.","example":"Blue Cross Blue Shield of Illinois - BlueCare Direct - HMO"},"category":{"type":"string","description":"Comma separated list of the category of insurances you are searching for.\n\nNote: This input must be an exact string match to work\n","example":"Medicare Advantage"},"_excl_category":{"type":"string","description":"Comma separated list of the category of insurances you wish to exclude.\n\nNote: This input must be an exact string match to work\n","example":"Medicare Advantage"},"codes":{"type":"string","description":"Single code input to search for plans with an exact string match within the codes field.","example":"H9572-001"},"partial_codes":{"type":"string","description":"Partial string input to match to the codes field.\nFor Medicare Advantage plans this is a contract ID (i.e. H9572). For Federal or State Exchange plans this is the first 10 digits of the HIOS ID (i.e. 36096il100)\n\nNote: This parameter can only be used if the `category` param is also utilized with a single category value.\n","example":"H9572"}}}}],"responses":{"200":{"description":"Insurances returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":141},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/insurances?search=aetna&page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/insurances?search=aetna&page=1"},"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}}}}}},"400":{"description":"A failure due to a malformed request","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}},"post":{"summary":"Create Insurance","description":"Create a insurance with desired field values.\n","operationId":"postCustomInsurance","tags":["Reference Endpoints"],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"d8addf29-1054-4ccb-b179-dda65f7fefdd","description":"A UUID uniquely identifying this insurance"},"carrier_association":{"type":["string","null"],"example":"Aetna"},"carrier_brand":{"type":["string","null"],"example":"Aetna"},"carrier_name":{"type":["string","null"],"example":"Aetna"},"state":{"type":["string","null"],"example":"NY"},"plan_name":{"type":["string","null"],"example":"Aetna HealthFund Open Choice"},"plan_type":{"type":["string","null"],"example":"PPO"},"metal_level":{"type":["string","null"]},"display_name":{"type":"string","example":"Aetna - HealthFund Open Choice - PPO"},"network":{"type":["string","null"]},"confidence":{"type":["integer","null"],"example":4},"category":{"type":["string","null"]},"codes":{"type":["array"],"items":{"type":"string"}}}}}}},"responses":{"201":{"description":"Insurance was successfully created.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"Insurance object with given fields already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}}},"/custom/insurances/{insurance_uuid}":{"get":{"summary":"Get Insurance","description":"Retrieve data on a specific insurance.\n","operationId":"getCustomInsurance","tags":["Reference Endpoints"],"parameters":[{"name":"insurance_uuid","in":"path","required":true,"description":"The UUID of the target insurance.","schema":{"type":"string","format":"uuid","example":"12403618-49d5-43ee-99ad-5e99194fe05c"}}],"responses":{"200":{"description":"Returns a single insurance","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}}},"404":{"description":"The given insurance UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Edit Insurance Fields","description":"Edit fields of a custom created insurance or a Ribbon created insurance.\n","operationId":"putCustomInsurance","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1insurances~1%7Binsurance_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The insurance object was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given insurance UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"Insurance object with given fields already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Insurance","description":"Delete an insurance.\n\nNote: If you've added this insurance to doctors, you are deleting all instances of this UUID, and Ribbon will not be able to regenerate them.\n","operationId":"deleteCustomInsurance","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1insurances~1%7Binsurance_uuid%7D/get/parameters/0"}],"responses":{"204":{"description":"Insurance was successfully deleted"},"404":{"description":"The given insurance UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/specialties":{"get":{"summary":"Search Specialties","description":"Search and list specialties that exist within the Ribbon API.\n","operationId":"getSpecialties","tags":["Reference Endpoints"],"parameters":[{"name":"Specialty Search Parameters","in":"query","required":false,"description":"Search parameters for the specialty reference endpoint.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"search":{"type":"string","description":"String input that fuzzy searches against key fields within each specialties object to return the most relevant options.\n","example":"Gastroenterology"},"provider_type":{"type":"string","description":"'Type' of provider specialty to filter results on. Here are a few key provider types:\n- Doctor\n- Nursing\n- Dental Providers\n","example":"Doctor"}}}}],"responses":{"200":{"description":"Specialties returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":141},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/specialties?page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/specialties?page=1"},"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"403":{"description":"Trial accounts do not have access to custom specialties","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}}}},"post":{"summary":"Create Specialty","description":"Create a custom specialty with desired field values.\n","operationId":"postCustomSpecialty","tags":["Reference Endpoints"],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}],"required":["display","board_specialty","board_sub_specialty","non_md_specialty","non_md_sub_specialty","provider_name","colloquial","provider_type"]}}}},"responses":{"201":{"description":"Specialty was successfully created.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"Specialty object with given fields already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}}},"/custom/specialties/{specialty_uuid}":{"get":{"summary":"Get Specialty","description":"Retrieve data on a specific specialty.\n","operationId":"getCustomSpecialty","tags":["Reference Endpoints"],"parameters":[{"name":"specialty_uuid","in":"path","required":true,"description":"The UUID of the target specialty.","schema":{"type":"string","format":"uuid","example":"a77d23ba-29f1-4afd-a0c4-62d2f0444cf7"}}],"responses":{"200":{"description":"Returns a single specialty","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"18d8ad26-7e5f-44ac-9afa-966efb375344","description":"A UUID uniquely identifying this specialty"},"taxonomy_code":{"type":["string"],"example":"207Q00000X"},"board_specialty":{"type":["string","null"],"example":"Family Medicine"},"board_sub_specialty":{"type":["string","null"]},"non_md_specialty":{"type":["string","null"]},"non_md_sub_specialty":{"type":["string","null"],"example":"None"},"provider_name":{"type":["string","null"],"example":"Family Medicine Doctor"},"colloquial":{"type":["string","null"]},"taxonomy_1":{"type":["string","null"],"example":"Allopathic & Osteopathic Physicians"},"taxonomy_2":{"type":["string","null"],"example":"Family Medicine"},"taxonomy_3":{"type":["string","null"]},"display":{"type":"string","example":"Family Medicine"},"provider_type":{"type":"string","example":"Doctor"},"is_primary":{"type":"boolean","example":true,"description":"Whether or not a specialty is a provider's primary specialty"}}}}}},"404":{"description":"The given specialty UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Edit Specialty Fields","description":"Edit fields of a custom created specialty.\n\nNote: You cannot edit a Ribbon created specialty.\n","operationId":"putCustomSpecialty","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1specialties/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The specialty object was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given specialty UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"Specialty object with given fields already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Specialty","description":"Delete a specialty.\n\nNote: You cannot delete a Ribbon created specialty.\n","operationId":"deleteCustomSpecialty","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/parameters/0"}],"responses":{"204":{"description":"Specialty was successfully deleted"},"404":{"description":"The given specialty UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/clinical_areas":{"get":{"summary":"Search Clinical Areas","description":"Returns clinical areas that exist within the Ribbon API.\n","operationId":"getClinicalAreas","tags":["Focus Area Endpoints"],"parameters":[{"name":"Clinical Area Search Parameters","in":"query","required":false,"description":"Search parameters for the clinical area endpoint.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"search":{"type":"string","example":"X-ray","description":"String input that fuzzy searches against key fields within each clinical area object to return the most relevant options.\n"},"clinical_area":{"type":"string","example":"Nutrition","description":"String input that fuzzy searches on `display` field."},"_excl_clinical_area_ids":{"type":"string","example":"ffce41b2-aba4-4202-beba-6aa9dc51ef37,fe7d808b-5f53-4024-af9d-2662515bcd83","description":"Comma separated list of clinical area UUIDs to exclude from search results."},"specialty_ids":{"type":"string","example":"fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5","description":"Comma separated list of specialty UUIDs."},"condition":{"type":"string","example":"Sleep Disorders","description":"String input that fuzzy searches on `condition.display` field."},"condition_ids":{"type":"string","example":"45c9a22c-7a0f-4405-b0c9-c5f8ad83ba32,219d3998-d7e2-4b9e-91d1-17c19cd0bbc2","description":"Comma separated list of condition UUIDs."},"treatment":{"type":"string","example":"ACL Surgery","description":"String input that fuzzy searches on `treatment.display` field."},"treatment_ids":{"type":"string","example":"bb2ca22c-7a0f-4405-b0c9-c5f8ad839898,2ce33998-d7e2-4b9e-91d1-17c19cd06012","description":"Comma separated list of treatment UUIDs."},"type":{"type":"string","example":"providers","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.\n"}}}}],"responses":{"200":{"description":"Clinical areas returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","parameters","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":107},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/clinical_areas?page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/clinical_areas?page=1"},"parameters":[{"$ref":"#/paths/~1custom~1clinical_areas/get/parameters/0"}],"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1clinical_areas~1%7Bclinical_area_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"400":{"description":"Each request can only perform one search","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/custom/clinical_areas/{clinical_area_uuid}":{"get":{"summary":"Get Clinical Area","description":"Retrieve data on a specific clinical area.\n","operationId":"getClinicalArea","tags":["Focus Area Endpoints"],"parameters":[{"name":"clinical_area_uuid","in":"path","required":true,"description":"The UUID of the target clinical area.","schema":{"type":"string","format":"uuid","example":"f352b596-dfb0-494f-9a03-224794f5d182"}}],"responses":{"200":{"description":"Returns a single clinical area","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"f352b596-dfb0-494f-9a03-224794f5d182","description":"A UUID uniquely identifying this clinical area"},"display":{"type":"string","example":"Substance Disorders (e.g. Opioid, Cocaine, Alcohol)"},"types":{"type":"array","items":{"type":"string","enum":["providers","locations"]}},"conditions":{"type":"array","items":{"$ref":"#/paths/~1custom~1conditions~1%7Bcondition_uuid%7D/get/responses/200/content/application~1json/schema"}},"treatments":{"type":"array","items":{"$ref":"#/paths/~1custom~1treatments~1%7Btreatment_uuid%7D/get/responses/200/content/application~1json/schema"}},"specialties":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"404":{"description":"The given clinical area UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/conditions":{"get":{"summary":"Search Conditions","description":"Returns conditions that exist within the Ribbon API.\n","operationId":"getConditions","tags":["Focus Area Endpoints"],"parameters":[{"name":"Condition Search Parameters","in":"query","required":false,"description":"Search parameters for the condition endpoint.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"search":{"type":"string","description":"String input that fuzzy searches against key fields within each condition object to return the most relevant options.\n","example":"depression"},"_excl_condition_ids":{"type":"string","example":"2938baf9-f064-44d6-8251-6e4b9fbb6fd2,c9d21735-8a78-45fe-982b-d216cb94beb7","description":"Comma separated list of condition UUIDs to exclude from search results."},"specialty_ids":{"type":"string","example":"fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5","description":"Comma separated list of specialty UUIDs."},"module":{"type":"string","example":"focus_areas","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\n"}}}}],"responses":{"200":{"description":"Conditions returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","parameters","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":480},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/conditions?page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/conditions?page=1"},"parameters":[{"$ref":"#/paths/~1custom~1conditions/get/parameters/0"}],"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1conditions~1%7Bcondition_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"400":{"description":"Module does not exist","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/custom/conditions/{condition_uuid}":{"get":{"summary":"Get Condition","description":"Retrieve data on a specific condition.\n","operationId":"getCondition","tags":["Focus Area Endpoints"],"parameters":[{"name":"condition_uuid","in":"path","required":true,"description":"The UUID of the target condition.","schema":{"type":"string","format":"uuid","example":"fd7c10f3-fbec-482a-929b-be94a8bb3bc1"}}],"responses":{"200":{"description":"Returns a single condition","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"99f4762e-c4c2-4d1d-983a-2b8b303e691d","description":"A UUID uniquely identifying this condition"},"display":{"type":"string","example":"Chronic Depression"},"types":{"type":"array","items":{"type":"string","enum":["focus_areas","condition_cost_estimate"]}},"specialties":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}},"modules":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"The given condition UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/treatments":{"get":{"summary":"Search Treatments","description":"Returns treatments that exist within the Ribbon API.\n","operationId":"getTreatments","tags":["Focus Area Endpoints"],"parameters":[{"name":"Treatment Search Parameters","in":"query","required":false,"description":"Search parameters for the treatment endpoint.","explode":true,"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"search":{"type":"string","description":"String input that fuzzy searches against key fields within each treatment object to return the most relevant options.\n","example":"Ankle X-Ray"},"_excl_treatment_ids":{"type":"string","example":"ffb31993-8265-45f6-98ac-18a495d614b5,ff36f4f1-7031-46b0-a297-e85b73aa8e90","description":"Comma separated list of treatment UUIDs to exclude from search results."},"specialty_ids":{"type":"string","example":"fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5","description":"Comma separated list of specialty UUIDs."},"type":{"type":"string","example":"providers","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.\n"}}}}],"responses":{"200":{"description":"Treatments returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","parameters","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":477},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/treatments?page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/custom/treatments?page=1"},"parameters":[{"$ref":"#/paths/~1custom~1treatments/get/parameters/0"}],"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1treatments~1%7Btreatment_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/custom/treatments/{treatment_uuid}":{"get":{"summary":"Get Treatment","description":"Retrieve data on a specific treatment.\n","operationId":"getTreatment","tags":["Focus Area Endpoints"],"parameters":[{"name":"treatment_uuid","in":"path","required":true,"description":"The UUID of the target treatment.","schema":{"type":"string","format":"uuid","example":"88a70b34-d0a7-47e2-89ac-4fed203eca2f"}}],"responses":{"200":{"description":"Returns a single treatment","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"88a70b34-d0a7-47e2-89ac-4fed203eca2f","description":"A UUID uniquely identifying this treatment"},"display":{"type":"string","example":"Knee Replacement"},"types":{"type":"array","items":{"type":"string","enum":["providers","locations"]}},"specialties":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"404":{"description":"The given treatment UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/organizations":{"get":{"summary":"Search Organizations","description":"Search for different organizations.\n\n#### Example Use Case\nDisplay a map of all of all nearby health systems and their relevant information so that a patient can find care.\n","operationId":"getOrganizations","tags":["Organizations"],"parameters":[{"name":"address","in":"query","required":false,"description":"String input of an address that will be interpreted and geocoded in real time.","schema":{"type":"string","example":"New York, NY"}},{"name":"name","in":"query","required":false,"description":"String input that is fuzzy matched to against the `organization.name` field.","schema":{"type":"string","example":"baptist"}},{"name":"distance","in":"query","required":false,"description":"Constrains the search to within this many miles of the center point","schema":{"type":"integer","example":10}},{"name":"location","in":"query","required":false,"description":"Latitude/longitude pair of coordinates in lieu of a string address.","schema":{"type":"string","example":"37.7489816,-122.4802092"}},{"$ref":"#/paths/~1procedures/get/parameters/2"},{"$ref":"#/paths/~1procedures/get/parameters/3"}],"responses":{"200":{"description":"Specialties returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"type":"object","properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"total_count":{"type":"integer","example":141,"description":"The total number of results matched, across all pages."},"sort_by":{"type":"string","example":"distance","description":"The main criteria used to sort results in the record set."},"distance":{"type":"integer","example":10,"description":"The proximity radius of locations returned."},"geo":{"type":"object","properties":{"latitude":{"type":"number","example":40.7351327,"description":"The latitude the search was focused on."},"longitude":{"type":"number","example":-73.9881657,"description":"The longitude the search was focused on."}}},"address":{"type":["string","null"],"description":"String input of an address that will be interpreted and geocoded in real time.","example":"Jacksonville, FL, USA"},"name":{"type":"string","description":"String input that is fuzzy matched to against the `organization.name` field.","example":"baptist"}}},"data":{"type":"array","items":{"$ref":"#/paths/~1custom~1organizations~1%7Borganization_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/custom/organizations/{organization_uuid}":{"get":{"summary":"Get Organization","description":"Retrieve detailed information for any organization given its UUID\n","operationId":"getOrganization","tags":["Organizations"],"parameters":[{"name":"organization_uuid","in":"path","required":true,"description":"The UUID of the target organization.","schema":{"type":"string","format":"uuid","example":"a1dbf998-a65b-4780-8361-648357785d96"}}],"responses":{"200":{"description":"The requested organization is returned","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"a1dbf998-a65b-4780-8361-648357785d96","description":"A UUID uniquely identifying this organization"},"name":{"type":"string","example":"Baptist Health (Jacksonville)"},"organization_types":{"type":"array","items":{"type":"string","enum":["Health System"]},"description":"The types of this organization. We currently only support `Health System` organizations, but plan to expand this in the future"},"websites":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"https://www.baptistjax.com/"}}},"description":"Website(s) of this organization"},"ids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"5"},"id_type":{"type":"string","example":"AHA_ID"}}}},"address":{"type":"string","example":"841 Prudential Dr # 1601, Jacksonville, FL 32207, US"},"address_details":{"type":"object","properties":{"zip":{"type":"string","example":"32207"},"city":{"type":"string","example":"Jacksonville"},"state":{"type":"string","example":"FL"},"street":{"type":"string","example":"841 Prudential Dr # 1601"},"address_line_1":{"type":"string","example":"841 Prudential Dr"},"address_line_2":{"type":"string","example":"# 1601"}}},"latitude":{"type":"number","example":30.3159499},"longitude":{"type":"number","example":81.6630919},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","example":"9042022000"},"detail":{"type":"string","example":"primary"}}}}}}}}},"404":{"description":"The given UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/tin":{"get":{"summary":"Search TINs","description":"Search and list tins that exist within the Ribbon API.\n","operationId":"getTins","tags":["TINs"],"parameters":[{"name":"Tins Search Parameters","in":"query","required":false,"description":"Search parameters for the tin reference endpoint.","explode":true,"schema":{"type":"object","properties":{"search":{"type":"string","description":"String input that fuzzy searches across tins, name, address, and legal_name.\n"},"name":{"type":"string","description":"The billing entity name that appears on claims data, or if available, the official legal name of the billing entity.\nString input that is fuzzy matched against the `name` field.\nNote: This parameter will not match with the `legal_name` field, only the `name` field.\n"},"legal_name":{"type":"string","description":"The legal name of the entity associated with the TIN.\nString input that is fuzzy matched against the `legal_name` field.\n"},"tin_ids":{"type":"string","description":"Comma separated list of TINs.\nNote: This parameter cannot be used in combination with any other parameters.\n"},"has_tin":{"type":"boolean","description":"Boolean input that applies to tin_confirmed field."},"page":{"type":"integer","description":"The page of the results which was returned."},"page_size":{"type":"integer","description":"How many results are in each page."}}}}],"responses":{"200":{"description":"Tins returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["parameters","tins"],"properties":{"parameters":{"oneOf":[{"type":"object","properties":{"tin_ids":{"type":"string","description":"Comma separated list of TINS."}}},{"type":"object","properties":{"search":{"type":"string","description":"String input that fuzzy searches across TINs, names, address, and legal_name."},"name":{"type":"string","description":"The billing entity name that appears on claims data, or if available, the official legal name of the billing entity.\nString input that is fuzzy matched against the `name` field.\n"},"legal_name":{"type":"string","description":"The legal name of the entity associated with the TIN.\nString input that is fuzzy matched against the `legal_name` field.\n"},"has_tin":{"type":"boolean","description":"Boolean input that applies to tin_confirmed field."},"page":{"type":"integer","description":"The page of the results which was returned."},"page_size":{"type":"integer","description":"The number of results per page."}}}]},"tins":{"type":"array","description":"array of returned TIN objects","items":{"type":"object","properties":{"tin":{"type":"string","description":"Standard 9-digit identification code used by the IRS for business entities and used for contracting and paying provider/facility claims.\n"},"name":{"type":"string","description":"The billing entity name that appears on claims data, or if available, the official legal name of the billing entity.\n"},"legal_name":{"type":"string","description":"The legal name of the entity associated with the TIN."},"address":{"type":"string","description":"The address of the organization with the TIN. This could be the primary service location or billing location.\n"},"tin_confirmed":{"type":"boolean","description":"A yes/no field that assesses whether a TIN is likely to be valid or not. The field is powered by business logic that triangulates IRS data and claims data.\n"}}}}}}}}},"403":{"description":"Trial accounts do not have access to custom tins","content":{"application/json":{"schema":{"type":"object","description":"You are not allow to make this request","required":["error"],"properties":{"error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","example":403},"code":{"type":"string","enum":["permission_denied"]},"message":{"type":"string","example":"a trial account does not have access to this functionality"}}}}}}}}}}},"/custom/tin/{tin_id}":{"get":{"summary":"Get TIN","description":"Retrieve data on a specific TIN.\n","operationId":"getCustomTin","tags":["TINs"],"parameters":[{"name":"tin_id","in":"path","required":true,"description":"The target TIN.","schema":{"type":"string","format":"uuid","example":123454321}}],"responses":{"200":{"description":"Returns a single TIN","content":{"application/json":{"schema":{"type":"object","properties":{"tin":{"type":"string","description":"Standard 9-digit identification code used by the IRS for business entities and used for contracting and paying provider/facility claims."},"name":{"type":"string","description":"The billing entity name that appears on claims data, or if available, the official legal name of the billing entity."},"legal_name":{"type":"string","description":"The legal name of the entity associated with the TIN."},"address":{"type":"string","description":"The address of the organization with the TIN. This could be the primary service location or billing location."},"tin_confirmed":{"type":"boolean","description":"A yes/no field that assesses whether a TIN is likely to be valid or not. The field is powered by business logic that triangulates IRS data and claims data."}}}}}},"404":{"description":"The given TIN UUID cannot be found","content":{"application/json":{"schema":{"type":"object","description":"The requested resource could not be found","required":["error"],"properties":{"error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","example":404},"code":{"type":"string","enum":["not_found"]},"message":{"type":"string","enum":["resource not found"]}}}}}}}}}}},"/provider_types":{"get":{"summary":"Search Provider Types","description":"Search and list provider types that exist within the Ribbon API.\n","operationId":"getCustomProviderTypes","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1languages/get/parameters/0"}],"responses":{"200":{"description":"Provider types returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","data"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":23},"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1provider_types~1%7Bprovider_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/custom/provider_types":{"post":{"summary":"Create Provider Type","description":"Create a custom provider type with desired field values.\n","operationId":"postCustomProviderType","tags":["Reference Endpoints"],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","example":"Certified Nurse Midwife"}}}}}},"responses":{"201":{"description":"Provider type was successfully created.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1provider_types~1%7Bprovider_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to create with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"Provider type object with given display_name already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}}},"/custom/provider_types/{provider_type_uuid}":{"get":{"summary":"Get Provider Type","description":"Retrieve data on a specific provider type.\n","operationId":"getCustomProviderType","tags":["Reference Endpoints"],"parameters":[{"name":"provider_type_uuid","in":"path","required":true,"description":"The UUID of the target provider type.","schema":{"type":"string","format":"uuid","example":"edeb875a-494a-4907-babb-5377ef1f49f9"}}],"responses":{"200":{"description":"Returns a single provider type","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"854a242b-9fa6-4427-b36f-ae7ba858e2c8","description":"A UUID uniquely identifying this provider type"},"display_name":{"type":"string","example":"Pediatrician"}}}}}},"404":{"description":"The given provider type UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Edit Provider Type Fields","description":"Edit fields of a custom created provider type.\n\nNote: You cannot edit a Ribbon created provider type.\n","operationId":"putCustomProviderType","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1provider_types~1%7Bprovider_type_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1provider_types/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The provider type object was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1provider_types~1%7Bprovider_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"This resource is managed by Ribbon and cannot be modified.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given provider type UUID cannot be found.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"Provider Type object with given display_name already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Provider Type","description":"Delete a provider type.\n\nNote: You cannot edit a Ribbon created provider type.\n","operationId":"deleteCustomProviderType","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1provider_types~1%7Bprovider_type_uuid%7D/get/parameters/0"}],"responses":{"204":{"description":"Provider type was successfully deleted"},"403":{"description":"This resource is managed by Ribbon and cannot be deleted.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given provider type UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/location_types":{"get":{"summary":"Search Location Types","description":"Search and list location types that exist within the Ribbon API.\n","operationId":"getCustomLocationTypes","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1languages/get/parameters/0"}],"responses":{"200":{"description":"Location types returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","data"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":7},"results":{"type":"array","items":{"$ref":"#/paths/~1custom~1location_types~1%7Blocation_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/custom/location_types":{"post":{"summary":"Create Location Type","description":"Create a location type with desired field values.\n","operationId":"postCustomLocationType","tags":["Reference Endpoints"],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1provider_types/post/requestBody/content/application~1json/schema"}}}},"responses":{"201":{"description":"Location type was successfully created.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1location_types~1%7Blocation_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to create with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"409":{"description":"Location type object with given display_name already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}}},"/custom/location_types/{location_type_uuid}":{"get":{"summary":"Get Location Type","description":"Retrieve data on a specific location type.\n","operationId":"getCustomLocationType","tags":["Reference Endpoints"],"parameters":[{"name":"location_type_uuid","in":"path","required":true,"description":"The UUID of the target location type.","schema":{"type":"string","format":"uuid","example":"b5458763-968e-4690-bc70-f29d3a7459a9"}}],"responses":{"200":{"description":"Returns a single location type","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"cd7f242d-3016-4db6-94f4-77b8237127a3","description":"A UUID uniquely identifying this location type"},"display_name":{"type":"string","example":"Radiology"}}}}}},"404":{"description":"The given location type UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}},"put":{"summary":"Edit Location Type Fields","description":"Edit fields of a custom created location type.\n\nNote: You cannot edit a Ribbon created location type.\n","operationId":"putCustomLocationType","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1location_types~1%7Blocation_type_uuid%7D/get/parameters/0"}],"requestBody":{"required":true,"description":"A JSON object mapping the name of the field to update to its new value","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1provider_types/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"The location type object was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/paths/~1custom~1location_types~1%7Blocation_type_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}},"400":{"description":"This request attempted to update with invalid schema or was missing required fields.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"403":{"description":"This resource is managed by Ribbon and cannot be modified.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given location type UUID cannot be found.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}},"409":{"description":"Location Type object with given display_name already exists.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1locations/post/responses/409/content/application~1json/schema"}}}}}},"delete":{"summary":"Delete Location Type","description":"Delete a location type.\n\nNote: You cannot edit a Ribbon created location type.\n","operationId":"deleteCustomLocationType","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1custom~1location_types~1%7Blocation_type_uuid%7D/get/parameters/0"}],"responses":{"204":{"description":"Location type was successfully deleted"},"403":{"description":"This resource is managed by Ribbon and cannot be deleted.","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin/get/responses/403/content/application~1json/schema"}}}},"404":{"description":"The given location type UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/custom/virtual_care_platforms":{"get":{"summary":"Search Virtual Care Platforms","description":"Search for different at-home or virtual platforms.\n\n#### Example Use Case\nEnable a patient to find a virtual care platform that focuses on their speciality need, has licensure in the state they live in, and is in-network for their insurance plan.\n","operationId":"getCustomVirtualCarePlatforms","tags":["Virtual Care Platforms"],"parameters":[{"name":"Virtual Care Platform Search Options","in":"query","required":false,"description":"Search options based on aspects of the virtual care platform objects.","explode":true,"schema":{"type":"object","properties":{"name":{"type":"string","description":"A full or partial platform name.\n\nNote: This parameter performs a case-insensitive exact string match (i.e. is not fuzzy).\n","example":"Virtual Care Platform"},"address_string":{"type":"string","description":"An address that will be interpreted and geocoded in real time.","example":"100 Main Street"},"insurance_ids":{"type":"string","description":"Comma-delimited list of desired insurance uuids. Returns all platforms which accept at least one of the given insurances.","example":"7b815b2f-ba65-4024-80aa-0ac1a9dcd4e0"},"specialty_ids":{"type":"string","description":"Comma-delimited list of desired specialty uuids. Returns all platforms which specialize in at least one of the given specialties.","example":"fff41986-41dc-46c0-93f0-5fb3fbd47678"},"npis":{"type":"string","description":"Comma-delimited list of type 2 NPIs associated with the platform.","example":1558319491},"offers_appts":{"type":"boolean","description":"Returns platforms that offer appointments.","example":true},"panel_ages":{"type":["string","integer"],"enum":["Pediatric","Adolescent","Adult","Senior"],"description":"Desired Panel Ages string, or an integer age.\n\nReturns all platforms with a `panel_demographics.ages` label field corresponding to the entered string or integer.\n","example":"Adolescent"},"panel_sexes":{"type":"string","enum":["Female","F","Male","M"],"description":"Returns all platforms with a `panel_demographics.sexes` label field corresponding to the entered string.","example":"Female"},"payment_method":{"type":"string","enum":["Cash Pay","Insurance"],"description":"Returns all platforms which accept the designated payment method.","example":"Cash Pay"},"provider_types":{"type":"string","description":"Comma-delimited list of the `type`s of providers you are searching for. Provider types are higher level groupings of specialties.","example":"Doctor"},"profile_claimed":{"type":"boolean","description":"Returns care platform profiles which are curated directly by the platform.\n\nWhen `False`, Ribbon has curated on behalf of the platform and may not have complete information for concepts such as licensure or insurances accepted.\n","example":true}}}}],"responses":{"200":{"description":"Returns an ordered list of matching virtual care platforms","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"type":"object","properties":{"total_count":{"type":"integer","example":141,"description":"The total number of results matched, across all pages."},"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"specialty_ids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["058148f1-3a99-4bbe-9722-6c2a54ddb860"]},"insurance_ids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["0082f872-5383-44de-9319-511f090fc56b"]},"address":{"type":"string","example":"408 broadway"},"geocoded_state":{"type":"string","example":"NY"}}},"data":{"type":"array","items":{"$ref":"#/paths/~1custom~1virtual_care_platforms~1%7Bvirtual_care_platform_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}},"400":{"description":"The search could not be completed as requested","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/custom/virtual_care_platforms/{virtual_care_platform_uuid}":{"get":{"summary":"Get Virtual Care Platform","description":"Retrieve detailed information for any virtual care platform given its UUID.\n","operationId":"getVirtualCarePlatform","tags":["Virtual Care Platforms"],"parameters":[{"name":"virtual_care_platform_uuid","in":"path","required":true,"description":"The UUID of the target virtual care platform.","schema":{"type":"string","format":"uuid","example":"c8fdf322-e562-479b-840d-e44931fb2a12"}}],"responses":{"200":{"description":"Returns a single virtual care platform","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Primary ID of this virtual care platform.","example":"c8fdf322-e562-479b-840d-e44931fb4112"},"name":{"type":"string","description":"Name of the virtual care platform.","example":"RibbonCare Platform"},"website":{"format":"string","description":"URL of the virtual care platform's website.","example":"https://www.ribbonvirtualcare.com"},"description":{"type":"string","example":"<p>RibbonCare is a virtual dermatology platform for eczema and psoriasis treatment.</p>"},"geographies_served":{"type":"array","items":{"type":"string","description":"2-letter state code of covered states.","example":"NY"},"example":["NY","TX","CA"]},"npis":{"type":"array","items":{"type":"integer","example":1234567890},"description":"NPIs of providers associated with this platform."},"specialties":{"type":"array","items":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"}},"specialties_detail":{"type":"string","example":"<p>We focus on eczma and psoriasis care</p>"},"insurances":{"type":"array","items":{"type":"string","format":"uuid","example":"0082f872-5383-44de-9319-511f090fc56b"}},"insurances_detail":{"type":"string","example":"<p>We have flexibility to do single case agreements with other payers/plans not listed on our profile</p>"},"sign_up_instructions":{"type":"string","example":"<ol><li>Create an account</li><li>Complete an online consultation to help your provider find the best treatment plan for your needs.</li><li>A provider trained in your specialty of concern will review your information and suggest a personalized treatment plan</li><li>If prescribed, we send your medication directly to your door</li><li>Get unlimited access messaging with your provider team to answer any questions and make changes as needed</li></ol>"},"care_delivery":{"type":"array","items":{"type":"string","example":"Virtual Care - Asynchronous"},"description":"Methods by which care can be delivered from this platform.","example":["Virtual Care - Asynchronous","Virtual Care - Live"]},"provider_types":{"type":"array","items":{"type":"string","example":"Doctor"},"description":"Types of the providers associated with this platform."},"provider_types_detail":{"type":"string","example":"<p>We also employ allied health professionals and lactation consultants</p>"},"panel_demographics":{"type":"object","properties":{"ages":{"type":"array","items":{"type":"string","enum":["Pediatric (0-12)","Adolescent (13-21)","Adult (22-44)","Adult (45-64)","Senior (65 and over)"]},"example":["Senior (65 and over)"]},"sexes":{"type":"array","items":{"type":"string","enum":["Both female and male","Primarily female","Primarily male"]},"example":["Both female and male"]},"detail":{"type":["string","null"]}}},"offers_appointments":{"type":"boolean","example":true,"description":"Whether this virtual care platform accepts appointments or not."},"appointment_booking_detail":{"type":"string","example":"<p>Patients can book an appointment through the Age Bold website: https://www.ribbonvirtualcare.com/booking</p>"},"payment_method":{"type":"array","items":{"type":"string","example":"Cash Pay"},"description":"The methods of payment accepted by this platform.","example":["Cash Pay","Insurance"]},"pricing_detail":{"type":"string","example":"<p>Patients have to join the RibbonCare membership to be able to consult with a doctor. The membership is an annual membership and cost $192 per year. </p><p>The visit is then billed through insurance (if we are in network with their insurance) or the cash price for a live visit is $42 per visit.</p>"},"claimed_profile":{"type":"boolean","example":true,"description":"Returns care platform profiles which are curated directly by the platform.\n\nWhen `False`, Ribbon has curated on behalf of the platform and may not have complete information for concepts such as licensure or insurances accepted.\n"},"disclaimer":{"type":["string","null"],"description":"Any disclaimer associated with this platform."}}}}}},"404":{"description":"The given UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/procedures":{"get":{"summary":"Search Procedures","description":"Search and list procedures that exist within the Ribbon API.\n","operationId":"getProcedures","tags":["Reference Endpoints"],"parameters":[{"$ref":"#/paths/~1languages/get/parameters/0"},{"name":"procedure_code","in":"query","required":false,"description":"A specific billing code (e.g., CPT, DRG) to search for","schema":{"type":"string","example":73222}},{"name":"page","in":"query","required":false,"description":"The page of the results which was returned.","schema":{"type":"integer","example":1}},{"name":"page_size","in":"query","required":false,"description":"How many results are in each page.","schema":{"type":"integer","example":15}}],"responses":{"200":{"description":"Procedures returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","next","previous","results"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":141},"next":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/procedures?page=3"},"previous":{"type":["string","null"],"example":"https://api.ribbonhealth.com/v1/procedures?page=1"},"results":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"0a9a245f-2f52-4cc0-a5c3-77a811acc6f7","description":"A UUID uniquely identifying this procedure"},"display_name":{"type":"string","example":"MRI, arm"}}}}}}}}}}}},"/procedures/{procedure_uuid}":{"get":{"summary":"Get Procedure","description":"Retrieve data on a specific procedure.\n","operationId":"getProcedure","tags":["Reference Endpoints"],"parameters":[{"name":"procedure_uuid","in":"path","required":true,"description":"The UUID of the target procedure.","schema":{"type":"string","format":"uuid","example":"3c51144e-3385-4933-b581-4081c84b3cb9"}}],"responses":{"200":{"description":"Returns a single procedure","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"0a9a245f-2f52-4cc0-a5c3-77a811acc6f7","description":"A UUID uniquely identifying this procedure"},"display":{"type":"string","example":"MRI, arm"},"procedure_code_count":{"type":"integer","example":7},"procedure_codes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"73222"},"type":{"type":"string","example":"CPT"},"description":{"type":"string","example":"MRI, arm"}}}}}}}}},"404":{"description":"The given procedure UUID cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/languages":{"get":{"summary":"Search Languages","description":"Search and list provider languages that exist in the Ribbon API.\n","operationId":"getLanguages","tags":["Reference Endpoints"],"parameters":[{"name":"search","in":"query","required":false,"description":"Search parameter for reference endpoints (Provider Type, Location Type, Languages)","schema":{"type":"string","description":"String input that fuzzy searches on `display_name` field within each object to return the most relevant options.\n","example":["Pediatrician","Clinic","Spanish"]}}],"responses":{"200":{"description":"Languages returned from a valid request","content":{"application/json":{"schema":{"type":"object","required":["count","data"],"properties":{"count":{"type":"integer","description":"The total number of results matched, across all pages.","example":333},"results":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"9b79819b-a1e3-489d-8010-b0b9f591c201","description":"A UUID uniquely identifying this language"},"display_name":{"type":"string","example":"arabic"}}}}}}}}}}}},"/pricing/providers":{"get":{"summary":"Provider Price Search","description":"Search for providers that perform a given procedure and find the lowest insurance-specific price for a procedure in your area.\n\n#### Example Use Case\nSearch for all applicable provider negotiated rates, given a specific insurance and procedure (and optionally, a specific location/address and distance). For example, search for all providers near me who perform Leg MRIs and who take a given insurance, sorted by lowest price.\n","operationId":"getPricingProviders","tags":["Price Transparency"],"parameters":[{"name":"Provider Price Search Criteria","in":"query","required":false,"description":"Criteria used to search for providers based on their specialties.","explode":true,"schema":{"type":"object","properties":{"procedure_id":{"type":"string","format":"uuid","description":"Search for prices for the procedure with the given UUID.\n\nIf the given ID is for a procedure bundle but do not have data for the insurance specified by the `plan_id` parameter, we will return data for its anchor procedure instead.\n\nExactly one of `procedure`, `procedure_id`, or `procedure_code` must be specified.\n","example":"7ad7c4ef-baf9-4789-8e58-51d2308a1143"},"procedure":{"type":"string","description":"Search for prices for the given procedure. This input is fuzzy matched to the most relevant procedure `display` field.\n\nWe will preferentially match procedure bundles. If we match a procedure bundle but do not have data for the insurance specified by the `plan_id` parameter, we will return data for its anchor procedure instead.\n\nExactly one of `procedure`, `procedure_id`, or `procedure_code` must be specified.\n","example":"MRI, thoracic spine"},"procedure_code":{"type":"string","description":"Search for prices for procedures with the given billing code.\n\nWe will preferentially match procedure bundles. If we match a procedure bundle but do not have data for the insurance specified by the `plan_id` parameter, we will return data for its anchor procedure instead.\n\nExactly one of `procedure`, `procedure_id`, or `procedure_code` must be specified.\n","example":73720},"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"plan_id":{"type":"string","format":"uuid","description":"Search for negotiated rates for the insurance plan with this UUID.","example":"81ba3a1a-05a9-48d9-b9b2-cb8f9eafc902"},"specialty_ids":{"type":"string","description":"A comma separated list of specialty UUIDs. Filter to providers with any of the given specialties.","example":"fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e,8b5d3998-d7e2-4b9e-91d1-17c19cd089f5,44b0284c-f360-4312-a17d-d601651cb0ea"},"specialty":{"type":"string","description":"String input of a provider specialty that will be interpreted and matched to the single closest specialty, dealing with basic typos and colloquial names for providers.\n","example":"gastroenterology"},"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"2074 23rd Ave, San Francisco, CA 94116"},"location":{"type":"string","description":"Latitude/longitude pair of coordinates in lieu of a string address.","example":"37.7489816,-122.4802092"},"distance":{"type":"integer","example":10,"description":"The proximity radius of providers returned."},"fields":{"type":"string","example":"matched_location,npi","description":"Comma-separated list of fields within the provider object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nNote that all price information is nested under the `matched_location` field. You almost certainly want to return this field.\n\nCannot be used in tandem with `_excl_fields`.\n"},"_excl_fields":{"type":"string","example":"insurances,age","description":"Comma-separated list of fields within the provider object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nCannot be used in tandem with `fields`.\n"}}}}],"responses":{"200":{"description":"Returns per provider prices for the given procedure","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"properties":{"total_count":{"type":"integer","example":141,"description":"The total number of results matched, across all pages."},"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"procedure_id":{"type":"string","format":"uuid","description":"The UUID of the procedure that results were filtered to.\n\nOnly populated when the `procedure_id` search parameter was used.\n","example":"7ad7c4ef-baf9-4789-8e58-51d2308a1143"},"procedure":{"$ref":"#/paths/~1procedures~1%7Bprocedure_uuid%7D/get/responses/200/content/application~1json/schema"},"insurances":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of insurance UUIDs for this provider.\n"},"insurance":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"d8addf29-1054-4ccb-b179-dda65f7fefdd","description":"A UUID uniquely identifying this insurance"},"plan_name":{"type":["string","null"],"example":"Aetna HealthFund Open Choice"},"carrier_name":{"type":["string","null"],"example":"Aetna"}}},"specialty_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e"},"description":"A comma separated list of specialty UUIDs. Filter to providers with any of the given specialties.","example":["fcc9a22c-7a0f-4405-b0c9-c5f8ad83b93e","8b5d3998-d7e2-4b9e-91d1-17c19cd089f5","44b0284c-f360-4312-a17d-d601651cb0ea"]},"specialty":{"$ref":"#/paths/~1custom~1specialties~1%7Bspecialty_uuid%7D/get/responses/200/content/application~1json/schema"},"address":{"type":"string","description":"String input of an address that will be interpreted and geocoded in real time.","example":"2074 23rd Ave, San Francisco, CA 94116"},"location":{"type":"string","description":"Latitude/longitude pair of coordinates in lieu of a string address.","example":"37.7489816,-122.4802092"},"distance":{"type":"integer","example":10,"description":"The proximity radius of providers returned."},"fields":{"type":"array","items":{"type":"string","example":"matched_location"},"example":["matched_location","npi"],"description":"List of fields within the provider object to return. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nNote that all price information is nested under the `matched_location` field. You almost certainly want to return this field.\n\nCannot be used in tandem with `_excl_fields`\n"},"_excl_fields":{"type":"array","items":{"type":"string","example":"insurances"},"example":["insurances","age"],"description":"List of fields within the provider object to exclude from the response. Can be used to greatly reduce the size of the response by requesting only data you intend to use.\n\nCannot be used in tandem with `fields`\n"}}},"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"insurance":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the insurance these prices correspond to.","example":"ef704f14-c906-4857-acd4-d811f1394c32"},"plan_name":{"type":"string","description":"The name of the insurance plan this UUID represents.","example":"Aetna"},"carrier_name":{"type":["string","null"],"description":"The carrier that this insurance plan is associated with, if any."}}},"procedure":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the procedure these prices correspond to.","example":"7ad7c4ef-baf9-4789-8e58-51d2308a1143"},"name":{"type":"string","description":"The name of the procedure these prices correspond to.","example":"MRI, leg"}}},"matched_location":{"allOf":[{"type":"object","properties":{"costs":{"description":"The costs associated with this location.","type":"object","properties":{"min":{"type":"string","example":"239.0","description":"The minimum cost for this procedure in dollars"},"median":{"type":"string","example":"520.5350000000001","description":"The median cost for this procedure in dollars"},"max":{"type":"string","example":"714.93","description":"The maximum cost for this procedure in dollars"},"is_bundle":{"type":"boolean","example":true,"description":"Where this data is the costs for a procedure bundle rather than a regular procedure."},"outpatient":{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures~1%7Bprocedure_uuid%7D~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema/properties/data/properties/costs/properties/inpatient","description":"Costs associated with this procedure in an outpatient setting.\n\nThis key will only be populated for procedure bundles, and only if we have relevant data. A regular procedure will always have a `null` value here.\n"},"inpatient":{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures~1%7Bprocedure_uuid%7D~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema/properties/data/properties/costs/properties/inpatient","description":"Costs associated with this procedure in an inpatient setting.\n\nThis key will only be populated for procedure bundles, and only if we have relevant data. A regular procedure will always have a `null` value here.\n"}}}}},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema"}],"description":"All of the metadata on the matched location plus a `costs` key."}}},{"type":"object","properties":{"npi":{"type":"integer","minimum":1000000000,"maximum":9999999999,"example":1861664294,"description":"The healthcare provider's 10-digit National Provider Identifier (NPI)"},"first_name":{"type":"string","example":"Jane","description":"First name of the provider"},"middle_name":{"type":["string","null"],"example":"J","description":"Middle name of the provider"},"last_name":{"type":"string","example":"Doe","description":"Last name of the provider"},"age":{"type":["integer","null"],"example":38,"description":"The estimated age of the provider"},"gender":{"type":"string","enum":["m","f"],"description":"The gender of the provider"},"ratings_count":{"type":"integer","example":20,"description":"Total number of ratings collected across different sources"},"ratings_avg":{"type":["number","null"],"example":9.8,"description":"Average patient satisfaction rating out of 10 points across multiple sources"},"degrees":{"type":"array","items":{"type":"string","example":"MD"},"description":"Lists all degrees associated with this provider (e.g. MD, OD, PhD)"},"specialties":{"type":"array","items":{"type":"string","format":"uuid"},"description":"This lists the UUIDs of all the specialties for a given provider"},"languages":{"type":"array","items":{"type":"string","example":"english"},"description":"List of confirmed languages spoken"},"educations":{"type":"array","items":{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/responses/200/content/application~1json/schema/properties/educations/items"},"description":"List of the schools attended by the provider"},"insurances":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of the UUIDs of insurances the provider accepts"},"provider_types":{"type":"array","items":{"type":"string","example":"Doctor"},"description":"There are high level classifications for different provider types -- e.g. \"Doctor\", \"Optometry\", \"Dental Providers\", \"Nursing\", etc."},"locations":{"type":"array","items":{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema"},"description":"List of all locations this provider is known to practice at including any known phone numbers at these locations"},"online_profiles":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"}}},"description":"We aggregate profiles across a variety of different online sources, including booking platforms"}}}]},"description":"All of the metadata on a specific provider plus a `matched_location` key showing the costs at the least expensive location."}}}}}},"400":{"description":"The given search was not valid. It combined parameters that may not be combined, or did not specify a procedure in any way, or the specified procedure could not be found, etc.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}}}}},"/pricing/providers/{npi}/procedures":{"get":{"summary":"Provider Procedures","description":"Fetch the list of procedures that a single provider performs, with the lowest available negotiated rates specific to a given insurance for each procedure.\n\n#### Example Use Case\nFor a given provider, search the full list of procedures that they are likely to perform where there are negotiated rates available for a particular insurance, and return the minimum price for each procedure.\n","operationId":"getPricingProviderProcedures","tags":["Price Transparency"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"name":"plan_id","in":"query","required":false,"description":"Search for negotiated rates for the insurance plan with this UUID.","schema":{"type":"string","format":"uuid","example":"81ba3a1a-05a9-48d9-b9b2-cb8f9eafc902"}},{"$ref":"#/paths/~1procedures/get/parameters/2"},{"$ref":"#/paths/~1procedures/get/parameters/3"}],"responses":{"200":{"description":"Returns the procedures for the given provider for which we have price data","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"insurance":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"d8addf29-1054-4ccb-b179-dda65f7fefdd","description":"A UUID uniquely identifying this insurance"},"display":{"type":["string"],"example":"Aetna"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the procedure these prices correspond to.","example":"7ad7c4ef-baf9-4789-8e58-51d2308a1143"},"display":{"type":"string","description":"The name of the procedure these prices correspond to.","example":"MRI, leg"},"min_cost":{"type":"number","description":"The minimum cost for this procedure with this provider, in dollars."}}}}}}}}},"400":{"description":"The given search was not valid. The given insurance could not be found, etc.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/pricing/providers/{npi}/procedures/{procedure_uuid}":{"get":{"summary":"Provider Procedure Pricing","description":"Find the prices offered by a single provider for a specific procedure, with a given insurance, across practice locations.\n\n#### Example Use Case\nCompare insurance-specific price estimates of a Leg MRI for a single provider at multiple relevant practices (e.g., compare this provider's rates when performing the procedure at both the provider's private outpatient facility, as well as a nearby hospital system clinic where they also practice).\n","operationId":"getPricingProviderProcedure","tags":["Price Transparency"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"name":"procedure_uuid","in":"path","required":true,"description":"The UUID of the target procedure. If the target procedure is a procedure bundle but we do not have any data for it, we will return data for its anchor procedure instead.","schema":{"type":"string","format":"uuid","example":"3c51144e-3385-4933-b581-4081c84b3cb9"}},{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures/get/parameters/1"},{"$ref":"#/paths/~1procedures/get/parameters/2"},{"$ref":"#/paths/~1procedures/get/parameters/3"}],"responses":{"200":{"description":"Returns costs for the given procedure with the given provider at each location","content":{"application/json":{"schema":{"type":"object","required":["parameters","locations"],"properties":{"parameters":{"properties":{"page":{"type":"integer","example":1,"description":"The page of the results which was returned."},"page_size":{"type":"integer","example":25,"description":"How many results are in each page."},"insurance":{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures/get/responses/200/content/application~1json/schema/properties/parameters/properties/insurance"}}},"locations":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the location these prices correspond to.","example":"7ad7c4ef-baf9-4789-8e58-51d2308a1143"},"costs":{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures~1%7Bprocedure_uuid%7D~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema/properties/data/properties/costs"}}}}}}}}},"400":{"description":"The given search was not valid. The given insurance could not be found, etc.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/pricing/providers/{npi}/procedures/{procedure_uuid}/locations/{location_uuid}":{"get":{"summary":"Provider Location Procedure Pricing","description":"Search for a price estimate for a specific procedure from a specific provider at a specific location, with a given insurance plan.\n\n#### Example Use Case\nGiven an insurance, identify the expected price of a particular procedure from a specific provider at a known facility.\n","operationId":"getPricingProviderProcedureLocation","tags":["Price Transparency"],"parameters":[{"$ref":"#/paths/~1custom~1providers~1%7Bnpi%7D/get/parameters/0"},{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures~1%7Bprocedure_uuid%7D/get/parameters/1"},{"$ref":"#/paths/~1custom~1locations~1%7Blocation_uuid%7D/get/parameters/0"},{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures/get/parameters/1"}],"responses":{"200":{"description":"Returns the costs associated with the given provider, procedure, and location","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"properties":{"insurance":{"$ref":"#/paths/~1custom~1insurances/post/requestBody/content/application~1json/schema"}}},"data":{"type":"object","properties":{"costs":{"type":"object","properties":{"min":{"type":"number","example":239,"description":"The minimum cost for this procedure in dollars"},"avg":{"type":"number","example":520.5350000000001,"description":"The median cost for this procedure in dollars\n\nThis key is misnamed. For backwards compatibility, we have retained the legacy name.\n"},"max":{"type":"number","example":714.93,"description":"The maximum cost for this procedure in dollars"},"is_bundle":{"type":"boolean","example":true,"description":"Where this data is the costs for a procedure bundle rather than a regular procedure."},"outpatient":{"$ref":"#/paths/~1pricing~1providers~1%7Bnpi%7D~1procedures~1%7Bprocedure_uuid%7D~1locations~1%7Blocation_uuid%7D/get/responses/200/content/application~1json/schema/properties/data/properties/costs/properties/inpatient","description":"Costs associated with this procedure in an outpatient setting.\n\nThis key will only be populated for procedure bundles, and only if we have relevant data. A regular procedure will always have a `null` value here.\n"},"inpatient":{"description":"Costs associated with this procedure in an inpatient setting.\n\nThis key will only be populated for procedure bundles, and only if we have relevant data. A regular procedure will always have a `null` value here.\n","type":["object","null"],"required":["min","median","max","is_bundle","components"],"properties":{"min":{"type":"number","example":239,"description":"The minimum cost for this procedure in this place of service, in dollars."},"median":{"type":"number","example":520.5350000000001,"description":"The median cost for this procedure in this place of service, in dollars.\n"},"max":{"type":"number","example":714.93,"description":"The maximum cost for this procedure in this place of service, in dollars."},"is_bundle":{"type":"boolean","example":true,"description":"Where this data is the costs for a procedure bundle rather than a regular procedure."},"components":{"type":["array","null"],"description":"Individual costs for the components that make up this procedure bundle.\n\nFor a regular procedure, this field will always be `null`.\n","items":{"type":"object","properties":{"display":{"type":"string","example":"Knee replacement surgery","description":"The display name for this component of a procedure bundle."},"min":{"type":"number","example":239,"description":"The minimum cost for this component in this place of service, in dollars."},"median":{"type":"number","example":520.5350000000001,"description":"The median cost for this component in this place of service, in dollars.\n"},"max":{"type":"number","example":714.93,"description":"The maximum cost for this component in this place of service, in dollars."}}}}}}}}}}}}}}},"400":{"description":"The given search was not valid. The given insurance could not be found, etc.","content":{"application/json":{"schema":{"$ref":"#/paths/~1network_analysis/get/responses/400/content/application~1json/schema"}}}},"404":{"description":"The given NPI cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/pricing/carriers":{"get":{"summary":"List Carriers","description":"This endpoint will show the carriers for which we have data. This can be used to fetch the recency of the data used per carrier.\n","operationId":"getPricingCarriers","tags":["Price Transparency"],"responses":{"200":{"description":"Returns all carriers we have price data for","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1pricing~1carrier~1%7Bcarrier_uuid%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/pricing/carrier/{carrier_uuid}":{"get":{"summary":"Get Carrier","description":"Fetch metadata including the recency of the pricing data used for a specific carrier.\n","operationId":"getPricingCarrier","tags":["Price Transparency"],"parameters":[{"name":"carrier_uuid","in":"path","required":true,"description":"The UUID of the insurance carrier.","schema":{"type":"string","format":"uuid","example":"ef704f14-c906-4857-acd4-d811f1394c32"}}],"responses":{"200":{"description":"Returns metadata for the given carrier","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"ef704f14-c906-4857-acd4-d811f1394c32","description":"A UUID uniquely identifying this carrier"},"name":{"type":"string","example":"Aetna","description":"A human-friendly name for this carrier"},"last_updated":{"type":"string","description":"A month-granularity ISO-format date representing when we last updated price data for this carrier","example":"2023-01"}}}}}},"404":{"description":"The given carrier cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/pricing/version":{"get":{"summary":"Carrier Names","description":"This endpoint will the names of the carriers for which we have data. This can be used to fetch the recency of the data used per carrier.\n\nThis endpoint is deprecated. Please use [List Carriers](./getpricingcarriers) instead.\n","operationId":"getPricingCarrierNames","tags":["Price Transparency"],"deprecated":true,"responses":{"200":{"description":"Returns all carriers we have price data for","content":{"application/json":{"schema":{"type":"object","properties":{"carriers":{"type":"array","items":{"type":"string","description":"The name of an insurance carrier we have pricing data for","example":"Aetna"},"description":"The name of the insurance carriers we have pricing data for","example":["Aetna","Cigna"]}}}}}}}}},"/pricing/version/{carrier_name}":{"get":{"summary":"Carrier Data Versions By Name","description":"Fetch the recency of the pricing data used for a specific carrier by name.\n\nThis endpoint is deprecated. Please use [Get Carrier](./getpricingcarrier) instead.\n","operationId":"getPricingVersionCarrier","tags":["Price Transparency"],"deprecated":true,"parameters":[{"name":"carrier_name","in":"path","required":true,"description":"The name of the insurance carrier.","schema":{"type":"string","example":"Aetna"}}],"responses":{"200":{"description":"Returns the recency for the given carrier","content":{"application/json":{"schema":{"type":"object","properties":{"last_updated":{"type":"string","description":"A month-granularity ISO-format date representing when we last updated price data for this carrier","example":"2023-01"}}}}}},"404":{"description":"The given carrier cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/eligibility":{"post":{"summary":"Check Member Eligibility","description":"Verify a member's current insurance coverage and benefits. You can access detailed information including a member’s progress on their Deductible and Out-of-pocket, as well as Copay and Coinsurance information for different services.\n\n#### Example Use Case\nInform a member of their current progress against their Deductible as well as their Copay and Coinsurance summaries so they can better estimate their out-of pocket costs.\n","operationId":"getEligibility","tags":["Cost Estimates"],"parameters":[{"name":"include_full_response","in":"query","required":false,"description":"Whether to return the full eligibility response from the payer. Defaults to `false` when not provided.","schema":{"type":"boolean","default":false,"example":true}}],"requestBody":{"required":true,"description":"Identifying information for the member to be checked","content":{"application/json":{"schema":{"type":"object","properties":{"member_id":{"type":"string","example":"000000000-00","description":"The member's identification number"},"first_name":{"type":"string","example":"John","description":"The member's first name"},"last_name":{"type":"string","example":"Doe","description":"The member's last name"},"birth_date":{"type":"string","format":"date","example":"1980-12-31","description":"The member's birth date as an ISO-format date string"},"insurance_partner":{"type":"string","example":"aetna_better_health_il","description":"The identifier for this insurance partner in the Ribbon API"}}}}}},"responses":{"200":{"description":"Eligibility information for the given member","content":{"application/json":{"schema":{"type":"object","required":["parameters","status","request_id"],"properties":{"parameters":{"type":"object","properties":{"member_id":{"type":"string","example":"000000000-00","description":"The member's identification number"},"first_name":{"type":"string","example":"John","description":"The member's first name"},"last_name":{"type":"string","example":"Doe","description":"The member's last name"},"birth_date":{"type":"string","format":"date","example":"1980-12-31","description":"The member's birth date as an ISO-format date string"},"insurance_partner":{"type":"string","example":"aetna_better_health_il","description":"The identifier for this insurance partner in the Ribbon API"}}},"status":{"type":"object","properties":{"is_valid":{"type":"boolean","example":true,"description":"Whether the eligibility check was successful"},"error":{"type":["string","null"],"description":"If `is_valid` is `true`, an error code explaining what went wrong. When `is_valid` is `false`, this will be `null`."}}},"request_id":{"type":"string","example":"40610978","description":"A unique identifier for the given response which Ribbon can use to find it in our logs during support requests"},"plan_info":{"type":"object","properties":{"insurance_partner":{"type":"string","example":"aetna_better_health_il","description":"The identifier for this insurance partner in the Ribbon API"},"plan_name":{"type":"string","example":"Aetna Better Health of Illinois","description":"User-friendly display name for this insurance partner"},"is_active":{"type":"boolean","example":true,"description":"Whether the member is actively covered by this plan"},"plan_start_date":{"type":"string","format":"date","example":"2012-02-01","description":"The starting date for the member's coverage by this plan"},"plan_end_date":{"type":["string","null"],"format":"date","example":"2024-01-01","description":"The ending date for the member's coverage by this plan"}}},"deductible_detail":{"type":"object","properties":{"individual":{"type":"object","properties":{"in_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards in-network deductibles, in dollars"},"maximum":{"type":["string","null"],"example":"3000","description":"The maximum amount the member can pay towards in-network deductibles, in dollars"},"remaining":{"type":"string","example":"2983.57","description":"The remaining amount the member can pay towards in-network deductibles, in dollars"}}},"out_of_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards out-of-network deductibles, in dollars"},"maximum":{"type":["string","null"],"example":"6000","description":"The maximum amount the member can pay towards out-of-network deductibles, in dollars"},"remaining":{"type":["string","null"],"example":"5983.57","description":"The remaining amount the member can pay towards out-of-network deductibles, in dollars"}}}}},"family":{"type":"object","properties":{"in_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards in-network deductibles, in dollars"},"maximum":{"type":["string","null"],"example":"6000","description":"The maximum amount the member can pay towards in-network deductibles, in dollars"},"remaining":{"type":["string","null"],"example":"5983.57","description":"The remaining amount the member can pay towards in-network deductibles, in dollars"}}},"out_of_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards out-of-network deductibles, in dollars"},"maximum":{"type":["string","null"],"example":"12000","description":"The maximum amount the member can pay towards out-of-network deductibles, in dollars"},"remaining":{"type":["string","null"],"example":"11983.57","description":"The remaining amount the member can pay towards out-of-network deductibles, in dollars"}}}}}}},"out_of_pocket_detail":{"type":"object","properties":{"individual":{"type":"object","properties":{"in_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards their in-network out-of-pocket maximum, in dollars"},"maximum":{"type":["string","null"],"example":"3000","description":"The maximum amount the member can pay towards their in-network out-of-pocket maximum, in dollars"},"remaining":{"type":["string","null"],"example":"2983.57","description":"The remaining amount the member can pay towards their in-network out-of-pocket maximum, in dollars"}}},"out_of_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards their out-of-network out-of-pocket maximum, in dollars"},"maximum":{"type":["string","null"],"example":"6000","description":"The maximum amount the member can pay towards their out-of-network out-of-pocket maximum, in dollars"},"remaining":{"type":["string","null"],"example":"5983.57","description":"The remaining amount the member can pay towards their out-of-network out-of-pocket maximum, in dollars"}}}}},"family":{"type":"object","properties":{"in_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards their in-network out-of-pocket maximum, in dollars"},"maximum":{"type":["string","null"],"example":"6000","description":"The maximum amount the member can pay towards their in-network out-of-pocket maximum, in dollars"},"remaining":{"type":["string","null"],"example":"5983.57","description":"The remaining amount the member can pay towards their in-network out-of-pocket maximum, in dollars"}}},"out_of_network":{"type":"object","properties":{"spend":{"type":["string","null"],"example":"16.43","description":"The amount the member has paid towards their out-of-network out-of-pocket maximum, in dollars"},"maximum":{"type":["string","null"],"example":"12000","description":"The maximum amount the member can pay towards their out-of-network out-of-pocket maximum, in dollars"},"remaining":{"type":["string","null"],"example":"11983.57","description":"The remaining amount the member can pay towards their out-of-network out-of-pocket maximum, in dollars"}}}}}}},"primary_care_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"dme_summary":{"type":"object","properties":{"in_network":{"type":"object","properties":{"copay":{"type":"string","example":"30.0","description":"The amount of the member's in-network copay, in dollars"},"coinsurance":{"type":["string","null"],"example":"0.0"}}},"out_of_network":{"type":"object","properties":{"copay":{"type":"string","example":"30.0","description":"The amount of the member's out-of-network copay, in dollars"},"coinsurance":{"type":["string","null"],"example":"0.0"}}}}},"oncology_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"vision_optometry_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"physical_therapy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"specialist_office_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"mental_health_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"surgical_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"urgent_care_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"diagnostic_lab_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"asc_facility_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"chiropractic_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"mri_ct_scan_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"x_ray_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"speech_therapy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"occupational_therapy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"emergency_medical_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"wellness_or_routine_visit_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"podiatry_office_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"outpatient_professional_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"anesthesia_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"substance_abuse_professional_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"substance_abuse_in_patient_facility_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"substance_abuse_out_patient_facility_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"flu_vaccination_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"hospital_inpatient_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"pharmacy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"hospital_outpatient_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"telemedicine_primary_care_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"telemedicine_specialist_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"telemedicine_urgent_care_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"telemedicine_physical_therapy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"telemedicine_mental_health_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"psychotherapy_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"snf_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"snf_room_board_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"home_health_care_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"hospice_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"},"professional_physician_visit_inpatient_summary":{"$ref":"#/paths/~1eligibility/post/responses/200/content/application~1json/schema/properties/dme_summary"}}}}}}},"x-readme":{"explorer-enabled":false}}},"/eligibility_insurance_partners":{"get":{"summary":"Search Supported Eligibility Insurances","description":"Search or list all insurance partners supported by our eligibility features.\n","operationId":"getEligibilityInsurancePartners","tags":["Cost Estimates"],"parameters":[{"name":"search","in":"query","required":false,"description":"Fuzzy search input for insurance names","schema":{"type":"string","example":"aetna"}}],"responses":{"200":{"description":"Returns a list of supported insurances","content":{"application/json":{"schema":{"type":"object","required":["count","data"],"properties":{"count":{"type":"integer","example":332,"description":"The total number of results matched."},"data":{"type":"array","items":{"$ref":"#/paths/~1eligibility_insurance_partners~1%7Binsurance_partner%7D/get/responses/200/content/application~1json/schema"}}}}}}}}}},"/eligibility_insurance_partners/{insurance_partner}":{"get":{"summary":"Get Eligibility Insurance","description":"Fetch an insurance partner supported by our eligibility features.\n","operationId":"getEligibilityInsurancePartner","tags":["Cost Estimates"],"parameters":[{"name":"insurance_partner","in":"path","required":true,"description":"The identifier for this insurance partner in the Ribbon API","schema":{"type":"string","example":"aetna_better_health_il"}}],"responses":{"200":{"description":"Returns a single supported insurance","content":{"application/json":{"schema":{"type":"object","properties":{"insurance_partner":{"type":"string","example":"aetna_better_health_il","description":"Identifier for this insurance partner used by other endpoints in the Ribbon API"},"display":{"type":"string","example":"Aetna Better Health of Illinois","description":"User-friendly display name for this insurance partner"}}}}}},"404":{"description":"The given insurance partner identifier cannot be found","content":{"application/json":{"schema":{"$ref":"#/paths/~1custom~1tin~1%7Btin_id%7D/get/responses/404/content/application~1json/schema"}}}}}}},"/procedure_cost_estimate":{"get":{"summary":"Procedure Cost Estimate","description":"Calculates estimated costs for a given procedure based on a user's location.\n\n#### Example Use Case\nEstimate the cost of a knee replacement surgery for a user in Boston so they can plan their personal finances accordingly.\n","operationId":"getProcedureCostEstimate","tags":["Cost Estimates"],"parameters":[{"name":"procedure_ids","in":"query","required":true,"description":"The UUIDs of the procedures to filter results to, as a comma-delimited string","schema":{"type":"string","example":"9f3fd9e8-96b0-4cc7-ab2c-8d538e9164ae,fbb223e6-9806-45b5-95b1-4d7a36cc9164"}},{"name":"member_zip","in":"query","required":true,"description":"The zip code of the member we are generating cost estimates for","schema":{"type":"string","example":"60606"}},{"name":"type","in":"query","required":false,"description":"The type of data to base cost estimates on: `claims` data or payer-filed `price_transparency` data. Defaults to `claims`.","schema":{"type":"string","enum":["claims","price_transparency"],"default":"claims","example":"price_transparency"}},{"name":"plan_id","in":"query","required":false,"description":"The UUID of the insurance plan to use when fetching negotiated rates with providers. Necessary only if searching for estimates using the 'price_transparency' `type`.","schema":{"type":"string","format":"uuid","example":"a5a0c8ff-c62b-4a9e-af86-55e52bd7dc55"}}],"responses":{"200":{"description":"Estimated costs for the given procedures","content":{"application/json":{"schema":{"type":"object","properties":{"parameters":{"type":"object","properties":{"procedures":{"type":"array","items":{"$ref":"#/paths/~1procedures~1%7Bprocedure_uuid%7D/get/responses/200/content/application~1json/schema"}},"member_zip":{"type":"string","example":"60606"}}},"data":{"type":"object","properties":{"cost_estimates":{"type":"object","properties":{"minimum":{"type":"number","example":100,"description":"Minimum cost for all of the given procedures combined."},"median":{"type":"number","example":300,"description":"Median cost for all of the given procedures combined."},"maximum":{"type":"number","example":500,"description":"Maximum cost for all of the given procedures combined."}}}}}}}}}}}}},"/network_analysis":{"get":{"summary":"Network Analysis Based on Geography","description":"View a provider network across different geographies (i.e. counties).\n\n#### Example Use Case\nIn looking to expand to a new region, analyze existing provider networks in the region to understand how best to construct your own.\n","operationId":"getNetworkAnalysis","tags":["Networks"],"parameters":[{"name":"insurance_id","in":"query","required":true,"description":"A unique identifier for a single provider network from the Insurances reference endpoint.","schema":{"type":"string","format":"uuid","example":"000912ad-5674-4c23-9b00-dca4e76aaa07"}},{"name":"ssa_codes","in":"query","required":true,"description":"SSA codes of the counties to run a network analysis on. \n\nA maximum of 50 codes may be included in a single request.\n","schema":{"type":"string","example":"14141,14150"}},{"name":"exclude_npis","in":"query","required":false,"description":"When set to `true` the response will not list specific NPIs in the network but will continue to include the `npi_count` fields to let you know how many there are.\n\nThis parameter can be used to greater lower the amount of data sent back when specific NPIs are not necessary.\n","schema":{"type":"boolean","default":false,"example":true}}],"responses":{"200":{"description":"Returns the size of the provider network for the given insurance in the given counties.","content":{"application/json":{"schema":{"type":"object","required":["parameters","data"],"properties":{"parameters":{"type":"object","required":["insurance_id","ssa_codes","npi_count"],"properties":{"insurance_id":{"type":"string","format":"uuid","example":"000912ad-5674-4c23-9b00-dca4e76aaa07","description":"A unique identifier for a single provider network from the Insurances reference endpoint."},"ssa_codes":{"type":"array","items":{"type":"string","example":"14141"},"description":"The SSA codes the network analysis was run on.","example":["14141","14150"]},"npi_count":{"type":"integer","description":"How many unique NPIs accept the given insurance across all requested counties.","example":2999}}},"data":{"type":"array","items":{"type":"object","required":["ssa_code","display","npi_count"],"properties":{"ssa_code":{"type":"string","example":"14141","description":"The SSA code of the county this data is for."},"display":{"type":"string","example":"Cook, IL","description":"The display name of the county this data is for."},"npi_count":{"type":"integer","example":2103,"description":"How many unique NPIs accept the given insurance in this county."},"npis":{"type":"array","items":{"type":"string","example":"1234567890"},"description":"The NPIs of providers who accept the given insurance in this county.\n\nIf the `exclude_npis` parameter was set to true, this key will not be present.\n"}}}}}}}}},"400":{"description":"The given request was invalid - the required parameters were missing or invalid, or it specified too many SSA codes.","content":{"application/json":{"schema":{"type":"object","description":"An error returned from the API","required":["error"],"properties":{"error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","description":"The HTTP error code associated with this error","example":400},"code":{"type":"string","enum":["invalid_query_params","bad_request"]},"message":{"type":["object","string"],"description":"An object representing what exactly went wrong. The keys available in this object vary with the type of error returned.\n","example":{"query":{"_schema":["parameters 'npis' and 'location_ids' cannot be used together"]}}}}}}}}}}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"BearerAuth":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true},"_id":"64e4b17b751ef3002b3800cc"},"oasPublicUrl":"@ribbon/v2.2#1xqf25m70yilh2","oauth":false,"rdmd":{"baseUrl":"/","body":"","dehydrated":{"body":"","toc":""},"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"baseUrl":"/","terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"6667447bbec68900185017e0","name":"BearerAuth","type":"http","scheme":"bearer","apiSetting":"6453d3f732b93104000efdab"}]}},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"6667447bbec68900185017e0","name":"BearerAuth","type":"http","scheme":"bearer","apiSetting":"6453d3f732b93104000efdab"}]},"mdx":false},"slugUrl":"/reference/geteligibility","suggestedEdits":true,"variables":{"defaults":[{"source":"security","_id":"6667447bbec68900185017e0","name":"BearerAuth","type":"http","scheme":"bearer","apiSetting":"6453d3f732b93104000efdab"}],"user":{}},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.284.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"6667447bbec68900185017e0","name":"BearerAuth","type":"http","scheme":"bearer","apiSetting":"6453d3f732b93104000efdab"}]},"project":{"_id":"5b0f46647e0af500032cc9a3","appearance":{"nextStepsLabel":"","hideTableOfContents":false,"showVersion":true,"html_hidelinks":false,"global_landing_page":{"redirect":"","html":""},"html_footer_meta":"","html_head":"","html_footer":"","html_body":"","html_promo":"","javascript_hub2":"function insertCustomBanner() {\n \n // !!!!!!!!! Link the banner uses !!!!!!!!!!\n const link = \"https://h1.co/press/h1-welcomes-former-fda-commissioner-to-board-of-directors-acquires-ribbon-health-and-unveils-2025-product-roadmap/\"\n \n // Select the target element where the banner should be added\n const header = document.querySelector('.Header3zzata9F_ZPQ');\n\n // Ensure the target element exists and is accessible\n if (header) {\n // Check if the custom banner already exists to avoid duplication\n if (!document.getElementById('custom-banner')) {\n // Create the custom banner container\n const customBanner = document.createElement('div');\n customBanner.id = 'custom-banner';\n\n // Create the inner banner container\n const innerBanner = document.createElement('div');\n innerBanner.id = 'inner-banner';\n\n // Add content to the inner banner\n const bannerHeading = document.createElement('h4');\n bannerHeading.textContent = 'H1 acquires Ribbon Health.';\n\n const bannerLink = document.createElement('a');\n bannerLink.href = link; // Update with the actual link\n bannerLink.textContent = 'Read More';\n bannerLink.target = '_blank'; // Open in a new tab/window\n\t\t\tbannerLink.rel = 'nofollow noreferrer'; // Add nofollow and noreferrer\n\n // Append heading and link to the inner banner\n innerBanner.appendChild(bannerHeading);\n bannerHeading.appendChild(bannerLink);\n\n // Append the inner banner to the custom banner container\n customBanner.appendChild(innerBanner);\n\n // Insert the banner as the first child of the target element\n header.insertBefore(customBanner, header.firstChild);\n }\n }\n}\n\n// Run the logic on each page load using the pageLoad event\n$(window).on('pageLoad', function (e, state) {\n insertCustomBanner();\n});","javascript":"","stylesheet_hub2":".p {\n font-family: 'avenir next';\n font-size: 20px;\n font-weight: bold;\n}\n\n.content-body code { \n display: inline; \n word-break: normal; \n}\n\n.Header-leftADQdGVqx1wqU a.Button.Header-link2tXYTgXq85zW:last-child {\n padding: 1px 12px 0;\n background: #9B255F;\n color: #FFFFFF;\n outline: none;\n}\n\n/* Banner */\n\n#custom-banner {\n background-color:#262F38;\n}\n\n#inner-banner {\n\tmax-width: 1370px;\n\tmargin: 0 auto;\n\tpadding: 10px 35px;\n}\n\n#inner-banner > h4,\n#inner-banner > h4 > a {\n\tcolor: #fff;\n\tfont-size: 16px;\n\tfont-weight: 400;\n margin:0;\n text-align:center;\n}\n\n#inner-banner > h4 > a {\n\tfont-weight: 600;\n margin-left:4px;\n}\n\n@media screen and (max-width: 768px) {\n\t#inner-banner {\n\t\tpadding: 10px 26px;\n\t}\n \n #inner-banner> h4, #inner-banner > h4 > a {\n \tfont-size: 12px;\n }\n}","stylesheet":"","favicon":["https://files.readme.io/ea171b287c6a8fb267f6151e05a72355433eb125a4f478552bc83ef46d8709f7-small-favicon-128x128.png","ea171b287c6a8fb267f6151e05a72355433eb125a4f478552bc83ef46d8709f7-small-favicon-128x128.png",32,32,"#44c94f","https://files.readme.io/5c3ab62729fc514246aa1335ab5cd839d1163bc938aea9cc31a4f969cb2fb795-favicon-128x128.png","677db4cf6fa8e2005d4ff0b1"],"logo_white_use":true,"logo_white":["https://files.readme.io/615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png","615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png",132,80,"#ffffff","https://files.readme.io/7905752a5d8b3d848fb1addea06857e815c6956eddea231e4e1a392e51ebf605-H1_Logo_White_1.png","677db47a75a6c30010760cfc"],"logo":["https://files.readme.io/1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png","1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png",136,80,"#44c94f","https://files.readme.io/f979bbb4ab06eaf2787995cae2139203366e36e90c855e41b6fa73ee479acbd7-H1_Logo_Primary_4X_3.png","677db5263a48a2002d36f6c0"],"promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":""},"title":"H1 APIs","text":"Our mission is to simplify healthcare.\n\nH1 provides healthcare enterprises with accurate data on doctors, insurance plans, and costs of care.\n\nOur API exists to help you build and enhance your healthcare solution.","_id":"5a148feda33f650012aacd93"}],"body":{"style":"none"},"header":{"img_pos":"tl","img_size":"auto","img":[],"style":"solid"},"typography":{"tk_body":"","tk_headline":"","tk_key":"","typekit":false,"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif"},"colors":{"body_highlight":"#064997","header_text":"","main_alt":"","main":"#064997","highlight":"","custom_login_link_color":""},"main_body":{"type":"links"},"categoriesAsDropdown":false,"hide_logo":false,"sticky":false,"landing":true,"overlay":"triangles","notheme":false,"theme":"solid","link_logo_to_url":false,"referenceLayout":"row","subheaderStyle":"dropdown","childrenAsPills":false,"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"splitReferenceDocs":false,"showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":true,"colorScheme":"light","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"","childrenProjects":[],"derivedPlan":"business","description":"The H1 API provides healthcare enterprises with accurate data on doctors, insurance plans, and costs of care.\n\nOur mission is to simplify healthcare.","error404":"","experiments":[],"first_page":"landing","flags":{"directGoogleToStableVersion":false,"disableAnonForum":false,"newApiExplorer":true,"stripe":false,"hideGoogleAnalytics":false,"cookieAuthentication":false,"allowXFrame":true,"speedyRender":false,"correctnewlines":false,"swagger":false,"oauth":false,"migrationSwaggerRun":false,"migrationRun":false,"hub2":true,"enterprise":false,"allow_hub2":false,"newSearch":true,"allowApiExplorerJsonEditor":false,"alwaysShowDocPublishStatus":false,"newEditor":true,"newMarkdownBetaProgram":true,"oldMarkdown":false,"rdmdCompatibilityMode":false,"staging":false,"translation":false,"tutorials":true,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"maskErrorMessages":true},"fullBaseUrl":"https://ribbon.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"html","alignment":"left","html":""}],"mdxMigrationStatus":"rdmd","metrics":{"thumbsEnabled":false,"enabled":false,"monthlyLimit":0,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":true,"logs":false,"tutorials":false,"graphql":false},"name":"H1 API Docs","nav_names":{"discuss":"","reference":"","docs":"","changelog":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":25,"totalScore":168},"reCaptchaSiteKey":"6Lci23khAAAAALNm7KszZJ7DrQ1u6Wwp4GMGIZVm","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"64e4b17b751ef3002b3801a0","version":"2.2","version_clean":"2.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["64e4b17b751ef3002b3800b9","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","64e4b17b751ef3002b3800ba","64e4b17b751ef3002b3800bb","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","64e4b17b751ef3002b3800bc","64e4b17b751ef3002b3800bd","64e4b17b751ef3002b3800be","64e4b17b751ef3002b3800bf","5b325c97d19cf700032b17e9","64e4b17b751ef3002b3800c0","64e4b17b751ef3002b3800c1","64e4b17b751ef3002b3800c2","64e4b17b751ef3002b3800c3","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","64e4b17b751ef3002b3800c4","64e4b17b751ef3002b3800c5","64e4b17b751ef3002b3800c6","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","64e4b17b751ef3002b3800c7","64e4b17b751ef3002b3800c8","64e4b17b751ef3002b3800c9","64e4b17b751ef3002b3800ca","6376b41e081e400003bac1b3","64e4b17b751ef3002b3800cb","64e4b17b751ef3002b3801a2","64e53563c6633f003f520238","64e537b0059c3f000dcc819a","64e53b81b6b872005fff1f51"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2023-08-22T13:00:43.284Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-09-07T18:14:48.285Z"},"subdomain":"ribbon","subpath":"","superHubWaitlist":false,"topnav":{"edited":true,"right":[],"left":[{"type":"docs","text":"Guides"},{"type":"reference","text":"API Reference"},{"type":"discuss"},{"type":"url","text":"Try H1!","url":"https://h1.co/request-demo/"}],"bottom":[]},"trial":{"trialEndsAt":"2017-12-05T20:43:25.480Z","trialDeadlineEnabled":true},"translate":{"languages":[],"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://www.h1.co","versions":[{"_id":"6453cb6c89b1471f081433ee","version":"0.0.1","version_clean":"0.0.1","codename":"API Reference Test","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["6453cb6c89b1471f0814336d","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","6453cb6c89b1471f0814336e","6453cb6c89b1471f0814336f","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","6453cb6c89b1471f08143370","6453cb6c89b1471f08143371","6453cb6c89b1471f08143372","6453cb6c89b1471f08143373","5b325c97d19cf700032b17e9","6453cb6c89b1471f08143374","6453cb6c89b1471f08143375","6453cb6c89b1471f08143376","6453cb6c89b1471f08143377","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","6453cb6c89b1471f08143378","6453cb6c89b1471f08143379","6453cb6c89b1471f0814337a","6453cb6c89b1471f0814337b","6453cb6c89b1471f0814337c","6453cb6c89b1471f0814337d","6453cb6c89b1471f0814337e","6453cb6c89b1471f0814337f","6453cb6c89b1471f08143380","6376b41e081e400003bac1b3","6453cb6c89b1471f081433f0","6453cc63c65ae219e985776b","6453cd39487b9215b2d3ca28","6453cdb8f974a31d138e9a02","6453cdf43e8b160cc99ae19a","6453cf4f682d72146c3bbf69","6453d1b6f272cf1f732c32b6","6453d2ad51ae010e3422ef95","6453d2dd70a2a40065511428","6453d2ef85ab11053c8f64b4","6453d2ff51ae010e3422efc9","6453d308c6e828000b95de3e","6453d3f732b93104000efdac","6453d4a12b10321eca864eaa"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2017-11-21T20:43:25.516Z","releaseDate":"2017-11-21T20:43:25.516Z"},{"_id":"5b0f46647e0af500032cc956","project":"5b0f46647e0af500032cc9a3","createdAt":"2017-11-21T20:43:25.516Z","releaseDate":"2017-11-21T20:43:25.516Z","categories":["5b0f46647e0af500032cc957","5b0f46647e0af500032cc958","5a2a3a680b68c20026c6c3f2","5b0f46647e0af500032cc959","5b0f46647e0af500032cc95a","5a3a9d3dbcc254001c4bfc24","5b0f46647e0af500032cc95b","5a3a9db2bcc254001c4bfc27","5b0f46647e0af500032cc95c","5b0f46647e0af500032cc95d","5b0f46647e0af500032cc95e","5b0f46647e0af500032cc95f","5b0f46647e0af500032cc960","5b0f46647e0af500032cc961","6376b41e081e400003bac1b1"],"is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1.0","__v":14},{"_id":"5b325c97d19cf700032b182b","project":"5b0f46647e0af500032cc9a3","__v":3,"forked_from":"5b0f46647e0af500032cc956","createdAt":"2017-11-21T20:43:25.516Z","releaseDate":"2017-11-21T20:43:25.516Z","categories":["5b325c97d19cf700032b17e0","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","5b325c97d19cf700032b17e2","5b325c97d19cf700032b17e3","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","5b325c97d19cf700032b17e5","5b325c97d19cf700032b17e6","5b325c97d19cf700032b17e7","5b325c97d19cf700032b17e8","5b325c97d19cf700032b17e9","5b325c97d19cf700032b17ea","5d125c114458cf0037c615c9","5d37774e22400901e5638f84","5e502001f917c40064640db5","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","6090bb69f529b4001f91dc42","60e5caeb250e480016ca4f42","61e728e3307bb7007aa29e3e","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","625db6ff76c25e003ee214c6","62d5d47c07cf7500e6a24a5f","62f07266c59d2600402d721e","636ab3bc4b83b600a79fa87b","6376b41e081e400003bac1b3","6493426d931db40023704158"],"is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"","version_clean":"2.0.0","version":"2.0","updatedAt":"2023-09-21T14:33:16.676Z"},{"_id":"60934b0b648f6a003fdfd29f","version":"2.1","version_clean":"2.1.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"categories":["60934b0b648f6a003fdfd246","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","60934b0b648f6a003fdfd247","60934b0b648f6a003fdfd248","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","60934b0b648f6a003fdfd249","60934b0b648f6a003fdfd24a","60934b0b648f6a003fdfd24b","60934b0b648f6a003fdfd24c","5b325c97d19cf700032b17e9","60934b0b648f6a003fdfd24d","60934b0b648f6a003fdfd24e","60934b0b648f6a003fdfd24f","60934b0b648f6a003fdfd250","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","60934b0b648f6a003fdfd251","6376b41e081e400003bac1b2","64b00828dd84d708300ea228","64b008911c1ad20058123f08","64b00899516a6a00574ba22e","64b008a278766c003249e9a6"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2017-11-21T20:43:25.516Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-07-13T14:22:26.974Z"},{"_id":"64e4b17b751ef3002b3801a0","version":"2.2","version_clean":"2.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["64e4b17b751ef3002b3800b9","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","64e4b17b751ef3002b3800ba","64e4b17b751ef3002b3800bb","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","64e4b17b751ef3002b3800bc","64e4b17b751ef3002b3800bd","64e4b17b751ef3002b3800be","64e4b17b751ef3002b3800bf","5b325c97d19cf700032b17e9","64e4b17b751ef3002b3800c0","64e4b17b751ef3002b3800c1","64e4b17b751ef3002b3800c2","64e4b17b751ef3002b3800c3","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","64e4b17b751ef3002b3800c4","64e4b17b751ef3002b3800c5","64e4b17b751ef3002b3800c6","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","64e4b17b751ef3002b3800c7","64e4b17b751ef3002b3800c8","64e4b17b751ef3002b3800c9","64e4b17b751ef3002b3800ca","6376b41e081e400003bac1b3","64e4b17b751ef3002b3800cb","64e4b17b751ef3002b3801a2","64e53563c6633f003f520238","64e537b0059c3f000dcc819a","64e53b81b6b872005fff1f51"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2023-08-22T13:00:43.284Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-09-07T18:14:48.285Z"}],"variableDefaults":[{"source":"security","_id":"6667447bbec68900185017e0","name":"BearerAuth","type":"http","scheme":"bearer","apiSetting":"6453d3f732b93104000efdab"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[],"canonical_url":null,"description":"The H1 API provides healthcare enterprises with accurate data on doctors, insurance plans, and costs of care.\n\nOur mission is to simplify healthcare.","homepage_url":"https://www.h1.co","id":"5b0f46647e0af500032cc9a3","name":"H1 API Docs","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"ribbon","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"BearerAuth","scheme":"bearer","source":"security","type":"http","id":"6667447bbec68900185017e0"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2017-12-05T20:43:25.480Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":"6Lci23khAAAAALNm7KszZJ7DrQ1u6Wwp4GMGIZVm","secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"enabled"}}},"appearance":{"brand":{"primary_color":"#064997","link_color":"#064997","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"large","dark_mode":{"uri":"/images/677db47a75a6c30010760cfc","url":"https://files.readme.io/615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png","name":"615878e8a3ff665394d54b6a24af1dd244f383e05e7e5cf7a8089dffee8645d9-small-H1_Logo_White_1.png","width":132,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/7905752a5d8b3d848fb1addea06857e815c6956eddea231e4e1a392e51ebf605-H1_Logo_White_1.png"}},"main":{"uri":"/images/677db5263a48a2002d36f6c0","url":"https://files.readme.io/1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png","name":"1a1f1519f715c6c42651900559af2cff3b3982cdcba99a20ae48d6f3b175b4f2-small-H1_Logo_Primary_4X_3.png","width":136,"height":80,"color":"#44c94f","links":{"original_url":"https://files.readme.io/f979bbb4ab06eaf2787995cae2139203366e36e90c855e41b6fa73ee479acbd7-H1_Logo_Primary_4X_3.png"}},"favicon":{"uri":"/images/677db4cf6fa8e2005d4ff0b1","url":"https://files.readme.io/ea171b287c6a8fb267f6151e05a72355433eb125a4f478552bc83ef46d8709f7-small-favicon-128x128.png","name":"ea171b287c6a8fb267f6151e05a72355433eb125a4f478552bc83ef46d8709f7-small-favicon-128x128.png","width":32,"height":32,"color":"#44c94f","links":{"original_url":"https://files.readme.io/5c3ab62729fc514246aa1335ab5cd839d1163bc938aea9cc31a4f969cb2fb795-favicon-128x128.png"}}},"custom_code":{"css":".p {\n font-family: 'avenir next';\n font-size: 20px;\n font-weight: bold;\n}\n\n.content-body code { \n display: inline; \n word-break: normal; \n}\n\n.Header-leftADQdGVqx1wqU a.Button.Header-link2tXYTgXq85zW:last-child {\n padding: 1px 12px 0;\n background: #9B255F;\n color: #FFFFFF;\n outline: none;\n}\n\n/* Banner */\n\n#custom-banner {\n background-color:#262F38;\n}\n\n#inner-banner {\n\tmax-width: 1370px;\n\tmargin: 0 auto;\n\tpadding: 10px 35px;\n}\n\n#inner-banner > h4,\n#inner-banner > h4 > a {\n\tcolor: #fff;\n\tfont-size: 16px;\n\tfont-weight: 400;\n margin:0;\n text-align:center;\n}\n\n#inner-banner > h4 > a {\n\tfont-weight: 600;\n margin-left:4px;\n}\n\n@media screen and (max-width: 768px) {\n\t#inner-banner {\n\t\tpadding: 10px 26px;\n\t}\n \n #inner-banner> h4, #inner-banner > h4 > a {\n \tfont-size: 12px;\n }\n}","js":"function insertCustomBanner() {\n \n // !!!!!!!!! Link the banner uses !!!!!!!!!!\n const link = \"https://h1.co/press/h1-welcomes-former-fda-commissioner-to-board-of-directors-acquires-ribbon-health-and-unveils-2025-product-roadmap/\"\n \n // Select the target element where the banner should be added\n const header = document.querySelector('.Header3zzata9F_ZPQ');\n\n // Ensure the target element exists and is accessible\n if (header) {\n // Check if the custom banner already exists to avoid duplication\n if (!document.getElementById('custom-banner')) {\n // Create the custom banner container\n const customBanner = document.createElement('div');\n customBanner.id = 'custom-banner';\n\n // Create the inner banner container\n const innerBanner = document.createElement('div');\n innerBanner.id = 'inner-banner';\n\n // Add content to the inner banner\n const bannerHeading = document.createElement('h4');\n bannerHeading.textContent = 'H1 acquires Ribbon Health.';\n\n const bannerLink = document.createElement('a');\n bannerLink.href = link; // Update with the actual link\n bannerLink.textContent = 'Read More';\n bannerLink.target = '_blank'; // Open in a new tab/window\n\t\t\tbannerLink.rel = 'nofollow noreferrer'; // Add nofollow and noreferrer\n\n // Append heading and link to the inner banner\n innerBanner.appendChild(bannerHeading);\n bannerHeading.appendChild(bannerLink);\n\n // Append the inner banner to the custom banner container\n customBanner.appendChild(innerBanner);\n\n // Insert the banner as the first child of the target element\n header.insertBefore(customBanner, header.firstChild);\n }\n }\n}\n\n// Run the logic on each page load using the pageLoad event\n$(window).on('pageLoad', function (e, state) {\n insertCustomBanner();\n});","html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"guides","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null},{"type":"discussions","title":null,"url":null,"custom_page":null},{"type":"link_url","title":"Try H1!","url":"https://h1.co/request-demo/","custom_page":null}],"logo_link":"landing_page","right":[],"sub_nav":[],"subheader_layout":"dropdown","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"64e4b17b751ef3002b3801a0","version":"2.2","version_clean":"2.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["64e4b17b751ef3002b3800b9","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","64e4b17b751ef3002b3800ba","64e4b17b751ef3002b3800bb","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","64e4b17b751ef3002b3800bc","64e4b17b751ef3002b3800bd","64e4b17b751ef3002b3800be","64e4b17b751ef3002b3800bf","5b325c97d19cf700032b17e9","64e4b17b751ef3002b3800c0","64e4b17b751ef3002b3800c1","64e4b17b751ef3002b3800c2","64e4b17b751ef3002b3800c3","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","64e4b17b751ef3002b3800c4","64e4b17b751ef3002b3800c5","64e4b17b751ef3002b3800c6","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","64e4b17b751ef3002b3800c7","64e4b17b751ef3002b3800c8","64e4b17b751ef3002b3800c9","64e4b17b751ef3002b3800ca","6376b41e081e400003bac1b3","64e4b17b751ef3002b3800cb","64e4b17b751ef3002b3801a2","64e53563c6633f003f520238","64e537b0059c3f000dcc819a","64e53b81b6b872005fff1f51"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2023-08-22T13:00:43.284Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-09-07T18:14:48.285Z"}},"reqUrl":"/reference/geteligibility","version":{"_id":"64e4b17b751ef3002b3801a0","version":"2.2","version_clean":"2.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["64e4b17b751ef3002b3800b9","5b325c97d19cf700032b17e1","5a2a3a680b68c20026c6c3f2","64e4b17b751ef3002b3800ba","64e4b17b751ef3002b3800bb","5a3a9d3dbcc254001c4bfc24","5b325c97d19cf700032b17e4","5a3a9db2bcc254001c4bfc27","64e4b17b751ef3002b3800bc","64e4b17b751ef3002b3800bd","64e4b17b751ef3002b3800be","64e4b17b751ef3002b3800bf","5b325c97d19cf700032b17e9","64e4b17b751ef3002b3800c0","64e4b17b751ef3002b3800c1","64e4b17b751ef3002b3800c2","64e4b17b751ef3002b3800c3","6090b9ab7f2079005b0a40dc","6090baf05f2f7b0041b96d87","64e4b17b751ef3002b3800c4","64e4b17b751ef3002b3800c5","64e4b17b751ef3002b3800c6","62042ccc049f53005ded1bc4","6206c3463e85640077c3b037","64e4b17b751ef3002b3800c7","64e4b17b751ef3002b3800c8","64e4b17b751ef3002b3800c9","64e4b17b751ef3002b3800ca","6376b41e081e400003bac1b3","64e4b17b751ef3002b3800cb","64e4b17b751ef3002b3801a2","64e53563c6633f003f520238","64e537b0059c3f000dcc819a","64e53b81b6b872005fff1f51"],"project":"5b0f46647e0af500032cc9a3","__v":0,"forked_from":"5b325c97d19cf700032b182b","createdAt":"2023-08-22T13:00:43.284Z","releaseDate":"2017-11-21T20:43:25.516Z","updatedAt":"2023-09-07T18:14:48.285Z"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,3622,9772,4904,7449,7372,9082,734,5312,6903,2395,6522,6471,1095,777,6969,2852,9930,7783,1456,5408,2637,2402,5798,4935,4287,4201,1936,1666,5948,8230,1313,1343,6060,4002,1525,3787,1202,1080,9852,8684,3859,9575,3221,7327,2541,3307,7356,8063,2144,4674,1731,9141,4467,6922,2447,4793,2616,3412,2578,678,1231,3826,8899]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-Discuss","Page","Footer","core-icons-chevron-up-down-svg","routes-Doc","routes-PageNotFound","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","routes-Landing","core-icons-alert-circle-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-chevron-down-svg","core-icons-arrow-right-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","RMDX","core-icons-arrow-up-right-svg","routes-Changelog","List","Post","routes-Tutorials","CustomPage","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-eye-off-svg","core-icons-webhook-svg","routes-CustomPage","routes-Dash-ChatGPT-CopilotInstalledPage","New","core-graphics-json-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.17077f1007fd28bfacf2.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3622.30b9cb2443fabb238262.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.4f5b31df3dc44b53f8ec.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.01a0e639a7ef9538f97e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.ccf876992083e861c716.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6471.7c35c1a3aaf54575282a.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1095.0021a98e29fa5ae0423e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/777.ef77d501263107e85d40.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6969.f532cda08d88de16b98a.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.8f091338ee9df50fd3c2.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.fdde3006d3bddb71d71f.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.cada933b93538b08b34f.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.11c1ea4eab468ae0b7f7.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.3803f927cf157eaa6fe4.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.8514b725f5cc2d3b093c.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.31d152eb3e55e8474e47.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.654b955d56546578946f.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.a7fc6699ce547c746349.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/8230.801356cb5016084f6850.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.5ab372d0c14f798d16e3.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/1525.d1de226102472ceacba6.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.b95f6aef50c6c4b838ab.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.b6e98482708fa5a1b7e2.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/2541.0453880796b8f2209146.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.414da433f0aa4db22430.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.431870cb4b4bcf334308.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.d9bd1d5feebc743d66ee.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.541858d9d3864fc7d303.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.e970f190e6b0f9676c06.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.922078b47615946064e5.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.6011119cd662e9e6f233.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.dc3b5b02d7c889ec94bf.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.62a9fb1d734b15803ce5.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.59ae63b23834934d50c8.js"></script></div><script id="customJS">function insertCustomBanner() { // !!!!!!!!! Link the banner uses !!!!!!!!!! const link = "https://h1.co/press/h1-welcomes-former-fda-commissioner-to-board-of-directors-acquires-ribbon-health-and-unveils-2025-product-roadmap/" // Select the target element where the banner should be added const header = document.querySelector('.Header3zzata9F_ZPQ'); // Ensure the target element exists and is accessible if (header) { // Check if the custom banner already exists to avoid duplication if (!document.getElementById('custom-banner')) { // Create the custom banner container const customBanner = document.createElement('div'); customBanner.id = 'custom-banner'; // Create the inner banner container const innerBanner = document.createElement('div'); innerBanner.id = 'inner-banner'; // Add content to the inner banner const bannerHeading = document.createElement('h4'); bannerHeading.textContent = 'H1 acquires Ribbon Health.'; const bannerLink = document.createElement('a'); bannerLink.href = link; // Update with the actual link bannerLink.textContent = 'Read More'; bannerLink.target = '_blank'; // Open in a new tab/window bannerLink.rel = 'nofollow noreferrer'; // Add nofollow and noreferrer // Append heading and link to the inner banner innerBanner.appendChild(bannerHeading); bannerHeading.appendChild(bannerLink); // Append the inner banner to the custom banner container customBanner.appendChild(innerBanner); // Insert the banner as the first child of the target element header.insertBefore(customBanner, header.firstChild); } } } // Run the logic on each page load using the pageLoad event $(window).on('pageLoad', function (e, state) { insertCustomBanner(); }); </script><script async="async" src="https://www.googletagmanager.com/gtag/js?id=G-94W66G7ZVC"></script><script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-94W66G7ZVC');</script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"YTQ4NjI4YWRhMmYwOWE1MzIwM2RmOWZhMzc4NTIxYmM2ZjAzNDY5YmM4MjAwMTExN2M4MDI0NTBlMWU3MDA0MXRhZ0ZpbHRlcnM9KHByb2plY3Q6NWIwZjQ2NjQ3ZTBhZjUwMDAzMmNjOWEzKSwodmVyc2lvbjpub25lLHZlcnNpb246NjRlNGIxN2I3NTFlZjMwMDJiMzgwMWEwKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:5b0f46647e0af500032cc9a3),(version:none,version:64e4b17b751ef3002b3801a0),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":true,"logs":false,"tutorials":false,"graphql":false},"id":"5b0f46647e0af500032cc9a3","name":"H1 API Docs","subdomain":"ribbon","subpath":"","nav_names":{"discuss":"","reference":"","docs":"","changelog":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

Check Member Eligibility