Flexpa · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flexpa Claims Data API

6 actions 6 updates phrasing extends openapi/flexpa-claims-data-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 6

$.info
$.paths['/fhir/Patient/{id}/$everything'].get
$.paths['/fhir/Patient/{id}/$summary'].get
$.paths['/fhir/Patient/{id}/$pdf'].get
$.paths['/fhir/ExplanationOfBenefit'].get
$.paths['/fhir/ExplanationOfBenefit/{id}'].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 Flexpa Claims Data API
  version: 1.0.0
extends: openapi/flexpa-claims-data-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: 5
- target: $.paths['/fhir/Patient/{id}/$everything'].get
  update:
    x-apievangelist-phrasing:
      intent: Get every record for a patient
      effect: read
      questions:
      - Can I pull every resource in a patient's compartment in a single call instead of searching each type?
      - What's the fastest way to fetch all claims, coverage and clinical data Flexpa holds for one patient?
      instructions:
      - text: Fetch everything in the patient compartment for patient {id}.
        slots:
          id: path.id
      - text: Pull all available records for patient {id} in one bundle.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Patient/{id}/$summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate an International Patient Summary
      effect: read
      questions:
      - Can I generate an International Patient Summary (IPS) document for a connected patient?
      - Is there a way to get a condensed IPS summary of a patient's health record rather than every resource?
      instructions:
      - text: Generate an International Patient Summary for patient {id}.
        slots:
          id: path.id
      - text: Build the IPS document for patient {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/Patient/{id}/$pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a patient's health data as a PDF
      effect: read
      questions:
      - Can I export a patient's health data as a printable PDF?
      - Is there a PDF version of a patient's comprehensive health record I can hand to a clinician?
      instructions:
      - text: Export patient {id}'s health data as a PDF.
        slots:
          id: path.id
      - text: Download a PDF report of patient {id}'s full health record.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/ExplanationOfBenefit'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a patient's insurance claims
      effect: read
      questions:
      - How do I list a patient's health insurance claims as ExplanationOfBenefit resources?
      - Can I filter claims by the date they were created, the treating provider, or their status?
      - Which claims were billed under a particular coverage?
      instructions:
      - text: List insurance claims for patient {patient}.
        slots:
          patient: query.patient
      - text: Find claims for patient {patient} created {created} with status {status}.
        slots:
          patient: query.patient
          created: query.created
          status: query.status
      - text: Search claims from provider {provider} under coverage {coverage}.
        slots:
          provider: query.provider
          coverage: query.coverage
      - text: Look up the claim with identifier {identifier}.
        slots:
          identifier: query.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fhir/ExplanationOfBenefit/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one insurance claim
      effect: read
      questions:
      - Can I open a single ExplanationOfBenefit by its resource ID to see the full claim detail?
      - What does one specific claim look like once I already have its FHIR ID?
      instructions:
      - text: Read ExplanationOfBenefit {id}.
        slots:
          id: path.id
      - text: Show me the full detail of claim resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'