vitagroup

vitagroup COMPOSITION API

The COMPOSITION API from vitagroup — 5 operation(s) for composition.

GitHub OpenAPI

Operations 8

GET /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid} Get composition at time #
PUT /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid} Update composition #
GET /rest/ecis/v1/composition/{uid} Deprecated since 2.0.0 and marked for removal #
PUT /rest/ecis/v1/composition/{uid} Deprecated since 2.0.0 and marked for removal #
DELETE /rest/ecis/v1/composition/{uid} Deprecated since 2.0.0 and marked for removal #
POST /rest/openehr/v1/ehr/{ehr_id}/composition Create composition #
POST /rest/ecis/v1/composition Deprecated since 2.0.0 and marked for removal #
DELETE /rest/openehr/v1/ehr/{ehr_id}/composition/{preceding_version_uid} Delete composition #

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-composition-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-composition-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-composition-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EHRbase COMPOSITION 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: Composition
paths:
  /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid}:
    get:
      tags:
      - Composition
      summary: Get composition at time
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html#composition-composition-get
      operationId: getComposition
      parameters:
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: ehr_id
        in: path
        required: true
        schema:
          type: string
      - name: versioned_object_uid
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        description: Composition format
        required: false
        schema:
          type: string
          enum:
          - JSON
          - XML
          - STRUCTURED
          - FLAT
      - name: version_at_time
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            application/openehr.wt.flat.schema+json:
              schema:
                type: string
            application/openehr.wt.structured.schema+json:
              schema:
                type: string
    put:
      tags:
      - Composition
      summary: Update composition
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html#composition-composition-put
      operationId: updateComposition
      parameters:
      - name: openehrVersion
        in: query
        required: true
        schema:
          type: string
      - name: openEHR-AUDIT_DETAILS
        in: header
        required: false
        schema:
          type: string
      - name: Content-Type
        in: header
        required: false
        schema:
          type: string
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: Prefer
        in: header
        required: false
        schema:
          type: string
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
      - name: ehr_id
        in: path
        required: true
        schema:
          type: string
      - name: versioned_object_uid
        in: path
        required: true
        schema:
          type: string
      - name: templateId
        in: query
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: Composition format
        required: false
        schema:
          type: string
          enum:
          - JSON
          - XML
          - STRUCTURED
          - FLAT
      requestBody:
        content:
          application/json:
            schema:
              type: string
          application/xml:
            schema:
              type: string
          application/openehr.wt.flat.schema+json:
            schema:
              type: string
          application/openehr.wt.structured.schema+json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            application/openehr.wt.flat.schema+json:
              schema:
                type: string
            application/openehr.wt.structured.schema+json:
              schema:
                type: string
  /rest/ecis/v1/composition/{uid}:
    get:
      tags:
      - Composition
      summary: Deprecated since 2.0.0 and marked for removal
      description: Replaced by /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid}
      operationId: getComposition_1
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
          default: XML
          enum:
          - FLAT
          - STRUCTURED
          - RAW
          - XML
          - ECISFLAT
          - EXPANDED
          - JSON
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositionResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/CompositionResponseData'
      deprecated: true
    put:
      tags:
      - Composition
      summary: Deprecated since 2.0.0 and marked for removal
      description: Replaced by /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid}
      operationId: update
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
          default: XML
          enum:
          - FLAT
          - STRUCTURED
          - RAW
          - XML
          - ECISFLAT
          - EXPANDED
          - JSON
      - name: templateId
        in: query
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionRestResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/ActionRestResponseData'
      deprecated: true
    delete:
      tags:
      - Composition
      summary: Deprecated since 2.0.0 and marked for removal
      description: Replaced by /rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid}
      operationId: delete
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionRestResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/ActionRestResponseData'
      deprecated: true
  /rest/openehr/v1/ehr/{ehr_id}/composition:
    post:
      tags:
      - Composition
      summary: Create composition
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html#composition-composition-post
      operationId: createComposition
      parameters:
      - name: openEHR-VERSION
        in: header
        required: false
        schema:
          type: string
      - name: openEHR-AUDIT_DETAILS
        in: header
        required: false
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        required: false
        schema:
          type: string
      - name: Prefer
        in: header
        required: false
        schema:
          type: string
      - name: ehr_id
        in: path
        required: true
        schema:
          type: string
      - name: templateId
        in: query
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: Composition format
        required: false
        schema:
          type: string
          enum:
          - JSON
          - XML
          - STRUCTURED
          - FLAT
      requestBody:
        content:
          application/json:
            schema:
              type: string
          application/xml:
            schema:
              type: string
          application/openehr.wt.flat.schema+json:
            schema:
              type: string
          application/openehr.wt.structured.schema+json:
            schema:
              type: string
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            application/openehr.wt.flat.schema+json:
              schema:
                type: object
            application/openehr.wt.structured.schema+json:
              schema:
                type: object
  /rest/ecis/v1/composition:
    post:
      tags:
      - Composition
      summary: Deprecated since 2.0.0 and marked for removal
      description: Replaced by /rest/openehr/v1/ehr/{ehr_id}/composition
      operationId: createComposition_1
      parameters:
      - name: format
        in: query
        required: false
        schema:
          type: string
          default: XML
          enum:
          - FLAT
          - STRUCTURED
          - RAW
          - XML
          - ECISFLAT
          - EXPANDED
          - JSON
      - name: templateId
        in: query
        required: false
        schema:
          type: string
      - name: ehrId
        in: query
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositionWriteRestResponseData'
            application/xml:
              schema:
                $ref: '#/components/schemas/CompositionWriteRestResponseData'
      deprecated: true
  /rest/openehr/v1/ehr/{ehr_id}/composition/{preceding_version_uid}:
    delete:
      tags:
      - Composition
      summary: Delete composition
      externalDocs:
        url: https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html#composition-composition-delete
      operationId: deleteComposition
      parameters:
      - name: openEHR-VERSION
        in: header
        required: false
        schema:
          type: string
      - name: openEHR-AUDIT_DETAILS
        in: header
        required: false
        schema:
          type: string
      - name: ehr_id
        in: path
        required: true
        schema:
          type: string
      - name: preceding_version_uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            application/openehr.wt.flat.schema+json:
              schema:
                type: string
            application/openehr.wt.structured.schema+json:
              schema:
                type: string
