OpenClinAI
OpenClinAI brings together tools for clinical AI, patient-chart search, health-data analysis, and reproducible evaluation. This repository connects the projects and provides a shared development workspace.
Project website · Explore the projects · Contribute
Projects
| Project | What it does | Setup and source |
|---|---|---|
| ChartSearchAI | Lets clinicians ask questions about an OpenMRS patient chart and inspect answers with source citations. | Backend · OpenMRS frontend |
| Med Agent Hub | A shared service for applications to configure and call language models, including clinical-answer workflows. | Repository |
| Catalyst | A supervised SQL workbench and dashboard builder for exploring health data, reviewing queries and publishing results to Apache Superset. | Repository |
| QueryStore | Retrieves and organizes OpenMRS clinical records for chart search and AI applications. | Repository |
| Clinical AI Validation Harness | Runs clinical-AI experiments, collects outputs and evidence, and produces evaluation and review reports. | Repository |
ChartSearchAI integrates with OpenMRS. Catalyst supports SQL-connected data sources, including reporting workflows for OpenELIS Global. Each project provides installation and usage documentation in its repository.
For ChartSearchAI background and community discussion, see the OpenMRS project page. The OpenMRS repository links above point to the development forks used by this workspace.
Explore the projects
- ChartSearchAI overview: patient-chart search and clinical-answer workflows.
- Catalyst overview and screenshot walkthrough: query workbench and reporting workflows.
- Evaluation reports: published experiments and supporting evidence.
To install a project, follow its setup guide in the repositories listed above.
Contribute
For product development, use that project's repository and contributor instructions. For component integration and shared development tooling, use this workspace. The architecture explains how the projects fit together; the roadmap index lists current priorities and links each delivery stream's focused spec. Read the repository instructions before editing.
Workspace checkout
Cloning requires Git and authenticated GitHub access to this private repository. The checkout uses the component revisions recorded by the workspace.
git clone --recurse-submodules https://github.com/pmanko/openclinai.org.git
cd openclinai.org
For an existing clone, check for local changes before updating its submodules:
git submodule update --init --recursive
Workspace checks
Requires Python 3.10+:
python3 -m unittest discover -s tests -v
python3 scripts/check_workspace.py
These commands check documentation links and component checkout consistency. Each product supplies its own build and test instructions.
Shared development
For a fresh OpenMRS instance with the HIV dataset, ChartSearchAI and research
accounts, follow the research setup guide and run
make chartsearch-research-setup. This imports the baseline; it is not an upgrade.
After setup, make local-stack-up starts the whole environment with the saved
data and local settings. Stop it with make local-stack-down.
The root Makefile provides the shared environment and product build commands:
| Command | Purpose |
|---|---|
make openmrs-source-pair-build |
Build QueryStore, then ChartSearchAI, and stage their modules. |
make chartsearch-esm-build |
Build and stage the OpenMRS frontend. |
make local-stack-up |
Start the prepared OpenMRS, Hub and model-router environment. |
make local-stack-down |
Stop the local environment. |
make chartsearch-research-setup |
Fresh HIV OpenMRS setup and seven research accounts. |
make catalyst-mvp-up |
Start the configured Catalyst environment, retaining existing data. |
make validate-run SET=demo |
Run the selected validation experiment against prepared services. |
Read the component's setup instructions before building or starting it. Product builds require the component-specific Java, Node, Docker or model-service tools. Connection settings and credentials belong in ignored environment files.
Website
Website pages and assets are in landing/; documentation and interactive previews
are in site/. The website guide covers local builds, checks and
publication. Static hosting configuration lives in compose/website/, and the
GitHub Pages workflow is configured in this repository.