> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/appertafoundation/openeyes/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to OpenEyes

> Learn about OpenEyes, the leading open source electronic patient record system for ophthalmology

## What is OpenEyes?

OpenEyes™ is the leading open source Electronic Patient Record (EPR) system for ophthalmology, developed and maintained by the [Apperta Foundation](https://apperta.org/). It provides a comprehensive, flexible framework for managing patient records in ophthalmic units of any size—from single practitioners to large eye hospitals.

<Note>
  OpenEyes is designed specifically for ophthalmology but is flexible enough to be adapted for other clinical specialties.
</Note>

## Key Features

OpenEyes offers a robust set of features tailored for eye care:

<CardGroup cols={2}>
  <Card title="Comprehensive Examinations" icon="eye">
    Full examination module with visual acuity, DR grading, phasing, and specialized ophthalmology elements
  </Card>

  <Card title="Event-Based Records" icon="calendar">
    Modular event system supporting consultations, prescriptions, correspondence, procedures, and more
  </Card>

  <Card title="Clinical Workflows" icon="workflow">
    Patient ticketing, worklist management, therapy applications, and case search functionality
  </Card>

  <Card title="Integration Ready" icon="plug">
    PASAPI support, SAML/OIDC authentication, LDAP integration, and extensive API capabilities
  </Card>
</CardGroup>

### Specialized Modules

OpenEyes includes dedicated modules for various ophthalmology workflows:

* **OphCiExamination** - Comprehensive examination elements with visual fields, DR grading, and more
* **OphCoCorrespondence** - Clinical correspondence and letter generation
* **OphDrPrescription** - Prescription management
* **OphCoTherapyapplication** - Therapy application workflows
* **OphCoCvi** - Certificate of Visual Impairment management
* **OphInBiometry** - Biometry and IOL calculations
* **Genetics** - Genetic results and DNA sample tracking
* **PatientTicketing** - Patient queue and workflow management

## Who Should Use OpenEyes?

OpenEyes is ideal for:

<AccordionGroup>
  <Accordion title="Ophthalmology Clinics">
    Single or multi-practitioner clinics requiring a complete EPR solution for outpatient eye care services
  </Accordion>

  <Accordion title="Eye Hospitals">
    Large ophthalmology departments and dedicated eye hospitals needing comprehensive patient record management across multiple subspecialties
  </Accordion>

  <Accordion title="NHS Trusts">
    UK healthcare organizations requiring NHS-compliant patient record systems with proper data governance
  </Accordion>

  <Accordion title="Research Institutions">
    Academic departments conducting ophthalmology research and clinical trials (includes OETrial module)
  </Accordion>

  <Accordion title="Optometrists">
    Non-medical staff delivering shared programs of eye care in collaboration with clinical teams
  </Accordion>
</AccordionGroup>

## Technology Stack

OpenEyes is built on proven, enterprise-grade technologies:

<CodeGroup>
  ```json composer.json theme={null}
  {
    "name": "openeyes/openeyes",
    "description": "Electronic Patient Record system for use in Ophthalmology clinics",
    "require": {
      "php": "^7.4 || ^8.0 || ^8.1",
      "yiisoft/yii": "1.1.28",
      "ext-json": "*",
      "ext-dom": "*",
      "ext-openssl": "*"
    }
  }
  ```
</CodeGroup>

### Core Technologies

* **PHP** - Backend logic (PHP 7.4, 8.0, or 8.1)
* **Yii Framework 1.1** - MVC framework providing structure and components
* **MySQL/MariaDB** - Primary database for patient records
* **JavaScript** - Interactive UI components and client-side validation
* **EyeDraw** - Specialized drawing library for ophthalmic diagrams

### Key Dependencies

* **PDF Generation** - FPDF, FPDI for reports and correspondence
* **Authentication** - SAML (OneLogin), OIDC (OpenID Connect), LDAP support
* **Spreadsheet Export** - PhpSpreadsheet for data exports
* **QR Codes** - Endroid QR Code generation for patient identification
* **Security** - Phpseclib for encryption, Quahog for antivirus scanning

## Architecture Overview

OpenEyes follows a modular, event-driven architecture:

```
OpenEyes/
├── protected/
│   ├── models/          # Patient, Episode, Event, User models
│   ├── controllers/     # Request handling and routing
│   ├── views/           # HTML templates
│   ├── modules/         # Event type modules (Examination, Prescription, etc.)
│   ├── components/      # Reusable business logic components
│   ├── migrations/      # Database schema migrations
│   └── config/          # Application configuration
├── vendor/              # Composer dependencies
└── index.php           # Application entry point
```

### Data Model

The core data structure centers around:

1. **Patient** - Demographics, identifiers, contact information
2. **Episode** - Care episodes grouped by subspecialty
3. **Event** - Clinical events (examinations, procedures, correspondence)
4. **Elements** - Structured data within events (findings, diagnoses, treatments)

<Warning>
  OpenEyes is provided under AGPL v3.0 license. Any user is advised to undertake a safety assessment to confirm that deployment matches local clinical safety requirements. No warranty is provided for clinical use.
</Warning>

## Open Source & Community

OpenEyes is a collaborative, open source project:

* **License**: GNU Affero General Public License v3.0 (AGPL v3.0)
* **Copyright**: 2019-2024 Apperta Foundation
* **Repository**: [GitHub](https://github.com/AppertaFoundation/openeyes)
* **Website**: [openeyes.apperta.org](https://openeyes.apperta.org/)

Clinical and technical contributions are made by hospitals, institutions, academic departments, companies, and individuals worldwide.

### Getting Support

<CardGroup cols={2}>
  <Card title="Issue Tracking" icon="github" href="https://github.com/AppertaFoundation/openeyes/issues">
    Report bugs and issues through GitHub
  </Card>

  <Card title="Professional Services" icon="briefcase" href="https://openeyes.apperta.org">
    Accredited partner network for implementation and support
  </Card>

  <Card title="Community" icon="users" href="mailto:openeyes@apperta.org">
    Join the OpenEyes community
  </Card>

  <Card title="Twitter" icon="twitter" href="https://twitter.com/openeyes_oef">
    Follow @openeyes\_oef for updates
  </Card>
</CardGroup>

<Note>
  No service level agreement exists for the open source project. Official implementation and support is available from Accredited Professional Services Partners.
</Note>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get OpenEyes running quickly with Docker
  </Card>

  <Card title="Installation Guide" icon="download" href="/installation">
    Detailed production installation instructions
  </Card>
</CardGroup>