{
  "$result_object_key":  {
    "active":  true,
    "active_tags":  [
      "Weight Loss",
      "Diabetes"
    ],
    "changed_fields":  [
      "email_address",
      "first_name",
      "last_name"
    ],
    "client_readable_source":  "src",
    "client_source":  {
      "id":  "3265",
      "readable_source":  "John Doe MS, LMFT",
      "ref_source":  "12345",
      "ref_source_other":  "Instagram",
      "ref_type":  "referring_provider",
      "related_insurance_id":  "12345",
      "related_object_id":  "12345",
      "related_object_name":  "Other"
    },
    "course_memberships":  [
      {
        "course_id":  "54654",
        "course_name":  "Nutrition 101",
        "course_status":  "active",
        "started_at":  "2024-02-14T16:10:11+00:00",
        "updated_at":  "2024-03-01T17:12:18+00:00"
      }
    ],
    "date_of_birth":  "1950-08-04",
    "default_stripe_customer_detail_id":  "cus_123456",
    "diagnoses":  [
      {
        "active":  true,
        "end_date":  "2024-07-04",
        "first_symptom_date":  "2023-07-04",
        "icd_code":  {
          "code":  "F41.1",
          "display_name":  "Generalized anxiety disorder"
        }
      }
    ],
    "dietician_organization_id":  "5465412",
    "dietitian_email_address":  "drfleming@example.com",
    "dietitian_first_name":  "Alexander",
    "dietitian_id":  "100070",
    "dietitian_last_name":  "Fleming",
    "dietitian_organization_id":  "20042",
    "email_address":  "john.doe@example.com",
    "first_name":  "John",
    "gender":  "Male",
    "gender_identity":  "Male",
    "has_created_password":  true,
    "height_meters":  1.75,
    "id":  "131391",
    "insurance_authorization":  {
      "end_on":  "2024-09-01",
      "start_on":  "2024-02-12",
      "units_authorized":  "10",
      "units_left":  "5",
      "units_used":  "5",
      "visits_left":  "3"
    },
    "last_active":  "2024-07-04T09:39:18+00:00",
    "last_appt_date":  "2024-04-22T09:00:00-04:00",
    "last_appt_id":  "604820",
    "last_name":  "Doe",
    "legal_name":  "Test Patient",
    "location":  {
      "city":  "San Francisco",
      "country":  "USA",
      "line1":  "123 Main Street",
      "line2":  "Suite 100",
      "state":  "CA",
      "zip":  "94117"
    },
    "money_owed":  "100.00",
    "next_appt_date":  "2024-08-17T10:30:00-04:00",
    "next_appt_id":  "604821",
    "next_required_step":  "Complete onboarding",
    "notification_contacts":  [
      {
        "email_address":  "john.doe@example.com",
        "first_name":  "John",
        "id":  "212012",
        "is_emergency_contact":  true,
        "last_name":  "Doe",
        "phone_number":  "+15551234123",
        "relationship":  "Caregiver"
      }
    ],
    "other_provider_ids":  [
      "123456",
      "789012"
    ],
    "phone_number":  "+15551234123",
    "policies":  [
      {
        "benefits":  [
          {
            "coinsurance":  "15",
            "copay":  "50",
            "deductible_calendar_year":  "2000",
            "deductible_year_to_date":  "1500"
          }
        ],
        "effective_end":  "2024-07-04",
        "group_num":  "331256",
        "id":  "202402",
        "insurance_card_back_id":  "123452",
        "insurance_card_front_id":  "123451",
        "insurance_plan":  {
          "id":  "611231",
          "name_and_id":  "Blue Cross Blue Shield - 629913",
          "payer_id":  "629913",
          "payer_name":  "Blue Cross Blue Shield"
        },
        "insurance_type":  "Medicaid",
        "notes":  "Policy is active",
        "num":  "1912310",
        "patient_id":  "100121",
        "priority_type":  "Primary",
        "updated_at":  "2024-07-01T11:29:19+00:00"
      }
    ],
    "primary_ethnicity_code":  "2135-2",
    "primary_race":  "White",
    "primary_race_code":  "1002-5",
    "pronouns":  "He/Him",
    "providers":  [
      {
        "first_name":  "Brian",
        "id":  "720312",
        "last_name":  "Hippocrates",
        "name":  "Dr. Brian Hippocrates",
        "qualifications":  "MD"
      }
    ],
    "quick_notes":  "Patient is very motivated to get well",
    "record_identifier":  "8e11f3ba-3167-4f47-a549-f43dc19df353",
    "referring_physician_emails":  [
      "brian.hippocrates@example.com",
      "joseph.lister@example.com"
    ],
    "referring_physicians":  [
      {
        "business_name":  "Dr. John",
        "created_at":  "2024-05-10T08:46:04Z",
        "email":  "john.doe@example.com",
        "first_name":  "John",
        "full_name":  "John Doe",
        "id":  "57211",
        "last_name":  "Doe",
        "location":  {
          "city":  "San Francisco",
          "country":  "USA",
          "line1":  "123 Main Street",
          "line2":  "Suite 100",
          "state":  "CA",
          "zip":  "94117"
        },
        "phone_number":  "+15551234123"
      }
    ],
    "referring_provider_name":  "Fred Flintstone",
    "set_password_link":  "https://passwords.health.co/reset",
    "sex":  "Male",
    "sex_assigned_at_birth":  "Male",
    "sexual_orientation":  "Heterosexual",
    "timezone":  "America/Los_Angeles",
    "timing":  {
      "created_at":  "2022-07-01T00:01:00+00:00",
      "updated_at":  "2022-07-01T00:01:00+00:00"
    },
    "unconfirmed_appointment_count":  1,
    "user_group":  {
      "created_at":  "2024-07-01T11:29:19+00:00",
      "id":  "123012",
      "name":  "Intake"
    },
    "weight_kilograms":  75
  }
}
{
  "$result_object_key":  {
    "active":  "Whether the User is active",
    "active_tags":  "List of active tags for the User",
    "changed_fields":  "Healthie User object fields changed in triggering the event for this User (Patient)",
    "client_readable_source":  "Client readable source for the user",
    "client_source":  {
      "id":  "ID of the client source",
      "readable_source":  "Get readable source based on ref_type",
      "ref_source":  "The source of how a client was acquired: contain ID or a Other string",
      "ref_source_other":  "If ref_source eq 'Other', than it may contain custom string or NULL",
      "ref_type":  "The type of the source of how a client was acquired",
      "related_insurance_id":  "ID of the related insurance",
      "related_object_id":  "ID of the related object, or 'Other'",
      "related_object_name":  "Name of the related object"
    },
    "course_memberships":  {
      "course_id":  "ID of the course",
      "course_name":  "Name of the course",
      "course_status":  "Status of the course membership",
      "started_at":  "Time the course membership started",
      "updated_at":  "Time the course membership was last updated"
    },
    "date_of_birth":  "Date of birth of the User",
    "default_stripe_customer_detail_id":  "Default Stripe customer detail ID",
    "diagnoses":  {
      "active":  "Whether the diagnosis is currently active",
      "end_date":  "Date the diagnosis ended",
      "first_symptom_date":  "Date of first symptoms",
      "icd_code":  {
        "code":  "ICD code",
        "display_name":  "Display name for the ICD code"
      }
    },
    "dietician_organization_id":  "Organization ID for the user's registered dietitian",
    "dietitian_email_address":  "Email address of the User's registered dietitian",
    "dietitian_first_name":  "First name of the User's registered dietitian",
    "dietitian_id":  "ID of the User's registered dietitian",
    "dietitian_last_name":  "Last name of the User's registered dietitian",
    "dietitian_organization_id":  "Organization ID for the User's registered dietitian",
    "email_address":  "Email address of the User",
    "first_name":  "First name of the User",
    "gender":  "Gender",
    "gender_identity":  "Gender identity",
    "has_created_password":  "Whether the User has created a password",
    "height_meters":  "Height in meters",
    "id":  "ID for the User",
    "insurance_authorization":  {
      "end_on":  "The day that visits authorized by the insurance company have no effect",
      "start_on":  "The day that visits authorized by the insurance company take effect",
      "units_authorized":  "Number of units authorized",
      "units_left":  "Number of units left",
      "units_used":  "Number of units used",
      "visits_left":  "Number of visits left"
    },
    "last_active":  "Time the User was last active",
    "last_appt_date":  "The datetime of the last appointment the Patient had",
    "last_appt_id":  "The last scheduled appointment ID for this Patient (if specified)",
    "last_name":  "Last name of the User",
    "legal_name":  "Legal name of the Patient",
    "location":  {
      "city":  "City",
      "country":  "Country",
      "line1":  "First line of the address",
      "line2":  "Second line of the address",
      "state":  "State",
      "zip":  "Zip code"
    },
    "money_owed":  "Amount of money owed by the User",
    "next_appt_date":  "The timestamp of the next scheduled appointment for this Patient (if scheduled)",
    "next_appt_id":  "The next scheduled appointment ID for this Patient (if specified)",
    "next_required_step":  "Next required step for the User",
    "notification_contacts":  {
      "email_address":  "Email address of the notification contact",
      "first_name":  "First name of the notification contact",
      "id":  "ID for the notification contact",
      "is_emergency_contact":  "Whether the notification contact is an emergency contact",
      "last_name":  "Last name of the notification contact",
      "phone_number":  "Phone number of the notification contact",
      "relationship":  "Relationship between the notification contact and the user"
    },
    "other_provider_ids":  "List of other provider IDs associated with the User",
    "phone_number":  "Phone number of the User",
    "policies":  {
      "benefits":  {
        "coinsurance":  "Coinsurance percentage due",
        "copay":  "Copay amount due",
        "deductible_calendar_year":  "Deductible amount for the calendar year",
        "deductible_year_to_date":  "Deductible amount for the year to-date"
      },
      "effective_end":  "Date the policy coverage expires",
      "group_num":  "Group number",
      "id":  "ID for the policy",
      "insurance_card_back_id":  "ID of the insurance card back image object",
      "insurance_card_front_id":  "ID of the insurance card front image object",
      "insurance_plan":  {
        "id":  "ID of the insurance plan",
        "name_and_id":  "Name of the payer and id of payer",
        "payer_id":  "ID of the insurance payer",
        "payer_name":  "Name of the insurance payer"
      },
      "insurance_type":  "The type of insurance: `type_string`",
      "notes":  "Notes about the policy",
      "num":  "Policy number",
      "patient_id":  "ID of the patient associated with the policy",
      "priority_type":  "The priority type of insurance: `priority_type`",
      "updated_at":  "Last time the Policy was updated"
    },
    "primary_ethnicity_code":  "The primary ethnicity code for the Patient",
    "primary_race":  "Primary race",
    "primary_race_code":  "The primary race code for the Patient",
    "pronouns":  "Pronouns",
    "providers":  {
      "first_name":  "First name of the provider",
      "id":  "ID for the provider",
      "last_name":  "Last name of the provider",
      "name":  "Name of the provider",
      "qualifications":  "Qualifications of the provider"
    },
    "quick_notes":  "Quick notes about the user",
    "record_identifier":  "Record identifier for the User (external unique patient ID reference)",
    "referring_physician_emails":  "List of referring physician emails",
    "referring_physicians":  {
      "business_name":  "Provider's business name",
      "created_at":  "Provider's creation date",
      "email":  "Provider's email",
      "first_name":  "Provider's first name",
      "full_name":  "Provider's full name",
      "id":  "Provider ID",
      "last_name":  "Provider's last name",
      "location":  {
        "city":  "City",
        "country":  "Country",
        "line1":  "First line of the address",
        "line2":  "Second line of the address",
        "state":  "State",
        "zip":  "Zip code"
      },
      "phone_number":  "Provider's phone number"
    },
    "referring_provider_name":  "Name of the referring provider",
    "set_password_link":  "Password setup hyperlink",
    "sex":  "Sex",
    "sex_assigned_at_birth":  "Sex assigned at birth",
    "sexual_orientation":  "Sexual orientation",
    "timezone":  "Timezone registered for the User",
    "timing":  {
      "created_at":  "Time the object was created",
      "updated_at":  "Time the object was updated"
    },
    "unconfirmed_appointment_count":  "Number of unconfirmed appointments",
    "user_group":  {
      "created_at":  "When the User Group was created",
      "id":  "ID of the User Group",
      "name":  "Name of the User Group"
    },
    "weight_kilograms":  "Weight in kilograms"
  }
}

