# 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 Vitals API
  version: 1.0.0
extends: openapi/elation-health-vitals-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['/vitals/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a vitals record (legacy)
      effect: read
      questions:
      - Can I pull one set of recorded vitals by id from the older unversioned endpoint?
      - What does the legacy vitals path return for a single reading?
      instructions:
      - text: Fetch legacy vitals record {id}.
        slots:
          id: path.id
      - text: Open vitals reading {id} from the original route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vitals/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search vitals by patient or note (legacy)
      effect: read
      questions:
      - Can I find the vitals attached to a specific visit note on the legacy path?
      - Does the old vitals search filter by patient and practice?
      instructions:
      - text: Find legacy vitals for patient {patient}.
        slots:
          patient: query.patient
      - text: Search old-route vitals recorded on visit note {visit_note}.
        slots:
          visit_note: query.visit_note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vitals/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record vitals for a patient (legacy)
      effect: write
      questions:
      - What must I send to record a patient's blood pressure and weight through the legacy endpoint?
      - Can the old create call attach vitals to a visit note?
      instructions:
      - text: 'Record legacy vitals for patient {patient} at practice {practice}: blood pressure {bp}, heart rate {hr}.'
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          bp: requestBody.bp
          hr: requestBody.hr
      - text: Add old-route vitals with height {height} and weight {weight} to visit note {visit_note} for patient {patient}.
        slots:
          height: requestBody.height
          weight: requestBody.weight
          visit_note: requestBody.visit_note
          patient: requestBody.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vitals/:id/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a vitals record (legacy PUT)
      effect: write
      questions:
      - Which legacy PUT overwrites a full set of vitals?
      - Do I have to resend temperature, oxygen and respiratory rate when replacing vitals on the old path?
      instructions:
      - text: Replace legacy vitals for patient {patient} with temperature {temperature}, oxygen {oxygen} and respiratory rate {rr}.
        slots:
          patient: requestBody.patient
          temperature: requestBody.temperature
          oxygen: requestBody.oxygen
          rr: requestBody.rr
      - text: Overwrite old-route vitals at practice {practice} with head circumference {hc}.
        slots:
          practice: requestBody.practice
          hc: requestBody.hc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vitals/:id/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a vitals record (legacy PATCH)
      effect: write
      questions:
      - Is there a legacy PATCH for correcting part of a vitals record?
      - Can I fix one vitals value through the old unversioned PATCH?
      instructions:
      - text: Patch the legacy vitals record with the corrected values.
      - text: Apply a partial correction to vitals through the old PATCH route.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vitals/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's vitals
      effect: read
      questions:
      - How do I list the vitals recorded for one patient?
      - Can I page and sort v2.0 vitals for a practice?
      - Which vitals were captured on a non-visit note?
      instructions:
      - text: List v2.0 vitals for patient {patient}, ordered by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      - text: Show vitals recorded on non-visit note {non_visit_note}.
        slots:
          non_visit_note: query.non_visit_note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vitals/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new set of vitals
      effect: write
      questions:
      - Can I record pain score and BMI percentile with vitals in API v2.0?
      - What's required to save a patient's vitals in the current API?
      instructions:
      - text: Record v2.0 vitals for patient {patient} at practice {practice} with pain {pain} and temperature {temperature}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          pain: requestBody.pain
          temperature: requestBody.temperature
      - text: Save BMI {bmi} and BMI percentile {bmi_percentile} for patient {patient} at practice {practice}.
        slots:
          bmi: requestBody.bmi
          bmi_percentile: requestBody.bmi_percentile
          patient: requestBody.patient
          practice: requestBody.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vitals/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one vitals record
      effect: read
      questions:
      - What does a single v2.0 vitals record include?
      - Can I see custom observations saved with a vitals reading?
      instructions:
      - text: Retrieve v2.0 vitals record {id}.
        slots:
          id: path.id
      - text: Show all measurements and custom observations in vitals {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vitals/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a vitals record
      effect: write
      questions:
      - Which v2.0 call fully replaces a vitals record?
      - Must patient and practice be resent when replacing vitals?
      instructions:
      - text: Replace vitals {id} for patient {patient} at practice {practice}.
        slots:
          id: path.id
          patient: requestBody.patient
          practice: requestBody.practice
      - text: Do a full v2.0 PUT on vitals {id} with custom observations {custom_observations}.
        slots:
          id: path.id
          custom_observations: requestBody.custom_observations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vitals/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct part of a vitals record
      effect: write
      questions:
      - Can I fix just the weight on a vitals record in v2.0?
      - Is there a partial update to sign off on recorded vitals?
      instructions:
      - text: Change the weight on vitals {id} to {weight}.
        slots:
          id: path.id
          weight: requestBody.weight
      - text: Mark v2.0 vitals {id} signed by {signed_by} on {signed_date}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
          signed_date: requestBody.signed_date
      method: generated
      generated: '2026-09-26'