Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 6.26 KB

README.md

File metadata and controls

89 lines (57 loc) · 6.26 KB
Raw

Clinical Application Project

Welcome to the Clinical Application Project! This project comprises a server and a client application designed to streamline the testing of clinical data resources. The server is built upon the open-source Hapi-FHIR project and incorporates bearer token authentication for enhanced security with Auth0.

Abstract

This project was an educational endeavor aimed at designing and implementing a medical application for managing patients and their observations. The primary objectives were to apply and extend our knowledge in software development, particularly focusing on the application structuring, basic security implementation, and understanding the usage of Fast Healthcare Interoperability Resources (FHIR). The application aimed to provide a practical solution to streamline patient management, specifically addressing certain use cases within the healthcare field. Throughout the process, we learned essential skills in defining a workflow, reflecting on the complexities and the interrelation of tasks within a software project. The experience gleaned from this project sheds light on the real-world application of theoretical knowledge in a highly critical field like healthcare and contributes to our practical proficiency in software development.

Table of Contents

Introduction

In the context of clinical applications, it is crucial to have a reliable and easy-to-use environment for testing different resources. This project aims to provide a practical solution for testing a server with clinical data resources. The server, based on Hapi-FHIR, offers various RESTful endpoints, and we have added bearer token authentication to enhance security.

Frontend Integration

This server repository is designed to seamlessly integrate with the frontend component of the project. Together, they offer a comprehensive solution for clinical application testing, providing a user-friendly interface to interact with the clinical data resources.

We invite you to explore the FrontEnd to leverage the full potential of the Klinisches Anwendungsprojekt. The frontend enhances the overall user experience and complements the functionality of the server.

Client - PatientGenerator

The PatientGenerator-client is a mock client application designed to generate random patient data and interact with the server through HTTP requests. This allows users to simulate real-world scenarios and test the server's handling of different resources. The client is a valuable tool for validating the server's functionality and performance.

Server Configuration

The server directory contains the Hapi-FHIR-based server, which serves as the core component of this project. We have customized the server to suit the specific requirements of our clinical application. Bearer token authentication has been integrated to secure the server and control access to sensitive patient data.

Getting Started

  1. Install Node.js: Before installing npm, you need to have Node.js installed on your machine. npm is the default package manager that comes with Node.js. If you don't have Node.js installed, you can download and install it from the official Node.js website: https://nodejs.org/

  2. Verify Installation: After installing Node.js, you can check if npm is installed by opening your terminal or command prompt and running the following commands:

    node -v
npm -v

    These commands will display the installed versions of Node.js and npm, respectively.

To get started with the Clinical Project, follow these steps:

  1. Clone the Repository: Begin by cloning this repository to your local machine using the following command:

    git clone https://github.com/GravityDarkLab/Clinical-Application-Project.git

  2. Configure the Server: Navigate to the server directory and follow the provided instructions to set up and configure the server. Ensure that you have all the required dependencies installed.

  3. Alternatively: you can download the built and ready-to-use server directly from here and follow the instructions in the Readme.

  4. Build the PatientGenerator: Next, go to the PatientGenerator-client directory. If needed, update the configurations to match your server's endpoint. Then, build the client application and you can now start testing the server's response to various resources and HTTP methods.

  5. Prepare the Frontend: Navigate to the front-end directory and install the required dependencies using npm:

    npm install

  6. Run the Development Server: Start the development server by running the following command:

    npm start

    The app will be accessible at http://localhost:3000 in your web browser.

Usage

By following these steps, you will have both the backend server and the frontend application up and running, enabling seamless interaction with the clinical data resources. Should you have any questions or need assistance, feel free to reach out. Happy testing!

Acknowledgment

Special thanks to the Hapi-FHIR community for providing the core server component that forms the foundation of our Klinisches Anwendungsprojekt. Their dedication to open-source excellence has been instrumental in advancing healthcare interoperability. We are grateful for their exceptional work and contributions.

License

The Klinisches Anwendungsprojekt is distributed under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license.

Thank you for your interest in the Klinisches Anwendungsprojekt. We hope this project proves to be a valuable asset in your clinical application testing endeavors. If you have any questions or need further assistance, please don't hesitate to reach out to us. Happy testing!