# 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 Patients API
  version: 1.0.0
extends: openapi/athenahealth-patients-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: 4
- target: $.paths['/patients'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patients by name or birth date
      effect: read
      questions:
      - How do I find a patient in athenaOne by first and last name?
      - Can I look up patients by date of birth within one department?
      instructions:
      - text: Find patients named {firstname} {lastname}.
        slots:
          firstname: query.firstname
          lastname: query.lastname
      - text: Search for patients born on {dob} in department {departmentid}.
        slots:
          dob: query.dob
          departmentid: query.departmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/patients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new patient
      effect: write
      questions:
      - How do I register a brand-new patient in a department?
      - What details are required to create a patient record?
      instructions:
      - text: Register patient {firstname} {lastname}, born {dob}, in department {departmentid}.
        slots:
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          dob: requestBody.dob
          departmentid: requestBody.departmentid
      - text: Create a new {sex} patient {firstname} {lastname} with birth date {dob} in department {departmentid}.
        slots:
          sex: requestBody.sex
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          dob: requestBody.dob
          departmentid: requestBody.departmentid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/patients/{patientid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a patient's demographics by patient ID
      effect: read
      questions:
      - How do I pull up a patient's record when I know their athenaOne patient ID?
      - What demographic details are stored for a given patient ID?
      instructions:
      - text: Get the record for patient {patientid}.
        slots:
          patientid: path.patientid
      - text: Show demographics for athenaOne patient {patientid}.
        slots:
          patientid: path.patientid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/patients/{patientid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a patient's contact details
      effect: write
      questions:
      - How do I change a patient's mobile phone or email on file?
      - Can I correct a misspelled name on an existing patient record?
      instructions:
      - text: Update the email for patient {patientid} to {email}.
        slots:
          patientid: path.patientid
          email: requestBody.email
      - text: Set the mobile phone of patient {patientid} to {mobilephone}.
        slots:
          patientid: path.patientid
          mobilephone: requestBody.mobilephone
      - text: Change patient {patientid}'s name to {firstname} {lastname}.
        slots:
          patientid: path.patientid
          firstname: requestBody.firstname
          lastname: requestBody.lastname
      method: generated
      generated: '2026-10-01'