Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NextGen Office Bulk FHIR R4 API

Bulk FHIR (Flat FHIR) R4 API for the NextGen Office EHR, 21st Century Cures compliant, enabling authorized vendors to export USCDIv1 data for multiple patients. A downloadable OpenAPI 3.0.0 definition (5 paths) is published.

NextGen Office Bulk FHIR R4 API is one of 5 APIs that NextGen Healthcare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FHIR, Bulk FHIR, and EHR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, organized into 3 resource areas, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://fhir.meditouchehr.com/api/.

9 operations 5 paths 3 schemas 2 DELETE5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://fhir.meditouchehr.com/api/bulkfhir/r4
Authentication
HTTP Bearer
Resource Areas
3

Authentication & Security 1

NextGen Office Bulk FHIR R4 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 5 GET, 1 POST, 1 PUT. They span 3 resource areas: Patient Search, Group APIs, Export APIs. Each is listed below with its method, path, parameters, and response codes.

Patient Search 1
GET
/bulkfhir/r4/$patient-search
Search Patients
searchPatients 3 params → 2004004014034045XX
Group APIs 5
POST
/bulkfhir/r4/Group
Create Group
createGroup body → 2014034225XX
GET
/bulkfhir/r4/Group
Retrieve all Groups
getAllGroups → 2004034045XX
PUT
/bulkfhir/r4/Group/{id}
Update Group
updateGroup 1 param body → 2004034044225XX
DELETE
/bulkfhir/r4/Group/{id}
Delete Group
deleteGroup 1 param → 2004034045XX
GET
/bulkfhir/r4/Group/{id}
Retrieve Group
getGroup 1 param → 2004014034045XX
Export APIs 3
GET
/bulkfhir/r4/Group/{id}/$export
Group Export
groupExport 2 params → 2024044014295XX
GET
/bulkfhir/r4/$export-poll-status
Poll Job Status
pollJobStatus 1 param → 2002024044015XX
DELETE
/bulkfhir/r4/$export-poll-status
Delete Job
deleteJob 1 param → 2024044015XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BulkDataStatusResponse (5 properties), UpdateBulkFhirPatientGroup (5 properties), CreateBulkFhirPatientGroup (3 properties). Each schema is shown below with its type and property counts.

CreateBulkFhirPatientGroup
object
3 properties 2 required
UpdateBulkFhirPatientGroup
object
5 properties 2 required
BulkDataStatusResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nextgen-office-bulk-fhir-r4-openapi.yml Raw ↑

Other APIs NextGen Healthcare publishes across the network.

NextGen Enterprise Patient Access FHIR API
NextGen Enterprise API
NextGen Office FHIR R4 API
NextGen Office FHIR R3 API