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

HIP EHRbase Enterprise API

The closed-source HIP EHRbase enterprise plugin API — Event Trigger management (AQL-defined hooks that forward composition and EHR_STATUS events over HTTP, AMQP/RabbitMQ or Kafka), Multi-tenant provisioning, and Transaction Compensation (Saga-pattern contribution rollback). 6 paths / 9 operations, bearer JWT required.

HIP EHRbase Enterprise 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, Events, Multi-Tenancy, and Enterprise. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

9 operations 6 paths 7 schemas 2 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://{ehrbaseBaseUrl}
Authentication
HTTP Bearer
Resource Areas
3

Authentication & Security 1

HIP EHRbase Enterprise API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 3 POST, 1 PUT. They span 3 resource areas: Event Trigger, Multi tenant, Compensation. Each is listed below with its method, path, parameters, and response codes.

Event Trigger 5
GET
/plugin/event-trigger/service/
Get All Event Triggers
getAll 1 param → 200
POST
/plugin/event-trigger/service/
Create Event Trigger
store body → 200
PUT
/plugin/event-trigger/service/{uuid}
Activate Event Trigger
activate 2 params → 200404
GET
/plugin/event-trigger/service/{id}
Get Event Trigger By Trigger-Id Or Trigger-UUID
getBy 1 param → 200404
DELETE
/plugin/event-trigger/service/{id}
Delete Event Trigger By Trigger-UUID
deleteBy 1 param → 200404
Multi tenant 3
GET
/plugin/multi-tenant/service
Get tenants
getTenants → 200
POST
/plugin/multi-tenant/service
Store tenant
storeTenant body → 200
DELETE
/plugin/multi-tenant/service/{tenant_id}
Delete Tenant
deleteTenant 1 param → 200
Compensation 1
POST
/plugin/transaction-management/ehr/{ehr_id}/contribution/{contribution_id}/rollback
Rollback
rollback 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are EventTrigger (6 properties), Rule (4 properties), Definition (4 properties), Author (4 properties). Each schema is shown below with its type and property counts.

EventTrigger
object
6 properties
Languange
object
1 property
Author
object
4 properties
Definition
object
4 properties
Rule
object
4 properties
Condition
object
2 properties
Consequence
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vitagroup-hip-ehrbase-enterprise.yml Raw ↑

Other APIs vitagroup publishes across the network.

HIP EHRbase openEHR REST API
HIP EHRbase Admin API
HIP EHRbase Item Tag Experimental API
EHRbase Sandbox (live springdoc api-docs)
Where this information came from

This is an independent, third-party profile of HIP EHRbase Enterprise 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.