ClearCarePulse

{
  "properties": {
    "current_setting": {
      "description": "Where currently scheduled (default: hospital outpatient)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "City or region for geographic adjustment",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "description": "Cosmetic procedure — e.g., 'rhinoplasty', 'breast augmentation', 'botox', 'liposuction'",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "has_insurance": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "description": "Dental procedure — e.g., 'crown', 'root canal', 'implant', 'deep cleaning'",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "coinsurance": {
      "description": "Patient coinsurance % (default: 20)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "deductible": {
      "description": "Annual deductible in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "deductible_met": {
      "description": "Deductible already met this year in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "oop_max": {
      "description": "Annual out-of-pocket maximum in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "hospital": {
      "description": "Hospital name — e.g., 'Cleveland Clinic', 'Stanford Medical Center'",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "description": "Procedure name",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "hospital",
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "bill_amount": {
      "description": "Bill amount in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "hospital": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "income": {
      "description": "Annual income in USD (for charity care eligibility)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "insured": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "coinsurance": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "deductible": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "deductible_met": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "hsa": {
      "description": "Has HSA (true/false)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "oop_max": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "oop_spent": {
      "description": "OOP already spent this year in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "plan_type": {
      "description": "Plan type (Bronze, Silver, Gold, Platinum, employer)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure_cost": {
      "description": "Known procedure cost in USD",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure"
  ],
  "type": "object"
}

{
  "properties": {
    "annual_income": {
      "description": "assistance: annual income (FPL math)",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "balance_billed": {
      "description": "surprise: balance-billed amount",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "bill_date": {
      "description": "gfe: bill date (120-day window)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "billed_amount": {
      "description": "gfe: the bill",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "check": {
      "description": "Which check to run",
      "enum": [
        "surprise",
        "gfe",
        "assistance",
        "appeal",
        "msn"
      ],
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "claim_type": {
      "description": "appeal: claim type (decision windows differ)",
      "enum": [
        "urgent",
        "pre_service",
        "post_service"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "consent_signed": {
      "description": "surprise: did you sign a notice-and-consent form",
      "required": false,
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "denial_date": {
      "description": "appeal: denial notice date",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "final_denial_date": {
      "description": "appeal: final internal denial (external-review window)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "first_statement_date": {
      "description": "assistance: first post-discharge statement (ECA/application windows)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "gfe_amount": {
      "description": "gfe: the estimate",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "household_size": {
      "description": "assistance: household size (FPL math)",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "msn_date": {
      "description": "msn: Medicare Summary Notice date",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "nonprofit": {
      "description": "assistance: is the hospital nonprofit",
      "required": false,
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "plan_type": {
      "description": "surprise: plan funding (ERISA nuance changes the enforcement route)",
      "enum": [
        "employer_self_funded",
        "employer_insured",
        "marketplace",
        "medicare",
        "medicaid",
        "uninsured",
        "unknown"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "scenario": {
      "description": "surprise: what happened",
      "enum": [
        "emergency",
        "oon_at_in_network",
        "air_ambulance",
        "ground_ambulance"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "service_role": {
      "description": "surprise: clinician role (never-waivable ancillary detection)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "check"
  ],
  "type": "object"
}

{
  "properties": {
    "check": {
      "description": "Which document",
      "enum": [
        "surprise",
        "gfe",
        "assistance",
        "appeal",
        "msn"
      ],
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Letter language (default English)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "patient_name": {
      "description": "Patient name (placeholder if omitted)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "provider_name": {
      "description": "Provider/plan/hospital name",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "check"
  ],
  "type": "object"
}

{
  "properties": {
    "lang": {
      "description": "Response language (e.g., 'Spanish')",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "procedure": {
      "description": "Procedure name in plain English — e.g., 'knee MRI', 'colonoscopy', 'hip replacement'",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "radius": {
      "default": "25",
      "description": "Search radius in miles",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Patient zip code for geographic search",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "procedure",
    "zip"
  ],
  "type": "object"
}