Atomik Documentation

The Atomik documentation covers installation, configuration, the web console, the REST APIs, data modeling with openEHR, and integration patterns. This page gives you an overview and links to the main sections.

Getting Started

CaboLabs handles the full Atomik installation and configuration for you. You provide the server — we take care of everything else, and hand off complete documentation at the end.

What you provide

A server with root access — on-premises or on a private cloud of your choice

What CaboLabs delivers

Install all required OS packages and dependencies
Install and configure Atomik and the database
Configure networking, security, and service settings
End-to-end deployment validation
Full handoff documentation covering server setup, configuration, and operational procedures

Note: Working with Atomik requires familiarity with the openEHR information model. If your team is new to openEHR, we recommend completing the openEHR Foundations course before starting implementation. See Training for details.

Documentation Sections

The full documentation is organized into the following sections.

openEHR Basics

Foundation concepts for working with openEHR data. Covers the Reference Model, archetypes, templates, compositions, and the EHR structure — required reading before working with the API.

Web Console Guide

How to manage templates, EHRs, compositions, stored queries, users, and audit logs through the browser interface. Includes screenshots and step-by-step instructions.

Managing Data Models

How to create, upload, and version operational templates. Covers the relationship between archetypes, templates, and compositions, and how template changes affect stored data.

Storing Data

How compositions are processed, validated, and persisted by Atomik. Covers versioning behavior, error responses, and how to handle partial or invalid submissions.

Querying Data

How to use the query engine and visual query editor to retrieve clinical data across EHRs, time ranges, and template structures. Covers stored queries and worked examples for common patterns. Atomik supports a working subset of AQL — full AQL compliance is on the roadmap.

REST API Reference

Full API documentation for all Atomik endpoints: the openEHR REST API, Admin API, Sync API, and Monitoring API. Includes HTTP request and response examples for each operation.

Full Documentation

The complete Atomik documentation, including installation guides, API references, and worked examples, is available at:

atomik.app/documentation