1.3. Release Notes EHRbase 0.14.0 (beta)

This release of EHRbase (v0.14.0, October 1st 2020) is the second beta release.

The following changes are included in this version:

1.3.1. Added

1.3.2. Changed

1.3.3. Fixed

1.3.4. General Features

  • openEHR Reference Model Version 1.0.4
  • Serialisation of Reference Model Objects in Canonical JSON and XML
  • Archetype Definition Language 1.4
  • Data Validation against Operational Templates
  • openEHR REST API Endpoints (see below for details)

1.3.4.1. openEHR REST API

Based on the official openEHR REST API the following endpoints are implemented:

  • EHR (CREATE EHR, CREATE EHR with Id)
  • EHR_STATUS
  • COMPOSITION (Create, Update, Delete, Get Composition by Version Id, Get composition at time)
  • CONTRIBUTION (Create, Get of compositions. Other versioned object like EHR_STATUS coming soonly)
  • DIRECTORY (Create, Update, Delete, Get folder in directory version, get folder in directory version at time)
  • QUERY (Execute ad-hoc (non-stored) AQL Query, Execute stored query, parameters))
  • STORED_QUERY (List Stored Queries, Store a query, Get stored query, delete, parameters)
  • ADL 1.4 TEMPLATE (Upload a Template, List Templates, Get Template)

Note

The Swagger UI is generally WIP and currently does not distinguish between implemented endpoints and stubs! This means that you will see some endpoints that you cannot use)

Note

The data format for contributions sent through the REST API is not yet defined in the openEHR. Please refer to the examples. Also note that the format might be subject of change.

1.3.4.2. Conformance Tests

EHRbase ships with a set of tests verifying the conformance with the openEHR REST API. For now the tests include the following endpoints:

  • EHR
  • EHR_STATUS
  • COMPOSITION
  • CONTRIBUTION
  • ADL 1.4 TEMPLATE
  • DIRECTORY
  • QUERY