How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vim Data Source

Ingestion surface for pushing patient-specific clinical insights and gaps (Diagnosis Gaps, Risk, Quality, Social Determinants of Health) into Vim for surfacing at the point of care, via either API or file-based connections. Requires a stable unique patient ID and a stable unique identifier per insight/gap.

Vim Data Source is one of 6 APIs that Vim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Care Gaps, Clinical Data, and Data Ingestion. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 4 operations across 4 paths, organized into 4 resource areas, and defines 15 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{environment}-{customerName}.com.

4 operations 4 paths 15 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Server
https://{environment}-{customerName}.com
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
4

Authentication & Security 2

Vim Data Source declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (service) using the implicit flow. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication token obtained from the /oauth/token endpoint

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. They span 4 resource areas: Access Token Retrieval, Patient Identification, Get Patient Care Insights, Patient Care Insights Feedback. Each is listed below with its method, path, parameters, and response codes.

Access Token Retrieval 1

Obtaining a Bearer service token to make API requests

POST
/oauth/token
Authenticate and Retrieve an Access Token
post-oauth-token body → 200400401500
Patient Identification 1

Identify the patient based on personal information

POST
/patient/identify
Identify an Eligible Patient
post-patient-identify 2 params body → 200400401403404500
Get Patient Care Insights 1

Retrieving patient care insights such as diagnosis gaps and care insights

POST
/insights/fetch
Fetching Patient Care Insights
post-insights-fetch 2 params body → 200400401403404500
Patient Care Insights Feedback 1

Sending feedback about the care insights

POST
/insights/feedback
Sending feedback about the insight
post-insights-feedback 2 params body → 200400401403404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DiagnosisGap (15 properties), Insight (14 properties), PatientDetails (8 properties), GapDetails (7 properties). Each schema is shown below with its type and property counts.

AuthTokenRequest
object
Authentication request
3 properties 3 required
AuthTokenResponse
object
3 properties 3 required
PatientDetails
object
Patient identification details
8 properties 3 required
IdentifyPatientResponse
object
Response from patient identification
2 properties 2 required
Patient
object
Patient identifier
1 property 1 required
GapDetails
object
7 properties 2 required
Insights
array
DiagnosisGaps
array
FeedbackRequest
object
Base feedback request with common fields
7 properties 5 required
DiagnosisGapFeedback
object
InsightFeedback
object
FeedbackResponse
object
1 property 1 required
DiagnosisGap
object
15 properties 4 required
Insight
object
14 properties 4 required
ErrorResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vim-data-source-openapi-original.json Raw ↑

Other APIs Vim publishes across the network.

Vim Canvas SDK (VimOS.js)
Vim Applications & Organizations API
Vim Invitations API
Vim Appointments API
Vim Chart Retrieval API
Where this information came from

This is an independent, third-party profile of Vim Data Source, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.