Generated by API Evangelist
Written by API Evangelist tooling for NextGen Healthcare's API. It is a proposal applied on top of the contract, not a document NextGen Healthcare publishes.
# 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 Export APIs API
version: 1.0.0
extends: openapi/nextgen-healthcare-export-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: 3
- target: $.paths['/bulkfhir/r4/Group/{id}/$export'].get
update:
x-apievangelist-phrasing:
intent: Start a bulk FHIR export for a patient group
effect: read
questions:
- How do I export all FHIR data for every patient in a group from NextGen Office?
- Can I pull a full set of FHIR resources across resource types for a patient group in one request?
instructions:
- text: Kick off a bulk FHIR export for group {id}.
slots:
id: path.id
- text: Export all FHIR resources for the patients in group {id} asynchronously.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/$export-poll-status'].get
update:
x-apievangelist-phrasing:
intent: Check the status of a bulk export job
effect: read
questions:
- Is my bulk data export finished yet?
- How can I check progress on an export job I already started?
instructions:
- text: Check the status of export job {_jobId}.
slots:
_jobId: query._jobId
- text: Poll bulk export job {_jobId} and tell me if the files are ready.
slots:
_jobId: query._jobId
method: generated
generated: '2026-10-01'
- target: $.paths['/bulkfhir/r4/$export-poll-status'].delete
update:
x-apievangelist-phrasing:
intent: Cancel a running bulk export job
effect: destructive
questions:
- Can I cancel a bulk FHIR export that is still running?
- How do I stop an export job I started by mistake?
instructions:
- text: Cancel export job {_jobId}.
slots:
_jobId: query._jobId
- text: Abort the in-progress bulk data request {_jobId}.
slots:
_jobId: query._jobId
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.