fluxq-engine 1.0.0 → 1.0.2
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 +50 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,35 +1,64 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FluxQ Engine ● Telemedicine Queue Optimizer
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://nodejs.org)
|
|
4
|
+
[](https://www.typescriptlang.org)
|
|
5
|
+
[](https://expressjs.com)
|
|
6
|
+
[](https://www.npmjs.com/package/fluxq-engine)
|
|
4
7
|
|
|
5
8
|
---
|
|
6
9
|
|
|
7
|
-
###
|
|
8
|
-
|
|
9
|
-
|
|
10
|
+
### ● Overview
|
|
11
|
+
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.
|
|
12
|
+
|
|
13
|
+
◈ **NPM Package**: [fluxq-engine](https://www.npmjs.com/package/fluxq-engine)
|
|
14
|
+
◈ **Live API Status**: [Online (Render)](https://fluxq.onrender.com/health)
|
|
10
15
|
|
|
11
16
|
---
|
|
12
17
|
|
|
13
|
-
###
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
+
### ● Key Features
|
|
19
|
+
|
|
20
|
+
#### ┃ 0x01 ― Smart Triage Logic
|
|
21
|
+
› Dynamic symptom assessment and severity classification.
|
|
22
|
+
› Clinical priority scoring (Severity × Wait Time × Fairness).
|
|
23
|
+
|
|
24
|
+
#### ┃ 0x02 ― Queue Optimization
|
|
25
|
+
› Real-time reordering based on clinical severity and fairness thresholds.
|
|
26
|
+
› Starvation prevention and dynamic aging boosts.
|
|
27
|
+
|
|
28
|
+
#### ┃ 0x03 ― Fairness Monitoring
|
|
29
|
+
› Real-time identification of starvation risks.
|
|
30
|
+
› Fairness reports with aging boost tracking.
|
|
31
|
+
|
|
32
|
+
#### ┃ 0x04 ― Simulation & Metrics
|
|
33
|
+
› High-level KPIs: Wait time reduction, doctor utilization, and throughput.
|
|
34
|
+
› Full baseline vs. optimized comparison reporting.
|
|
35
|
+
|
|
36
|
+
---
|
|
18
37
|
|
|
19
|
-
###
|
|
20
|
-
You can use this API in any project:
|
|
21
|
-
- **Get Config**: `GET /api/v1/config`
|
|
22
|
-
- **Optimize Queue**: `POST /api/v1/optimize`
|
|
23
|
-
- **Run Simulation**: `POST /api/v1/simulate`
|
|
38
|
+
### ● Quick Start
|
|
24
39
|
|
|
25
|
-
|
|
40
|
+
▶ **Installation**
|
|
26
41
|
```bash
|
|
27
|
-
|
|
28
|
-
cd server
|
|
29
|
-
npm install
|
|
30
|
-
npm start
|
|
42
|
+
npm install fluxq-engine
|
|
31
43
|
```
|
|
32
44
|
|
|
45
|
+
▶ **API Client Library Usage**
|
|
46
|
+
```typescript
|
|
47
|
+
import { QueueOptimizer } from 'fluxq-engine';
|
|
48
|
+
|
|
49
|
+
const optimizer = new QueueOptimizer();
|
|
50
|
+
const optimizedQueue = optimizer.optimize(patients, config);
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
▶ **Direct API Connectivity**
|
|
54
|
+
◈ `GET /api/v1/config` ― Get current system optimization parameters.
|
|
55
|
+
◈ `POST /api/v1/optimize` ― Submit a patient list for instant re-ordering.
|
|
56
|
+
◈ `POST /api/v1/simulate` ― Run a complete FCFS vs. AI comparison.
|
|
57
|
+
|
|
33
58
|
---
|
|
34
59
|
|
|
35
|
-
|
|
60
|
+
### ● Developer
|
|
61
|
+
◈ **Built by [Diksha](https://github.com/dikshaa2909)**
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
◈ **FluxQ Engine ― 2026**
|
package/package.json
CHANGED