> ## 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.

# OpenEyes Documentation

> Open source electronic patient record system for ophthalmology clinics and eye care providers

<div
  style={{
background: 'linear-gradient(135deg, #4f5871 0%, #303c5a 100%)',
borderRadius: '24px',
padding: '60px 40px',
marginBottom: '40px',
color: '#ffffff'
}}
>
  <h1
    style={{
fontSize: '48px',
fontWeight: '700',
marginBottom: '20px',
color: '#ffffff'
}}
  >
    OpenEyes
  </h1>

  <p
    style={{
fontSize: '24px',
marginBottom: '30px',
opacity: '0.95'
}}
  >
    The leading open source Electronic Patient Record (EPR) for ophthalmology
  </p>

  <div style={{display: 'flex', gap: '16px', flexWrap: 'wrap'}}>
    <a
      href="/quickstart"
      style={{
  backgroundColor: '#ffffff',
  color: '#1f2937',
  padding: '12px 28px',
  borderRadius: '24px',
  textDecoration: 'none',
  fontWeight: '600',
  display: 'inline-block'
}}
    >
      Get Started →
    </a>

    <a
      href="https://github.com/appertafoundation/openeyes"
      style={{
  backgroundColor: 'transparent',
  color: '#ffffff',
  padding: '12px 28px',
  borderRadius: '24px',
  textDecoration: 'none',
  fontWeight: '600',
  border: '2px solid rgba(255,255,255,0.3)',
  display: 'inline-block'
}}
    >
      View on GitHub
    </a>
  </div>
</div>

## Key Features

<CardGroup cols={3}>
  <Card title="Electronic Patient Records" icon="folder-medical" iconType="solid">
    Comprehensive EPR system designed specifically for ophthalmology clinics and eye care providers
  </Card>

  <Card title="Clinical Modules" icon="stethoscope" iconType="solid">
    Extensive suite of clinical modules covering examinations, operations, prescriptions, and more
  </Card>

  <Card title="Multi-Institution Support" icon="hospital" iconType="solid">
    Support for multiple institutions and sites with role-based access control
  </Card>

  <Card title="Worklist Management" icon="list-check" iconType="solid">
    Efficient clinical workflow and worklist management for optimal patient care
  </Card>

  <Card title="Document Generation" icon="file-lines" iconType="solid">
    Automated correspondence and document generation for seamless communication
  </Card>

  <Card title="Integration Ready" icon="plug" iconType="solid">
    RESTful API for integration with external systems and third-party applications
  </Card>
</CardGroup>

## Get Started

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Get OpenEyes up and running in your environment quickly
  </Card>

  <Card title="Installation" icon="download" href="/installation">
    Detailed installation instructions for production deployment
  </Card>

  <Card title="User Guide" icon="book-open" href="/user-guide/dashboard">
    Learn how to use OpenEyes for daily clinical workflows
  </Card>

  <Card title="Clinical Modules" icon="briefcase-medical" href="/modules/overview">
    Explore the comprehensive clinical module ecosystem
  </Card>
</CardGroup>

## For Administrators

<CardGroup cols={2}>
  <Card title="Configuration" icon="gear" href="/admin/configuration">
    Configure OpenEyes for your institution's needs
  </Card>

  <Card title="Users & Permissions" icon="users" href="/admin/users-permissions">
    Manage users, roles, and access control
  </Card>

  <Card title="Institutions" icon="building" href="/admin/institutions">
    Set up multi-institution and multi-site configurations
  </Card>

  <Card title="System Settings" icon="sliders" href="/admin/system-settings">
    Configure system-wide settings and preferences
  </Card>
</CardGroup>

## For Developers

<CardGroup cols={2}>
  <Card title="Architecture" icon="sitemap" href="/development/architecture">
    Understand the OpenEyes technical architecture
  </Card>

  <Card title="Module Development" icon="puzzle-piece" href="/development/modules">
    Learn how to create custom modules and extend OpenEyes
  </Card>

  <Card title="Testing" icon="vial" href="/development/testing">
    Testing strategies and best practices
  </Card>

  <Card title="Contributing" icon="code-pull-request" href="/development/contributing">
    Contribute to the OpenEyes project
  </Card>
</CardGroup>

## API Reference

<Card title="API Documentation" icon="code" href="/api/overview">
  Explore the OpenEyes REST API for integration and automation
</Card>

## About OpenEyes

OpenEyes is a collaborative, open source project led by the [Apperta Foundation](https://apperta.org/). The goal is to produce a framework which allows the rapid and continuous development of an electronic patient record (EPR) for ophthalmology in particular and eye care in general.

<Note>
  OpenEyes is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). Users should undertake a safety assessment to confirm that deployment matches local clinical safety requirements.
</Note>

## Community & Support

* **GitHub**: [appertafoundation/openeyes](https://github.com/appertafoundation/openeyes)
* **Issues**: Report bugs and request features via [GitHub Issues](https://github.com/appertafoundation/openeyes/issues)
* **Email**: For general enquiries, contact [openeyes@apperta.org](mailto:openeyes@apperta.org)
* **Twitter**: Follow [@openeyes\_oef](https://twitter.com/openeyes_oef)