Parameters

Action
Parameters
ID
string
required

ID This field maps to the destination API id field.

{
  "$result_object_key":  {
    "active":  true,
    "active_tags":  [
      "Weight Loss",
      "Diabetes"
    ],
    "changed_fields":  [
      "email_address",
      "first_name",
      "last_name"
    ],
    "client_readable_source":  "src",
    "client_source":  {
      "id":  "3265",
      "readable_source":  "John Doe MS, LMFT",
      "ref_source":  "12345",
      "ref_source_other":  "Instagram",
      "ref_type":  "referring_provider",
      "related_insurance_id":  "12345",
      "related_object_id":  "12345",
      "related_object_name":  "Other"
    },
    "course_memberships":  [
      {
        "course_id":  "54654",
        "course_name":  "Nutrition 101",
        "course_status":  "active",
        "started_at":  "2024-02-14T16:10:11+00:00",
        "updated_at":  "2024-03-01T17:12:18+00:00"
      }
    ],
    "date_of_birth":  "1950-08-04",
    "default_stripe_customer_detail_id":  "cus_123456",
    "diagnoses":  [
      {
        "active":  true,
        "end_date":  "2024-07-04",
        "first_symptom_date":  "2023-07-04",
        "icd_code":  {
          "code":  "F41.1",
          "display_name":  "Generalized anxiety disorder"
        }
      }
    ],
    "dietician_organization_id":  "5465412",
    "dietitian_email_address":  "drfleming@example.com",
    "dietitian_first_name":  "Alexander",
    "dietitian_id":  "100070",
    "dietitian_last_name":  "Fleming",
    "dietitian_organization_id":  "20042",
    "email_address":  "john.doe@example.com",
    "first_name":  "John",
    "gender":  "Male",
    "gender_identity":  "Male",
    "has_created_password":  true,
    "height_meters":  1.75,
    "id":  "131391",
    "insurance_authorization":  {
      "end_on":  "2024-09-01",
      "start_on":  "2024-02-12",
      "units_authorized":  "10",
      "units_left":  "5",
      "units_used":  "5",
      "visits_left":  "3"
    },
    "last_active":  "2024-07-04T09:39:18+00:00",
    "last_appt_date":  "2024-04-22T09:00:00-04:00",
    "last_appt_id":  "604820",
    "last_name":  "Doe",
    "legal_name":  "Test Patient",
    "location":  {
      "city":  "San Francisco",
      "country":  "USA",
      "line1":  "123 Main Street",
      "line2":  "Suite 100",
      "state":  "CA",
      "zip":  "94117"
    },
    "money_owed":  "100.00",
    "next_appt_date":  "2024-08-17T10:30:00-04:00",
    "next_appt_id":  "604821",
    "next_required_step":  "Complete onboarding",
    "notification_contacts":  [
      {
        "email_address":  "john.doe@example.com",
        "first_name":  "John",
        "id":  "212012",
        "is_emergency_contact":  true,
        "last_name":  "Doe",
        "phone_number":  "+15551234123",
        "relationship":  "Caregiver"
      }
    ],
    "other_provider_ids":  [
      "123456",
      "789012"
    ],
    "phone_number":  "+15551234123",
    "policies":  [
      {
        "benefits":  [
          {
            "coinsurance":  "15",
            "copay":  "50",
            "deductible_calendar_year":  "2000",
            "deductible_year_to_date":  "1500"
          }
        ],
        "effective_end":  "2024-07-04",
        "group_num":  "331256",
        "id":  "202402",
        "insurance_card_back_id":  "123452",
        "insurance_card_front_id":  "123451",
        "insurance_plan":  {
          "id":  "611231",
          "name_and_id":  "Blue Cross Blue Shield - 629913",
          "payer_id":  "629913",
          "payer_name":  "Blue Cross Blue Shield"
        },
        "insurance_type":  "Medicaid",
        "notes":  "Policy is active",
        "num":  "1912310",
        "patient_id":  "100121",
        "priority_type":  "Primary",
        "updated_at":  "2024-07-01T11:29:19+00:00"
      }
    ],
    "primary_ethnicity_code":  "2135-2",
    "primary_race":  "White",
    "primary_race_code":  "1002-5",
    "pronouns":  "He/Him",
    "providers":  [
      {
        "first_name":  "Brian",
        "id":  "720312",
        "last_name":  "Hippocrates",
        "name":  "Dr. Brian Hippocrates",
        "qualifications":  "MD"
      }
    ],
    "quick_notes":  "Patient is very motivated to get well",
    "record_identifier":  "8e11f3ba-3167-4f47-a549-f43dc19df353",
    "referring_physician_emails":  [
      "brian.hippocrates@example.com",
      "joseph.lister@example.com"
    ],
    "referring_physicians":  [
      {
        "business_name":  "Dr. John",
        "created_at":  "2024-05-10T08:46:04Z",
        "email":  "john.doe@example.com",
        "first_name":  "John",
        "full_name":  "John Doe",
        "id":  "57211",
        "last_name":  "Doe",
        "location":  {
          "city":  "San Francisco",
          "country":  "USA",
          "line1":  "123 Main Street",
          "line2":  "Suite 100",
          "state":  "CA",
          "zip":  "94117"
        },
        "phone_number":  "+15551234123"
      }
    ],
    "referring_provider_name":  "Fred Flintstone",
    "set_password_link":  "https://passwords.health.co/reset",
    "sex":  "Male",
    "sex_assigned_at_birth":  "Male",
    "sexual_orientation":  "Heterosexual",
    "timezone":  "America/Los_Angeles",
    "timing":  {
      "created_at":  "2022-07-01T00:01:00+00:00",
      "updated_at":  "2022-07-01T00:01:00+00:00"
    },
    "unconfirmed_appointment_count":  1,
    "user_group":  {
      "created_at":  "2024-07-01T11:29:19+00:00",
      "id":  "123012",
      "name":  "Intake"
    },
    "weight_kilograms":  75
  }
}
{
  "$result_object_key":  {
    "active":  "Whether the User is active",
    "active_tags":  "List of active tags for the User",
    "changed_fields":  "Healthie User object fields changed in triggering the event for this User (Patient)",
    "client_readable_source":  "Client readable source for the user",
    "client_source":  {
      "id":  "ID of the client source",
      "readable_source":  "Get readable source based on ref_type",
      "ref_source":  "The source of how a client was acquired: contain ID or a Other string",
      "ref_source_other":  "If ref_source eq 'Other', than it may contain custom string or NULL",
      "ref_type":  "The type of the source of how a client was acquired",
      "related_insurance_id":  "ID of the related insurance",
      "related_object_id":  "ID of the related object, or 'Other'",
      "related_object_name":  "Name of the related object"
    },
    "course_memberships":  {
      "course_id":  "ID of the course",
      "course_name":  "Name of the course",
      "course_status":  "Status of the course membership",
      "started_at":  "Time the course membership started",
      "updated_at":  "Time the course membership was last updated"
    },
    "date_of_birth":  "Date of birth of the User",
    "default_stripe_customer_detail_id":  "Default Stripe customer detail ID",
    "diagnoses":  {
      "active":  "Whether the diagnosis is currently active",
      "end_date":  "Date the diagnosis ended",
      "first_symptom_date":  "Date of first symptoms",
      "icd_code":  {
        "code":  "ICD code",
        "display_name":  "Display name for the ICD code"
      }
    },
    "dietician_organization_id":  "Organization ID for the user's registered dietitian",
    "dietitian_email_address":  "Email address of the User's registered dietitian",
    "dietitian_first_name":  "First name of the User's registered dietitian",
    "dietitian_id":  "ID of the User's registered dietitian",
    "dietitian_last_name":  "Last name of the User's registered dietitian",
    "dietitian_organization_id":  "Organization ID for the User's registered dietitian",
    "email_address":  "Email address of the User",
    "first_name":  "First name of the User",
    "gender":  "Gender",
    "gender_identity":  "Gender identity",
    "has_created_password":  "Whether the User has created a password",
    "height_meters":  "Height in meters",
    "id":  "ID for the User",
    "insurance_authorization":  {
      "end_on":  "The day that visits authorized by the insurance company have no effect",
      "start_on":  "The day that visits authorized by the insurance company take effect",
      "units_authorized":  "Number of units authorized",
      "units_left":  "Number of units left",
      "units_used":  "Number of units used",
      "visits_left":  "Number of visits left"
    },
    "last_active":  "Time the User was last active",
    "last_appt_date":  "The datetime of the last appointment the Patient had",
    "last_appt_id":  "The last scheduled appointment ID for this Patient (if specified)",
    "last_name":  "Last name of the User",
    "legal_name":  "Legal name of the Patient",
    "location":  {
      "city":  "City",
      "country":  "Country",
      "line1":  "First line of the address",
      "line2":  "Second line of the address",
      "state":  "State",
      "zip":  "Zip code"
    },
    "money_owed":  "Amount of money owed by the User",
    "next_appt_date":  "The timestamp of the next scheduled appointment for this Patient (if scheduled)",
    "next_appt_id":  "The next scheduled appointment ID for this Patient (if specified)",
    "next_required_step":  "Next required step for the User",
    "notification_contacts":  {
      "email_address":  "Email address of the notification contact",
      "first_name":  "First name of the notification contact",
      "id":  "ID for the notification contact",
      "is_emergency_contact":  "Whether the notification contact is an emergency contact",
      "last_name":  "Last name of the notification contact",
      "phone_number":  "Phone number of the notification contact",
      "relationship":  "Relationship between the notification contact and the user"
    },
    "other_provider_ids":  "List of other provider IDs associated with the User",
    "phone_number":  "Phone number of the User",
    "policies":  {
      "benefits":  {
        "coinsurance":  "Coinsurance percentage due",
        "copay":  "Copay amount due",
        "deductible_calendar_year":  "Deductible amount for the calendar year",
        "deductible_year_to_date":  "Deductible amount for the year to-date"
      },
      "effective_end":  "Date the policy coverage expires",
      "group_num":  "Group number",
      "id":  "ID for the policy",
      "insurance_card_back_id":  "ID of the insurance card back image object",
      "insurance_card_front_id":  "ID of the insurance card front image object",
      "insurance_plan":  {
        "id":  "ID of the insurance plan",
        "name_and_id":  "Name of the payer and id of payer",
        "payer_id":  "ID of the insurance payer",
        "payer_name":  "Name of the insurance payer"
      },
      "insurance_type":  "The type of insurance: `type_string`",
      "notes":  "Notes about the policy",
      "num":  "Policy number",
      "patient_id":  "ID of the patient associated with the policy",
      "priority_type":  "The priority type of insurance: `priority_type`",
      "updated_at":  "Last time the Policy was updated"
    },
    "primary_ethnicity_code":  "The primary ethnicity code for the Patient",
    "primary_race":  "Primary race",
    "primary_race_code":  "The primary race code for the Patient",
    "pronouns":  "Pronouns",
    "providers":  {
      "first_name":  "First name of the provider",
      "id":  "ID for the provider",
      "last_name":  "Last name of the provider",
      "name":  "Name of the provider",
      "qualifications":  "Qualifications of the provider"
    },
    "quick_notes":  "Quick notes about the user",
    "record_identifier":  "Record identifier for the User (external unique patient ID reference)",
    "referring_physician_emails":  "List of referring physician emails",
    "referring_physicians":  {
      "business_name":  "Provider's business name",
      "created_at":  "Provider's creation date",
      "email":  "Provider's email",
      "first_name":  "Provider's first name",
      "full_name":  "Provider's full name",
      "id":  "Provider ID",
      "last_name":  "Provider's last name",
      "location":  {
        "city":  "City",
        "country":  "Country",
        "line1":  "First line of the address",
        "line2":  "Second line of the address",
        "state":  "State",
        "zip":  "Zip code"
      },
      "phone_number":  "Provider's phone number"
    },
    "referring_provider_name":  "Name of the referring provider",
    "set_password_link":  "Password setup hyperlink",
    "sex":  "Sex",
    "sex_assigned_at_birth":  "Sex assigned at birth",
    "sexual_orientation":  "Sexual orientation",
    "timezone":  "Timezone registered for the User",
    "timing":  {
      "created_at":  "Time the object was created",
      "updated_at":  "Time the object was updated"
    },
    "unconfirmed_appointment_count":  "Number of unconfirmed appointments",
    "user_group":  {
      "created_at":  "When the User Group was created",
      "id":  "ID of the User Group",
      "name":  "Name of the User Group"
    },
    "weight_kilograms":  "Weight in kilograms"
  }
}

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.

