Orion Health Monitoring API

System health and performance monitoring

Operations 5

GET /routes/{routeId}/statistics Orion Health Get route processing statistics #
GET /monitoring/dashboard Orion Health Get monitoring dashboard #
GET /monitoring/health Orion Health Get system health status #
GET /monitoring/alerts Orion Health List monitoring alerts #
POST /monitoring/alerts/{alertId}/acknowledge Orion Health Acknowledge a monitoring alert #

Documentation

Specifications

Schemas & Data

Other Resources

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/orion-monitoring-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.

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

OpenAPI Specification

orion-health-monitoring-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orion Health Rhapsody Integration Monitoring API
  description: The Orion Health Rhapsody Integration Engine API provides management and monitoring capabilities for the Rhapsody healthcare integration platform. It enables programmatic control of integration routes, communication points, message queues, and system monitoring. Rhapsody supports HL7v2, FHIR, CDA, X12, DICOM, and other healthcare messaging standards for connecting disparate healthcare systems.
  version: 1.0.0
  contact:
    name: Orion Health API Support
    email: apisupport@orionhealth.com
    url: https://www.orionhealth.com/support
  license:
    name: Proprietary
    url: https://www.orionhealth.com/terms-of-service
  termsOfService: https://www.orionhealth.com/terms-of-service
servers:
- url: https://api.orionhealth.com/rhapsody
  description: Rhapsody Management API
- url: https://sandbox.orionhealth.com/rhapsody
  description: Sandbox Rhapsody API
security:
- oauth2: []
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Monitoring
  description: System health and performance monitoring
paths:
  /routes/{routeId}/statistics:
    get:
      operationId: getRouteStatistics
      summary: Orion Health Get route processing statistics
      description: Retrieve message processing statistics for a specific route including throughput, error rates, and processing times.
      tags:
      - Monitoring
      parameters:
      - name: routeId
        in: path
        required: true
        schema:
          type: integer
      - name: periodStart
        in: query
        schema:
          type: string
          format: date-time
      - name: periodEnd
        in: query
        schema:
          type: string
          format: date-time
      - name: interval
        in: query
        description: Statistics aggregation interval
        schema:
          type: string
          enum:
          - minute
          - hour
          - day
          - week
      responses:
        '200':
          description: Route statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteStatistics'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /monitoring/dashboard:
    get:
      operationId: getMonitoringDashboard
      summary: Orion Health Get monitoring dashboard
      description: Retrieve an overview of the Rhapsody engine status including system health, active routes, queue depths, and error counts.
      tags:
      - Monitoring
      responses:
        '200':
          description: Dashboard data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /monitoring/health:
    get:
      operationId: getHealthStatus
      summary: Orion Health Get system health status
      description: Retrieve the overall health status of the Rhapsody engine including component-level health checks.
      tags:
      - Monitoring
      security: []
      responses:
        '200':
          description: System is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '503':
          description: System is unhealthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
  /monitoring/alerts:
    get:
      operationId: listMonitoringAlerts
      summary: Orion Health List monitoring alerts
      description: Retrieve active monitoring alerts for the Rhapsody engine.
      tags:
      - Monitoring
      parameters:
      - name: severity
        in: query
        schema:
          type: string
          enum:
          - info
          - warning
          - error
          - critical
      - name: acknowledged
        in: query
        schema:
          type: boolean
      - $ref: '#/components/parameters/PageOffset'
      - $ref: '#/components/parameters/PageLimit'
      responses:
        '200':
          description: List of alerts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MonitoringAlert'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /monitoring/alerts/{alertId}/acknowledge:
    post:
      operationId: acknowledgeAlert
      summary: Orion Health Acknowledge a monitoring alert
      description: Acknowledge a monitoring alert to indicate it has been reviewed.
      tags:
      - Monitoring
      parameters:
      - name: alertId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                note:
                  type: string
      responses:
        '200':
          description: Alert acknowledged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringAlert'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Dashboard:
      type: object
      properties:
        engineStatus:
          type: string
          enum:
          - running
          - starting
          - stopping
          - stopped
          - error
        uptime:
          type: string
          description: Engine uptime duration
        uptimeSeconds:
          type: integer
        routes:
          type: object
          properties:
            total:
              type: integer
            started:
              type: integer
            stopped:
              type: integer
            error:
              type: integer
        communicationPoints:
          type: object
          properties:
            total:
              type: integer
            started:
              type: integer
            stopped:
              type: integer
            error:
              type: integer
        queues:
          type: object
          properties:
            totalDepth:
              type: integer
            totalErrors:
              type: integer
            totalHeld:
              type: integer
        messages:
          type: object
          properties:
            processedToday:
              type: integer
            errorsToday:
              type: integer
            throughputPerSecond:
              type: number
        memory:
          type: object
          properties:
            usedMb:
              type: number
            maxMb:
              type: number
            percentUsed:
              type: number
        disk:
          type: object
          properties:
            usedGb:
              type: number
            totalGb:
              type: number
            percentUsed:
              type: number
    Pagination:
      type: object
      properties:
        offset:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        hasMore:
          type: boolean
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - healthy
          - degraded
          - unhealthy
        timestamp:
          type: string
          format: date-time
        components:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
                enum:
                - healthy
                - degraded
                - unhealthy
              message:
                type: string
              lastChecked:
                type: string
                format: date-time
    MonitoringAlert:
      type: object
      properties:
        id:
          type: string
          format: uuid
        severity:
          type: string
          enum:
          - info
          - warning
          - error
          - critical
        source:
          type: string
          description: Component that generated the alert
        title:
          type: string
        message:
          type: string
        acknowledged:
          type: boolean
        acknowledgedBy:
          type: string
        acknowledgedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
    RouteStatistics:
      type: object
      properties:
        routeId:
          type: integer
        routeName:
          type: string
        period:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
        totalMessages:
          type: integer
        successfulMessages:
          type: integer
        errorMessages:
          type: integer
        averageProcessingTimeMs:
          type: number
        maxProcessingTimeMs:
          type: number
        messagesPerSecond:
          type: number
        timeline:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
              messagesProcessed:
                type: integer
              errors:
                type: integer
              avgProcessingTimeMs:
                type: number
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    PageLimit:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    PageOffset:
      name: offset
      in: query
      description: Number of items to skip
      schema:
        type: integer
        minimum: 0
        default: 0
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.orionhealth.com/oauth2/token
          scopes:
            rhapsody:read: Read access to Rhapsody engine
            rhapsody:write: Write access to Rhapsody engine
            rhapsody:admin: Administrative access
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key