Skip to main content

Email Variables Documentation

B
Written by Bhavik Tadigotla
Updated over a month ago

Using the email functionality within Brellium is a key part of maximizing your organization’s results. Customizable templates and scheduling options allow you to send emails at specific times, to specific providers, and for specific issues—helping you get the most out of your communication. This is achieved by breaking your audit set into subsets. Email variables help extract relevant information from these subsets for ease of use and greater efficiency.

Below is a list of common email variables along with brief explanations of each. To explore how these variables appear in practice, use the Preview Email feature within the app.

Scheduled Email Variables:

Audit Summary

  • audits.num

    Description: Total number of audits conducted for the provider.

  • audits.num_critical_error

    Description: Number of audits that had critical errors (has audit flag labeled as Critical Error).

Provider Information

  • provider.name

    Description: Full name of the provider (e.g., "Jane Doe").

  • provider.first_name

    Description: First name of the provider.

  • provider.last_name

    Description: Last name of the provider.

  • provider.email_display_name

    Description: Display name used in the provider's email. Note: This can be configured for any person's record, but this field is not widely used and defaults to the full name.

Audit Score Averages

  • aggregate.audit.score

    Description: Average audit score for this specific provider across all audited sessions.

  • overall.aggregate.audit.score

    Description: Average audit score across all providers in the organization.

Audit Results and Feedback

  • aggregate.audit.results

    Description: Full audit results for the provider, including session details, questions, answers, and scores.

  • Feedback List: This includes only audits with failed responses and considers feedback in the context of failed questions.

    • audit.question_answer_feedback_list

      Description: Questions and answers that received feedback, sorted by session date.

    • audit.question_answer_feedback_list_initials

      Description: Questions and answers that received feedback, sorted by client initials.

    • audit.question_answer_feedback_list_first_name

      Description: Questions and answers that received feedback, sorted by client’s first name.

    • audit.question_answer_feedback_list_initials_mm_dd_yyyy

      Description: Feedback list with client initials and session dates formatted as MM-DD-YYYY.

    • audit.question_answer_feedback_list_initials_dd_mm_yyyy

      Description: Feedback list with client initials and session dates formatted as DD-MM-YYYY.

    • audit.question_answer_feedback_list_initials_times

      Description: Feedback list with client initials and session start times.

    • audit.question_answer_feedback_list_client_id

      Description: Feedback list with client IDs.

    • audit.question_answer_feedback_question_set

      Description: Feedback organized by question set.

    Flagged Responses and Remediations
    In this case, "flagged" refers to meeting the email criteria.

    • audit.responses_with_remediations

      Description: List of flagged answers that include suggested remediations or corrections.

    • audit.responses_with_remediations_dates

      Description: List of flagged answers that include suggested remediations or corrections with session dates.

    • audit.responses_with_remediations_dates_initials

      Description: List of flagged answers that include suggested remediations or corrections with session dates and client initials.

    • audit.responses_with_remediations_dates_times_initials

      Description: List of flagged answers that include suggested remediations or corrections with session dates, start times, and client initials.

    • audit.responses_with_remediations_dates_client_id

      Description: List of flagged answers that include suggested remediations or corrections with session dates and client IDs.

    • audit.remediations_by_question_set

      Description: Flagged responses grouped by question set, summarizing remediations.

Audit Date Range Metadata

  • audit.start_date_month

    Description: Month (e.g., "May") when the audit window started.

  • audit.start_date_day

    Description: Day of the month when the audits started.

  • audit.end_date_month

    Description: Month when the audits ended.

  • audit.end_date_day

    Description: Day of the month when the audits ended.

  • audit.start_date

    Description: Full audit window start date (formatted as YYYY-MM-DD).

  • audit.end_date

    Description: Full audit window end date (formatted as YYYY-MM-DD).

Session Date Metadata

  • audit.earliest_session_date

    Description: The earliest session date included in the audit.

  • audit.earliest_session_date_mm_dd_yyyy

    Description: The earliest session date included in the audit, formatted as MM-DD-YYYY.

  • audit.earliest_session_date_dd_mm_yyyy

    Description: The earliest session date in the audit, formatted as DD-MM-YYYY.

  • audit.latest_session_date

    Description: The latest session date included in the audit.

  • audit.latest_session_date_mm_dd_yyyy

    Description: The latest session date in the audit, formatted as MM-DD-YYYY.

  • audit.latest_session_date_dd_mm_yyyy

    Description: The latest session date in the audit, formatted as DD-MM-YYYY.

Performance Highlights

  • audit.therapy_questions_ranked_top_three

    Description: The three highest-scoring questions in the given therapy set.

  • audit.therapy_questions_ranked_bottom_three

    Description: The three lowest-scoring questions in the given therapy set.

Instant Email Variables

There are also distinct variables available for instant emails, which generally follow the same structure as those used in scheduled emails. While instant emails function similarly to scheduled ones, the key difference is that they provide feedback on a specific audit, allowing providers to make necessary changes in a more timely manner. The variables are listed below:

  • provider.name

  • provider.first_name

  • provider.last_name

  • provider.email_display_name

  • audit.audit_date

  • audit.audit_date_mm_dd_yyyy

  • audit.audit_date_dd_mm_yyyy

  • audit.session_date

  • audit.session_date_mm_dd_yyyy

  • audit.session_date_dd_mm_yyyy

  • audit.session_time

  • audit.score

  • audit.responses_with_remediation

    The following variables use the same definition of “feedback” as outlined above in the Scheduled Email Variables section.

    • audit.question_answer_feedback_list

    • audit.question_answer_feedback_list_initials

    • audit.question_answer_feedback_list_first_name

    • audit.question_answer_feedback_list_initials_mm_dd_yyyy

    • audit.question_answer_feedback_list_initials_dd_mm_yyyy

    • audit.responses_with_remediations_dates_initials

  • reviewer.email

  • reviewer.display_name

  • bcba.name

  • bcba.first.name

  • client.initials

For help with using email variables or improving your email efficacy, please reach out to your Brellium account manager or [email protected].

Did this answer your question?