components:
  schemas:
    Meta:
      type: object
      properties:
        href:
          $ref: '#/components/schemas/RestHref'
        precedingHref:
          $ref: '#/components/schemas/RestHref'
        nextHref:
          $ref: '#/components/schemas/RestHref'
    CompositionResponseData:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
        action:
          type: string
          enum:
          - RETRIEVE
          - CREATE
          - UPDATE
          - MERGE
          - DELETE
        composition:
          $ref: '#/components/schemas/StructuredString'
        format:
          type: string
          enum:
          - FLAT
          - STRUCTURED
          - RAW
          - XML
          - ECISFLAT
          - EXPANDED
          - JSON
        templateId:
          type: string
        ehrId:
          type: string
          format: uuid
        compositionUid:
          type: string
    StructuredString:
      type: object
      properties:
        format:
          type: string
          enum:
          - XML
          - JSON
        value:
          type: string
    CompositionWriteRestResponseData:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
        action:
          type: string
          enum:
          - RETRIEVE
          - CREATE
          - UPDATE
          - MERGE
          - DELETE
        compositionUid:
          type: string
    RestHref:
      type: object
      properties:
        url:
          type: string
    ActionRestResponseData:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
        action:
          type: string
          enum:
          - RETRIEVE
          - CREATE
          - UPDATE
          - MERGE
          - DELETE
externalDocs:
  description: EHRbase Documentation
  url: https://docs.ehrbase.org/