---
title: "GET /api/patients_list"
method: GET
path: "/api/patients_list"
tags: ["Clinical"]
---

# GET /api/patients_list

`GET /api/patients_list`

Retrieve or search patients in batches. This resource returns identical data to `GET /api/patients` but uses an asynchronous batch-based approach to data delivery. This is an efficient choice for large historical record loading use cases. Retrieve the results/status of a previously created patient_list request using the UUID returned in the response. Results are ordered by patient ID number.

## Query parameters

- `uuid` string, required

## Response `200`

OK

- object — Paginated Result
  - `status` string — Status of the request. Possible values are "In progress" or "Complete".
  - `results` Patient[] — result data. only presented when the status is "Complete"
    - `medication_history_consent` string
    - `last_name` string
    - `emergency_contact_phone` string
    - `primary_care_physician` string — Referring doctor for this patient
    - `date_of_first_appointment` string — Date of first patient visit.
    - `tertiary_insurance` object — **Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.
      - `insurance_group_name` string
      - `insurance_id_number` string
      - `insurance_claim_office_number` string — Insurance office phone number
      - `subscriber_address` string
      - `subscriber_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' — Two-letter state code
      - `subscriber_social_security` string
      - `photo_front` string — Photo of front of insurance card
      - `subscriber_last_name` string
      - `subscriber_middle_name` string
      - `subscriber_date_of_birth` string
      - `insurance_company` string
      - `is_subscriber_the_patient` boolean — True if the insurance policy is under patient's own name. Defaults to true
      - `insurance_plan_name` string — Name of insurance plan.
      - `patient_relationship_to_subscriber` '' | '01' | '04' | '05' | '07' | '10' | '15' | '17' | '19' | '20' | '21' | '22' | '23' | '24' | '29' | '32' | '33' | '36' | '39' | '40' | '41' | '43' | '53' | '76' | 'G8' — HCFA/1500 individual relationship code
      - `subscriber_gender` '' | 'Male' | 'Female' | 'Other' | 'UNK' | 'ASKU' — One of `"Male"` or `"Female"`
      - `photo_back` string — Photo of back of insurance card
      - `subscriber_suffix` string — E.g. `"II"` or `"III"`
      - `subscriber_zip_code` string
      - `subscriber_city` string
      - `insurance_plan_type` '' | 'AM' | 'BL' | 'CH' | 'CI' | '17' | 'DS' | '14' | 'FI' | 'HM' | '16' | '15' | 'LM' | 'MC' | 'MA' | 'MB' | 'ZZ' | 'OF' | '11' | '13' | '12' | 'TV' | 'VA' | 'WC'
      - `insurance_payer_id` string
      - `subscriber_country` '' | 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CYM' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Two-letter country code
      - `subscriber_first_name` string
      - `insurance_group_number` string
    - `patient_flags_attached` object[] — Patient flags attached to the patient
      - `archived` boolean
      - `flag_text` string — Description of the patient flag
      - `created_at` string
      - `flag_type` integer — ID of the associated `/api/patient_flag_types` object
      - `updated_at` string
      - `id` integer
    - `updated_at` string
    - `custom_demographics` object[]
      - `field_type` integer — ID of the `/api/custom_demographics` object
      - `updated_at` string
      - `value` string
    - `referring_source` string — Referring source.
    - `responsible_party_relation` string
    - `zip_code` string
    - `id` integer
    - `employer_city` string
    - `employer_state` string — Two-letter abbreviation
    - `city` string
    - `first_name` string
    - `middle_name` string
    - `doctor` integer, required
    - `race_subcategories` object[]
      - `code` string
      - `description` string
    - `disable_sms_messages` boolean — If True, suppress SMS/Txt messages to this patient even if we have a cell phone # for them.
    - `employer` string
    - `preferred_language_description` string
    - `patient_flags` object[] — Possible patient flag type that can be attached to the patient
      - `archived` boolean
      - `name` string
      - `doctor` integer — ID of doctor who owns the flag
      - `color` string
      - `created_at` string
      - `updated_at` string
      - `priority` integer
      - `id` integer
    - `date_of_birth` string
    - `ethnicity` 'blank' | 'hispanic' | 'not_hispanic' | 'declined' — One of `"blank"`, `"hispanic"`, `"not_hispanic"` or `"declined"`
    - `home_phone` string
    - `pronouns` '' | 'LA29518-0' | 'LA29519-8' | 'LA29520-6' | 'LA29523-0' | 'LA29521-4' | 'LA29515-6' | 'LA29516-4' | 'LA29517-2' | 'LA29522-2' | 'LA29524-8'
    - `patient_status` 'A' | 'I' | 'D' — One of `"A"` (active), `"I"` (inactive), `"D"` (inactive-deceased)
    - `patient_photo_date` string — Cannot be passed without `patient_photo`
    - `gender_identity_description` string
    - `email` string
    - `responsible_party_email` string
    - `patient_photo` string
    - `responsible_party_phone` string
    - `state` string — Two-letter abbreviation
    - `secondary_insurance` object — **Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.
      - `insurance_group_name` string
      - `insurance_id_number` string
      - `insurance_claim_office_number` string — Insurance office phone number
      - `subscriber_address` string
      - `subscriber_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' — Two-letter state code
      - `subscriber_social_security` string
      - `photo_front` string — Photo of front of insurance card
      - `subscriber_last_name` string
      - `subscriber_middle_name` string
      - `subscriber_date_of_birth` string
      - `insurance_company` string
      - `is_subscriber_the_patient` boolean — True if the insurance policy is under patient's own name. Defaults to true
      - `insurance_plan_name` string — Name of insurance plan.
      - `patient_relationship_to_subscriber` '' | '01' | '04' | '05' | '07' | '10' | '15' | '17' | '19' | '20' | '21' | '22' | '23' | '24' | '29' | '32' | '33' | '36' | '39' | '40' | '41' | '43' | '53' | '76' | 'G8' — HCFA/1500 individual relationship code
      - `subscriber_gender` '' | 'Male' | 'Female' | 'Other' | 'UNK' | 'ASKU' — One of `"Male"` or `"Female"`
      - `photo_back` string — Photo of back of insurance card
      - `subscriber_suffix` string — E.g. `"II"` or `"III"`
      - `subscriber_zip_code` string
      - `subscriber_city` string
      - `insurance_plan_type` '' | 'AM' | 'BL' | 'CH' | 'CI' | '17' | 'DS' | '14' | 'FI' | 'HM' | '16' | '15' | 'LM' | 'MC' | 'MA' | 'MB' | 'ZZ' | 'OF' | '11' | '13' | '12' | 'TV' | 'VA' | 'WC'
      - `insurance_payer_id` string
      - `subscriber_country` '' | 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CYM' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Two-letter country code
      - `subscriber_first_name` string
      - `insurance_group_number` string
    - `date_of_last_appointment` string — Date of previous patient visit
    - `preferred_language_code` string
    - `patient_payment_profile` '' | 'Cash' | 'Insurance' | 'Insurance Out of Network' | 'Auto Accident' | 'Worker's Comp' — One of `""`, `"Cash"`, `"Insurance"`, `"Insurance Out of Network"`, `"Auto Accident"` or `"Worker's Comp"`.<br>**Note:** Patient must already have either `primary_insurance` or `secondary_insurance` or new `primary_insurance` or `secondary_insurance` is passed in request if `Insurance`, `Auto Accident` or `Worker's Comp` payment profiles are chosen.
    - `date_of_death` string — Available when show_inactive is passed
    - `social_security_number` string
    - `auto_accident_insurance` object
      - `auto_accident_claim_rep_city` string
      - `auto_accident_claim_rep_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
      - `auto_accident_claim_rep_address` string
      - `auto_accident_will_require_therapy_rec` string
      - `auto_accident_subscriber_middle_name` string
      - `auto_accident_still_under_care` boolean — Is patient still under your care for this condition?
      - `auto_accident_significant_injury_notes` string
      - `auto_accident_subscriber_first_name` string
      - `auto_accident_subscriber_address` string
      - `auto_accident_disabled_from_date` string — Patient was disabled (unable to work) from
      - `auto_accident_company` string
      - `auto_accident_disabled_to_date` string — Patient was disabled (unable to work) to
      - `auto_accident_similar_condition_date` string — Date of same or similar condition
      - `auto_accident_case_number` string
      - `auto_accident_claim_rep_is_insurer` boolean — Is the insurer's claim representative the insurer?
      - `auto_accident_payer_address` string
      - `auto_accident_subscriber_last_name` string
      - `auto_accident_subscriber_social_security` string
      - `auto_accident_subscriber_phone_number` string
      - `auto_accident_subscriber_city` string
      - `auto_accident_significant_injury` 'YES' | 'NO' | 'N\A'
      - `auto_accident_similar_condition_notes` string
      - `auto_accident_payer_id` string — Auto Accident Payer ID
      - `auto_accident_payer_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
      - `auto_accident_subscriber_zip_code` string
      - `auto_accident_payer_zip` string
      - `auto_accident_payer_city` string
      - `auto_accident_will_require_therapy` boolean — Will the patient require rehabilitation and/or occupational therapy as a result of the injuries sustained in this accident?
      - `auto_accident_date_of_accident` string
      - `auto_accident_subscriber_date_of_birth` string
      - `auto_accident_subscriber_suffix` string
      - `auto_accident_subscriber_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
      - `auto_accident_return_to_work_date` string — If still disabled, patient should be able to return to work on
      - `auto_accident_notes` string
      - `auto_accident_policy_number` string
      - `auto_accident_is_subscriber_the_patient` boolean — True if the insurance policy is under patient's own name.
      - `auto_accident_claim_rep_zip` string
      - `auto_accident_state_of_occurrence` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
      - `auto_accident_treatment_duration` string
      - `auto_accident_had_similar_condition` boolean — Has the patient had same or similar condition?
      - `auto_accident_patient_relationship_to_subscriber` '' | '01' | '04' | '05' | '07' | '10' | '15' | '17' | '19' | '20' | '21' | '22' | '23' | '24' | '29' | '32' | '33' | '36' | '39' | '40' | '41' | '43' | '53' | '76' | 'G8'
      - `auto_accident_claim_rep_name` string
    - `address` string
    - `chart_id` string — Automatically set using first & last name if absent
    - `referring_doctor` object
      - `fax` string — Should follow format "xxx-xx-xxxx"
      - `last_name` string
      - `middle_name` string
      - `suffix` string
      - `first_name` string
      - `provider_number` string
      - `specialty` '' | 'Acupuncture' | 'Advanced Practice Midwife' | 'Aesthetic Medicine' | 'Aesthetician' | 'Allergist/Immunologist' | 'Anesthesiologist' | 'Cardiac Electrophysiologist' | 'Cardiologist' | 'Cardiothoracic Surgeon' | 'Child/Adolescent Psychiatry' | 'Chiropractor' | 'Clinical Social Worker' | 'Colorectal Surgeon' | 'Correactology' | 'Cosmetic Medicine' | 'Counselor Mental Health' | 'Counselor Professional' | 'Counselor' | 'Dentist' | 'Diabetology' | 'Dermatologist' | 'Diagnostic Medical Sonographer' | 'Dietitian, Registered' | 'Ear-Nose-Throat Specialist (ENT)' | 'Emergency Medicine Physician' | 'Endocrinologist' | 'Endodontist' | 'Epidemiologist' | 'Family Practitioner' | 'Gastroenterologist' | 'General Practice' | 'General Surgeon' | 'Geneticist' | 'Geriatrician' | 'Gerontologist' | 'Gynecologist (no OB)' | 'Gynegologic Oncologist' | 'Hand Surgeon' | 'Hematologist' | 'Home Care' | 'Hospice' | 'Hospitalist' | 'Infectious Disease Specialist' | 'Integrative and Functional Medicine' | 'Integrative Medicine' | 'Internist' | 'Interventional Radiology' | 'Laboratory Medicine Specialist' | 'Laser Surgery' | 'Massage Therapist' | 'Naturopathic Physician' | 'Neonatologist' | 'Nephrologist' | 'Neurologist' | 'Neuropsychology' | 'Neurosurgeon' | 'Not Actively Practicing' | 'Nuclear Medicine Specialist' | 'Nurse Practitioner' | 'Nursing' | 'Nutritionist' | 'Obstetrician/Gynecologist' | 'Occupational Medicine' | 'Occupational Therapist' | 'Oncologist' | 'Ophthalmologist' | 'Optometrist' | 'Oral Surgeon' | 'Orofacial Pain' | 'Orthodontist' | 'Orthopedic Surgeon' | 'Orthotist' | 'Other' | 'Pain Management Specialist' | 'Pathologist' | 'Pediatric Dentist' | 'Pediatric Gastroenterology' | 'Pediatric Surgeon' | 'Pediatrician' | 'Perinatologist' | 'Periodontist' | 'Physical Medicine and Rehab Specialist' | 'Physical Therapist' | 'Physician Assistant' | 'Plastic Surgeon' | 'Podiatrist' | 'Preventive-Aging Medicine' | 'Preventive Medicine/Occupational-Environmental Medicine' | 'Primary Care Physician' | 'Prosthetist' | 'Prosthodontist' | 'Psychiatrist' | 'Psychologist' | 'Public Health Professional' | 'Pulmonologist' | 'Radiation Oncologist' | 'Radiologist' | 'Registered Nurse' | 'Religious Nonmedical Practitioner' | 'Reproductive Endocrinologist' | 'Reproductive Medicine' | 'Rheumatologist' | 'Sleep Medicine' | 'Speech-Language Pathologist' | 'Sports Medicine Specialist' | 'Urologist' | 'Urgent Care' | 'Vascular Surgeon' — Can be one of following, `''`, `'Acupuncture'`, `'Advanced Practice Midwife'`, `'Aesthetic Medicine'`, `'Aesthetician'`, `'Allergist/Immunologist'`, `'Anesthesiologist'`, `'Cardiac Electrophysiologist'`, `'Cardiologist'`, `'Cardiothoracic Surgeon'`, `'Child/Adolescent Psychiatry'`, `'Chiropractor'`, `'Clinical Social Worker'`, `'Colorectal Surgeon'`, `'Correactology'`, `'Cosmetic Medicine'`, `'Counselor Mental Health'`, `'Counselor Professional'`, `'Counselor'`, `'Dentist'`, `'Diabetology'`, `'Dermatologist'`, `'Diagnostic Medical Sonographer'`, `'Dietitian, Registered'`, `'Ear-Nose-Throat Specialist (ENT)'`, `'Emergency Medicine Physician'`, `'Endocrinologist'`, `'Endodontist'`, `'Epidemiologist'`, `'Family Practitioner'`, `'Gastroenterologist'`, `'General Practice'`, `'General Surgeon'`, `'Geneticist'`, `'Geriatrician'`, `'Gerontologist'`, `'Gynecologist (no OB)'`, `'Gynegologic Oncologist'`, `'Hand Surgeon'`, `'Hematologist'`, `'Home Care'`, `'Hospice'`, `'Hospitalist'`, `'Infectious Disease Specialist'`, `'Integrative and Functional Medicine'`, `'Integrative Medicine'`, `'Internist'`, `'Interventional Radiology'`, `'Laboratory Medicine Specialist'`, `'Laser Surgery'`, `'Massage Therapist'`, `'Naturopathic Physician'`, `'Neonatologist'`, `'Nephrologist'`, `'Neurologist'`, `'Neuropsychology'`, `'Neurosurgeon'`, `'Not Actively Practicing'`, `'Nuclear Medicine Specialist'`, `'Nurse Practitioner'`, `'Nursing'`, `'Nutritionist'`, `'Obstetrician/Gynecologist'`, `'Occupational Medicine'`, `'Occupational Therapist'`, `'Oncologist'`, `'Ophthalmologist'`, `'Optometrist'`, `'Oral Surgeon'`, `'Orofacial Pain'`, `'Orthodontist'`, `'Orthopedic Surgeon'`, `'Orthotist'`, `'Other'`, `'Pain Management Specialist'`, `'Pathologist'`, `'Pediatric Dentist'`, `'Pediatric Gastroenterology'`, `'Pediatric Surgeon'`, `'Pediatrician'`, `'Perinatologist'`, `'Periodontist'`, `'Physical Medicine and Rehab Specialist'`, `'Physical Therapist'`, `'Physician Assistant'`, `'Plastic Surgeon'`, `'Podiatrist'`, `'Preventive-Aging Medicine'`, `'Preventive Medicine/Occupational-Environmental Medicine'`, `'Primary Care Physician'`, `'Prosthetist'`, `'Prosthodontist'`, `'Psychiatrist'`, `'Psychologist'`, `'Public Health Professional'`, `'Pulmonologist'`, `'Radiation Oncologist'`, `'Radiologist'`, `'Registered Nurse'`, `'Religious Nonmedical Practitioner'`, `'Reproductive Endocrinologist'`, `'Reproductive Medicine'`, `'Rheumatologist'`, `'Sleep Medicine'`, `'Speech-Language Pathologist'`, `'Sports Medicine Specialist'`, `'Urologist'`, `'Urgent Care'`, `'Vascular Surgeon'`
      - `provider_qualifier` '' | '0B' | '1G' | 'G2' — Can be one of following, `''`, `'0B'`(State License #), `'1G'`(Provider UPIN #), `'G2'`(Provider Commercial #)
      - `phone` string — Should follow format "xxx-xx-xxxx"
      - `address` string
      - `npi` string
      - `email` string
    - `primary_insurance` object — **Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.
      - `insurance_group_name` string
      - `insurance_id_number` string
      - `insurance_claim_office_number` string — Insurance office phone number
      - `subscriber_address` string
      - `subscriber_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' — Two-letter state code
      - `subscriber_social_security` string
      - `photo_front` string — Photo of front of insurance card
      - `subscriber_last_name` string
      - `subscriber_middle_name` string
      - `subscriber_date_of_birth` string
      - `insurance_company` string
      - `is_subscriber_the_patient` boolean — True if the insurance policy is under patient's own name. Defaults to true
      - `insurance_plan_name` string — Name of insurance plan.
      - `patient_relationship_to_subscriber` '' | '01' | '04' | '05' | '07' | '10' | '15' | '17' | '19' | '20' | '21' | '22' | '23' | '24' | '29' | '32' | '33' | '36' | '39' | '40' | '41' | '43' | '53' | '76' | 'G8' — HCFA/1500 individual relationship code
      - `subscriber_gender` '' | 'Male' | 'Female' | 'Other' | 'UNK' | 'ASKU' — One of `"Male"` or `"Female"`
      - `photo_back` string — Photo of back of insurance card
      - `subscriber_suffix` string — E.g. `"II"` or `"III"`
      - `subscriber_zip_code` string
      - `subscriber_city` string
      - `insurance_plan_type` '' | 'AM' | 'BL' | 'CH' | 'CI' | '17' | 'DS' | '14' | 'FI' | 'HM' | '16' | '15' | 'LM' | 'MC' | 'MA' | 'MB' | 'ZZ' | 'OF' | '11' | '13' | '12' | 'TV' | 'VA' | 'WC'
      - `insurance_payer_id` string
      - `subscriber_country` '' | 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CYM' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Two-letter country code
      - `subscriber_first_name` string
      - `insurance_group_number` string
    - `preferred_language` 'blank' | 'eng' | 'zho' | 'fra' | 'ita' | 'jpn' | 'por' | 'rus' | 'spa' | 'other' | 'unknown' | 'declined' — Use ISO 639 alpha-3 codes
    - `responsible_party_name` string
    - `nick_name` string — Common name for patient, should be used instead of first name if supplied.
    - `copay` string
    - `created_at` string
    - `emergency_contact_relation` string
    - `gender_identity_code` string
    - `office_phone` string
    - `employer_address` string
    - `race` 'blank' | 'indian' | 'asian' | 'black' | 'hawaiian' | 'white' | 'other' | 'declined' — One of `"blank"`, `"indian"`, `"asian"`, `"black"`, `"hawaiian"`, `"white"` or `"declined"`
    - `offices` integer[] — IDs of every office this patient has been to
    - `preferred_pharmacies` string — ncpdp id of patient's preferred pharmacies
    - `emergency_contact_name` string
    - `gender` '' | 'Male' | 'Female' | 'Other' | 'UNK' | 'ASKU', required — One of `"Male"`, `"Female"`, or `"Other"`
    - `default_pharmacy` string — ncpdp id of patient's default pharmacy
    - `cell_phone` string
    - `employer_zip_code` string
    - `workers_comp_insurance` object
      - `workers_comp_payer_city` string
      - `workers_comp_payer_id` string
      - `workers_comp_group_name` string
      - `workers_comp_wcb` string
      - `workers_comp_carrier_code` string
      - `workers_comp_notes` string
      - `property_and_casualty_agency_claim_number` string
      - `workers_comp_state_of_occurrence` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
      - `workers_comp_payer_zip` string
      - `workers_comp_wcb_rating_code` string
      - `workers_comp_case_number` string
      - `workers_comp_group_number` string
      - `workers_comp_company` string
      - `workers_comp_payer_address` string
      - `workers_comp_date_of_accident` string
      - `workers_comp_payer_state` 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'
  - `uuid` string — UUID of the batch request.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized
- `403` — Permission Denied
- `404` — Not Found. The UUID is not found, or, it has expired. UUIDs have a 1 hour lifetime.
- `500` — Internal Server Error

---

[API](https://skmtc.net/drchrono/apis/untitled-api.md) · [All operations](https://skmtc.net/drchrono/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drchrono/untitled-api/versions/e595797fe800/schema)