# 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 Imaging Orders API
  version: 1.0.0
extends: openapi/elation-health-imaging-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['/imaging_orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an imaging order (legacy endpoint)
      effect: read
      questions:
      - Can I look up one imaging order on the legacy imaging orders path?
      - What does the older get-imaging-order call show about the ordered tests?
      instructions:
      - text: Open imaging order {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the clinical reason on old-path imaging order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/imaging_orders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an imaging order (legacy PUT)
      effect: write
      questions:
      - How do I resend a whole imaging order through the legacy PUT?
      - Can the older full update change which imaging center an order goes to?
      instructions:
      - text: With the legacy PUT, rewrite imaging order {id} for patient {patient} at practice {practice}, prescribed by {prescribing_user}, sent to {ancillary_company}.
        slots:
          id: path.id
          patient: requestBody.patient
          practice: requestBody.practice
          prescribing_user: requestBody.prescribing_user
          ancillary_company: requestBody.ancillary_company
      - text: Fully replace the old-path imaging order with reason {clinical_reason}, document date {document_date}, chart date {chart_date}.
        slots:
          clinical_reason: requestBody.clinical_reason
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/imaging_orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an imaging order (legacy endpoint)
      effect: destructive
      questions:
      - Is there a legacy call to delete an imaging order entered by mistake?
      - Can I remove a radiology order through the original imaging orders path?
      instructions:
      - text: Delete imaging order {id} with the legacy endpoint.
        slots:
          id: path.id
      - text: Remove the mistaken old-path radiology order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/imaging_orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an imaging order (legacy PATCH)
      effect: write
      questions:
      - Can I change only the ICD-10 codes on an imaging order with the legacy PATCH?
      - What's the older way to mark an imaging order STAT without resending it?
      instructions:
      - text: Using the legacy PATCH, set imaging order {id}'s ICD-10 codes to {icd10_codes}.
        slots:
          id: path.id
          icd10_codes: requestBody.icd10_codes
      - text: Patch the old-path imaging order to send to imaging center {imaging_center} via {statmethod}.
        slots:
          imaging_center: requestBody.imaging_center
          statmethod: requestBody.statmethod
      method: generated
      generated: '2026-10-01'
- target: $.paths['/imaging_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find imaging orders (legacy endpoint)
      effect: read
      questions:
      - Can I find all of a patient's imaging orders with the older lookup?
      - Which radiology orders has my practice placed, via the legacy search?
      instructions:
      - text: Using the legacy lookup, find imaging orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Find old-path imaging orders placed by practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/imaging_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Place an imaging order (legacy endpoint)
      effect: write
      questions:
      - How do I order an X-ray or MRI for a patient through the legacy endpoint?
      - What's required to place an imaging order on the older path?
      instructions:
      - text: Via the legacy endpoint, order imaging for patient {patient} at practice {practice}, prescribed by {prescribing_user}, with {ancillary_company}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          prescribing_user: requestBody.prescribing_user
          ancillary_company: requestBody.ancillary_company
      - text: Place an old-path imaging order for tests {tests} because {clinical_reason}, dated {document_date} and charted {chart_date}.
        slots:
          tests: requestBody.tests
          clinical_reason: requestBody.clinical_reason
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List imaging orders in API 2.0
      effect: read
      questions:
      - How do I page through imaging orders in the 2.0 API?
      - Can API 2.0 list imaging orders for a single patient, sorted?
      instructions:
      - text: List 2.0 imaging orders for patient {patient} ordered by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      - text: List API 2.0 imaging orders for practice {practice}, {limit} per page.
        slots:
          practice: query.practice
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an imaging order in API 2.0
      effect: write
      questions:
      - How do I create a new imaging order with the 2.0 API?
      - Can I attach ICD-10 codes and a test date when ordering imaging?
      instructions:
      - text: In API 2.0, order imaging tests {tests} for patient {patient} at practice {practice}, prescribed by {prescribing_user}, with {ancillary_company}.
        slots:
          tests: requestBody.tests
          patient: requestBody.patient
          practice: requestBody.practice
          prescribing_user: requestBody.prescribing_user
          ancillary_company: requestBody.ancillary_company
      - text: Create a 2.0 imaging order for reason {clinical_reason}, document date {document_date}, chart date {chart_date}, codes {icd10_codes}.
        slots:
          clinical_reason: requestBody.clinical_reason
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
          icd10_codes: requestBody.icd10_codes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an imaging order in API 2.0
      effect: read
      questions:
      - How do I retrieve a single imaging order by ID in API 2.0?
      - Does a 2.0 imaging order show its resolution and test date?
      instructions:
      - text: Retrieve API 2.0 imaging order {id}.
        slots:
          id: path.id
      - text: Get the resolution status of 2.0 imaging order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an imaging order in API 2.0
      effect: write
      questions:
      - Can I replace an entire imaging order with a 2.0 PUT?
      - Which fields must be resent when fully replacing an imaging order?
      instructions:
      - text: Replace 2.0 imaging order {id} with tests {tests} for patient {patient} at practice {practice}, prescribed by {prescribing_user} with {ancillary_company}.
        slots:
          id: path.id
          tests: requestBody.tests
          patient: requestBody.patient
          practice: requestBody.practice
          prescribing_user: requestBody.prescribing_user
          ancillary_company: requestBody.ancillary_company
      - text: 'Overwrite API 2.0 imaging order {id}: reason {clinical_reason}, document date {document_date}, chart date {chart_date}.'
        slots:
          id: path.id
          clinical_reason: requestBody.clinical_reason
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an imaging order in API 2.0
      effect: destructive
      questions:
      - How do I delete an imaging order with the 2.0 API?
      - Can I cancel out an imaging order by deleting it in API 2.0?
      instructions:
      - text: Delete API 2.0 imaging order {id}.
        slots:
          id: path.id
      - text: Remove 2.0 imaging order {id} from the chart.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/imaging_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an imaging order in API 2.0
      effect: write
      questions:
      - Can I record a test date on an existing imaging order without replacing it?
      - Is there a 2.0 PATCH to change an imaging order's follow-up method?
      instructions:
      - text: Patch 2.0 imaging order {id} with test date {test_date}.
        slots:
          id: path.id
          test_date: requestBody.test_date
      - text: Partially update API 2.0 imaging order {id} to follow up by {follow_up_method}.
        slots:
          id: path.id
          follow_up_method: requestBody.follow_up_method
      method: generated
      generated: '2026-09-26'