Admin API (development)

CodegenDownloadDEVELOPMENT

Description

Purpose

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

Prerequisite documents for reading this document include:

Related documents include:

Status

This specification is in the DEVELOPMENT 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/development/admin.html.

EHR

Admin management of EHRs.

Delete EHR

Deletes the EHR identified by ehr_id.

All corresponding or owned resources, such as COMPOSITION, EHR_STATUS, ITEM_TAG, etc. including historical versions, will also be (physically) deleted.

The server may perform this operation in an asynchronous way (in batches), in which case status 202 Accepted is returned, or may perform this operation directly, in which case (by successful outcome) will return status 204 No Content.

path Parameters
ehr_id
required
string <uuid>
Example: 7d44b88c-4199-4bad-97dc-d78268e01398

EHR identifier taken from EHR.ehr_id.value.

Responses

Delete all EHRs

Deletes all EHRs, or a subset of EHRs defined using the ehr_id query parameter.

All corresponding or owned resources by the candidate EHRs, such as COMPOSITION, EHR_STATUS, ITEM_TAG, etc. including historical versions, will also be (physically) deleted.

The server may perform this operation in an asynchronous way (in batches), in which case status 202 Accepted is returned, or may perform this operation directly, in which case (by successful outcome) will return status 204 No Content.

query Parameters
ehr_id
string <uuid>
Examples:
  • ehr_id=7d44b88c-4199-4bad-97dc-d78268e01398 - A single EHR identifier
  • ehr_id=7d44b88c-4199-4bad-97dc-d78268e01398&ehr_id=297c3e91-7c17-4497-85dd-01e05aaae44e - Multiple EHR identifiers

An optional parameter to perform the operation on a subset of EHRs.

Responses