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 EHR API

The core openEHR record API — create and manage EHRs, compositions, directories, contributions and versioned objects. openEHR SPECIFICATION, not a callable service — 33 operation(s) across 23 path(s), served from the templated host `https://{baseUrl}/v1`.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 2 JSON Schema definitions.

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

This API exposes 33 operations across 23 paths, organized into 6 resource areas, and defines 114 schemas. It is described by OpenAPI 3.0.3, at version latest.

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

33 operations 23 paths 114 schemas 4 DELETE19 GET4 POST6 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
6

Paths & Operations 33

Across 23 paths, the API surfaces 33 operations — 4 DELETE, 19 GET, 4 POST, 6 PUT. They span 6 resource areas: EHR, EHR_STATUS, COMPOSITION, DIRECTORY, CONTRIBUTION, ITEM_TAG. Each is listed below with its method, path, parameters, and response codes.

EHR 4

Management of [EHRs](https://specifications.openehr.org/releases/RM/latest/ehr.htmlehrclass). Operations in this group cover creation of new EHRs, retrieval by identifier or subje…

POST
/ehr
Create EHR
ehr_create 3 params body → 201400409
GET
/ehr
Get EHR by subject id
ehr_get_by_subject 3 params → 200404
PUT
/ehr/{ehr_id}
Create EHR with id
ehr_create_with_id 4 params body → 201400409
GET
/ehr/{ehr_id}
Get EHR by id
ehr_get_by_id 2 params → 200404
EHR_STATUS 7

Management of [EHRSTATUS](https://specifications.openehr.org/releases/RM/latest/ehr.htmlehrstatusclass) and [VERSIONEDEHRSTATUS](https://specifications.openehr.org/releases/RM/lat…

GET
/ehr/{ehr_id}/ehr_status/{version_uid}
Get EHRSTATUS by version id
ehr_status_get_by_version_id 3 params → 200404
GET
/ehr/{ehr_id}/ehr_status
Get EHRSTATUS at time
ehr_status_get_at_time 3 params → 200400404
PUT
/ehr/{ehr_id}/ehr_status
Update EHRSTATUS
ehr_status_update 7 params body → 200204400404412
GET
/ehr/{ehr_id}/versioned_ehr_status
Get versioned EHRSTATUS
versioned_ehr_status_get 3 params → 200404
GET
/ehr/{ehr_id}/versioned_ehr_status/revision_history
Get versioned EHRSTATUS revision history
versioned_ehr_status_revision_history 3 params → 200404
GET
/ehr/{ehr_id}/versioned_ehr_status/version
Get versioned EHRSTATUS version at time
versioned_ehr_status_version_get_at_time 4 params → 200400404
GET
/ehr/{ehr_id}/versioned_ehr_status/version/{version_uid}
Get versioned EHRSTATUS version by id
versioned_ehr_status_version_get_by_id 4 params → 200404
COMPOSITION 8

Management of [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.htmlcompositionclass) and [VERSIONEDCOMPOSITION](https://specifications.openehr.org/releases/…

POST
/ehr/{ehr_id}/composition
Create COMPOSITION
composition_create 6 params body → 201400404422
GET
/ehr/{ehr_id}/composition/{uid_based_id}
Get COMPOSITION
composition_get 4 params → 200204404
PUT
/ehr/{ehr_id}/composition/{uid_based_id}
Update COMPOSITION
composition_update 8 params body → 200204400404412422
DELETE
/ehr/{ehr_id}/composition/{uid_based_id}
Delete COMPOSITION
composition_delete 2 params → 204400404409
GET
/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}
Get versioned COMPOSITION
versioned_composition_get 4 params → 200404
GET
/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/revision_history
Get versioned COMPOSITION revision history
versioned_composition_revision_history 4 params → 200404
GET
/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version
Get versioned COMPOSITION version at time
versioned_composition_version_get_at_time 5 params → 200404
GET
/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version/{version_uid}
Get versioned COMPOSITION version by id
versioned_composition_version_get_by_id 5 params → 200404
DIRECTORY 5

Management of the [directory](https://specifications.openehr.org/releases/RM/latest/ehr.htmldirectory) [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.htmlfo…

POST
/ehr/{ehr_id}/directory
Create directory
directory_create 4 params body → 201400404
PUT
/ehr/{ehr_id}/directory
Update directory
directory_update 5 params body → 200204400404412
DELETE
/ehr/{ehr_id}/directory
Delete directory
directory_delete 2 params → 204400404412
GET
/ehr/{ehr_id}/directory
Get folder in directory version at time
directory_get_at_time 4 params → 200204404
GET
/ehr/{ehr_id}/directory/{version_uid}
Get folder in directory version
directory_get_by_version_id 4 params → 200404
CONTRIBUTION 2

Management of [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.htmlcontributionclass) resource. Operations cover creation of contributions and retrieval…

POST
/ehr/{ehr_id}/contribution
Create CONTRIBUTION
contribution_create 4 params body → 201400404409
GET
/ehr/{ehr_id}/contribution/{contribution_uid}
Get CONTRIBUTION by id
contribution_get 3 params → 200404
ITEM_TAG 7

Management of [ITEMTAG](https://specifications.openehr.org/releases/RM/development/common.htmlitemtagclass) resources.

GET
/ehr/{ehr_id}/tags
Get EHR tags
ehr_tags_get 5 params → 200400404
GET
/ehr/{ehr_id}/composition/{uid_based_id}/tags
Get COMPOSITION tags
composition_tags_get 3 params → 200404
PUT
/ehr/{ehr_id}/composition/{uid_based_id}/tags
Update COMPOSITION tags
composition_tags_update 5 params body → 200204400404
DELETE
/ehr/{ehr_id}/composition/{uid_based_id}/tags/{key}
Delete COMPOSITION tags
composition_tags_delete 3 params → 204404
GET
/ehr/{ehr_id}/ehr_status/{uid_based_id}/tags
Get EHRSTATUS tags
ehr_status_tags_get 3 params → 200404
PUT
/ehr/{ehr_id}/ehr_status/{uid_based_id}/tags
Update EHRSTATUS tags
ehr_status_tags_update 5 params body → 200204400404
DELETE
/ehr/{ehr_id}/ehr_status/{uid_based_id}/tags/{key}
Delete EHRSTATUS tags
ehr_status_tags_delete 3 params → 204404

Schemas 114

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

HierObjectId
object
2 properties 1 required
ArchetypeId
object
2 properties 1 required
UMArchetypeId
object
2 properties 2 required
TemplateId
object
2 properties 1 required
UMTemplateId
object
2 properties 2 required
TerminologyId
object
2 properties 1 required
UMTerminologyId
object
2 properties 2 required
UMGenericId
object
3 properties 3 required
UMHierObjectId
object
2 properties 2 required
ObjectVersionId
object
2 properties 1 required
UMObjectVersionId
object
2 properties 2 required
UObjectId
object
ObjectRef
object
3 properties 3 required
ObjectRefOfObjectVersionId
object
3 properties 3 required
CodePhrase
object
3 properties 2 required
DvInterval
object
5 properties 4 required
UMDvUri
object
2 properties 2 required
DvEhrUri
object
2 properties 1 required
UMDvEhrUri
object
2 properties 2 required
UDvUri
object
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
ReferenceRange
object
2 properties 2 required
DvDuration
object
8 properties 1 required
DvDateTime
object
7 properties 1 required
Ehr
object
An EHR resource
5 properties
UUidBasedId
object
Link
object
3 properties 3 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
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
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
EhrStatus
object
An EHRSTATUS resource
11 properties 5 required
Identifier
object
1 property 1 required
Error
object
2 properties 2 required
UpdateItemTag
object
3 properties 1 required
ObjectRefOfHierObjectId
object
3 properties 3 required
VersionedEhrStatus
object
A VERSIONEDEHRSTATUS resource
4 properties 3 required
AuditDetails
object
The set of attributes required to document the committal of an information item to a repository.
6 properties 4 required
RevisionHistoryItem
object
A REVISIONHISTORYITEM resource
2 properties 2 required
RevisionHistory
object
A REVISIONHISTORY resource
1 property 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
UMComposition
object
13 properties 7 required
UMEhrStatus
object
11 properties 6 required
UObjectRefOfUidBasedId
object
3 properties 3 required
Folder
object
A FOLDER resource
10 properties 2 required
UMFolder
object
10 properties 3 required
UVersionable
object
Attestation
object
11 properties 6 required
UMOriginalVersionOfEhrStatus
object
10 properties 6 required
UMImportedVersionOfEhrStatus
object
6 properties 5 required
UVersionOfEhrStatus
object
VersionedComposition
object
A VERSIONEDCOMPOSITION resource
4 properties 3 required
UMOriginalVersionOfComposition
object
10 properties 6 required
UMImportedVersionOfComposition
object
6 properties 5 required
UVersionOfComposition
object
UpdateAudit
object
The set of attributes required to document the committal of an information item to a repository. UPDATEAUDIT is a REST commit DTO, not an RM class: structurall…
5 properties 2 required
UpdateAttestation
object
10 properties 4 required
UpdateVersion
object
6 properties 3 required
NewContribution
object
A new (un-committed) CONTRIBUTION resource
3 properties 2 required
Contribution
object
A CONTRIBUTION resource
3 properties 3 required
ItemTagOfComposition
object
5 properties 3 required
ItemTagOfEhrStatus
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openehr-ehr-openapi.yml Raw ↑

Other APIs openEHR publishes across the network.

openEHR Query API
AE Profile APIs.io
openEHR Definition 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:ehr
Server
https://{baseUrl}/v1
Docs
https://specifications.openehr.org/releases/ITS-REST/latest/ehr.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=ehr&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ehr"

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 EHR 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.