Home Schema Example JSON Schema

User Properties


This schema defines the user properties for each provider. Shadowfax validates the the properties in the _get_user_properties method during augment_events.

No Additional Properties

Type: object

The following properties are required:

  • cleo
Type: object

The following properties are required:

  • einstein
Type: object

The following properties are required:

  • hospital
Type: object

The following properties are required:

  • stitch
Type: object

The following properties are required:

  • noop

Shadowfax User Properties (Cleo)

Type: object

Cleo specific Shadowfax user properties.

No Additional Properties

Clinic

Type: string

Clinic domain of user.

Must be at least 1 characters long

Name

Type: string

Name of user.

Must be at least 1 characters long

Profile UID

Type: string

Profile UID of user.

Must be at least 1 characters long

Communication Method

Type: string

Preferred communication method of user.

Must be at least 1 characters long

Language

Type: string

Preferred language of user.

Must be at least 1 characters long

Is Anonymous

Type: boolean

Whether this is a known user.

Is Clinician

Type: boolean

Whether this is a clinician.

Is Patient

Type: boolean

Whether this is a patient.

Is Caregiver

Type: boolean

Whether this is a caregiver.

Shadowfax User Properties

Type: object

This is the schema for user properties in Einstein.

Organization Key

Type: string

Organization key of administrator's hospital.

Must be at least 1 characters long

Full Name

Type: string

Full name of the user.

Einstein department

Type: string

Einstein department.

Einstein Designation

Type: string

Einstein Designation.

Profile UID

Type: string

Administrator (short) profile UID.

Must be at least 1 characters long

Additional Properties of any type are allowed.

Type: object

Shadowfax User Properties

Type: object

This is the schema for user properties in Hospital.

Organization Key

Type: string

Organization key of hospital.

Must be at least 1 characters long

Full Name

Type: string

Full name of the user.

Hospital department

Type: string

Hospital department.

Hospital Designation

Type: string

Hospital Designation.

Additional Properties of any type are allowed.

Type: object

Shadowfax User Properties (Stitch)

Type: object

Stitch specific Shadowfax user properties.

Noop User Properties

Type: object

Mostly used by unit tests.

Additional Properties of any type are allowed.

Type: object