# 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 Discontinued Medications API
  version: 1.0.0
extends: openapi/elation-health-discontinued-medications-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: 7
- target: $.paths['/discontinued_medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search discontinued medications (legacy)
      effect: read
      questions:
      - Can I find which medications a patient stopped on the older unversioned endpoint?
      - Does the legacy search filter by discontinue date?
      instructions:
      - text: Find legacy discontinued medications for patient {patient}.
        slots:
          patient: query.patient
      - text: Search legacy meds stopped on or after {discontinue_date__gte} at practice {practice}.
        slots:
          discontinue_date__gte: query.discontinue_date__gte
          practice: query.practice
      method: generated
      generated: '2026-10-02'
- target: $.paths['/discontinued_medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Discontinue a medication order (legacy)
      effect: write
      questions:
      - What does the legacy call need to stop a patient's medication?
      - Can I record a reason when discontinuing a med on the old path?
      instructions:
      - text: Discontinue medication order {med_order} via the legacy endpoint.
        slots:
          med_order: requestBody.med_order
      - text: Stop med order {med_order} on {discontinue_date} for reason {reason} through the old route.
        slots:
          med_order: requestBody.med_order
          discontinue_date: requestBody.discontinue_date
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/discontinued_medications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a discontinued medication (legacy)
      effect: read
      questions:
      - What does the unversioned path return for one discontinued medication?
      - Can I read a single stopped-medication record on the legacy API?
      instructions:
      - text: Fetch legacy discontinued medication {id}.
        slots:
          id: path.id
      - text: Open stopped-medication record {id} from the original route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/discontinued_medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: List discontinued medications
      effect: read
      questions:
      - How do I list the medications a patient has stopped taking?
      - Can I filter v2.0 discontinued meds to permanent ones or by prescriber?
      instructions:
      - text: List v2.0 discontinued medications for patient {patient}.
        slots:
          patient: query.patient
      - text: Show v2.0 permanently stopped meds where permanent is {permanent}, prescribed by {prescribing_physician}.
        slots:
          permanent: query.permanent
          prescribing_physician: query.prescribing_physician
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/discontinued_medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a discontinued medication
      effect: write
      questions:
      - Can I note who documented a discontinuation in API v2.0?
      - What's required to mark a medication order as discontinued in the current API?
      instructions:
      - text: Record v2.0 discontinuation of med order {med_order} with reason {reason}.
        slots:
          med_order: requestBody.med_order
          reason: requestBody.reason
      - text: Discontinue order {med_order} documented by {documenting_personnel}, supervised by {supervising_physician}.
        slots:
          med_order: requestBody.med_order
          documenting_personnel: requestBody.documenting_personnel
          supervising_physician: requestBody.supervising_physician
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/discontinued_medications/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one discontinued medication
      effect: read
      questions:
      - What does a v2.0 discontinued medication record include?
      - Can I see why and when a specific med was stopped?
      instructions:
      - text: Retrieve v2.0 discontinued medication {id}.
        slots:
          id: path.id
      - text: Show the reason and date for discontinued med {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/discontinued_medications/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discontinued medication record
      effect: destructive
      questions:
      - Can I undo a discontinuation entered by mistake?
      - What deletes a discontinued medication in API v2.0?
      instructions:
      - text: Delete v2.0 discontinued medication {id}.
        slots:
          id: path.id
      - text: Remove the mistaken discontinuation record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'