athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth FHIR R4 Encounter API

3 actions 3 updates phrasing extends openapi/athenahealth-encounter-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['/Encounter'].get

$.paths['/Encounter/{id}'].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 R4 Encounter API
  version: 1.0.0
extends: openapi/athenahealth-encounter-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['/Encounter'].get
  update:
    x-apievangelist-phrasing:
      intent: Search FHIR Encounter resources
      effect: read
      questions:
      - How do I find a patient's encounters as FHIR Encounter resources?
      - Can I filter FHIR encounters by date?
      instructions:
      - text: Search FHIR Encounters for patient {patient}.
        slots:
          patient: query.patient
      - text: Find FHIR Encounter resources for patient {patient} on {date}.
        slots:
          patient: query.patient
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Encounter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one FHIR Encounter resource
      effect: read
      questions:
      - How do I fetch a single FHIR Encounter by its resource id?
      - What does one FHIR Encounter resource contain?
      instructions:
      - text: Read FHIR Encounter {id}.
        slots:
          id: path.id
      - text: Fetch the Encounter resource with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'