vitagroup

vitagroup QUERY API

The QUERY API from vitagroup — 3 operation(s) for query.

GitHub OpenAPI

Operations 6

GET /rest/openehr/v1/query/{qualified_query_name}/{version} Execute stored query #
POST /rest/openehr/v1/query/{qualified_query_name}/{version} Execute stored query #
GET /rest/openehr/v1/query/{qualified_query_name} Execute stored query #
POST /rest/openehr/v1/query/{qualified_query_name} Execute stored query #
GET /rest/openehr/v1/query/aql Execute ad-hoc (non-stored) AQL query #
POST /rest/openehr/v1/query/aql Execute ad-hoc (non-stored) AQL query #

Documentation

📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/openEHR-REST
📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/Admin-REST
📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Explore/Item-Tags
📖
Documentation
https://docs.ehrbase.org/docs/EHRbase/Enterprise-Features/Overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vitagroup/refs/heads/main/openapi/vitagroup-query-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/vitagroup/refs/heads/main/asyncapi/vitagroup-event-trigger-webhooks.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/vitagroup/refs/heads/main/sandbox/vitagroup-sandbox.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/vitagroup-query-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

vitagroup-query-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EHRbase QUERY 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: Query
paths:
  /rest/openehr/v1/query/{qualified_query_name}/{version}:
    get:
      tags:
      - Query
      summary: Execute stored query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-get-1
      operationId: executeStoredQuery
      parameters:
      - name: qualified_query_name
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: fetch
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
    post:
      tags:
      - Query
      summary: Execute stored query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-post-1
      operationId: executeStoredQuery_1
      parameters:
      - name: qualified_query_name
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          application/xml:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
  /rest/openehr/v1/query/{qualified_query_name}:
    get:
      tags:
      - Query
      summary: Execute stored query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-get-1
      operationId: executeStoredQuery_2
      parameters:
      - name: qualified_query_name
        in: path
        required: true
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: fetch
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
    post:
      tags:
      - Query
      summary: Execute stored query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-post-1
      operationId: executeStoredQuery_3
      parameters:
      - name: qualified_query_name
        in: path
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          application/xml:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
  /rest/openehr/v1/query/aql:
    get:
      tags:
      - Query
      summary: Execute ad-hoc (non-stored) AQL query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-get
      operationId: executeAdHocQuery
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: fetch
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
    post:
      tags:
      - Query
      summary: Execute ad-hoc (non-stored) AQL query
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/query.html#query-execute-query-post
      operationId: executeAdHocQuery_1
      parameters:
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          application/xml:
            schema:
              type: object
              additionalProperties: {}
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/QueryResponseData'
components:
  schemas:
    MetaData:
      type: object
      properties:
        _href:
          type: string
        _type:
          type: string
        _schema_version:
          type: string
        _created:
          type: string
          format: date-time
        _generator:
          type: string
        _executed_aql:
          type: string
    QueryResponseData:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/MetaData'
        q:
          type: string
        name:
          type: string
        columns:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
        rows:
          type: array
          items:
            type: array
            items: {}
externalDocs:
  description: EHRbase Documentation
  url: https://docs.ehrbase.org/