Skip to content

Commit 466043c

Browse files
authored
Merge pull request #4 from HealthSamurai/aidbox-ui-page
docs(aidbox-ui): rewrite Aidbox UI page as single landing page
2 parents 447c658 + ee9bf57 commit 466043c

File tree

12 files changed

+56
-15
lines changed

12 files changed

+56
-15
lines changed

SUMMARY.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,6 @@
139139
* [Licenses](overview/aidbox-user-portal/licenses.md)
140140
* [Members](overview/aidbox-user-portal/members.md)
141141
* [Aidbox UI](overview/aidbox-ui/README.md)
142-
* [Aidbox Notebooks](overview/aidbox-ui/aidbox-notebooks.md)
143-
* [REST Console](overview/aidbox-ui/rest-console.md)
144-
* [Database Console](overview/aidbox-ui/database-console.md)
145-
* [Attrs Stats](overview/aidbox-ui/attrs-stats.md)
146-
* [DB Tables](overview/aidbox-ui/db-tables.md)
147-
* [DB Queries](overview/aidbox-ui/db-queries.md)
148142
* [Versioning](overview/versioning.md)
149143
* [Release Notes](overview/release-notes.md)
150144
* [FAQ](overview/faq.md)

assets/overview/aidbox-ui/db.mp4

25.3 MB
Binary file not shown.

assets/overview/aidbox-ui/far.mp4

14.1 MB
Binary file not shown.
19.8 MB
Binary file not shown.

assets/overview/aidbox-ui/vd.mp4

10.6 MB
Binary file not shown.

docs/overview/aidbox-ui/README.md

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,57 @@
11
---
2-
description: Comprehensive user interface for Aidbox FHIR server with REST Console, Database Console, tables, queries, and notebooks for data management.
2+
description: Open-source administration console for Aidbox FHIR server with Resource Browser, REST Console, SQL Console, FHIR packages, Audit Events, and Settings.
33
---
44

55
# Aidbox UI
66

7-
**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.
7+
**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.
88

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

11-
- [Rest Console](./rest-console.md)
12-
- [Database Console](./database-console.md)
13-
- [DB tables](./db-tables.md)
14-
- [DB queries](./db-queries.md)
15-
- [Attrs stats](./attrs-stats.md)
16-
- [Aidbox Notebooks](./aidbox-notebooks.md)
11+
## Key components
12+
13+
### Resource Browser
14+
15+
Browse, search, create, and edit FHIR resources stored in Aidbox. The Resource Browser supports search parameters, sorting, and inline JSON editing.
16+
17+
Some resource types have specialized views:
18+
19+
* **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.
20+
* **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.
21+
22+
### REST Console
23+
24+
An interactive HTTP client built into Aidbox. Use it to execute REST API requests, inspect responses, and build collections of saved queries.
25+
26+
### SQL Console
27+
28+
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.
29+
30+
### FHIR Packages
31+
32+
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.
33+
34+
### Audit Events
35+
36+
View and search [AuditEvent](../../access-control/audit-and-logging.md) resources generated by Aidbox, with filtering by date, type, and agent.
37+
38+
### Settings
39+
40+
Configure Aidbox instance settings from the UI.
41+
42+
## Screenshots and videos
43+
44+
{% tabs %}
45+
{% tab title="DB Console" %}
46+
<video src="../../assets/overview/aidbox-ui/db.mp4" autoplay loop muted playsinline class="w-full rounded-lg" loading="lazy"></video>
47+
{% endtab %}
48+
{% tab title="REST Console" %}
49+
<video src="../../assets/overview/aidbox-ui/rest-4k.mp4" autoplay loop muted playsinline class="w-full rounded-lg" loading="lazy"></video>
50+
{% endtab %}
51+
{% tab title="ViewDefinition Builder" %}
52+
<video src="../../assets/overview/aidbox-ui/vd.mp4" autoplay loop muted playsinline class="w-full rounded-lg" loading="lazy"></video>
53+
{% endtab %}
54+
{% tab title="FHIR Packages" %}
55+
<video src="../../assets/overview/aidbox-ui/far.mp4" autoplay loop muted playsinline class="w-full rounded-lg" loading="lazy"></video>
56+
{% endtab %}
57+
{% endtabs %}

docs/overview/aidbox-ui/aidbox-notebooks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
hidden: true
23
description: >-
34
This doc will help you get a deeper understanding of Aidbox notebooks and how
45
they can help you on a daily basis.

docs/overview/aidbox-ui/attrs-stats.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
hidden: true
23
description: >-
34
This page will help you get a deeper understanding of the Aidbox Attrs stats
45
tab and how it can help you on a daily basis.

docs/overview/aidbox-ui/database-console.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
hidden: true
23
description: Learn how to use DB Console to work with your Aidbox.
34
---
45

docs/overview/aidbox-ui/db-queries.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
hidden: true
23
description: Monitor running database queries in Aidbox, detect slow queries, and terminate them with the DB Queries interface.
34
---
45

0 commit comments

Comments
 (0)