Home Schema Example JSON Schema

Application Settings

Type: object

ProviderApplication.application_settings are used by backend to communicate with the authentication providers. This field will not be exposed to frontend.

Allowed Redirects

Type: array of string

List of canonical URLs allowed by the login frontend to redirect to after authentication.

All items must be unique

No Additional Items

Each item of this array must be:

Type: stringFormat: uri

Scopes

Type: object

Overrides the session scopes defined in the class. This is used by GovernessUserApplication and HospitalHeimdallApplication.

Hospital

Type: array of string

Hospital specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 2 items

All items must be unique

No Additional Items

Each item of this array must be:


User

Type: const

Access all user features.

Specific value: "hospital:user"

User

Type: const

Access all user features.

Specific value: "hospital:user-temporary"

Public

Type: const

Access all public features.

Specific value: "hospital:public"

Organiation Key

Type: string

Organization

Must match regular expression: ^hospital\:\w+$

Hospital (Chemocalc)

Type: const

Chemocalc specific session scopes.

Specific value: [ "sgid", "hospital:user" ]

Cleo

Type: object

Cleo specific session scopes. A Cleo session can be scoped for either clinician or patient.

Type: const
Specific value: [ "cleo:user", "cleo:administrator", "cleo:superadmin" ]
Type: const
Specific value: [ "cleo:user", "cleo:administrator", "cleo:admin" ]
Type: const
Specific value: [ "cleo:user", "cleo:clinician" ]
Type: const
Specific value: [ "cleo:user", "cleo:patient" ]
Type: const
Specific value: [ "cleo:user", "cleo:patient", "cleo:maxicare" ]
Type: const
Specific value: [ "cleo:maxicare" ]
Type: const
Specific value: [ "cleo:clinic" ]
Type: const
Specific value: [ "cleo:clinicgroup" ]
Type: const
Specific value: [ "cleo:clinician-temporary" ]
Type: const
Specific value: [ "cleo:patient-temporary" ]

Maxwell

Type: array of string

Maxwell specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 2 items

Must contain a maximum of 2 items

All items must be unique

No Additional Items

Each item of this array must be:

Merlin

Type: object

Merlin specific session scopes.

Type: const
Specific value: [ "merlin:administrator", "merlin:superadmin" ]
Type: const
Specific value: [ "merlin:administrator", "merlin:admin" ]

Einstein

Type: array of string

Einstein specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:


Administrator

Type: const
Specific value: "einstein:administrator"

Administrator (Temporary)

Type: const
Specific value: "einstein:administrator-temporary"

Faraday

Type: array of string

Faraday specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:


Doctor

Type: const

Doctor with acess to its own data.

Specific value: "faraday:doctor"

Admin

Type: const

Admin with limited access.

Specific value: "faraday:admin"

Super Admin

Type: const

Clinic Admin with full access.

Specific value: "faraday:superadmin"

Approval

Type: const

Session to access approval page.

Specific value: "faraday:approval"

Sgid

Type: array of enum (of string)

For Sgid session

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "sgid"

Internal Services

Type: array of enum (of string)

Used by internal services to access Hippocrates services. tester is used in unit tests only.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "internal:chatterbox"
  • "internal:stitch"
  • "tester"

Anonymous

Type: array

Anonymous sessions should have empty ([]) scopes.

Must contain a maximum of 0 items

No Additional Items

Issues Temporary Sessions

Type: boolean Default: false

If true, this instance of the application issues temporary session tokens only. Defaults to false. Temporary tokens last 60 seconds by default.

Session Duration

Type: number

Overrides the session duration defined in the class. This is used by GovernessUserApplication and HospitalHeimdallApplication.

Value must be greater or equal to 3600

Native Session Duration

Type: number

Overrides the native session duration defined in the class. This is used by HospitalHeimdallApplication. Defaults to sesion_duration.

Value must be greater or equal to 3600

Web Session Duration

Type: number

Overrides the web session duration defined in the class. This is used by HospitalHeimdallApplication. Defaults to 10800.

