NextGen Healthcare Group APIs API

The Group APIs API from NextGen Healthcare — 2 operation(s) for group apis.

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /bulkfhir/r4/Group Create a patient group for bulk export · Create Group #
Ask an LLM
“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?”
Tell an agent
Create a new Group named {name} containing patients {patientIds}.
Set up a new bulk export group for patient IDs {patientIds}.
GET /bulkfhir/r4/Group List all bulk FHIR patient groups · Retrieve all Groups #
Ask an LLM
“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?”
Tell an agent
List all of my bulk FHIR patient groups.
Show me every Group currently defined for bulk export.
PUT /bulkfhir/r4/Group/{id} Add or remove patients in an existing group · Update Group #
Ask an LLM
“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?”
Tell an agent
Add patients {patientIdsToInclude} to existing group {id}.
Remove patients {patientIdsToExclude} from group {id}.
DELETE /bulkfhir/r4/Group/{id} Delete a patient group · Delete Group #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete group {id}.
Remove the patient group {id} from the bulk data server.
GET /bulkfhir/r4/Group/{id} Retrieve one patient group · Retrieve Group #
Ask an LLM
“How can I look up the details of a single patient group by its ID?”
“Which patients are in a specific bulk FHIR group?”
Tell an agent
Get the details of group {id}.
Show me which patients belong to Group {id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nextgen-healthcare:nextgen-healthcare-group-apis-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nextgen-healthcare-group-apis-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: NextGen Office BulK FHIR Group APIs API
  description: 'Our API is coded against the US Core Specification (FHIR Version: 4.0.0)


    https://hl7.org/fhir/us/core/STU4/


    Note: This document is only for referring Bulk FHIR API.'
  contact:
    email: nextgen-office-api@nextgen.com
servers:
- url: https://fhir.meditouchehr.com/api/
  description: FHIR Base URL
tags:
- name: Group APIs
paths:
  /bulkfhir/r4/Group:
    post:
      security:
      - bearerAuth: []
      summary: Create Group
      operationId: createGroup
      tags:
      - Group APIs
      requestBody:
        description: Request body for create Group API
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBulkFhirPatientGroup'
      responses:
        '201':
          description: Group created successfully
        '403':
          description: Forbidden operation (e.g., maximum limit reached)
        '422':
          description: Unprocessable entity (e.g., invalid patient IDs)
        5XX:
          description: Unexpected error
    get:
      security:
      - bearerAuth: []
      summary: Retrieve all Groups
      operationId: getAllGroups
      tags:
      - Group APIs
      responses:
        '200':
          description: Groups retrieved successfully
        '403':
          description: Forbidden operation
        '404':
          description: No groups found
        5XX:
          description: Unexpected error
  /bulkfhir/r4/Group/{id}:
    put:
      security:
      - bearerAuth: []
      summary: Update Group
      operationId: updateGroup
      tags:
      - Group APIs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 09208d49-32ca-45f5-a595-b1df2412543d
      requestBody:
        description: Request body for create Group API
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBulkFhirPatientGroup'
      responses:
        '200':
          description: Group updated successfully
        '403':
          description: Forbidden operation
        '404':
          description: Group not found
        '422':
          description: Unprocessable entity (e.g., invalid patient IDs)
        5XX:
          description: Unexpected error
    delete:
      security:
      - bearerAuth: []
      summary: Delete Group
      operationId: deleteGroup
      tags:
      - Group APIs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 09208d49-32ca-45f5-a595-b1df2412543d
      responses:
        '200':
          description: Group deleted successfully
        '403':
          description: Forbidden operation
        '404':
          description: Group not found
        5XX:
          description: Unexpected error
    get:
      security:
      - bearerAuth: []
      summary: Retrieve Group
      operationId: getGroup
      tags:
      - Group APIs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 09208d49-32ca-45f5-a595-b1df2412543d
      responses:
        '200':
          description: Group retrieved successfully
        '401':
          description: Unauthorized operation
        '403':
          description: Forbidden operation
        '404':
          description: Group not found
        5XX:
          description: Unexpected error
components:
  schemas:
    UpdateBulkFhirPatientGroup:
      type: object
      required:
      - resourceType
      - id
      properties:
        resourceType:
          type: string
        id:
          type: string
        name:
          type: string
        patientIdsToInclude:
          type: array
          items:
            type: string
        patientIdsToExclude:
          type: array
          items:
            type: string
      example:
        resourceType: Group
        id: 09208d49-32ca-45f5-a595-b1df2412543d
        name: Diabetes Patients with age greater than 50
        patientIdsToInclude:
        - '123457'
        - '456789'
        patientIdsToExclude:
        - '878792'
        - '885904'
    CreateBulkFhirPatientGroup:
      type: object
      required:
      - resourceType
      - patientIds
      properties:
        resourceType:
          type: string
        name:
          type: string
        patientIds:
          type: array
          items:
            type: string
      example:
        resourceType: Group
        name: Diabetes Patients
        patientIds:
        - '878792'
        - '885904'
        - '966958'
        - '1008774'
        - '1023533'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Find out more about NextGen Office FHIR API
  url: https://www.nextgen.com/products-and-services/nextgen-office