Aidbox Docs

Aidbox UI

Aidbox UI is an open-source administration console for the Aidbox FHIR server. It is built with React and TypeScript and ships as part of every Aidbox instance. The source code is available on GitHub. Contributions, bug reports, and feature requests are welcome.

Aidbox UI is built on top of the Aidbox TypeScript SDK and the Health Samurai React Components library — a set of reusable UI components for building healthcare applications with Aidbox. You can use the same libraries to build your own custom UIs.

Key components

Resource Browser

Browse, search, create, and edit FHIR resources stored in Aidbox. The Resource Browser supports search parameters, sorting, and inline JSON editing.

Some resource types have specialized views:

  • AccessPolicy — includes a built-in dev tool for testing policies. Send a request directly from the editor and see which policies matched, the evaluation result, and the generated SQL — all without leaving the page.
  • ViewDefinition — a visual builder for SQL on FHIR ViewDefinitions. Edit columns, preview the generated SQL, run the query, and inspect results side by side with a FHIRPath editor and schema browser.

REST Console

An interactive HTTP client built into Aidbox. Use it to execute REST API requests, inspect responses, and build collections of saved queries.

SQL Console

Run SQL queries directly against the Aidbox database. Useful for debugging, analytics, and working with SQL on FHIR ViewDefinitions.

Per-tab settings:

  • Transaction mode — Autocommit (each statement commits immediately; required for VACUUM, CREATE INDEX CONCURRENTLY) or Transaction (whole script wrapped in a single transaction).
  • Timeout — per-query statement_timeout, default 1 minute.
  • Limit — JDBC fetch size cap.
  • Execution — Foreground (synchronous, results returned to the UI) or Background (fire-and-forget; the server runs the query, the UI does not retain results).

Stop button cancels the running query via $psql-cancel. The Tab key indents inside the editor; EXPLAIN plans render as a monospace block. Each tab keeps its own settings, query text, and running state. Backed by the $psql endpoint.

FHIR Packages

Browse, install, and manage FHIR Implementation Guides and NPM packages loaded into Aidbox via the FHIR Artifact Registry. Inspect individual resources within each package.

Audit Events

View and search AuditEvent resources generated by Aidbox, with filtering by date, type, and agent.

Settings

Configure Aidbox instance settings from the UI.

Screenshots and videos

Last updated: