opensrp / web

A web based interface for administering FHIR based digital health solutions

OpenSRP FHIR Web

OpenSRP FHIR Web is the default frontend for OpenSRP HAPI FHIR Server, as well as a configuration dashboard for the OpenSRP FHIR Core mobile application. It provides access to healthcare data, configuration options, and other functionality provided by OpenSRP FHIR Server and OpenSRP FHIR Core.

Table of Contents

---

• FHIR Standard
• OpenSRP FHIR Core
• Project Architecture
• Repository Setup
  • Bootstrapping
  • Current Build Tools
  • Deprecated Build Tools
• Getting Started
• Contributing
• Deployments
  • Prerequisites
  • Docker
  • Kubernetes
  • Ansible
• Configuration
  • Environment Variables
  • Multi-language Support
• Publishing

What is the FHIR Standard

HL7 Fast Healthcare Interoperability Resources (FHIR), is a standard to enable quick and efficient representation and exchange of health care data, including clinical and administrative data, by digital health systems.

What is OpenSRP FHIR Core

OpenSRP FHIR Core is a Kotlin application for delivering offline-capable, mobile-first healthcare project implementations from local community to national and international scale using FHIR and the WHO Smart Guidelines on Android.

Project Architecture

OpenSRP FHIR Web consumes FHIR resources from the OpenSRP HAPI FHIR server. Both OpenSRP FHIR Web and OpenSRP HAPI FHIR server use a Keycloak Server for authentication (Oauth 2.0). On top of the React Js web application, there is a tiny Express JS Server that is bundled together with OpenSRP FHIR Web that handles both authentication and serving the compiled FHIR Web files. For All Intents and Purposes, both the Express and the React Js apps are bundled together and collectively referred to as the OpenSRP FHIR Web.

Repository Setup

Bootstrapping

This repository is a monorepo bootstrapped with Lerna and Yarn Workspaces. It is divided into two workTrees, the first, /app, containing the actual React application, and the second, /packages containing the different packages that /app consume.

Current Build Tools

• React
• TypeScript
• Ant Design
• Lerna
• Yarn Workspaces
• TanStack Query
• Jest
• React Testing Library
• React Router
• Eslint
• Prettier

Deprecated Build Tools

• Enzyme
• React Redux

Getting Started

• Getting Started Documentation.

Contributing

• Contributing Documentation.

Deployments

We use different technologies to deploy OpenSRP FHIR Web.

Prerequisites

• A well configured keycloak server deployment.
  • We currently support version 18.0.0-legacy
  • This should include the Keycloak Realm and Client configurations.
• A well configured Hapi FHIR server deployment.

1. Docker

• FHIR Web Docker Deployment Documentation.

• OpenSRP Web Docker Deployment Documentation.

2. Kubernetes

• FHIR Web and OpenSRP Web Kubernetes Helm Chart.

3. Ansible

• OpenSRP Web Ansible Playbook
  • Run an OpenSRP Web deployment with certbot, react, express, and nginx.
  • You'll need accompanying ansible inventories

Configuration

Environment Variables

• List Of Configurable Environment Variables.

Multi-language Support (MLS)

• Internalization and Multi Language Support Documentation.

Publishing

• Publishing Documentation.