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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.