NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Patient API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-patient-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 3

$.info
$.paths['/fhir/r4/Patient/{id}'].get
$.paths['/fhir/r4/Patient'].get

OpenAPI Overlay

Raw ↑
# 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 FHIR Patient API
  version: 1.0.0
extends: openapi/nextgen-healthcare-patient-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: 2
- target: $.paths['/fhir/r4/Patient/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one patient's demographics
      effect: read
      questions:
      - How do I pull a patient's demographics if I know their patient id?
      - Does a single Patient record include previous names and suffix?
      instructions:
      - text: Get patient {id}.
        slots:
          id: path.id
      - text: Show the name, birth date and contact details for patient {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/Patient'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for patients
      effect: read
      questions:
      - How do I find a patient by name and date of birth?
      - Can I look a patient up by an identifier like a medical record number?
      - Which gender values can I search patients by?
      instructions:
      - text: Find patients named {name} born on {birthdate}.
        slots:
          name: query.name
          birthdate: query.birthdate
      - text: Search for the patient with identifier {identifier}.
        slots:
          identifier: query.identifier
      - text: Find {gender} patients named {name}.
        slots:
          gender: query.gender
          name: query.name
      method: generated
      generated: '2026-10-01'