NextGen Healthcare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NextGen Office FHIR Observation API

3 actions 3 updates phrasing extends openapi/nextgen-healthcare-observation-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/Observation/{id}'].get
$.paths['/fhir/r4/Observation'].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 Observation API
  version: 1.0.0
extends: openapi/nextgen-healthcare-observation-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/Observation/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one observation
      effect: read
      questions:
      - Can I fetch a single vital sign or lab value by its observation id?
      - What does one Observation record contain, like a blood pressure reading?
      instructions:
      - text: Get observation {id}.
        slots:
          id: path.id
      - text: Show the value recorded in observation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/r4/Observation'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's observations and vitals
      effect: read
      questions:
      - How do I get a patient's vital signs and lab values?
      - Can I filter a patient's observations by LOINC code or category?
      - Can I get a patient's observations for a specific date?
      instructions:
      - text: List observations for patient {patient}.
        slots:
          patient: query.patient
      - text: Show patient {patient}'s observations in category {category}.
        slots:
          patient: query.patient
          category: query.category
      - text: Find patient {patient}'s observations with LOINC code {code} on {date}.
        slots:
          patient: query.patient
          code: query.code
          date: query.date
      method: generated
      generated: '2026-10-01'