# 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 Facility Identifiers API
  version: 1.0.0
extends: openapi/elation-health-lab-facility-identifiers-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_facility_identifiers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lab facility identifier (legacy)
      effect: destructive
      questions:
      - Can I remove a lab facility identifier using the older unversioned endpoint?
      - Which legacy call deletes a practice's lab facility mapping?
      instructions:
      - text: Delete legacy lab facility identifier {id}.
        slots:
          id: path.id
      - text: Remove facility mapping {id} through the original lab facility route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_facility_identifiers/{id} [WIP]'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a lab facility identifier (legacy WIP)
      effect: read
      questions:
      - What does the work-in-progress legacy endpoint return for one lab facility identifier?
      - Can I read a single lab facility mapping on the old unversioned path?
      instructions:
      - text: Fetch legacy lab facility identifier {id}.
        slots:
          id: path.id
      - text: Show facility mapping {id} from the WIP lab facility route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_facility_identifiers/{id} [WIP]'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab facility identifier (legacy WIP)
      effect: write
      questions:
      - Which legacy WIP call overwrites a whole lab facility identifier?
      - Must I resend vendor, practice and both facility codes when replacing a mapping on the old path?
      instructions:
      - text: Replace legacy identifier {id} with vendor {vendor}, practice {practice}, lab facility {lab_facility}, practice facility {practice_facility}, active {active}.
        slots:
          id: path.id
          vendor: requestBody.vendor
          practice: requestBody.practice
          lab_facility: requestBody.lab_facility
          practice_facility: requestBody.practice_facility
          active: requestBody.active
      - text: Overwrite old-route facility mapping {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_facility_identifiers/{id} [WIP]'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a lab facility identifier (legacy WIP)
      effect: write
      questions:
      - Can I deactivate a lab facility mapping with the legacy PATCH?
      - Is there an old WIP endpoint to change only the description of a facility identifier?
      instructions:
      - text: Set active to {active} on legacy facility identifier {id}.
        slots:
          active: requestBody.active
          id: path.id
      - text: Patch the description of old-route mapping {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_facility_identifiers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lab facility identifiers (legacy)
      effect: read
      questions:
      - Where do I find all lab facility identifiers on the legacy unversioned API?
      - Does the old lab facility search need an Authentication header?
      instructions:
      - text: Using credential {auth}, list every legacy lab facility identifier.
        slots:
          auth: header.Authentication
      - text: Authenticate with {auth} and pull the old-route facility mappings.
        slots:
          auth: header.Authentication
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lab_facility_identifiers/ [WIP]'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a lab facility identifier (legacy WIP)
      effect: write
      questions:
      - What does the old WIP endpoint need to register a new lab facility mapping?
      - Can I attach a compendium when adding a facility identifier through the legacy route?
      instructions:
      - text: 'Create a legacy identifier: vendor {vendor}, practice {practice}, lab facility {lab_facility}, practice facility {practice_facility}.'
        slots:
          vendor: requestBody.vendor
          practice: requestBody.practice
          lab_facility: requestBody.lab_facility
          practice_facility: requestBody.practice_facility
      - text: Add an old-route mapping with compendium {compendium} for vendor {vendor}.
        slots:
          compendium: requestBody.compendium
          vendor: requestBody.vendor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lab vendor integrations
      effect: read
      questions:
      - How do I see every lab vendor integration configured for my practices?
      - Can I sort and page the v2.0 lab facility identifier list?
      instructions:
      - text: List v2.0 lab facility identifiers ordered by {order_by}.
        slots:
          order_by: query.order_by
      - text: Show the next {limit} lab vendor integrations starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a lab vendor integration
      effect: write
      questions:
      - What's required to connect a practice to a lab vendor's facility?
      - Can I mark a new lab integration as bidirectional?
      instructions:
      - text: Create a v2.0 lab integration for practice {practice} with vendor {vendor}, lab facility {lab_facility}, practice facility {practice_facility}, active {active}.
        slots:
          practice: requestBody.practice
          vendor: requestBody.vendor
          lab_facility: requestBody.lab_facility
          practice_facility: requestBody.practice_facility
          active: requestBody.active
      - text: Set up a user-facing lab connection {lab_connection} for practice {practice}.
        slots:
          lab_connection: requestBody.lab_connection
          practice: requestBody.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one lab vendor integration
      effect: read
      questions:
      - Can I check the settings of a single lab vendor integration?
      - Which facility codes does one v2.0 lab integration use?
      instructions:
      - text: Retrieve v2.0 lab integration {id}.
        slots:
          id: path.id
      - text: Show the facility codes for lab vendor integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a lab vendor integration
      effect: write
      questions:
      - Which v2.0 call fully replaces a lab vendor integration?
      - Must every required field be resent when replacing a lab integration?
      instructions:
      - text: Replace lab integration {id} with vendor {vendor}, practice {practice}, lab facility {lab_facility}, practice facility {practice_facility}, active {active}.
        slots:
          id: path.id
          vendor: requestBody.vendor
          practice: requestBody.practice
          lab_facility: requestBody.lab_facility
          practice_facility: requestBody.practice_facility
          active: requestBody.active
      - text: Do a full v2.0 PUT on lab integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a lab vendor integration
      effect: destructive
      questions:
      - Can I disconnect a practice from a lab by deleting its integration?
      - What deletes a lab facility identifier in API v2.0?
      instructions:
      - text: Delete v2.0 lab integration {id}.
        slots:
          id: path.id
      - text: Disconnect lab vendor integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/lab_facility_identifiers/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a lab vendor integration
      effect: write
      questions:
      - Can I switch a lab integration's bidirectional connection on without resending everything?
      - Is there a partial update to change a lab integration's secondary practice id?
      instructions:
      - text: Set bidirectional connection {bidi_connection} on lab integration {id}.
        slots:
          bidi_connection: requestBody.bidi_connection
          id: path.id
      - text: Change the practice secondary id of lab integration {id} to {practice_secondary_id}.
        slots:
          id: path.id
          practice_secondary_id: requestBody.practice_secondary_id
      method: generated
      generated: '2026-09-26'