API Evangelist conversational phrasing for Elation Health Referrals API

# 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 Referrals API
  version: 1.0.0
extends: openapi/elation-health-referrals-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: 10
- target: $.paths['/api/2.0/letters/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find letters by patient and date
      effect: read
      questions:
      - How do I find the letters sent about a patient in Elation?
      - Can I filter letters by recipient name and document date range?
      instructions:
      - text: List letters for patient {patient} dated after {document_date__gte}.
        slots:
          patient: query.patient
          document_date__gte: query.document_date__gte
      - text: Find letters sent to recipient {recipient_name} at practice {practice}.
        slots:
          recipient_name: query.recipient_name
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/letters/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a letter about a patient
      effect: write
      questions:
      - How do I send a referral letter to a contact by fax or direct message?
      - Can a new letter be attached to a referral order?
      instructions:
      - text: Create a letter for patient {patient} at practice {practice} to contact {send_to_contact} with subject {subject}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          send_to_contact: requestBody.send_to_contact
          subject: requestBody.subject
      - text: Fax a letter about patient {patient} to {fax_to} for referral order {referral_order}.
        slots:
          patient: requestBody.patient
          fax_to: requestBody.fax_to
          referral_order: requestBody.referral_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/letters/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one letter
      effect: read
      questions:
      - How do I read one letter including its fax status?
      - What does a single letter record show about delivery?
      instructions:
      - text: Get letter {id}.
        slots:
          id: path.id
      - text: Show the delivery details of letter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/letters/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a letter
      effect: write
      questions:
      - Can I replace an entire letter record?
      - Which call overwrites every field of a letter at once?
      instructions:
      - text: Replace letter {id} for patient {patient} addressed to contact {send_to_contact}.
        slots:
          id: path.id
          patient: requestBody.patient
          send_to_contact: requestBody.send_to_contact
      - text: Overwrite letter {id} in full with body {body}.
        slots:
          id: path.id
          body: requestBody.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/letters/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a letter
      effect: write
      questions:
      - Can I change just the subject of a letter already drafted?
      - How do I mark a letter as processed?
      instructions:
      - text: Change the subject of letter {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Mark letter {id} processed {is_processed}.
        slots:
          id: path.id
          is_processed: requestBody.is_processed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/referral_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List referral orders
      effect: read
      questions:
      - Which referral orders exist across my practice?
      - Can I sort and page through referral orders?
      instructions:
      - text: List referral orders ordered by {order_by}.
        slots:
          order_by: query.order_by
      - text: Show the next {limit} referral orders starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/referral_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Refer a patient to a specialist
      effect: write
      questions:
      - How do I create a referral order to a specialist for a patient?
      - What does a referral order need, such as an authorization number and re-evaluation date?
      instructions:
      - text: Refer patient {patient} to {consultant_name} in {specialty} with authorization number {auth_number}.
        slots:
          patient: requestBody.patient
          consultant_name: requestBody.consultant_name
          specialty: requestBody.specialty
          auth_number: requestBody.auth_number
      - text: Create a referral order at practice {practice} with re-evaluation date {date_for_reEval} and ICD-10 codes {icd10_codes}.
        slots:
          practice: requestBody.practice
          date_for_reEval: requestBody.date_for_reEval
          icd10_codes: requestBody.icd10_codes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/referral_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one referral order
      effect: read
      questions:
      - How do I see the specialty and consultant on one referral order?
      - What does a single referral order record include?
      instructions:
      - text: Get referral order {id}.
        slots:
          id: path.id
      - text: Show the consultant and authorization on referral {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/referral_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a referral order
      effect: write
      questions:
      - Can I replace a referral order in full?
      - Which call overwrites every field of a referral order?
      instructions:
      - text: Replace referral order {id} with consultant {consultant_name} in {specialty}.
        slots:
          id: path.id
          consultant_name: requestBody.consultant_name
          specialty: requestBody.specialty
      - text: Overwrite referral order {id} with authorization {auth_number}.
        slots:
          id: path.id
          auth_number: requestBody.auth_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/referral_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update part of a referral order
      effect: write
      questions:
      - Can I change only the re-evaluation date on a referral?
      - How do I record a resolution on an existing referral order?
      instructions:
      - text: Move the re-evaluation date of referral {id} to {date_for_reEval}.
        slots:
          id: path.id
          date_for_reEval: requestBody.date_for_reEval
      - text: Set the resolution of referral order {id} to {resolution}.
        slots:
          id: path.id
          resolution: requestBody.resolution
      method: generated
      generated: '2026-09-26'