# 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 Cardiac Orders API
  version: 1.0.0
extends: openapi/elation-health-cardiac-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['/cardiac_orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a cardiac order (legacy endpoint)
      effect: read
      questions:
      - How do I fetch a single cardiac order from the legacy unversioned path?
      - What does the old cardiac orders endpoint return for one order?
      instructions:
      - text: Fetch legacy cardiac order {id}.
        slots:
          id: path.id
      - text: Show me cardiac order {id} using the original endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cardiac_orders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a cardiac order (legacy PUT)
      effect: write
      questions:
      - Can I resend a whole cardiac order through the legacy PUT?
      - Which fields are mandatory when overwriting a cardiac order on the old endpoint?
      instructions:
      - text: Replace legacy cardiac order {id} for patient {patient} with clinical reason {clinical_reason}, prescribed by {prescribing_user}.
        slots:
          id: path.id
          patient: requestBody.patient
          clinical_reason: requestBody.clinical_reason
          prescribing_user: requestBody.prescribing_user
      - text: Overwrite the old-style cardiac order sent to ancillary company {ancillary_company} with document date {document_date}.
        slots:
          ancillary_company: requestBody.ancillary_company
          document_date: requestBody.document_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cardiac_orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cardiac order (legacy endpoint)
      effect: destructive
      questions:
      - How do I remove a cardiac order with the legacy API?
      - Can the unversioned cardiac orders path delete an order?
      instructions:
      - text: Delete legacy cardiac order {id}.
        slots:
          id: path.id
      - text: Remove cardiac order {id} through the old endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cardiac_orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a cardiac order (legacy PATCH)
      effect: write
      questions:
      - Can I add ICD-10 codes to a cardiac order with the legacy PATCH?
      - What legacy call changes only a cardiac order's follow-up method?
      instructions:
      - text: Patch legacy cardiac order {id} to use ICD-10 codes {icd10_codes}.
        slots:
          id: path.id
          icd10_codes: requestBody.icd10_codes
      - text: Mark the old-style cardiac order confidential {confidential} and set follow-up to {follow_up_method}.
        slots:
          confidential: requestBody.confidential
          follow_up_method: requestBody.follow_up_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cardiac_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find cardiac orders by patient (legacy)
      effect: read
      questions:
      - How can I search cardiac orders for one patient on the legacy endpoint?
      - Can the old cardiac order finder filter by practice?
      instructions:
      - text: Find legacy cardiac orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Search old-style cardiac orders at practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cardiac_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Order a cardiac test (legacy endpoint)
      effect: write
      questions:
      - How do I place a cardiac order through the legacy unversioned API?
      - Which fields must a new cardiac order carry on the old endpoint?
      instructions:
      - text: Create a legacy cardiac order for patient {patient} at practice {practice} with reason {clinical_reason}, sent to {ancillary_company}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          clinical_reason: requestBody.clinical_reason
          ancillary_company: requestBody.ancillary_company
      - text: Place an old-style cardiac order for tests {tests} ordered by {prescribing_user}.
        slots:
          tests: requestBody.tests
          prescribing_user: requestBody.prescribing_user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List cardiac orders
      effect: read
      questions:
      - Which cardiac orders exist for a patient in Elation?
      - Can I page through a practice's cardiac orders sorted by a field?
      instructions:
      - text: List cardiac orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Show practice {practice}'s cardiac orders ordered by {order_by}, {limit} at a time.
        slots:
          practice: query.practice
          order_by: query.order_by
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a cardiac order
      effect: write
      questions:
      - How do I order an ECG or other cardiac test for a patient through API v2?
      - Can a new cardiac order be sent to a specific cardiac center?
      instructions:
      - text: Order cardiac tests {tests} for patient {patient} at practice {practice}, reason {clinical_reason}.
        slots:
          tests: requestBody.tests
          patient: requestBody.patient
          practice: requestBody.practice
          clinical_reason: requestBody.clinical_reason
      - text: Send a v2 cardiac order to cardiac center {cardiac_center} via {ancillary_company}, prescribed by {prescribing_user}.
        slots:
          cardiac_center: requestBody.cardiac_center
          ancillary_company: requestBody.ancillary_company
          prescribing_user: requestBody.prescribing_user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cardiac order
      effect: read
      questions:
      - How do I see the tests and resolution on one cardiac order?
      - What does a single v2 cardiac order record contain?
      instructions:
      - text: Get cardiac order {id}.
        slots:
          id: path.id
      - text: Retrieve v2 cardiac order {id} with its tests.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a cardiac order
      effect: write
      questions:
      - Can I replace every field of a cardiac order in v2?
      - Which v2 call fully rewrites a cardiac order?
      instructions:
      - text: Replace cardiac order {id} with tests {tests} and reason {clinical_reason}.
        slots:
          id: path.id
          tests: requestBody.tests
          clinical_reason: requestBody.clinical_reason
      - text: Overwrite v2 cardiac order {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cardiac order
      effect: destructive
      questions:
      - How do I delete a cardiac order in v2?
      - Can I cancel a cardiac order that was entered by mistake?
      instructions:
      - text: Delete cardiac order {id}.
        slots:
          id: path.id
      - text: Remove v2 cardiac order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/cardiac_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update part of a cardiac order
      effect: write
      questions:
      - Can I record a test date on an existing cardiac order without resending it?
      - How do I sign a cardiac order in v2?
      instructions:
      - text: Set the test date on cardiac order {id} to {test_date}.
        slots:
          id: path.id
          test_date: requestBody.test_date
      - text: Mark v2 cardiac order {id} signed by {signed_by} on {signed_date}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
          signed_date: requestBody.signed_date
      method: generated
      generated: '2026-09-26'