# 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 Immunizations API
  version: 1.0.0
extends: openapi/elation-health-immunizations-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: 8
- target: $.paths['/immunizations/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an immunization (legacy endpoint)
      effect: read
      questions:
      - Can I look up one vaccination record on the legacy path?
      - What lot number and dose does the original endpoint return for an immunization?
      instructions:
      - text: Get legacy immunization {id}.
        slots:
          id: path.id
      - text: Show vaccination record {id} from the older endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/immunizations/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an immunization (legacy endpoint)
      effect: destructive
      questions:
      - Is there a legacy endpoint to remove a vaccination record?
      - Can I delete an immunization entered on the wrong chart through the original path?
      instructions:
      - text: Delete legacy immunization {id}.
        slots:
          id: path.id
      - text: Remove vaccination record {id} via the old endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/immunizations/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's immunizations (legacy)
      effect: read
      questions:
      - What vaccines has a patient received, per the legacy endpoint?
      - Can the original immunization search filter by patient?
      instructions:
      - text: Find legacy immunizations for patient {patient}.
        slots:
          patient: query.patient
      - text: Search the old endpoint for patient {patient}'s vaccine history.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/immunizations/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an immunization (legacy endpoint)
      effect: write
      questions:
      - How do I record a vaccine given to a patient through the legacy endpoint?
      - Which details are required to log a shot the old way?
      instructions:
      - text: Record legacy immunization {vaccine} for patient {patient} given {date}, qty {qty}, by {admin} ordered by {orderer}.
        slots:
          vaccine: requestBody.vaccine
          patient: requestBody.patient
          date: requestBody.administered_date
          qty: requestBody.qty
          admin: requestBody.administering_physician
          orderer: requestBody.ordering_physician
      - text: Log on the old endpoint that patient {patient} got {vaccine} from lot {lot}.
        slots:
          patient: requestBody.patient
          vaccine: requestBody.vaccine
          lot: requestBody.lot_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/immunizations/'].get
  update:
    x-apievangelist-phrasing:
      intent: List immunizations (v2.0)
      effect: read
      questions:
      - Can I page through a patient's immunizations in the 2.0 API?
      - Can I sort version 2.0 vaccination records?
      instructions:
      - text: List v2.0 immunizations for patient {patient}.
        slots:
          patient: query.patient
      - text: List 2.0 immunizations ordered by {order_by}.
        slots:
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/immunizations/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an immunization (v2.0)
      effect: write
      questions:
      - How do I log a vaccine with its service location in version 2.0?
      - Can I record the date the VIS was given in the 2.0 API?
      instructions:
      - text: Create v2.0 immunization {vaccine} for patient {patient} on {date}, qty {qty}, given by {admin}, ordered by {orderer}.
        slots:
          vaccine: requestBody.vaccine
          patient: requestBody.patient
          date: requestBody.administered_date
          qty: requestBody.qty
          admin: requestBody.administering_physician
          orderer: requestBody.ordering_physician
      - text: Record 2.0 immunization {vaccine} for patient {patient} at service location {location}.
        slots:
          vaccine: requestBody.vaccine
          patient: requestBody.patient
          location: requestBody.service_location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/immunizations/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an immunization (v2.0)
      effect: read
      questions:
      - Which 2.0 call fetches one vaccination record?
      - Does the v2.0 immunization include funding source and VFC eligibility?
      instructions:
      - text: Get v2.0 immunization {id}.
        slots:
          id: path.id
      - text: Retrieve vaccination {id} from the 2.0 API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/immunizations/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an immunization (v2.0)
      effect: destructive
      questions:
      - How do I delete a vaccination record through the 2.0 API?
      - Can I remove a duplicate immunization in version 2.0?
      instructions:
      - text: Delete v2.0 immunization {id}.
        slots:
          id: path.id
      - text: Remove vaccination {id} with the 2.0 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'