56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
|
# CLQMS Technical Documentation Index
|
||
|
|
|
||
|
|
This repository serves as the central knowledge base for the CLQMS Backend. It contains architectural proposals, API contracts, and design reviews that guide the development of the clinical laboratory management system.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 🏗️ Architectural Redesign (Manager's Proposal)
|
||
|
|
|
||
|
|
The system is currently transitioning to a consolidated database schema to enhance performance and maintainability. This is a critical initiative aimed at reducing schema complexity.
|
||
|
|
|
||
|
|
- **[Detailed Redesign Proposal](./20251216002-Test_OrderTest_RefRange_schema_redesign_proposal.md)**
|
||
|
|
- *Focus:* Consolidating 13 legacy tables into 7 optimized tables.
|
||
|
|
- *Modules Impacted:* Test Definition, Reference Ranges, and Order Management.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 🛠️ Functional Modules
|
||
|
|
|
||
|
|
### 1. Test Management
|
||
|
|
Handles the definition of laboratory tests, including technical specifications, calculation formulas, and external system mappings.
|
||
|
|
- See: `tests` table and `test_panels` in the redesign proposal.
|
||
|
|
|
||
|
|
### 2. Patient & Order Workflow
|
||
|
|
Manages the lifecycle of a laboratory order:
|
||
|
|
- **[Patient Registration API Contract](./api_contract_patient_registration.md)**: Specifications for patient intake and data validation.
|
||
|
|
- **Order Tracking**: From collection and receipt to technical verification.
|
||
|
|
|
||
|
|
### 3. Reference Range Engine
|
||
|
|
A unified logic for determining normal and critical flags across various test types.
|
||
|
|
- *Types supported:* Numeric, Threshold (Cut-off), Textual, and Coded (Value Sets).
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 📊 Design Reviews & Legacy Reference
|
||
|
|
|
||
|
|
Documentation regarding the initial assessments and legacy structures:
|
||
|
|
- **[Database Design Review - Sonnet](./20251212001-database_design_review_sonnet.md)**: Comprehensive analysis of legacy table relationships and bottlenecks.
|
||
|
|
- **[Database Design Review - Opus](./20251212002-database_design_review_opus.md)**: Additional perspectives on the initial system architecture.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 🛡️ Development Standards
|
||
|
|
|
||
|
|
All contributions to the CLQMS backend must adhere to the following:
|
||
|
|
1. **Data Integrity:** All database migrations must include data validation scripts.
|
||
|
|
2. **Auditability:** Status changes in the `orders` module must be logged in `order_history`.
|
||
|
|
3. **Security:** Every endpoint requires JWT authentication.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### 📜 Administration
|
||
|
|
Documentation maintained by the **5Panda Team**.
|
||
|
|
|
||
|
|
---
|
||
|
|
*Built with ❤️ by the 5Panda Team.*
|