Skip to main content
images/dr_chrono.svg

Parameters

Action
Parameters
{
  "$result_object_key": {
    "address": "123 Main Street",
    "auto_accident_insurance": {
      "auto_accident_case_number": "AAC-2024-001",
      "auto_accident_claim_rep_address": "123 Insurance Blvd",
      "auto_accident_claim_rep_city": "Los Angeles",
      "auto_accident_claim_rep_is_insurer": true,
      "auto_accident_claim_rep_name": "John Smith",
      "auto_accident_claim_rep_state": "CA",
      "auto_accident_claim_rep_zip": "90210",
      "auto_accident_company": "State Farm",
      "auto_accident_date_of_accident": "2024-01-10",
      "auto_accident_disabled_from_date": "2024-01-11",
      "auto_accident_disabled_to_date": "2024-02-11",
      "auto_accident_had_similar_condition": false,
      "auto_accident_is_subscriber_the_patient": true,
      "auto_accident_notes": "Rear-ended at intersection",
      "auto_accident_patient_relationship_to_subscriber": "01",
      "auto_accident_payer_address": "456 Payer St",
      "auto_accident_payer_city": "Chicago",
      "auto_accident_payer_id": "PAY123",
      "auto_accident_payer_state": "IL",
      "auto_accident_payer_zip": "60601",
      "auto_accident_policy_number": "POL-2024-12345",
      "auto_accident_return_to_work_date": "2024-03-01",
      "auto_accident_significant_injury": "YES",
      "auto_accident_significant_injury_notes": "Whiplash and back pain",
      "auto_accident_similar_condition_date": "2020-05-15",
      "auto_accident_similar_condition_notes": "Previous back injury",
      "auto_accident_state_of_occurrence": "CA",
      "auto_accident_still_under_care": true,
      "auto_accident_subscriber_address": "789 Main St",
      "auto_accident_subscriber_city": "San Francisco",
      "auto_accident_subscriber_date_of_birth": "1985-06-15",
      "auto_accident_subscriber_first_name": "Jane",
      "auto_accident_subscriber_last_name": "Doe",
      "auto_accident_subscriber_middle_name": "Marie",
      "auto_accident_subscriber_phone_number": "555-123-4567",
      "auto_accident_subscriber_social_security": "123-45-6789",
      "auto_accident_subscriber_state": "CA",
      "auto_accident_subscriber_suffix": "Jr",
      "auto_accident_subscriber_zip_code": "94102",
      "auto_accident_treatment_duration": "6 months",
      "auto_accident_will_require_therapy": true,
      "auto_accident_will_require_therapy_rec": "Physical therapy 2x weekly"
    },
    "cell_phone": "555-123-4567",
    "chart_id": "DOEJ001",
    "city": "San Francisco",
    "copay": "25.00",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_demographics": [
      {
        "field_type": 5,
        "updated_at": "2024-01-15T10:30:00Z",
        "value": "Custom value"
      }
    ],
    "date_of_birth": "1990-05-15",
    "date_of_death": "2024-12-01",
    "date_of_first_appointment": "2020-03-10",
    "date_of_last_appointment": "2024-01-05",
    "default_pharmacy": "1234567",
    "disable_sms_messages": false,
    "doctor": 12345,
    "email": "[email protected]",
    "emergency_contact_name": "Jane Doe",
    "emergency_contact_phone": "555-987-6543",
    "emergency_contact_relation": "Spouse",
    "employer": "Acme Corporation",
    "employer_address": "456 Corporate Blvd",
    "employer_city": "Los Angeles",
    "employer_state": "CA",
    "employer_zip_code": "90210",
    "ethnicity": "not_hispanic",
    "first_name": "John",
    "gender": "Male",
    "gender_identity_code": "446151000124109",
    "gender_identity_description": "Identifies as male",
    "home_phone": "555-111-2222",
    "id": "123456",
    "last_name": "Doe",
    "medication_history_consent": "Y",
    "middle_name": "Robert",
    "nick_name": "Johnny",
    "office_phone": "555-333-4444",
    "offices": [],
    "patient_flags": [
      {
        "archived": false,
        "color": "#FF0000",
        "created_at": "2024-01-15T10:30:00Z",
        "doctor": 12345,
        "flag_id": 1,
        "flag_text": "Requires wheelchair access",
        "flag_type": 2,
        "name": "High Priority",
        "priority": 1,
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ],
    "patient_flags_attached": [
      {
        "archived": false,
        "color": "#FF0000",
        "created_at": "2024-01-15T10:30:00Z",
        "doctor": 12345,
        "flag_id": 1,
        "flag_text": "Requires wheelchair access",
        "flag_type": 2,
        "name": "High Priority",
        "priority": 1,
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ],
    "patient_payment_profile": "Insurance",
    "patient_photo": "https://example.com/photo.jpg",
    "patient_photo_date": "2024-01-10",
    "patient_status": "A",
    "preferred_language": "eng",
    "preferred_language_code": "en",
    "preferred_language_description": "English",
    "preferred_pharmacies": [],
    "primary_care_physician": "Dr. Jane Smith",
    "primary_insurance": {
      "insurance_claim_office_number": "800-555-1234",
      "insurance_company": "Blue Cross Blue Shield",
      "insurance_group_name": "Employer Health Plan",
      "insurance_group_number": "GRP12345",
      "insurance_id_number": "XYZ123456789",
      "insurance_payer_id": "00123",
      "insurance_plan_name": "PPO Gold",
      "insurance_plan_type": "HM",
      "is_subscriber_the_patient": true,
      "patient_relationship_to_subscriber": "01",
      "photo_back": "https://example.com/card_back.jpg",
      "photo_front": "https://example.com/card_front.jpg",
      "subscriber_address": "123 Main St",
      "subscriber_city": "New York",
      "subscriber_country": "US",
      "subscriber_date_of_birth": "1980-05-20",
      "subscriber_first_name": "John",
      "subscriber_gender": "Male",
      "subscriber_last_name": "Doe",
      "subscriber_middle_name": "Robert",
      "subscriber_social_security": "123-45-6789",
      "subscriber_state": "NY",
      "subscriber_suffix": "Jr",
      "subscriber_zip_code": "10001"
    },
    "pronouns": "he/him",
    "race": "white",
    "race_subcategories": [
      {
        "code": "2028-9",
        "description": "Asian Indian"
      }
    ],
    "referring_doctor": {
      "address": "456 Medical Center Dr",
      "email": "[email protected]",
      "fax": "555-12-3456",
      "first_name": "Robert",
      "last_name": "Smith",
      "middle_name": "James",
      "npi": "1234567890",
      "phone": "555-98-7654",
      "provider_number": "PROV12345",
      "provider_qualifier": "0B",
      "specialty": "Cardiologist",
      "suffix": "MD"
    },
    "referring_source": "Website",
    "responsible_party_email": "[email protected]",
    "responsible_party_name": "Mary Doe",
    "responsible_party_phone": "555-555-5555",
    "responsible_party_relation": "Parent",
    "secondary_insurance": {
      "insurance_claim_office_number": "800-555-1234",
      "insurance_company": "Blue Cross Blue Shield",
      "insurance_group_name": "Employer Health Plan",
      "insurance_group_number": "GRP12345",
      "insurance_id_number": "XYZ123456789",
      "insurance_payer_id": "00123",
      "insurance_plan_name": "PPO Gold",
      "insurance_plan_type": "HM",
      "is_subscriber_the_patient": true,
      "patient_relationship_to_subscriber": "01",
      "photo_back": "https://example.com/card_back.jpg",
      "photo_front": "https://example.com/card_front.jpg",
      "subscriber_address": "123 Main St",
      "subscriber_city": "New York",
      "subscriber_country": "US",
      "subscriber_date_of_birth": "1980-05-20",
      "subscriber_first_name": "John",
      "subscriber_gender": "Male",
      "subscriber_last_name": "Doe",
      "subscriber_middle_name": "Robert",
      "subscriber_social_security": "123-45-6789",
      "subscriber_state": "NY",
      "subscriber_suffix": "Jr",
      "subscriber_zip_code": "10001"
    },
    "social_security_number": "123-45-6789",
    "state": "CA",
    "tertiary_insurance": {
      "insurance_claim_office_number": "800-555-1234",
      "insurance_company": "Blue Cross Blue Shield",
      "insurance_group_name": "Employer Health Plan",
      "insurance_group_number": "GRP12345",
      "insurance_id_number": "XYZ123456789",
      "insurance_payer_id": "00123",
      "insurance_plan_name": "PPO Gold",
      "insurance_plan_type": "HM",
      "is_subscriber_the_patient": true,
      "patient_relationship_to_subscriber": "01",
      "photo_back": "https://example.com/card_back.jpg",
      "photo_front": "https://example.com/card_front.jpg",
      "subscriber_address": "123 Main St",
      "subscriber_city": "New York",
      "subscriber_country": "US",
      "subscriber_date_of_birth": "1980-05-20",
      "subscriber_first_name": "John",
      "subscriber_gender": "Male",
      "subscriber_last_name": "Doe",
      "subscriber_middle_name": "Robert",
      "subscriber_social_security": "123-45-6789",
      "subscriber_state": "NY",
      "subscriber_suffix": "Jr",
      "subscriber_zip_code": "10001"
    },
    "updated_at": "2024-01-15T10:30:00Z",
    "workers_comp_insurance": {
      "property_and_casualty_agency_claim_number": "PCA-2024-001",
      "workers_comp_carrier_code": "WCC123",
      "workers_comp_case_number": "WC-2024-00123",
      "workers_comp_company": "Hartford",
      "workers_comp_date_of_accident": "2024-01-05",
      "workers_comp_group_name": "Industrial Workers",
      "workers_comp_group_number": "WCG456",
      "workers_comp_notes": "Injury occurred on job site",
      "workers_comp_payer_address": "100 Insurance Way",
      "workers_comp_payer_city": "Hartford",
      "workers_comp_payer_id": "WCPAY001",
      "workers_comp_payer_state": "CT",
      "workers_comp_payer_zip": "06103",
      "workers_comp_state_of_occurrence": "NY",
      "workers_comp_wcb": "WCB12345",
      "workers_comp_wcb_rating_code": "A1"
    },
    "zip_code": "94102"
  }
}
{
  "$result_object_key": {
    "address": "Patient address",
    "auto_accident_insurance": {
      "auto_accident_case_number": "Auto accident case number",
      "auto_accident_claim_rep_address": "Claim representative address",
      "auto_accident_claim_rep_city": "Claim representative city",
      "auto_accident_claim_rep_is_insurer": "Is the insurer's claim representative the insurer?",
      "auto_accident_claim_rep_name": "Claim representative name",
      "auto_accident_claim_rep_state": "Claim representative state",
      "auto_accident_claim_rep_zip": "Claim representative ZIP code",
      "auto_accident_company": "Auto accident insurance company",
      "auto_accident_date_of_accident": "Date of the auto accident",
      "auto_accident_disabled_from_date": "Patient was disabled (unable to work) from this date",
      "auto_accident_disabled_to_date": "Patient was disabled (unable to work) until this date",
      "auto_accident_had_similar_condition": "Has the patient had same or similar condition?",
      "auto_accident_is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
      "auto_accident_notes": "Notes about the auto accident",
      "auto_accident_patient_relationship_to_subscriber": "Patient's relationship to subscriber",
      "auto_accident_payer_address": "Auto accident payer address",
      "auto_accident_payer_city": "Auto accident payer city",
      "auto_accident_payer_id": "Auto Accident Payer ID",
      "auto_accident_payer_state": "Auto accident payer state",
      "auto_accident_payer_zip": "Auto accident payer ZIP code",
      "auto_accident_policy_number": "Auto accident policy number",
      "auto_accident_return_to_work_date": "If still disabled, patient should be able to return to work on this date",
      "auto_accident_significant_injury": "Whether there was a significant injury",
      "auto_accident_significant_injury_notes": "Notes about significant injury",
      "auto_accident_similar_condition_date": "Date of same or similar condition",
      "auto_accident_similar_condition_notes": "Notes about similar condition",
      "auto_accident_state_of_occurrence": "State where the auto accident occurred",
      "auto_accident_still_under_care": "Is patient still under your care for this condition?",
      "auto_accident_subscriber_address": "Subscriber address",
      "auto_accident_subscriber_city": "Subscriber city",
      "auto_accident_subscriber_date_of_birth": "Subscriber date of birth",
      "auto_accident_subscriber_first_name": "Subscriber first name",
      "auto_accident_subscriber_last_name": "Subscriber last name",
      "auto_accident_subscriber_middle_name": "Subscriber middle name",
      "auto_accident_subscriber_phone_number": "Subscriber phone number",
      "auto_accident_subscriber_social_security": "Subscriber social security number",
      "auto_accident_subscriber_state": "Subscriber state",
      "auto_accident_subscriber_suffix": "Subscriber suffix",
      "auto_accident_subscriber_zip_code": "Subscriber ZIP code",
      "auto_accident_treatment_duration": "Treatment duration",
      "auto_accident_will_require_therapy": "Will the patient require rehabilitation and/or occupational therapy?",
      "auto_accident_will_require_therapy_rec": "Therapy recommendation"
    },
    "cell_phone": "Patient cell phone number",
    "chart_id": "Chart ID (automatically set using first & last name if absent)",
    "city": "Patient city",
    "copay": "Patient copay amount",
    "created_at": "Timestamp when the patient was created",
    "custom_demographics": {
      "field_type": "ID of the custom demographics object",
      "updated_at": "Timestamp when the custom demographic was last updated",
      "value": "Value of the custom demographic"
    },
    "date_of_birth": "Patient date of birth",
    "date_of_death": "Patient date of death (available when show_inactive is passed)",
    "date_of_first_appointment": "Date of first patient visit",
    "date_of_last_appointment": "Date of previous patient visit",
    "default_pharmacy": "NCPDP ID of patient's default pharmacy",
    "disable_sms_messages": "If true, suppress SMS/Txt messages to this patient",
    "doctor": "Doctor ID",
    "email": "Patient email address",
    "emergency_contact_name": "Emergency contact name",
    "emergency_contact_phone": "Emergency contact phone number",
    "emergency_contact_relation": "Emergency contact relationship to patient",
    "employer": "Patient employer name",
    "employer_address": "Employer address",
    "employer_city": "Employer city",
    "employer_state": "Employer state (two-letter abbreviation)",
    "employer_zip_code": "Employer ZIP code",
    "ethnicity": "Patient ethnicity (blank, hispanic, not_hispanic, or declined)",
    "first_name": "Patient first name",
    "gender": "Patient gender (Male, Female, or Other)",
    "gender_identity_code": "Gender identity code",
    "gender_identity_description": "Gender identity description",
    "home_phone": "Patient home phone number",
    "id": "Patient ID",
    "last_name": "Patient last name",
    "medication_history_consent": "Medication history consent status",
    "middle_name": "Patient middle name",
    "nick_name": "Common name for patient (should be used instead of first name if supplied)",
    "office_phone": "Patient office phone number",
    "offices": "IDs of every office this patient has been to",
    "patient_flags": {
      "archived": "Whether the flag is archived",
      "color": "Color of the flag",
      "created_at": "Timestamp when the flag was created",
      "doctor": "ID of doctor who owns the flag",
      "flag_id": "Flag ID",
      "flag_text": "Description of the patient flag",
      "flag_type": "ID of the associated patient flag type",
      "name": "Name of the flag",
      "priority": "Priority level of the flag",
      "updated_at": "Timestamp when the flag was last updated"
    },
    "patient_flags_attached": {
      "archived": "Whether the flag is archived",
      "color": "Color of the flag",
      "created_at": "Timestamp when the flag was created",
      "doctor": "ID of doctor who owns the flag",
      "flag_id": "Flag ID",
      "flag_text": "Description of the patient flag",
      "flag_type": "ID of the associated patient flag type",
      "name": "Name of the flag",
      "priority": "Priority level of the flag",
      "updated_at": "Timestamp when the flag was last updated"
    },
    "patient_payment_profile": "Patient payment profile (Cash, Insurance, Insurance Out of Network, Auto Accident, or Worker's Comp)",
    "patient_photo": "Patient photo URL",
    "patient_photo_date": "Patient photo date (cannot be passed without patient_photo)",
    "patient_status": "Patient status: A (active), I (inactive), D (inactive-deceased)",
    "preferred_language": "Preferred language (ISO 639 alpha-3 codes)",
    "preferred_language_code": "Preferred language code",
    "preferred_language_description": "Preferred language description",
    "preferred_pharmacies": "NCPDP IDs of patient's preferred pharmacies",
    "primary_care_physician": "Referring doctor for this patient",
    "primary_insurance": {
      "insurance_claim_office_number": "Insurance office phone number",
      "insurance_company": "Insurance company name",
      "insurance_group_name": "Insurance group name",
      "insurance_group_number": "Insurance group number",
      "insurance_id_number": "Insurance ID number",
      "insurance_payer_id": "Insurance payer ID",
      "insurance_plan_name": "Name of insurance plan",
      "insurance_plan_type": "Type of insurance plan",
      "is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
      "patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
      "photo_back": "Photo of back of insurance card",
      "photo_front": "Photo of front of insurance card",
      "subscriber_address": "Subscriber address",
      "subscriber_city": "Subscriber city",
      "subscriber_country": "Two-letter country code",
      "subscriber_date_of_birth": "Subscriber date of birth",
      "subscriber_first_name": "Subscriber first name",
      "subscriber_gender": "Subscriber gender - Male or Female",
      "subscriber_last_name": "Subscriber last name",
      "subscriber_middle_name": "Subscriber middle name",
      "subscriber_social_security": "Subscriber social security number",
      "subscriber_state": "Two-letter state code",
      "subscriber_suffix": "Subscriber suffix (e.g. II or III)",
      "subscriber_zip_code": "Subscriber ZIP code"
    },
    "pronouns": "Patient pronouns",
    "race": "Patient race (blank, indian, asian, black, hawaiian, white, or declined)",
    "race_subcategories": {
      "code": "Race subcategory code",
      "description": "Race subcategory description"
    },
    "referring_doctor": {
      "address": "Referring doctor address",
      "email": "Referring doctor email",
      "fax": "Referring doctor fax (format: xxx-xx-xxxx)",
      "first_name": "Referring doctor first name",
      "last_name": "Referring doctor last name",
      "middle_name": "Referring doctor middle name",
      "npi": "Referring doctor NPI number",
      "phone": "Referring doctor phone (format: xxx-xx-xxxx)",
      "provider_number": "Provider number",
      "provider_qualifier": "Provider qualifier (State License #, Provider UPIN #, or Provider Commercial #)",
      "specialty": "Referring doctor specialty",
      "suffix": "Referring doctor suffix"
    },
    "referring_source": "Referring source",
    "responsible_party_email": "Responsible party email",
    "responsible_party_name": "Responsible party name",
    "responsible_party_phone": "Responsible party phone number",
    "responsible_party_relation": "Responsible party relationship to patient",
    "secondary_insurance": {
      "insurance_claim_office_number": "Insurance office phone number",
      "insurance_company": "Insurance company name",
      "insurance_group_name": "Insurance group name",
      "insurance_group_number": "Insurance group number",
      "insurance_id_number": "Insurance ID number",
      "insurance_payer_id": "Insurance payer ID",
      "insurance_plan_name": "Name of insurance plan",
      "insurance_plan_type": "Type of insurance plan",
      "is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
      "patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
      "photo_back": "Photo of back of insurance card",
      "photo_front": "Photo of front of insurance card",
      "subscriber_address": "Subscriber address",
      "subscriber_city": "Subscriber city",
      "subscriber_country": "Two-letter country code",
      "subscriber_date_of_birth": "Subscriber date of birth",
      "subscriber_first_name": "Subscriber first name",
      "subscriber_gender": "Subscriber gender - Male or Female",
      "subscriber_last_name": "Subscriber last name",
      "subscriber_middle_name": "Subscriber middle name",
      "subscriber_social_security": "Subscriber social security number",
      "subscriber_state": "Two-letter state code",
      "subscriber_suffix": "Subscriber suffix (e.g. II or III)",
      "subscriber_zip_code": "Subscriber ZIP code"
    },
    "social_security_number": "Patient social security number",
    "state": "Patient state (two-letter abbreviation)",
    "tertiary_insurance": {
      "insurance_claim_office_number": "Insurance office phone number",
      "insurance_company": "Insurance company name",
      "insurance_group_name": "Insurance group name",
      "insurance_group_number": "Insurance group number",
      "insurance_id_number": "Insurance ID number",
      "insurance_payer_id": "Insurance payer ID",
      "insurance_plan_name": "Name of insurance plan",
      "insurance_plan_type": "Type of insurance plan",
      "is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
      "patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
      "photo_back": "Photo of back of insurance card",
      "photo_front": "Photo of front of insurance card",
      "subscriber_address": "Subscriber address",
      "subscriber_city": "Subscriber city",
      "subscriber_country": "Two-letter country code",
      "subscriber_date_of_birth": "Subscriber date of birth",
      "subscriber_first_name": "Subscriber first name",
      "subscriber_gender": "Subscriber gender - Male or Female",
      "subscriber_last_name": "Subscriber last name",
      "subscriber_middle_name": "Subscriber middle name",
      "subscriber_social_security": "Subscriber social security number",
      "subscriber_state": "Two-letter state code",
      "subscriber_suffix": "Subscriber suffix (e.g. II or III)",
      "subscriber_zip_code": "Subscriber ZIP code"
    },
    "updated_at": "Timestamp when the patient was last updated",
    "workers_comp_insurance": {
      "property_and_casualty_agency_claim_number": "Property and casualty agency claim number",
      "workers_comp_carrier_code": "Workers comp carrier code",
      "workers_comp_case_number": "Workers comp case number",
      "workers_comp_company": "Workers comp insurance company",
      "workers_comp_date_of_accident": "Date of the workers comp accident",
      "workers_comp_group_name": "Workers comp group name",
      "workers_comp_group_number": "Workers comp group number",
      "workers_comp_notes": "Notes about the workers comp claim",
      "workers_comp_payer_address": "Workers comp payer address",
      "workers_comp_payer_city": "Workers comp payer city",
      "workers_comp_payer_id": "Workers comp payer ID",
      "workers_comp_payer_state": "Workers comp payer state",
      "workers_comp_payer_zip": "Workers comp payer ZIP code",
      "workers_comp_state_of_occurrence": "State where the workers comp accident occurred",
      "workers_comp_wcb": "Workers compensation board number",
      "workers_comp_wcb_rating_code": "Workers compensation board rating code"
    },
    "zip_code": "Patient ZIP code"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.
Patient
Fetch Action Response Object