# 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 Document Interaction API
  version: 1.0.0
extends: openapi/hint-health-documentinteraction-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: 3
- target: $.paths['/provider/patients/{patient_id}/interactions/document'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document to a patient's record
      effect: write
      questions:
      - How do I attach a document from my system to a patient's record?
      - Can I post a document with a status and attachments?
      instructions:
      - text: Add a document titled {title} to patient {patient_id} with status {status}.
        slots:
          title: requestBody.title
          patient_id: path.patient_id
          status: requestBody.status
      - text: Create a {status} document on patient {patient_id} with attachments {attachments}.
        slots:
          status: requestBody.status
          patient_id: path.patient_id
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/document/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document on a patient's record
      effect: read
      questions:
      - Can I fetch a document interaction I added to a patient?
      - What is the status of a document on a patient's record?
      instructions:
      - text: Show document {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get patient {patient_id}'s document interaction {id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/document/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a document on a patient's record
      effect: write
      questions:
      - How do I change the status or body of a patient document I already posted?
      - Can I replace the attachments on an existing document interaction?
      instructions:
      - text: Set document {id} on patient {patient_id} to status {status}.
        slots:
          id: path.id
          patient_id: path.patient_id
          status: requestBody.status
      - text: Update document {id} for patient {patient_id} to status {status} with body {body}.
        slots:
          id: path.id
          patient_id: path.patient_id
          status: requestBody.status
          body: requestBody.body
      method: generated
      generated: '2026-10-01'