NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR CCDA API

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

$.info

$.paths['/ccda'].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 CCDA API
  version: 1.0.0
extends: openapi/nextgen-healthcare-ccda-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: 1
- target: $.paths['/ccda'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a patient's record as a C-CDA document
      effect: read
      questions:
      - How do I get a patient's summary as a C-CDA document?
      - Can I pull a CCDA continuity of care document for just a date range?
      instructions:
      - text: Export patient {patient}'s record in CCDA format.
        slots:
          patient: query.patient
      - text: Generate a C-CDA document for patient {patient} covering {date}.
        slots:
          patient: query.patient
          date: query.date
      method: generated
      generated: '2026-10-01'