openEHR Definition API
Description Purpose This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Description
Purpose
This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with the openEHR Definition API in a RESTful manner.
Related Documents
Prerequisite documents for reading this document include:
Related documents include:
- The openEHR Architecture Overview
- The Archetype Technology Overview
- The openEHR Global Class Index
- The XML-Schemas (XSD)
- The JSON-Schemas and [Simplified Formats](simplified_formats.html)
Status
This specification is in the STABLE state, and can be downloaded as OpenAPI specification file (in YAML format) [for validation](computable/OAS/definition-validation.openapi.yaml), or [for code generators](computable/OAS/definition-codegen.openapi.yaml).
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 .
Endpoints 13
ADL1.4
- GETList templates
/definition/template/adl1.4List the available ADL 1.4 operational templates (OPT) on the system. - POSTUpload a template
/definition/template/adl1.4Upload a new ADL 1.4 operational template (OPT). - GETGet a template
/definition/template/adl1.4/:template_idRetrieves the ADL 1.4 operational template (OPT) identified by template_id identifier. Note that this can return either the original (canonical) XML based OPT… - GETGet example data by template
/definition/template/adl1.4/:template_id/exampleGenerates and retrieves an example data instance based on an ADL 1.4 operational template (OPT) identified by the template_id parameter. The generated example…
ADL2
- GETList templates
/definition/template/adl2List the available ADL2 operational templates on the system. - POSTUpload a template
/definition/template/adl2Upload a new ADL2 operational template. - GETGet a template
/definition/template/adl2/:template_idRetrieves the latest version of the ADL2 operational template identified by template_id identifier. - GETGet example data by template
/definition/template/adl2/:template_id/exampleGenerates and retrieves an example data instance based on an ADL2 operational template (OPT) identified by the template_id parameter. The generated example… - GETGet a template at version
/definition/template/adl2/:template_id/:versionDeprecated. Retrieves the ADL2 operational template identified by template_id identifier, at specified version.
Query
- GETList stored queries
/definition/query/:qualified_query_nameRetrieves list of all stored queries on the system matched by qualified_query_name as pattern. If pattern should given be in the format of… - PUTStore a query
/definition/query/:qualified_query_nameStores a new query, or updates an existing query on the system. - GETGet stored query at version
/definition/query/:qualified_query_name/:versionRetrieves the definition of a particular stored query (at specified version) and its associated metadata. - PUTStore a query version
/definition/query/:qualified_query_name/:versionStores a query, at a specified version, on the system.
API details
- Base URL
https://{baseUrl}/v1- Authentication
- None declared in the description
- Operations
- 13 operations on 9 pathsGET 9PUT 2POST 2
1 marked deprecated - Main resources
- ADL2 5ADL1.4 4Query 4
- Description format
- OpenAPI 3.0.3, API version
latest - Links
- OpenAPI document · Support
- Listed from
- openEHR's published OpenAPI description (openEHR/specifications-ITS-REST) (Apache-2.0)
How to test the openEHR Definition API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the openEHR Definition API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List templates” (GET /definition/template/adl1.4), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the openEHR Definition API?
Description Purpose This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with… It is listed under Healthcare and has 13 endpoints.
Who publishes the openEHR Definition API?
It is listed from openEHR's public API description (an OpenAPI document), not published by openEHR on Swastik Codes. Anyone who controls openehr.org can claim the profile by adding a DNS TXT record.
What is the base URL of the openEHR Definition API?
Requests go to https://{baseUrl}/v1. Endpoint paths are added to this base URL.
How do I authenticate with the openEHR Definition API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the openEHR Definition API have?
13 operations on 9 paths (9 GET, 2 PUT, 2 POST). The largest groups are ADL2, ADL1.4, Query.
Is forking the openEHR Definition API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.