# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Visit Notes API
  version: 1.0.0
extends: openapi/elation-health-notes-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: 6
- target: $.paths['/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List visit notes
      effect: read
      questions:
      - How do I list a patient's notes in Elation?
      - Can I show only draft notes for certain providers?
      instructions:
      - text: List notes for patient {patient}.
        slots:
          patient: query.patient
      - text: Show draft notes {is_draft} written by providers {providers} at practice {practice_id}.
        slots:
          is_draft: query.is_draft
          providers: query.providers
          practice_id: query.practice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a note
      effect: write
      questions:
      - How do I start a new visit note for a patient?
      - Can a new note be marked confidential and linked to a bill?
      instructions:
      - text: Create a {category} note for patient {patient} by provider {provider} at practice {practice}.
        slots:
          category: requestBody.category
          patient: requestBody.patient
          provider: requestBody.provider
          practice: requestBody.practice
      - text: Start a confidential {confidential} note for patient {patient} with exam reason {exam_reason}.
        slots:
          confidential: requestBody.confidential
          patient: requestBody.patient
          exam_reason: requestBody.exam_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{note_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a note without taking a snapshot
      effect: read
      questions:
      - How do I read a note's contents without starting an edit session?
      - Does reading a note return sections or the legacy note format?
      instructions:
      - text: Get note {note_id}.
        slots:
          note_id: path.note_id
      - text: Show the sections of note {note_id} read-only.
        slots:
          note_id: path.note_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{note_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a draft note
      effect: destructive
      questions:
      - Can I delete a note that is still a draft?
      - How do I throw away an unsigned draft note?
      instructions:
      - text: Delete draft note {note_id}.
        slots:
          note_id: path.note_id
      - text: Discard the draft with id {note_id}.
        slots:
          note_id: path.note_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{note_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a note's content
      effect: write
      questions:
      - How do I change the content of an existing note?
      - Can I close a note snapshot when saving my edits?
      instructions:
      - text: Update note {note_id} with content {content}.
        slots:
          note_id: path.note_id
          content: requestBody.content
      - text: Save edits to note {note_id} against snapshot {snapshot_id} and close it {close_snapshot}.
        slots:
          note_id: path.note_id
          snapshot_id: requestBody.snapshot_id
          close_snapshot: requestBody.close_snapshot
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{note_id}/amendments/{amendment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an amendment to a note
      effect: read
      questions:
      - How do I see an amendment added to a signed note?
      - Which call returns one note amendment by its id?
      instructions:
      - text: Get amendment {amendment_id} on note {note_id}.
        slots:
          amendment_id: path.amendment_id
          note_id: path.note_id
      - text: Show what amendment {amendment_id} changed in note {note_id}.
        slots:
          amendment_id: path.amendment_id
          note_id: path.note_id
      method: generated
      generated: '2026-09-26'