Home Schema Example JSON Schema

Session Scopes


Session.scopes are used to limit what a user can/cannot do. Sessions can only use scopes from the same application.

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