User
Fetch Action Response Object
id
string
required

ID ID for the User

CEL
$result_object_key.id
Example
"131391"
record_identifier
string

ID Record identifier for the User (external unique patient ID reference)

CEL
$result_object_key.record_identifier
Example
"8e11f3ba-3167-4f47-a549-f43dc19df353"
active
bool
required

Whether the User is active

CEL
$result_object_key.active
Example
true
first_name
string

PII First name of the User

CEL
$result_object_key.first_name
Example
"John"
last_name
string

PII Last name of the User

CEL
$result_object_key.last_name
Example
"Doe"
date_of_birth
values.v1.Date

PII Date of birth of the User

CEL
$result_object_key.date_of_birth
Example
"1950-08-04"
phone_number
string

PII Phone number of the User

CEL
$result_object_key.phone_number
Example
"+15551234123"
email_address
string

PII Email address of the User

CEL
$result_object_key.email_address
Example
"john.doe@example.com"
sex_assigned_at_birth
string

HI Sex assigned at birth

CEL
$result_object_key.sex_assigned_at_birth
Example
"Male"
gender
string

HI Gender

CEL
$result_object_key.gender
Example
"Male"
gender_identity
string

HI Gender identity

CEL
$result_object_key.gender_identity
Example
"Male"
pronouns
string

