# openmrs/openmrs-esm-patient-chart architecture

> Architecture diagram of the GitHub repository openmrs/openmrs-esm-patient-chart, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openmrs/openmrs-esm-patient-chart
- Repository: https://github.com/openmrs/openmrs-esm-patient-chart

## Overview

##### Main Components

a. Core Application Layer:
- Patient Chart Core (esm-patient-chart-app)
- Common Library (esm-patient-common-lib)
- Form Engine & Entry System (esm-form-engine-app, esm-form-entry-app)

b. Feature Modules Layer:
- Clinical Modules (Allergies, Conditions, Immunizations)
- Documentation Modules (Notes, Forms, Attachments)
- Monitoring Modules (Vitals, Tests, Medications)
- Administrative Modules (Programs, Lists)

c. UI Components Layer:
- Patient Banner
- Navigation Menu
- Workspace Components
- Dashboard Widgets

##### Relationships

a. Data Flow:
- API interactions with backend services
- Form submission flows
- Patient data access patterns

b. Dependencies:
- Common library usage by feature modules
- Form engine integration points
- Shared service utilization

##### Architectural Patterns to Highlight

a. Microfrontend Architecture:
- Module isolation
- Dynamic loading boundaries
- Shared state management

b. Component Communication:
- Event-based communication channels
- Shared state mechanisms
- Extension points

- Browser/Client              |

- ↓

- OpenMRS 3.0 SPA Framework        |

- ↓

- Core Layer     |    Feature Layer    |
- Chart Core     | - Clinical Modules  |
- Common Lib     | - Doc Modules       |
- Form Engine    | - Monitoring Modules|

- ↓

- UI Components Layer           |
- Banner  - Navigation  - Workspace      |

- ↓

- Backend Services              |

##### Implementation Details

a. Technical elements:
- Translation support (i18n)
- Testing infrastructure
- Configuration management
- Offline capabilities

b. Integration points:
- REST API connections
- FHIR resource handling
- External system interfaces

##### Notes

Annotations for:
- Key configuration points
- Scalability considerations
- Security boundaries
- Performance optimization points

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#333
    classDef feature fill:#b3ffb3,stroke:#333
    classDef ui fill:#ffd9b3,stroke:#333
    classDef framework fill:#e6e6e6,stroke:#333
    classDef backend fill:#d9d9d9,stroke:#333

    %% Browser Layer
    Browser["Browser/Client"]:::framework

    %% OpenMRS Framework Layer
    Framework["OpenMRS 3.0 SPA Framework"]:::framework

    %% Core Layer
    subgraph CoreLayer["Core Layer"]
        ChartCore["Patient Chart Core"]:::core
        CommonLib["Common Library"]:::core
        FormEngine["Form Engine"]:::core
        FormEntry["Form Entry System"]:::core
    end

    %% Feature Modules Layer
    subgraph FeatureLayer["Feature Modules Layer"]
        subgraph Clinical["Clinical Modules"]
            Allergies["Allergies"]:::feature
            Conditions["Conditions"]:::feature
            Immunizations["Immunizations"]:::feature
        end

        subgraph Documentation["Documentation Modules"]
            Notes["Notes"]:::feature
            Forms["Forms"]:::feature
            Attachments["Attachments"]:::feature
        end

        subgraph Monitoring["Monitoring Modules"]
            Vitals["Vitals"]:::feature
            Tests["Tests"]:::feature
            Medications["Medications"]:::feature
        end

        subgraph Administrative["Administrative Modules"]
            Programs["Programs"]:::feature
            Lists["Lists"]:::feature
        end
    end

    %% UI Components Layer
    subgraph UILayer["UI Components Layer"]
        Banner["Patient Banner"]:::ui
        Flags["Patient Flags"]:::ui
    end

    %% Backend Layer
    Backend["Backend Services"]:::backend

    %% Relationships
    Browser --> Framework
    Framework --> ChartCore
    ChartCore --> CommonLib
    ChartCore --> FormEngine
    FormEngine --> FormEntry

    %% Feature Module Dependencies
    CommonLib --> Clinical
    CommonLib --> Documentation
    CommonLib --> Monitoring
    CommonLib --> Administrative

    %% UI Integration
    Clinical --> Banner
    Documentation --> Banner
    Monitoring --> Banner
    Administrative --> Banner
    Banner --> Backend

    %% Click Events
    click ChartCore "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-chart-app"
    click CommonLib "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-common-lib"
    click FormEngine "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-form-engine-app"
    click FormEntry "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-form-entry-app"
    click Allergies "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-allergies-app"
    click Conditions "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-conditions-app"
    click Immunizations "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-immunizations-app"
    click Notes "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-notes-app"
    click Forms "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-forms-app"
    click Attachments "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-attachments-app"
    click Vitals "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-vitals-app"
    click Tests "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-tests-app"
    click Medications "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-medications-app"
    click Programs "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-programs-app"
    click Lists "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-lists-app"
    click Banner "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-banner-app"
    click Flags "https://github.com/openmrs/openmrs-esm-patient-chart/tree/main//packages/esm-patient-flags-app"
```
