# 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 Problems API
  version: 1.0.0
extends: openapi/elation-health-problems-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['/problems/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's problems (legacy endpoint)
      effect: read
      questions:
      - Can I see a patient's problem list through the older problems lookup?
      - What diagnoses are on this patient's chart, via the legacy endpoint?
      instructions:
      - text: Using the legacy lookup, find problems for patient {patient}.
        slots:
          patient: path.patient
      - text: Show the old-path problem list of patient {patient}.
        slots:
          patient: path.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a problem to a chart (legacy endpoint)
      effect: write
      questions:
      - How do I add a diagnosis to a patient's problem list with the legacy endpoint?
      - Can I set a start date and rank when adding a problem the old way?
      instructions:
      - text: Via the legacy endpoint, add problem {dx} with status {status} for patient {patient} at practice {practice}.
        slots:
          dx: requestBody.dx
          status: requestBody.status
          patient: requestBody.patient
          practice: requestBody.practice
      - text: Create an old-path problem for patient {patient} described as {description}, starting {start_date}.
        slots:
          patient: requestBody.patient
          description: requestBody.description
          start_date: requestBody.start_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a problem (legacy endpoint)
      effect: read
      questions:
      - Can I read one problem entry on the legacy problems path?
      - Does the older get-problem call show when a condition was resolved?
      instructions:
      - text: Open problem {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the synopsis of old-path problem {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a problem (legacy PUT)
      effect: write
      questions:
      - How do I replace all fields of a problem on the unversioned path?
      - Can the legacy full update record a resolved date on a condition?
      instructions:
      - text: 'With the legacy PUT, replace problem {id} for patient {patient}: {description}, status {status}, started {start_date}.'
        slots:
          id: path.id
          patient: requestBody.patient
          description: requestBody.description
          status: requestBody.status
          start_date: requestBody.start_date
      - text: Rewrite old-path problem {id} with resolved date {resolved_date}.
        slots:
          id: path.id
          resolved_date: requestBody.resolved_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a problem (legacy endpoint)
      effect: destructive
      questions:
      - Is there a legacy call to remove a problem added in error?
      - Can I delete a diagnosis from the problem list on the original path?
      instructions:
      - text: Delete problem {id} with the legacy endpoint.
        slots:
          id: path.id
      - text: Remove the erroneous old-path problem {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a problem (legacy PATCH)
      effect: write
      questions:
      - Can I mark a problem resolved with the legacy PATCH?
      - What's the older way to change just a problem's rank?
      instructions:
      - text: Using the legacy PATCH, set problem {id} to status {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Patch old-path problem {id} with rank {rank}.
        slots:
          id: path.id
          rank: requestBody.rank
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/'].get
  update:
    x-apievangelist-phrasing:
      intent: List problems in API 2.0
      effect: read
      questions:
      - How do I list problems added within a date range in the 2.0 API?
      - Can API 2.0 return only active problems for a patient?
      - Is the 2.0 problem list filterable by practice?
      instructions:
      - text: List 2.0 problems for patient {patient} with status {status}.
        slots:
          patient: query.patient
          status: query.status
      - text: List API 2.0 problems created between {created_date__gte} and {created_date__lte}.
        slots:
          created_date__gte: query.created_date__gte
          created_date__lte: query.created_date__lte
      - text: List 2.0 problems for practice {practice} ordered by {order_by}.
        slots:
          practice: query.practice
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a problem in API 2.0
      effect: write
      questions:
      - How do I add a problem to a patient's chart with the 2.0 API?
      - Can I set a verification status on a new problem?
      instructions:
      - text: In API 2.0, add problem {description} with diagnosis {dx}, status {status}, starting {start_date}, for patient {patient}.
        slots:
          description: requestBody.description
          dx: requestBody.dx
          status: requestBody.status
          start_date: requestBody.start_date
          patient: requestBody.patient
      - text: Create a 2.0 problem for patient {patient} with verification status {verification_status}.
        slots:
          patient: requestBody.patient
          verification_status: requestBody.verification_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a problem in API 2.0
      effect: read
      questions:
      - How do I retrieve one problem by ID in API 2.0?
      - Does a 2.0 problem include its diagnosis codes?
      instructions:
      - text: Retrieve API 2.0 problem {id}.
        slots:
          id: path.id
      - text: Get the diagnosis and status of 2.0 problem {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a problem in API 2.0
      effect: write
      questions:
      - Can I replace an entire problem record with a 2.0 PUT?
      - What must I resend to fully replace a problem in API 2.0?
      instructions:
      - text: 'Replace 2.0 problem {id}: {description}, diagnosis {dx}, status {status}, started {start_date}, patient {patient}.'
        slots:
          id: path.id
          description: requestBody.description
          dx: requestBody.dx
          status: requestBody.status
          start_date: requestBody.start_date
          patient: requestBody.patient
      - text: Overwrite API 2.0 problem {id} with synopsis {synopsis}.
        slots:
          id: path.id
          synopsis: requestBody.synopsis
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a problem in API 2.0
      effect: destructive
      questions:
      - How do I delete a problem with the 2.0 API?
      - Can I remove a duplicate diagnosis from the chart in API 2.0?
      instructions:
      - text: Delete API 2.0 problem {id}.
        slots:
          id: path.id
      - text: Remove duplicate 2.0 problem {id} from the chart.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/problems/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a problem in API 2.0
      effect: write
      questions:
      - Can I resolve a problem by setting only its resolved date in API 2.0?
      - Is there a 2.0 PATCH to change a problem's verification status?
      instructions:
      - text: Patch 2.0 problem {id} with resolved date {resolved_date}.
        slots:
          id: path.id
          resolved_date: requestBody.resolved_date
      - text: Partially update API 2.0 problem {id} to verification status {verification_status}.
        slots:
          id: path.id
          verification_status: requestBody.verification_status
      method: generated
      generated: '2026-09-26'