NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Practitioner Role API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-practitioner-role-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/PractitionerRole/{id}'].get
$.paths['/fhir/r4/PractitionerRole'].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 Practitioner Role API
  version: 1.0.0
extends: openapi/nextgen-healthcare-practitioner-role-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/PractitionerRole/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one practitioner role
      effect: read
      questions:
      - Can I fetch a single practitioner role by its role id?
      - What does one PractitionerRole record describe?
      instructions:
      - text: Get practitioner role {id}.
        slots:
          id: path.id
      - text: Show the specialty and organization on role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/PractitionerRole'].get
  update:
    x-apievangelist-phrasing:
      intent: List a practitioner's roles
      effect: read
      questions:
      - Which roles does a given practitioner hold?
      - How do I find the roles linked to one clinician?
      instructions:
      - text: List roles for practitioner {practitioner}.
        slots:
          practitioner: query.practitioner
      - text: Show where practitioner {practitioner} works and in what role.
        slots:
          practitioner: query.practitioner
      method: generated
      generated: '2026-10-01'