Home Schema Example JSON Schema

Event Properties


This schema defines the event properties for each provider. Note that event_types field is added for validation but is not actually with the event properties object. Shadowfax validates the the properties in the _get_event_properties method during augment_events.

 No Additional Properties

root oneOf item 0
Type: object

The following properties are required:

  • cleo
root oneOf item 1
Type: object

The following properties are required:

  • einstein
root oneOf item 2
Type: object

The following properties are required:

  • hospital
root oneOf item 3
Type: object

The following properties are required:

  • stitch
root oneOf item 4
Type: object

The following properties are required:

  • noop

root cleo

Shadowfax Event Properties (Cleo)

Type: object

Cleo specific Shadowfax event properties.

root cleo oneOf Created Session
Type: object
No Additional Properties

root cleo oneOf item 0 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Created Clinician Session"
  • "Created Patient Session"

root cleo oneOf item 0 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 0 is_new_session

Is New Session

Type: boolean

Whether this is a new session.

root cleo oneOf item 0 session_uid

Session UID

Type: string

Session UID of user.

Must be at least 1 characters long

root cleo oneOf Form Submission
Type: object
No Additional Properties

root cleo oneOf item 1 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Form Submission"
  • "Patient Form Enrollment"
  • "Patient Form Discharge"

root cleo oneOf item 1 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 1 enrollment_form

Enrollment Form

Type: string

Enrollment form submitted.

Must be at least 1 characters long

root cleo oneOf item 1 monitoring_form

Monitoring Form

Type: string

Monitoring form submitted.

Must be at least 1 characters long

root cleo oneOf item 1 is_enrollment_form

Is Enrollment Form

Type: boolean

Whether this is an enrollment form submission.

root cleo oneOf item 1 is_abnormal_submission

Is Abnormal Submission

Type: boolean

Whether there are alerts triggered for this submission.

root cleo oneOf item 1 alert_count

Alert Count

Type: integer

Value must be greater or equal to 0

root cleo oneOf item 1 discharge_method

Discharge Method

Type: enum (of string)

How the patient-form was discharged

Must be one of:

  • "Via Dashboard"
root cleo oneOf Incoming and Outgoing Message
Type: object
No Additional Properties

root cleo oneOf item 2 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Outgoing Message"
  • "Incoming Message"

root cleo oneOf item 2 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 2 direction

Direction

Type: enum (of string)

Direction of the delivery.

Must be one of:

  • "outgoing"
  • "incoming"

root cleo oneOf item 2 delivery_by

Delivery By

Type: string

What triggered this delivery.

Must be at least 1 characters long

root cleo oneOf item 2 language

Language

Type: string

Must be at least 1 characters long

root cleo oneOf item 2 communication_method

Communication Method

Type: string

Must be at least 1 characters long

root cleo oneOf item 2 template_purpose

Template Purpose

Type: string

Must be at least 1 characters long

root cleo oneOf item 2 template_name

Template Name

Type: string

Must be at least 1 characters long

root cleo oneOf item 2 is_enrolled

Is Enrolled

Type: boolean

Whether the message is sent by an enrolled patient.
root cleo oneOf Exports and Stitch Download
Type: object

root cleo oneOf item 3 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Export"
  • "Stitch Download"

root cleo oneOf item 3 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 3 export_output_format

Export Output Format

Type: string

Must be at least 1 characters long

root cleo oneOf item 3 export_document_type

Export Document Type

Type: string

Must be at least 1 characters long

root cleo oneOf item 3 export_via_email

Export Via Email

Type: boolean

Additional Properties of any type are allowed.

root cleo oneOf item 3 additionalProperties
Type: object
root cleo oneOf Jarvis Response
Type: object
No Additional Properties

root cleo oneOf item 4 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Jarvis Response"

root cleo oneOf item 4 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 4 elapsed

Elapsed

Type: number

Number of seconds elapsed for the Jarvis API call.

root cleo oneOf item 4 message_type

Message Type

Type: enum (of string)

Must be one of:

  • "sorry"
  • "response"
  • "not_enrolled"
root cleo oneOf Daily Clinic Statistics
Type: object
No Additional Properties

root cleo oneOf item 5 event_type

Event Type

Type: const
Specific value: "Daily Clinic Statistics"

root cleo oneOf item 5 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 5 active_caregiver_count

