athenahealth · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for athenahealth FHIR R4 Observation API

2 actions 2 updates phrasing extends openapi/athenahealth-observation-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 2

$.info

$.paths['/Observation'].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 Observation API
  version: 1.0.0
extends: openapi/athenahealth-observation-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: 1
- target: $.paths['/Observation'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a patient's observations and vitals
      effect: read
      questions:
      - How do I get a patient's vital signs or lab results as observations?
      - Can I filter observations by category, code or date?
      instructions:
      - text: List observations for patient {patient}.
        slots:
          patient: query.patient
      - text: Get {category} observations for patient {patient} on {date}.
        slots:
          category: query.category
          patient: query.patient
          date: query.date
      - text: Find observations with code {code} for patient {patient}.
        slots:
          code: query.code
          patient: query.patient
      method: generated
      generated: '2026-10-01'