HI Pronouns

CEL
$result_object_key.pronouns
Example
"He/Him"
user_group
object

User Group details

CEL
$result_object_key.user_group
Example
{
"created_at":  "2024-07-01T11:29:19+00:00",
"id":  "123012",
"name":  "Intake"
}
user_group.id
string

ID of the User Group

CEL
$result_object_key.user_group.id
Example
"123012"
user_group.name
string

Name of the User Group

CEL
$result_object_key.user_group.name
Example
"Intake"
user_group.created_at
timing.v1.Timestamp

When the User Group was created

CEL
$result_object_key.user_group.created_at
Example
"2024-07-01T11:29:19+00:00"
policies
object
required

PII List of Policies associated with the User

CEL
$result_object_key.policies
Example
[
{
"benefits":  [
{
  "coinsurance":  "15",
  "copay":  "50",
  "deductible_calendar_year":  "2000",
  "deductible_year_to_date":  "1500"
}
],
"effective_end":  "2024-07-04",
"group_num":  "331256",
"id":  "202402",
"insurance_card_back_id":  "123452",
"insurance_card_front_id":  "123451",
"insurance_plan":  {
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
},
"insurance_type":  "Medicaid",
"notes":  "Policy is active",
"num":  "1912310",
"patient_id":  "100121",
"priority_type":  "Primary",
"updated_at":  "2024-07-01T11:29:19+00:00"
}
]
policies.map(x, x.insurance_plan)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.insurance_plan)
Example
[
{
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
}
]
policies.map(x, x.insurance_plan)
[]string
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.insurance_plan)
Example
[
{
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
}
]
policies.map(x, x.insurance_plan)
[]string
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.insurance_plan)
Example
[
{
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
}
]
policies.map(x, x.insurance_plan)
[]string
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.insurance_plan)
Example
[
{
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
}
]
policies.map(x, x.insurance_plan)
[]string
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.insurance_plan)
Example
[
{
"id":  "611231",
"name_and_id":  "Blue Cross Blue Shield - 629913",
"payer_id":  "629913",
"payer_name":  "Blue Cross Blue Shield"
}
]
policies.map(x, x.num)
[]string
required

