# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Patient API
  version: 1.0.0
extends: openapi/hint-health-patient-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/provider/patients'].get
  update:
    x-apievangelist-phrasing:
      intent: List patients
      effect: read
      questions:
      - How do I get a list of all patients in my practice?
      - Can I see only archived patients instead of active ones?
      - Is there a way to page through patients in batches?
      instructions:
      - text: List all patients.
      - text: List patients filtered by {filter}.
        slots:
          filter: query.filter
      - text: Show {limit} patients starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new patient
      effect: write
      questions:
      - What do I need to add a new patient to the practice?
      - Can I record a patient's chosen name and pronouns when I create them?
      instructions:
      - text: Create a patient named {first_name} {last_name}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
      - text: Add new patient {first_name} {last_name} with email {email} and birth date {dob}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          dob: requestBody.dob
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a patient
      effect: read
      questions:
      - What is a specific patient's membership status?
      - Where can I see one patient's full profile?
      instructions:
      - text: Show patient {id}.
        slots:
          id: path.id
      - text: Check whether patient {id} has an active membership.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a patient
      effect: destructive
      questions:
      - Can I permanently delete a patient record?
      - Is there a way to remove a duplicate patient from the practice?
      instructions:
      - text: Delete patient {id}.
        slots:
          id: path.id
      - text: Remove the patient record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a patient's details
      effect: write
      questions:
      - Can I change an existing patient's address or phone number?
      - Is it possible to update the insurance details on a patient I already have?
      instructions:
      - text: Update patient {id} with first name {first_name} and last name {last_name}.
        slots:
          id: path.id
          first_name: requestBody.first_name
          last_name: requestBody.last_name
      - text: Change the email on existing patient {id} ({first_name} {last_name}) to {email}.
        slots:
          id: path.id
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/matching'].post
  update:
    x-apievangelist-phrasing:
      intent: Find patients matching a name and details
      effect: read
      questions:
      - Does a patient with this name and birth date already exist before I create one?
      - Can I match patients on email or phone as well as name?
      instructions:
      - text: Find patients matching {first_name} {last_name}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
      - text: Match existing patients named {first_name} {last_name} born {dob}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          dob: requestBody.dob
      method: generated
      generated: '2026-10-01'