BaseInstrument
BaseInstrument<
TLanguage>:object
Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:117
Type Parameters
Section titled “Type Parameters”• TLanguage extends InstrumentLanguage = InstrumentLanguage
Type declaration
Section titled “Type declaration”__runtimeVersion
Section titled “__runtimeVersion”__runtimeVersion:
1
The runtime version for this instrument, which is set automatically by the defineInstrument function
clientDetails?
Section titled “clientDetails?”
optionalclientDetails:ClientInstrumentDetails<TLanguage>
The content in the instrument to be rendered to the client
content?
Section titled “content?”
optionalcontent:unknown
The content in the instrument to be rendered to the clinician/researcher
details
Section titled “details”details:
InstrumentDetails<TLanguage>
The details of the instrument to be displayed to the user
optionalid:string
The database ID for the instrument. For scalar instruments, this is derived by the internal property.
kind:
InstrumentKind
The discriminator key for the type of instrument
language
Section titled “language”language:
TLanguage
The language(s) in which the instrument is written
tags:
InstrumentUIOption<TLanguage,string[]>
A list of tags that users can use to filter instruments