NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office BulK FHIR Patient Search API

2 actions 2 updates phrasing extends openapi/nextgen-healthcare-patient-search-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/bulkfhir/r4/$patient-search'].get

OpenAPI Overlay

# 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 Patient Search API
  version: 1.0.0
extends: openapi/nextgen-healthcare-patient-search-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: 1
- target: $.paths['/bulkfhir/r4/$patient-search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patients for bulk FHIR access
      effect: read
      questions:
      - How do I find a patient by chart number in NextGen Office bulk FHIR?
      - Can I search for patients who had an encounter on a particular date?
      - Are patient search results paged?
      instructions:
      - text: Find the patient with chart number {patientChartNo}.
        slots:
          patientChartNo: query.patientChartNo
      - text: Search for patients with an encounter on {encDate}.
        slots:
          encDate: query.encDate
      - text: Show page {page} of patients seen on {encDate}.
        slots:
          page: query.page
          encDate: query.encDate
      method: generated
      generated: '2026-10-01'