Home Schema Example JSON Schema

Patient Form Metadata

Type: object

Settings for patient-form enrollment information.

Ada

Type: object

Patient metadata from previous Ada clinics.

No Additional Properties

Hashed ID

Type: string

Hashed patient IC.

Login Hash

Type: string

Hashed last 4 characters of patient IC and phone number.

Engage

Type: object

Metadata associated with the patient form for the Engage v1 flow.

No Additional Properties

Module

Type: enum (of string)

The module associated with this patient-form.

Must be one of:

  • "Pre Genetic Counseling"
  • "Post Genetic Counseling"
  • "Post Genetic Testing"

Stage

Type: string

The stage associated with this patient-form.

Is Completed

Type: boolean

Boolean to mark the form as completed or not. This is for convenience to easily reset existing patient forms.

Reminder Delivery UIDs

Type: array of string

For forms with reminder schedules, this is an array of reminder delivery UIDs for tracking purposes.

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

Alert Email Sent

Type: boolean

True when an alert email has been sent to doctor in-charge. Defaults to false.

Appointment Reminder Stages

Type: array of string

Array of stages of appointment reminders that have been sent.

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

Appointment Datetime

Type: stringFormat: date-time

Date/Time the appointment visit is scheduled for.

Additional Properties of any type are allowed.

Type: object