novate-medviz/README.md

Comprehensive React library for medical anatomy visualization with 550+ anatomical structures, clinical examination points, and AI-powered natural language processing. Supports 10 anatomical views with gender-specific differences.

# Novate MedViz

A comprehensive React library for medical anatomy visualization with 550+ anatomical structures, clinical examination points, and AI-powered natural language processing. Supports 10 anatomical views with gender-specific differences.

## Features

- **Comprehensive Anatomy Coverage**: 550+ anatomical structures across multiple body systems
- **Gender-Specific Views**: Male and female anatomical differences
- **Clinical Examination Points**: Pre-mapped clinical examination locations
- **AI-Powered Analysis**: Natural language processing for medical transcriptions
- **Multiple Views**: Front, back, left side, right side, and internal organ views
- **TypeScript Support**: Fully typed for better development experience
- **Customizable**: Easy to integrate and customize for your needs

## Installation

```bash
npm install novate-medviz
```

```bash
yarn add novate-medviz
```

## Quick Start

### Basic Usage

```jsx
import React from 'react';
import { MedDiagram } from 'novate-medviz';

const MyMedicalApp = () => {
  const symptomData = {
    symptoms: [
      {
        name: "chest pain",
        bodyPart: "chest",
        severity: "moderate",
        coordinates: { x: 0.5, y: 0.3 }
      }
    ]
  };

  return (
    <div>
      <h1>Medical Examination</h1>
      <MedDiagram 
        data={symptomData}
        view="front"
        gender="male"
      />
    </div>
  );
};

export default MyMedicalApp;
```

### Medical Transcription Analysis

```jsx
import React, { useState } from 'react';
import { MedicalTranscriptionAnalyzer } from 'novate-medviz';

const TranscriptionAnalyzer = () => {
  const [analysis, setAnalysis] = useState(null);
  const analyzer = new MedicalTranscriptionAnalyzer();

  const handleAnalyze = () => {
    const medicalNote = "Patient complains of chest pain and shortness of breath...";
    const result = analyzer.analyzeMedicalText(medicalNote);
    setAnalysis(result);
  };

  return (
    <div>
      <button onClick={handleAnalyze}>Analyze Medical Note</button>
      {analysis && (
        <div>
          <h3>Analysis Results:</h3>
          <p>Detected symptoms: {analysis.matches.length}</p>
        </div>
      )}
    </div>
  );
};
```

## API Reference

### Components

#### MedDiagram

The main component for displaying anatomical diagrams with symptoms or examination points.

**Props:**
- `data` (MedDiagramData): Symptom and examination data
- `view` ('front' | 'back' | 'leftside' | 'rightside' | 'internal'): Anatomical view
- `gender` ('male' | 'female'): Patient gender
- `className?` (string): Additional CSS classes
- `onSymptomClick?` (function): Callback for symptom interactions

### Utilities

#### MedicalTranscriptionAnalyzer

AI-powered analyzer for processing medical transcriptions.

**Methods:**
- `analyzeMedicalText(text: string): AnalysisResult`
- `extractSymptoms(text: string): SymptomMatch[]`

### Data Exports

#### Coordinate Systems

```jsx
import { 
  bodyPartCoordinatesFront,
  bodyPartCoordinatesBack,
  bodyPartCoordinatesLeftSide,
  bodyPartCoordinatesRightSide,
  bodyPartCoordinatesInternal
} from 'novate-medviz';
```

#### Data Integration

```jsx
import { mapAnatomyData, integrateCustomMapping } from 'novate-medviz';

// Map custom data to anatomy coordinates
const mappedData = mapAnatomyData(yourSymptomData);

// Integrate custom coordinate mappings
const customMapping = integrateCustomMapping(yourCustomCoordinates);
```

## Supported Anatomical Views

1. **Front View** - Complete frontal anatomy
2. **Back View** - Posterior anatomy
3. **Left Side** - Left lateral view
4. **Right Side** - Right lateral view
5. **Internal Organs** - Internal organ systems
6. **Cardiovascular & Respiratory** - Specialized cardio-pulmonary view
7. **Abdominal & Inguinal** - Detailed abdominal examination regions
8. **Gender-Specific Views** - Male and female anatomical differences

## Advanced Configuration

### Custom Styling

```jsx
<MedDiagram 
  data={symptomData}
  view="front"
  gender="male"
  className="custom-medical-diagram"
  style={{
    maxWidth: '600px',
    height: 'auto'
  }}
/>
```

### Custom Coordinate Mapping

```jsx
import { adaptMappingFormat } from 'novate-medviz';

const customCoordinates = {
  "custom_point": {
    name: "Custom Examination Point",
    coordinates: { x: 0.4, y: 0.6 },
    clinical: "Custom clinical significance"
  }
};

const adaptedMapping = adaptMappingFormat(customCoordinates);
```

## Data Structure

### MedDiagramData

```typescript
interface MedDiagramData {
  symptoms: Symptom[];
  patientInfo?: {
    age?: number;
    gender?: 'male' | 'female';
    conditions?: string[];
  };
}

interface Symptom {
  name: string;
  bodyPart: string;
  severity?: 'mild' | 'moderate' | 'severe';
  coordinates: { x: number; y: number };
  description?: string;
  duration?: string;
}
```

## Assets

The package includes high-quality anatomical images:
- Male and female front/back views
- Side profile views  
- Internal organ diagrams
- Specialized examination views

Access assets directly:
```jsx
import maleImage from 'novate-medviz/assets/malefront.png';
```

## License

MIT License - see LICENSE file for details.

## Repository

https://github.com/gbengaoluwadahunsi/novate-medviz

## Keywords

`react` `medical` `anatomy` `visualization` `healthcare` `clinical-examination` `medical-education` `typescript` `ai-powered` `medical-transcription` `nlp`

---

Made with ❤️ by Novate AI for the medical community.