Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Insurance API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v3/insurance/search/payor'].get
$.paths['/v3/insurance/search/payor'].post
$.paths['/v3/insurance/search/diagnosis'].get
$.paths['/v3/insurance/validate_icd_codes'].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 Junction Insurance API
  version: 1.0.0
extends: openapi/vital-io-insurance-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: 4
- target: $.paths['/v3/insurance/search/payor'].get
  update:
    x-apievangelist-phrasing:
      intent: Search insurance payors by name
      effect: read
      questions:
      - How do I find the payor code for a patient's insurance company?
      - Can I look up a payor using a lab provider's own payor ID?
      instructions:
      - text: Search for insurance payors named {insurance_name}.
        slots:
          insurance_name: query.insurance_name
      - text: Find the payor with provider payor ID {provider_payor_id} at {provider}.
        slots:
          provider_payor_id: query.provider_payor_id
          provider: query.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/insurance/search/payor'].post
  update:
    x-apievangelist-phrasing:
      intent: Search payors with a POST request body
      effect: read
      questions:
      - Can I submit a payor lookup as a JSON body instead of query parameters?
      - Is there a body-based payor search that accepts a provider ID?
      instructions:
      - text: Post a payor search for {body_name} with provider ID {provider_id}.
        slots:
          body_name: requestBody.insurance_name
          provider_id: requestBody.provider_id
      - text: Run the POST payor lookup for insurer {body_name} under {body_provider}.
        slots:
          body_name: requestBody.insurance_name
          body_provider: requestBody.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/insurance/search/diagnosis'].get
  update:
    x-apievangelist-phrasing:
      intent: Search diagnoses by keyword
      effect: read
      questions:
      - What diagnosis code matches a condition like type 2 diabetes?
      - Can I search diagnoses by keyword to pick codes for a lab order?
      instructions:
      - text: Search diagnoses matching {diagnosis}.
        slots:
          diagnosis: query.diagnosis_query
      - text: Find diagnosis codes for {diagnosis}.
        slots:
          diagnosis: query.diagnosis_query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/insurance/validate_icd_codes'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a list of ICD codes
      effect: read
      questions:
      - Can I check whether a list of ICD codes is valid before placing an order?
      - Which of my ICD codes would come back as invalid?
      instructions:
      - text: Validate the ICD codes {codes}.
        slots:
          codes: requestBody.codes
      - text: Check whether {codes} are valid ICD codes.
        slots:
          codes: requestBody.codes
      method: generated
      generated: '2026-10-01'