PII Mapped array of: Policy number

CEL
$result_object_key.policies.map(x, x.num)
Example
[
"1912310"
]
policies.map(x, x.group_num)
[]string
required

Mapped array of: Group number

CEL
$result_object_key.policies.map(x, x.group_num)
Example
[
"331256"
]
policies.map(x, x.notes)
[]string
required

Mapped array of: Notes about the policy

CEL
$result_object_key.policies.map(x, x.notes)
Example
[
"Policy is active"
]
policies.map(x, x.effective_end)
[]values.v1.Date
required

Mapped array of: Date the policy coverage expires

CEL
$result_object_key.policies.map(x, x.effective_end)
Example
[
"2024-07-04"
]
policies.map(x, x.id)
[]string
required

Mapped array of: ID for the policy

CEL
$result_object_key.policies.map(x, x.id)
Example
[
"202402"
]
policies.map(x, x.patient_id)
[]string
required

ID PII Mapped array of: ID of the patient associated with the policy

CEL
$result_object_key.policies.map(x, x.patient_id)
Example
[
"100121"
]
policies.map(x, x.insurance_card_front_id)
[]string
required

HI ID PII Mapped array of: ID of the insurance card front image object

CEL
$result_object_key.policies.map(x, x.insurance_card_front_id)
Example
[
"123451"
]
policies.map(x, x.insurance_card_back_id)
[]string
required

HI ID PII Mapped array of: ID of the insurance card back image object

CEL
$result_object_key.policies.map(x, x.insurance_card_back_id)
Example
[
"123452"
]
policies.map(x, x.updated_at)
[]timing.v1.Timestamp
required

Mapped array of: Last time the Policy was updated

CEL
$result_object_key.policies.map(x, x.updated_at)
Example
[
"2024-07-01T11:29:19+00:00"
]
policies.map(x, x.insurance_type)
[]string
required

Mapped array of: The type of insurance: type_string

CEL
$result_object_key.policies.map(x, x.insurance_type)
Example
[
"Medicaid"
]
policies.map(x, x.priority_type)
[]string
required

