Aller au contenu

BaseInstrument

Ce contenu n’est pas encore disponible dans votre langue.

BaseInstrument<TLanguage> = object

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:121

Type Parameters

TLanguage

TLanguage extends InstrumentLanguage = InstrumentLanguage

Properties

__runtimeVersion

__runtimeVersion: 1

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:123

The runtime version for this instrument, which is set automatically by the defineInstrument function


clientDetails?

optional clientDetails?: ClientInstrumentDetails<TLanguage>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:125

The content in the instrument to be rendered to the client


content?

optional content?: unknown

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:127

The content in the instrument to be rendered to the clinician/researcher


details

details: InstrumentDetails<TLanguage>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:129

The details of the instrument to be displayed to the user


id?

optional id?: string

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:131

The database ID for the instrument. For scalar instruments, this is derived by the internal property.


kind

kind: InstrumentKind

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:133

The discriminator key for the type of instrument


language

language: TLanguage

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:135

The language(s) in which the instrument is written


tags

tags: InstrumentUIOption<TLanguage, string[]>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:137

A list of tags that users can use to filter instruments