v2

latestOpenAPI 3.1.02026-07-31515292.8 KB

Get Medical Inquiry

get/api/v0/medical/inquiries/{id}

Path parameters

idstring required

Response

Successful Response

idstring required

unique generated (uuid4) id for the inquiry

status'SCHEDULED' | 'IN_PROGRESS' | 'SUCCESS' | 'UNSUCCESSFUL' | 'CANCELLED' | 'UNKNOWN' required

An enumeration.

creation_tsstring date-time required

timestamp of when the inquiry was created

summarystring

summary of the call results

Example response

{
  "creation_ts": "2020-01-01T00:00:00.000000Z",
  "summary": "Benefits retrieved successfully.",
  "results": {
    "call_details": [
      {
        "call_end_time": "2024-03-01T06:00:00.0000Z",
        "representative_name": "Deborah M",
        "reference_number": "2812129",
        "call_recording_url": "https://www.google.com/voice_recording.wav",
        "transcript": "..."
      }
    ],
    "similar_claim_dates": [
      "01-15-2020",
      "01-31-2020"
    ],
    "claims_info": [
      {
        "main_class": "ClaimApprovedInfo",
        "date_of_service": "01-31-2020",
        "claim_summary": "Claim paid",
        "date_received": "01-31-2020",
        "date_processed_up_to": "01-31-2020",
        "turnaround_time": "21 business days",
        "date_processed": "01-31-2020",
        "date_paid": "01-31-2020",
        "total_amount_paid": 100,
        "adjustment_details": "Adjusted for deductible",
        "code_details": [
          {
            "procedure_code": "99213",
            "amount_paid": 100,
            "patient_responsibility": 20,
            "patient_applied_to_deductible": 10
          }
        ],
        "claim_denial_reason": "Not covered due to frequency"
      }
    ],
    "claim_not_found_info": {
      "patient_eligible_on_dos": true
    }
  },
  "request": {
    "desired_completion_date": "03-19-2024",
    "patient_name": "Alex Martin",
    "dob": "01-31-2020",
    "member_id": "123456789",
    "group_id": "123456",
    "npi": "1234567890",
    "billing_npi": "1234567890",
    "rendering_npi": "1234567890",
    "tax_id": "123456789",
    "practice_billing_address": "123 Main St, New York, NY 10001",
    "diagnosis_codes": [
      "F41.1",
      "F42.23"
    ],
    "claims_date_of_service": "01-31-2020",
    "claim_number": "1234567890",
    "additional_info": "The patient is on a Medicare plan and we need to know their secondary insurance benefits.",
    "insurance": "United Healthcare",
    "benefits_query": [
      "PULMONARY_REHAB_COVERAGE"
    ],
    "benefits_codes": [
      "99395"
    ],
    "is_specialist": true,
    "place_of_service": "doctors office",
    "billed_amount": 100,
    "insurance_payor_id": "60054"
  }
}