NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Device API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-device-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/Device/{id}'].get
$.paths['/fhir/r4/Device'].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 Device API
  version: 1.0.0
extends: openapi/nextgen-healthcare-device-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/Device/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one implantable device
      effect: read
      questions:
      - Can I get one implanted device record by id?
      - Does a single Device record include the unique device identifier?
      instructions:
      - text: Get implantable device {id}.
        slots:
          id: path.id
      - text: Show the UDI for device {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/Device'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's implantable devices
      effect: read
      questions:
      - Which implanted devices does a patient have?
      - Can I limit a patient's implant list by date?
      instructions:
      - text: List implantable devices for patient {patient}.
        slots:
          patient: query.patient
      - text: Show devices implanted in patient {patient} as of {date}.
        slots:
          patient: query.patient
          date: query.date
      method: generated
      generated: '2026-10-01'