1.1. Release Notes EHRbase 0.12.0 (alpha)

This release of EHRbase (v0.12.0, March 31 2020) adds basic authentication (see details below) and allows to overwrite templates. we consider EHRbase to be still in alpha status.

The following changes are included in this version:

1.1.1. Added

1.1.2. Fixed

1.1.3. 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.1.3.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.1.3.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

1.1.4. What (basic) features you might miss

  • VERSIONED_OBJECT Endpoints are not implemented
  • EHR functions like is_modifyable and is_queryable are not yet supported

1.1.5. Known Issues

As EHRbase is still in alpha status, there are plenty of known issues. If you try things out, please be aware that the following issues are known and documented:

1.1.5.1. Archetype Query Language

  • ehr e projection not supported
  • Not supported variables in archetype_id predicates
select e/ehr_id/value, e/time_created/value, e/system_id/value from EHR
e CONTAINS COMPOSITION c [$archetype_id]
  • TIMEWINDOW keyword is not supported
SELECT e/ehr_id/value FROM EHR e TIMEWINDOW PT12H/2019-10-24