Skip to main content

Item Tags

warning

This is an experimental feature.

Introduction

openEHR is in the process of specifying tags, which, amongst other use-cases, could be used to handle annotations. A draft of a data model has already been defined, consensus concerning REST API or AQL binding has not yet been reached. Therefore, the implementation is based on/inspired by these efforts.

The Data Model is based on the development version of the openEHR-RM spec for tags (ITEM_TAG): EHR Information Model Common Information Model.

Configuration

ENV.ymlValue to setDefault
EHRBASE_REST_EXPERIMENTAL_TAGS_ENABLEDehrbase.rest.experimental.tags.enabledtrue/falsefalse
EHRBASE_REST_EXPERIMENTAL_TAGS_CONTEXTPATHehrbase.rest.experimental.tags.context-pathContext for the item_tags endpoints/rest/experimental/tags

REST API

For managing Item Tags through the REST API checkout the Item Tag API Definition.