openEHR

openEHR COMPOSITION API

Management of [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_composition_class) and [VERSIONED_COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_composition_class) resources. Operations include create, retrieve, update, delete of compositions, and access to their version containers, specific versions and revision history.

GitHub OpenAPI

Operations 8

POST /ehr/{ehr_id}/composition Create COMPOSITION #
GET /ehr/{ehr_id}/composition/{uid_based_id} Get COMPOSITION #
PUT /ehr/{ehr_id}/composition/{uid_based_id} Update COMPOSITION #
DELETE /ehr/{ehr_id}/composition/{uid_based_id} Delete COMPOSITION #
GET /ehr/{ehr_id}/versioned_composition/{versioned_object_uid} Get versioned COMPOSITION #
GET /ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/revision_history Get versioned COMPOSITION revision history #
GET /ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version Get versioned COMPOSITION version at time #
GET /ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version/{version_uid} Get versioned COMPOSITION version by id #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/openapi/openehr-composition-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/json-schema/openehr-rm-1.1.0-all.json
📊
JSONSchema
https://specifications.openehr.org/releases/ITS-JSON/latest/components/openehr_rm_1.1.0_all.json

Other Resources

🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/ehr-validation.openapi.yaml
🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/query.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/query-validation.openapi.yaml
🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/definition.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/definition-validation.openapi.yaml
🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/overview.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/system-validation.openapi.yaml
🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/demographic.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/demographic-validation.openapi.yaml
🔗
Specification
https://specifications.openehr.org/releases/ITS-REST/latest/admin.html
🔗
SourceCode
https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/admin-validation.openapi.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openehr-composition-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openehr-composition-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EHR COMPOSITION API
  version: latest
  x-status: STABLE
  x-spec: ehr
  contact:
    name: Specifications Editorial Committee openEHR
    url: https://specifications.openehr.org/
    email: info@openehr.org
  license:
    name: Creative Commons Attribution-NoDerivs 3.0 Unported
    url: https://creativecommons.org/licenses/by-nd/3.0/
  description: '## Description


    ### Purpose


    This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with the openEHR EHR API in a RESTful manner.'
servers:
- url: https://{baseUrl}/v1
  description: An example openEHR server URL.
  variables:
    baseUrl:
      default: openEHRSys.example.com
      description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
security: []
tags:


# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/openapi/openehr-composition-api-openapi.yml