Home Schema Example JSON Schema

Task Metadata

Type: object

These are used to store task metadata. To separate between different task providers, we adopt a naming convention where the fields are named by the provider_key.

No Additional Properties

Cleo

Type: object

Cleo related task metadata used for faster querying.

No Additional Properties

Type: object

The following properties are required:

  • reminder_uid
Type: object

The following properties are required:

  • clinic_uid

Clinic UID

Type: string

The clinic UID this task is responsible for.

Must be at least 1 characters long

Reminder UID

Type: string

The reminder UID this task is responsible for.

Must be at least 1 characters long

Patient Form UID

Type: string

The patient form UID this task is responsible for.

Must be at least 1 characters long

Calendar UID

Type: string

The calendar UID this task is responsible for.

Must be at least 1 characters long

Patient Event UID

Type: string

The patient event UID this task is responsible for.

Must be at least 1 characters long

Patient Program UID

Type: string

The patient program UID this task is responsible for.

Must be at least 1 characters long

Patient Program Form UID

Type: string

The patient program form UID this task is responsible for.

Must be at least 1 characters long

Type: object

Logic to sync reminder schedule.

No Additional Properties

Reminder UIDs

Type: array of string

Reminder UIDs to sync.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Type: object

Baxter related task metadata used for baxter's business logic.

No Additional Properties

Baxter Clinic Mapping

Type: object

Mapping to map Cleo Clinics to Baxter Clinics. Key are cleo_clinic_uid and value are baxter_clinic_uid.

Baxter Submission Onform Mapping

Type: object

Mapping that map Baxter's device submission to respective onform. Key are cleo_clinic_uid and value are onform_uid.

Baxter Enrollment Onform Mapping

Type: object

Mapping that enroll patient via respective onform. Key are cleo_clinic_uid and value are onform_uid.

Type: object

Document syncer related task metadata used for document syncer's business logic.

No Additional Properties

Clinic UID

Type: string

Clinic UID to sync.

Must be at least 1 characters long

Document UID

Type: string

Document UID to sync.

Must be at least 1 characters long

Type: object

Hummingbird related task metadata used for Hummingbird's business logic.

No Additional Properties

Clinics

Type: array of object

Clinic to sync calendar from Hummingbird.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Clinic UID

Type: string

Clinic UID to sync.

Caesar UIDs

Type: array of string

UID of provider application in Caesar to sync.

No Additional Items

Each item of this array must be:

Type: object

HMI related task metadata used for HMI's business logic.

No Additional Properties

SFTP

Type: object

SFTP settings for HMI.

No Additional Properties

Host

Type: string

SFTP host.

Port

Type: integer

SFTP port.

Username

Type: string

SFTP username.

Password

Type: string

SFTP password.

Host Key

Type: string

Host key in ecdsa-sha2-nistp256 algorithm to establish SSH connection.

Private Key

Type: string

SFTP private key.

Chernobyl

Type: object

Chernobyl related task metadata.

No Additional Properties

Google Drive URL

Type: string

Google Drive URL this task is responsible for.

Must be at least 1 characters long

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Einstein

Type: object

Einstein related task metadata.

No Additional Properties

Einstein Module UIDs

Type: array of string

Used for any einstein kronos task which needs einstein Module uids.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Einstein DataSource UIDs

Type: array of string

Used for any einstein kronos task which needs einstein DataSource uids.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip On Recreate Entries

Type: boolean

Set this flag to skip syncing data sources which have the skip_on_recreate_entries set to True (Defaults to True).

Fleming

Type: object

Fleming related task metadata.

No Additional Properties

Google Drive URL

Type: string

Google Drive URL this task is responsible for.

Must be at least 1 characters long

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Same definition as gsheets

Health Check

Type: object

Various settings for Healthchecks.

No Additional Properties

Type: object

The following properties are required:

  • heartbeat_key
Type: object

The following properties are required:

  • provider_application

Heartbeat Key

Type: string

Betteruptime heartbeat key for reporting heartbeats.

Must be at least 1 characters long

Provider Application

Type: string

The provider application UID or name that contain the HealthcheckApplication for driving the healthcheck pings.

Must be at least 1 characters long

Noop

Type: string

The Noop provider displays a message at the INFO level to the logs.

Must be at least 1 characters long