Orion Health

Orion Health Notifications API

Admission, discharge, and transfer notifications

GitHub OpenAPI

Operations 3

GET /notifications Orion Health List ADT notifications #
GET /notifications/subscriptions Orion Health List notification subscriptions #
POST /notifications/subscriptions Orion Health Create a notification subscription #

Documentation

📖
Documentation
https://www.orionhealth.com/developers/fhir-api
📖
Authentication
https://www.orionhealth.com/developers/authentication
📖
Documentation
https://www.orionhealth.com/developers/population-health-api
📖
Documentation
https://www.orionhealth.com/developers/hie-api
📖
Documentation
https://www.orionhealth.com/developers/rhapsody-api
📖
GettingStarted
https://www.orionhealth.com/developers/getting-started

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/openapi/orion-health-notifications-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/asyncapi/orion-health-rhapsody-messaging-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/json-schema/orion-health-patient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/json-schema/orion-health-observation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/json-schema/orion-health-care-plan-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/orion-health/refs/heads/main/json-ld/orion-health-healthcare-context.jsonld
🔗
Sandbox
https://sandbox.orionhealth.com/population-health
🔗
TermsOfService
https://www.orionhealth.com/terms-of-service

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-notifications-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

orion-health-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Orion Health HIE Notifications API
  description: The Orion Health Health Information Exchange (HIE) API enables sharing of patient health information across healthcare organizations. It provides capabilities for patient identity matching, document exchange, consent management, provider directory lookups, and audit logging in compliance with healthcare interoperability standards. The API supports IHE profiles including XDS, XCA, and PDQ.
  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/hie
  description: Production HIE Server
- url: https://sandbox.orionhealth.com/hie
  description: Sandbox HIE Server
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Notifications
  description: Admission, discharge, and transfer notifications
paths:
  /notifications:
    get:
      operationId: listNotifications
      summary: Orion Health List ADT notifications
      description: Retrieve admission, discharge, and transfer (ADT) notifications for subscribed patients and organizations.
      tags:
      - Notifications
      parameters:
      - name: patientId
        in: query
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
          enum:
          - admission
          - discharge
          - transfer
          - registration
      - name: organization
        in: query
        schema:
          type: string
      - name: dateFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        schema:
          type: string
          enum:
          - pending
          - delivered
          - read
          - failed
      - $ref: '#/components/parameters/PageOffset'
      - $ref: '#/components/parameters/PageLimit'
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /notifications/subscriptions:
    get:
      operationId: listNotificationSubscriptions
      summary: Orion Health List notification subscriptions
      description: Retrieve current ADT notification subscriptions.
      tags:
      - Notifications
      responses:
        '200':
          description: List of subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationSubscription'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createNotificationSubscription
      summary: Orion Health Create a notification subscription
      description: Subscribe to ADT notifications for specific patients, organizations, or event types.
      tags:
      - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSubscriptionCreate'
      responses:
        '201':
          description: Subscription created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Pagination:
      type: object
      properties:
        offset:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        hasMore:
          type: boolean
    Notification:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - admission
          - discharge
          - transfer
          - registration
        patientId:
          type: string
        patientName:
          type: string
        sourceOrganization:
          type: string
        sourceOrganizationName:
          type: string
        facility:
          type: string
        eventDate:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - pending
          - delivered
          - read
          - failed
        details:
          type: object
          properties:
            admitReason:
              type: string
            dischargeDisposition:
              type: string
            attendingProvider:
              type: string
            department:
              type: string
        createdAt:
          type: string
          format: date-time
    NotificationSubscription:
      type: object
      properties:
        id:
          type: string
          format: uuid
        eventTypes:
          type: array
          items:
            type: string
            enum:
            - admission
            - discharge
            - transfer
            - registration
        patientIds:
          type: array
          items:
            type: string
          description: Specific patient IDs to monitor (empty means all)
        sourceOrganizations:
          type: array
          items:
            type: string
        callbackUrl:
          type: string
          format: uri
        status:
          type: string
          enum:
          - active
          - paused
          - disabled
        createdAt:
          type: string
          format: date-time
    NotificationSubscriptionCreate:
      type: object
      required:
      - eventTypes
      - callbackUrl
      properties:
        eventTypes:
          type: array
          items:
            type: string
            enum:
            - admission
            - discharge
            - transfer
            - registration
        patientIds:
          type: array
          items:
            type: string
        sourceOrganizations:
          type: array
          items:
            type: string
        callbackUrl:
          type: string
          format: uri
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters
      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:
            hie:patient-query: Query patient identity
            hie:document-read: Retrieve documents
            hie:document-write: Submit documents
            hie:consent-read: Read consent directives
            hie:consent-write: Manage consent directives
            hie:provider-read: Query provider directory
            hie:notification-read: Read notifications
            hie:notification-manage: Manage notification subscriptions
            hie:audit-read: Read audit logs
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT