EHRbase

EHRbase Admin - Heartbeat API

The Admin - Heartbeat API from EHRbase — 1 operation(s) for admin - heartbeat.

GitHub OpenAPI

Operations 1

GET /rest/admin/status Get status #

Documentation

📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/openEHR-REST
📖
APIReference
https://docs.ehrbase.org/api/hip-ehrbase/openehr
📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/Admin-REST
📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/Status-And-Metrics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ehrbase/refs/heads/main/openapi/ehrbase-admin-heartbeat-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ehrbase-admin-heartbeat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

ehrbase-admin-heartbeat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EHRbase Admin - Heartbeat API
  description: 'EHRbase implements the official openEHR REST API. Additionally, EHRbase provides a custom `status` heartbeat endpoint, an Admin API (if activated) and a Status and Metrics API (if activated) for monitoring and maintenance. Note: The openEHR REST API is documented in their official documentation, not here. Please refer to their separate documentation.'
  license:
    name: Apache 2.0
    url: https://github.com/ehrbase/ehrbase/blob/develop/LICENSE.md
  version: v1
servers:
- url: https://sandkiste.ehrbase.org/ehrbase
  description: Generated server url
tags:
- name: Admin - Heartbeat
paths:
  /rest/admin/status:
    get:
      tags:
      - Admin - Heartbeat
      operationId: getStatus
      responses:
        '200':
          description: Admin API resources available and user has permission to access.
          headers:
            Content-Type:
              description: Format of response
              style: simple
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
        '401':
          description: Client credentials are invalid or have expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
        '403':
          description: Client has no access permission since the admin role is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/AdminStatusResponseData'
      summary: Get status
      x-summary-source: derived
components:
  schemas:
    AdminStatusResponseData:
      type: object
      properties:
        message:
          type: string
externalDocs:
  description: EHRbase Documentation
  url: https://docs.ehrbase.org/