This guide shows you how provider group’s Console account owners and admins can request, approve, and activate your application in the Vim Console™ or in the Canvas™ Marketplace. It’s designed for developers who want to understand the end-to-end Marketplace process so they can better support onboarding and activation for both existing and new Vim customers.
What is a Console Account Owner or Admin?
A provider organization’s Console account owner accepts Vim’s Terms of Service, BAA, and manages essential settings such as the Marketplace distribution for their organization in Console.
A provider organization can also have Console account administrators who can assist with Vim Connect user application access.
Using the Vim Console™ and Canvas™ Marketplace
The Vim Console™ and Canvas™ Marketplace lets console account owners and admins:
- Discover third-party applications
- Add or Request to add applications directly in Console
- Watch demo videos for select tools
- Learn about app functionality, workflow integration, and data security
- Activate apps for their Vim Connect users
You can share these how-to guides with your existing customers who already have Vim Connect to streamline onboarding and help new customers find your app faster.
Who Can Access Vim’s Console and Canvas™ Marketplace?
Console Marketplace
- Only Console Account Owners and Account Admins in a provider group have access.
Canvas™ Marketplace (in the EHR)
- Console Account Owners and Account Admins who are also Vim Connect end users can access apps through the Canvas™ Marketplace.
- Vim Connect end users who are not Console Account Owners or Admins do not have access to Console but can still access the Canvas™ Marketplace directly in the EHR.
Where Can Console Accounts Owners + Admins Access Vim’s Console Marketplace?
The Console™ Marketplace is located in Vim’s Console under the Applications tab in the left-hand navigation.
How can developers view users added in the Marketplace?
From Console, developer account owners/admins can:
- View newly added provider organizations
- View newly added Vim Connect users for each organization
From the SDK, developers can:
- Identify new organizations and users once your app is installed. When a user successfully adds your app from the Marketplace, the SDK automatically triggers the authentication flow and provides both the user and organization identifiers.
- Match identifiers against your internal database to determine whether the user or organization is new or returning, and handle each case appropriately.
- Track user engagement by using the SDK’s app state to see whether a specific user has opened your app.
How App Requests Work
Individual Subscription Applications
- These can be added immediately via the “Add now” icon on your app’s Console listing page.
- The provider account owner/admin:
- Reviews and agrees to your Terms of Service, Privacy Policy, Business Associate Agreement (if applicable), and EHR permissions.
- Selects which users will have access to the application.
- Designated Vim Connect end users receive a notification in the EHR the next time they log in, letting them know the app is installed and ready to use.
- You will see the new organization and user(s) data on the app authorization flow
Organization-Level Subscription Applications
- These require an additional step and show a “Request to add” icon.
- The provider account owner/admin:
- Reviews and agrees to your Terms of Service, Privacy Policy, Business Associate Agreement (if applicable), and EHR permissions.
If they are your existing customer:
- They enter their contact information and note in the free text field that they are already your customer.
- They click Send request.
- You’ll receive an email from Vim with the request details.
- Vim adds the app for your customer.
- You will see the new organization and user(s) data on the app authorization flow
If they are not an existing customer:
- They enter contact information and click Send request to allow Vim to share their details with you.
- This starts a direct conversation about subscription terms—no commitment yet.
- You’ll receive an email from Vim with the practice’s name, TIN, address, and contact info.
- Your team reaches out to the provider group to finalize a contract with them.
- Once the contract is in place, you notify Vim to turn on your app for the organization.
- Then you’ll see the new organization and user(s) data on the app authorization flow.
Example of email developer team receives for organization level requests:
Tips for Developers
- Encourage existing customers to note that they already have a contract in the free text field if your app is an organization subscription type—this speeds up activation.
- Provide clear demo videos with audio and descriptions in your Marketplace listing to improve request-to-activation rates.
- Respond quickly when you get a request email—practices expect fast turnaround.