Skip to main content
API docs by Redocly

Admin API (1.0.0)

Download OpenAPI specification:Download

Overview

Purpose

This specification describes service endpoints, resources and operations as well as details of requests and responses that interacts with EHR openEHR API in a RESTful manner.

Status

This specification is in the STABLE state, and can be downloaded as OpenAPI specification file (in YAML format) for validation, or for code generators. Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.

The development version of this document can be found at https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html.

Composition

Delete Composition

Removes a composition and all related and not otherwise referenced data from EHRbase

path Parameters
ehr_id
required
string
composition_id
required
string
Example: {{last_composition_id_short}}

Responses

EHR

Administrative routes for EHRs

Update EHR

Sends new data for a specific EHR entry which will replace the old content of this EHR withour history entries

path Parameters
ehr_id
required
string
Example: {{ehr_id}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Delete EHR

Removes and EHR phyically from the database. All corresponding resources will also be removed including all history entries.

path Parameters
ehr_id
required
string
Example: {{ehr_id}}

Responses

Contribution

Update Contribution

Replaces the content of a Contribution with the new data sent with the request

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Directory

Delete directory

Delete a diretory of an EHR physically from database

path Parameters
ehr_id
required
string
directory_id
required
string
Example: {{folder_id_short}}

Responses

Template

Update template

Updated a given template by replacing the content of the template by the new sent data. If there is still data referencing the template the request will be rejected

path Parameters
template_id
required
string
Example: International Patient Summary

Responses

Delete template

Removes a given template from database physically. If there is still data referencing the template the request will be rejected

path Parameters
template_id
required
string
Example: International Patient Summary

Responses

Delete all templates

Deletes all templates from database physically if there were no more Compositions referencing templates.

Responses

Query

Delete Stored Query Version

Deletes a stored query version

path Parameters
qualified_query_name
required
string
Example: org.ehrbase::compositions_with_high_blood_pressure
version
required
string
Example: 1.0.0

Responses

Status & Management

Admin API status

Get the admin api status

Responses