athenahealth

athenahealth CDS Hooks API

The CDS Hooks API from athenahealth — 2 operation(s) for cds hooks.

GitHub OpenAPI

Operations 2

GET /cds-services Discover CDS Services #
POST /cds-services/{id} Invoke CDS Service #

Documentation

📖
Documentation
https://docs.athenahealth.com/api/docs/athenaone-apis
📖
Documentation
https://docs.athenahealth.com/api/api-ref/patient
📖
Documentation
https://docs.athenahealth.com/api/api-ref/appointment
📖
Documentation
https://docs.athenahealth.com/api/docs/encounter
📖
Documentation
https://docs.athenahealth.com/api/docs/fhir-apis
📖
Documentation
https://docs.athenahealth.com/api/guides/base-fhir-urls
📖
Documentation
https://mydata.athenahealth.com/fhirapidoc/r4
📖
Documentation
https://fhir.athena.io/athenacoreext/index.html
📖
Documentation
https://github.com/athenahealth/aone-fhir-subscriptions
📖
Documentation
https://docs.athenahealth.com/api/resources/227-release-added-fhir-bulk-data-access-capability-support-21st-century-cures
📖
Documentation
https://docs.mydata.athenahealth.com/fhir-r4/ehiexport.html
📖
Documentation
https://docs.athenahealth.com/downloads/athenaone-cds-hooks-integration-guide

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/openapi/athenahealth-cds-hooks-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/asyncapi/athenahealth-fhir-subscriptions-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/json-schema/athenahealth-patient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/json-schema/athenahealth-appointment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/json-schema/athenahealth-fhir-patient-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/overlays/athenahealth-cds-hooks-api-overlay.yaml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/json-ld/athenahealth-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/athenahealth/refs/heads/main/graphql/athenahealth-graphql.md

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-cds-hooks-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.

GitHub Google LinkedIn

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

OpenAPI Specification

athenahealth-cds-hooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: athenahealth CDS Hooks API
  description: 'CDS Hooks integration for athenaOne — invoke remote clinical decision

    support services at well-defined points in the EHR workflow.

    '
  version: 1.0.0
servers:
- url: https://cds.example.com
  description: Third-party CDS service implementing CDS Hooks
tags:
- name: CDS Hooks
paths:
  /cds-services:
    get:
      summary: Discover CDS Services
      operationId: discoverCdsServices
      tags:
      - CDS Hooks
      responses:
        '200':
          description: Discovery response
          content:
            application/json:
              schema:
                type: object
                properties:
                  services:
                    type: array
                    items:
                      $ref: '#/components/schemas/CdsService'
  /cds-services/{id}:
    post:
      summary: Invoke CDS Service
      operationId: invokeCdsService
      tags:
      - CDS Hooks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CdsRequest'
      responses:
        '200':
          description: CDS Hooks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CdsResponse'
components:
  schemas:
    CdsService:
      type: object
      properties:
        id:
          type: string
        hook:
          type: string
          enum:
          - patient-view
          - order-select
          - order-sign
          - appointment-book
        title:
          type: string
        description:
          type: string
        prefetch:
          type: object
          additionalProperties:
            type: string
    CdsResponse:
      type: object
      properties:
        cards:
          type: array
          items:
            $ref: '#/components/schemas/Card'
    CdsRequest:
      type: object
      properties:
        hook:
          type: string
        hookInstance:
          type: string
        fhirServer:
          type: string
          format: uri
        context:
          type: object
        prefetch:
          type: object
    Card:
      type: object
      properties:
        summary:
          type: string
        indicator:
          type: string
          enum:
          - info
          - warning
          - critical
        detail:
          type: string
        source:
          type: object
          properties:
            label:
              type: string
            url:
              type: string
              format: uri
        suggestions:
          type: array
          items:
            type: object
        links:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              url:
                type: string
                format: uri
              type:
                type: string
                enum:
                - absolute
                - smart