athenahealth Subscription API

The Subscription API from athenahealth — 3 operation(s) for subscription.

Operations 5

GET /Subscription Search Subscriptions #
POST /Subscription Create Subscription #
GET /Subscription/{id} Read Subscription #
DELETE /Subscription/{id} Delete Subscription #
GET /Subscription/{id}/$status Get Subscription Status #

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/athena-health-subscription-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 email required.

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

OpenAPI Specification

athenahealth-subscription-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: athenahealth FHIR Subscriptions Subscription API
  description: 'The athenahealth Event Subscription Platform delivers near real-time

    healthcare-domain event notifications via FHIR Subscriptions (R5 Backport).

    Currently supports the rest-hook channel and id-only payload type.

    '
  version: 1.0.0
servers:
- url: https://api.platform.athenahealth.com/fhir/r4
  description: Production
- url: https://api.preview.platform.athenahealth.com/fhir/r4
  description: Preview
security:
- oauth2: []
tags:
- name: Subscription
paths:
  /Subscription:
    get:
      summary: Search Subscriptions
      operationId: searchSubscriptions
      tags:
      - Subscription
      responses:
        '200':
          description: Bundle of Subscription resources
    post:
      summary: Create Subscription
      operationId: createSubscription
      tags:
      - Subscription
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: Subscription created
  /Subscription/{id}:
    get:
      summary: Read Subscription
      operationId: readSubscription
      tags:
      - Subscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription resource
    delete:
      summary: Delete Subscription
      operationId: deleteSubscription
      tags:
      - Subscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
  /Subscription/{id}/$status:
    get:
      summary: Get Subscription Status
      operationId: getSubscriptionStatus
      tags:
      - Subscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SubscriptionStatus
components:
  schemas:
    Subscription:
      type: object
      properties:
        resourceType:
          type: string
          enum:
          - Subscription
        status:
          type: string
          enum:
          - requested
          - active
          - error
          - false
        criteria:
          type: string
        channel:
          type: object
          properties:
            type:
              type: string
              enum:
              - rest-hook
            endpoint:
              type: string
              format: uri
            payload:
              type: string
              enum:
              - application/fhir+json
            header:
              type: array
              items:
                type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.platform.athenahealth.com/oauth2/v1/token
          scopes:
            system/Subscription.read: Read Subscriptions
            system/Subscription.write: Manage Subscriptions