# quicksortrx/universal-med-ids architecture

> Architecture diagram of the GitHub repository quicksortrx/universal-med-ids, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quicksortrx/universal-med-ids
- Repository: https://github.com/quicksortrx/universal-med-ids

## Overview

##### Main Components

a. Data Sources Layer:
- OpenFDA Data Source
- RxNorm Database (rxnorm.db)
- FDA NDC Directory (package.csv, product.csv)
- Medicare Part B Data (optional component)

b. Core Processing Layer:
- QUMI Code Generator
- Data Transformation Pipeline
- Algorithmic Matching Engine

c. Output Layer:
- Universal Medication IDs (CSV format)
- Logging System

**[Data Sources Layer]**
- ↓
**[Core Processing Layer]**
- ↓
**[Output Layer]**

##### Detailed Component Relationships

a. Data Sources Layer:
**[OpenFDA API] → [RxNorm DB] → [FDA NDC Files] → [Medicare Part B Files]**
- ↓              ↓                       ↓
- [Data Ingestion & Validation Layer]

b. Core Processing Layer:
**[Data Transformation Pipeline]**
- ↓
**[Algorithmic Matching Engine]**
- ↓
**[QUMI Code Generator]**

c. Output Layer:
**[Universal Med IDs CSV] ← [Logging System]**

##### Technical Details to Highlight

- Python-based implementation
- File-based data storage
- CSV output format
- Modular design with separate components for:
- Core QUMI generation
- Medicare pricing
- Logging
- Common utilities

##### Key Interactions

- Data flow from source files to QUMI generator
- Validation and transformation steps
- Error handling paths
- Logging points
- Optional Medicare pricing integration

##### Additional Elements

- Data flow directions
- Component types
- Validation points
- Optional vs. required components
- Error handling paths

This system design should clearly communicate both the data processing pipeline and the business rules that ensure accurate medication matching, which is crucial for the project's primary goal of providing universal medication identifiers.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Data Sources Layer
    subgraph DataSources
        OpenFDA[OpenFDA API]:::external
        RxNorm[RxNorm Database]:::external
        FDANDC["FDA NDC Files<br/>(package.csv, product.csv)"]:::external
        Medicare["Medicare Part B Data"]:::external
    end

    %% Core Processing Layer
    subgraph CoreProcessing
        DataIngestion[Data Ingestion & Validation]:::processing
        DataTransform[Data Transformation Pipeline]:::processing
        AlgoMatch[Algorithmic Matching Engine]:::processing
        QumiGen[QUMI Code Generator]:::processing
    end

    %% Output Layer
    subgraph OutputLayer
        UnivMedIDs[Universal Medication IDs]:::output
        LogSystem[Logging System]:::output
        MedicarePricing[Medicare Pricing Integration]:::optional
        MedicarePricingOut[Medicare Pricing Output]:::output
    end

    %% Relationships
    OpenFDA --> DataIngestion
    RxNorm --> DataIngestion
    FDANDC --> DataIngestion
    Medicare --> DataIngestion

    DataIngestion --> DataTransform
    DataTransform --> AlgoMatch
    AlgoMatch --> QumiGen
    QumiGen --> UnivMedIDs
    QumiGen --> LogSystem

    Medicare --> MedicarePricing
    MedicarePricing --> MedicarePricingOut

    %% Click Events
    click QumiGen "https://github.com/QuicksortRx/universal-med-ids/blob/main/qumi-codes.py"
    click LogSystem "https://github.com/QuicksortRx/universal-med-ids/blob/main/src/common/logger_config.py"
    click UnivMedIDs "https://github.com/QuicksortRx/universal-med-ids/blob/main/universal-med-ids.csv"
    click LogSystem "https://github.com/QuicksortRx/universal-med-ids/blob/main/universal-med-ids.log"
    click Medicare "https://github.com/QuicksortRx/universal-med-ids/tree/main/src/medicare_part_b/data/"
    click MedicarePricing "https://github.com/QuicksortRx/universal-med-ids/blob/main/src/medicare_part_b/merge_medicare_pricing.py"
    click MedicarePricingOut "https://github.com/QuicksortRx/universal-med-ids/blob/main/src/medicare_part_b/data/medicare-pricing-merged.csv"

    %% Styles
    classDef external fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef processing fill:#90EE90,stroke:#333,stroke-width:2px
    classDef output fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef optional fill:#E6E6FA,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5

    %% Legend
    subgraph Legend
        L1[External Data Sources]:::external
        L2[Processing Components]:::processing
        L3[Output Components]:::output
        L4[Optional Components]:::optional
    end

    %% Notes
    note["Note:<br/>- 96% accuracy rate for injectable drugs<br/>- Limited handling of biologics<br/>- Preservative-free info limitations"]
```
