# CKM REST API

**Canonical:** https://apis.io/apis/ocean-health-systems/ckm-rest-api/  
**Provider:** Ocean Health Systems — https://apis.io/providers/ocean-health-systems/  
**Base URL:** https://ckm.openehr.org/ckm/rest/v1  
**Documentation:** https://ckm.openehr.org/ckm/rest-doc/

CKM REST API is published by [Ocean Health Systems](https://apis.io/providers/ocean-health-systems/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include openEHR, Clinical Knowledge Management, Clinical Data, Archetypes, and Terminology. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

REST API for the Clinical Knowledge Manager — 48 operations across 39 paths covering archetypes (list, search, ADL/XML/mindmap retrieval, specialisation parent, status by asset version, MD5 hash, import, trunk update, delete), templates (list, search, OET/OPT retrieval, file-set URL, required archetypes, embedded templates, validation report, status read and update, import, trunk update, delete), the archetype/template union "resources" view with the instance publisher namespace, projects and subdomains, change requests and resource proposals, and user and session management. Authentication is HTTP Basic or a JSESSIONID session header; public projects on a public instance read anonymously.

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/openapi/ocean-health-systems-ckm-rest-api-openapi.json
- **Documentation** — https://ckm.openehr.org/ckm/rest-doc/
- **APIReference** — https://ckm.openehr.org/ckm/rest-doc/
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/overlays/ocean-health-systems-ckm-rest-api-overlay.yaml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/authentication/ocean-health-systems-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/conventions/ocean-health-systems-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/errors/ocean-health-systems-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/data-model/ocean-health-systems-data-model.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/rate-limits/ocean-health-systems-rate-limits.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/apis.yml

## Tags

openEHR, Clinical Knowledge Management, Clinical Data, Archetypes, Terminology, Health Informatics, Interoperability

---

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