---
description: Open-source administration console for Aidbox FHIR server with Resource Browser, REST Console, SQL Console, FHIR packages, Audit Events, and Settings.
---

# 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](https://github.com/HealthSamurai/aidbox-ui). Contributions, bug reports, and feature requests are welcome.

Aidbox UI is built on top of the [Aidbox TypeScript SDK](https://github.com/HealthSamurai/aidbox-ts-sdk) and the [Health Samurai React Components](https://github.com/HealthSamurai/aidbox-ts-sdk/tree/master/packages/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](../../modules/sql-on-fhir/README.md) 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](../../modules/sql-on-fhir/README.md) ViewDefinitions.

### FHIR Packages

Browse, install, and manage FHIR Implementation Guides and NPM packages loaded into Aidbox via the [FHIR Artifact Registry](../../artifact-registry/artifact-registry-overview.md). Inspect individual resources within each package.

### Audit Events

View and search [AuditEvent](../../access-control/audit-and-logging.md) resources generated by Aidbox, with filtering by date, type, and agent.

### Settings

Configure Aidbox instance settings from the UI.

## Screenshots and videos

{% tabs %}
{% tab title="DB Console" %}
<video src="../../assets/overview/aidbox-ui/db.mp4" autoplay loop muted playsinline controls class="w-full rounded-lg" loading="lazy"></video>
{% endtab %}
{% tab title="REST Console" %}
<video src="../../assets/overview/aidbox-ui/rest-4k.mp4" autoplay loop muted playsinline controls class="w-full rounded-lg" loading="lazy"></video>
{% endtab %}
{% tab title="ViewDefinition Builder" %}
<video src="../../assets/overview/aidbox-ui/vd.mp4" autoplay loop muted playsinline controls class="w-full rounded-lg" loading="lazy"></video>
{% endtab %}
{% tab title="FHIR Packages" %}
<video src="../../assets/overview/aidbox-ui/far.mp4" autoplay loop muted playsinline controls class="w-full rounded-lg" loading="lazy"></video>
{% endtab %}
{% endtabs %}