# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Patient Form Requests API
  version: 1.0.0
extends: openapi/elation-health-patient-form-requests-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/patient_form_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List patient form requests (legacy)
      effect: read
      questions:
      - How do I see which intake forms we've asked patients to fill out, via the older endpoint?
      - Which legacy call lists outstanding patient form requests?
      instructions:
      - text: List all patient form requests from the legacy route.
      - text: Show the intake form requests we've sent, older endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patient_form_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a patient forms request (legacy)
      effect: write
      questions:
      - How do I ask a patient to complete intake forms through the unversioned route?
      - Can I schedule when the patient gets notified about a legacy form request?
      instructions:
      - text: Request forms {patient_forms} from patient {patient} using the legacy endpoint.
        slots:
          patient_forms: requestBody.patient_forms
          patient: requestBody.patient
      - text: Send patient {patient} an older-style forms request with notification on {notification_date}.
        slots:
          patient: requestBody.patient
          notification_date: requestBody.notification_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patient_form_requests/{patient_form_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a patient form request (legacy)
      effect: read
      questions:
      - How do I check one form request's details on the older route?
      - Which forms were included in a specific legacy form request?
      instructions:
      - text: Get legacy patient form request {patient_form_request_id}.
        slots:
          patient_form_request_id: path.patient_form_request_id
      - text: Show the forms included in older request {patient_form_request_id}.
        slots:
          patient_form_request_id: path.patient_form_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patient_form_requests/{patient_form_request_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a patient form request (legacy)
      effect: write
      questions:
      - Can I change which forms a patient was asked to complete on the unversioned route?
      - How do I move the notification date of a legacy form request?
      instructions:
      - text: Update legacy form request {patient_form_request_id} for patient {patient} to forms {patient_forms}.
        slots:
          patient_form_request_id: path.patient_form_request_id
          patient: requestBody.patient
          patient_forms: requestBody.patient_forms
      - text: Reschedule the notification for older request {patient_form_request_id} to {notification_date}.
        slots:
          patient_form_request_id: path.patient_form_request_id
          notification_date: requestBody.notification_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patient_form_requests/{patient_form_request_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a patient form request (legacy)
      effect: destructive
      questions:
      - How do I withdraw a form request sent by mistake, using the older route?
      - Which unversioned call deletes a patient form request?
      instructions:
      - text: Delete legacy patient form request {patient_form_request_id}.
        slots:
          patient_form_request_id: path.patient_form_request_id
      - text: Withdraw older forms request {patient_form_request_id}.
        slots:
          patient_form_request_id: path.patient_form_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/'].get
  update:
    x-apievangelist-phrasing:
      intent: List patient form requests with paging
      effect: read
      questions:
      - How do I page through patient form requests in the v2.0 API?
      - Can I sort /api/2.0 form requests?
      instructions:
      - text: List v2.0 patient form requests, {limit} per page.
        slots:
          limit: query.limit
      - text: Page through /api/2.0 form requests from offset {offset} ordered by {order_by}.
        slots:
          offset: query.offset
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a patient forms request tied to a visit
      effect: write
      questions:
      - Can I send a patient pre-visit forms linked to a specific appointment?
      - Does the v2.0 form request give me a forms URL to share?
      instructions:
      - text: Send patient {patient} forms {patient_forms} ahead of appointment {appointment}.
        slots:
          patient: requestBody.patient
          patient_forms: requestBody.patient_forms
          appointment: requestBody.appointment
      - text: Create a v2.0 form request for patient {patient} in practice {practice}, notifying on {notification_date}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          notification_date: requestBody.notification_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a patient form request from v2.0
      effect: read
      questions:
      - How do I fetch one form request by ID from /api/2.0?
      - Which appointment is a v2.0 form request linked to?
      instructions:
      - text: Retrieve v2.0 patient form request {id}.
        slots:
          id: path.id
      - text: Show the forms URL and appointment on /api/2.0 request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a patient form request in v2.0
      effect: write
      questions:
      - How do I fully replace a form request through /api/2.0?
      - Which v2.0 call overwrites a form request's patient, forms and appointment?
      instructions:
      - text: Replace v2.0 form request {id} with patient {patient} and forms {patient_forms}.
        slots:
          id: path.id
          patient: requestBody.patient
          patient_forms: requestBody.patient_forms
      - text: Overwrite /api/2.0 request {id} and link it to appointment {appointment}.
        slots:
          id: path.id
          appointment: requestBody.appointment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a patient form request in v2.0
      effect: destructive
      questions:
      - How do I delete a patient form request through /api/2.0?
      - Can I cancel a v2.0 forms request the patient no longer needs?
      instructions:
      - text: Delete v2.0 patient form request {id}.
        slots:
          id: path.id
      - text: Cancel /api/2.0 forms request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/patient_form_requests/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a patient form request in v2.0
      effect: write
      questions:
      - Can I change only the notification date on a v2.0 form request?
      - How do I attach an appointment to an existing /api/2.0 form request?
      instructions:
      - text: Set notification date {notification_date} on v2.0 form request {id}.
        slots:
          notification_date: requestBody.notification_date
          id: path.id
      - text: Attach appointment {appointment} to existing /api/2.0 request {id}.
        slots:
          appointment: requestBody.appointment
          id: path.id
      method: generated
      generated: '2026-09-26'