-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aa70136
commit a09dd8f
Showing
2 changed files
with
184 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,184 @@ | ||
--- | ||
title: HealthSync | ||
description: A sophisticated AI-powered medical charting and EMR documentation system built with Next.js and Together AI. | ||
tags: [nextjs, react, ai, medical] | ||
imageSrc: /projects/health-sync.png | ||
links: | ||
github: https://github.com/royce-mathew/HealthSync | ||
publishedDate: 2025-02-02 | ||
modifiedDate: 2025-02-02 | ||
hasToc: true | ||
--- | ||
|
||
# π₯ HealthSync | ||
|
||
<div align="center"> | ||
 | ||
|
||
> A sophisticated AI-powered medical charting and EMR documentation system built with Next.js and Together AI. | ||
<div className="flex flex-row space-x-3 justify-center mt-4"> | ||
<div> | ||
[](https://nextjs.org/) | ||
</div> | ||
<div> | ||
[](https://reactjs.org/) | ||
</div> | ||
|
||
</div> | ||
|
||
</div> | ||
|
||
## π₯ Development Team | ||
|
||
| # | Full Name | GitHub Username | | ||
| --- | ---------------- | ----------------------------------------------- | | ||
| 1 | Sunny Patel | [sunnypatell](https://github.com/sunnypatell/) | | ||
| 2 | Michael Ispahani | [Michaelexe](https://github.com/Michaelexe) | | ||
| 3 | Royce Mathew | [royce-mathew](https://github.com/royce-mathew) | | ||
| 4 | Alyesha Singh | [AlyeshaS](https://github.com/AlyeshaS) | | ||
|
||
## π Overview | ||
|
||
HealthSync is a cutting-edge medical documentation system that leverages artificial intelligence to streamline the patient intake process. It provides real-time, structured medical charting with an intuitive interface for healthcare professionals. | ||
|
||
## β¨ Features | ||
|
||
### Core Functionality | ||
|
||
- **AI-Powered Documentation** | ||
- Real-time speech-to-text for verbal input | ||
- Intelligent SOAP format adherence | ||
- Automated medical terminology validation | ||
|
||
### User Interface | ||
|
||
- **Dual Chat Interface** | ||
- Choose between two AI assistants (Ava & Eli) | ||
- Real-time conversation tracking | ||
- Voice input support with visual feedback | ||
|
||
### Charting System | ||
|
||
- **Dynamic Charting Display** | ||
- Warning and message categorization | ||
- Visual indicators for different entry types | ||
- Real-time updates during consultation | ||
|
||
### Data Processing | ||
|
||
- **Structured Data Output** | ||
- JSON-formatted medical records | ||
- SOAP-compliant documentation | ||
- Automated follow-up question generation | ||
|
||
## π Architecture | ||
|
||
```plaintext | ||
HealthSync/ | ||
βββ src/ | ||
β βββ pages/ | ||
β β βββ index.js # Main application router | ||
β β βββ HomePage.js # Initial selection interface | ||
β β βββ ChatPage.js # AI interaction interface | ||
β β βββ Charting.js # Medical documentation display | ||
β β βββ api/ | ||
β β βββ agent.js # Together AI integration | ||
β βββ styles/ | ||
β βββ index.css # Global styles | ||
β βββ home.css # Homepage styles | ||
β βββ chat.css # Chat interface styles | ||
β βββ charting.css # Documentation styles | ||
``` | ||
|
||
## π Technology Stack | ||
|
||
- **Frontend** | ||
|
||
- Next.js 13 | ||
- React 18 | ||
- TailwindCSS | ||
- Framer Motion | ||
|
||
- **AI Integration** | ||
|
||
- Together AI API | ||
- OpenAI Whisper | ||
- Custom AI Agents (Ava & Eli) | ||
|
||
- **Development Tools** | ||
- TypeScript | ||
- ESLint | ||
- Prettier | ||
- Husky | ||
|
||
## π Project Structure | ||
|
||
The project follows a modular architecture with clear separation of concerns: | ||
|
||
- `pages/` - Route components and API endpoints | ||
- `components/` - Reusable UI components | ||
- `styles/` - Global and component-specific styles | ||
- `lib/` - Utility functions and API clients | ||
- `types/` - TypeScript type definitions | ||
- `public/` - Static assets and resources | ||
|
||
## 𧩠Components | ||
|
||
Key components include: | ||
|
||
- **ChatInterface** - Main conversation UI | ||
- **VoiceInput** - Speech recognition component | ||
- **ChartingDisplay** - Medical documentation view | ||
- **AgentSelector** - AI assistant selection interface | ||
|
||
## π€ AI Integration | ||
|
||
HealthSync uses Together AI's API for: | ||
|
||
- Natural language processing | ||
- Medical terminology validation | ||
- Automated documentation generation | ||
- Context-aware responses | ||
|
||
## π Styling | ||
|
||
- TailwindCSS for utility-first styling | ||
- Custom CSS modules for complex components | ||
- Responsive design for all screen sizes | ||
- Dark/Light mode support | ||
|
||
## π Setup & Installation | ||
|
||
1. Install dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
2. Create a `.env.` file: | ||
|
||
```bash | ||
TOGETHER_API_KEY=your_api_key_here | ||
``` | ||
|
||
3. Start the development server: | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
## π» Development | ||
|
||
- Build: `npm run build` | ||
- Lint: `npm run lint` | ||
|
||
## π€ Contributing | ||
|
||
1. Fork the repository | ||
2. Create a feature branch | ||
3. Commit your changes | ||
4. Push to the branch | ||
5. Open a Pull Request | ||
|
||
<p align="center">Made with β€οΈ for HackHive 2025</p> |