Create bulk export
This API will kick off an asynchronous job to create a bulk export csv and return a bulk_export_id
. To know when your export is complete,
you will have to poll with the Get Bulk Exports API.
The body of the bulk export request allows you to set filters on the data you want. For example, if you only wanted
to get all payor approved prior authorizations in 2024, you would make a request like the below, replacing the example provider_id
with the provider ID you want to get data for.
If you want to make requests for eligibility checks, benefits checks, or payor detections/discovery,
you can replace the export_type
with ELIGIBILITY_CHECK
, BENEFITS_CHECK
, or PAYOR_DETECTION
respectively.
CSV Schemas Generated
Prior Authorizations
- patient_ehr_id (optional)
- created_at (YYYY-MM-DD)
- submitted_on (YYYY-MM-DD, optional)
- first_name
- last_name
- patient_code
- service_location_name
- authorization_type
- start_date (YYYY-MM-DD)
- end_date (YYYY-MM-DD, optional)
- authorization_reference_number (optional)
- status
- treatment_codes (list of treatment code objects containing):
- treatment_code
- modifiers (optional list)
- units (decimal)
- unit_type
- time_frame
- specialty (optional)
- payor
- member_number (optional)
Benefits Checks
- patient_ehr_id (optional)
- created_at (YYYY-MM-DD)
- date_verified (YYYY-MM-DD, optional)
- first_name
- last_name
- patient_code
- service_location_name
- patient_status
- patient_date_of_birth (YYYY-MM-DD, optional)
- eligibility_status (optional)
- network_status (optional)
- payor
- member_number (optional)
- group_number (optional)
- plan_start_date (YYYY-MM-DD, optional)
- plan_end_date (YYYY-MM-DD, optional)
- plan_type (optional)
- subscriber_first_name (optional)
- subscriber_last_name (optional)
- subscriber_date_of_birth (YYYY-MM-DD, optional)
- subscriber_address (optional)
- subscriber_city (optional)
- subscriber_state (optional)
- subscriber_zip_code (optional)
- subscriber_patient_relationship (optional
- copay (decimal, optional)
- coinsurance (decimal, optional)
- individual_deductible (decimal, optional)
- individual_deductible_met (decimal, optional)
- family_deductible (decimal, optional)
- family_deductible_met (decimal, optional)
- individual_out_of_pocket (decimal, optional)
- individual_out_of_pocket_met (decimal, optional)
- family_out_of_pocket (decimal, optional)
- family_out_of_pocket_met (decimal, optional)
- hard_visit_limit_present (boolean, optional)
- hard_visit_limit_units (integer, optional)
- hard_visit_limit_unit_type (optional)
- referral_required (boolean, optional)
- authorization_required (boolean, optional)
- authorization_not_required (boolean, optional)
- authorization_requirement_time (optional)
- authorization_requirement_quantity (decimal, optional)
- authorization_requirement_unit (optional)
- specialty (optional)
- cost_estimate_copy (optional)
- payor_type (optional)
- exclusions_and_limitations (optional)
If you are using Rates, we will also include each rate that you have set up as a column in the CSV.
Eligibility Checks
- patient_ehr_id (optional)
- created_at (YYYY-MM-DD)
- date_verified (YYYY-MM-DD, optional)
- first_name
- last_name
- patient_code
- service_location_name
- patient_status
- patient_date_of_birth (YYYY-MM-DD, optional)
- payor
- member_number (optional)
- group_number (optional)
- eligibility_status (optional)
Payor Detections
- patient_ehr_id (optional)
- first_name
- last_name
- patient_code
- payor
- member_number (optional)
- date_found (YYYY-MM-DD)
- status
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Create Parameters for Bulk Export
Prior Auth Export Params