API Evangelist conversational phrasing for Elation Health Physicians API

# 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 Physicians API
  version: 1.0.0
extends: openapi/elation-health-physicians-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['/physicians/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find physicians by name or NPI (legacy)
      effect: read
      questions:
      - How do I look up a physician in the practice by NPI on the older endpoint?
      - Can I search legacy physician records by first and last name?
      instructions:
      - text: Find the physician with NPI {npi} using the legacy search.
        slots:
          npi: query.npi
      - text: Search older physician records for {first_name} {last_name}.
        slots:
          first_name: query.first_name
          last_name: query.last_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/physicians/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a physician (legacy)
      effect: read
      questions:
      - How do I pull one physician's profile from the unversioned route?
      - What credentials and license info does the legacy physician record hold?
      instructions:
      - text: Get legacy physician {id}.
        slots:
          id: path.id
      - text: Show license and credentials for older physician record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/physicians/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a physician profile (legacy)
      effect: write
      questions:
      - How do I overwrite a physician's profile, including telehealth settings, on the older PUT route?
      - Which fields are mandatory for a legacy physician replace?
      instructions:
      - text: Replace legacy physician {id} with name {first_name} {last_name} and email {email}.
        slots:
          id: path.id
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
      - text: Overwrite older physician profile {id} with telehealth settings {telehealth_settings}.
        slots:
          id: path.id
          telehealth_settings: requestBody.telehealth_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/physicians/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a physician profile (legacy)
      effect: write
      questions:
      - Can I change just a physician's license state on the older PATCH route?
      - How do I tweak one field on a legacy physician without resending the rest?
      instructions:
      - text: Patch legacy physician {id} with license {license} in state {license_state}.
        slots:
          id: path.id
          license: requestBody.license
          license_state: requestBody.license_state
      - text: Set credentials {credentials} on older physician {id}.
        slots:
          credentials: requestBody.credentials
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/physicians/{id}/availabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get physician availabilities (legacy)
      effect: read
      questions:
      - Is there an older unversioned route for reading when a physician is available?
      - Where does the legacy API expose physician scheduling availability?
      instructions:
      - text: Read physician {id}'s availability from the legacy availabilities route.
        slots:
          id: path.id
      - text: Pull older-style availability windows for a physician.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/physicians/{id}/availabilities'].put
  update:
    x-apievangelist-phrasing:
      intent: Update physician availabilities (legacy)
      effect: write
      questions:
      - Is there an older unversioned route for setting a physician's available hours?
      - Which legacy call writes physician availability?
      instructions:
      - text: Write new availability windows for physician {id} through the legacy availabilities route.
        slots:
          id: path.id
      - text: Push older-style open hours for a physician.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/2.0/physicians/'].get
  update:
    x-apievangelist-phrasing:
      intent: List physicians with paging
      effect: read
      questions:
      - How do I page through every physician in the v2.0 API?
      - Can I sort the v2.0 physician list and filter it by NPI?
      instructions:
      - text: List v2.0 physicians with NPI {npi}.
        slots:
          npi: query.npi
      - text: Page through physicians {limit} at a time from offset {offset}, ordered by {order_by}.
        slots:
          limit: query.limit
          offset: query.offset
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/physicians/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a physician from the v2.0 API
      effect: read
      questions:
      - How do I fetch one physician by ID from /api/2.0?
      - Does the v2.0 physician record include specialty and fax?
      instructions:
      - text: Retrieve v2.0 physician {id}.
        slots:
          id: path.id
      - text: Show /api/2.0 physician {id} with specialty and practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/physicians/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a physician in the v2.0 API
      effect: write
      questions:
      - How do I fully replace a physician record in /api/2.0, including NPI and license?
      - What does the v2.0 physician replace require?
      instructions:
      - text: Replace v2.0 physician {id} with NPI {npi}, license {license} in {license_state} and email {email}.
        slots:
          id: path.id
          npi: requestBody.npi
          license: requestBody.license
          license_state: requestBody.license_state
          email: requestBody.email
      - text: Overwrite /api/2.0 physician {id} with specialty {specialty} and fax {fax}.
        slots:
          id: path.id
          specialty: requestBody.specialty
          fax: requestBody.fax
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/physicians/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a physician in the v2.0 API
      effect: write
      questions:
      - Can I deactivate a physician in the v2.0 API without replacing the record?
      - How do I change only a physician's specialty through /api/2.0?
      instructions:
      - text: Set v2.0 physician {id} active status to {is_active}.
        slots:
          id: path.id
          is_active: requestBody.is_active
      - text: Change the specialty of /api/2.0 physician {id} to {specialty}.
        slots:
          id: path.id
          specialty: requestBody.specialty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/physicians/{id}/availabilities/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a physician's availabilities
      effect: read
      questions:
      - When is a given physician available to see patients?
      - How do I read a physician's availability through /api/2.0?
      instructions:
      - text: Get the availabilities for v2.0 physician {id}.
        slots:
          id: path.id
      - text: Show when physician {id} is open for appointments.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/physicians/{id}/availabilities/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a physician's availabilities
      effect: write
      questions:
      - How do I set a physician's available hours through /api/2.0?
      - Can I replace a physician's availability windows in one call?
      instructions:
      - text: Set physician {id}'s availabilities to {availabilities}.
        slots:
          id: path.id
          availabilities: requestBody.availabilities
      - text: Replace the v2.0 open hours for physician {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'