Active Caregiver Count

Type: integer

Number of activated caregivers in clinic.

root cleo oneOf item 5 active_clinician_count

Active Clinician Count

Type: integer

Number of activated clinicians in clinic.

root cleo oneOf item 5 active_patient_count

Active Patient Count

Type: integer

Number of activated patients in clinic.

root cleo oneOf item 5 active_patient_form_count

Active Patient-Form Count

Type: integer

Number of activated patient-forms in clinic.

root cleo oneOf item 5 clinical_parameter_count

Clinical Parameter Count

Type: integer

Number of clinical parameters in the clinic.
root cleo oneOf Frontend Events
Type: object

root cleo oneOf item 6 event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Add Caregiver"
  • "Add Clinical Admin"
  • "Add New Patient"
  • "Apply Filters"
  • "Click Send Message"
  • "Deactivate Caregiver Profile"
  • "Deactivate Clinical Admin Profile"
  • "Discharge Patient"
  • "Download Patient Submissions"
  • "Edit Caregiver Profile"
  • "Edit Clinical Admin Profile"
  • "Edit Patient Profile"
  • "Enroll Patient"
  • "Export User List"
  • "List All Active Patients"
  • "List All Unread Comments"
  • "List Clinical Admin"
  • "List Clinical Alerts"
  • "List Non Compliant Patients"
  • "List Overview"
  • "List Patient List"
  • "List Patient Monitoring"
  • "List Patient Submissions"
  • "List Unread Comments Patients"
  • "List Unresolved Alerts"
  • "No Action"
  • "Open Contact Us"
  • "Patient Caregivers"
  • "Reactivate Caregiver Profile"
  • "Reactivate Clinical Admin Profile"
  • "Read Help Guide"
  • "Refresh Results"
  • "Reset Filters"
  • "Search Patients"
  • "Show Patient Profile"
  • "View Clinical Settings - Activate/Pause Reminder"
  • "View Clinical Settings - Delete reminder"
  • "View Clinical Settings - Discharge patient"
  • "View Clinical Settings - Edit alert threshold"
  • "View Clinical Settings - Edit Clinical User"
  • "View Clinical Settings - Edit reminder duration"
  • "View Clinical Settings - Edit reminder frequency"
  • "View Clinical Settings - Edit reminder"
  • "View Clinical Settings - Send template message"
  • "View Clinical Settings"
  • "View Graphs"
  • "View Patient Form"

root cleo oneOf item 6 clinic

Clinic

Type: string

Clinic domain related to the event.

Must be at least 1 characters long

root cleo oneOf item 6 eventName

Event Name

Type: string

An alias for event_type.

Additional Properties of any type are allowed.

root cleo oneOf item 6 additionalProperties
Type: object

root einstein

Shadowfax Event Properties

Type: object

This is the schema for event properties in Einstein.

root einstein event_type

Event Type

Type: string

Name of the event.

Must be at least 1 characters long

root einstein profile_uid

Profile UID

Type: string

Profile UID.

Must be at least 1 characters long

root einstein organization_key

Organization Key

Type: string

Organization key of einstein.

Must be at least 1 characters long

Additional Properties of any type are allowed.

root einstein additionalProperties
Type: object

root hospital

Shadowfax Event Properties

Type: object

This is the schema for event properties in Hospital.

root hospital event_type

Event Type

Type: string

Name of the event.

Must be at least 1 characters long

root hospital profile_uid

Profile UID

Type: string

Profile UID.

root hospital organization_key

Organization Key

Type: string

Organization key of hospital.

Additional Properties of any type are allowed.

root hospital additionalProperties
Type: object

root stitch

Shadowfax Event Properties (Stitch)

Type: object

Stitch specific Shadowfax user properties.

root stitch event_type

Event Type

Type: enum (of string)

Must be one of:

  • "Stitch Download"

root stitch source_url

Source URL

Type: string

Must be at least 1 characters long

root stitch mime_type

MIME Type

Type: string

Must be at least 1 characters long

root stitch provider

Provider Key

Type: string

Stitch provider key.

Must be at least 1 characters long

Additional Properties of any type are allowed.

root stitch additionalProperties
Type: object

root noop

Noop User Properties

Type: object

Mostly used by unit tests.

Additional Properties of any type are allowed.

root noop additionalProperties
Type: object