phellow•community

Your open source patient portal using FHIR.

Welcome to phellow•community, an open-source patient portal designed to streamline creating a frontend for your healthcare project needs. This project aims to provide a user-friendly interface for managing appointments and accessing medical records using HL7 FHIR.

Table of Contents

• phellow•community
  • Table of Contents
  • About the Project
  • Features
  • Getting Started
    • Prerequisites
    • Installation
    • Launch a demo
  • Usage
  • Contributing
  • Documentation
  • License

---

About the Project

The Patient Portal is a modern, open-source solution for healthcare providers and patients. It is built with a focus on accessibility, security, and ease of use. The project leverages cutting-edge web technologies like Svelte, SvelteKit, TailwindCSS, and Vite to deliver a seamless experience.

---

Features

• Appointment Management: See scheduled appointments.
• Medical Records Access: View and download medical records securely.
• Laboratory Values: Display patients lab values and graph them.
• Multi-Language Support: Built-in support for multiple languages.
• Responsive Design: Fully optimized for desktop and mobile devices.

---

Getting Started

Prerequisites

Ensure you have the following installed:

• Node.js (v16 or higher)
• pnpm (preferred package manager)
• Docker (optional, for containerized deployment)

Installation

1. Clone the repository:

   git clone https://github.com/phellowseven/phellow-community.git
   cd phellow-community

2. Install dependencies

   pnpm install

3. Set up environment variables:
   • Copy .env.example to .env and configure the variables as needed.
4. Start the development server:

   pnpm run dev

Launch a demo

If you don't have an OAuth Provider or data repository available, you can use the mock services provided.

To launch a mock OIDC Provider, run:

pnpm run mock:oidc

To provide sample FHIR data to the application, you can launch Mockoon with the config at samples/mockooon.json.

You can use one of the .env.mockoon.* files for the environment variables, depending on how you launch the demo (either locally or via docker).

Then start the development server:

pnpm run dev

If you have Docker available on your system, you can use docker-compose with the docker-compose.sample.yaml config to quickly launch a demo system:

docker-compose -f docker-compose.sample.yaml up -d

Usage

• Access the application in your browser at http://localhost:5173 (default Vite port).
• Patients can log in to view their data

For detailed usage instructions, refer to the docs directory.

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

3. Commit your changes and push the branch:

   git commit -m "Add your feature description"
    git push origin feature/your-feature-name

4. Open a pull request.

Thank you for contributing to phellow•community! Together, we can make healthcare more accessible and efficient.

Documentation

For more detailed documentation, including API references, deployment guides, and architecture overviews, visit the docs directory.

License

This project is licensed under the Apache License Version 2.0 License. Feel free to use, modify, and distribute it as per the terms of the license.