athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth CDS Hooks API

3 actions 3 updates phrasing extends openapi/athenahealth-cds-hooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for athenahealth's API. It is a proposal applied on top of the contract, not a document athenahealth publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/cds-services'].get

$.paths['/cds-services/{id}'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for athenahealth CDS Hooks API
  version: 1.0.0
extends: openapi/athenahealth-cds-hooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/cds-services'].get
  update:
    x-apievangelist-phrasing:
      intent: Discover available CDS Hooks services
      effect: read
      questions:
      - Which clinical decision support services can I call?
      - What CDS Hooks services and hook types are offered?
      instructions:
      - text: List the available CDS Hooks services.
      - text: Run CDS service discovery.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cds-services/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Invoke a CDS Hooks service for decision cards
      effect: read
      questions:
      - How do I call a CDS service to get decision support cards for a patient context?
      - Can I pass prefetched FHIR data when invoking a clinical decision support hook?
      instructions:
      - text: Invoke CDS service {id} for hook {hook} with context {context}.
        slots:
          id: path.id
          hook: requestBody.hook
          context: requestBody.context
      - text: Call CDS service {id} using FHIR server {fhirServer} and prefetch {prefetch}.
        slots:
          id: path.id
          fhirServer: requestBody.fhirServer
          prefetch: requestBody.prefetch
      method: generated
      generated: '2026-10-01'