# 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 Order Compendiums API
  version: 1.0.0
extends: openapi/elation-health-lab-order-compendiums-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/lab_order_compendiums/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a lab order compendium (legacy)
      effect: read
      questions:
      - How do I fetch one lab order compendium entry from the legacy endpoint?
      - What does the old unversioned compendium path return for a single entry?
      instructions:
      - text: Fetch legacy lab order compendium {id}.
        slots:
          id: path.id
      - text: Show compendium entry {id} using the original endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_order_compendiums/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab compendium entry (legacy PUT)
      effect: write
      questions:
      - Can I overwrite a compendium entry's vendor, code and name with the legacy PUT?
      - Which legacy call requires all three of lab vendor, code and name?
      instructions:
      - text: Replace legacy compendium {id} with vendor {lab_vendor}, code {code} and name {name}.
        slots:
          id: path.id
          lab_vendor: requestBody.lab_vendor
          code: requestBody.code
          name: requestBody.name
      - text: Fully rewrite old-style compendium entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_order_compendiums/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab order compendium (legacy)
      effect: destructive
      questions:
      - How do I remove a lab order compendium entry with the legacy API?
      - Can the unversioned compendium path delete an entry?
      instructions:
      - text: Delete legacy lab order compendium {id}.
        slots:
          id: path.id
      - text: Remove compendium entry {id} through the old endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_order_compendiums/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a lab compendium entry (legacy PATCH)
      effect: write
      questions:
      - Can I change just the name of a compendium entry on the legacy endpoint?
      - Does the legacy compendium PATCH still need the lab vendor?
      instructions:
      - text: Rename legacy compendium {id} to {name} for vendor {lab_vendor}.
        slots:
          id: path.id
          name: requestBody.name
          lab_vendor: requestBody.lab_vendor
      - text: Patch the code on old-style compendium entry {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_order_compendiums/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search lab order compendiums (legacy)
      effect: read
      questions:
      - How can I search the legacy compendium by test code or name?
      - Can the old finder show only entries my practice created?
      instructions:
      - text: Find legacy compendium entries named {name} from vendor {lab_vendor}.
        slots:
          name: query.name
          lab_vendor: query.lab_vendor
      - text: Search old-style compendiums with code {code} created by practice {practice_created}.
        slots:
          code: query.code
          practice_created: query.practice_created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_order_compendiums/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a lab order compendium (legacy)
      effect: write
      questions:
      - How do I add a lab test to the compendium through the legacy API?
      - What must a new compendium entry include on the old endpoint?
      instructions:
      - text: Create a legacy compendium entry {name} with code {code} for vendor {lab_vendor}.
        slots:
          name: requestBody.name
          code: requestBody.code
          lab_vendor: requestBody.lab_vendor
      - text: Add old-style lab test {name} to vendor {lab_vendor}'s compendium.
        slots:
          name: requestBody.name
          lab_vendor: requestBody.lab_vendor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lab order compendiums
      effect: read
      questions:
      - Which lab tests are in a vendor's order compendium in Elation?
      - Can I filter compendiums by code and sort the results?
      instructions:
      - text: List lab order compendiums for vendor {lab_vendor}.
        slots:
          lab_vendor: query.lab_vendor
      - text: Show compendium entries matching name {name}, ordered by {order_by}.
        slots:
          name: query.name
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lab order compendium entry
      effect: write
      questions:
      - How do I add a custom lab test to a vendor's compendium in v2?
      - Is a code required when creating a v2 compendium entry?
      instructions:
      - text: Create compendium entry {name} for lab vendor {lab_vendor}.
        slots:
          name: requestBody.name
          lab_vendor: requestBody.lab_vendor
      - text: Add a v2 lab test {name} with code {code} to vendor {lab_vendor}.
        slots:
          name: requestBody.name
          code: requestBody.code
          lab_vendor: requestBody.lab_vendor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one lab order compendium entry
      effect: read
      questions:
      - How do I read a single lab compendium entry in v2?
      - What fields does a v2 compendium record expose?
      instructions:
      - text: Get lab order compendium {id}.
        slots:
          id: path.id
      - text: Retrieve v2 compendium entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab order compendium entry
      effect: write
      questions:
      - Can I replace a compendium entry entirely in v2?
      - Which v2 call overwrites a lab compendium entry?
      instructions:
      - text: Replace compendium {id} with name {name} under vendor {lab_vendor}.
        slots:
          id: path.id
          name: requestBody.name
          lab_vendor: requestBody.lab_vendor
      - text: Overwrite v2 lab order compendium {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab order compendium entry
      effect: destructive
      questions:
      - How do I delete a lab compendium entry in v2?
      - Can I remove an outdated test from the compendium?
      instructions:
      - text: Delete lab order compendium {id}.
        slots:
          id: path.id
      - text: Remove v2 compendium entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_order_compendiums/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a lab compendium entry
      effect: write
      questions:
      - Can I fix just the code on a compendium entry in v2?
      - How do I rename a lab test in the compendium without resending everything?
      instructions:
      - text: Change the code of compendium {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Rename v2 compendium entry {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'