# 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 Message Threads API
  version: 1.0.0
extends: openapi/elation-health-message-threads-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/message_threads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message thread (Get endpoint)
      effect: read
      questions:
      - How do I fetch a patient message thread by its id with the Get Message Thread call?
      - Can I read a care-team message thread's members and messages?
      instructions:
      - text: Get message thread {id} using the Get Message Thread endpoint.
        slots:
          id: path.id
      - text: Fetch the messages in thread {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find message threads by patient or date
      effect: read
      questions:
      - Can I find message threads for a patient within a document date range?
      - Which message threads were documented after a given date at my practice?
      instructions:
      - text: Find message threads for patient {patient}.
        slots:
          patient: query.patient
      - text: Find threads at practice {practice} documented after {document_date__gt}.
        slots:
          practice: query.practice
          document_date__gt: query.document_date__gt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a message thread with a sender
      effect: write
      questions:
      - How do I start a new message thread about a patient with a named sender?
      - Can I flag a new message thread as urgent when I create it?
      instructions:
      - text: Start a message thread for patient {patient} from sender {sender} at practice {practice}, dated {document_date}, charted {chart_date}.
        slots:
          patient: requestBody.patient
          sender: requestBody.sender
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Open an urgent thread from {sender} about patient {patient} in practice {practice} on {document_date} charted {chart_date} flagged {is_urgent}.
        slots:
          sender: requestBody.sender
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
          is_urgent: requestBody.is_urgent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message thread (legacy)
      effect: destructive
      questions:
      - How do I remove a message thread using the older delete call?
      - Can a message thread be deleted once it's created?
      instructions:
      - text: Delete message thread {id} with the legacy Delete Message Thread call.
        slots:
          id: path.id
      - text: Remove thread {id} from the patient chart via the legacy endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/message_threads/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a thread's urgency or members
      effect: write
      questions:
      - Can I mark an existing message thread urgent after the fact?
      - How do I add members to a message thread that already exists?
      instructions:
      - text: 'Mark message thread {id} urgent: {is_urgent}.'
        slots:
          id: path.id
          is_urgent: requestBody.is_urgent
      - text: Set the members of thread {id} to {members} on the legacy endpoint.
        slots:
          id: path.id
          members: requestBody.members
      method: generated
      generated: '2026-10-02'
- target: $.paths['/message_threads/ [WIP]'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a message thread (WIP endpoint)
      effect: write
      questions:
      - Is there a work-in-progress version of the create message thread call?
      - Can I create a thread with the WIP endpoint without naming a sender?
      instructions:
      - text: Using the WIP endpoint, create a thread for patient {patient} at practice {practice} dated {document_date}, charted {chart_date}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Create a WIP message thread for {patient} in {practice} with messages {messages}, document date {document_date}, chart date {chart_date}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          messages: requestBody.messages
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/ [WIP]'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message thread (WIP endpoint)
      effect: destructive
      questions:
      - Does the work-in-progress API have its own message thread delete?
      - Can I delete a thread through the WIP endpoint?
      instructions:
      - text: Delete thread {id} via the WIP endpoint.
        slots:
          id: path.id
      - text: Use the work-in-progress delete to remove message thread {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/message_threads/'].get
  update:
    x-apievangelist-phrasing:
      intent: List message threads with paging
      effect: read
      questions:
      - Can I page through all message threads with limit and offset?
      - How do I list threads sorted by document date on or before a cutoff?
      instructions:
      - text: List message threads, {limit} per page.
        slots:
          limit: query.limit
      - text: List threads for patient {patient} documented on or before {document_date__lte}, sorted by {order_by}.
        slots:
          patient: query.patient
          document_date__lte: query.document_date__lte
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/message_threads/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a message thread for signing
      effect: write
      questions:
      - Can I create a message thread already signed by a provider?
      - What's the minimum to create a new message thread in a patient chart?
      instructions:
      - text: Create a thread for patient {patient} at practice {practice} dated {document_date} with chart date {chart_date}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Create a thread for {patient} in {practice}, dated {document_date}, charted {chart_date}, signed by {signed_by}.
        slots:
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
          signed_by: requestBody.signed_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/message_threads/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a message thread
      effect: read
      questions:
      - Where can I retrieve a message thread including who signed it?
      - Can I retrieve a thread's delivery date by id?
      instructions:
      - text: Retrieve message thread {id}.
        slots:
          id: path.id
      - text: Retrieve who signed thread {id} and when.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/message_threads/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a message thread
      effect: write
      questions:
      - Can I fully replace a message thread's patient, practice and dates?
      - Which fields are required to overwrite a whole message thread?
      instructions:
      - text: Replace thread {id} with patient {patient}, practice {practice}, document date {document_date} and chart date {chart_date}.
        slots:
          id: path.id
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
      - text: Overwrite thread {id} for {patient} at {practice}, dated {document_date}, charted {chart_date}, delivered {delivery_date}.
        slots:
          id: path.id
          patient: requestBody.patient
          practice: requestBody.practice
          document_date: requestBody.document_date
          chart_date: requestBody.chart_date
          delivery_date: requestBody.delivery_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/message_threads/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message thread
      effect: destructive
      questions:
      - How do I delete an existing message thread from the chart?
      - Is deleting a message thread permanent?
      instructions:
      - text: Delete existing message thread {id}.
        slots:
          id: path.id
      - text: Destroy v2.0 message thread {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/message_threads/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a message thread
      effect: write
      questions:
      - Can I change only the signer or signed date on a message thread?
      - Can I partially update a thread's chart date in the v2.0 API without resending everything?
      instructions:
      - text: Partially update thread {id} with signed date {signed_date}.
        slots:
          id: path.id
          signed_date: requestBody.signed_date
      - text: Change the chart date of thread {id} to {chart_date}.
        slots:
          id: path.id
          chart_date: requestBody.chart_date
      method: generated
      generated: '2026-10-02'