athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth athenaOne REST Encounters API

3 actions 3 updates phrasing extends openapi/athenahealth-encounters-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['/chart/{patientid}/encounters'].get

$.paths['/chart/encounter/{encounterid}'].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 athenaOne REST Encounters API
  version: 1.0.0
extends: openapi/athenahealth-encounters-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['/chart/{patientid}/encounters'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's chart encounters
      effect: read
      questions:
      - Which visits are recorded in a patient's chart?
      - Can I limit a patient's chart encounters to one department?
      instructions:
      - text: List chart encounters for patient {patientid}.
        slots:
          patientid: path.patientid
      - text: Show patient {patientid}'s chart encounters in department {departmentid}.
        slots:
          patientid: path.patientid
          departmentid: query.departmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/chart/encounter/{encounterid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one chart encounter
      effect: read
      questions:
      - How do I open a specific chart encounter by encounter ID?
      - What details are in a single athenaOne chart encounter?
      instructions:
      - text: Get chart encounter {encounterid}.
        slots:
          encounterid: path.encounterid
      - text: Show the details of encounter {encounterid} from the chart.
        slots:
          encounterid: path.encounterid
      method: generated
      generated: '2026-10-01'