How ferrohealth/ferroehr works
FerroEHR is an openEHR clinical data repository: applications submit versioned clinical records and queries through its REST interface, which mediates access and delegates operations to the database-backed service. The repository also includes the FerroEHR Viewer and integrations for terminology, change feeds, and multimedia. The graph reflects documented product capabilities and sampled routing/state code; most domain handlers and service internals were not sampled, so their internal call paths are not asserted.
Main entry points: mod.rs API hub · lib.rs CDR service · state.rs Shared app state · openapi_routes.rs EHR operations
Components 24
Clients
- Clinical applications
REST and access
- REST router
app/ferroehr-rest/src/router.rs - API hub
app/ferroehr-rest/src/api/mod.rs - Shared app state
app/ferroehr-rest/src/state.rs - Access controls
app/ferroehr-rest/src/extensions/access/admission.rs - EHR operations
app/ferroehr-rest/src/api/ehr/openapi_routes.rs - Demographics API
app/ferroehr-rest/src/api/demographic/party.rs - Administrative API
app/ferroehr-rest/src/api/admin/operations.rs - Query API
app/ferroehr-rest/src/api/query/openapi_routes.rs - Format dispatch
app/ferroehr-rest/src/formats/dispatch.rs - Version committal
app/ferroehr-rest/src/overview/committal.rs - Version identifiers
app/ferroehr-rest/src/overview/version_id.rs - Request audit
app/ferroehr-rest/src/system_log/middleware.rs
Clinical services
- CDR service
app/ferroehr-server/src/lib.rs - AQL engine
app/ferroehr/src/aql/exec.rs - Templates and validation
app/ferroehr/src/service/definition/adl2_engine.rs - Identifier protection
app/ferroehr/src/identifier_protection/engine.rs - PostgreSQL store
app/ferroehr/src/db/pool.rs
Integrations
- Terminology service
app/ferroehr-rest/src/extensions/terminology.rs - Change-event feed
app/ferroehr/src/extensions/outbox/mod.rs - Multimedia storage
app/ferroehr-ext/src/multimedia/blob.rs
Viewer
- Web viewer
app/ferroehr-viewer/src/routes.rs - Viewer requests
app/ferroehr-viewer/src/request.rs - Viewer authorization scope
app/ferroehr-viewer/src/scope.rs
Connections 29
- Clinical applications → REST router: send requests
- REST router → API hub: routes requests
app/ferroehr-rest/src/api/mod.rs - API hub → Access controls: checks access
app/ferroehr-rest/src/api/mod.rs - API hub → EHR operations: dispatches EHR
app/ferroehr-rest/src/api/ehr/openapi_routes.rs - API hub → Demographics API: dispatches demographics
app/ferroehr-rest/src/api/demographic/party.rs - API hub → Administrative API: dispatches admin
app/ferroehr-rest/src/api/admin/openapi_routes.rs - API hub → Query API: dispatches queries
app/ferroehr-rest/src/api/query/openapi_routes.rs - API hub → Shared app state: provides state
app/ferroehr-rest/src/state.rs - EHR operations → Shared app state: uses state
app/ferroehr-rest/src/api/ehr/openapi_routes.rs - Demographics API → Shared app state: uses state
app/ferroehr-rest/src/api/demographic/party.rs - Administrative API → Shared app state: uses state
app/ferroehr-rest/src/api/admin/operations.rs - Query API → Shared app state: uses state
app/ferroehr-rest/src/api/query/openapi_routes.rs - Shared app state → CDR service: holds service
app/ferroehr-rest/src/state.rs - EHR operations → Version committal: commits versions
- EHR operations → Format dispatch: negotiates formats
- Demographics API → Format dispatch: dispatches formats
app/ferroehr-rest/src/api/demographic/party.rs - Demographics API → Version identifiers: uses version IDs
app/ferroehr-rest/src/api/demographic/party.rs - API hub → Request audit: logs requests
app/ferroehr-rest/src/api/mod.rs - CDR service → PostgreSQL store: persists records
- Query API → AQL engine: executes AQL
- CDR service → Templates and validation: validates templates
- CDR service → Identifier protection: protects identifiers
- CDR service → Change-event feed: publishes changes
- Clinical applications → Terminology service: uses terminology
- CDR service → Multimedia storage: stores media
- Clinical applications → Web viewer: uses viewer
- Web viewer → Viewer requests: handles requests
app/ferroehr-viewer/src/routes.rs - Viewer requests → Viewer authorization scope: checks scope
app/ferroehr-viewer/src/request.rs - Web viewer → REST router: calls public API