Inviting Accounts to Your App

Once your app has a live version, you can invite an account to install it. There are two flows, depending on whether the account already uses Vim:

Inviting a new account

As the developer:

1. In the Console, open Build → My Apps, then your app.
2. On the live version's row, click Invite account.
3. Choose New account. The Invitations form opens with your app already selected under Pre-install apps.
4. Fill in the practice's details and the account owner's name and email, then click Send invitation.

The invitation shows as pending under Network → Invitations until the practice signs up.

As the invited practice:

1. Open the email "Vim invited you to join Vim Connect" and click Accept Invitation. The link expires in 72 hours. If it has expired, ask the sender to resend it.
2. Complete the onboarding wizard: verify your email, accept the agreements, then enter your practice's details.
3. On the apps step, review the pre-selected app and the data it can access, then confirm.

Inviting an existing account

An existing account connects through a connection code: a one-time code the account generates and shares with you. Codes are single-use and expire after 7 days.

As the invited account, first:

1. In the Console, open Network → My network and click Share a connection code.
2. Click Generate new code, copy the code, and send it to the developer.

As the developer:

1. Open your app. On the live version's row, click Invite account.
2. Choose Existing account. A service app skips this choice and opens directly on the code step.
3. Paste the 64-character code. You can add a message explaining why the account should connect.
4. Review what the app will access, then click Send invitation:
   • Point-of-care apps: the in-app experience (App UX) and the EHR data it can access.
   • Service apps: the collection's record types and the operations the app asks for.

As the invited account, then:

1. Open My Account → Applications → Pending approval. The request names the inviting account and shows "via connection code".
2. Click Approve and review the app's access.
   • For a service app, choose which operations to grant. The list the app asks for is a ceiling: you can grant all of them or fewer, never more.
3. Click Approve install.

The app moves to Installed and is active right away.

Troubleshooting

• "Must be a 64-character lowercase hex string" means the code was copied incompletely. Ask for it again, or copy it once more.
• The code was rejected because it has already been used or has expired. Ask the account to generate a new one.
• Invite account is missing because only a live version can be shared. Publish the version first.