Mapped array of: The priority type of insurance: priority_type

CEL
$result_object_key.policies.map(x, x.priority_type)
Example
[
"Primary"
]
policies.map(x, x.benefits)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.benefits)
Example
[
[
{
"coinsurance":  "15",
"copay":  "50",
"deductible_calendar_year":  "2000",
"deductible_year_to_date":  "1500"
}
]
]
policies.map(x, x.benefits)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.benefits)
Example
[
[
{
"coinsurance":  "15",
"copay":  "50",
"deductible_calendar_year":  "2000",
"deductible_year_to_date":  "1500"
}
]
]
policies.map(x, x.benefits)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.benefits)
Example
[
[
{
"coinsurance":  "15",
"copay":  "50",
"deductible_calendar_year":  "2000",
"deductible_year_to_date":  "1500"
}
]
]
policies.map(x, x.benefits)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.benefits)
Example
[
[
{
"coinsurance":  "15",
"copay":  "50",
"deductible_calendar_year":  "2000",
"deductible_year_to_date":  "1500"
}
]
]
policies.map(x, x.benefits)
[]bool
required

Mapped array of: Insurance plan details

CEL
$result_object_key.policies.map(x, x.benefits)
Example
[
[
{
"coinsurance":  "15",
"copay":  "50",
"deductible_calendar_year":  "2000",
"deductible_year_to_date":  "1500"
}
]
]
insurance_authorization
object

Insurance authorization details

CEL
$result_object_key.insurance_authorization
Example
{
"end_on":  "2024-09-01",
"start_on":  "2024-02-12",
"units_authorized":  "10",
"units_left":  "5",
"units_used":  "5",
"visits_left":  "3"
}
insurance_authorization.units_authorized
string

Number of units authorized

CEL
$result_object_key.insurance_authorization.units_authorized
Example
"10"
insurance_authorization.units_used
string

Number of units used

CEL
$result_object_key.insurance_authorization.units_used
Example
"5"
insurance_authorization.units_left
string

Number of units left

CEL
$result_object_key.insurance_authorization.units_left
Example
"5"
insurance_authorization.visits_left
string

Number of visits left

CEL
$result_object_key.insurance_authorization.visits_left
Example
"3"
insurance_authorization.start_on
values.v1.Date

The day that visits authorized by the insurance company take effect

CEL
$result_object_key.insurance_authorization.start_on
Example
"2024-02-12"
insurance_authorization.end_on
values.v1.Date

The day that visits authorized by the insurance company have no effect

CEL
$result_object_key.insurance_authorization.end_on
Example
"2024-09-01"
timezone
string

Timezone registered for the User

CEL
$result_object_key.timezone
Example
"America/Los_Angeles"
location
object

PII Location details

CEL
$result_object_key.location
Example
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
location.line1
string

First line of the address

CEL
$result_object_key.location.line1
Example
"123 Main Street"
location.line2
string

Second line of the address

CEL
$result_object_key.location.line2
Example
"Suite 100"
location.city
string

City

CEL
$result_object_key.location.city
Example
"San Francisco"
location.state
string

State

CEL
$result_object_key.location.state
Example
"CA"
location.zip
string

Zip code

CEL
$result_object_key.location.zip
Example
"94117"
location.country
string

Country

CEL
$result_object_key.location.country
Example
"USA"
timing
object
required

Create and update times

CEL
$result_object_key.timing
Example
{
"created_at":  "2022-07-01T00:01:00+00:00",
"updated_at":  "2022-07-01T00:01:00+00:00"
}
timing.created_at
timing.v1.Timestamp
required

Time the object was created

CEL
$result_object_key.timing.created_at
Example
"2022-07-01T00:01:00+00:00"
timing.updated_at
timing.v1.Timestamp
required

Time the object was updated

CEL
$result_object_key.timing.updated_at
Example
"2022-07-01T00:01:00+00:00"
default_stripe_customer_detail_id
string

PII Default Stripe customer detail ID

CEL
$result_object_key.default_stripe_customer_detail_id
Example
"cus_123456"
diagnoses
object
required

HI List of diagnoses associated with the User

CEL
$result_object_key.diagnoses
Example
[
{
"active":  true,
"end_date":  "2024-07-04",
"first_symptom_date":  "2023-07-04",
"icd_code":  {
"code":  "F41.1",
"display_name":  "Generalized anxiety disorder"
}
}
]
diagnoses.map(x, x.active)
[]bool
required

Mapped array of: Whether the diagnosis is currently active

CEL
$result_object_key.diagnoses.map(x, x.active)
Example
[
true
]
diagnoses.map(x, x.first_symptom_date)
[]values.v1.Date
required

Mapped array of: Date of first symptoms

CEL
$result_object_key.diagnoses.map(x, x.first_symptom_date)
Example
[
"2023-07-04"
]
diagnoses.map(x, x.end_date)
[]values.v1.Date
required

Mapped array of: Date the diagnosis ended

CEL
$result_object_key.diagnoses.map(x, x.end_date)
Example
[
"2024-07-04"
]
diagnoses.map(x, x.icd_code)
[]bool
required

Mapped array of: ICD code details

CEL
$result_object_key.diagnoses.map(x, x.icd_code)
Example
[
{
"code":  "F41.1",
"display_name":  "Generalized anxiety disorder"
}
]
diagnoses.map(x, x.icd_code)
[]string
required

Mapped array of: ICD code details

CEL
$result_object_key.diagnoses.map(x, x.icd_code)
Example
[
{
"code":  "F41.1",
"display_name":  "Generalized anxiety disorder"
}
]
diagnoses.map(x, x.icd_code)
[]string
required

Mapped array of: ICD code details

CEL
$result_object_key.diagnoses.map(x, x.icd_code)
Example
[
{
"code":  "F41.1",
"display_name":  "Generalized anxiety disorder"
}
]
has_created_password
bool
required

Whether the User has created a password

CEL
$result_object_key.has_created_password
Example
true
last_active
timing.v1.Timestamp

Time the User was last active

CEL
$result_object_key.last_active
Example
"2024-07-04T09:39:18+00:00"
money_owed
string

Amount of money owed by the User

