API Evangelist conversational phrasing for Elation Health Visit Notes API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Visit Notes API
  version: 1.0.0
extends: openapi/elation-health-visit-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: 14
- target: $.paths['/visit_notes/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a visit note (legacy endpoint)
      effect: read
      questions:
      - Can I read a single visit note through the older visit notes path?
      - What does the legacy get-visit-note call return for an encounter?
      instructions:
      - text: Open visit note {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the bullets of old-path visit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visit_notes/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a visit note (legacy PUT)
      effect: write
      questions:
      - How do I replace every field of a visit note on the unversioned path?
      - Can I switch a visit note's template or mark it confidential with the legacy full update?
      instructions:
      - text: On the legacy path, replace visit note {id} for patient {patient} by physician {physician} at practice {practice} using template {template}.
        slots:
          id: path.id
          patient: requestBody.patient
          physician: requestBody.physician
          practice: requestBody.practice
          template: requestBody.template
      - text: Rewrite legacy visit note {id} with document date {document_date} and chart date {chart_date}.
        slots:
          id: path.id
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visit_notes/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a visit note (legacy endpoint)
      effect: destructive
      questions:
      - Is it possible to delete a visit note through the original visit notes path?
      - What happens when I remove a draft encounter note with the legacy delete?
      instructions:
      - text: Delete visit note {id} with the legacy endpoint.
        slots:
          id: path.id
      - text: Remove the mistaken old-path visit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visit_notes/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Sign a draft visit note
      effect: write
      questions:
      - How do I sign a draft visit note so it's finalized?
      - Who can be recorded as the signer when signing an encounter note?
      instructions:
      - text: Sign draft visit note {id} as user {signed_by} dated {signed_date}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
          signed_date: requestBody.signed_date
      - text: Finalize the encounter note {id} with my signature today.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visit_notes/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find visit notes (legacy endpoint)
      effect: read
      questions:
      - Can I find a patient's unsigned visit notes with the older search?
      - Which visit notes were signed between two dates, using the legacy lookup?
      instructions:
      - text: Using the legacy lookup, find visit notes for patient {patient} that are still unsigned.
        slots:
          patient: query.patient
      - text: Find old-path visit notes by physician {physician} signed from {from_signed_date} to {to_signed_date}.
        slots:
          physician: query.physician
          from_signed_date: query.from_signed_date
          to_signed_date: query.to_signed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/visit_notes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a visit note (legacy endpoint)
      effect: write
      questions:
      - Can I document an encounter by creating a visit note on the legacy path?
      - What's required to post a new visit note through the older endpoint?
      instructions:
      - text: Via the legacy endpoint, create a visit note for patient {patient} by physician {physician} with template {template}.
        slots:
          patient: requestBody.patient
          physician: requestBody.physician
          template: requestBody.template
      - text: Post an old-path encounter note with bullets {bullets}, document date {document_date} and chart date {chart_date}.
        slots:
          bullets: requestBody.bullets
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/'].get
  update:
    x-apievangelist-phrasing:
      intent: List visit notes in API 2.0
      effect: read
      questions:
      - How do I list visit notes changed since a given time in the 2.0 API?
      - Can API 2.0 return only unsigned visit notes for my practice?
      - What sort orders are available when listing visit notes?
      instructions:
      - text: List 2.0 visit notes for patient {patient} ordered by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      - text: List API 2.0 visit notes modified after {last_modified__gt}, {limit} per page.
        slots:
          last_modified__gt: query.last_modified__gt
          limit: query.limit
      - text: Show unsigned 2.0 visit notes for practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a visit note in API 2.0
      effect: write
      questions:
      - How do I create an encounter visit note with the 2.0 API?
      - Can a new 2.0 visit note be created already signed?
      instructions:
      - text: In API 2.0, create a visit note for patient {patient} by physician {physician} using template {template}.
        slots:
          patient: requestBody.patient
          physician: requestBody.physician
          template: requestBody.template
      - text: Create a 2.0 visit note with bullets {bullets}, document date {document_date} and chart date {chart_date}.
        slots:
          bullets: requestBody.bullets
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a visit note in API 2.0
      effect: read
      questions:
      - How do I fetch a single visit note by ID with API 2.0?
      - Does a retrieved 2.0 visit note include its signatures?
      instructions:
      - text: Retrieve API 2.0 visit note {id}.
        slots:
          id: path.id
      - text: Get who signed 2.0 visit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a visit note's signature in API 2.0
      effect: write
      questions:
      - Can I replace a 2.0 visit note's signing details with a PUT?
      - What fields does a full visit note replacement accept in API 2.0?
      instructions:
      - text: Replace 2.0 visit note {id} with signer {signed_by} and signed date {signed_date}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
          signed_date: requestBody.signed_date
      - text: Overwrite the signatures on API 2.0 visit note {id} with {signatures}.
        slots:
          id: path.id
          signatures: requestBody.signatures
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a visit note in API 2.0
      effect: destructive
      questions:
      - How do I delete a visit note with the 2.0 API?
      - Can I remove an encounter note created by mistake in API 2.0?
      instructions:
      - text: Delete API 2.0 visit note {id}.
        slots:
          id: path.id
      - text: Remove the erroneous 2.0 encounter note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a visit note in API 2.0
      effect: write
      questions:
      - Can I set just the signed date on a visit note with a 2.0 partial update?
      - Is there a PATCH in API 2.0 for adding a signer to a visit note?
      instructions:
      - text: Patch 2.0 visit note {id} so it is signed by {signed_by}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
      - text: Partially update API 2.0 visit note {id} with signed date {signed_date}.
        slots:
          id: path.id
          signed_date: requestBody.signed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/clinical_summary/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a visit note's clinical summary
      effect: read
      questions:
      - How do I get the clinical summary generated for a visit note?
      - Can I pull the clinical summary document for an encounter?
      instructions:
      - text: Get the clinical summary for visit note {id}.
        slots:
          id: path.id
      - text: Download the encounter clinical summary of note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/visit_notes/{id}/visit_summary/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a visit note's patient visit summary
      effect: read
      questions:
      - Where do I get the after-visit summary for a patient's visit note?
      - Can I retrieve the visit summary to hand to a patient after their appointment?
      instructions:
      - text: Pull the patient-facing visit summary of note {id}.
        slots:
          id: path.id
      - text: Fetch the after-visit summary tied to note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'