Flexpa · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flexpa FHIR API

9 actions 9 updates phrasing extends openapi/flexpa-fhir-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Flexpa's API. It is a proposal applied on top of the contract, not a document Flexpa publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/fhir/metadata'].get
$.paths['/fhir/Patient'].get
$.paths['/fhir/Patient/{id}'].get
$.paths['/fhir/Coverage'].get
$.paths['/fhir/Coverage/{id}'].get
$.paths['/fhir/Practitioner'].get
$.paths['/fhir/Organization'].get
$.paths['/fhir/ViewDefinition/$run'].post

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 Flexpa FHIR API
  version: 1.0.0
extends: openapi/flexpa-fhir-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: 8
- target: $.paths['/fhir/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which FHIR resources the server supports
      effect: read
      questions:
      - Which FHIR resources and operations does the Flexpa server support?
      - Where can I find the CapabilityStatement for this FHIR endpoint?
      instructions:
      - text: Fetch the FHIR CapabilityStatement.
      - text: Show me the supported resources and operations listed in the server metadata.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Patient'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patients by identifier
      effect: read
      questions:
      - Can I find a Patient resource using an identifier such as a member ID?
      - Which patients does my access token let me see?
      instructions:
      - text: Search for patients with identifier {identifier}.
        slots:
          identifier: query.identifier
      - text: List the Patient resources available to my token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Patient/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a patient's demographic record
      effect: read
      questions:
      - How do I read one patient's demographics once I have their Patient ID?
      - What name, birth date and contact details are on a specific Patient resource?
      instructions:
      - text: Read Patient {id}.
        slots:
          id: path.id
      - text: Show the demographic record for patient {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Coverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a patient's insurance coverage
      effect: read
      questions:
      - Which health insurance plans cover a given patient?
      - Can I filter a patient's coverage to only active policies?
      instructions:
      - text: List insurance coverage for patient {patient}.
        slots:
          patient: query.patient
      - text: Find coverage for patient {patient} with status {status}.
        slots:
          patient: query.patient
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Coverage/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one insurance coverage record
      effect: read
      questions:
      - What plan, payer and period does one specific Coverage resource describe?
      - Can I fetch a single coverage record by its FHIR ID?
      instructions:
      - text: Read Coverage {id}.
        slots:
          id: path.id
      - text: Show the details of insurance coverage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Practitioner'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up individual healthcare providers
      effect: read
      questions:
      - Can I look up an individual doctor by NPI number?
      - How do I find clinicians by name or specialty?
      instructions:
      - text: Search individual practitioners by name or specialty.
      - text: Find the clinician registered under a given NPI.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Organization'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up healthcare organizations
      effect: read
      questions:
      - Can I find hospitals or clinics by organizational NPI?
      - What healthcare organizations are located near a given city?
      instructions:
      - text: Search healthcare organizations by name.
      - text: Find hospitals and clinics in a given location.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/ViewDefinition/$run'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract tabular data with a ViewDefinition
      effect: read
      questions:
      - Can I flatten FHIR resources into rows and columns using a SQL-on-FHIR ViewDefinition?
      - What's the way to pull claims or coverage data into a table for analytics?
      instructions:
      - text: Run a SQL-on-FHIR ViewDefinition to extract tabular data.
      - text: Flatten FHIR records into a table using my ViewDefinition.
      method: generated
      generated: '2026-10-01'