Desktop Electron EHR — specification pack
This folder defines normative requirements and design for the Ghasi EHR desktop client (Electron), with offline-first behavior and UI parity with apps/ehr-web.
Authority and reading order
| Rule | Detail |
|---|---|
| Specs vs docs | When ambiguous, specs/ wins over docs/. |
| Platform offline | This pack extends OFFLINE_FIRST_AND_CLIENT_SYNC.md and the offline-first/ pack; do not contradict FR-OFF / NFR-OFF / TR-OFF unless this folder explicitly narrows client technology. |
| Module behavior | Per-module rules remain in specs/modules/<module>/SPEC.md and related files. |
| Frontend index | See also docs/ehr-frontend-specs-index.md. |
Suggested read order for implementers:
- EHEALTH_DESKTOP_PLATFORM_REQUIREMENTS.md — program-level implementation-ready requirements (Electron stack, all modules, REQ-DESK-* IDs for Jira).
- SPEC.md — scope, personas, offline vs online-only.
- TECHNICAL_REQUIREMENTS.md — Electron, storage, sync, security.
- SOLUTION_DESIGN.md — processes, IPC, Kong, sequences.
- UI_AND_DESIGN_PARITY.md — Berry/MUI parity with
ehr-web. - BACKEND_AND_SERVICE_MAP.md — services and API pointers.
- IMPLEMENTATION_ROADMAP.md — phased delivery.
- TRACEABILITY_MATRIX.md — requirements to verification (includes REQ-DESK + DESK-US).
- backlog/ — epics, unified user stories, linkage, Jira ADF (
backlog/adf/*.adf.json), implementation status. - AI_AGENT_BUILD_GUIDE.md — monorepo steps, env, DoD.
Document index
| Document | Purpose |
|---|---|
| EHEALTH_DESKTOP_PLATFORM_REQUIREMENTS.md | Cross-module desktop program requirements (Electron); Jira-oriented REQ-DESK-* |
| SPEC.md | Functional requirements, personas, acceptance criteria |
| TECHNICAL_REQUIREMENTS.md | TR-DSK-* technical requirements (stack, outbox, sync) |
| SOLUTION_DESIGN.md | Architecture and sequence diagrams |
| UI_AND_DESIGN_PARITY.md | Theme, design system, offline/sync UX |
| BACKEND_AND_SERVICE_MAP.md | Persona/feature → module → service → APIs |
| IMPLEMENTATION_ROADMAP.md | Phases and dependencies |
| TRACEABILITY_MATRIX.md | Traceability matrix (FR-DSK / TR-DSK / REQ-DESK / DESK-US) |
| backlog/README.md | Jira-oriented backlog: EPICS, UNIFIED_USER_STORIES, LINKAGE, ADF |
| AI_AGENT_BUILD_GUIDE.md | Build guide for automation and engineers |
Related platform documents
- ../OFFLINE_FIRST_AND_CLIENT_SYNC.md
- ../offline-first/SPEC.md
- ../offline-first/TECHNICAL_REQUIREMENTS.md
- ../API_PATH_CONVENTIONS.md
- ../COMPLIANCE_SECURITY.md
- ../REGIONAL_PROFILE.md — locales, RTL, calendars, identifiers
- ../AI_PLATFORM.md — cloud orchestrator, on-device policy, offline behavior
- ../../governance-auth/README.md
- ../../../MODULE_INDEX.md