Open industry specifications, models
and software for e-health
openEHR components

REST API specifications (ITS-REST) Component - 1.0.3

Specifications

Specification Description
STABLE Overview The overview of various aspects and requirements of openEHR REST APIs.
STABLE EHR API This specification describes service endpoints, resources, functions and operations as well as details of requests and responses that interacts with an openEHR EHR API in a RESTful manner.
STABLE Query API This specification describes service endpoints, resources, functions and operations as well as details of requests and responses that interacts with an openEHR Query API in a RESTful manner.
STABLE Definition API This specification describes service endpoints, resources, functions and operations as well as details of requests and responses that interacts with the openEHR Definition API in a RESTful manner. Definitions includes Archetypes, Templates and Operational Templates (OPTs).
DEVELOPMENT SDT Simplified Data Template specification - a simplified data representation for committing data to the openEHR EHR.
TRIAL OAS 3.0 The openEHR REST API specifications as OpenAPI Specification v3.0 files in YAML format.

Releases

Release Date Description
Release 1.0.3 19-Dec-2022 The latest released specifications of REST API specifications (ITS-REST) Component | Release notes
Release 1.0.2 24-Apr-2021 Release notes
Release 1.0.1 03-Nov-2019 Release notes
Release 1.0.0 07-Dec-2018 Release notes

Work In Progress

Release Description
Development The development version of specifications of REST API specifications (ITS-REST) Component | GitHub repo
Release 1.1.0 Issues | Changes

Computable Expressions

Resource Description
REST API src REST API specifications as OpenAPI Specification v3.0 files.