CEL
$result_object_key.money_owed
Example
"100.00"
next_required_step
string

Next required step for the User

CEL
$result_object_key.next_required_step
Example
"Complete onboarding"
client_readable_source
string

Client readable source for the user

CEL
$result_object_key.client_readable_source
Example
"src"
referring_physician_emails
[]string
required

List of referring physician emails

CEL
$result_object_key.referring_physician_emails
Example
[
"brian.hippocrates@example.com",
"joseph.lister@example.com"
]
referring_provider_name
string

Name of the referring provider

CEL
$result_object_key.referring_provider_name
Example
"Fred Flintstone"
unconfirmed_appointment_count
uint64

Number of unconfirmed appointments

CEL
$result_object_key.unconfirmed_appointment_count
Example
1
dietician_organization_id
string

Organization ID for the user’s registered dietitian

CEL
$result_object_key.dietician_organization_id
Example
"5465412"
height_meters
float64 (double)

Height in meters

CEL
$result_object_key.height_meters
Example
1.75
weight_kilograms
float64 (double)

Weight in kilograms

CEL
$result_object_key.weight_kilograms
Example
75
quick_notes
string

Quick notes about the user

CEL
$result_object_key.quick_notes
Example
"Patient is very motivated to get well"
notification_contacts
object
required

PII List of notification contacts for the user

CEL
$result_object_key.notification_contacts
Example
[
{
"email_address":  "john.doe@example.com",
"first_name":  "John",
"id":  "212012",
"is_emergency_contact":  true,
"last_name":  "Doe",
"phone_number":  "+15551234123",
"relationship":  "Caregiver"
}
]
notification_contacts.map(x, x.id)
[]string
required

Mapped array of: ID for the notification contact

CEL
$result_object_key.notification_contacts.map(x, x.id)
Example
[
"212012"
]
notification_contacts.map(x, x.first_name)
[]string
required

Mapped array of: First name of the notification contact

CEL
$result_object_key.notification_contacts.map(x, x.first_name)
Example
[
"John"
]
notification_contacts.map(x, x.last_name)
[]string
required

Mapped array of: Last name of the notification contact

CEL
$result_object_key.notification_contacts.map(x, x.last_name)
Example
[
"Doe"
]
notification_contacts.map(x, x.email_address)
[]string
required

PII Mapped array of: Email address of the notification contact

CEL
$result_object_key.notification_contacts.map(x, x.email_address)
Example
[
"john.doe@example.com"
]
notification_contacts.map(x, x.is_emergency_contact)
[]bool
required

Mapped array of: Whether the notification contact is an emergency contact

CEL
$result_object_key.notification_contacts.map(x, x.is_emergency_contact)
Example
[
true
]
notification_contacts.map(x, x.phone_number)
[]string
required

PII Mapped array of: Phone number of the notification contact

CEL
$result_object_key.notification_contacts.map(x, x.phone_number)
Example
[
"+15551234123"
]
notification_contacts.map(x, x.relationship)
[]string
required

Mapped array of: Relationship between the notification contact and the user

CEL
$result_object_key.notification_contacts.map(x, x.relationship)
Example
[
"Caregiver"
]
dietitian_organization_id
string

Organization ID for the User’s registered dietitian

CEL
$result_object_key.dietitian_organization_id
Example
"20042"
dietitian_first_name
string

First name of the User’s registered dietitian

CEL
$result_object_key.dietitian_first_name
Example
"Alexander"
dietitian_last_name
string

Last name of the User’s registered dietitian

CEL
$result_object_key.dietitian_last_name
Example
"Fleming"
dietitian_email_address
string

Email address of the User’s registered dietitian

CEL
$result_object_key.dietitian_email_address
Example
"drfleming@example.com"
dietitian_id
string

ID of the User’s registered dietitian

CEL
$result_object_key.dietitian_id
Example
"100070"
sex
string

Sex

CEL
$result_object_key.sex
Example
"Male"
sexual_orientation
string

Sexual orientation

CEL
$result_object_key.sexual_orientation
Example
"Heterosexual"
primary_race
string

Primary race

CEL
$result_object_key.primary_race
Example
"White"
active_tags
[]string
required

List of active tags for the User

CEL
$result_object_key.active_tags
Example
[
"Weight Loss",
"Diabetes"
]
other_provider_ids
[]string
required

List of other provider IDs associated with the User

CEL
$result_object_key.other_provider_ids
Example
[
"123456",
"789012"
]
providers
object
required

List of providers associated with the user

CEL
$result_object_key.providers
Example
[
{
"first_name":  "Brian",
"id":  "720312",
"last_name":  "Hippocrates",
"name":  "Dr. Brian Hippocrates",
"qualifications":  "MD"
}
]
providers.map(x, x.id)
[]string
required

Mapped array of: ID for the provider

CEL
$result_object_key.providers.map(x, x.id)
Example
[
"720312"
]
providers.map(x, x.name)
[]string
required

Mapped array of: Name of the provider

CEL
$result_object_key.providers.map(x, x.name)
Example
[
"Dr. Brian Hippocrates"
]
providers.map(x, x.qualifications)
[]string
required

Mapped array of: Qualifications of the provider

CEL
$result_object_key.providers.map(x, x.qualifications)
Example
[
"MD"
]
providers.map(x, x.first_name)
[]string
required

Mapped array of: First name of the provider

CEL
$result_object_key.providers.map(x, x.first_name)
Example
[
"Brian"
]
providers.map(x, x.last_name)
[]string
required

Mapped array of: Last name of the provider

CEL
$result_object_key.providers.map(x, x.last_name)
Example
[
"Hippocrates"
]
course_memberships
object
required

List of course memberships for the User

CEL
$result_object_key.course_memberships
Example
[
{
"course_id":  "54654",
"course_name":  "Nutrition 101",
"course_status":  "active",
"started_at":  "2024-02-14T16:10:11+00:00",
"updated_at":  "2024-03-01T17:12:18+00:00"
}
]
course_memberships.map(x, x.course_id)
[]string
required

Mapped array of: ID of the course

CEL
$result_object_key.course_memberships.map(x, x.course_id)
Example
[
"54654"
]
course_memberships.map(x, x.course_name)
[]string
required

