# 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 Lab Orders API
  version: 1.0.0
extends: openapi/elation-health-lab-orders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/lab_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find lab orders (legacy endpoint)
      effect: read
      questions:
      - Where can I look up a patient's lab orders on the legacy unversioned endpoint?
      - Can the older lab order search show only orders that are still unsigned?
      instructions:
      - text: Find legacy lab orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Search the old lab orders endpoint for orders signed between {from} and {to}.
        slots:
          from: query.from_signed_date
          to: query.to_signed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a lab order (legacy endpoint)
      effect: write
      questions:
      - How do I place a new lab order for a patient through the legacy endpoint?
      - What does the original lab order create call need besides the patient and ordering physician?
      instructions:
      - text: Create a legacy lab order for patient {patient} ordered by physician {physician} in practice {practice} dated {date}.
        slots:
          patient: requestBody.patient
          physician: requestBody.ordering_physician
          practice: requestBody.practice
          date: requestBody.document_date
      - text: Use the old lab orders endpoint to send patient {patient}'s order to lab vendor {vendor}.
        slots:
          patient: requestBody.patient
          vendor: requestBody.vendor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}/printable'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a printable lab order (legacy path)
      effect: read
      questions:
      - Can I get a print-ready view of a lab order from the legacy printable path?
      - Is there a way to print a lab order without the page header on the older endpoint?
      instructions:
      - text: Get the legacy printable view of lab order {lab_order}.
        slots:
          lab_order: path.lab_order_id
      - text: Print lab order {order} from the old path with print_header set to {header}.
        slots:
          order: path.id
          header: query.print_header
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lab_orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lab order (legacy endpoint)
      effect: read
      questions:
      - Can I fetch a single lab order by id on the legacy unversioned path?
      - What details come back for one lab order from the original endpoint?
      instructions:
      - text: Get legacy lab order {id}.
        slots:
          id: path.id
      - text: Pull up lab order {id} from the older lab orders endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab order (legacy PUT)
      effect: write
      questions:
      - Can I overwrite a whole lab order through the legacy PUT endpoint?
      - Which legacy call does a full replacement of a lab order record?
      instructions:
      - text: Replace legacy lab order {id} in full, keeping patient {patient} and ordering physician {physician}.
        slots:
          id: path.id
          patient: requestBody.patient
          physician: requestBody.ordering_physician
      - text: Overwrite every field of old-endpoint lab order {id} with test date {test_date}.
        slots:
          id: path.id
          test_date: requestBody.test_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab order (legacy endpoint)
      effect: destructive
      questions:
      - How do I remove a lab order using the legacy unversioned endpoint?
      - Can I delete a lab order that was placed by mistake through the old path?
      instructions:
      - text: Delete legacy lab order {id}.
        slots:
          id: path.id
      - text: Remove lab order {id} via the original lab orders endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit fields on a lab order (legacy PATCH)
      effect: write
      questions:
      - Can I change just the facility or follow-up method on a lab order with the legacy PATCH?
      - Which legacy call edits only some fields of a lab order?
      instructions:
      - text: Patch legacy lab order {id} to set the follow-up method to {method}.
        slots:
          id: path.id
          method: requestBody.follow_up_method
      - text: On the old endpoint, mark lab order {id} as confidential {confidential}.
        slots:
          id: path.id
          confidential: requestBody.confidential
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lab orders (v2.0)
      effect: read
      questions:
      - Is it possible to page through all lab orders in a practice with the 2.0 API?
      - Can I list lab orders by document date range in version 2.0?
      - Which v2.0 lab orders are still waiting to be signed?
      instructions:
      - text: List v2.0 lab orders for patient {patient}.
        slots:
          patient: query.patient
      - text: List 2.0 lab orders with a document date after {after}, {limit} per page.
        slots:
          after: query.document_date__gte
          limit: query.limit
      - text: Show every unsigned lab order in practice {practice} from the 2.0 API.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a lab order (v2.0)
      effect: write
      questions:
      - How do I create a lab order with specimens and special insurance in the 2.0 API?
      - What fields are required to place a lab order in version 2.0?
      instructions:
      - text: Create a v2.0 lab order for patient {patient} by physician {physician} in practice {practice} dated {date}.
        slots:
          patient: requestBody.patient
          physician: requestBody.ordering_physician
          practice: requestBody.practice
          date: requestBody.document_date
      - text: Place a 2.0 lab order for patient {patient} with specimens {specimens}.
        slots:
          patient: requestBody.patient
          specimens: requestBody.specimens
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lab order (v2.0)
      effect: read
      questions:
      - Which v2.0 call returns one lab order with its requisition and submissions?
      - Does the v2.0 lab order record show who signed it and when?
      instructions:
      - text: Get v2.0 lab order {id}.
        slots:
          id: path.id
      - text: Retrieve lab order {id} from the 2.0 API including its signed date.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/lab_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab order (v2.0 PUT)
      effect: write
      questions:
      - Can I fully replace a lab order record in the v2.0 API?
      - Which 2.0 call overwrites an entire lab order rather than patching it?
      instructions:
      - text: Replace v2.0 lab order {id} in full for patient {patient}.
        slots:
          id: path.id
          patient: requestBody.patient
      - text: Overwrite 2.0 lab order {id} with vendor {vendor} and all required fields.
        slots:
          id: path.id
          vendor: requestBody.vendor
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/lab_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab order (v2.0)
      effect: destructive
      questions:
      - What's the 2.0 way to delete a lab order?
      - Can I remove a lab order entered on the wrong patient in version 2.0?
      instructions:
      - text: Delete v2.0 lab order {id}.
        slots:
          id: path.id
      - text: Remove lab order {id} using the 2.0 lab orders endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some fields of a lab order (v2.0)
      effect: write
      questions:
      - Can I change only the test date on a lab order in the 2.0 API?
      - Which v2.0 call edits a few lab order fields without resending the rest?
      instructions:
      - text: Patch v2.0 lab order {id} to set test date {test_date}.
        slots:
          id: path.id
          test_date: requestBody.test_date
      - text: Update the tags on 2.0 lab order {id} to {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_orders/{id}/printable/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a printable lab order (v2.0)
      effect: read
      questions:
      - How do I get a print-ready lab order from the 2.0 printable endpoint?
      - Can I leave the header off a printed lab order in version 2.0?
      instructions:
      - text: Get the v2.0 printable view of lab order {id}.
        slots:
          id: path.id
      - text: Print lab order {id} from the 2.0 API with print_header {header}.
        slots:
          id: path.id
          header: query.print_header
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lab order with its tests and status
      effect: read
      questions:
      - Which tests and status does a lab order have on the trailing-slash lab orders path?
      - What clinical notes and lab vendor are recorded on a given lab order record?
      instructions:
      - text: Show the tests and status on lab order record {id}.
        slots:
          id: path.id
      - text: Look up legacy lab order {id} with its clinical notes and lab vendor.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/lab_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab order's tests and status
      effect: write
      questions:
      - Can I replace the test list and status of a lab order in one call?
      - How do I overwrite a lab order's clinical notes, physician and tests together on the legacy endpoint?
      instructions:
      - text: Replace lab order record {id} with physician {physician}, tests {tests} and status {status}.
        slots:
          id: path.id
          physician: requestBody.physician
          tests: requestBody.tests
          status: requestBody.status
      - text: Overwrite lab order {id} for patient {patient} with clinical notes {notes}.
        slots:
          id: path.id
          patient: requestBody.patient
          notes: requestBody.clinical_notes
      method: generated
      generated: '2026-10-02'
- target: $.paths['/lab_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab order record with tests
      effect: destructive
      questions:
      - Can I delete a lab order record from the trailing-slash lab orders path?
      - Can I permanently drop a lab order along with its tests?
      instructions:
      - text: Delete lab order record {id} and its tests.
        slots:
          id: path.id
      - text: Drop lab order {id} from the tests-and-status lab orders path.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a lab order's status or lab vendor
      effect: write
      questions:
      - How do I change only the status of a lab order?
      - Can I switch the lab vendor on an existing lab order without replacing it?
      instructions:
      - text: Set the status of lab order {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Switch lab order {id} to lab vendor {vendor}.
        slots:
          id: path.id
          vendor: requestBody.lab_vendor
      method: generated
      generated: '2026-09-26'