# 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 Pulmonary Orders API
  version: 1.0.0
extends: openapi/elation-health-pulmonary-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: 12
- target: $.paths['/pulmonary_orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pulmonary order (Get)
      effect: read
      questions:
      - How do I get a patient's pulmonary function test order?
      - Can I get a pulmonary order's clinical reason by id?
      instructions:
      - text: Get pulmonary order {id}.
        slots:
          id: path.id
      - text: Get the clinical reason on pulmonary order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pulmonary_orders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a pulmonary order (legacy PUT)
      effect: write
      questions:
      - Can I overwrite a pulmonary order with the older PUT call?
      - What does the legacy full pulmonary order update require?
      instructions:
      - text: Legacy-PUT pulmonary order {id} for patient {patient} with clinical reason {clinical_reason}.
        slots:
          id: path.id
          patient: requestBody.patient
          clinical_reason: requestBody.clinical_reason
      - text: Overwrite via legacy PUT the pulmonary order's tests to {tests}.
        slots:
          tests: requestBody.tests
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pulmonary_orders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pulmonary order (legacy)
      effect: destructive
      questions:
      - How do I cancel a pulmonary order with the older delete call?
      - Can I delete a pulmonary test order entered in error via the legacy endpoint?
      instructions:
      - text: Delete pulmonary order {id} with the legacy call.
        slots:
          id: path.id
      - text: Remove the erroneous pulmonary order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/pulmonary_orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a pulmonary order (legacy PATCH)
      effect: write
      questions:
      - Can I change a pulmonary order's ICD-10 codes with the legacy PATCH?
      - Is there an older partial update for pulmonary orders?
      instructions:
      - text: Legacy-patch pulmonary order {id}'s ICD-10 codes to {icd10_codes}.
        slots:
          id: path.id
          icd10_codes: requestBody.icd10_codes
      - text: Legacy-patch the pulmonary order follow-up method to {follow_up_method}.
        slots:
          follow_up_method: requestBody.follow_up_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pulmonary_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find pulmonary orders for a patient
      effect: read
      questions:
      - Which pulmonary orders has a patient had, per the legacy endpoint?
      - Can I find pulmonary orders placed at my practice?
      instructions:
      - text: Find pulmonary orders for patient {patient}.
        slots:
          patient: query.patient
      - text: Find pulmonary orders at practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-10-02'
- target: $.paths['/pulmonary_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Order pulmonary tests (legacy create)
      effect: write
      questions:
      - How do I order a pulmonary function test with the older create call?
      - Can I send a pulmonary order to a specific pulmonary center on the legacy endpoint?
      instructions:
      - text: Order pulmonary tests {tests} for patient {patient}, prescribed by {prescribing_user}, for {clinical_reason}.
        slots:
          tests: requestBody.tests
          patient: requestBody.patient
          prescribing_user: requestBody.prescribing_user
          clinical_reason: requestBody.clinical_reason
      - text: Legacy-create a pulmonary order for {patient} sent to pulmonary center {pulmonary_center}.
        slots:
          patient: requestBody.patient
          pulmonary_center: requestBody.pulmonary_center
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/pulmonary_orders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List pulmonary orders with paging
      effect: read
      questions:
      - Can I page through pulmonary orders with limit and offset?
      - How do I list pulmonary orders sorted by date in the v2.0 API?
      instructions:
      - text: List pulmonary orders, {limit} per page.
        slots:
          limit: query.limit
      - text: List pulmonary orders for {patient} sorted by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/pulmonary_orders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pulmonary order with allergies
      effect: write
      questions:
      - Can I create a pulmonary order that lists the patient's allergies?
      - Does creating a pulmonary order in the v2.0 API let me set a test date?
      instructions:
      - text: Create a pulmonary order for {patient} noting allergies {allergies} and reason {clinical_reason}.
        slots:
          patient: requestBody.patient
          allergies: requestBody.allergies
          clinical_reason: requestBody.clinical_reason
      - text: Create a pulmonary order for {patient} with ancillary company {ancillary_company} and test date {test_date}.
        slots:
          patient: requestBody.patient
          ancillary_company: requestBody.ancillary_company
          test_date: requestBody.test_date
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/pulmonary_orders/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a pulmonary order
      effect: read
      questions:
      - Can I retrieve a pulmonary order's resolution and who signed it?
      - Where do I retrieve a single pulmonary order?
      instructions:
      - text: Retrieve pulmonary order {id}.
        slots:
          id: path.id
      - text: Retrieve the resolution of pulmonary order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/pulmonary_orders/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a pulmonary order
      effect: write
      questions:
      - Can I replace a pulmonary order by id with a new resolution?
      - What must I send to fully replace a pulmonary order?
      instructions:
      - text: Replace pulmonary order {id} for patient {patient} with clinical reason {clinical_reason}.
        slots:
          id: path.id
          patient: requestBody.patient
          clinical_reason: requestBody.clinical_reason
      - text: Replace the full contents of pulmonary order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/pulmonary_orders/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pulmonary order
      effect: destructive
      questions:
      - How do I delete an existing pulmonary order by id?
      - Can a pulmonary order be destroyed?
      instructions:
      - text: Delete existing pulmonary order {id}.
        slots:
          id: path.id
      - text: Destroy v2.0 pulmonary order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/pulmonary_orders/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a pulmonary order
      effect: write
      questions:
      - Can I record a pulmonary order's resolution without replacing it?
      - How do I mark a pulmonary order confidential?
      instructions:
      - text: Set the resolution of pulmonary order {id} to {resolution}.
        slots:
          id: path.id
          resolution: requestBody.resolution
      - text: 'Mark pulmonary order {id} confidential: {confidential}.'
        slots:
          id: path.id
          confidential: requestBody.confidential
      method: generated
      generated: '2026-09-26'