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
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:
An optional parameter to perform the operation on a subset of EHRs. |