# 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 Allergies API
  version: 1.0.0
extends: openapi/elation-health-allergies-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['/allergies/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an allergy (legacy endpoint)
      effect: read
      questions:
      - How do I read one allergy entry by id on the legacy allergies path?
      - What reaction and severity does the original endpoint return for an allergy?
      instructions:
      - text: Get legacy allergy {id}.
        slots:
          id: path.id
      - text: Show allergy {id} from the older allergies endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allergies/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an allergy (legacy PUT)
      effect: write
      questions:
      - Can I overwrite a patient's allergy record through the legacy PUT?
      - Which legacy call fully replaces an allergy's name, reaction and severity?
      instructions:
      - text: Replace legacy allergy {id} for patient {patient} with allergen name {name}.
        slots:
          id: path.id
          patient: requestBody.patient
          name: requestBody.name
      - text: Overwrite old-endpoint allergy {id} with severity {severity}.
        slots:
          id: path.id
          severity: requestBody.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allergies/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allergy (legacy endpoint)
      effect: destructive
      questions:
      - How do I remove an allergy from a chart using the legacy endpoint?
      - Can I delete an allergy that was recorded in error through the original path?
      instructions:
      - text: Delete legacy allergy {id}.
        slots:
          id: path.id
      - text: Remove allergy {id} via the old allergies endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allergies/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an allergy's status or notes (legacy PATCH)
      effect: write
      questions:
      - Can I mark an allergy inactive with the legacy PATCH call?
      - How do I add notes to an existing allergy on the unversioned path?
      instructions:
      - text: Patch legacy allergy {id} to status {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Add notes {notes} to allergy {id} on the old endpoint.
        slots:
          id: path.id
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allergies/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's allergies (legacy endpoint)
      effect: read
      questions:
      - How do I see all allergies recorded for a patient on the legacy path?
      - Can the original allergies search filter to one patient?
      instructions:
      - text: Find legacy allergies for patient {patient}.
        slots:
          patient: query.patient
      - text: Search the old allergies endpoint for everything on patient {patient}'s chart.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allergies/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an allergy (legacy endpoint)
      effect: write
      questions:
      - How do I add a new allergy to a patient's chart through the legacy endpoint?
      - Can I record the reaction and start date when adding an allergy the old way?
      instructions:
      - text: Add legacy allergy {name} for patient {patient}.
        slots:
          name: requestBody.name
          patient: requestBody.patient
      - text: Record on the old endpoint that patient {patient} is allergic to {name} with reaction {reaction}.
        slots:
          patient: requestBody.patient
          name: requestBody.name
          reaction: requestBody.reaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/'].get
  update:
    x-apievangelist-phrasing:
      intent: List allergies (v2.0)
      effect: read
      questions:
      - What allergies does a patient have according to the 2.0 API?
      - Can I page and sort through allergy records in version 2.0?
      instructions:
      - text: List v2.0 allergies for patient {patient}.
        slots:
          patient: query.patient
      - text: List 2.0 allergies ordered by {order_by}, {limit} at a time.
        slots:
          order_by: query.order_by
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an allergy (v2.0)
      effect: write
      questions:
      - How do I add an allergy with a Medi-Span id in the 2.0 API?
      - What is required to record a new allergy in version 2.0?
      instructions:
      - text: Create a v2.0 allergy {name} for patient {patient}.
        slots:
          name: requestBody.name
          patient: requestBody.patient
      - text: Record 2.0 allergy {name} for patient {patient} with Medi-Span id {medispanid}.
        slots:
          name: requestBody.name
          patient: requestBody.patient
          medispanid: requestBody.medispanid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an allergy (v2.0)
      effect: read
      questions:
      - How do I fetch a single allergy record in the 2.0 API?
      - Does the v2.0 allergy record include its Medi-Span identifiers?
      instructions:
      - text: Get v2.0 allergy {id}.
        slots:
          id: path.id
      - text: Retrieve allergy {id} from the 2.0 API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an allergy (v2.0 PUT)
      effect: write
      questions:
      - Can I fully replace an allergy record in version 2.0?
      - Which 2.0 call overwrites every field of an allergy?
      instructions:
      - text: Replace v2.0 allergy {id} with name {name} for patient {patient}.
        slots:
          id: path.id
          name: requestBody.name
          patient: requestBody.patient
      - text: Overwrite 2.0 allergy {id} in full, setting status {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allergy (v2.0)
      effect: destructive
      questions:
      - How do I delete an allergy through the 2.0 API?
      - Can I remove a duplicate allergy entry in version 2.0?
      instructions:
      - text: Delete v2.0 allergy {id}.
        slots:
          id: path.id
      - text: Remove allergy {id} with the 2.0 allergies endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/allergies/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some allergy fields (v2.0)
      effect: write
      questions:
      - Can I change only an allergy's severity in the 2.0 API?
      - Which v2.0 call edits part of an allergy without resending it all?
      instructions:
      - text: Patch v2.0 allergy {id} to severity {severity}.
        slots:
          id: path.id
          severity: requestBody.severity
      - text: Update the reaction on 2.0 allergy {id} to {reaction}.
        slots:
          id: path.id
          reaction: requestBody.reaction
      method: generated
      generated: '2026-09-26'