Mapped array of: Name of the course

CEL
$result_object_key.course_memberships.map(x, x.course_name)
Example
[
"Nutrition 101"
]
course_memberships.map(x, x.course_status)
[]string
required

Mapped array of: Status of the course membership

CEL
$result_object_key.course_memberships.map(x, x.course_status)
Example
[
"active"
]
course_memberships.map(x, x.started_at)
[]timing.v1.Timestamp
required

Mapped array of: Time the course membership started

CEL
$result_object_key.course_memberships.map(x, x.started_at)
Example
[
"2024-02-14T16:10:11+00:00"
]
course_memberships.map(x, x.updated_at)
[]timing.v1.Timestamp
required

Mapped array of: Time the course membership was last updated

CEL
$result_object_key.course_memberships.map(x, x.updated_at)
Example
[
"2024-03-01T17:12:18+00:00"
]
next_appt_date
timing.v1.Timestamp

The timestamp of the next scheduled appointment for this Patient (if scheduled)

CEL
$result_object_key.next_appt_date
Example
"2024-08-17T10:30:00-04:00"
primary_race_code
string

The primary race code for the Patient

CEL
$result_object_key.primary_race_code
Example
"1002-5"
primary_ethnicity_code
string

The primary ethnicity code for the Patient

CEL
$result_object_key.primary_ethnicity_code
Example
"2135-2"
last_appt_date
timing.v1.Timestamp

The datetime of the last appointment the Patient had

CEL
$result_object_key.last_appt_date
Example
"2024-04-22T09:00:00-04:00"
client_source
object

Client source

CEL
$result_object_key.client_source
Example
{
"id":  "3265",
"readable_source":  "John Doe MS, LMFT",
"ref_source":  "12345",
"ref_source_other":  "Instagram",
"ref_type":  "referring_provider",
"related_insurance_id":  "12345",
"related_object_id":  "12345",
"related_object_name":  "Other"
}
client_source.id
string

ID of the client source

CEL
$result_object_key.client_source.id
Example
"3265"
client_source.readable_source
string

Get readable source based on ref_type

CEL
$result_object_key.client_source.readable_source
Example
"John Doe MS, LMFT"
client_source.ref_source
string

The source of how a client was acquired: contain ID or a Other string

CEL
$result_object_key.client_source.ref_source
Example
"12345"
client_source.ref_source_other
string

If ref_source eq ‘Other’, than it may contain custom string or NULL

CEL
$result_object_key.client_source.ref_source_other
Example
"Instagram"
client_source.ref_type
string

The type of the source of how a client was acquired

CEL
$result_object_key.client_source.ref_type
Example
"referring_provider"

ID of the related insurance

CEL
$result_object_key.client_source.related_insurance_id
Example
"12345"

ID of the related object, or ‘Other’

CEL
$result_object_key.client_source.related_object_id
Example
"12345"

Name of the related object

CEL
$result_object_key.client_source.related_object_name
Example
"Other"
referring_physicians
object
required

List of referring physicians (providers)

CEL
$result_object_key.referring_physicians
Example
[
{
"business_name":  "Dr. John",
"created_at":  "2024-05-10T08:46:04Z",
"email":  "john.doe@example.com",
"first_name":  "John",
"full_name":  "John Doe",
"id":  "57211",
"last_name":  "Doe",
"location":  {
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
},
"phone_number":  "+15551234123"
}
]
referring_physicians.map(x, x.id)
[]string
required

Mapped array of: Provider ID

CEL
$result_object_key.referring_physicians.map(x, x.id)
Example
[
"57211"
]
referring_physicians.map(x, x.first_name)
[]string
required

PII Mapped array of: Provider’s first name

CEL
$result_object_key.referring_physicians.map(x, x.first_name)
Example
[
"John"
]
referring_physicians.map(x, x.last_name)
[]string
required

PII Mapped array of: Provider’s last name

CEL
$result_object_key.referring_physicians.map(x, x.last_name)
Example
[
"Doe"
]
referring_physicians.map(x, x.location)
[]bool
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.location)
[]string
required

PII Mapped array of: Provider’s location

CEL
$result_object_key.referring_physicians.map(x, x.location)
Example
[
{
"city":  "San Francisco",
"country":  "USA",
"line1":  "123 Main Street",
"line2":  "Suite 100",
"state":  "CA",
"zip":  "94117"
}
]
referring_physicians.map(x, x.created_at)
[]timing.v1.Timestamp
required

Mapped array of: Provider’s creation date

CEL
$result_object_key.referring_physicians.map(x, x.created_at)
Example
[
"2024-05-10T08:46:04Z"
]
referring_physicians.map(x, x.business_name)
[]string
required

PII Mapped array of: Provider’s business name

CEL
$result_object_key.referring_physicians.map(x, x.business_name)
Example
[
"Dr. John"
]
referring_physicians.map(x, x.phone_number)
[]string
required

PII Mapped array of: Provider’s phone number

CEL
$result_object_key.referring_physicians.map(x, x.phone_number)
Example
[
"+15551234123"
]
referring_physicians.map(x, x.email)
[]string
required

PII Mapped array of: Provider’s email

CEL
$result_object_key.referring_physicians.map(x, x.email)
Example
[
"john.doe@example.com"
]
referring_physicians.map(x, x.full_name)
[]string
required

PII Mapped array of: Provider’s full name

CEL
$result_object_key.referring_physicians.map(x, x.full_name)
Example
[
"John Doe"
]

Password setup hyperlink

CEL
$result_object_key.set_password_link
Example
"https://passwords.health.co/reset"
next_appt_id
string

The next scheduled appointment ID for this Patient (if specified)

CEL
$result_object_key.next_appt_id
Example
"604821"
last_appt_id
string

The last scheduled appointment ID for this Patient (if specified)

CEL
$result_object_key.last_appt_id
Example
"604820"

PII Legal name of the Patient

CEL
$result_object_key.legal_name
Example
"Test Patient"
changed_fields
[]string
required

Healthie User object fields changed in triggering the event for this User (Patient)

CEL
$result_object_key.changed_fields
Example
[
"email_address",
"first_name",
"last_name"
]