{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://api-evangelist.github.io/drchrono/json-schema/patient.json", "title": "Patient", "required": [ "gender", "doctor" ], "type": "object", "properties": { "medication_history_consent": { "type": "string", "description": "", "title": "Medication history consent" }, "last_name": { "type": "string", "description": "", "title": "Last name" }, "emergency_contact_phone": { "type": "string", "description": "", "title": "Emergency contact phone" }, "primary_care_physician": { "type": "string", "description": "Referring doctor for this patient", "title": "Primary care physician" }, "date_of_first_appointment": { "type": "string", "description": "Date of first patient visit.", "title": "Date of first appointment" }, "tertiary_insurance": { "title": "TertiaryInsurance", "type": "object", "description": "**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.", "properties": { "insurance_group_name": { "type": "string", "description": "", "title": "Insurance group name" }, "insurance_id_number": { "type": "string", "description": "", "title": "Insurance id number" }, "insurance_claim_office_number": { "type": "string", "description": "Insurance office phone number", "title": "Insurance claim office number" }, "subscriber_address": { "type": "string", "description": "", "title": "Subscriber address" }, "subscriber_state": { "enum": [ "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" ], "type": "string", "description": "Two-letter state code", "title": "Subscriber state" }, "subscriber_social_security": { "type": "string", "description": "", "title": "Subscriber social security" }, "photo_front": { "type": "string", "description": "Photo of front of insurance card", "title": "Photo front" }, "subscriber_last_name": { "type": "string", "description": "", "title": "Subscriber last name" }, "subscriber_middle_name": { "type": "string", "description": "", "title": "Subscriber middle name" }, "subscriber_date_of_birth": { "type": "string", "description": "", "title": "Subscriber date of birth" }, "insurance_company": { "type": "string", "description": "", "title": "Insurance company" }, "is_subscriber_the_patient": { "type": "boolean", "description": "True if the insurance policy is under patient's own name. Defaults to true", "title": "Is subscriber the patient" }, "insurance_plan_name": { "type": "string", "description": "Name of insurance plan.", "title": "Insurance plan name" }, "patient_relationship_to_subscriber": { "enum": [ "", "01", "04", "05", "07", "10", "15", "17", "19", "20", "21", "22", "23", "24", "29", "32", "33", "36", "39", "40", "41", "43", "53", "76", "G8" ], "type": "string", "description": "HCFA/1500 individual relationship code", "title": "Patient relationship to subscriber" }, "subscriber_gender": { "enum": [ "", "Male", "Female", "Other", "UNK", "ASKU" ], "type": "string", "description": "One of `\"Male\"` or `\"Female\"`", "title": "Subscriber gender" }, "photo_back": { "type": "string", "description": "Photo of back of insurance card", "title": "Photo back" }, "subscriber_suffix": { "type": "string", "description": "E.g. `\"II\"` or `\"III\"`", "title": "Subscriber suffix" }, "subscriber_zip_code": { "type": "string", "description": "", "title": "Subscriber zip code" }, "subscriber_city": { "type": "string", "description": "", "title": "Subscriber city" }, "insurance_plan_type": { "enum": [ "", "AM", "BL", "CH", "CI", "17", "DS", "14", "FI", "HM", "16", "15", "LM", "MC", "MA", "MB", "ZZ", "OF", "11", "13", "12", "TV", "VA", "WC" ], "type": "string", "description": "", "title": "Insurance plan type" }, "insurance_payer_id": { "type": "string", "description": "", "title": "Insurance payer id" }, "subscriber_country": { "enum": [ "", "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" ], "type": "string", "description": "Two-letter country code", "title": "Subscriber country" }, "subscriber_first_name": { "type": "string", "description": "", "title": "Subscriber first name" }, "insurance_group_number": { "type": "string", "description": "", "title": "Insurance group number" } } }, "patient_flags_attached": { "items": { "title": "PatientFlag", "type": "object", "description": "Array of patient flag objects", "properties": { "archived": { "readOnly": true, "type": "boolean", "description": "", "title": "Archived" }, "flag_text": { "type": "string", "description": "Description of the patient flag", "title": "Flag text" }, "created_at": { "readOnly": true, "type": "string", "description": "", "title": "Created at" }, "flag_type": { "type": "integer", "description": "ID of the associated `/api/patient_flag_types` object", "title": "Flag type" }, "updated_at": { "readOnly": true, "type": "string", "description": "", "title": "Updated at" }, "id": { "readOnly": true, "type": "integer", "description": "", "title": "ID" } } }, "type": "array", "description": "Patient flags attached to the patient", "title": "Patient flags attached" }, "updated_at": { "readOnly": true, "type": "string", "description": "", "title": "Updated at" }, "custom_demographics": { "items": { "title": "CustomPatientFieldValue", "type": "object", "description": "Custom demographic values the patient has", "properties": { "field_type": { "type": "integer", "description": "ID of the `/api/custom_demographics` object", "title": "Field type" }, "updated_at": { "readOnly": true, "type": "string", "description": "", "title": "Updated at" }, "value": { "type": "string", "description": "", "title": "Value" } } }, "type": "array", "description": "", "title": "Custom demographics" }, "referring_source": { "type": "string", "description": "Referring source.", "title": "Referring source" }, "responsible_party_relation": { "type": "string", "description": "", "title": "Responsible party relation" }, "zip_code": { "type": "string", "description": "", "title": "Zip code" }, "id": { "readOnly": true, "type": "integer", "description": "", "title": "ID" }, "employer_city": { "type": "string", "description": "", "title": "Employer city" }, "employer_state": { "type": "string", "description": "Two-letter abbreviation", "title": "Employer state" }, "city": { "type": "string", "description": "", "title": "City" }, "first_name": { "type": "string", "description": "", "title": "First name" }, "middle_name": { "type": "string", "description": "", "title": "Middle name" }, "doctor": { "type": "integer", "description": "", "title": "Doctor" }, "race_subcategories": { "items": { "title": "RaceSubcategories", "type": "object", "description": "", "properties": { "code": { "type": "string", "description": "", "title": "Code" }, "description": { "type": "string", "description": "", "title": "Description" } } }, "type": "array", "description": "", "title": "Race subcategories" }, "disable_sms_messages": { "type": "boolean", "description": "If True, suppress SMS/Txt messages to this patient even if we have a cell phone # for them.", "title": "Disable sms messages" }, "employer": { "type": "string", "description": "", "title": "Employer" }, "preferred_language_description": { "readOnly": true, "type": "string", "description": "", "title": "Preferred language description" }, "patient_flags": { "items": { "title": "PatientFlagType", "type": "object", "description": "Array of patien flag type objects", "properties": { "archived": { "readOnly": true, "type": "boolean", "description": "", "title": "Archived" }, "name": { "type": "string", "description": "", "title": "Name" }, "doctor": { "type": "integer", "description": "ID of doctor who owns the flag", "title": "Doctor" }, "color": { "type": "string", "description": "", "title": "Color" }, "created_at": { "readOnly": true, "type": "string", "description": "", "title": "Created at" }, "updated_at": { "readOnly": true, "type": "string", "description": "", "title": "Updated at" }, "priority": { "type": "integer", "description": "", "title": "Priority" }, "id": { "readOnly": true, "type": "integer", "description": "", "title": "ID" } } }, "readOnly": true, "type": "array", "description": "Possible patient flag type that can be attached to the patient", "title": "Patient flags" }, "date_of_birth": { "type": "string", "description": "", "title": "Date of birth" }, "ethnicity": { "enum": [ "blank", "hispanic", "not_hispanic", "declined" ], "type": "string", "description": "One of `\"blank\"`, `\"hispanic\"`, `\"not_hispanic\"` or `\"declined\"`", "title": "Ethnicity" }, "home_phone": { "type": "string", "description": "", "title": "Home phone" }, "pronouns": { "enum": [ "", "LA29518-0", "LA29519-8", "LA29520-6", "LA29523-0", "LA29521-4", "LA29515-6", "LA29516-4", "LA29517-2", "LA29522-2", "LA29524-8" ], "type": "string", "description": "", "title": "Pronouns" }, "patient_status": { "enum": [ "A", "I", "D" ], "type": "string", "description": "One of `\"A\"` (active), `\"I\"` (inactive), `\"D\"` (inactive-deceased)", "title": "Patient status" }, "patient_photo_date": { "type": "string", "description": "Cannot be passed without `patient_photo`", "title": "Patient photo date" }, "gender_identity_description": { "readOnly": true, "type": "string", "description": "", "title": "Gender Identity description" }, "email": { "type": "string", "description": "", "title": "Email" }, "responsible_party_email": { "type": "string", "description": "", "title": "Responsible party email" }, "patient_photo": { "type": "string", "description": "", "title": "Patient photo" }, "responsible_party_phone": { "type": "string", "description": "", "title": "Responsible party phone" }, "state": { "type": "string", "description": "Two-letter abbreviation", "title": "State" }, "secondary_insurance": { "title": "SecondaryInsurance", "type": "object", "description": "**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.", "properties": { "insurance_group_name": { "type": "string", "description": "", "title": "Insurance group name" }, "insurance_id_number": { "type": "string", "description": "", "title": "Insurance id number" }, "insurance_claim_office_number": { "type": "string", "description": "Insurance office phone number", "title": "Insurance claim office number" }, "subscriber_address": { "type": "string", "description": "", "title": "Subscriber address" }, "subscriber_state": { "enum": [ "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" ], "type": "string", "description": "Two-letter state code", "title": "Subscriber state" }, "subscriber_social_security": { "type": "string", "description": "", "title": "Subscriber social security" }, "photo_front": { "type": "string", "description": "Photo of front of insurance card", "title": "Photo front" }, "subscriber_last_name": { "type": "string", "description": "", "title": "Subscriber last name" }, "subscriber_middle_name": { "type": "string", "description": "", "title": "Subscriber middle name" }, "subscriber_date_of_birth": { "type": "string", "description": "", "title": "Subscriber date of birth" }, "insurance_company": { "type": "string", "description": "", "title": "Insurance company" }, "is_subscriber_the_patient": { "type": "boolean", "description": "True if the insurance policy is under patient's own name. Defaults to true", "title": "Is subscriber the patient" }, "insurance_plan_name": { "type": "string", "description": "Name of insurance plan.", "title": "Insurance plan name" }, "patient_relationship_to_subscriber": { "enum": [ "", "01", "04", "05", "07", "10", "15", "17", "19", "20", "21", "22", "23", "24", "29", "32", "33", "36", "39", "40", "41", "43", "53", "76", "G8" ], "type": "string", "description": "HCFA/1500 individual relationship code", "title": "Patient relationship to subscriber" }, "subscriber_gender": { "enum": [ "", "Male", "Female", "Other", "UNK", "ASKU" ], "type": "string", "description": "One of `\"Male\"` or `\"Female\"`", "title": "Subscriber gender" }, "photo_back": { "type": "string", "description": "Photo of back of insurance card", "title": "Photo back" }, "subscriber_suffix": { "type": "string", "description": "E.g. `\"II\"` or `\"III\"`", "title": "Subscriber suffix" }, "subscriber_zip_code": { "type": "string", "description": "", "title": "Subscriber zip code" }, "subscriber_city": { "type": "string", "description": "", "title": "Subscriber city" }, "insurance_plan_type": { "enum": [ "", "AM", "BL", "CH", "CI", "17", "DS", "14", "FI", "HM", "16", "15", "LM", "MC", "MA", "MB", "ZZ", "OF", "11", "13", "12", "TV", "VA", "WC" ], "type": "string", "description": "", "title": "Insurance plan type" }, "insurance_payer_id": { "type": "string", "description": "", "title": "Insurance payer id" }, "subscriber_country": { "enum": [ "", "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" ], "type": "string", "description": "Two-letter country code", "title": "Subscriber country" }, "subscriber_first_name": { "type": "string", "description": "", "title": "Subscriber first name" }, "insurance_group_number": { "type": "string", "description": "", "title": "Insurance group number" } } }, "date_of_last_appointment": { "type": "string", "description": "Date of previous patient visit", "title": "Date of last appointment" }, "preferred_language_code": { "readOnly": true, "type": "string", "description": "", "title": "Preferred language code" }, "patient_payment_profile": { "enum": [ "", "Cash", "Insurance", "Insurance Out of Network", "Auto Accident", "Worker's Comp" ], "type": "string", "description": "One of `\"\"`, `\"Cash\"`, `\"Insurance\"`, `\"Insurance Out of Network\"`, `\"Auto Accident\"` or `\"Worker's Comp\"`.
**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.", "title": "Patient payment profile" }, "date_of_death": { "type": "string", "description": "Available when show_inactive is passed", "title": "Date of death" }, "social_security_number": { "type": "string", "description": "", "title": "Social security number" }, "auto_accident_insurance": { "title": "AutoAccidentInsurance", "type": "object", "description": "", "properties": { "auto_accident_claim_rep_city": { "type": "string", "description": "", "title": "Auto accident claim rep city" }, "auto_accident_claim_rep_state": { "enum": [ "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" ], "type": "string", "description": "", "title": "Auto accident claim rep state" }, "auto_accident_claim_rep_address": { "type": "string", "description": "", "title": "Auto accident claim rep address" }, "auto_accident_will_require_therapy_rec": { "type": "string", "description": "", "title": "Auto accident will require therapy rec" }, "auto_accident_subscriber_middle_name": { "type": "string", "description": "", "title": "Auto accident subscriber middle name" }, "auto_accident_still_under_care": { "type": "boolean", "description": "Is patient still under your care for this condition?", "title": "Auto accident still under care" }, "auto_accident_significant_injury_notes": { "type": "string", "description": "", "title": "Auto accident significant injury notes" }, "auto_accident_subscriber_first_name": { "type": "string", "description": "", "title": "Auto accident subscriber first name" }, "auto_accident_subscriber_address": { "type": "string", "description": "", "title": "Auto accident subscriber address" }, "auto_accident_disabled_from_date": { "type": "string", "description": "Patient was disabled (unable to work) from", "title": "Auto accident disabled from date" }, "auto_accident_company": { "type": "string", "description": "", "title": "Auto accident company" }, "auto_accident_disabled_to_date": { "type": "string", "description": "Patient was disabled (unable to work) to", "title": "Auto accident disabled to date" }, "auto_accident_similar_condition_date": { "type": "string", "description": "Date of same or similar condition", "title": "Auto accident similar condition date" }, "auto_accident_case_number": { "type": "string", "description": "", "title": "Auto accident case number" }, "auto_accident_claim_rep_is_insurer": { "type": "boolean", "description": "Is the insurer's claim representative the insurer?", "title": "Auto accident claim rep is insurer" }, "auto_accident_payer_address": { "type": "string", "description": "", "title": "Auto accident payer address" }, "auto_accident_subscriber_last_name": { "type": "string", "description": "", "title": "Auto accident subscriber last name" }, "auto_accident_subscriber_social_security": { "type": "string", "description": "", "title": "Auto accident subscriber social security" }, "auto_accident_subscriber_phone_number": { "type": "string", "description": "", "title": "Auto accident subscriber phone number" }, "auto_accident_subscriber_city": { "type": "string", "description": "", "title": "Auto accident subscriber city" }, "auto_accident_significant_injury": { "enum": [ "YES", "NO", "N\\A" ], "type": "string", "description": "", "title": "Auto accident significant injury" }, "auto_accident_similar_condition_notes": { "type": "string", "description": "", "title": "Auto accident similar condition notes" }, "auto_accident_payer_id": { "type": "string", "description": "Auto Accident Payer ID", "title": "Auto accident payer id" }, "auto_accident_payer_state": { "enum": [ "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" ], "type": "string", "description": "", "title": "Auto accident payer state" }, "auto_accident_subscriber_zip_code": { "type": "string", "description": "", "title": "Auto accident subscriber zip code" }, "auto_accident_payer_zip": { "type": "string", "description": "", "title": "Auto accident payer zip" }, "auto_accident_payer_city": { "type": "string", "description": "", "title": "Auto accident payer city" }, "auto_accident_will_require_therapy": { "type": "boolean", "description": "Will the patient require rehabilitation and/or occupational therapy as a result of the injuries sustained in this accident?", "title": "Auto accident will require therapy" }, "auto_accident_date_of_accident": { "type": "string", "description": "", "title": "Auto accident date of accident" }, "auto_accident_subscriber_date_of_birth": { "type": "string", "description": "", "title": "Auto accident subscriber date of birth" }, "auto_accident_subscriber_suffix": { "type": "string", "description": "", "title": "Auto accident subscriber suffix" }, "auto_accident_subscriber_state": { "enum": [ "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" ], "type": "string", "description": "", "title": "Auto accident subscriber state" }, "auto_accident_return_to_work_date": { "type": "string", "description": "If still disabled, patient should be able to return to work on", "title": "Auto accident return to work date" }, "auto_accident_notes": { "type": "string", "description": "", "title": "Auto accident notes" }, "auto_accident_policy_number": { "type": "string", "description": "", "title": "Auto accident policy number" }, "auto_accident_is_subscriber_the_patient": { "type": "boolean", "description": "True if the insurance policy is under patient's own name.", "title": "Auto accident is subscriber the patient" }, "auto_accident_claim_rep_zip": { "type": "string", "description": "", "title": "Auto accident claim rep zip" }, "auto_accident_state_of_occurrence": { "enum": [ "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" ], "type": "string", "description": "", "title": "Auto accident state of occurrence" }, "auto_accident_treatment_duration": { "type": "string", "description": "", "title": "Auto accident treatment duration" }, "auto_accident_had_similar_condition": { "type": "boolean", "description": "Has the patient had same or similar condition?", "title": "Auto accident had similar condition" }, "auto_accident_patient_relationship_to_subscriber": { "enum": [ "", "01", "04", "05", "07", "10", "15", "17", "19", "20", "21", "22", "23", "24", "29", "32", "33", "36", "39", "40", "41", "43", "53", "76", "G8" ], "type": "string", "description": "", "title": "Auto accident patient relationship to subscriber" }, "auto_accident_claim_rep_name": { "type": "string", "description": "", "title": "Auto accident claim rep name" } } }, "address": { "type": "string", "description": "", "title": "Address" }, "chart_id": { "type": "string", "description": "Automatically set using first & last name if absent", "title": "Chart id" }, "referring_doctor": { "title": "Patient", "type": "object", "description": "", "properties": { "fax": { "type": "string", "description": "Should follow format \"xxx-xx-xxxx\"", "title": "Fax" }, "last_name": { "type": "string", "description": "", "title": "Last name" }, "middle_name": { "type": "string", "description": "", "title": "Middle name" }, "suffix": { "type": "string", "description": "", "title": "Suffix" }, "first_name": { "type": "string", "description": "", "title": "First name" }, "provider_number": { "type": "string", "description": "", "title": "Provider number" }, "specialty": { "enum": [ "", "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" ], "type": "string", "description": "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'`", "title": "Specialty" }, "provider_qualifier": { "enum": [ "", "0B", "1G", "G2" ], "type": "string", "description": "Can be one of following, `''`, `'0B'`(State License #), `'1G'`(Provider UPIN #), `'G2'`(Provider Commercial #)", "title": "Provider qualifier" }, "phone": { "type": "string", "description": "Should follow format \"xxx-xx-xxxx\"", "title": "Phone" }, "address": { "type": "string", "description": "", "title": "Address" }, "npi": { "type": "string", "description": "", "title": "Npi" }, "email": { "type": "string", "description": "", "title": "Email" } } }, "primary_insurance": { "title": "PrimaryInsurance", "type": "object", "description": "**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.", "properties": { "insurance_group_name": { "type": "string", "description": "", "title": "Insurance group name" }, "insurance_id_number": { "type": "string", "description": "", "title": "Insurance id number" }, "insurance_claim_office_number": { "type": "string", "description": "Insurance office phone number", "title": "Insurance claim office number" }, "subscriber_address": { "type": "string", "description": "", "title": "Subscriber address" }, "subscriber_state": { "enum": [ "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" ], "type": "string", "description": "Two-letter state code", "title": "Subscriber state" }, "subscriber_social_security": { "type": "string", "description": "", "title": "Subscriber social security" }, "photo_front": { "type": "string", "description": "Photo of front of insurance card", "title": "Photo front" }, "subscriber_last_name": { "type": "string", "description": "", "title": "Subscriber last name" }, "subscriber_middle_name": { "type": "string", "description": "", "title": "Subscriber middle name" }, "subscriber_date_of_birth": { "type": "string", "description": "", "title": "Subscriber date of birth" }, "insurance_company": { "type": "string", "description": "", "title": "Insurance company" }, "is_subscriber_the_patient": { "type": "boolean", "description": "True if the insurance policy is under patient's own name. Defaults to true", "title": "Is subscriber the patient" }, "insurance_plan_name": { "type": "string", "description": "Name of insurance plan.", "title": "Insurance plan name" }, "patient_relationship_to_subscriber": { "enum": [ "", "01", "04", "05", "07", "10", "15", "17", "19", "20", "21", "22", "23", "24", "29", "32", "33", "36", "39", "40", "41", "43", "53", "76", "G8" ], "type": "string", "description": "HCFA/1500 individual relationship code", "title": "Patient relationship to subscriber" }, "subscriber_gender": { "enum": [ "", "Male", "Female", "Other", "UNK", "ASKU" ], "type": "string", "description": "One of `\"Male\"` or `\"Female\"`", "title": "Subscriber gender" }, "photo_back": { "type": "string", "description": "Photo of back of insurance card", "title": "Photo back" }, "subscriber_suffix": { "type": "string", "description": "E.g. `\"II\"` or `\"III\"`", "title": "Subscriber suffix" }, "subscriber_zip_code": { "type": "string", "description": "", "title": "Subscriber zip code" }, "subscriber_city": { "type": "string", "description": "", "title": "Subscriber city" }, "insurance_plan_type": { "enum": [ "", "AM", "BL", "CH", "CI", "17", "DS", "14", "FI", "HM", "16", "15", "LM", "MC", "MA", "MB", "ZZ", "OF", "11", "13", "12", "TV", "VA", "WC" ], "type": "string", "description": "", "title": "Insurance plan type" }, "insurance_payer_id": { "type": "string", "description": "", "title": "Insurance payer id" }, "subscriber_country": { "enum": [ "", "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" ], "type": "string", "description": "Two-letter country code", "title": "Subscriber country" }, "subscriber_first_name": { "type": "string", "description": "", "title": "Subscriber first name" }, "insurance_group_number": { "type": "string", "description": "", "title": "Insurance group number" } } }, "preferred_language": { "enum": [ "blank", "eng", "zho", "fra", "ita", "jpn", "por", "rus", "spa", "other", "unknown", "declined" ], "type": "string", "description": "Use ISO 639 alpha-3 codes", "title": "Preferred language" }, "responsible_party_name": { "type": "string", "description": "", "title": "Responsible party name" }, "nick_name": { "type": "string", "description": "Common name for patient, should be used instead of first name if supplied.", "title": "Nick name" }, "copay": { "type": "string", "description": "", "title": "Copay" }, "created_at": { "readOnly": true, "type": "string", "description": "", "title": "Created at" }, "emergency_contact_relation": { "type": "string", "description": "", "title": "Emergency contact relation" }, "gender_identity_code": { "readOnly": true, "type": "string", "description": "", "title": "Gender Identity code" }, "office_phone": { "type": "string", "description": "", "title": "Office phone" }, "employer_address": { "type": "string", "description": "", "title": "Employer address" }, "race": { "enum": [ "blank", "indian", "asian", "black", "hawaiian", "white", "other", "declined" ], "type": "string", "description": "One of `\"blank\"`, `\"indian\"`, `\"asian\"`, `\"black\"`, `\"hawaiian\"`, `\"white\"` or `\"declined\"`", "title": "Race" }, "offices": { "items": { "type": "integer", "description": "", "title": "" }, "type": "array", "description": "IDs of every office this patient has been to", "title": "Offices" }, "preferred_pharmacies": { "items": { "type": "string", "description": "", "title": "" }, "enum": [ [ "string" ] ], "type": "array", "description": "ncpdp id of patient's preferred pharmacies", "title": "Preferred pharmacies" }, "emergency_contact_name": { "type": "string", "description": "", "title": "Emergency contact name" }, "gender": { "enum": [ "", "Male", "Female", "Other", "UNK", "ASKU" ], "type": "string", "description": "One of `\"Male\"`, `\"Female\"`, or `\"Other\"`", "title": "Gender" }, "default_pharmacy": { "type": "string", "description": "ncpdp id of patient's default pharmacy", "title": "Default pharmacy" }, "cell_phone": { "type": "string", "description": "", "title": "Cell phone" }, "employer_zip_code": { "type": "string", "description": "", "title": "Employer zip code" }, "workers_comp_insurance": { "title": "WorkerCompInsurance", "type": "object", "description": "", "properties": { "workers_comp_payer_city": { "type": "string", "description": "", "title": "Workers comp payer city" }, "workers_comp_payer_id": { "type": "string", "description": "", "title": "Workers comp payer id" }, "workers_comp_group_name": { "type": "string", "description": "", "title": "Workers comp group name" }, "workers_comp_wcb": { "type": "string", "description": "", "title": "Workers comp wcb" }, "workers_comp_carrier_code": { "type": "string", "description": "", "title": "Workers comp carrier code" }, "workers_comp_notes": { "type": "string", "description": "", "title": "Workers comp notes" }, "property_and_casualty_agency_claim_number": { "type": "string", "description": "", "title": "Property and casualty agency claim number" }, "workers_comp_state_of_occurrence": { "enum": [ "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" ], "type": "string", "description": "", "title": "Workers comp state of occurrence" }, "workers_comp_payer_zip": { "type": "string", "description": "", "title": "Workers comp payer zip" }, "workers_comp_wcb_rating_code": { "type": "string", "description": "", "title": "Workers comp wcb rating code" }, "workers_comp_case_number": { "type": "string", "description": "", "title": "Workers comp case number" }, "workers_comp_group_number": { "type": "string", "description": "", "title": "Workers comp group number" }, "workers_comp_company": { "type": "string", "description": "", "title": "Workers comp company" }, "workers_comp_payer_address": { "type": "string", "description": "", "title": "Workers comp payer address" }, "workers_comp_date_of_accident": { "type": "string", "description": "", "title": "Workers comp date of accident" }, "workers_comp_payer_state": { "enum": [ "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" ], "type": "string", "description": "", "title": "Workers comp payer state" } } } }, "x-verbose-required": [ "auto_accident_insurance", "custom_demographics", "patient_flags", "patient_flags_attached", "primary_insurance", "referring_doctor", "secondary_insurance", "tertiary_insurance", "workers_comp_insurance" ] }