# 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 Sleep Orders API
  version: 1.0.0
extends: openapi/elation-health-sleep-orders-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: 12
- target: $.paths['/sleep_orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a sleep study order (legacy)
      effect: read
      questions:
      - Can I pull one sleep study order by id from the older unversioned endpoint?
      - What does the legacy sleep orders path return for a single order?
      instructions:
      - text: Fetch legacy sleep order {id}.
        slots:
          id: path.id
      - text: Open sleep study order {id} from the original route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sleep_orders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a sleep study order (legacy PUT)
      effect: write
      questions:
      - Which legacy PUT overwrites an entire sleep study order?
      - Must I resend the clinical reason and prescriber when replacing a sleep order on the old path?
      instructions:
      - text: Replace legacy sleep order {id} for patient {patient} with sleep lab {ancillary_company} and reason {clinical_reason}.
        slots:
          id: path.id
          patient: requestBody.patient
          ancillary_company: requestBody.ancillary_company
          clinical_reason: requestBody.clinical_reason
      - text: Overwrite an old-route sleep order prescribed by {prescribing_user} at practice {practice}.
        slots:
          prescribing_user: requestBody.prescribing_user
          practice: requestBody.practice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sleep_orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sleep study order (legacy)
      effect: destructive
      questions:
      - Can I cancel a sleep study order by deleting it on the unversioned API?
      - Which old call removes a sleep order?
      instructions:
      - text: Delete legacy sleep order {id}.
        slots:
          id: path.id
      - text: Remove sleep study order {id} via the original route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sleep_orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a sleep study order (legacy PATCH)
      effect: write
      questions:
      - Can I change only the sleep center on an order with the legacy PATCH?
      - Is there an old-path partial edit for a sleep order's diagnosis codes?
      instructions:
      - text: Move legacy sleep order {id} to sleep center {sleep_center}.
        slots:
          id: path.id
          sleep_center: requestBody.sleep_center
      - text: Patch the ICD-10 codes on an old-route sleep order to {icd10_codes}.
        slots:
          icd10_codes: requestBody.icd10_codes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sleep_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search sleep study orders (legacy)
      effect: read
      questions:
      - Can I find a patient's sleep study orders on the legacy unversioned path?
      - Does the old sleep order search filter by practice?
      instructions:
      - text: Find legacy sleep orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Search old-route sleep orders at practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sleep_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Order a sleep study (legacy)
      effect: write
      questions:
      - What must I send to place a sleep study order through the legacy endpoint?
      - Can the old create call include ICD-10 codes and a follow-up method?
      instructions:
      - text: Create a legacy sleep order for patient {patient} at sleep lab {ancillary_company} for {clinical_reason}, prescribed by {prescribing_user}.
        slots:
          patient: requestBody.patient
          ancillary_company: requestBody.ancillary_company
          clinical_reason: requestBody.clinical_reason
          prescribing_user: requestBody.prescribing_user
      - text: Place an old-route sleep order at practice {practice} with follow-up by {follow_up_method}.
        slots:
          practice: requestBody.practice
          follow_up_method: requestBody.follow_up_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List sleep study orders
      effect: read
      questions:
      - How do I list the sleep study orders for one patient?
      - Can I page and sort sleep orders across a practice in v2.0?
      instructions:
      - text: List v2.0 sleep orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Show sleep orders at practice {practice} ordered by {order_by}, {limit} per page.
        slots:
          practice: query.practice
          order_by: query.order_by
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a sleep study order
      effect: write
      questions:
      - What's required to order a sleep study for a patient in API v2.0?
      - Can I set a test date and specific sleep tests on a new order?
      instructions:
      - text: Order sleep tests {tests} for patient {patient} at sleep lab {ancillary_company}, reason {clinical_reason}.
        slots:
          tests: requestBody.tests
          patient: requestBody.patient
          ancillary_company: requestBody.ancillary_company
          clinical_reason: requestBody.clinical_reason
      - text: Create a v2.0 sleep order for patient {patient} prescribed by {prescribing_user} with test date {test_date}.
        slots:
          patient: requestBody.patient
          prescribing_user: requestBody.prescribing_user
          test_date: requestBody.test_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sleep study order
      effect: read
      questions:
      - What does a single v2.0 sleep order record include?
      - Can I check the resolution of a sleep study order?
      instructions:
      - text: Retrieve v2.0 sleep order {id}.
        slots:
          id: path.id
      - text: Show the tests and resolution on sleep order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a sleep study order
      effect: write
      questions:
      - Which v2.0 call fully replaces a sleep order?
      - Do I have to resend the tests list when replacing a sleep order?
      instructions:
      - text: Replace sleep order {id} with tests {tests} for patient {patient}.
        slots:
          id: path.id
          tests: requestBody.tests
          patient: requestBody.patient
      - text: Do a full v2.0 PUT on sleep order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sleep study order
      effect: destructive
      questions:
      - Can I delete a sleep order placed in error through API v2.0?
      - What removes a sleep study order in the current API?
      instructions:
      - text: Delete v2.0 sleep order {id}.
        slots:
          id: path.id
      - text: Remove the mistaken sleep study order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/sleep_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a sleep study order
      effect: write
      questions:
      - Can I record the resolution of a sleep order without resending it all?
      - Is there a v2.0 partial update to sign a sleep order?
      instructions:
      - text: Set the resolution of sleep order {id} to {resolution}.
        slots:
          id: path.id
          resolution: requestBody.resolution
      - text: Mark v2.0 sleep order {id} signed by {signed_by}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
      method: generated
      generated: '2026-09-26'