RibbonCare is a virtual dermatology platform for eczema and psoriasis treatment.
" }, "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": "We focus on eczma and psoriasis care
" }, "insurances": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "0082f872-5383-44de-9319-511f090fc56b" } }, "insurances_detail": { "type": "string", "example": "We have flexibility to do single case agreements with other payers/plans not listed on our profile
" }, "sign_up_instructions": { "type": "string", "example": "We also employ allied health professionals and lactation consultants
" }, "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": "Patients can book an appointment through the Age Bold website: https://www.ribbonvirtualcare.com/booking
" }, "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": "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.
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.
" }, "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\u2019s 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" }, "place_of_service": { "type": "string", "description": "The Place of Service (POS) code to include in the eligibility request", "nullable": true } } } } } }, "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": [] } ] }