athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth FHIR Subscriptions Subscription API

6 actions 6 updates phrasing extends openapi/athenahealth-subscription-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 6

$.info

$.paths['/Subscription'].get

$.paths['/Subscription'].post

$.paths['/Subscription/{id}'].get

$.paths['/Subscription/{id}'].delete

$.paths['/Subscription/{id}/$status'].get

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 FHIR Subscriptions Subscription API
  version: 1.0.0
extends: openapi/athenahealth-subscription-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: 5
- target: $.paths['/Subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: List FHIR event subscriptions
      effect: read
      questions:
      - Which FHIR subscriptions have I already set up?
      - What event notification subscriptions are active on my account?
      instructions:
      - text: List all my FHIR subscriptions.
      - text: Show every notification subscription I have registered.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to FHIR resource change notifications
      effect: write
      questions:
      - How do I get notified when FHIR resources matching some criteria change?
      - Can I register a webhook channel to receive FHIR Subscription notifications?
      - What criteria can a new athenahealth FHIR subscription watch?
      instructions:
      - text: Create a FHIR subscription for criteria {criteria} delivered over channel {channel}.
        slots:
          criteria: requestBody.criteria
          channel: requestBody.channel
      - text: Subscribe to changes matching {criteria} with status {status}.
        slots:
          criteria: requestBody.criteria
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Subscription/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one FHIR subscription
      effect: read
      questions:
      - How do I see the criteria and channel of one subscription I created?
      - What is configured on a specific FHIR subscription?
      instructions:
      - text: Get FHIR subscription {id}.
        slots:
          id: path.id
      - text: Show the configuration of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Subscription/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a FHIR subscription
      effect: destructive
      questions:
      - How do I stop receiving notifications from a subscription?
      - Can I remove a FHIR subscription I no longer need?
      instructions:
      - text: Delete FHIR subscription {id}.
        slots:
          id: path.id
      - text: Remove subscription {id} so its notifications stop.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Subscription/{id}/$status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a FHIR subscription's delivery status
      effect: read
      questions:
      - Is my FHIR subscription healthy and delivering events?
      - Where can I check the current status of a subscription's notifications?
      instructions:
      - text: Check the delivery status of subscription {id}.
        slots:
          id: path.id
      - text: Run the $status operation on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'