For Organizations: Create URLs / embeds for clients to book with all or specific providers

Healthie's calendar and package embeds enable you and your team to share custom views of your Organization Calendar and Client Packages. These views can be created as a URL or an embeddable widget, and you can customize which providers and packages appear in your URLs as you streamline your client onboarding process. 

These links enable clients to buy and/or book with you from your website / social media / newsletter accounts, and be automatically linked to you on Healthie.

Healthie offers 3 primary options (Options A - C below) for how you can display your calendar & package options. This article provides an outline of your options, and how to pull the specific URL / embed code to meet your client onboarding needs. We have also aligned with our Organizations on custom onboarding requirements (Option D below). 

IN THIS ARTICLE:

  • In this instance, each provider maintains their own unique link that shows their availability, and enables clients to book / purchase. 
  • If a client (or prospective client) uses this link, they are automatically associated with that specific provider in your organization. 
  • This is commonly used for organizations that have a website biography page that outlines specific provider services with link to book / purchase.
  • Each provider can pull the link to book here, and purchase
  • If you'd like to include JUST calendar availability, please have each provider navigate to Calendar > Share Calendar, and generate their unique link
  • If you'd like to include a package in this booking flow:
    • Billing > Client Packages > Package > Share > Select Provider > Copy Link
  • In this instance, your full organization's availability is incorporated into the booking flow. 
  • If a prospective client uses this link, they are assigned to a provider based on the availability that providers have, in aggregate, set. If more than one provider the same opening available that a client selects, the client is randomly assigned. 
  • This is commonly used for organizations in which there is no preference (e.g., based on geography or specialty) of client / provider.
  • To pull this link, replace the &provider_ids[...] section of your package / booking link with the snippet of code &org_level=true to show the full team's openings
  • Alternatively, if you would like to show the combined availability of a set of specific providers rather than the entire organization, generate the link with specific providers filtered, leave their IDs in the URL and add &org_level=true&vorp_ezimodnar=true to the end of the booking link. This will skip the “Select a Provider” step in the booking flow.

Option C: [Multi-step] - Clients select a provider (or indicate no preference), then select a time

  • In this instance, all providers are shown in a single directory before a client is prompted to find a specific time to provider maintains their own unique link that shows their availability, and enables clients to book / purchase. 
    • Clients can also select "no preference" which will pull the availability of all providers in the organization
  • If a client (or prospective client) uses this link, they are automatically associated with that specific provider in your organization. 
  • This is commonly used for organizations that do not have a website biography page that outlines specific provider services with link to book / purchase, but still want clients to be able to choose their provider. 
  • You may also want to indicate Specialty of a provider, which can be set up by adding credentials after the Last Name of the provider in their account settings: ie. Mary Jones, NP (where Jones, NP is the Last Name of the provider). 

  • To set up Option C, please use the "Share and Embed" option navigating to Billing > Client Packages > More > Share and Embed. More information here.  You will be able to select Providers and Packages that you'd like to use. 

Option D: Something Else

An alternate solution would be to:

  • Create a separate Appointment Type that is setup to require booking with the providers you want to show the shared availability of
  • Generate a sharing link for that specific Appointment Type
  • Setting up the availability for this new Appointment Type for the providers involved
  • Replacing the &provider_ids[...] part of a a booking link with &org_level=true that link will show the combined availability for your entire organization for the appointment types included on the link

This would result in a booking link that shows the combined availability for just these providers. It's a more involved process but it's how you would be able to implement this workflow with what is currently possible within Healthie. More details on how to require a specific provider to be available as part of an appointment type will be found here: Configure Appointment Types


Full suite of options on Scheduling URL Param Options


Healthie’s shareable/embeddable scheduling links can be configured via URL params. This document goes over helpful params that can be used to customize the booking experience

URL Format

Healthie’s booking links follow the following format (in Ruby String syntax)

“#{BASE_URL}/appointments/embed_appt#{URL_PARAMS}

BASE_URL is the URL of your Healthie interface. This would be

Env

Base URL
Staging https://securestaging.gethealthie.com
Unbranded
Production https://secure.gethealthie.com
Whitelabeled
Production The provided whitelabel URL

Key URL Params

Param

Usage

Example
provider_id Required. The ID of a provider. This specifies the specific provider’s availability to check if org_level is false. If org_level is true, this helps identify the organization to operate on

1
org_level Defaults to false. When true, the scheduling link can check multiple providers at once

true
provider_ids An array of Provider IDs. Must be passed in with org_level as true. When sent in, the potential provider is limited to these provided IDs.

[1,2,3]



vorp_ezimodnar Has no impact if provider_ids are not passed in. When true, the provider select step is skipped.

true
appt_type_ids An array of Appointment Type IDs. When sent in, the potential appointment type options are limited to these provided IDs.

[1,2,3]
contact_type The Contact Type for the session (as a string). Only is applied if appt_type_id is also sent in

Phone Call
appt_type_id An Appointment Type ID. When sent in, the appointment type select step is skipped and this is preselected. If sent in, a contact_type must be sent in as well

1
state_licenses The potential states that can be selected. If only one is sent in, it is pre-selected

[NY,PA]
appt_loc_id An Appointment Location ID. When booking an in-person appointment, this preselects the appointment location

1
appt_loc_ids An array of Appointment Location IDs. When sent in, the potential appointment locations options are limited to these provided IDs.

[1,2,3]
tag_ids An array of Tag IDs. When sent in, only providers with ALL of the specified tags are considered potential options

[1,2,3]
email When sent in, this will prefill the email field in the “complete booking” screen

test@example.com
first_name When sent in, this will prefill the first name field in the “complete booking” screen

John
last_name When sent in, this will prefill the last name field in the “complete booking” screen

Doe
phone_number When sent in, this will prefill the phone number field in the “complete booking” screen

555-555-5555
read_only When sent in as true, the user information on the “complete booking” screen will not be editable. Only use if prefilling those fields

true

So an example URL with a pre-selected state and subset of tags would be something like


https://secure.gethealthie.com/appointments/embed_appt?provider_id=30&state_licenses=[NY]&tag_ids=[1,2,3,4]



FAQs

When booking round-robin, does it show the superset of all providers' availabilities?

Yes, the link will search availability for all providers.

If two providers are available at the same time, which provider will get the booking?

Healthie will randomly choose the provider.

How can a support team member share a calendar?

If a support team member doesn't have access to their own calendar, they can still create a share link or embedded code for providers in their organization. This is done by:
  • Navigating to the Organization Calendar
  • On the left-hand side under View by Provider click any provider name
  • This will bring you to the provider's calendar where you can then click More > Share and Embed
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.