NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Immunization API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-immunization-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/Immunization/{id}'].get
$.paths['/fhir/r4/Immunization'].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 Immunization API
  version: 1.0.0
extends: openapi/nextgen-healthcare-immunization-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/Immunization/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one immunization record
      effect: read
      questions:
      - Can I fetch a single vaccination record by id?
      - What does one Immunization entry tell me about a shot given?
      instructions:
      - text: Get immunization {id}.
        slots:
          id: path.id
      - text: Show the vaccine given in immunization record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/Immunization'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's immunizations
      effect: read
      questions:
      - Which vaccines has a patient received?
      - Are a patient's immunizations returned with CVX codes?
      - Can I limit a patient's vaccination history to a date range?
      instructions:
      - text: List immunizations for patient {patient}.
        slots:
          patient: query.patient
      - text: Show vaccines given to patient {patient} on or after {date}.
        slots:
          patient: query.patient
          date: query.date
      method: generated
      generated: '2026-10-01'