# 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 Clinical Note Interaction API
  version: 1.0.0
extends: openapi/hint-health-clinicalnoteinteraction-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/clinical_note'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a clinical note to a patient's chart
      effect: write
      questions:
      - How do I post a clinical note from my system into a patient's chart?
      - Can I attach files and a provider name to a clinical note?
      instructions:
      - text: Add a clinical note titled {title} to patient {patient_id} with text {text}.
        slots:
          title: requestBody.title
          patient_id: path.patient_id
          text: requestBody.text
      - text: Create a clinical note for patient {patient_id} by {provider_name} dated {event_timestamp}.
        slots:
          patient_id: path.patient_id
          provider_name: requestBody.provider_name
          event_timestamp: requestBody.event_timestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/clinical_note/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clinical note on a patient
      effect: read
      questions:
      - Can I read back a clinical note I posted to a patient's chart?
      - What does a specific clinical note contain?
      instructions:
      - text: Show clinical note {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get patient {patient_id}'s clinical note {id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/clinical_note/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing clinical note
      effect: write
      questions:
      - Is it possible to correct the text of a clinical note already in a patient's chart?
      - Can I record an integration error message on a clinical note?
      instructions:
      - text: Update the text of clinical note {id} for patient {patient_id} to {text}.
        slots:
          id: path.id
          patient_id: path.patient_id
          text: requestBody.text
      - text: Set integration error {integration_error_message} on clinical note {id} for patient {patient_id}.
        slots:
          integration_error_message: requestBody.integration_error_message
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'