Skip to main content
GET
/
api
/
v0
/
medical
/
inquiries
Get Medical Inquiries
curl --request GET \
  --url https://api.example.com/api/v0/medical/inquiries \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "status": "SUCCESS",
    "creation_ts": "2023-11-07T05:31:56Z",
    "request": {
      "type": "BENEFITS",
      "desired_completion_date": "<string>",
      "patient_name": "<string>",
      "dob": "<string>",
      "member_id": "<string>",
      "tax_id": "<string>",
      "group_id": "<string>",
      "insurance_in_network": true,
      "npi": "<string>",
      "billing_npi": "<string>",
      "rendering_npi": "<string>",
      "external_id": "<string>",
      "practice_billing_address": "<string>",
      "diagnosis_codes": [
        "<string>"
      ],
      "claims_date_of_service": "<string>",
      "claim_number": "<string>",
      "additional_info": "<string>",
      "call_script_id": "<string>",
      "insurance": "<string>",
      "benefits_query": [
        "DEDUCTIBLES_AND_MAXIMUMS"
      ],
      "benefits_codes": [
        "<string>"
      ],
      "benefits_form_name": "<string>",
      "is_specialist": true,
      "place_of_service": "<string>",
      "billed_amount": 123,
      "insurance_payor_id": "<string>",
      "insurance_phone_number": "<string>"
    },
    "summary": "<string>",
    "results": {
      "call_details": [
        {
          "representative_name": "<string>",
          "reference_number": "<string>",
          "call_end_time": "2023-11-07T05:31:56Z",
          "call_recording_url": "<string>",
          "call_transcript_url": "<string>",
          "call_transcript": "<string>",
          "custom_answers": {}
        }
      ],
      "plan_information": {
        "is_active": true,
        "plan_type": "PPO",
        "effective_date": "10-01-2020",
        "termination_date": "10-31-2021",
        "is_calendar_year_plan": true,
        "is_provider_in_network": true,
        "is_primary_insurance": true
      },
      "maximums": {
        "individual_deductible": "100",
        "individual_deductible_used": "80",
        "individual_out_of_pocket_maximum": "1000",
        "individual_out_of_pocket_maximum_used": "800",
        "family_deductible": "200",
        "family_deductible_used": "100",
        "family_out_of_pocket_maximum": "2000",
        "family_out_of_pocket_maximum_used": "1000"
      },
      "procedure_classes": {},
      "procedure_codes": [
        [
          "<unknown>"
        ]
      ]
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.healthharbor.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

external_id
string
limit
integer
default:200

Response

Successful Response

id
string
required

unique generated (uuid4) id for the inquiry

status
enum<string>
required

status of the inquiry

Available options:
SCHEDULED,
IN_PROGRESS,
SUCCESS,
UNSUCCESSFUL,
CANCELLED,
UNKNOWN
Example:

"SUCCESS"

creation_ts
string<date-time>
required

timestamp of when the inquiry was created

Example:

"2020-01-01T00:00:00.000000Z"

request
Request · object
required

The request that was used to create the inquiry.

summary
string

summary of the call results

Example:

"Benefits retrieved successfully."

results
Results · object

The output from the call containing the benefits results..