EHRbase's implementation of the official openEHR REST API (ITS-REST) — EHR, EHR_STATUS, COMPOSITION, DIRECTORY, CONTRIBUTION, versioned objects, ADL 1.4 / ADL 2 template definitions and Archetype Query Language (AQL) execution, plus the EHRbase status heartbeat. 31 paths / 45 operations.
HIP EHRbase openEHR REST API is one of 5 APIs that vitagroup publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include openEHR, Electronic Health Records, Clinical Data Repository, and AQL. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
45 operations
across 31 paths,
organized into 12 resource areas,
and defines 67 schemas.
It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, http://localhost:8080/ehrbase.
45 operations31 paths67 schemas2 DELETE28 GET9 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 31 paths, the API surfaces 45 operations — 2 DELETE, 28 GET, 9 POST, 6 PUT. They span 12 resource areas, including EHR, EHR_STATUS, DIRECTORY, COMPOSITION, STORED_QUERY, QUERY, CONTRIBUTION, ADL 2 TEMPLATE, and 4 more. Each is listed below with its method, path, parameters, and response codes.
The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are WebTemplateNode (18 properties), ArchetypeID (16 properties), Composition (13 properties), DvMultimedia (11 properties). Each schema is shown below with its type and property counts.
ArchetypeID
object
16 properties
Archetyped
object
3 properties
AuditDetails
object
5 properties
CodePhrase
object
3 properties
Composition
object
13 properties
CompositionDto
object
4 properties
ContentItem
object
7 properties
ContributionDto
object
3 properties
DvCodedText
object
6 properties
DvDateTime
object
6 properties
DvDuration
object
7 properties
DvEHRURI
object
1 property
DvEncapsulated
object
2 properties
DvIdentifier
object
4 properties
DvIntervalDvDateTime
object
6 properties
DvIntervalDvDuration
object
6 properties
DvText
object
6 properties
DvURI
object
1 property
EHR
object
6 properties
EHR_STATUS
object
10 properties2 required
EventContext
object
9 properties
FeederAudit
object
5 properties
FeederAuditDetails
object
7 properties
HierObjectId
object
1 property
Item
object
7 properties
ItemStructure
object
8 properties
Link
object
3 properties
ObjectId
object
1 property
Participation
object
4 properties
PartyIdentified
object
3 properties
PartyProxy
object
1 property
PartyRef
object
3 properties
PartySelf
object
1 property
PathSegment
object
4 properties
ReferenceRangeDvDateTime
object
2 properties
ReferenceRangeDvDuration
object
2 properties
TemplateId
object
1 property
TermMapping
object
3 properties
TerminologyId
object
1 property
UIDBasedId
object
1 property
ObjectVersionId
object
1 property
Folder
object
10 properties
ObjectRefObjectId
object
3 properties
DirectoryResponseData
object
5 properties
QueryDefinitionResponseData
object
5 properties
MetaData
object
6 properties
QueryResponseData
object
5 properties
TemplateResponseData
object
VERSIONED_EHR_STATUS
object
4 properties
Attestation
object
10 properties
Contribution
object
3 properties
DvMultimedia
object
11 properties
OriginalVersionResponseDataEhrStatusDto
object
10 properties
RevisionHistoryItem
object
2 properties
VERSIONED_COMPOSITION
object
4 properties
OriginalVersionResponseDataComposition
object
10 properties
TemplateMetaDataDto
object
4 properties
WebTemplate
object
5 properties
WebTemplateAnnotation
object
1 property
WebTemplateInput
object
7 properties
WebTemplateInputValue
object
8 properties
WebTemplateInterval
object
4 properties
WebTemplateNode
object
18 properties
WebTemplateTerminology
object
2 properties
WebTemplateValidation
object
3 properties
WebtemplateCardinality
object
4 properties
QueryDefinitionListResponseData
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 HIP EHRbase openEHR REST 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.
