How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
openEHR

openEHR Definition API

Manage the definition layer — ADL 1.4 and ADL 2 templates, operational templates and stored queries. openEHR SPECIFICATION, not a callable service — 13 operation(s) across 9 path(s), served from the templated host `https://{baseUrl}/v1`.

Documentation Provider Profile APIs.io OpenAPI GitHub

openEHR Definition API is one of 6 APIs that openEHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include openEHR, Healthcare, EHR, and Specification. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 9 paths, organized into 3 resource areas, and defines 136 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://{baseUrl}/v1.

13 operations 9 paths 136 schemas 9 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Server
https://{baseUrl}/v1
Contact
Specifications Editorial Committee openEHR
License
Creative Commons Attribution-NoDerivs 3.0 Unported
Resource Areas
3

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 9 GET, 2 POST, 2 PUT. They span 3 resource areas: ADL1.4, ADL2, Query. Each is listed below with its method, path, parameters, and response codes.

ADL1.4 4

Management of [AOM and ADL 1.4](https://specifications.openehr.org/releases/AM/latest) Operational Templates (OPTs). These templates can be created using [modelling tools](https:/…

POST
/definition/template/adl1.4
Upload a template
definition_template_adl1.4_upload 3 params body → 201400409
GET
/definition/template/adl1.4
List templates
definition_template_adl1.4_list 6 params → 200
GET
/definition/template/adl1.4/{template_id}
Get a template
definition_template_adl1.4_get 2 params → 200400404406
GET
/definition/template/adl1.4/{template_id}/example
Get example data by template
definition_template_adl1.4_example_get 4 params → 200400404406
ADL2 5

Management of [AOM2](https://specifications.openehr.org/releases/AM/latest/AOM2.htmltemplates) templates. See also [ADL2 Template specifications](https://specifications.openehr.or…

POST
/definition/template/adl2
Upload a template
definition_template_adl2_upload 4 params body → 201400409
GET
/definition/template/adl2
List templates
definition_template_adl2_list 6 params → 200
GET
/definition/template/adl2/{template_id}
Get a template
definition_template_adl2_get 2 params → 200400404
GET
/definition/template/adl2/{template_id}/example
Get example data by template
definition_template_adl2_example_get 4 params → 200400404406
GET
/definition/template/adl2/{template_id}/{version}deprecated
Get a template at version
definition_template_adl2_version_get 3 params → 200400404
Query 4

Management of stored (registered) queries in the system, including creation of new versions and retrieval by qualified name and version. These endpoints enable registration and li…

GET
/definition/query/{qualified_query_name}
List stored queries
definition_query_list 2 params → 200
PUT
/definition/query/{qualified_query_name}
Store a query
definition_query_store.yaml 4 params body → 200400
PUT
/definition/query/{qualified_query_name}/{version}
Store a query version
definition_query_version_store.yaml 4 params body → 200400409
GET
/definition/query/{qualified_query_name}/{version}
Get stored query at version
definition_query_version_get 3 params → 200404

Schemas 136

The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are UMInstruction (19 properties), UMAction (19 properties), UMObservation (17 properties), Child1 (17 properties). Each schema is shown below with its type and property counts.

TemplateMetadata
object
Uploaded TEMPLATE meta information.
5 properties 4 required
TemplateList
array
List of uploaded TEMPLATE resources.
OperationalTemplate
object
LocalizedNames
object
1 property 1 required
LocalizedDescriptions
object
1 property 1 required
LocalizedNames1
object
1 property 1 required
LocalizedNames2
object
2 properties 1 required
Annotations
object
2 properties
Precision
object
4 properties 4 required
Range
object
4 properties 2 required
Validation
object
2 properties
LocalizedLabels
object
1 property 1 required
List
object
5 properties 2 required
Validation1
object
2 properties 1 required
Input
object
5 properties 1 required
SNOMEDCT
object
2 properties 2 required
TermBindings
object
1 property 1 required
Input1
object
2 properties 1 required
Child3
object
11 properties 10 required
Child2
object
16 properties 11 required
List1
object
4 properties 4 required
Input2
object
3 properties 1 required
Annotations1
object
2 properties
Child1
object
17 properties 6 required
List2
object
3 properties 3 required
Input3
object
4 properties 2 required
Child
object
14 properties 5 required
Tree
object
11 properties 11 required
WebTemplate
object
5 properties 5 required
TemplateIdentifier
object
1 property 1 required
Error
object
2 properties 2 required
UMDvUri
object
2 properties 2 required
DvEhrUri
object
2 properties 1 required
UMDvEhrUri
object
2 properties 2 required
UDvUri
object
TerminologyId
object
2 properties 1 required
CodePhrase
object
3 properties 2 required
DvCodedText
object
8 properties 2 required
TermMapping
object
3 properties 2 required
UMDvText
object
7 properties 2 required
UMDvCodedText
object
8 properties 3 required
UDvText
object
UMHierObjectId
object
2 properties 2 required
UMObjectVersionId
object
2 properties 2 required
UUidBasedId
object
Link
object
3 properties 3 required
ArchetypeId
object
2 properties 1 required
TemplateId
object
2 properties 1 required
Archetyped
object
3 properties 2 required
DvIdentifier
object
Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number,…
5 properties 1 required
DvMultimedia
object
12 properties 3 required
UMDvMultimedia
object
12 properties 3 required
DvParsable
object
5 properties 3 required
UMDvParsable
object
5 properties 3 required
UDvEncapsulated
object
UMArchetypeId
object
2 properties 2 required
UMTemplateId
object
2 properties 2 required
UMTerminologyId
object
2 properties 2 required
UMGenericId
object
3 properties 3 required
UObjectId
object
ObjectRef
object
3 properties 3 required
PartyRef
object
Identifier for parties in a demographic or identity service.
3 properties 3 required
UMPartyIdentified
object
4 properties 1 required
UMPartyRelated
object
5 properties 2 required
UPartyIdentified
object
UMPartySelf
object
2 properties 1 required
UPartyProxy
object
DvInterval
object
5 properties 4 required
ReferenceRange
object
2 properties 2 required
DvDuration
object
8 properties 1 required
DvDateTime
object
7 properties 1 required
UMDvBoolean
object
2 properties 2 required
UMDvCount
object
8 properties 2 required
UMDvDate
object
7 properties 2 required
UMDvDateTime
object
7 properties 2 required
UMDvDuration
object
8 properties 2 required
UMDvIdentifier
object
5 properties 2 required
UMDvOrdinal
object
6 properties 3 required
UMDvProportion
object
11 properties 4 required
UMDvQuantity
object
12 properties 3 required
UMDvScale
object
6 properties 3 required
UMDvState
object
3 properties 3 required
UMDvTime
object
7 properties 2 required
UDataValue
object
Element
object
10 properties 2 required
ItemSingle
object
8 properties 3 required
ItemList
object
8 properties 2 required
Clstr
object
8 properties 3 required
UItem
object
ItemTable
object
8 properties 2 required
ItemTree
object
8 properties 2 required
UItemStructure
object
FeederAuditDetails
object
7 properties 1 required
FeederAudit
object
5 properties 1 required
DvIntervalOfDateTime
object
7 properties 4 required
Participation
object
4 properties 2 required
EventContext
object
8 properties 2 required
UContentItem
object
UMSection
object
8 properties 3 required
UMAdminEntry
object
14 properties 7 required
Event
object
10 properties 4 required
History
object
12 properties 3 required
UMObservation
object
17 properties 7 required
UMEvaluation
object
16 properties 7 required
Activity
object
10 properties 4 required
UMInstruction
object
19 properties 7 required
IsmTransition
object
5 properties 1 required
LocatableRef
object
4 properties 3 required
InstructionDetails
object
4 properties 2 required
UMAction
object
19 properties 9 required
Composition
object
A COMPOSITION resource
13 properties 6 required
EhrStatus
object
An EHRSTATUS resource
11 properties 5 required
UObjectRefOfUidBasedId
object
3 properties 3 required
Folder
object
A FOLDER resource
10 properties 2 required
PartyIdentity
object
8 properties 3 required
ListOfPartyIdentity
array
Address
object
8 properties 3 required
DvIntervalOfDate
object
7 properties 4 required
Contact
object
9 properties 3 required
ListOfContact
array
PartyRelationship
object
11 properties 4 required
ListOfPartyRelationship
array
Agent
object
13 properties 3 required
Group
object
13 properties 3 required
Organisation
object
13 properties 3 required
Person
object
13 properties 3 required
Capability
object
9 properties 3 required
ListOfCapability
array
Role
object
14 properties 4 required
OperationalTemplateV2
object
QueryName
string
The (fully qualified) name of the query (when is registered as a stored query), in a format of [{namespace}::]{query-name}. See [Query Name](tag/Qualifiedquery…
QueryType
string
Query formalism type.
QueryVersion
string
The SEMVER version number of the Stored Query.
AQL
string
The given AQL query.
StoredQuery
object
Stored Query content meta information.
5 properties 5 required
QueryList
array
List of Stored Query resources.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openehr-definition-openapi.yml Raw ↑

Other APIs openEHR publishes across the network.

openEHR EHR API
AE Profile APIs.io
openEHR Query API
AE Profile APIs.io
openEHR System API
AE Profile APIs.io
openEHR Demographic API
AE Profile APIs.io
openEHR Admin API
AE Profile APIs.io
#openEHR#Healthcare#EHR#Specification
← Back to O APIs
API Details
ID
openehr:definition
Server
https://{baseUrl}/v1
Docs
https://specifications.openehr.org/releases/ITS-REST/latest/definition.html
Provider
openEHR
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=definition&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/definition"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of openEHR Definition API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.