Vim · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Vim Data Source API Integration

3 actions 3 updates update extends openapi/vim-data-source-openapi-original.json

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-consequencex-apievangelist-providerx-apievangelist-surfacex-apievangelist-authx-apievangelist-error-envelopex-apievangelist-fhir

Targets 3

$.info

$.paths['/patient/identify'].post

$.paths['/insights/feedback'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Vim Data Source API Integration
  version: 1.0.0
extends: openapi/vim-data-source-openapi-original.json
actions:
  - target: $.info
    update:
      x-apievangelist-provider: vim
      x-apievangelist-surface: data-source
      x-apievangelist-auth: oauth2-client-credentials (bearer JWT via POST /oauth/token)
      x-apievangelist-error-envelope: "{ code, reason } (not RFC 9457)"
      x-apievangelist-fhir: false
  - target: $.paths['/patient/identify'].post
    update:
      x-apievangelist-consequence: reads PHI; returns stable patient_id + eligibility
  - target: $.paths['/insights/feedback'].post
    update:
      x-apievangelist-consequence: write; records clinician action (AGREE/DISMISS) on a gap/insight
x-notes: >-
  Non-destructive overlay capturing API Evangelist annotations. The original
  spec at openapi/vim-data-source-openapi-original.json is never mutated.