OpenCRVS
v1.5
v1.5
  • 👋Welcome!
  • CRVS Systems
    • Understanding CRVS
    • Effective digital CRVS systems
    • OpenCRVS within a government systems architecture
    • OpenCRVS Value Proposition
  • Product Specifications
    • Functional Architecture
    • Workflow management
    • Status Flow Diagram
    • Users
      • Examples
    • Core functions
      • 1. Notify event
      • 2. Declare event
      • 3. Validate event
      • 4. Register event
      • 5. Print certificate
      • 6. Issue certificate
      • 7. Search for a record
      • 8. View record
      • 9. Correct record
      • 10. Verify record
      • 11. Archive record
      • 12. Vital statistics export
    • Support functions
      • 13. Login
      • 14. Audit
      • 15. Deduplication
      • 16. Performance management
      • 17. Payment
      • 18. Learning
      • 19. User support
      • 20. User onboarding
    • Admin functions
      • 21. User management
      • 22. Comms management
      • 23. Content management
      • 24. Config management
    • Data functions
      • 25. Legacy data import
      • 26. Legacy paper import
  • Technology
    • Architecture
      • Performance tests
    • Standards
      • FHIR Documents
        • Event Composition
        • Person
        • Registration Task
        • Event Observations
        • Locations
    • Security
    • Interoperability
      • Create a client
      • Authenticate a client
      • Event Notification clients
      • Record Search clients
      • Webhook clients
      • National ID client
      • FHIR Location REST API
      • Other ways to interoperate
  • Default configuration
    • Intro to Farajaland
    • Civil registration in Farajaland
    • OpenCRVS configuration in Farajaland
      • Application settings
      • User / role mapping
      • Declaration forms
      • Certificate templates
    • Business process flows in Farajaland
  • Setup
    • 1. Planning an OpenCRVS Implementation
    • 2. Establish project and team
    • 3. Gather requirements
      • 3.1 Mapping business processes
      • 3.2 Mapping offices and user types
      • 3.3 Define your application settings
      • 3.4 Designing event declaration forms
      • 3.5 Designing a certificate template
    • 4. Installation
      • 4.1 Set-up a local development environment
        • 4.1.1 Install the required dependencies
        • 4.1.2 Install OpenCRVS locally
        • 4.1.3 Starting and stopping OpenCRVS
        • 4.1.4 Log in to OpenCRVS locally
        • 4.1.5 Tooling
          • 4.1.5.1 WSL Support
      • 4.2 Set-up your own, local, country configuration
        • 4.2.1 Fork your own country configuration repository
        • 4.2.2 Set up administrative address divisions
          • 4.2.2.1 Prepare source file for administrative structure
          • 4.2.2.2 Prepare source file for statistics
        • 4.2.3 Set up CR offices and Health facilities
          • 4.2.3.1 Prepare source file for CRVS Office facilities
          • 4.2.3.2 Prepare source file for health facilities
        • 4.2.4 Set up employees & roles for testing or production
          • 4.2.3.1 Prepare source file for employees
          • 4.2.3.2 Configure role titles
        • 4.2.5 Set up application settings
          • 4.2.5.1 Managing language content
            • 4.2.5.1.1 Informant and staff notifications
          • 4.2.5.2 Configuring Metabase Dashboards
        • 4.2.6 Configure certificate templates
        • 4.2.7 Configure declaration forms
          • 4.2.7.1 Configuring an event form
        • 4.2.8 Seeding & clearing your local databases
        • 4.2.9 Countryconfig API endpoints explained
      • 4.3 Set-up a server-hosted environment
        • 4.3.1 Verify servers & create a "provision" user
        • 4.3.2 TLS / SSL & DNS
          • 4.3.2.1 LetsEncrypt https challenge in development environments
          • 4.3.2.2 LetsEncrypt DNS challenge in production
          • 4.3.2.3 Static TLS certificates
        • 4.3.3 Configure inventory files
        • 4.3.4 Create a Github environment
          • 4.3.4.1 Environment secrets and variables explained
          • 4.3.4.2 VPN Recipes
        • 4.3.5 Provisioning servers
          • 4.3.5.1 SSH access
          • 4.3.5.2 Building, pushing & releasing your countryconfig code
          • 4.3.5.3 Ansible tasks when provisioning
        • 4.3.6 Deploy
          • 4.3.6.1 Running a deployment
          • 4.3.6.2 Seeding a server environment
          • 4.3.6.3 Login to an OpenCRVS server
          • 4.3.6.5 Resetting a server environment
        • 4.3.7 Backup & Restore
          • 4.3.7.1 Restoring a backup
          • 4.3.7.2 Off-boarding from OpenCRVS
    • 5. Functional configuration
      • 5.1 Configure application settings
      • 5.2 Configure registration periods and fees
      • 5.3 Managing system users
    • 6. Quality assurance testing
    • 7. Go-live
      • 7.1 Pre-Deployment Checklist
    • 8. Operational Support
    • 9. Monitoring
      • 9.1 Application logs
      • 9.2 Infrastructure health
      • 9.3 Routine monitoring checklist
      • 9.4 Setting up alerts
      • 9.5 Managing a Docker Swarm
  • General
    • Community
    • Contributing
    • Releases
      • v1.5.1: Release notes
      • v1.5.0: Release notes
      • v1.4.1: Release notes
      • v1.4.0 to v1.4.1 Migration notes
      • v1.4.0 Release notes
      • v1.3.* to v1.4.* Migration notes
      • v1.3.5: Release notes
      • v1.3.4: Release notes
      • v1.3.3: Release notes
      • v1.3.1: Release notes
      • v1.3.0: Release notes
      • v1.2.1: Release notes
      • Patch: Elasticsearch 7.10.2
      • v1.2.0: Release notes
      • v.1.1.2: Release notes
      • v.1.1.1: Release notes
      • v1.1.0: Release notes
    • Roadmap
