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

EHRbase's non-standard administrative API — hard delete and update of EHRs, compositions, contributions, directories, stored queries and templates, plus the HIP EHRbase Merge EHR operations (merge, merge status, merge details, merge target). 8 paths / 11 operations, admin role required.

HIP EHRbase Admin 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, Administration, and Electronic Health Records. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 12 paths, organized into 8 resource areas, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, http://localhost:8080/ehrbase.

15 operations 12 paths 39 schemas 7 DELETE4 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://sandkiste.ehrbase.org/ehrbase
License
Resource Areas
8

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 7 DELETE, 4 GET, 1 POST, 3 PUT. They span 8 resource areas: Admin - Template, Admin - EHR, Admin - Contribution, Admin - EHR-Merge, Admin - Heartbeat, Admin - Stored-Query, Admin - Directory, Admin - Composition. Each is listed below with its method, path, parameters, and response codes.

Admin - Template 3
PUT
/rest/admin/template/{template_id}
updateTemplate 3 params body → 200401403404422
DELETE
/rest/admin/template/{template_id}
deleteTemplate 1 param → 202401403404422
DELETE
/rest/admin/template/all
deleteAllTemplates → 200401403404422
Admin - EHR 2
PUT
/rest/admin/ehr/{ehr_id}
updateEhr 2 params → 200401403404
DELETE
/rest/admin/ehr/{ehr_id}
deleteEhr 1 param → 204401403404
Admin - Contribution 2
PUT
/rest/admin/ehr/{ehr_id}/contribution/{contribution_id}
updateContribution 2 params → 200401403404
DELETE
/rest/admin/ehr/{ehr_id}/contribution/{contribution_id}
Not supported since 2.0.0
deleteContribution 2 params → 501
Admin - EHR-Merge 4
POST
/rest/admin/ehr/merge
Merge a source EHR into an existing target EHR
mergeEhrs body → 200401403404
GET
/rest/admin/ehr/merge_target/{id}
Request the EHR id that a given EHR was merged into, taking cascading into account
getMergeTarget 1 param → 200401403404
GET
/rest/admin/ehr/merge_status
Request the merging status of a SOURCEEHR and/or TARGETEHR
getMergeStatusList 3 params → 200401403404
GET
/rest/admin/ehr/merge_details
Request the details of a merge operation
getMergeDetails 3 params → 200401403404
Admin - Heartbeat 1
GET
/rest/admin/status
getStatus → 200401403
Admin - Stored-Query 1
DELETE
/rest/admin/query/{qualified_query_name}/{version}
deleteStoredQuery 3 params → 200401403404
Admin - Directory 1
DELETE
/rest/admin/ehr/{ehr_id}/directory/{directory_id}
deleteDirectory 2 params → 200401403404
Admin - Composition 1
DELETE
/rest/admin/ehr/{ehr_id}/composition/{composition_id}
deleteComposition 2 params → 200401403404

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ArchetypeID (16 properties), EhrUnmergeData (8 properties), ItemStructure (8 properties), DvDuration (7 properties). Each schema is shown below with its type and property counts.

AdminUpdateResponseData
object
1 property
MergeRequestBody
object
7 properties 3 required
ArchetypeID
object
16 properties
Archetyped
object
3 properties
CodePhrase
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
EhrUnmergeData
object
8 properties
EhrUnmergeVersionData
object
7 properties
EhrUnmergeVersionedObjectData
object
2 properties
FeederAudit
object
5 properties
FeederAuditDetails
object
7 properties
Item
object
7 properties
ItemStructure
object
8 properties
ItemTagDto
object
7 properties
Link
object
3 properties
Locatable
object
7 properties
MergeDetailsDto
object
5 properties
MergeOutcomeDto
object
2 properties
ObjectId
object
1 property
PartyIdentified
object
3 properties
PartyProxy
object
1 property
PartyRef
object
3 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
AdminStatusResponseData
object
1 property
AdminDeleteResponseData
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vitagroup-hip-ehrbase-admin.json Raw ↑

Other APIs vitagroup publishes across the network.

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

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