Home Schema Example JSON Schema

Message Template Set User Variables

Type: array of object

List of variables that a user can specify on the frontend for messaging patients.

Must contain a minimum of 0 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Name

Type: string

Variable name that will be used for substitution. Name should not include the ${ and } prefix/suffix.

Must match regular expression: ^[a-zA-Z0-9\-\_\[\]\(\)\{\}]+$

Description

Type: string

Human readable description used as a prompt on frontend for user data entry.

Must be at least 1 characters long

Type

Type: enum (of string)

The type of this variable. Defaults to string.

Must be one of:

  • "string"
  • "file"
  • "url"
  • "datetime"
  • "date"
  • "time"

Required

Type: boolean

Whether this variable is required. Defaults to false.

Default

Type: string

If this variable is not required, the default value will be used. Defaults to not being included in the variables.

Must be at least 1 characters long

Max Length

Type: integer

For string and url, this is the maximum length of the string.

Value must be greater or equal to 1

`strftime` Format

Type: string

For datetime, date, and time variables, the strftime will be applied to generate the final string. Defaults to clinic settings datetime_format for date and datetime. This is required for time variables.
See Python strftime style format for more information.
Note: Named datetime_format to be consistent with clinic settings but can be used for both date and time variable types as well.

Must be at least 1 characters long