Vim

Vim is a United States healthcare technology company (getvim.com) that operates a clinical workflow and point-of-care integration platform connecting health plans, provider organizations, and digital-health applications to physicians inside their existing electronic health records. Through the Vim Canvas developer platform and the VimOS.js JavaScript SDK, applications embed actionable clinical insights - diagnosis gaps, risk, quality, and social determinants of health - directly into supported ambulatory EHR workflows and can read and write EHR resources (Patient, Encounter, Orders, Referral, Claim) at the point of care. Vim also exposes a REST API at api.getvim.com/v1 for provisioning applications, organizations, invitations, appointment lookups, and chart retrieval, authenticated with OAuth 2.0 client credentials via an Auth0-backed authorization server (auth.getvim.com). Vim is HIPAA, SOC 2, and HITRUST certified. The platform is proprietary REST and SDK based; it is not an HL7 FHIR API and publishes no FHIR CapabilityStatement. The API is available only to application servers hosted within the United States.

Vim publishes 5 APIs on the APIs.io network, including Applications & Organizations API, Invitations API, Appointments API, and 2 more. Tagged areas include Healthcare, United States, Clinical AI, EHR Integration, and Point of Care.

The Vim catalog on APIs.io includes 1 event-driven AsyncAPI specification.

Vim’s developer surface includes changelog, sandbox, authentication, documentation, API reference, getting-started guide, support, and 39 more developer resources.

🌐 Visit website 📡 Source on GitHub
62.5/100 strong ▲ 14.1 Agent 53/100 agent ready Full breakdown ↓
scored 2026-08-17 · rubric v0.11.0
AccessEnterprise
6 APIs 1 MCP Servers
HealthcareUnited StatesClinical AIEHR IntegrationPoint of CareInteroperabilityValue-Based CareCare GapsOAuth

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-17 · rubric v0.11.0
Composite quality — 62.5/100 · strong
Contract Quality 13.9 / 21
Developer Ergonomics 12.5 / 17
Commercial Clarity 8.5 / 17
Operational Transparency 9.6 / 11
Governance 2.1 / 10
Discoverability 7.1 / 9
Regulatory Posture 8.8 / 15
Agent readiness — 53/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Regulatory Posture applies to this provider. Its tags matched the Health regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
The six quality facets above are damped to 85 points between them, because the conditional facet above carries the other 15. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 85% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/vim: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 6

Individual APIs this provider publishes, each with its own machine-readable definition.

Vim Canvas SDK (VimOS.js)

