NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Care Team API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-careteam-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/CareTeam/{id}'].get
$.paths['/fhir/r4/CareTeam'].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 Care Team API
  version: 1.0.0
extends: openapi/nextgen-healthcare-careteam-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/CareTeam/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one care team member record
      effect: read
      questions:
      - Can I look up one care team entry directly by its id?
      - What details does a single CareTeam record give me?
      instructions:
      - text: Get care team record {id}.
        slots:
          id: path.id
      - text: Show who is on care team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/CareTeam'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a patient's care team
      effect: read
      questions:
      - Who is on a patient's care team?
      - Can I only see the active members of a patient's care team?
      - Can I search care teams by care team id instead of by patient?
      instructions:
      - text: List the care team for patient {patient}.
        slots:
          patient: query.patient
      - text: Show care team members with status {status} for patient {patient}.
        slots:
          status: query.status
          patient: query.patient
      - text: Search care teams matching care team id {_id}.
        slots:
          _id: query._id
      method: generated
      generated: '2026-10-01'