NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Diagnostic Report API

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

$.paths['/fhir/r4/DiagnosticReport'].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 Diagnostic Report API
  version: 1.0.0
extends: openapi/nextgen-healthcare-diagnosticreport-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/DiagnosticReport/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one lab or imaging report
      effect: read
      questions:
      - Can I open a single lab or radiology report by its id?
      - Does one DiagnosticReport include its observations and narrative?
      instructions:
      - text: Get diagnostic report {id}.
        slots:
          id: path.id
      - text: Show the results and narrative in lab report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/DiagnosticReport'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's lab and imaging reports
      effect: read
      questions:
      - Where do I find all of a patient's lab and radiology results?
      - Can I filter a patient's reports to just laboratory or just imaging?
      - Is it possible to search a patient's reports by report code?
      instructions:
      - text: List diagnostic reports for patient {patient}.
        slots:
          patient: query.patient
      - text: Show patient {patient}'s reports in category {category} from {date}.
        slots:
          patient: query.patient
          category: query.category
          date: query.date
      - text: Find patient {patient}'s reports with code {code}.
        slots:
          patient: query.patient
          code: query.code
      method: generated
      generated: '2026-10-01'