Developer Portal

Canvas™ Developer Platform - FAQs

Written by Vim | Sep 11, 2025 9:11:09 PM

Getting Started

What is the Vim Canvas™ Developer Platform?

Canvas is Vim’s embedded application platform that enables developers to integrate apps directly into clinical workflows across supported EHRs. Apps can display data, collect inputs, and write back to the EHR through Vim's iframe-based overlay.

What are the benefits of using Canvas?
  • Build Once, Deploy Everywhere: Your app runs across multiple EHRs with no extra configuration.

  • Embedded in Workflow: Launches in the EHR via iframe, no screen toggling.

  • Advanced Features: Supports role-based access, write-back, context-aware actions.

  • Fast Setup: Self-serve App Manifest gets you live in days, even with a small team.

  • Built-In Distribution: Apps can be listed in the Vim’s Canvas Marketplace, allowing your app to scale across Vim’s network of connected practices.

  • Security & Compliance: HIPAA, SOC 2, and HITRUST certified.

How do I get started?

You can explore the SDK documentation here and submit interest at getvim.com. After an intro call and executed MNDA, you’ll receive access to the developer Console and the sandbox EHR environment where you can start building in the App Manifest right away!

What is required to test my app?

Once you get access to the Vim Canvas™ Developer Platform, you’ll use Vim’s sandbox EHR environment and install our Chrome extension or MSI package (Windows) to simulate real-world clinical workflows.

Are there code samples or an SDK?

Yes, the SDK documentation can be found here and the sample application code here.

How long does it take to go live?

After you’ve completed your own testing to ensure your app is behaving as expected in the sandbox EHR environment, we’ll schedule a user acceptance testing (UAT) session where we will go through the experience together in the EHR production environment. Assuming the UAT session doesn’t identify needed app updates, you’ll submit the app for review. Reviews typically take one week, depending on feedback cycles.

Integration & Technical Capabilities

How does integration work?

You embed Vim’s JavaScript SDK into your web app. Vim uses client-side RPA to extract and write back data to the EHR UI. The SDK normalizes EHR differences.

What EHRs does Vim support?

You can find the list of supported EHRs here and those in development.  

Do I need to integrate separately with each EHR?

No. Canvas abstracts EHR differences so you only build once.

What data can my app access?

Available resources for reading, writing, and API calls are detailed in the SDK here.

What if an EHR updates its version?

Vim Canvas is built to be resilient to version changes. We maintain high uptime with rapid fixes and proactive monitoring.

Can I use any programming language?

Yes. Canvas is language agnostic.

Does Canvas support APIs or FHIR?

Apps are iframe-based and communicate through our JavaScript SDK. Some backend APIs are available. 

Security & Compliance

How is PHI handled?

Vim stores minimal PHI for debugging purposes. All PHI is encrypted and access is limited to staff with a need-to-know basis. We are HIPAA, SOC2, and HITRUST certified.

Does Vim carry cybersecurity insurance?

Yes, and we can provide documentation such as SOC2/HITRUST reports, insurance certs, etc. upon request (under MNDA).

Is the Vim integration compliant with EHR Terms of Service (ToS)?

Vim complies with HIPAA and interoperability standards. It’s the responsibility of each practice to confirm compatibility with their EHR vendor’s ToS.

Does my app need to meet privacy/security requirements?

Yes. Apps must be HIPAA compliant and pass a security and legal review before production release.

Is a Business Associates Agreement (BAA) required?

Yes, you’ll need a BAA with any practice that enables your app, and where the exchange of PHI is involved. Note: Vim supports applications that do not receive PHI through our integration, which may have different BAA requirements as a result. 

How is authentication handled between Vim and my app?

See details here in our documentation. 

Launch & Distribution

How is my app distributed in the Vim Canvas Marketplace? 

Once your application is live in the marketplace, we have three standard ways we communicate the availability of your application to the Vim network of connected practices:

  1. In-EHR Marketplace listing in the User Center accessible via the Vim hub

  2. in-EHR push notifications

  3. Vim monthly newsletter

Can I limit who in Vim's network of practices can enable my app?

Yes, you can choose to auto-enable or require approval. While any Vim user can request access, you control permitting access.

What are best practices for early distribution?

We recommend starting with a few practices to learn, iterate, then scale via the Marketplace.

How do I make my app available through Vim to users who already use it outside of Vim?

To enable your app via Vim, users will need to activate a Vim account and install either the Vim Chrome extension (for Mac) or the MSI package (for Windows). The setup is quick and straightforward, and our implementation team will support you and your users throughout the process.

Pricing & Billing

How does pricing work?

We have two standard tiered models, with additional revenue-share opportunities as an option:

  • Per-User (PUPM): often selected for apps that can be used across the entire patient panel.

  • Per-Member (PMPM): often selected for apps only used with a subset of the patient panel.

What determines pricing “tier?”
  • Standard Tier: Read-only with a few workflows

  • Premium Tier: Write-back, advanced API use, deeper workflow support

Once we have a signed MNDA, we will collaborate with you to define the appropriate pricing model and tier based on your use case and business model.

Who handles billing?

Vim bills developers. You manage billing and contracting with practices (as applicable). We provide usage reporting, but downstream billing and analytics reporting is up to you to implement and manage.

App Management & Support

How do I update my app?

You can deploy updates at any time through Vim Console. Minor changes (e.g., UI tweaks, bug fixes) do not require re-review. However, if you’re adding new functionality or requesting access to new SDK features your app will need to go through Vim’s re-review process.

How will I know about platform product updates?

We send monthly release notes by email with highlights and demo videos.

What if something breaks within Vim Hub or my app?

Users can submit support tickets in Vim Hub with the “Need Help?” CTA. If our support team determines that the issue is related to your app functionality, we’ll notify you.

Will I have a point of contact at Vim for questions post launch? 

Yes, you will have a Customer Success Specialist assigned to your account who can triage ongoing questions beyond regular support needs. 

Still have questions? Reach out anytime to Vim’s product team, we are here to help.