• There are no suggestions because the search field is empty.
BUILD

Console Overview for Developers

Vim
Vim

This guide is for Developer Account Admins who can set up accounts in Console, manage and build applications, and support end user onboarding and ongoing end user success.

1. Manage your application(s) in Console

A. Setting Up Your Application

  • Access Credentials: Retrieve your Client ID and secret from the My Account tab. These are required for integrating the SDK into your app’s codebase.
  • Team Collaboration: Invite additional developers or collaborators via the Console Users tab to ensure your team has the necessary access and roles. See more under “Inviting team members” in our docs. 
  • Application Manifest: Define and configure your app’s manifest in the Applications tab. The manifest sets your app’s core details and requirements.
B. Developing and Integrating
  • SDK Documentation: Reference the Documentation tab for comprehensive SDK guides, integration tips, and API references to streamline your development process.
  • Sandbox Testing: Use the Sandbox EHR tab to thoroughly test your application in a safe, realistic environment.
C. Version Control and Environment Management
  • Manage Application Versions: Use the Manage Versions tab within your built application to create and organize multiple versions across different environments (e.g., local, dev, test, demo, or any custom environment). This supports parallel development, QA, and release processes.
D. Application Review and Go-Live
  • Submit for Review: When ready, submit your application for review by the Vim team directly from the Vim Console.
  • Go Live: Once approved, mark your application as live. Your app will then be available for installation by practices and users.
2. Manage your network of practices - applicable for org-level distributed applications

Looking up an organization:

  • Login to Console
  • Click on the Organizations tab in the left menu
  • Look up the organization by using the search bar in the top right corner or by scrolling through the list of organizations
  • Click the three dots to the right of the organization’s name 
  • Select view

From the organization view in Console you can access the:

  • Organization ID - you're dev team may need this to configure the app for the organization prior to the implementation call
    • This key ensures users are tied to the correct practice when they install Vim.
  • Organization URL- you’re dev team may also need this to configure the app for the organization prior to the implementation call
  • Organization Key - you'll need this during the download process for new users.
    • This key ensures users are tied to the correct practice when they install Vim.
3. Enable your network of practices with resources designed for your network’s Console account admins and account owners.
  • Practice Knowledge Base: Console Overview
    • This article includes a training video that shows a practice’s console account owner and admin how to:
      • Update their advanced settings
      • Add or remove an application from a user
      • Delete inactive users

Tips for Success
  • Enable Seamless Login and Auto-Create for the easiest setup experience.
  • Double-check email addresses for accuracy when adding users manually.
  • Remove unused users regularly to keep your Console organized.