Value must be greater or equal to 3600 and lesser or equal to 86400

Test phone numbers

Type: array of string

Allowed test phone numbers. This is used by TestApplication.

No Additional Items

Each item of this array must be:

Cleo

Type: object

Settings for CleoHeimdallApplication.

No Additional Properties

Use Temporary Session

Type: boolean

CleoHeimdallApplication will issue temporary sessions when used from the login page. This setting defaults to true and will be deprecated when temporary sessions are in use on production.

Scopes

Type: object

Additional scopes for session.

Hospital

Type: array of string

Hospital specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 2 items

All items must be unique

No Additional Items

Each item of this array must be:


User

Type: const

Access all user features.

Specific value: "hospital:user"

User

Type: const

Access all user features.

Specific value: "hospital:user-temporary"

Public

Type: const

Access all public features.

Specific value: "hospital:public"

Organiation Key

Type: string

Organization

Must match regular expression: ^hospital\:\w+$

Hospital (Chemocalc)

Type: const

Chemocalc specific session scopes.

Specific value: [ "sgid", "hospital:user" ]

Cleo

Type: object

Cleo specific session scopes. A Cleo session can be scoped for either clinician or patient.

Type: const
Specific value: [ "cleo:user", "cleo:administrator", "cleo:superadmin" ]
Type: const
Specific value: [ "cleo:user", "cleo:administrator", "cleo:admin" ]
Type: const
Specific value: [ "cleo:user", "cleo:clinician" ]
Type: const
Specific value: [ "cleo:user", "cleo:patient" ]
Type: const
Specific value: [ "cleo:user", "cleo:patient", "cleo:maxicare" ]
Type: const
Specific value: [ "cleo:maxicare" ]
Type: const
Specific value: [ "cleo:clinic" ]
Type: const
Specific value: [ "cleo:clinicgroup" ]
Type: const
Specific value: [ "cleo:clinician-temporary" ]
Type: const
Specific value: [ "cleo:patient-temporary" ]

Maxwell

Type: array of string

Maxwell specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 2 items

Must contain a maximum of 2 items

All items must be unique

No Additional Items

Each item of this array must be:

Merlin

Type: object

Merlin specific session scopes.

Type: const
Specific value: [ "merlin:administrator", "merlin:superadmin" ]
Type: const
Specific value: [ "merlin:administrator", "merlin:admin" ]

Einstein

Type: array of string

Einstein specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:


Administrator

Type: const
Specific value: "einstein:administrator"

Administrator (Temporary)

Type: const
Specific value: "einstein:administrator-temporary"

Faraday

Type: array of string

Faraday specific session scopes. See heimdall/SessionScopes.schema for more information.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:


Doctor

Type: const

Doctor with acess to its own data.

Specific value: "faraday:doctor"

Admin

Type: const

Admin with limited access.

Specific value: "faraday:admin"

Super Admin

Type: const

Clinic Admin with full access.

Specific value: "faraday:superadmin"

Approval

Type: const

Session to access approval page.

Specific value: "faraday:approval"

Sgid

Type: array of enum (of string)

For Sgid session

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "sgid"

Internal Services

Type: array of enum (of string)

Used by internal services to access Hippocrates services. tester is used in unit tests only.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "internal:chatterbox"
  • "internal:stitch"
  • "tester"

Anonymous

Type: array

Anonymous sessions should have empty ([]) scopes.

Must contain a maximum of 0 items

No Additional Items

Chemocalc

Type: object

Settings for ChemocalcHeimdallApplication.

No Additional Properties

Hospital Profile UID

Type: string

Session generated from ChemocalcHeimdallApplication will be stored under this hospital profile.

Must be at least 1 characters long

Faraday

Type: object

Settings for FaradayHeimdallApplication.

No Additional Properties

Approval Emails

Type: array of string

Email that is allowed to access Faraday's approval page.

No Additional Items

Each item of this array must be:

Additional Properties of any type are allowed.

Type: object