1- # AI-Powered Medical Documentation Assistant
1+ < div align = " center " >
22
3- ## Quick Start
3+ # 🏥 ScribeMed
4+
5+ ** AI-Powered Medical Documentation Assistant**
6+
7+ _ Streamlining healthcare documentation with intelligent transcription, coding, and clinical note generation_
8+
9+ [ ![ Node.js] ( https://img.shields.io/badge/Node.js-18%2B-green?logo=node.js )] ( https://nodejs.org/ )
10+ [ ![ PNPM] ( https://img.shields.io/badge/PNPM-8%2B-orange?logo=pnpm )] ( https://pnpm.io/ )
11+ [ ![ TypeScript] ( https://img.shields.io/badge/TypeScript-5.2%2B-blue?logo=typescript )] ( https://www.typescriptlang.org/ )
12+ [ ![ PostgreSQL] ( https://img.shields.io/badge/PostgreSQL-15%2B-blue?logo=postgresql )] ( https://www.postgresql.org/ )
13+ [ ![ License] ( https://img.shields.io/badge/license-Private-red )] ( LICENSE )
14+
15+ </div >
16+
17+ ---
18+
19+ ## ✨ Overview
20+
21+ ScribeMed is a comprehensive healthcare documentation platform that leverages AI to automate medical transcription, clinical coding, and documentation workflows. Built as a modern monorepo, it provides scalable microservices architecture for healthcare organizations seeking to reduce administrative burden and improve documentation accuracy.
22+
23+ ### 🎯 Key Features
24+
25+ - 🎤 ** Real-time Audio Transcription** - High-accuracy speech-to-text for clinical encounters
26+ - 📝 ** Intelligent Documentation** - AI-powered clinical note generation
27+ - 🏷️ ** Automated Coding** - ICD-10 and CPT code suggestions
28+ - 🔍 ** RAG-Powered Retrieval** - Context-aware information retrieval
29+ - 🔄 ** FHIR Integration** - Standards-compliant healthcare data exchange
30+ - 🎛️ ** Agent Orchestration** - Coordinated multi-service workflows
31+ - 📱 ** Multi-Platform** - Web, mobile, and admin interfaces
32+
33+ ---
34+
35+ ## 🚀 Quick Start
436
537### Prerequisites
638
7- - Node.js >= 18.0.0
8- - PNPM >= 8.0.0
9- - Docker & Docker Compose
10- - PostgreSQL 15+
39+ Ensure you have the following installed:
40+
41+ - ** Node.js** ≥ 18.0.0
42+ - ** PNPM** ≥ 8.0.0
43+ - ** Docker** & Docker Compose
44+ - ** PostgreSQL** 15+
1145
1246### Installation
1347
14- ```
15- # Clone repository
48+ ``` bash
49+ # Clone the repository
1650git clone https://github.com/Sakeeb91/scribemed.git
1751cd scribemed
1852
@@ -24,47 +58,194 @@ cp .env.example .env
2458# Edit .env with your configuration
2559
2660# Run database migrations
27- pnpm run migrate
61+ pnpm run db:migrate
62+
63+ # Seed development database (optional)
64+ pnpm run db:seed:dev
2865
29- # Start development servers
66+ # Start all services in development mode
3067pnpm run dev
3168```
3269
33- ### Available Commands
34-
35- - ` pnpm dev ` - Start all services in development mode
36- - ` pnpm build ` - Build all packages
37- - ` pnpm test ` - Run all tests
38- - ` pnpm lint ` - Lint all code
39- - ` pnpm format ` - Format all code
40-
41- ## Project Structure
70+ ### 🛠️ Available Commands
71+
72+ | Command | Description |
73+ | ----------------------- | ------------------------------------------ |
74+ | ` pnpm dev ` | Start all services in development mode |
75+ | ` pnpm build ` | Build all packages and services |
76+ | ` pnpm test ` | Run all unit and integration tests |
77+ | ` pnpm test:unit ` | Run unit tests only |
78+ | ` pnpm test:integration ` | Run integration tests only |
79+ | ` pnpm lint ` | Lint all code |
80+ | ` pnpm format ` | Format all code with Prettier |
81+ | ` pnpm format:check ` | Check code formatting |
82+ | ` pnpm type-check ` | Run TypeScript type checking |
83+ | ` pnpm db:migrate ` | Run database migrations |
84+ | ` pnpm db:migrate:info ` | Show migration status |
85+ | ` pnpm db:migrate:undo ` | Rollback last migration |
86+ | ` pnpm db:seed:dev ` | Seed development database |
87+ | ` pnpm clean ` | Clean all build artifacts and node_modules |
88+
89+ ---
90+
91+ ## 📁 Project Structure
4292
4393```
4494scribemed/
45- ├── .github/
46- │ ├── workflows/
47- │ ├── ISSUE_TEMPLATE/
48- │ └── PULL_REQUEST_TEMPLATE.md
49- ├── apps/
50- ├── services/
51- ├── packages/
52- ├── infrastructure/
53- ├── docs/
54- ├── .husky/
55- ├── .vscode/
56- ├── package.json
57- ├── pnpm-workspace.yaml
58- ├── turbo.json
59- ├── tsconfig.json
60- ├── .eslintrc.js
61- ├── .prettierrc
62- ├── .gitignore
63- └── README.md
95+ ├── 📱 apps/ # End-user applications
96+ │ ├── web/ # Web application
97+ │ ├── mobile/ # Mobile application
98+ │ ├── admin-portal/ # Admin dashboard
99+ │ └── api-gateway/ # API gateway service
100+ │
101+ ├── ⚙️ services/ # Backend microservices
102+ │ ├── transcription/ # Audio transcription service
103+ │ ├── documentation/ # Clinical note generation
104+ │ ├── coding/ # Medical coding service
105+ │ ├── rag/ # Retrieval-augmented generation
106+ │ ├── agent-orchestrator/ # Service orchestration
107+ │ ├── audio-capture/ # Audio capture service
108+ │ └── fhir-adapter/ # FHIR integration
109+ │
110+ ├── 📦 packages/ # Shared libraries
111+ │ ├── database/ # Database migrations & connection
112+ │ ├── auth/ # Authentication utilities
113+ │ ├── logging/ # Logging infrastructure
114+ │ ├── monitoring/ # Monitoring & observability
115+ │ ├── config/ # Configuration management
116+ │ ├── types/ # Shared TypeScript types
117+ │ ├── ui-components/ # Reusable UI components
118+ │ └── utils/ # Common utilities
119+ │
120+ ├── 🏗️ infrastructure/ # Infrastructure as code
121+ │ ├── terraform/ # Terraform configurations
122+ │ ├── kubernetes/ # K8s manifests
123+ │ ├── docker/ # Docker configurations
124+ │ └── scripts/ # Deployment scripts
125+ │
126+ └── 📚 docs/ # Documentation
127+ ├── architecture/ # Architecture documentation
128+ ├── api/ # API specifications
129+ ├── database/ # Database documentation
130+ ├── ci-cd/ # CI/CD documentation
131+ ├── compliance/ # Compliance documentation
132+ └── runbooks/ # Operational runbooks
64133```
65134
66- See ` docs/architecture/OVERVIEW.md ` , ` docs/ci-cd/README.md ` , and ` docs/database/README.md ` for more details.
135+ ---
136+
137+ ## 🏗️ Architecture
138+
139+ ScribeMed follows a ** monorepo architecture** powered by [ Turborepo] ( https://turbo.build/repo ) for efficient builds and task orchestration. The platform is organized into:
140+
141+ - ** Applications** (` apps/ ` ) - User-facing interfaces and gateways
142+ - ** Services** (` services/ ` ) - Independent microservices with specific responsibilities
143+ - ** Packages** (` packages/ ` ) - Shared libraries and utilities
144+ - ** Infrastructure** (` infrastructure/ ` ) - IaC and deployment configurations
145+
146+ ### 📖 Documentation
147+
148+ Comprehensive documentation is available in the ` docs/ ` directory:
149+
150+ - 📐 [ Architecture Overview] ( docs/architecture/OVERVIEW.md ) - System design and architecture decisions
151+ - 🗄️ [ Database Documentation] ( docs/database/README.md ) - Schema, migrations, and data dictionary
152+ - 🔌 [ API Documentation] ( docs/api/README.md ) - API specifications and endpoints
153+ - 🚀 [ CI/CD Guide] ( docs/ci-cd/README.md ) - Continuous integration and deployment
154+ - 📋 [ Compliance] ( docs/compliance/README.md ) - Healthcare compliance and security
155+ - 📘 [ Runbooks] ( docs/runbooks/README.md ) - Operational procedures
156+
157+ ---
158+
159+ ## 🧪 Development
160+
161+ ### Development Workflow
162+
163+ 1 . ** Create a feature branch** from ` main `
164+
165+ ``` bash
166+ git checkout -b feature/your-feature-name
167+ ```
168+
169+ 2 . ** Make your changes** with accompanying tests and documentation
170+
171+ 3 . ** Run quality checks** before pushing
172+
173+ ``` bash
174+ pnpm lint
175+ pnpm test
176+ pnpm build
177+ pnpm type-check
178+ ```
179+
180+ 4 . ** Commit your changes** (Husky will run lint-staged automatically)
181+
182+ ``` bash
183+ git commit -m " feat: your feature description"
184+ ```
185+
186+ 5 . ** Push and create a pull request** referencing related issues
187+
188+ ### Code Quality
189+
190+ - ** Linting** : ESLint with TypeScript support
191+ - ** Formatting** : Prettier with consistent configuration
192+ - ** Type Checking** : TypeScript strict mode
193+ - ** Testing** : Node.js built-in test runner
194+ - ** Pre-commit Hooks** : Husky + lint-staged
195+
196+ ---
197+
198+ ## 🤝 Contributing
199+
200+ We welcome contributions! Please see our [ Contributing Guide] ( CONTRIBUTING.md ) for:
201+
202+ - Development setup instructions
203+ - Code style guidelines
204+ - Commit message conventions
205+ - Pull request process
206+
207+ ### Quick Contribution Checklist
208+
209+ - ✅ Code follows project style guidelines
210+ - ✅ Tests added/updated and passing
211+ - ✅ Documentation updated
212+ - ✅ Linting and type checking passes
213+ - ✅ No breaking changes (or documented if necessary)
214+
215+ ---
216+
217+ ## 🔒 Security & Compliance
218+
219+ ScribeMed handles Protected Health Information (PHI) and adheres to healthcare compliance standards:
220+
221+ - ** HIPAA** compliance considerations
222+ - ** FHIR** standards for healthcare data exchange
223+ - Secure credential management via AWS Secrets Manager
224+ - Environment-specific security configurations
225+
226+ For security concerns, please contact the maintainers directly.
227+
228+ ---
229+
230+ ## 📄 License
231+
232+ This project is private and proprietary. All rights reserved.
233+
234+ ---
235+
236+ ## 🔗 Links
237+
238+ - [ Architecture Documentation] ( docs/architecture/OVERVIEW.md )
239+ - [ Database Schema] ( docs/database/ERD.md )
240+ - [ API Reference] ( docs/api/README.md )
241+ - [ Contributing Guide] ( CONTRIBUTING.md )
242+
243+ ---
244+
245+ <div align =" center " >
246+
247+ ** Built with ❤️ for healthcare professionals**
67248
68- ## Contributing
249+ [ Report Bug ] ( https://github.com/Sakeeb91/scribemed/issues ) · [ Request Feature ] ( https://github.com/Sakeeb91/scribemed/issues )
69250
70- See ` CONTRIBUTING.md ` for development guidelines.
251+ </ div >
0 commit comments