# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NextGen Office BulK FHIR Group APIs API
  version: 1.0.0
extends: openapi/nextgen-healthcare-group-apis-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/bulkfhir/r4/Group'].get
  update:
    x-apievangelist-phrasing:
      intent: List all bulk FHIR patient groups
      effect: read
      questions:
      - Which patient groups have I already set up for bulk FHIR export in NextGen Office?
      - Can I see every Group resource defined on my bulk data server?
      instructions:
      - text: List all of my bulk FHIR patient groups.
      - text: Show me every Group currently defined for bulk export.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/Group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a patient group for bulk export
      effect: write
      questions:
      - How do I define a new group of patients to run a bulk FHIR export against?
      - What do I need to supply to create a Group from a list of patient IDs?
      instructions:
      - text: Create a new Group named {name} containing patients {patientIds}.
        slots:
          name: requestBody.name
          patientIds: requestBody.patientIds
      - text: Set up a new bulk export group for patient IDs {patientIds}.
        slots:
          patientIds: requestBody.patientIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/Group/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one patient group
      effect: read
      questions:
      - How can I look up the details of a single patient group by its ID?
      - Which patients are in a specific bulk FHIR group?
      instructions:
      - text: Get the details of group {id}.
        slots:
          id: path.id
      - text: Show me which patients belong to Group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/Group/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or remove patients in an existing group
      effect: write
      questions:
      - Can I add patients to a group I already created without rebuilding it?
      - How do I drop certain patients from an existing bulk export group?
      - Is it possible to rename an existing patient group?
      instructions:
      - text: Add patients {patientIdsToInclude} to existing group {id}.
        slots:
          patientIdsToInclude: requestBody.patientIdsToInclude
          id: path.id
      - text: Remove patients {patientIdsToExclude} from group {id}.
        slots:
          patientIdsToExclude: requestBody.patientIdsToExclude
          id: path.id
      - text: Rename existing group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/Group/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a patient group
      effect: destructive
      questions:
      - How do I permanently remove a patient group I no longer export?
      - What happens if I delete a bulk FHIR group I no longer need?
      instructions:
      - text: Delete group {id}.
        slots:
          id: path.id
      - text: Remove the patient group {id} from the bulk data server.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'