Home Schema Example JSON Schema

Reminder Event Metadata

Type: object

Schema to describe how the reminder event metadata will look like.

No Additional Properties

Status

Type: enum (of string)

Status of this reminder event.
1. queued: The reminder has been queued by the job scheduler (i.e., celery) but has yet to be processed. 2. processing: The reminder has been processed by the scheduler (i.e., celery) but the final outcome is not known yet. In this stage, no attempts will be made at all. 3. delivered: The reminder has been delivered by the Ratatoskr provider (i.e., a Delivery object has been created). 3. completed: The reminder action has been performed. Note that this is the equivalent of delivered for non-delivery actions. 4. failed: The reminder has been considered a failure and no more attempts will be made. Examples includes missing delivery object for SendTemplate action. 5. skipped: The reminder has been skipped because the patient already has a recent submission.

Must be one of:

  • "queued"
  • "processing"
  • "delivered"
  • "completed"
  • "failed"
  • "skipped"

Follow Up

Type: object

For follow up reminder events, this object will contain metadata about the first reminder.

No Additional Properties

UID

Type: string

UID for first reminder event.

Must be at least 1 characters long

Interval

Type: number

This is the interval between this current reminder event and the first reminder event.

Value must be strictly greater than 0