# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Care Gaps Caregaps API
  version: 1.0.0
extends: openapi/elation-health-caregaps-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: 5
- target: $.paths['/caregaps/api/{quality_program}/caregap/'].get
  update:
    x-apievangelist-phrasing:
      intent: List care gaps in a quality program
      effect: read
      questions:
      - Which patients have open care gaps in a quality program?
      - Can I filter care gaps by status or the date they were closed?
      - How do I page through care gaps with a cursor?
      instructions:
      - text: List care gaps in quality program {quality_program}.
        slots:
          quality_program: path.quality_program
      - text: List care gaps in {quality_program} for patient {patient_id} with status {status}.
        slots:
          quality_program: path.quality_program
          patient_id: query.patient_id
          status: query.status
      - text: List gaps in {quality_program} closed between {closed_date_begin} and {closed_date_end}.
        slots:
          quality_program: path.quality_program
          closed_date_begin: query.closed_date_begin
          closed_date_end: query.closed_date_end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caregaps/api/{quality_program}/caregap/'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a care gap for a patient
      effect: write
      questions:
      - How do I open a new care gap for a patient under a quality measure?
      - What do I need to create a care gap in Elation?
      instructions:
      - text: Create a care gap in {quality_program} for patient {patient_id}, practice {practice_id}, definition {definition_id}, {status}, {created_date}.
        slots:
          quality_program: path.quality_program
          patient_id: requestBody.patient_id
          practice_id: requestBody.practice_id
          definition_id: requestBody.definition_id
          status: requestBody.status
          created_date: requestBody.created_date
      - text: Open gap {definition_id} in {quality_program} for {patient_id}, practice {practice_id}, {status}, {created_date}, detail {detail}.
        slots:
          definition_id: requestBody.definition_id
          quality_program: path.quality_program
          patient_id: requestBody.patient_id
          practice_id: requestBody.practice_id
          status: requestBody.status
          created_date: requestBody.created_date
          detail: requestBody.detail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caregaps/api/{quality_program}/caregap/{caregap_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one care gap
      effect: read
      questions:
      - Can I look up the details of a specific care gap?
      - Who closed a particular care gap and when?
      instructions:
      - text: Get care gap {caregap_id} in quality program {quality_program}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
      - text: Show care gap {caregap_id} from {quality_program} for practice {practice_id}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
          practice_id: query.practice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caregaps/api/{quality_program}/caregap/{caregap_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a care gap
      effect: destructive
      questions:
      - How do I delete a care gap that was opened in error?
      - Can I remove a care gap from a quality program entirely?
      instructions:
      - text: Delete care gap {caregap_id} in {quality_program}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
      - text: Remove erroneous gap {caregap_id} from program {quality_program} for practice {practice_id}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
          practice_id: query.practice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caregaps/api/{quality_program}/caregap/{caregap_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Close or reopen a care gap
      effect: write
      questions:
      - How do I mark a care gap as closed once the patient gets the screening?
      - Can I change a care gap's closed status?
      instructions:
      - text: Set care gap {caregap_id} in {quality_program} to status {status}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
          status: requestBody.status
      - text: Close care gap {caregap_id} in program {quality_program} by setting {status}.
        slots:
          caregap_id: path.caregap_id
          quality_program: path.quality_program
          status: requestBody.status
      method: generated
      generated: '2026-09-26'