Home Schema Example JSON Schema

Reminder Schedule (DEPRECATED)

Type: object

Schema for storing reminder schedules.

No Additional Properties

Cron Expressions (Deprecated)

Type: array

This field has been deprecated.

All items must be unique

No Additional Items

Timezone

Type: string

The timezone for this cron expressions. Defaults to clinic timezone (or UTC if that is not set).

Must be at least 1 characters long

Frontend Data Model

Type: object

Used by frontend to represent the reminder schedule.

No Additional Properties

Times

Type: array of string

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.

No Additional Items

Each item of this array must be:

Time

Type: string

Times are always in %H:%M format. Assume local timezone as determined by above.

Must match regular expression: ^(?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)$

Every

Type: integer

Reminders will be sent every every_unit (e.g., days, weeks, etc).

Value must be greater or equal to 1

Every Unit

Type: enum (of string)

Reminders will be sent every every every_unit (e.g., days, weeks, etc).

Must be one of:

  • "day"
  • "week"
  • "month"

Days of Week

Type: array of enum (of string)

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

No Additional Items

Each item of this array must be:

Day

Type: enum (of string)

Must be one of:

  • "mon"
  • "tue"
  • "wed"
  • "thu"
  • "fri"
  • "sat"
  • "sun"

Follow Up Intervals

Type: array of integer

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 Items

Each item of this array must be:

Interval

Type: integer

Value must be strictly greater than 0 and lesser or equal to 43200

Recent Submission

Type: object

Describes how submissions are attached to ReminderEvents.

No Additional Properties

Before

Type: number

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

After

Type: number

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