Home Schema Example JSON Schema

Profile Metadata

Type: object

Provides supplementary information about the clinician.

 No Additional Properties

root language

Language

Type: string

Profile's preferred language. Use the ISO 639-1 code.

Must match regular expression: ^[a-z][a-z]$

root email

E-mail

Type: stringFormat: idn-email

Profile's email address.

root avatar

Avatar

Type: enum (of string)

Profile's avatar.

Must be one of:

  • "avatar_blue_male"
  • "avatar_blue_female"
  • "avatar_yellow_male"
  • "avatar_yellow_female"
  • "avatar_pink_male"
  • "avatar_pink_female"
  • "avatar_grey_male"
  • "avatar_grey_female"

root engage

Engage

Type: object

Patient metadata for the Engage v1 flow.

 No Additional Properties

root engage module

Module

Type: enum (of string)

The current module the patient signed up for. If this field is absent, it is assumed that the patient is not enrolled into anything.

Must be one of:

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

root engage stage

Stage

Type: string

The current stage of the patient on the onboarding process.

root maxicare

Maxicare

Type: object

Maxicare's metadata

root maxicare coverages

Coverage

Type: array of object

Coverage that patient has access to.

 No Additional Items

Each item of this array must be:

root maxicare coverages coverages items
Type: object

root maxicare coverages coverages items code

Code

Type: enum (of string)

Code of the coverage

Must be one of:

  • "ACU"
  • "C"
  • "IP"
  • "OP"
  • "ER"
  • "M"

root maxicare coverages coverages items description

Description

Type: string

Description of the coverage

root maxicare expiry_date

Expiry Date

Type: stringFormat: date-time

Expiry date of the maxicare card

Additional Properties of any type are allowed.

root maxicare additionalProperties
Type: object