athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth FHIR R4 Patient API

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

$.paths['/Patient/{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 Patient API
  version: 1.0.0
extends: openapi/athenahealth-patient-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['/Patient'].get
  update:
    x-apievangelist-phrasing:
      intent: Search FHIR Patient resources
      effect: read
      questions:
      - How do I search FHIR Patient resources by family and given name?
      - Can I find a FHIR Patient by an identifier such as an MRN?
      - Which FHIR patients match a given birthdate?
      instructions:
      - text: Search FHIR Patients with family name {family} and given name {given}.
        slots:
          family: query.family
          given: query.given
      - text: Find the FHIR Patient with identifier {identifier}.
        slots:
          identifier: query.identifier
      - text: Search FHIR Patients born on {birthdate}.
        slots:
          birthdate: query.birthdate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Patient/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one FHIR Patient resource
      effect: read
      questions:
      - How do I fetch a FHIR Patient resource by its logical id?
      - What does a single FHIR Patient resource return?
      instructions:
      - text: Read FHIR Patient {id}.
        slots:
          id: path.id
      - text: Fetch the Patient resource with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'