fluxq-engine 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,35 +1,44 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FluxQ Engine ― Telemedicine Queue Optimizer
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
◆ **Overview**
|
|
4
|
+
FluxQ Engine is a high-performance REST API and core logic engine built for clinical-aware patient triage and intelligent queue management. It optimizes wait times by up to 40% using advanced clinical weight balancing and fairness enforcement.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
### 🌐 Live API Usage
|
|
8
|
-
**Base URL**: `https://fluxq.onrender.com`
|
|
9
|
-
**Health Check**: [Online](https://fluxq.onrender.com/health)
|
|
6
|
+
◈ **NPM Package**: [fluxq-engine](https://www.npmjs.com/package/fluxq-engine)
|
|
7
|
+
◈ **Live API Status**: [fluxq.onrender.com](https://fluxq.onrender.com/health)
|
|
10
8
|
|
|
11
9
|
---
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
- **Smart Triage Engine**: Dynamic symptom assessment and severity classification.
|
|
15
|
-
- **Queue Optimization**: Real-time reordering based on clinical severity and fairness thresholds.
|
|
16
|
-
- **Fairness Monitoring**: Aging boosts and starvation risk alerts.
|
|
17
|
-
- **Simulate & Metrics**: Full baseline vs. optimized comparison with 9+ performance KPIs.
|
|
11
|
+
◆ **Features**
|
|
18
12
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
- **Run Simulation**: `POST /api/v1/simulate`
|
|
13
|
+
• **Smart Triage Logic**: Dynamic symptom assessment and severity classification.
|
|
14
|
+
• **Queue Optimization**: Real-time reordering based on clinical severity and fairness thresholds.
|
|
15
|
+
• **Fairness Monitoring**: Dynamic aging boosts and starvation risk tracking.
|
|
16
|
+
• **Comprehensive Metrics**: Provides full baseline vs. optimized comparisons with 9+ performance KPIs.
|
|
24
17
|
|
|
25
|
-
|
|
18
|
+
◆ **Quick Start**
|
|
19
|
+
|
|
20
|
+
▶ **Installation**
|
|
26
21
|
```bash
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
22
|
+
npm install fluxq-engine
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
▶ **Usage**
|
|
26
|
+
```typescript
|
|
27
|
+
import { QueueOptimizer } from 'fluxq-engine';
|
|
28
|
+
|
|
29
|
+
const optimizer = new QueueOptimizer();
|
|
30
|
+
const optimizedQueue = optimizer.optimize(patients, config);
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
+
◆ **API Connectivity**
|
|
34
|
+
◈ `GET /api/v1/config` ― Get current system optimization parameters.
|
|
35
|
+
◈ `POST /api/v1/optimize` ― Submit a patient list for instant re-ordering.
|
|
36
|
+
◈ `POST /api/v1/simulate` ― Run a complete FCFS vs. AI comparison.
|
|
37
|
+
|
|
33
38
|
---
|
|
39
|
+
◆ **Development**
|
|
40
|
+
◈ **Developed by [Diksha](https://github.com/dikshaa2909)**
|
|
41
|
+
◈ Built using Node.js, TypeScript, and Express.
|
|
34
42
|
|
|
35
|
-
|
|
43
|
+
---
|
|
44
|
+
◈ **FluxQ Engine ― 2026**
|
package/package.json
CHANGED