BaseInstrument

BaseInstrument<TLanguage>: object

Type Parameters

• TLanguage extends InstrumentLanguage = InstrumentLanguage

Type declaration

__runtimeVersion

__runtimeVersion: 1

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

clientDetails?

optional clientDetails: ClientInstrumentDetails<TLanguage>

The content in the instrument to be rendered to the client

content?

optional content: unknown

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

details

details: InstrumentDetails<TLanguage>

The details of the instrument to be displayed to the user

id?

optional id: string

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

kind

kind: InstrumentKind

The discriminator key for the type of instrument

language

language: TLanguage

The language(s) in which the instrument is written

tags

tags: InstrumentUIOption<TLanguage, string[]>

A list of tags that users can use to filter instruments

Defined in

packages/runtime-core/src/types/instrument.base.d.ts:160