athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth FHIR Access Bulk Data API

4 actions 4 updates phrasing extends openapi/athenahealth-bulk-data-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 4

$.info

$.paths['/Group/{id}/$export'].get

$.paths['/bulk/status/{jobid}'].get

$.paths['/bulk/status/{jobid}'].delete

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 Access Bulk Data API
  version: 1.0.0
extends: openapi/athenahealth-bulk-data-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: 3
- target: $.paths['/Group/{id}/$export'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk FHIR export for a patient group
      effect: read
      questions:
      - How do I export all FHIR data for a group of patients at once?
      - Can a bulk export include only certain resource types or changes since a date?
      - What output format does a group-level $export produce?
      instructions:
      - text: Start a bulk export for group {id}.
        slots:
          id: path.id
      - text: Export {_type} resources for group {id} changed since {_since}.
        slots:
          _type: query._type
          id: path.id
          _since: query._since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulk/status/{jobid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of a bulk export job
      effect: read
      questions:
      - Is my bulk data export finished yet?
      - Where do I get the download links once a bulk export completes?
      instructions:
      - text: Check the status of bulk export job {jobid}.
        slots:
          jobid: path.jobid
      - text: Get the output files for finished export job {jobid}.
        slots:
          jobid: path.jobid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulk/status/{jobid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running bulk export
      effect: destructive
      questions:
      - How do I stop a bulk export that is still running?
      - Can I cancel an export job I kicked off by mistake?
      instructions:
      - text: Cancel bulk export job {jobid}.
        slots:
          jobid: path.jobid
      - text: Abort export {jobid} and discard it.
        slots:
          jobid: path.jobid
      method: generated
      generated: '2026-10-01'