Schema for storing reminder settings which include schedules.
No Additional PropertiesThe timezone for the reminder schedule. Defaults to clinic timezone (or UTC if that is not set).
Must be at least 1 characters long
Describes the reminder schedule, triggers, actions, etc.
No Additional PropertiesThe action to take when reminder is triggered. Actions are implemented in cleo/types/reminder/actions.py.
The type of reminder action. This is a fixed set.
Trigger if metadata-entries matches the condition
Schema for storing filter settings.
No Additional PropertiesThe type of this element.
Specific value:"expression"
Expression of filter.
No Additional PropertiesOperator of expressions.
The type of this element.
The type of this element.
Specific value:"at_least"
An operator that filters any data where at least N of the conditions are true
Number of data where condition is true.
Value must be greater or equal to 1
Expressions of data
No Additional ItemsThe type of this element.
Specific value:"condition"
The type of this element.
Specific value:"Q"
Django ORM query
No Additional PropertiesMust be at least 1 characters long
Must be at least 1 characters long
Value must be greater or equal to 0
Must contain a minimum of 1 items
Method to validate if filter fullfill condition.
Number of expected metadata entries.
Value must be greater or equal to 1
Trigger if metadata-entries matches the condition
Method to validate if filter fullfill condition.
Number of expected metadata entries.
Value must be greater or equal to 1
This action sends a template message to the patient-form.
No Additional PropertiesTemplate set purpose to send. If purpose is REMINDER, there are additional logic involved.
Must be at least 1 characters long
Template set name or uid. This should align with purpose.
Must be at least 1 characters long
This action sends a reminder message to the patient-form.
This action discharges a patient-form.
This action enroll patient into new monitoring form.
No Additional PropertiesMonitoring formset where patient will be enroll into.
Must be at least 1 characters long
This action discharges a patient-program.
This action enroll patient into new clinic program.
No Additional PropertiesClinic program where patient will be enroll into.
Must be at least 1 characters long
This action discharges a patient-program and enroll patient into a new clinic program.
No Additional PropertiesClinic program where patient will be enroll into after discharge from existing patient-program.
Must be at least 1 characters long
This action does nothing except display a debug log message.
Describes how this reminder can be triggered. This usually refers to a pre-determined event. If unspecified, we assume the reminder starts immediately.
No Additional PropertiesThe event that will trigger a reminder. This is a hardcoded set of values.
Amount of time before/after the triggering event. This is expressed as an integer multiple of unit. Defaults to 0.
Value must be greater or equal to 0
The unit of measurement for duration.
The time of the day to recur the event at. This field should not be set when unit is minute or hour.
By default, the event will occur exactly duration x unit after the trigger event.
This is useful for overriding the time of the day such as 08:00 instead of some arbitrary time.
^(?P<hour>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24):(?P<minute>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|56|57|58|59)$
Clinical parameter that is datetime type to be used as the trigger.
Clinical parameter that is datetime type to be used as the trigger.
Trigger if metadata-entries matches the condition
Method to validate if filter fullfill condition.
Number of expected metadata entries.
Value must be greater or equal to 1
Date time for Exact event to execute.
True if the reminder is triggered duration after the event and false if reminder is triggered duration before the event. Defaults to true.
If true, it will require an enrolled patient form for form related reminders and will not trigger for discharged patient forms. Does not apply to event reminders. Defaults to true.
If true, it will require an enrolled patient program for program related reminders and will not trigger for discharged patient programs. Does not apply to event reminders. Defaults to true.
Describes when this reminder is canceled. This usually refers to a pre-determined event. If unspecified, we assume the reminder never ends.
No Additional PropertiesThe event that will trigger a reminder. This is a hardcoded set of values.
Amount of time before/after the triggering event. This is expressed as an integer multiple of unit. Defaults to 0.
Value must be greater or equal to 0
The unit of measurement for duration.
The time of the day to recur the event at. This field should not be set when unit is minute or hour.
By default, the event will occur exactly duration x unit after the trigger event.
This is useful for overriding the time of the day such as 08:00 instead of some arbitrary time.
^(?P<hour>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24):(?P<minute>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|56|57|58|59)$
Clinical parameter that is datetime type to be used as the trigger.
Clinical parameter that is datetime type to be used as the trigger.
Trigger if metadata-entries matches the condition
Method to validate if filter fullfill condition.
Number of expected metadata entries.
Value must be greater or equal to 1
Date time for Exact event to execute.
True if the reminder is triggered duration after the event and false if reminder is triggered duration before the event. Defaults to true.
If true, it will require an enrolled patient form for form related reminders and will not trigger for discharged patient forms. Does not apply to event reminders. Defaults to true.
If true, it will require an enrolled patient program for program related reminders and will not trigger for discharged patient programs. Does not apply to event reminders. Defaults to true.
An array of RecurringFrequency objects to describe the reminder logic. This is used for recurring reminders.
Must contain a minimum of 1 items
Recurring frequency objects describe complex recurring logic that are usually not supported by cron.
This design is probably a super set of CRON.
Event recurs in multiples of every units. Defaults to 1.
Value must be greater or equal to 1
The unit of measurement for every. Defaults to day.
The number of times for this recurring frequency before it ends. Count is based on the start_on. Defaults to repeat infinitely.
Value must be greater or equal to 1
For unit = hour, this is the minute of the hour for the event to recur. Required for unit = hour. Defaults to 0.
Value must be greater or equal to 0 and lesser or equal to 59
For unit is one of {day, week, month, year}, this is the time of the day for the event to recur. Required for unit in {day, week, month, year}. Defaults to 09:00.
For unit = week, this is the day of the week for the event to recur. Required for unit = week. Defaults to mon.
For unit = month, this is the day of the month for the event to recur. For certain days that do not occur every month (e.g., 31), it will fallback to the last day of the month (e.g., Feb 28). Required for unit = month. Defaults to 1.
Value must be greater or equal to 1 and lesser or equal to 31
For unit = year, this is the day of the year for the event to recur. For certain days that do not occur every month (e.g., 02/29), it will fallback to the closest equivalent (e.g., 02/28). Required for unit = year. Defaults to 1/1.
^(01|02|03|04|05|06|07|08|09|10|11|12)\/(01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31)$
If true, the event will start from the trigger time. If false, the event will start from the next recurring time. Defaults to false.
Sends a follow up reminder if the patient did not submit to the first reminder event. This is an array of intervals in seconds after the first ReminderEvent. Note that the maximum value for an interval is 43200 seconds (i.e., 12 hours).
No Additional ItemsValue must be strictly greater than 0 and lesser or equal to 43200
Describes how submissions are attached to ReminderEvents.
Submissions that were submitted before seconds before the reminder will be attached to the ReminderEvent. Defaults to 14400 seconds.
Value must be strictly greater than 0
Submissions that were submitted after seconds after the reminder will be attached to the ReminderEvent. Defaults to 14400 seconds.
Value must be strictly greater than 0
Metadata of this reminder.
Additional Properties of any type are allowed.
Type: objectThis field has been deprecated.
All items must be unique
No Additional ItemsThis field has been deprecated. Use schedule instead.
An array of reminder times in %H:%M format. Reminders will be sent at this time of the day as determined by the frequency and local timezone.
Times are always in %H:%M format. Assume local timezone as determined by above.
^(?P<hour>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24):(?P<minute>00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|56|57|58|59)$
Reminders will be sent every every_unit (e.g., days, weeks, etc).
Value must be greater or equal to 1
Reminders will be sent every every every_unit (e.g., days, weeks, etc).
For reminders every WEEK, the days of the week for which we will remind. Required when every_unit is WEEK.
Must contain a minimum of 1 items