# 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 Histories API
  version: 1.0.0
extends: openapi/elation-health-histories-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: 8
- target: $.paths['/histories/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's histories (legacy endpoint)
      effect: read
      questions:
      - Can I see a patient's social and family history entries via the legacy lookup?
      - What history is recorded for this patient on the older histories path?
      instructions:
      - text: Using the legacy lookup, find histories for patient {patient}.
        slots:
          patient: query.patient
      - text: Show all old-path history entries on file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/histories/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a history entry (legacy endpoint)
      effect: write
      questions:
      - How do I record a patient's surgical or social history through the legacy endpoint?
      - What's needed to add a history entry the old way?
      instructions:
      - text: 'Via the legacy endpoint, add a {type} history for patient {patient}: {text}.'
        slots:
          type: requestBody.type
          patient: requestBody.patient
          text: requestBody.text
      - text: Record old-path history text {text} of type {type} on patient {patient}.
        slots:
          text: requestBody.text
          type: requestBody.type
          patient: requestBody.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/histories/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a history entry (legacy endpoint)
      effect: read
      questions:
      - Can I read one history entry on the legacy histories path?
      - Does the older get-history call return the entry's type?
      instructions:
      - text: Open history entry {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the text of old-path history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/histories/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a history entry (legacy endpoint)
      effect: destructive
      questions:
      - Is there a legacy call to remove an incorrect history entry?
      - Can I delete a patient history item on the original path?
      instructions:
      - text: Delete history entry {id} with the legacy endpoint.
        slots:
          id: path.id
      - text: Remove the incorrect old-path history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/histories/'].get
  update:
    x-apievangelist-phrasing:
      intent: List patient histories in API 2.0
      effect: read
      questions:
      - How do I list patient histories for a practice in the 2.0 API?
      - Can API 2.0 return one patient's history entries in a set order?
      instructions:
      - text: List 2.0 histories for patient {patient} ordered by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      - text: List API 2.0 histories for practice {practice}, {limit} per page.
        slots:
          practice: query.practice
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/histories/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a patient history in API 2.0
      effect: write
      questions:
      - How do I add a family or social history entry with the 2.0 API?
      - Can I set a display rank on a new history entry?
      instructions:
      - text: In API 2.0, create a {type} history for patient {patient} reading {text}.
        slots:
          type: requestBody.type
          patient: requestBody.patient
          text: requestBody.text
      - text: Add a 2.0 history entry {text} of type {type} for patient {patient} at rank {rank}.
        slots:
          text: requestBody.text
          type: requestBody.type
          patient: requestBody.patient
          rank: requestBody.rank
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/histories/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a patient history in API 2.0
      effect: read
      questions:
      - How do I retrieve a single patient history by ID in API 2.0?
      - Does a 2.0 history entry show when it was created?
      instructions:
      - text: Retrieve API 2.0 history {id}.
        slots:
          id: path.id
      - text: Get the type and text of 2.0 history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/histories/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a patient history in API 2.0
      effect: destructive
      questions:
      - How do I delete a patient history entry in the 2.0 API?
      - Can I remove a duplicated history item by its ID in API 2.0?
      instructions:
      - text: Delete API 2.0 history {id}.
        slots:
          id: path.id
      - text: Remove duplicated 2.0 history item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'