# avniproject/avni-models architecture

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

- Interactive diagram: https://gitdiagram.com/avniproject/avni-models
- Repository: https://github.com/avniproject/avni-models

## Overview

##### Main Components

a. Core Domain Models Layer:
- Related entities into logical clusters:
- Subject Management (Individual.js, Family.js, SubjectType.js)
- Clinical (Encounter.js, ProgramEncounter.js, ProgramEnrolment.js)
- Observation Models (Observation.js, ObservationsHolder.js)
- Metadata (EntityMetaData.js, Schema.js)
- Rules Engine (Rule.js, EntityRule.js, RuleDependency.js)

b. Application Layer:
- Forms Subsystem (application/Form.js, FormElement.js, FormMapping.js)
- Workflow Management (WorkItem.js, WorkList.js)
- Dashboard & Reporting (Dashboard.js, ReportCard.js)

c. Framework Layer:
- Realm Database Integration (framework/RealmProxy.js, RealmObjectSchema.js)
- Utility Services (utility/*)

**[Frontend Clients]**
- ↓
**[Models Package Interface (index.js)]**
- ↓
**┌─────────────────────────────────────┐**
- Domain Models             │
- ┤
- • Subject Domain                    │
- • Clinical Domain                   │
- • Observation Domain                │
- • Metadata Management               │
- ┘
- ↕
**┌─────────────────────────────────────┐**
- Application Layer           │
- ┤
- • Forms Management                  │
- • Work Management                   │
- • Reporting & Analytics             │
- ┘
- ↕
**┌─────────────────────────────────────┐**
- Framework Layer             │
- ┤
- • Realm DB Integration             │
- • Utility Services                 │
- ┘

##### Important Details to Highlight

a. Entity Relationships:
- Inheritance from BaseEntity.js
- Relationships between clinical entities (Program → ProgramEnrolment → ProgramEncounter)
- Form structure relationships

b. Cross-Cutting Concerns:
- Sync functionality (EntitySyncStatus.js)
- Validation system (ValidationResults.js)
- Translation/localization (Translation.js, LocaleMapping.js)

##### Notes for Implementation
- Use standard UML notation where appropriate
- Version information
- Document sync/persistence capabilities

## Diagram (Mermaid)

```mermaid
graph TB
    classDef domain fill:#b3d9ff,stroke:#333
    classDef application fill:#90EE90,stroke:#333
    classDef framework fill:#d3d3d3,stroke:#333
    classDef external fill:#ffa500,stroke:#333

    Frontend["Frontend Clients"]:::external

    subgraph DomainModels["Domain Models Layer"]
        SubjectMgmt["Subject Management"]:::domain
        ClinicalDomain["Clinical Domain"]:::domain
        ObservationModels["Observation Models"]:::domain
        MetadataMgmt["Metadata Management"]:::domain
        RulesEngine["Rules Engine"]:::domain
        RelationshipMgmt["Relationship Management"]:::domain
    end

    subgraph ApplicationLayer["Application Layer"]
        FormsSys["Forms Subsystem"]:::application
        WorkflowMgmt["Workflow Management"]:::application
        DashboardReport["Dashboard & Reporting"]:::application
        TaskMgmt["Task Management"]:::application
        ErrorHandling["Error Handling"]:::application
    end

    subgraph FrameworkLayer["Framework Layer"]
        RealmDB["Realm Database Integration"]:::framework
        UtilityServices["Utility Services"]:::framework
    end

    Frontend --> DomainModels
    DomainModels <--> ApplicationLayer
    ApplicationLayer <--> FrameworkLayer

    %% Click events for components
    click SubjectMgmt "https://github.com/avniproject/avni-models/blob/master/src/Individual.js"
    click ClinicalDomain "https://github.com/avniproject/avni-models/blob/master/src/Program.ts"
    click ObservationModels "https://github.com/avniproject/avni-models/tree/master/src/observation"
    click MetadataMgmt "https://github.com/avniproject/avni-models/blob/master/src/service/MetaDataService.js"
    click RulesEngine "https://github.com/avniproject/avni-models/blob/master/src/Rule.js"
    click RelationshipMgmt "https://github.com/avniproject/avni-models/tree/master/src/relationship"
    click FormsSys "https://github.com/avniproject/avni-models/blob/master/src/application/Form.js"
    click WorkflowMgmt "https://github.com/avniproject/avni-models/blob/master/src/application/WorkItem.js"
    click DashboardReport "https://github.com/avniproject/avni-models/tree/master/src/reports"
    click TaskMgmt "https://github.com/avniproject/avni-models/tree/master/src/task"
    click ErrorHandling "https://github.com/avniproject/avni-models/tree/master/src/error"
    click RealmDB "https://github.com/avniproject/avni-models/blob/master/src/framework/RealmProxy.js"
    click UtilityServices "https://github.com/avniproject/avni-models/tree/master/src/utility"

    %% Legend
    subgraph Legend
        DomainNode["Domain Component"]:::domain
        AppNode["Application Component"]:::application
        FrmNode["Framework Component"]:::framework
        ExtNode["External Component"]:::external
    end
```
