Schema for Cleo Patient Form Metadata

---
$id: https://skeleton.botmd.io/cleo/PatientFormMetadata.schema
$schema: http://json-schema.org/draft-07/schema#

title: Patient Form Metadata
description: Settings for patient-form enrollment information.

type: object
additionalProperties: true
required: []

properties:
  ada:
    title: Ada
    description: Patient metadata from previous Ada clinics.

    type: object
    additionalProperties: false
    required: []

    properties:
      hashed_id:
        title: Hashed ID
        description: Hashed patient IC.
        type: string

      login_hash:
        title: Login Hash
        description: Hashed last 4 characters of patient IC and phone number.
        type: string
    #end properties
  #end ada

  engage:
    title: Engage
    description: Metadata associated with the patient form for the Engage v1 flow.

    type: object
    additionalProperties: false
    required: [module, stage]

    properties:
      module:
        title: Module
        description: The module associated with this patient-form.
        enum: [Pre Genetic Counseling, Post Genetic Counseling, Post Genetic Testing]

      stage:
        title: Stage
        description: The stage associated with this patient-form.
        type: string

      is_completed:
        title: Is Completed
        description: Boolean to mark the form as completed or not. This is for convenience to easily reset existing patient forms.
        type: boolean

      reminder_delivery_uids:
        title: Reminder Delivery UIDs
        description: For forms with reminder schedules, this is an array of reminder delivery UIDs for tracking purposes.
        type: array
        minItems: 1
        items:
          type: string
          minLength: 1

      alert_email_sent:
        title: Alert Email Sent
        description: "`True` when an alert email has been sent to doctor in-charge. Defaults to `false`."
        type: boolean

      appointment_reminder_stages:
        title: Appointment Reminder Stages
        description: Array of stages of appointment reminders that have been sent.
        type: array
        minItems: 1
        items:
          type: string
          minLength: 1

      appointment_datetime:
        title: Appointment Datetime
        description: Date/Time the appointment visit is scheduled for.
        type: string
        format: date-time
    #end properties
  #end engage
#end properties