# 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 Non Visit Notes API
  version: 1.0.0
extends: openapi/elation-health-non-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: 12
- target: $.paths['/non_visit_notes/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a non-visit note (legacy)
      effect: read
      questions:
      - How do I fetch one non-visit note from the legacy endpoint?
      - What does the old unversioned path return for a single non-visit note?
      instructions:
      - text: Fetch legacy non-visit note {id}.
        slots:
          id: path.id
      - text: Show non-visit note {id} using the original endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/non_visit_notes/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a non-visit note (legacy PUT)
      effect: write
      questions:
      - Can I overwrite a non-visit note's type and dates with the legacy PUT?
      - Which legacy call fully replaces a non-visit note?
      instructions:
      - text: Replace legacy non-visit note {id} with type {type}, document date {document_date} and chart date {chart_date}.
        slots:
          id: path.id
          type: requestBody.type
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Rewrite the bullets of old-style note {id} as {bullets}.
        slots:
          id: path.id
          bullets: requestBody.bullets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/non_visit_notes/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a non-visit note (legacy)
      effect: destructive
      questions:
      - How do I remove a non-visit note with the legacy API?
      - Can the unversioned non-visit notes path delete a note?
      instructions:
      - text: Delete legacy non-visit note {id}.
        slots:
          id: path.id
      - text: Remove non-visit note {id} through the old endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/non_visit_notes/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Sign or edit a non-visit note (legacy PATCH)
      effect: write
      questions:
      - Can I sign a non-visit note through the legacy PATCH?
      - What legacy call changes only the tags on a non-visit note?
      instructions:
      - text: Sign legacy non-visit note {id} as {signed_by} on {sign_date}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
          sign_date: requestBody.sign_date
      - text: Patch the tags on old-style non-visit note {id} to {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/non_visit_notes/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's non-visit notes (legacy)
      effect: read
      questions:
      - How can I search a patient's non-visit notes on the legacy endpoint?
      - Does the old non-visit note finder require a patient?
      instructions:
      - text: Find legacy non-visit notes for patient {patient}.
        slots:
          patient: query.patient
      - text: Search the old endpoint for patient {patient}'s non-visit notes.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/non_visit_notes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a non-visit note (legacy)
      effect: write
      questions:
      - How do I add a non-visit note to a chart through the legacy API?
      - Can a legacy non-visit note carry a note document attachment?
      instructions:
      - text: Create a legacy {type} non-visit note for patient {patient} dated {document_date}, charted {chart_date}.
        slots:
          type: requestBody.type
          patient: requestBody.patient
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Add an old-style non-visit note with bullets {bullets} to patient {patient}'s chart.
        slots:
          bullets: requestBody.bullets
          patient: requestBody.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/'].get
  update:
    x-apievangelist-phrasing:
      intent: List non-visit notes
      effect: read
      questions:
      - Which non-visit notes are on a patient's chart in Elation?
      - Can I page through non-visit notes sorted by date?
      instructions:
      - text: List non-visit notes for patient {patient}.
        slots:
          patient: query.patient
      - text: Show non-visit notes ordered by {order_by}, {limit} per page.
        slots:
          order_by: query.order_by
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a non-visit note to a chart
      effect: write
      questions:
      - How do I record a phone call or other non-visit note in v2?
      - Can a new v2 non-visit note be signed when it is created?
      instructions:
      - text: Add a {type} non-visit note to patient {patient} with document date {document_date} and chart date {chart_date}.
        slots:
          type: requestBody.type
          patient: requestBody.patient
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Create a v2 non-visit note for patient {patient} signed by {signed_by}.
        slots:
          patient: requestBody.patient
          signed_by: requestBody.signed_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one non-visit note
      effect: read
      questions:
      - How do I read a single non-visit note with its bullets in v2?
      - What does a v2 non-visit note record include?
      instructions:
      - text: Get non-visit note {id}.
        slots:
          id: path.id
      - text: Retrieve v2 non-visit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a non-visit note
      effect: write
      questions:
      - Can I replace a whole non-visit note in v2?
      - Which v2 call overwrites every field of a non-visit note?
      instructions:
      - text: Replace non-visit note {id} with type {type} for patient {patient}.
        slots:
          id: path.id
          type: requestBody.type
          patient: requestBody.patient
      - text: Overwrite v2 non-visit note {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a non-visit note
      effect: destructive
      questions:
      - How do I delete a non-visit note in v2?
      - Can I remove a non-visit note written on the wrong chart?
      instructions:
      - text: Delete non-visit note {id}.
        slots:
          id: path.id
      - text: Remove v2 non-visit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/non_visit_notes/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a non-visit note
      effect: write
      questions:
      - Can I add tags to an existing non-visit note in v2?
      - How do I sign a non-visit note after it was written?
      instructions:
      - text: Tag non-visit note {id} with {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      - text: Sign v2 non-visit note {id} as {signed_by}.
        slots:
          id: path.id
          signed_by: requestBody.signed_by
      method: generated
      generated: '2026-09-26'