Mosio %Tags%: Trigger Mosio Automations from REDCap
FollowVIDEO:
With Mosio Tags REDCap users are able to configure Mosio Storylines and/or Appointment Reminders, triggered from REDCap Alerts and Notifications. This is an advanced feature and requires a Mosio Basic or Plus Plan.
Overview
Mosio %tags% allow you to trigger storylines and appointment reminders using your REDCap alerts. This allows for a more efficient and automated way to pass information from REDCap to Mosio.
There are 3 available actions:
- Add a participant to a Storyline
- Setup an Appointment Reminder for a participant
- Set a participant variable in Mosio. These variables can be referenced in text messages.
These tags should be placed in a REDCap alert or ASI. REDCap will send them as a text message to Mosio, where the system will process the tag and remove it from the message. Any leftover text will send to the participant as a text message. A special %no-text% tag can be included to suppress the text to the participant.
%storyline% Tag
To add a subject to a storyline, to modify their start date within that storyline, or to remove them from the storyline, use this format:
Format:
%storyline:id:start_date%
Example: %storyline:12345:2025-02-05% Add ppt to storyline 12345 with start of 5-Feb-2025
Example: %storyline:12345:today% Add ppt to storyline 12345 with start date of today
Example: %storyline:12345:remove% Remove ppt from storyline 12345
storyline - Start this tag with the keyword "storyline"
id - This is the storyline ID, found at the top of the storyline page. Click the storyline you want from the main nav, and on the page that loads you will see the ID next to the storyline name.
start_date (yyyy-mm-dd) - This is the participant's starting date in the storyline (i.e. Day 0). If the participant is already in the storyline, and this date changes, their start date will be updated to match. The best format for this date is yyyy-mm-dd. Other formats are supported, but please test that they work as expected - occasionally dates are interpreted using the European style of day-month-year, though the system tries to avoid this.
You can also use relative dates such as "today", "tomorrow", "yesterday", "last monday", "next monday", etc. Be sure these do not happen on recurring alerts, otherwise the start date will be updated on the Storyline with each alert.
To remove a participant from a storyline, specify "remove" as the date. Ex: %storyline:12345:remove%. This is useful if a participant opts out, or is lost to follow up.
%appointment% Tag
To add an appointment reminder for a participant, or update an existing appointment reminder, use this format:
Format:
%appointment#:id:appt_date_time%
Example: %appointment1:54321:2025-02-05 10:00% Add reminder with appt time of 5-Feb-2025 10am
Example: %appointment2:54321:2025-02-12 14:00% A second reminder appt time of 12-Feb-2025 2pm
Example: %appointment1:54321:remove% Remove first appt reminder
appointment# - Multiple appointments are supported, so you must assign a number to the appointment keyword.
id - This is the appointment reminder ID, found at the top of the appointment reminder page. Click the appointment reminder you want from the main nav, and on the page that loads you will see the ID next to the appointment reminder name.
appt_date_time (yyyy-mm-dd hh:mm) - This is the date and time of the appointment reminder. The best format for this date and time is yyyy-mm-dd hh:mm. Other formats are supported, but please test to make sure they work as expected.
To remove an appointment reminder from a participant, specify "remove" as the date. Dates in the past will also cause the appointment reminder to be removed.
%set% Tag
To save a participant variable in Mosio, with a value that can be referenced later in messages or survey branching expressions:
Format:
%set:name:value%
Example: %set:reminder_msg:Remember that thing!% Sets %reminder_msg%
Example: %set:reminder_msg:% Clears %reminder_msg%
set - Start this tag with the keyword "set"
name - This is the name of the variable in Mosio that is being set. Names should start with a letter, and contain only letters, numbers, and underscore ( _ ). Some system values may not be allowed. You can view and define variables in Mosio by clicking on the Tools > Project Variables menu in the main nav.
value - This should contain plain text. Other values such as emojis may not be supported. Specify an empty string to clear the value.
%no-text% Tag
Format:
%no-text%
This tag specifies that the alert being sent to Mosio is an action-only alert, and no text message should send to the participant.
Once processed, Mosio %tags% are removed from the message. Adding the %no-text% tag guarantees that no text will send to the participant.
_________________________________________________________________________________________________________
SLIDES
______________________________________________________________________________
TRANSCRIPT:
Alright. So this is the Mosio tags feature. This is an advanced feature within Mosio and REDCap. The prerequisites are that you need an understanding of REDCap alerts and notifications, you need an understanding of Mosio storylines and appointment reminders, and this can also this is can be done with a basic or a plus plan.
So Mosio tags, what are they? They enable you to configure texting automation functions such as story lines and appointment reminders, and then you can trigger those from inside of REDCap. So this enhancement allows for more efficient data flow and automation to happen between REDCap and Mosio. Effectively, what you're doing is you're configuring these functions or these appoint reminders inside of Mosio, and then you're triggering them from inside of REDCap. So it simplifies the process and makes it easier for REDCap users to manage and organize data through text messaging.
So the first use case, storyline enrollment.
In this case, we have two groups. We've got a control group and an intervention group, which would require two storylines and two alerts in REDCap. In the first one, you're seeing that it's looking for a subject enrollment is is saved and has a status of group one. So that's the control group.
Over here on the right, you'll see that where it says no text. What that means is that there's no text. There's no message being sent to the subject. It's just letting Mosio know that this function is simply enrolling them into a storyline.
On the right, that right arrow, you can see it's showing the storyline ID and then the start date for that particular subject. Now down below in the intervention, you'll see that the group equals two. So that means it's an intervention group or that subject's in the intervention group. You'll see the no text symbol there, code there, and then also the different storyline ID with their start date there.
So additional functionality regarding story line enrollment, it shows you the format here. And those functions are allows you to add users to story lines or update a start date. The start date actually can be piped in from Redcap.
And we also support the removal of a storyline using the the word remove inside of those Mosio tags.
So now, appointment reminders. So once appoint an appointment reminder or appointment reminders have been configured inside of Mosio, subjects can then be enrolled via a REDCap alert. So the typically, you'll have your appointment day and time stored inside of Redcap, whether that's an in office visit for Zoom, you are sending a Zoom link or a phone call. And then with the Mosio tag, you can use an alert to add the appointment data to a Mosio appointment reminder.
So here in the example, we see that no text code there, which will tell Mosio do not send a message to the subject. And then we have not only the appointment ID, which is that one four seven six zero seven number, but you can have different appointment numbers. So you can have appointment one, two, three. If you have sequential appointment, appointments with that subject, then you can enroll them into multiple appointments through those numbers.
And then you have the appointment date as part of the tag as well.
So the Mosio tag, more specific information. Here's the format, the functions that we have. We're able to create new appointments and update existing appointments. And we're also able to support multiple appointments with different appointment numbers as we just mentioned in the last slide.
So those are Mosio tags in a nutshell for Storyline enrollment and appointment reminders. We do update the system based on feedback from our users. So we expect to see Mosio tags used in a in in new ways. And if you have any suggestions for us, then just let us know.