|
1 | 1 | --- |
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. |
3 | 3 | --- |
4 | 4 |
|
5 | 5 | # Aidbox UI |
6 | 6 |
|
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. |
8 | 8 |
|
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. |
10 | 10 |
|
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 %} |
0 commit comments