Powered by GitBook
On this page
  • Dependencies
  • Docker Swarm
  • FHIR Standard MongoDB Database layer
  • ElasticSearch
  • InfluxData
  • OpenCRVS microservice packages
  • (Optional) OpenHIM enterprise service bus, interoperability Layer
  1. Technology

Architecture

Previous26. Legacy paper importNextPerformance tests

Last updated 9 months ago

OpenCRVS technical architecture is designed using modular, event-driven . Each micro service and every OpenCRVS component is configurable, scalable and protects data sovereignty by being provisionable in on-premise private tier 2/3 data centres using included configurations.

To learn about the server hosting & network architecture required for hosting OpenCRVS visit

OpenCRVS provides:

  • Easy country configuration via a dedicated config microservice, simple csv files and a configuration UI.

  • Standards-based multi-language content management.

  • An automated continuous integration, delivery and testing suite.

  • SMS 2-Factor Authentication with well defined user role authorization privileges

Dependencies

Docker Swarm

  • Many countries may be located far from a high-quality data-centre above Tier 2.

  • Many countries may not legally support international data storage of citizen data on a public cloud. Getting the legal approval for external storage of citizen data requires regulatory change which can take a considerable amount of time.

  • Because some countries may not be able to maintain complex software independently, we are considering a SaaS solution, provided enough countries get regulatory approval. Over time, this situation appears to be slowly evolving and we are monitoring it closely.

Previously unskilled system administrators can quickly up-skill in the techniques of private cloud infrastructure management using Docker Swarm. We wanted to democratise containerisation benefits for all countries.

Is there a plan for Kubernetes?

FHIR Standard MongoDB Database layer

ElasticSearch

De-duplication management to ensure data integrity is essential to any civil registration system. A fast search engine lowers operational costs and improves the user experience for frontline staff.

InfluxData

OpenCRVS microservice packages

The OpenCRVS microservice architecture enables continuous evolution of its business requirements.

(Optional) OpenHIM enterprise service bus, interoperability Layer

OpenHIM is built in NodeJS and is designed to ease interoperability between OpenCRVS and external healthcare systems. It provides external access to the system via secure APIs. OpenHIM is fully compatible with OpenCRVS and can be optionally included in the stack.

A market-leading, powerful search, audit and de-duplication engine powered by .

Real-time performance analytics powered by the time-series database .

