NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Allergy Intolerance API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-allergy-intolerance-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/AllergyIntolerance/{id}'].get

$.paths['/fhir/r4/AllergyIntolerance'].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 FHIR Allergy Intolerance API
  version: 1.0.0
extends: openapi/nextgen-healthcare-allergy-intolerance-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/AllergyIntolerance/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one allergy or intolerance record
      effect: read
      questions:
      - Can I pull a single allergy record if I already have its FHIR id?
      - What does one AllergyIntolerance entry include, like the substance and the reaction?
      instructions:
      - text: Get allergy record {id}.
        slots:
          id: path.id
      - text: Show the substance and reaction recorded on allergy entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/AllergyIntolerance'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's allergies and intolerances
      effect: read
      questions:
      - How do I see every allergy a patient has on file in NextGen?
      - Are a patient's allergy codes returned as RxNorm codes?
      - Can I limit a patient's allergy list to entries recorded in a date range?
      instructions:
      - text: List all allergies and intolerances for patient {patient}.
        slots:
          patient: query.patient
      - text: Show allergies recorded for patient {patient} on or after {date}.
        slots:
          patient: query.patient
          date: query.date
      method: generated
      generated: '2026-10-01'