RatesResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ticexplorer-com/json-schema/ticexplorer-com-rates-result-schema.json",
  "title": "RatesResult",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ticexplorer-com-openapi.json#/components/schemas/RatesResult",
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/RateRow"
      },
      "type": "array",
      "title": "Data"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Cursor"
    },
    "total_rows": {
      "type": "integer",
      "title": "Total Rows"
    },
    "summary": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Summary",
      "default": []
    },
    "cheapest_sites": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array",
      "title": "Cheapest Sites",
      "description": "Per code x component: the cheapest real places to go (site, address, miles to the site, TIN, amount, quality).",
      "default": []
    },
    "hospital_file_check": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hospital File Check",
      "description": "How many hospital rows were compared with the hospitals' own price files, and how many agree."
    },
    "medicare_reference": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medicare Reference",
      "description": "coverage medicare: per code OPPS wage-adjusted APC, estimated lab fee, ASP drug limit."
    },
    "coverage": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Coverage"
    },
    "needs": {
      "items": {
        "$ref": "#/$defs/Need"
      },
      "type": "array",
      "title": "Needs",
      "default": []
    },
    "next_steps": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Next Steps",
      "default": []
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "data",
    "total_rows"
  ],
  "$defs": {
    "Billing": {
      "properties": {
        "billing_class": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Billing Class",
          "description": "professional (clinician claim) | institutional (facility claim)"
        },
        "setting": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Setting"
        },
        "modifiers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Modifiers",
          "default": []
        },
        "component": {
          "type": "string",
          "title": "Component",
          "description": "global | professional_component | technical_component | professional | facility | drug"
        },
        "applies_when": {
          "type": "string",
          "title": "Applies When"
        },
        "place_of_service": {
          "type": "string",
          "title": "Place Of Service",
          "description": "non_facility | facility | mixed | unspecified"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "component",
        "applies_when",
        "place_of_service"
      ],
      "title": "Billing"
    },
    "Need": {
      "properties": {
        "field": {
          "type": "string",
          "title": "Field",
          "description": "The missing input or condition, e.g. which_insurer, place_of_service, wait."
        },
        "why": {
          "type": "string",
          "title": "Why",
          "description": "Why it changes the answer and what to do."
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "field",
        "why"
      ],
      "title": "Need"
    },
    "Price": {
      "properties": {
        "kind": {
          "type": "string",
          "title": "Kind",
          "description": "negotiated | fee_schedule | derived | per_diem | percent_of_charges | placeholder | algorithm ..."
        },
        "amount": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Amount",
          "description": "Allowed dollars per unit; null when not a dollar price."
        },
        "percent": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Percent"
        },
        "unit": {
          "type": "string",
          "title": "Unit",
          "description": "per_service | per_day | per_apc_case | percent_of_billed_charges | none"
        },
        "is_dollar_price": {
          "type": "boolean",
          "title": "Is Dollar Price"
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "kind",
        "unit",
        "is_dollar_price"
      ],
      "title": "Price"
    },
    "RateRow": {
      "properties": {
        "code": {
          "type": "string",
          "title": "Code"
        },
        "code_type": {
          "type": "string",
          "title": "Code Type"
        },
        "billing_entity": {
          "additionalProperties": true,
          "type": "object",
          "title": "Billing Entity",
          "description": "{tin, name, is_hospital}: prices belong to billing entities."
        },
        "location": {
          "additionalProperties": true,
          "type": "object",
          "title": "Location"
        },
        "price": {
          "$ref": "#/$defs/Price"
        },
        "billing": {
          "$ref": "#/$defs/Billing"
        },
        "hospital_outpatient": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hospital Outpatient",
          "description": "APC, status indicator, packaging (institutional rows)."
        },
        "benchmark": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Benchmark",
          "description": "Medicare amount for the same service/setting + percent_of_medicare."
        },
        "flags": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Flags",
          "default": []
        },
        "quality": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Quality",
          "description": "{score 1-5, reason}: 5 corroborated by the hospital's own file, 4 consistent with Medicare band, 3 unchecked / not corroborated, 2 unusual, 1 not a usable dollar price (guide://fields)."
        },
        "hospital_file_rate": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hospital File Rate",
          "description": "Hospital rows: the same hospital's own price file for this payer and code (amount, plan_as_written, agreement, difference_percent)."
        },
        "evidence": {
          "additionalProperties": true,
          "type": "object",
          "title": "Evidence"
        },
        "provenance": {
          "additionalProperties": true,
          "type": "object",
          "title": "Provenance",
          "description": "payer, plan, files, insurer_date_label vs retrieved_at, future_dated_label."
        }
      },
      "additionalProperties": true,
      "type": "object",
      "required": [
        "code",
        "code_type",
        "billing_entity",
        "location",
        "price",
        "billing",
        "evidence",
        "provenance"
      ],
      "title": "RateRow"
    }
  }
}