Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Admin console

ferroehr-admin-ui is a standalone web console for managing an ITS-REST-1.1.0 CDR — this server or any other. It is a pure REST client: everything it does goes through the CDR’s public API (never the database), so what you see in the console is exactly what the API serves. The whole application is Rust (Leptos SSR + WebAssembly); there is no hand-written JavaScript anywhere, including its browser tests.

Running it

The quickstart compose ships the console as the ferroehr-admin-ui service on port 3000:

docker compose up ferroehr-postgres ferroehr ferroehr-admin-ui
# → http://localhost:3000  (log in with the dev users, e.g. ferroehr/ferroehr)

Standalone, point it at any CDR:

docker run -p 3000:3000 \
  -e FERROEHR_ADMIN__CDR__BASE_URL=https://cdr.example.org \
  ghcr.io/rubentalstra/ferroehr-admin-ui

Signing in

The sign-in page offers exactly the methods that can actually work: the console’s configured login modes intersected with the authentication schemes the CDR advertises (its WWW-Authenticate challenge). A Basic form is never shown against a bearer-only CDR, and vice versa. The page is served fully rendered and works with JavaScript disabled.

The console ships a full dark theme (the toggle persists per browser), and the user menu opens the access drawer:

The access drawer

“View scopes” answers what may this session do, and who says so:

  • the authenticated principal and how it signs in — a Basic session replays its CDR account (and carries no SMART scopes), an OIDC session carries an access token whose scopes are listed;
  • every scope on the session rendered as its parsed grant: the compartment it delegates to (patient / user / system), the resource family and id pattern it reaches, and the create/read/update/delete/search operations it permits — with a broad access marker on a bare *;
  • a previewer: paste any scope string, or a whole space-separated claim, and read the same rendering. A scope shaped like a resource scope but malformed explains what the grammar expected instead of quietly reading as nothing.

The reading is not the console’s own interpretation: it parses with the same module the CDR’s SMART scope gate enforces with, so the two can never drift. Scopes narrow access and never grant it — the CDR remains the enforcer, and a previewed grant is an upper bound.

Configuration

One TOML file (ferroehr-admin-ui.toml, searched in the working directory and /etc/ferroehr/admin-ui.toml, or pointed at with FERROEHR_ADMIN_CONFIG), with FERROEHR_ADMIN__<SECTION>__<KEY> environment overrides:

KeyDefaultMeaning
cdr.base_urlhttp://localhost:8080The CDR origin (the ITS-REST base path is appended).
cdr.request_timeout_secs30Per-request timeout toward the CDR.
cdr.management_base_url{cdr.base_url}/managementThe CDR’s management surface, base path included — set it when the CDR serves management on its own internal listener (management.port) or under a renamed base path. Drives the Operations panel.
auth.basic_enabledtrueOffer the username/password form (validated against the CDR; held server-side).
auth.oidc.enabledfalseOffer OIDC login (authorization code + PKCE).
auth.oidc.issuer / client_id / client_secret (_file) / public_base_url / scopesThe OIDC client registration; public_base_url is the console’s externally visible origin for the redirect URI.
session.idle_minutes60Session idle expiry.
session.cookie_securefalseSet behind TLS.

The console is stateless apart from its in-process session store: it has no database and keeps no local files of its own. Everything it shows — including how stored queries are grouped, which is derived from the namespace in each query’s qualified name — lives in the CDR and is read over ITS-REST, so two console replicas always agree and nothing needs backing up.

Login and sessions live in the console’s backend; CDR credentials and bearer tokens never reach the browser.

The screens

  • Dashboard — record counts, per-namespace stored-query match tiles, and a commit-activity trend. See Dashboard & queries.
  • Templates — upload and inspect operational templates. See Templates & EHR browsing.
  • Queries — the point-and-click Query Builder, the raw AQL editor, and stored-query management. See Dashboard & queries.
  • EHRs — browse EHRs, folders, compositions, and version history. See Templates & EHR browsing.
  • Audit log — browse the CDR’s ATNA security audit trail (see below).
  • System — CDR status, the openEHR conformance manifest (what the server advertises about itself through the System API: product, vendor, claimed conformance profile, and the API groups it actually mounts), SMART discovery, repository usage, the server’s own OpenAPI documents — pick the complete surface or one API family, and the choice stays in the URL — the redacted runtime configuration, and a shortcut into the audit browser.
  • Operations — dependency health, build and spec provenance, the metric registry, and runtime log control. Appears only when the CDR serves its management surface. See Operations panel.

Paging

Every listing is paged, and the page lives in the URL — a page is shareable and bookmarkable, a reload lands on the same rows, and the browser’s back and forward buttons walk the pages. The tables the console holds in full (Templates, Queries) share one footer under the table: which rows are on screen out of how many (26–50 of 137 templates), previous/next, and a rows-per-page choice of 25/50/100 — ?page= and ?size=. The AQL-backed listings (EHRs, an EHR’s compositions) page through ?offset= links, and the audit browser through ?page= beside its filters. Every one of these controls is a plain link, so paging works before the page’s WebAssembly loads.

Audit log

The Audit log screen browses the CDR’s security audit trail — who accessed what, with what outcome — through the standard IHE ITI-81 retrieval (GET /fhir/r4/AuditEvent; see the Audit trail chapter). Filter by event-time window, patient, principal, outcome, or action; every filter lives in the URL, so a filtered view is shareable and refresh-safe. Each row opens the full stored FHIR AuditEvent record.

The audit trail is an operator surface: under role-based access control the screen requires the CDR’s admin role, and when the CDR’s local audit store is disabled the screen says so instead of erroring.

Each row’s view disclosure opens the full stored FHIR AuditEvent record — exactly what the ITI-81 API serves:

A filter that matches nothing renders a distinct empty state, so “no records” is always visibly different from “records you haven’t found”: