reporting.types
All types available in Rad AI Reporting.
Alert
Extends
Properties
| Property | Type | Inherited from |
|---|
extensionId | string | ExtensionId.extensionId |
level | AlertLevel | - |
message | string | - |
type | "alert" | - |
AlertConfirmation
Extends
Properties
| Property | Type | Inherited from |
|---|
cancelText | string | - |
confirmText | string | - |
extensionId | string | ExtensionId.extensionId |
message | string | - |
messageId | string | - |
type | "confirm-request" | - |
AlertConfirmationResponse
Properties
| Property | Type |
|---|
messageId | string |
status | "confirmed" | "cancelled" |
type | "confirm-response" |
Display a clickable button.
Button clicks can be acted upon using the reporting.views.onButtonClick handler.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | string | The text displayed inside of your button. | - |
color | ButtonColor | The themed-color of your button. | - |
disabled? | boolean | If true, users cannot click your button. | - |
id | string | An identifier for your button. Should be unique for your extension. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "button" | - | - |
variant | ButtonVariant | The style of your button. | - |
CacheClear
Extends
Properties
| Property | Type | Inherited from |
|---|
extensionId | string | ExtensionId.extensionId |
type | "clear-cache" | - |
CacheUpdate
Extends
Properties
| Property | Type | Inherited from |
|---|
cache | Cache | - |
extensionId | string | ExtensionId.extensionId |
type | "update-cache" | - |
Check
Properties
| Property | Type |
|---|
fixes? | CheckFix[] |
id | string |
level | "info" | "warning" | "error" |
message | string |
positions? | Position[] |
CheckFix
Properties
| Property | Type |
|---|
fixId | string |
message | string |
CheckFixBuffered
Properties
CheckboxNode
Display a read-only checkbox with text.
Can be used as part of an automated checklist.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
checked | boolean | The displayed read-only checkbox. | - |
children | string | The text displayed along-side your checkbox. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "checkbox" | - | - |
Checks
Extends
Properties
| Property | Type | Inherited from |
|---|
checks | Record<string, Check> | - |
extensionId | string | ExtensionId.extensionId |
type | "checks" | - |
ChecksFixClick
Properties
| Property | Type |
|---|
extensionId | string |
fixId | string |
type | "fix-click" |
ColumnContainerNode
Display children side-by-side.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | ColumnNode[] | Nested columns. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "column-container" | - | - |
ColumnNode
Display children in a column. Used with the ColumnContainerNode type.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | Node[] | Nested children. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "column" | - | - |
CustomStyling
While Rad AI provides good defaults for styling your nodes, you can fully customize your styling.
Extended by
Properties
| Property | Type | Description |
|---|
style? | CSSProperties | The custom styles you want to apply to your node. |
Display header text.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | InlineNode[] | The content displayed inline. | - |
size | HeaderSize | The size you want the header to be. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "header" | - | - |
ImageNode
Display inline image.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | string | The alt-text for your image. | - |
src | string | The URL your image lives at. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "image" | - | - |
ListNode
Display children in a nested list.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | Node[] | Nested children. | - |
ordered? | boolean | If true, list items are displayed with numbers. If false, list items are displayed with bullet points. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "list" | - | - |
ParagraphNode
Display a paragraph of text.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
children | InlineNode[] | The content displayed inline. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "paragraph" | - | - |
Position
Properties
| Property | Type |
|---|
start | number |
stop | number |
ReportClosed
Event that fires when a report is closed.
Properties
| Property | Type | Description |
|---|
id | string | A unique identifier for the report. |
type | "report-closed" | - |
ReportOpened
Event that fires when a report is opened.
Properties
| Property | Type | Description |
|---|
id | string | A unique identifier for the report. |
type | "report-opened" | - |
ReportUpdated
Event that fires when a report is updated.
Reports are most commonly updated when the report content is edited (such as during dictation).
Properties
| Property | Type | Description |
|---|
id | string | A unique identifier for the report. |
observations? | Observation[] | An array of R4B Observation FHIR resources. Observations consist of pre-loaded measurements, annotations, and other structured data related to the imaging study. Will be undefined if the report is not associated with a specific imaging study. |
patient? | Patient | The R4B Patient FHIR resource. Will be undefined if the report is not associated with a specific imaging study or if there's no patient associated with the imaging study. |
priors? | DiagnosticReport[] | An array of R4B DiagnosticReport FHIR resources. Priors are previously-generated reports for the patient. Will be undefined if the report is not associated with a specific imaging study. |
shortcuts | {modality: string;procedureCode: string;reportContent: string; } | Shortcuts for frequently-access data. |
shortcuts.modality? | string | - |
shortcuts.procedureCode? | string | - |
shortcuts.reportContent | string | - |
study? | ImagingStudy | The R4B ImagingStudy FHIR resource. Will be undefined if the report is not associated with a specific imaging study. |
type | "report-updated" | - |
TextInputNode
Display a read-only checkbox with text.
Can be used as part of an automated checklist.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
disabled? | boolean | If true, users cannot type into your input. | - |
id | string | An identifier for your input. Should be unique for your extension. | - |
label? | string | The label for your input. | - |
multiline? | boolean | If true, your input will allow multiple lines. | - |
placeholder? | string | The placeholder for your input. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "text-input" | - | - |
TextNode
Display inline text.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|
bold? | boolean | If true, text is bolded. | - |
children | string | The text you want to display. | - |
italics? | boolean | If true, text is italicized. | - |
style? | CSSProperties | The custom styles you want to apply to your node. | CustomStyling.style |
type | "text" | - | - |
underline? | boolean | If true, text is underlined. | - |
Properties
| Property | Type |
|---|
buttonId | string |
extensionId | string |
type | "button-click" |
ViewTextInputChange
Properties
| Property | Type |
|---|
extensionId | string |
inputId | string |
type | "text-input-change" |
value | string |
ViewUpdate
Extends
Properties
| Property | Type | Inherited from |
|---|
children | Node[] | - |
extensionId | string | ExtensionId.extensionId |
type | "update-view" | - |
AlertLevel
AlertLevel: "info" | "success" | "warning" | "error"
BlockNode
BlockNode: HeaderNode | ParagraphNode | ListNode | ColumnNode | ColumnContainerNode
ButtonColor: "primary" | "info" | "success" | "warning" | "error"
ButtonVariant: "outlined" | "contained"
Cache
Cache: Record<string, any>
ExtensionId
ExtensionId: {extensionId: string; }
Type declaration
| Name | Type |
|---|
extensionId | string |
ExtractHandlerEvent<T>
ExtractHandlerEvent<T>: Extract<HandlerEvent, {type: T; }>
Type Parameters
HandlerEvent
HandlerEvent: AlertConfirmationResponse | ChecksFixClick | ReportClosed | ReportOpened | ReportUpdated | ViewButtonClick | ViewTextInputChange
HandlerEventType
HandlerEventType: HandlerEvent["type"]
HeaderSize: "large" | "medium" | "small"
InlineNode
InlineNode: TextNode | ImageNode | CheckboxNode | ButtonNode | TextInputNode
Node
Node: InlineNode | BlockNode