The Vim Canvas developer platform and VimOS.js JavaScript SDK for embedding applications at the point of care. Reads EHR state (Patient, Encounter, Orders, Referral, Claim, plus...

Vim Applications & Organizations API

REST endpoints for retrieving the organizations connected to an application and the users within an organization application. OAuth 2.0 client-credentials authenticated.

Vim Invitations API

REST endpoint for inviting users to access applications on Vim. OAuth 2.0 client-credentials authenticated.

Vim Appointments API

REST endpoint returning future appointment data (a 10-day lookahead) for a Vim organization. OAuth 2.0 client-credentials authenticated.

Vim Chart Retrieval API

REST endpoint for obtaining a download URL for a chart-retrieval request. OAuth 2.0 client-credentials authenticated.

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 c...

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Vim Data Source API Integration

OPEN COLLECTION

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

vim-mcp.yml

MCP SERVER

Pricing Plans 1

Published pricing tiers and plan structures.

Vim Plans Pricing

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Vim Rate Limits

5 limits

RATE LIMITS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Vim Webhooks

ASYNCAPI

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Vim Authentication

http/oauth2 · 2 schemes

SECURITY

Vim Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Vim Trust Center

HITRUST CSF, SOC 2 Type II, HIPAA

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Vim Scopes

4 scopes · implicit/clientCredentials

4 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Vim Agentic Access

4 operations · 4 acting

4 operations · 4 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

Sandbox
Sandbox
 DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 Login
Login

Documentation 4

Reference material describing how the API behaves

OpenAPI
OpenAPI
 OpenAPI
OpenAPI
 Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

MCPServer
MCPServer
 AgentSkill
AgentSkill
 WellKnown
WellKnown
 LLMsTxt
LLMsTxt
 AgenticAccess
AgenticAccess

Design & Contract 9

Pagination, idempotency, versioning, errors, and events

ErrorCatalog
ErrorCatalog
 Conventions
Conventions
 DataModel
DataModel
 Lifecycle
Lifecycle
 Conformance
Conformance
 ErrorCatalog
ErrorCatalog
 Webhooks
Webhooks
 Components
Components
 OAuthMetadata
OAuthMetadata

Scroll for all 9

Build 5

SDKs, sample code, and the tooling you integrate with

ToolCrosswalk
ToolCrosswalk
 Packages
Packages
 SDKs
SDKs
 GitHubOrganization
GitHubOrganization
 Postman
Postman

Access & Security 6

Authentication, authorization, and security posture

Compliance
Compliance
 TrustCenter
TrustCenter
 DomainSecurity
DomainSecurity
 OAuthScopes
OAuthScopes
 Authentication
Authentication
 Security
Security

Operate 5

Status, limits, changes, and where to get help

RateLimits
RateLimits
 ChangeLog
ChangeLog
 ChangeLog
ChangeLog
 Support
Support
 StatusPage
StatusPage

Commercial 3

Pricing, plans, and the legal terms of use

Plans
Plans
 TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 2

The organization behind the API

Website
Website
 Blog
Blog

Other 3

Properties that don't map to a standard resource type

Overlay
Overlay
 Overlay
Overlay
 OpenIDConfiguration
OpenIDConfiguration

Source (apis.yml)

apis.yml Raw ↑ 
aid: vim
url: https://raw.githubusercontent.com/api-evangelist/vim/refs/heads/main/apis.yml
name: Vim
kind: company
description: Vim is a United States healthcare technology company (getvim.com) that operates a clinical workflow and point-of-care
  integration platform connecting health plans, provider organizations, and digital-health applications to physicians inside
  their existing electronic health records. Through the Vim Canvas developer platform and the VimOS.js JavaScript SDK, applications
  embed actionable clinical insights - diagnosis gaps, risk, quality, and social determinants of health - directly into supported
  ambulatory EHR workflows and can read and write EHR resources (Patient, Encounter, Orders, Referral, Claim) at the point
  of care. Vim also exposes a REST API at api.getvim.com/v1 for provisioning applications, organizations, invitations, appointment
  lookups, and chart retrieval, authenticated with OAuth 2.0 client credentials via an Auth0-backed authorization server (auth.getvim.com).
  Vim is HIPAA, SOC 2, and HITRUST certified. The platform is proprietary REST and SDK based; it is not an HL7 FHIR API and
  publishes no FHIR CapabilityStatement. The API is available only to application servers hosted within the United States.
accessModel:
  pricing: enterprise
  onboarding: partner
  trial: false
  try_now: false
  public: false
  label: Enterprise · Partner onboarding · US-only
  confidence: medium
  source:
  - authentication
  - documentation
  generated: '2026-07-24'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Healthcare
- United States
- Clinical AI
- EHR Integration
- Point of Care
- Interoperability
- Value-Based Care
- Care Gaps
- OAuth
created: '2026-07-24'
modified: '2026-08-15'
specificationVersion: '0.19'
apis:
- aid: vim:vim-canvas-sdk
  name: Vim Canvas SDK (VimOS.js)
  description: The Vim Canvas developer platform and VimOS.js JavaScript SDK for embedding applications at the point of care.
    Reads EHR state (Patient, Encounter, Orders, Referral, Claim, plus problem/medication/allergy/lab/vitals lists) and writes
    back to Encounter, Referral, and Order resources through Vim Connect's EHR connectivity layer. Proprietary SDK surface
    - not FHIR.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  tags:
  - EHR Integration
  - SDK
  - Point of Care
  properties:
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: Documentation
    url: https://docs.getvim.com/vim-os-js/vim-ehr-connectivity
  - type: GettingStarted
    url: https://docs.getvim.com/vim-os-js/setting-up
- aid: vim:vim-applications-api
  name: Vim Applications & Organizations API
  description: REST endpoints for retrieving the organizations connected to an application and the users within an organization
    application. OAuth 2.0 client-credentials authenticated.
  humanURL: https://docs.getvim.com/api
  baseURL: https://api.getvim.com/v1
  tags:
  - Applications
  - Organizations
  properties:
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: OpenAPI
    url: openapi/vim-rest-api-openapi-original.json
  - type: Overlay
    url: overlays/vim-rest-api-overlay.yaml
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
- aid: vim:vim-invitations-api
  name: Vim Invitations API
  description: REST endpoint for inviting users to access applications on Vim. OAuth 2.0 client-credentials authenticated.
  humanURL: https://docs.getvim.com/api
  baseURL: https://api.getvim.com/v1
  tags:
  - Invitations
  - User Management
  properties:
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: OpenAPI
    url: openapi/vim-rest-api-openapi-original.json
  - type: Overlay
    url: overlays/vim-rest-api-overlay.yaml
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
- aid: vim:vim-appointments-api
  name: Vim Appointments API
  description: REST endpoint returning future appointment data (a 10-day lookahead) for a Vim organization. OAuth 2.0 client-credentials
    authenticated.
  humanURL: https://docs.getvim.com/api
  baseURL: https://api.getvim.com/v1
  tags:
  - Appointments
  - Scheduling
  properties:
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: OpenAPI
    url: openapi/vim-rest-api-openapi-original.json
  - type: Overlay
    url: overlays/vim-rest-api-overlay.yaml
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
- aid: vim:vim-chart-retrieval-api
  name: Vim Chart Retrieval API
  description: REST endpoint for obtaining a download URL for a chart-retrieval request. OAuth 2.0 client-credentials authenticated.
  humanURL: https://docs.getvim.com/api
  baseURL: https://api.getvim.com/v1
  tags:
  - Chart Retrieval
  - Clinical Data
  properties:
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: OpenAPI
    url: openapi/vim-rest-api-openapi-original.json
  - type: Overlay
    url: overlays/vim-rest-api-overlay.yaml
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
- aid: vim:vim-data-source
  name: Vim Data Source
  description: 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.
  humanURL: https://data-docs.getvim.com/general-information.html
  tags:
  - Care Gaps
  - Clinical Data
  - Data Ingestion
  properties:
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: OpenAPI
    url: openapi/vim-data-source-openapi-original.json
  - type: MCPServer
    url: mcp/vim-mcp.yml
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
  - type: Overlay
    url: overlays/vim-data-source-overlay.yaml
common:
- type: OpenAPI
  url: openapi/vim-data-source-openapi-original.json
- type: OpenAPI
  url: openapi/vim-rest-api-openapi-original.json
- type: MCPServer
  url: mcp/vim-mcp.yml
- type: ToolCrosswalk
  url: mcp/vim-tool-crosswalk.yml
- type: Packages
  url: packages/vim-packages.yml
- type: SDKs
  url: packages/vim-packages.yml
- type: AgentSkill
  url: skills/_index.yml
- type: ErrorCatalog
  url: errors/vim-problem-types.yml
- type: Conventions
  url: conventions/vim-conventions.yml
- type: DataModel
  url: data-model/vim-data-model.yml
- type: Lifecycle
  url: lifecycle/vim-lifecycle.yml
- type: Conformance
  url: conformance/vim-conformance.yml
- type: Compliance
  url: https://getvim.com/technology-security/
- type: TrustCenter
  url: https://compliance-self-service.getvim.com
- type: WellKnown
  url: well-known/vim-well-known.yml
- type: LLMsTxt
  url: llms/vim-llms.txt
- type: Overlay
  url: overlays/vim-data-source-overlay.yaml
- type: Overlay
  url: overlays/vim-rest-api-overlay.yaml
- type: ErrorCatalog
  url: errors/vim-error-codes.yml
- type: RateLimits
  url: rate-limits/vim-rate-limits.yml
- type: ChangeLog
  url: changelog/vim-changelog.yml
- type: Sandbox
  url: sandbox/vim-sandbox.yml
- type: Webhooks
  url: asyncapi/vim-webhooks.yml
- type: Plans
  url: plans/vim-plans-pricing.yml
- type: Components
  url: components/vim-components.yml
- type: DomainSecurity
  url: security/vim-domain-security.yml
- type: AgenticAccess
  url: agentic-access/vim-agentic-access.yml
- type: OAuthScopes
  url: scopes/vim-scopes.yml
- type: Authentication
  url: authentication/vim-authentication.yml
- type: Website
  url: https://getvim.com/
- type: DeveloperPortal
  url: https://docs.getvim.com/
- type: Documentation
  url: https://docs.getvim.com/
- type: APIReference
  url: https://docs.getvim.com/api
- type: GettingStarted
  url: https://docs.getvim.com/vim-os-js/setting-up
- type: OpenIDConfiguration
  url: well-known/vim-openid-configuration.json
- type: OAuthMetadata
  url: well-known/vim-oauth-authorization-server.json
- type: GitHubOrganization
  url: https://github.com/getvim
- type: Postman
  url: https://docs.getvim.com/invitations-postman-collection.json
- type: ChangeLog
  url: https://docs.getvim.com/change-log/
- type: Support
  url: https://getvim.com/contact-us/
- type: Login
  url: https://console.getvim.com
- type: StatusPage
  url: https://status.getvim.com
- type: Blog
  url: https://getvim.com/blog
- type: Security
  url: https://getvim.com/technology-security/
- type: TermsOfService
  url: https://getvim.com/legal/website-terms-of-use/
- type: PrivacyPolicy
  url: https://getvim.com/legal/privacy/
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
x-enrichment:
  date: '2026-08-15'
  status: enriched
  artifacts_added: 12
  pass: local-v1