API Evangelist conversational phrasing for athenahealth athenaOne REST Appointments API

# 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 Appointments API
  version: 1.0.0
extends: openapi/athenahealth-appointments-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: 6
- target: $.paths['/appointments'].get
  update:
    x-apievangelist-phrasing:
      intent: Find booked appointments in a department
      effect: read
      questions:
      - Which appointments are booked in a department this week?
      - Can I narrow booked appointments in a clinic department to a start and end date?
      - What appointments are already on the schedule at one of my athenahealth departments?
      instructions:
      - text: List booked appointments in department {departmentid}.
        slots:
          departmentid: query.departmentid
      - text: Show appointments in department {departmentid} between {startdate} and {enddate}.
        slots:
          departmentid: query.departmentid
          startdate: query.startdate
          enddate: query.enddate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/appointments/open'].get
  update:
    x-apievangelist-phrasing:
      intent: Find open appointment slots
      effect: read
      questions:
      - Where can I see open slots a patient could book in a department?
      - Can I check a specific provider's open availability for next week?
      - What free appointment times are left in a clinic between two dates?
      instructions:
      - text: Find open appointment slots in department {departmentid}.
        slots:
          departmentid: query.departmentid
      - text: Show open slots for provider {providerid} in department {departmentid} from {startdate} to {enddate}.
        slots:
          providerid: query.providerid
          departmentid: query.departmentid
          startdate: query.startdate
          enddate: query.enddate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/appointments/{appointmentid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one appointment
      effect: read
      questions:
      - How do I pull the details of a single appointment by its ID?
      - What does one specific appointment record show, like time and status?
      instructions:
      - text: Get the details of appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      - text: Show me appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/appointments/{appointmentid}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel an appointment
      effect: destructive
      questions:
      - How do I cancel a patient's scheduled appointment?
      - Can an agent call off a visit that a patient can no longer make?
      instructions:
      - text: Cancel appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      - text: Call off the visit booked as appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/appointments/{appointmentid}/checkin'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a patient in for an appointment
      effect: write
      questions:
      - How do I mark a patient as arrived for their appointment?
      - Can I check someone in at the front desk through the API?
      instructions:
      - text: Check in the patient for appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      - text: Mark appointment {appointmentid} as arrived.
        slots:
          appointmentid: path.appointmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/appointments/{appointmentid}/reschedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Reschedule an appointment
      effect: write
      questions:
      - How do I move an existing appointment to a different time?
      - Is there a way to reschedule a visit rather than cancel and rebook it?
      instructions:
      - text: Reschedule appointment {appointmentid}.
        slots:
          appointmentid: path.appointmentid
      - text: Move appointment {appointmentid} to a new time.
        slots:
          appointmentid: path.appointmentid
      method: generated
      generated: '2026-10-01'