NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Related Person API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-relatedperson-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/RelatedPerson/{id}'].get
$.paths['/fhir/r4/RelatedPerson'].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 Related Person API
  version: 1.0.0
extends: openapi/nextgen-healthcare-relatedperson-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/RelatedPerson/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one related person
      effect: read
      questions:
      - Can I fetch one patient contact or relative by its id?
      - What does a single RelatedPerson record include?
      instructions:
      - text: Get related person {id}.
        slots:
          id: path.id
      - text: Show the relationship and contact details for related person {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/RelatedPerson'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's related persons
      effect: read
      questions:
      - Who are a patient's family members or caregivers on file?
      - How do I list the related people for a patient?
      instructions:
      - text: List related persons for patient {patient}.
        slots:
          patient: query.patient
      - text: Show patient {patient}'s family contacts and caregivers.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-10-01'