Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,6 @@
* [Licenses](overview/aidbox-user-portal/licenses.md)
* [Members](overview/aidbox-user-portal/members.md)
* [Aidbox UI](overview/aidbox-ui/README.md)
* [Aidbox Notebooks](overview/aidbox-ui/aidbox-notebooks.md)
* [REST Console](overview/aidbox-ui/rest-console.md)
* [Database Console](overview/aidbox-ui/database-console.md)
* [Attrs Stats](overview/aidbox-ui/attrs-stats.md)
* [DB Tables](overview/aidbox-ui/db-tables.md)
* [DB Queries](overview/aidbox-ui/db-queries.md)
* [Versioning](overview/versioning.md)
* [Release Notes](overview/release-notes.md)
* [FAQ](overview/faq.md)
Expand Down
Binary file added assets/overview/aidbox-ui/db.mp4
Binary file not shown.
Binary file added assets/overview/aidbox-ui/far.mp4
Binary file not shown.
Binary file added assets/overview/aidbox-ui/rest-4k.mp4
Binary file not shown.
Binary file added assets/overview/aidbox-ui/vd.mp4
Binary file not shown.
59 changes: 50 additions & 9 deletions docs/overview/aidbox-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,57 @@
---
description: Comprehensive user interface for Aidbox FHIR server with REST Console, Database Console, tables, queries, and notebooks for data management.
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 a comprehensive user interface designed to enhance the experience of working with Aidbox, a robust healthcare platform. This UI offers a variety of features and tools that facilitate efficient data management and interaction.
**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.

### Key Aidbox UI components:
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.

- [Rest Console](./rest-console.md)
- [Database Console](./database-console.md)
- [DB tables](./db-tables.md)
- [DB queries](./db-queries.md)
- [Attrs stats](./attrs-stats.md)
- [Aidbox Notebooks](./aidbox-notebooks.md)
## 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 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 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 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 class="w-full rounded-lg" loading="lazy"></video>
{% endtab %}
{% endtabs %}
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/aidbox-notebooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: >-
This doc will help you get a deeper understanding of Aidbox notebooks and how
they can help you on a daily basis.
Expand Down
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/attrs-stats.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: >-
This page will help you get a deeper understanding of the Aidbox Attrs stats
tab and how it can help you on a daily basis.
Expand Down
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/database-console.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: Learn how to use DB Console to work with your Aidbox.
---

Expand Down
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/db-queries.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: Monitor running database queries in Aidbox, detect slow queries, and terminate them with the DB Queries interface.
---

Expand Down
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/db-tables.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: View database table statistics in Aidbox including rows, size, indexes, vacuum status, and disk usage for FHIR resources.
---

Expand Down
1 change: 1 addition & 0 deletions docs/overview/aidbox-ui/rest-console.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
hidden: true
description: Learn how to use REST Console to work with your Aidbox via REST API.
---

Expand Down
Loading