An Amazon S3 compatible object store for storing supporting documentation attachments powered by .

Increased performance by the use of , reducing HTTP requests between client and server.

A single JS, codebase for backend, desktop and mobile using for offline and low-connectivity access.

External server and application health monitoring using

Automatic SSL configuration

OpenCRVS is a full-stack that is designed to give you the lowest possible .

Our international development teams work in an Agile way, in tandem with local development resources and human-centred designers, following the methodology, to rapidly design, build, deploy, test and maintain OpenCRVS releases.

The following dependencies are automatically provisioned alongside the OpenCRVS Core in containers in a Docker Swarm on Ubuntu.

was chosen by our architects in 2018 for it's lack of requirement of other essential dependencies, it's close alignment with Docker and it's simplicity in terms of installation and monitoring on a , on bare metal servers with headless . Why not use AWS, public cloud SaaS or serverless you might be thinking?

We are working on a migration now that Kubernetes has become a more mature, easier to use and configure solution, thanks to dependencies like Helm and other plugins increasing popularity since 2018. In the meantime, Docker Swarm makes it easy to commence containerised microservice package distribution privately, automatically configures a "round robin" load balanced cluster, and provides Service Discovery out-the-box.

The OpenCRVS data layer is . FHIR is a global standard for exchanging electronic health records.

In order to support configuration for limitless country scale, OpenCRVS was designed for , built on , and aligned to a globally recognised healthcare standard.

Massively scalable and extensible, is an OpenSource NoSQL database server originally built by the OpenCRVS founding member , using interoperable v4 ( Accredited, Fast Healthcare Interoperability Resources) as standard.

We extended to support the civil registration context. Our civil registration FHIR standard is described .

OpenCRVS uses , an industry standard, NoSQL document orientated, real-time de-duplication & search engine. Lightning fast, intelligent civil registration record returns are possible, even with imprecise “fuzzy” search parameters.

ElasticSearch is also used with for application and server health monitoring.

The hyper-efficient "time series database" is used in our stack for "big data" performance insights. Millisecond level query times facilitate civil registration statistical queries over years of data, disaggregated by gender, location and configurable operational and statistical parameters.

The core of OpenCRVS is a monorepo organised using . Each package represents a single microservice. Each microservice has over 80% unit test coverage in . Following the , 1 service per container model, every package is independently scalable in a single container.

\

The microservices are written in (a strictly typed superset of JavaScript that compiles to JavaScript) and NodeJS using the framework.

Each microservice in OpenCRVS has no knowledge of other services or business requirements in the application, and each exposes it’s capabilities via secured APIs.

The microservice API Gateway uses . allows OpenCRVS to perform much faster and more responsively in remote areas by drastically reducing the number of HTTP requests that are required in order to render a view in the presentation layer. The OpenCRVS GraphQL Gateway is a JWT protected server that requests and resolves resources from into GraphQL, for easy interoperability or client consumption.

Client applications are built using and technology. This means that we can take advantage of offline functionality and native mobile features using , without the overhead of maintaining multiple web and mobile codebases and respective App/Play Store releases.

In remote areas, registrars can save a configurable number of registrations offline on their mobile phone, using .

The is the interoperability layer of choice in the and interoperates natively using .

ElasticSearch
Influx
Minio
GraphQL
TypeScript
Progressive Web Application technology
Kibana
LetsEncrypt
"total cost of ownership"
Scrum
docker
Docker Swarm
Tier 2 private data centre
Ubuntu OS
Kubernetes
HL7 (Fast Healthcare Interoperability Resources) or FHIR
NoSQL
MongoDB
Hearth
Jembi Health Systems
Health Level 7
FHIR
ANSI
FHIR
here
ElasticSearch
Kibana
Influx
Lerna
Jest
microservice
docker
TypeScript
HapiJS
JWT
GraphQL
GraphQL
Apollo
FHIR
Hearth
React
progressive web application
Workbox
IndexedDB
OpenHIM (Health Information Mediator)
Open Health Information Exchange (OpenHIE) architectural standard
HL7 (Fast Healthcare Interoperability Resources) or FHIR
microservices
Docker Swarm
this section.
1MB
Application services and network diagram.png
image