Home Schema Example JSON Schema

Rule Parser Settings

Type: object

Settings for configuring alert rule parsers.

 No Additional Properties

root simple

Simple

Type: array of object

Triggers alerts when parameters are not in an inclusive min-max range or equals to a given value. The settings for Simple parser is an array of parameter and min/max/equal values which are OR-ed together.

 No Additional Items

Each item of this array must be:

root simple simple items
Type: object
No Additional Properties

root simple simple items clinical_parameter

Clinical Parameter

Type: string

This is one of clinical parameter uid or name or name (group_name).

Must be at least 1 characters long

root simple simple items min

Minimum value

Type: number

Parameter should be greater (or equal, depending on inclusive_min) to this value.

root simple simple items inclusive_min

Inclusive Minimum

Type: boolean

If inclusive_min is true, then value ≤ min will trigger an alert. Defaults to false.

root simple simple items max

Maximum value

Type: number

Parameter should be lesser (or equal, depending on inclusive_max) to this value.

root simple simple items inclusive_max

Inclusive Maximum

Type: boolean

If inclusive_max is true, then value ≥ max will trigger an alert. Defaults to false.

root simple simple items equals

Equals

Type: object

When the parameter contains or equal to this value.

 No Additional Properties

root simple simple items equals value

Value

Type: string or number

Value to match the parameter. Can be number or string.

root simple simple items equals case_sensitive

Case Sensitive

Type: boolean

Whether to perform case sensitive compare for string parameter values. Defaults to false.

root simple simple items is_empty

Is Empty

Type: boolean

Whether to trigger an alert when the value is empty; applies to string and string_array only.

root simple simple items is_not_empty

Is Not Empty

Type: boolean

Whether to trigger an alert when the value is not empty; applies to string and string_array only.

root simple simple items reason

Reason

Type: string

This reason is returned when parameter is alertable. Defaults to {sv.parameter.name_with_group} is too low/too high/equals ${value}.

root minmax

MinMax

Type: array of object

This is equivalent to Simple rule parser. It exists for backward compatibility.

 No Additional Items

Each item of this array must be:

root simple simple items
Type: object
No Additional Properties

root simple simple items clinical_parameter

Clinical Parameter

Type: string

This is one of clinical parameter uid or name or name (group_name).

Must be at least 1 characters long

root simple simple items min

Minimum value

Type: number

Parameter should be greater (or equal, depending on inclusive_min) to this value.

root simple simple items inclusive_min

Inclusive Minimum

Type: boolean

If inclusive_min is true, then value ≤ min will trigger an alert. Defaults to false.

root simple simple items max

Maximum value

Type: number

Parameter should be lesser (or equal, depending on inclusive_max) to this value.

root simple simple items inclusive_max

Inclusive Maximum

Type: boolean

If inclusive_max is true, then value ≥ max will trigger an alert. Defaults to false.

root simple simple items equals

Equals

Type: object

When the parameter contains or equal to this value.

 No Additional Properties

root simple simple items equals value

Value

Type: string or number

Value to match the parameter. Can be number or string.

root simple simple items equals case_sensitive

Case Sensitive

Type: boolean

Whether to perform case sensitive compare for string parameter values. Defaults to false.

root simple simple items is_empty

Is Empty

Type: boolean

Whether to trigger an alert when the value is empty; applies to string and string_array only.

root simple simple items is_not_empty

Is Not Empty

Type: boolean

Whether to trigger an alert when the value is not empty; applies to string and string_array only.

root simple simple items reason

Reason

Type: string

This reason is returned when parameter is alertable. Defaults to {sv.parameter.name_with_group} is too low/too high/equals ${value}.

root missing

Missing Submission

Type: object

Triggers alers when submissions are not made a certain time period after being reminded.

root missing after_seconds

After Seconds

Type: integer

Number of seconds after reminder event without submission which we will trigger an alert.

Value must be greater or equal to 0

Additional Properties of any type are allowed.

root missing additionalProperties
Type: object