Admin API (development)
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.
Related Documents
Prerequisite documents for reading this document include:
- The EHR Information Model
- The Demographic Information Model
- The Operational Template 2
- The Archetype Query Language(AQL)
Related documents include:
- The openEHR Architecture Overview
- The openEHR Global Class Index
- The XML-Schemas (XSD)
- The JSON-Schemas and Simplified Data Template (SDT)
- The openEHR Platform Abstract Service Model
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.
Admin management of EHRs.
Delete EHR by id
Deletes the EHR identified by ehr_id.
All resources associated with or owned by the specified EHR (such as COMPOSITION, EHR_STATUS, ITEM_TAG, CONTRIBUTION, and their historical versions) will also be permanently and physically deleted, in compliance with applicable data protection regulations (e.g., the GDPR in the European Union).
The server may execute this operation asynchronously (e.g. in batches), in which case returns status 202 Accepted.
If the deletion is processed synchronously and completes successfully, the server returns 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 multiple EHRs
Deletes all or multiple EHRs, or a specified subset of EHRs identified using the ehr_id query parameter.
NOTE: This functionality is intended primarily for development or testing purposes and may be disabled in production environments, in which case server may respond with
405 Method Not Allowed.
All resources associated with or owned by the targeted EHRs (such as COMPOSITION, EHR_STATUS, ITEM_TAG, CONTRIBUTION, and their historical versions) will also be permanently and physically deleted, in compliance with applicable data protection regulations (e.g., the GDPR in the European Union).
The server may execute this operation asynchronously (e.g. in batches), in which case returns status 202 Accepted.
If the deletion is processed synchronously and completes successfully, the server returns status 204 No Content.
query Parameters
| ehr_id | string <uuid> Examples:
An optional parameter to perform the operation on a subset of EHRs. |