Introduction
Mirah supports a variety of ways to customize the appearance of the platform to display more of a customer’s brand identity. This can help patients understand who is sending messages, and make patients more likely to engage with assessments that they know come from a trusted source.
Some of these can be set directly by you. Others require you to contact support.
In the examples throughout, we will be using “Test Hospital” as the example name.
Using Placeholders in Templates
Many of the settings below support placeholder substitution. This allows you to change the content dynamically to include things like the patient’s name, the respondent’s name, or the name of the unit/organization providing care.
For example:
Hi %{recipient_first_name}, %{client_facing_org_name} would like you to take an assessment for %{patient_possive} appointment on %{date}
Would look as follows when received by a patient called John:
Hi John, Test Hospital’s Outpatient Unit would like you to take an assessment for your appointment on 8/25
But when used instead to generate a notification for the Alice, the adult caregiver of a child named Ben in the IOP unit, would look like this:
Hi Alice, Test Hospital’s Child IOP Unit would like you to take an assessment for Ben’s appointment on 8/25
Supported Options
Option | Description | Requirements and Limitations | How to change |
Email Subject | Changes the subject line of assessment emails. The default value is “Assessment from Test Hospital” | None | Change the assessmentEmailSubject configuration value Contact support if you are uncomfortable doing this without assistance |
Email Sender | Changes the name and email address from which notifications are sent. By default, it is: “Mirah <noreply@mirah.com>”. | Changes to the name but not the domain (e.g. “Test Hospital Assessments” If you wish to change the domain to a different one, e.g. “help@testhospital.com”, you must also configure a Custom Mail Server below. | Change the assessmentSenderEmailAddress configuration value Contact support if you are uncomfortable doing this without assistance. |
*Email Body Text | Allows certain parts of the email body to be changed. | The text can include variables like the patient’s name - see Using Placeholders in templates below for details | For first time emails, change the welcomeAssessmentEmailContent configuration value. For ongoing assessments, change the ongoingAssessmentEmailContent configuration value. Contact support if you are uncomfortable doing this without assistance |
Custom Mail Server | If you wish to send emails from your own domain, you must give Mirah login information that allows us to send emails on your behalf. | We require the following details:
Server must have TLS Supported | Contact Support |
Customer Logo in Email | Image must be a transparent PNG | Contact Support |
Text Message
Option | Description | Requirements and Limitations | How to change |
Text Message Sender | Changes the number from which text messages | We support Twilio SMS. | Contact Support |
Text Message Content | Allows the content of the text message to be customized. | You may change the text for first time assessments, ongoing assessments, and reminders for uncompleted assessments. The message template supports placeholders | You may change the following configuration properties: welcomeAssessmentTextContent ongoingAssessmentTextContent reminderAssessmentTextContent |
*Note that at this time we do not support color or theme changes to emails. Some parts of the emails, for example the greeting, and signature etc, are not currently configurable. These include elements which ensure that if multiple emails for different participants are sent to the same address for multiple participants, it is clear which is for each.