# EHRbase openEHR REST API

**Canonical:** https://apis.io/apis/ehrbase/openehr-rest-api/  
**Provider:** EHRbase — https://apis.io/providers/ehrbase/  
**Base URL:** https://sandkiste.ehrbase.org/ehrbase  
**Documentation:** https://docs.ehrbase.org/api/hip-ehrbase/openehr

EHRbase openEHR REST API is one of 3 APIs that [EHRbase](https://apis.io/providers/ehrbase/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include openEHR, Electronic Health Records, Clinical Data, AQL, and Healthcare. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The standard openEHR ITS-REST 1.0.2 surface - 31 paths and 45 operations covering EHR, EHR_STATUS, COMPOSITION, VERSIONED_COMPOSITION, CONTRIBUTION, DIRECTORY, operational templates (ADL 1.4 and ADL 2), stored queries and ad-hoc AQL execution. Writes are versioned rather than mutated, guarded by If-Match on the preceding version_uid, and audited through the openEHR-AUDIT_DETAILS header. EHRbase adds two non-standard but essential projections: the web template (a flattened node tree with aqlPath per leaf) and the flat/structured JSON composition media types.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/openapi/ehrbase-openehr-rest-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/overlays/ehrbase-openehr-rest-overlay.yaml
- **Documentation** — https://docs.ehrbase.org/docs/EHRbase/Explore/openEHR-REST
- **APIReference** — https://docs.ehrbase.org/api/hip-ehrbase/openehr
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/apis.yml

## Other EHRbase APIs (2)

- [EHRbase Admin API](https://apis.io/apis/ehrbase/admin-api/)
- [EHRbase Status and Metrics API](https://apis.io/apis/ehrbase/status-api/)

## Tags

openEHR, Electronic Health Records, Clinical Data, AQL, Healthcare

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ehrbase/openehr-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ehrbase/.