API Evangelist conversational phrasing for Elation Health Medications 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 Medications API
  version: 1.0.0
extends: openapi/elation-health-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: 8
- target: $.paths['/medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's medications (legacy)
      effect: read
      questions:
      - How can I search a patient's medications on the legacy endpoint?
      - Can the old medication finder show only discontinued or permanent meds?
      instructions:
      - text: Find legacy medications for patient {patient} that are discontinued {discontinued}.
        slots:
          patient: query.patient
          discontinued: query.discontinued
      - text: Search old-style medications in thread {thread} documented after {document_date__gt}.
        slots:
          thread: query.thread
          document_date__gt: query.document_date__gt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Prescribe or document a medication (legacy)
      effect: write
      questions:
      - How do I add a prescription to a chart through the legacy medications API?
      - Which fields does the old endpoint require for a new medication, such as refills and quantity?
      instructions:
      - text: 'Create a legacy {order_type} medication {medication} for patient {patient}: qty {qty} {qty_units}, {auth_refills} refills, starting {start_date}.'
        slots:
          order_type: requestBody.order_type
          medication: requestBody.medication
          patient: requestBody.patient
          qty: requestBody.qty
          qty_units: requestBody.qty_units
          auth_refills: requestBody.auth_refills
          start_date: requestBody.start_date
      - text: Document old-style med {medication} prescribed by {prescribing_physician} with directions {directions}.
        slots:
          medication: requestBody.medication
          prescribing_physician: requestBody.prescribing_physician
          directions: requestBody.directions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/medications/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a medication (legacy)
      effect: read
      questions:
      - How do I fetch one medication entry from the legacy endpoint?
      - What does the old unversioned medications path return for one med?
      instructions:
      - text: Fetch legacy medication {id}.
        slots:
          id: path.id
      - text: Show medication {id} from the legacy unversioned endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/medications/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a medication (legacy)
      effect: destructive
      questions:
      - Can I delete a medication using the legacy unversioned path?
      - Is there an old endpoint for removing a medication from a chart?
      instructions:
      - text: Delete legacy medication {id}.
        slots:
          id: path.id
      - text: Remove medication {id} through the old endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: List medications
      effect: read
      questions:
      - What medications is a patient on in Elation?
      - Can I list only active, non-discontinued medications for a practice?
      - Is there a filter for medications documented within a date range?
      instructions:
      - text: List medications for patient {patient}.
        slots:
          patient: query.patient
      - text: Show medications at practice {practice} documented on or after {document_date__gte}.
        slots:
          practice: query.practice
          document_date__gte: query.document_date__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a medication to a chart
      effect: write
      questions:
      - How do I write a prescription for a patient with API v2?
      - Can a new medication allow substitutions and set a days supply?
      instructions:
      - text: 'Prescribe {medication} to patient {patient}: qty {qty} {qty_units}, {auth_refills} refills, from {start_date}, by {prescribing_physician}.'
        slots:
          medication: requestBody.medication
          patient: requestBody.patient
          qty: requestBody.qty
          qty_units: requestBody.qty_units
          auth_refills: requestBody.auth_refills
          start_date: requestBody.start_date
          prescribing_physician: requestBody.prescribing_physician
      - text: Add v2 medication {medication} for patient {patient} with a {days_supply} day supply.
        slots:
          medication: requestBody.medication
          patient: requestBody.patient
          days_supply: requestBody.days_supply
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/medications/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one medication
      effect: read
      questions:
      - How do I see the directions and refills on one medication?
      - What does a single v2 medication record include?
      instructions:
      - text: Get v2.0 medication {id}.
        slots:
          id: path.id
      - text: Retrieve v2 medication {id} with its directions.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/medications/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a medication
      effect: destructive
      questions:
      - How do I delete a medication entered in error in v2?
      - Can a v2 medication be removed from a patient's chart?
      instructions:
      - text: Delete medication {id}.
        slots:
          id: path.id
      - text: Remove v2 medication {id} from the chart.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'