# OpenHIM Platform ## OpenHIM Platform - [OpenHIM Platform](https://jembi.gitbook.io/openhim-platform/readme.md): What is the OpenHIM Platform and what can you use it for? - [Getting Started](https://jembi.gitbook.io/openhim-platform/readme-1.md): What you need to start using OpenHIM Platform. - [Recipes](https://jembi.gitbook.io/openhim-platform/recipes.md): Pre-defined recipes for common use cases - [Central Data Repository with Data Warehousing](https://jembi.gitbook.io/openhim-platform/recipes/central-data-repository-with-data-warehousing.md) - [Central Data repository (no reporting)](https://jembi.gitbook.io/openhim-platform/recipes/central-data-repository-no-reporting.md) - [Master Patient Index](https://jembi.gitbook.io/openhim-platform/recipes/master-patient-index.md) - [Packages](https://jembi.gitbook.io/openhim-platform/packages.md): The OpenHIM Platform includes a number of base packages which are useful for supporting Health Information Exchanges Workflows. Each section below describes the details of these packages. - [Interoperability Layer Openhim](https://jembi.gitbook.io/openhim-platform/packages/interoperability-layer-openhim.md): The interoperability layer that enables simpler data exchange between the different systems. It is also the security layer for the other systems. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/interoperability-layer-openhim/local-development.md): The Interoperability Layer is the base of the Platform architecture. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/interoperability-layer-openhim/environment-variables.md): Listed in this page are all environment variables needed to run the interoperability layer Openhim. - [Monitoring](https://jembi.gitbook.io/openhim-platform/packages/monitoring.md): A package for monitoring the platform services - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/monitoring/environment-variables.md): Listed in this page are all environment variables needed to run Monitoring package. - [Kafka Mapper Consumer](https://jembi.gitbook.io/openhim-platform/packages/kafka-mapper-consumer.md): A Kafka consumer that maps FHIR resources to a flattened data structure. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/kafka-mapper-consumer/local-development.md): A Kafka consumer that maps FHIR resources to a flattened data structure - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/kafka-mapper-consumer/environment-variables.md): Listed in this page are all environment variables needed to run Kafka mapper consumer. - [Data Mapper Logstash](https://jembi.gitbook.io/openhim-platform/packages/data-mapper-logstash.md): Generic Logstash pipeline for ELK stack. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/data-mapper-logstash/local-development.md): Generic Logstash pipeline for ELK stack. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/data-mapper-logstash/environment-variables.md): Listed in this page are all environment variables needed to run Logstash. - [Job Scheduler Ofelia](https://jembi.gitbook.io/openhim-platform/packages/job-scheduler-ofelia.md): A job scheduling tool. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/job-scheduler-ofelia/local-development.md): A job scheduling tool. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/job-scheduler-ofelia/environment-variables.md): Listed in this page are all environment variables needed to run Ofelia. - [Analytics Datastore - Clickhouse](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-clickhouse.md): Clickhouse is a SQL datastore. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-clickhouse/local-development.md): Clickhouse is a SQL datastore - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-clickhouse/environment-variables.md): Listed in this page are all environment variables needed to run Clickhouse. - [Analytics Datastore - Elasticsearch](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch.md): Elasticsearch is the datastore for the Elastic (ELK) Stack. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch/local-development.md): Elasticsearch is the datastore for the Elastic (ELK) Stack - [Running in Clustered Mode](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch/running-in-clustered-mode.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch/environment-variables.md): Listed in this page are all environment variables needed to run and initialize Elasticsearch. - [Client Registry - SanteMPI](https://jembi.gitbook.io/openhim-platform/packages/client-registry-santempi.md): A patient matching and deduplicater for the platform - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/client-registry-santempi/environment-variables.md): Listed in this page are all environment variables needed to run Kibana. - [Dashboard Visualiser - Jsreport](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-js-report.md): Jsreport is a visualisation tool configured to query data from Elasticsearch. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-js-report/local-development.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-js-report/environment-variables.md): Listed in this page are all environment variables needed to run Jsreport. - [Dashboard Visualiser - Kibana](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-kibana.md): Kibana is a visualisation tool forming part of the Elastic (ELK) Stack for creating dashboards by querying data from ElasticSearch. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-kibana/local-development.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-kibana/environment-variables.md): Listed in this page are all environment variables needed to run Kibana. - [Dashboard Visualiser - Superset](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-superset.md): Superset is a visualisation tool meant for querying data from a SQL-type database. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-superset/local-development.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/dashboard-visualiser-superset/environment-variables.md): Listed in this page are all environment variables needed to run Superset. - [Message Bus - Kafka](https://jembi.gitbook.io/openhim-platform/packages/message-bus-kafka.md): Kafka is a stream processing platform which groups like-messages together, such that the number of sequential writes to disk can be increased, thus effectively increasing database speeds. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/message-bus-kafka/local-development.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/message-bus-kafka/environment-variables.md): Listed in this page are all environment variables needed to run the Message Bus Kafka. - [FHIR Datastore HAPI FHIR](https://jembi.gitbook.io/openhim-platform/packages/fhir-datastore-hapi-fhir.md): A FHIR compliant server for the platform. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/fhir-datastore-hapi-fhir/local-development.md): A FHIR compliant server for the platform. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/fhir-datastore-hapi-fhir/environment-variables.md): Listed in this page are all environment variables needed to run hapi-fhir package. - [Kafka Unbundler Consumer](https://jembi.gitbook.io/openhim-platform/packages/kafka-unbundler-consumer.md): A kafka processor to unbundle resources into their own kafka topics. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/kafka-unbundler-consumer/environment-variables.md): A kafka processor to unbundle resources into their own kafka topics. - [Message Bus Helper Hapi Proxy](https://jembi.gitbook.io/openhim-platform/packages/message-bus-helper-hapi-proxy.md): A helper package for the Kafka message bus. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/message-bus-helper-hapi-proxy/environment-variables.md): Listed in this page are all environment variables needed to run Hapi-proxy. - [Reverse Proxy Nginx](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-nginx.md): Reverse proxy for secure and insecure nginx configurations. - [Local Development](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-nginx/local-development.md): Reverse proxy for secure and insecure nginx configurations. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-nginx/environment-variables.md): Listed in this page are all environment variables needed to run Reverse Proxy Nginx. - [OpenFn](https://jembi.gitbook.io/openhim-platform/packages/openfn.md) - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/openfn/environment-variables.md) - [Reverse Proxy Traefik](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-traefik.md): Reverse proxy for secure traefik configurations. - [Environment Variables](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-traefik/environment-variables.md) - [Cheat sheet](https://jembi.gitbook.io/openhim-platform/cheat-sheet.md): This page gives a list of common command and examples for easy reference - [Architecture](https://jembi.gitbook.io/openhim-platform/architecture.md) - [Guides](https://jembi.gitbook.io/openhim-platform/guides.md): Various notes and guide - [Provisioning remote servers](https://jembi.gitbook.io/openhim-platform/guides/provisioning-up-remote-servers.md): Infrastructure tools for the OpenHIM Platform - [Ansible](https://jembi.gitbook.io/openhim-platform/guides/provisioning-up-remote-servers/ansible.md): A tool that enables infrastructure as code for provision of the servers. - [Terraform](https://jembi.gitbook.io/openhim-platform/guides/provisioning-up-remote-servers/terraform.md): A tool that enables infrastructure as code to set up servers in AWS EC2. - [Resource Allocations](https://jembi.gitbook.io/openhim-platform/guides/resource-allocations.md): Allot CPU and RAM resources to services, per service, per server. - [Disaster Recovery Process](https://jembi.gitbook.io/openhim-platform/guides/disaster-recovery-process.md): Backup & restore process. - [Elasticsearch](https://jembi.gitbook.io/openhim-platform/guides/disaster-recovery-process/elasticsearch.md): Elasticsearch Backup & Restore. - [HAPI FHIR Data](https://jembi.gitbook.io/openhim-platform/guides/disaster-recovery-process/hapi-fhir-data.md): FHIR messages Backup & Restore. - [OpenHIM Data](https://jembi.gitbook.io/openhim-platform/guides/disaster-recovery-process/openhim-data.md): OpenHIM backup & restore - [Development](https://jembi.gitbook.io/openhim-platform/guides/development.md) - [Config Importing](https://jembi.gitbook.io/openhim-platform/guides/development/config-importing.md): This section defines the configuration importing methods used in the Platform - [Performance Testing](https://jembi.gitbook.io/openhim-platform/guides/performance.md) - [Community](https://jembi.gitbook.io/openhim-platform/community.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://jembi.gitbook.io/openhim-platform/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.