| 🎉 OpenCDx v1.0.1 is here ↓ |
|---|
| Updated libraries, minor feature enhancements, and DX polish across repos. |
Table of Contents
Use the Table of Contents below to quickly navigate through the key sections and repositories of the OpenCDx platform.
- Introduction
- 🚀 Minimum Installation
- Repositories Overview
- Next Steps
- Related Links
- OpenCDx Team Members
OpenCDx is a comprehensive platform designed for clinical data management, offering secure, scalable, and interoperable solutions across healthcare systems. The OpenCDx ecosystem includes several repositories that work together to streamline data management, enable clinical decision-making, and enhance user experiences.
🚀 Minimum Installation
To get started, you only need the core OpenCDx Repository.
The OpenCDx Repository forms the platform's backbone, providing core backend services, secure clinical data management, and interoperability. The OpenCDx GUI repository enhances this core, adding an administrative dashboard for system configuration and management, along with a client-facing application to facilitate public user interaction. Data collected via OpenCDx and OpenCDx-GUI is stored and also extended to the OpenCDx ADR repository. Stored data can then be easily queried using OpenCDx ADR-gui. Additionally, the OpenCDx UI Library ensures visual consistency by providing reusable UI components across all platform interfaces.
Below is a breakdown of the repositories under the OpenCDx organization:
Repository: OpenCDx
Overview:
OpenCDx serves as the core platform for managing clinical data in a healthcare environment. It acts as the backbone of the OpenCDx ecosystem, providing the backend services for data management, interoperability, and integration across different healthcare systems. This includes essential backend services and provides a system GUI for service management, along with a Swagger interface for easy API invocation.
Key Features:
- Data Management: Handles clinical data storage and retrieval.
- Interoperability: Ensures seamless communication between systems (e.g., medical devices, EHRs).
- Core Functionality: Manages the primary functions related to clinical data such as user access, data flow, system configuration, monitoring, and security.
Repository: OpenCDx GUI
Overview:
OpenCDx GUI is the graphical user interface for interacting with the OpenCDx platform. It provides a user-friendly interface that allows clinical teams and system administrators to visualize and manage clinical data workflows. OpenCDx-GUI includes an admin dashboard for administrative control and client app to configure interface for the public user.
Key Features:
- Interactive Dashboard: Centralized view of the OpenCDx system for monitoring and management.
- Real-Time Data Viewing: Allows users to interact with live data and clinical workflows.
- User-Friendly Interface: Simplifies interaction with complex clinical data.
Repository: OpenCDx ADR
Overview:
OpenCDx ADR serves as a data store for managing clinical data, including form responses, test results, and clinical observations. It allows users to efficiently query and retrieve data, providing a centralized platform for data management and integration.
Key Features:
- Centralized Data Store: Organizes and stores clinical data to enable easy querying and retrieval.
- Query Capabilities: Supports querying of form responses, test results, and other clinical data types in a normalized format.
- Interoperability: Facilitates integration with external systems and partners, allowing smooth data exchange and collaboration.
- Data Management: Ensures data consistency, security, and scalability for future growth.
Repository: OpenCDx ADR-gui
Overview:
OpenCDx ADR-gui provides a graphical user interface (GUI) for interacting with ADR data. This interface enables users to easily build queries and view ADR data in a visual, user-friendly manner.
Key Features:
- Web-Based Interface: Built using modern technologies like Next.js and React.
- Drag-and-Drop Query Builder: Makes it easy to build queries for interacting with ADR data.
- Real-Time Query Execution: Provides immediate feedback when querying ADR records.
- Docker Support: Allows for easy deployment of the GUI.
Repository: OpenCDx UI Library
Overview:
The OpenCDx UI Library is a set of reusable UI components and templates that serve as the foundational design layer for the OpenCDx ecosystem. These components are packaged as a Node.js module and are used across various OpenCDx GUI repositories to ensure consistent and efficient development.
Key Features:
- Reusable Components: Common UI elements like buttons, forms, and tables.
- Tailwind CSS Integration: Ensures responsive design and customization options.
- Component-Based Architecture: Provides standardized, modular components for integration across different repositories.
To get started with OpenCDx, follow these steps:
- Minimum Installation: Clone the essential OpenCDx Repository, which provides core backend services, system GUI, and Swagger interfaces.
- Optionally, clone other repositories based on your requirements.
- Follow each repository's README for detailed installation instructions.
- Integrate and configure components to effectively manage clinical data.
All OpenCDx repositories seamlessly integrate to offer a scalable and efficient solution for clinical data management and healthcare interoperability.
Explore additional resources and documentation to deepen your understanding of OpenCDx, its use cases, and the broader ecosystem. Below you'll find helpful links providing more detailed explanations, guides, and background information to support your OpenCDx implementation.
| Tag | Release Type | Release Date | Title | OpenCDx Repositories | ADR Repositories | UI Library | ||
|---|---|---|---|---|---|---|---|---|
| v1.0.0 | Major | 04/14/2025 | Initial Open Source Release of OpenCDx | opencdx | opencdx-gui | ADR | ADR-gui | ui-library |
| v1.0.1 | Minor | 10/20/2025 | Updated libraries and improved developer experience | opencdx | opencdx-gui | N/A | N/A | ui-library |
Ravinder Singh ([email protected])
Jeff Miller ([email protected])
Ranga Lakshminarayanan ([email protected])
Patrick Chou ([email protected])
Karthick Rajamurugan ([email protected])
Gaurav Mishra ([email protected])