# 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 Notes v1 API
  version: 1.0.0
extends: openapi/elation-health-notes-v1-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: 5
- target: $.paths['/v1/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List visit notes metadata
      effect: read
      questions:
      - How do I list the notes written for a patient?
      - Can I see only draft notes for particular providers?
      instructions:
      - text: List notes for patient {patient}.
        slots:
          patient: query.patient
      - text: Show draft status {is_draft} notes by providers {providers} in 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['/v1/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legacy visit note
      effect: write
      questions:
      - How do I write a new visit note on a patient's chart?
      - Can I mark a new note confidential and set the service date?
      instructions:
      - text: Create a {category} note for patient {patient} by provider {provider} in practice {practice}.
        slots:
          category: requestBody.category
          patient: requestBody.patient
          provider: requestBody.provider
          practice: requestBody.practice
      - text: Write a confidential {confidential} note with exam reason {exam_reason}, serviced at {serviced_at}.
        slots:
          confidential: requestBody.confidential
          exam_reason: requestBody.exam_reason
          serviced_at: requestBody.serviced_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notes/{note_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legacy visit note
      effect: read
      questions:
      - How do I read the content of a specific note?
      - Why would fetching a note fail for notes using the newer EN2.1 schema?
      instructions:
      - text: Get note {note_id}.
        slots:
          note_id: path.note_id
      - text: Show the content and category of legacy note {note_id}.
        slots:
          note_id: path.note_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notes/{note_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a draft legacy note
      effect: destructive
      questions:
      - How do I throw away a draft note I no longer need?
      - Can only draft notes be deleted?
      instructions:
      - text: Delete draft note {note_id}.
        slots:
          note_id: path.note_id
      - text: Discard the unsigned legacy draft {note_id}.
        slots:
          note_id: path.note_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notes/{note_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a legacy visit note
      effect: write
      questions:
      - How do I edit the content or provider on an existing note?
      - Can I close a note by sending a snapshot?
      instructions:
      - text: Update note {note_id} with content {content}.
        slots:
          note_id: path.note_id
          content: requestBody.content
      - text: Close legacy note {note_id} using snapshot {snapshot_id} and close_snapshot {close_snapshot}.
        slots:
          note_id: path.note_id
          snapshot_id: requestBody.snapshot_id
          close_snapshot: requestBody.close_snapshot
      method: generated
      generated: '2026-09-26'