NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Document Reference API

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

$.paths['/fhir/r4/DocumentReference'].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 Document Reference API
  version: 1.0.0
extends: openapi/nextgen-healthcare-document-reference-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/DocumentReference/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one clinical document reference
      effect: read
      questions:
      - Can I fetch one clinical note's document reference by id?
      - What metadata comes back for a single DocumentReference?
      instructions:
      - text: Get document reference {id}.
        slots:
          id: path.id
      - text: Show the metadata for clinical document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/DocumentReference'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's clinical documents
      effect: read
      questions:
      - How do I list a patient's discharge summaries and progress notes?
      - Can I filter a patient's documents by type, date or status?
      - Is only the clinical-note category supported when searching documents?
      instructions:
      - text: List clinical documents for patient {patient}.
        slots:
          patient: query.patient
      - text: Find patient {patient}'s documents of type {type} created {date}.
        slots:
          patient: query.patient
          type: query.type
          date: query.date
      - text: Show patient {patient}'s documents with status {status}.
        slots:
          patient: query.patient
          status: query.status
      method: generated
      generated: '2026-10-01'