API Evangelist conversational phrasing for Elation Health Practice 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 Practice Medications API
  version: 1.0.0
extends: openapi/elation-health-practice-medications-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: 10
- target: $.paths['/practice_medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom practice medications (legacy)
      effect: read
      questions:
      - Can I look up a practice's custom medications by name on the older unversioned path?
      - Which legacy endpoint searches practice-defined drugs?
      instructions:
      - text: Find legacy practice medications named {name}.
        slots:
          name: query.name
      - text: Search old-route custom medications for practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/practice_medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom practice medication (legacy)
      effect: write
      questions:
      - What does the legacy call need to add a medication that isn't in the drug database?
      - Can I flag a custom drug as controlled on the old create endpoint?
      instructions:
      - text: Create legacy practice medication {name} of type {type} for practice {practice}.
        slots:
          name: requestBody.name
          type: requestBody.type
          practice: requestBody.practice
      - text: Add old-route custom drug {name}, strength {strength}, controlled {is_controlled}, type {type}, practice {practice}.
        slots:
          name: requestBody.name
          strength: requestBody.strength
          is_controlled: requestBody.is_controlled
          type: requestBody.type
          practice: requestBody.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/practice_medications/{practice_medication_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a custom practice medication (legacy)
      effect: read
      questions:
      - What does the unversioned endpoint return for one practice medication?
      - Can I read a custom drug by id on the legacy path?
      instructions:
      - text: Fetch legacy practice medication {practice_medication_id}.
        slots:
          practice_medication_id: path.practice_medication_id
      - text: Open custom drug {practice_medication_id} from the old route.
        slots:
          practice_medication_id: path.practice_medication_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/practice_medications/{practice_medication_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a custom practice medication obsolete
      effect: write
      questions:
      - How do I retire a custom medication so it stops showing up for prescribing?
      - Can I set the date a practice medication became obsolete?
      instructions:
      - text: Mark practice medication {practice_medication_id} obsolete.
        slots:
          practice_medication_id: path.practice_medication_id
      - text: Obsolete custom drug {practice_medication_id} as of {obsoleted_date}.
        slots:
          practice_medication_id: path.practice_medication_id
          obsoleted_date: requestBody.obsoleted_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom practice medications
      effect: read
      questions:
      - How do I list the custom medications my practice has defined?
      - Can I filter v2.0 practice medications by name and page the results?
      instructions:
      - text: List v2.0 practice medications for practice {practice}.
        slots:
          practice: query.practice
      - text: Show practice medications matching {name}, ordered by {order_by}.
        slots:
          name: query.name
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom practice medication
      effect: write
      questions:
      - Can I add a custom drug with its NDCs and RxNorm codes in API v2.0?
      - Which fields describe a new practice medication's form and route?
      instructions:
      - text: Create v2.0 practice medication {name} for practice {practice} with strength {strength} and form {form}.
        slots:
          name: requestBody.name
          practice: requestBody.practice
          strength: requestBody.strength
          form: requestBody.form
      - text: Add custom drug {generic_name} with NDCs {ndcs} and RxNorm CUIs {rxnorm_cuis}.
        slots:
          generic_name: requestBody.generic_name
          ndcs: requestBody.ndcs
          rxnorm_cuis: requestBody.rxnorm_cuis
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom practice medication
      effect: read
      questions:
      - What does a single v2.0 practice medication record contain?
      - Can I see the active NDCs of one custom drug?
      instructions:
      - text: Retrieve v2.0 practice medication {id}.
        slots:
          id: path.id
      - text: Show the NDCs and strength for custom drug {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom practice medication
      effect: write
      questions:
      - Which v2.0 call does a full replacement of a practice medication?
      - Can I overwrite a custom drug's brand and generic names together?
      instructions:
      - text: Replace practice medication {id} with brand {brand_name} and generic {generic_name}.
        slots:
          id: path.id
          brand_name: requestBody.brand_name
          generic_name: requestBody.generic_name
      - text: Do a full PUT on custom drug {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom practice medication
      effect: destructive
      questions:
      - Can I delete a custom medication that was added by mistake?
      - What removes a practice medication in API v2.0?
      instructions:
      - text: Delete v2.0 practice medication {id}.
        slots:
          id: path.id
      - text: Remove the mistaken custom drug {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/practice_medications/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a custom practice medication
      effect: write
      questions:
      - Can I set a market end date on a custom drug without resending everything?
      - Is there a v2.0 partial update for a practice medication's route?
      instructions:
      - text: Set the market end date of practice medication {id} to {market_end_date}.
        slots:
          id: path.id
          market_end_date: requestBody.market_end_date
      - text: Change the route on custom drug {id} to {route}.
        slots:
          id: path.id
          route: requestBody.route
      method: generated
      generated: '2026-09-26'