You are here:
Check Patient Location for Appointments
Create custom fields and edit an Omniscript to check that a patient’s location at the time of a virtual appointment matches with a care provider license jurisdiction.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions with Health Cloud |
| User Permissions Needed | |
|---|---|
| To edit OmniScripts: | OmniStudio Admin permission set |
To show only providers that can provide care in the user’s location, set up a custom filter for licensing jurisdictions.
-
To store locations where the provider can practice Virtual Care, add a custom field to the
Healthcare Provider Object.
- From Setup, click Object Manager, then click Healthcare Provider
- Open Fields & Relationships and click New.
- Select the Picklist (Multi-Select) data type and click Next.
- Enter the Field Label. For example, Licensing State.
- Select Enter values, with each value separated by a new line.
-
Enter the jurisdictions where your providers can legally practice virtual care.
Depending on your location, you can enter all of your country’s states and territories, or enter a few that apply to your providers.
- Leave the Field Name as is and click Next.
- Set field-level security to allow users to update provider information, then click Next.
- Leave the default page layout assignment as is and click Save.
-
Add a Licensing State custom field to the Care Provider Searchable Field object so that
location is a searchable field.
- In the Object Manager, click Care Provider Searchable Field.
- Open Fields & Relationships, and click New.
- Select the Picklist (Multi-Select) data type, and click Next.
- Enter the Field Label. We suggest Licensing State_PS.
- Select Enter values, with each value separated by a new line.
-
Enter the jurisdictions where your providers can legally practice Virtual Care.
Enter the same jurisdictions that you entered for the custom field in the Healthcare Provider object.
- Make a note of the Field Name as you need it later in this task. Then click Next.
- Set field-level security to Read-Only for all users that need access to this field in Provider Search, then click Next.
- Leave the default page layout assignment as is, then save your work.
-
Map the Licensing State field on the Healthcare Provider object to the Licensing
State field on the Care Provider Searchable Field object.
- From Setup, in the Quick Find box, type Care Provider Search, and select Care Provider Search Config.
- Click New.
- Enter a label. We suggest Licensing_State_Config.
- Select Healthcare Provider from the Mapped Object dropdown list.
- In Source Field, add the Field Name of the field you added to the Healthcare Provider object. For example, Licensing_State__c.
- In Target Field, add the Field Name of the field you added to the Care Provider Searchable Field object. For example, Licensing_State_PS__c.
- Select IsActive.
- Save your changes.
-
Edit the Omniscript to ask the user their location at the time of the
appointment.
This strategy directly asks the user’s location at the time of appointment. There are other programmatic approaches to determine location, but they’re more complex.
- From the App Launcher, find and select OmniStudio.
- Go to the OmniScripts page and enter healthCloudIAM in the search field.
- Expand the healthCloudIAM/selfService Omniscript and open the latest version.
- Click New Version.
- In the Build panel, expand Groups.
- Drag the Step option above the Step named SelectLocation.
- Enter a Field Label. For example, Current State.
- Enter Instructions. For example, Which state will you be located in at the time of your appointment?
- In the Build panel, expand Inputs.
- Drag the Select component inside the step.
- In Select Properties, enter a Name. We suggest CurrentStateValues.
- Select Required.
- In Option Source, select $Object.
- In Source Type, enter the Object and Field API names where the state multi-select picklist is located. The format is ObjectName.FieldName. For example, if you created the Licensed State field on the Healthcare Provider, enter HealthcareProvider.Licensing_State__c.
-
After the customer indicates the state where they are at the time of the appointment, we
pass that value into the filter choices for Provider Search.
- From the OmniStudio app, select OmniStudio Integration Procedures.
- Expand healthCloudIAM/FetchProviderAndTimeSlots and select the latest version.
- Click Create Version.
- Click the DRTransformProviderSearchInput step.
-
In the Omnistudio Data Mapper Transform Action Properties panel, open the
Data Mapper by clicking the
next to the Data Mapper
Interface field.
- Go to the Transforms tab.
- Add a transform by clicking the + icon.
- In the Output JSON Path, enter ProviderSearchInput:CustomFilter
- In Output Data Type, select List<Map>.
-
Add another transform by clicking the
.
- In the Input JSON Path, enter the name of the step that was added to ask the user’s location and the name of the element holding the current state value. Type CurrentState:CurrentStateValues.
- In the Output JSON Path, enter ProviderSearchInput:Licensing_State_PS__c.
-
Update the applied filter in the ScheduleProvider step.
- Go back to the healthCloudIAM/selfService Omniscript.
-
Expand the ScheduleProvider step by clicking
- Click Apply Filter.
-
In the Properties panel on the Integration Procedure field, click the
to open the
healthCloudIAM_FetchProviderandTimeSlotsFilter.
- Select the DRTransformProviderSearchInput step.
-
In the Data Mapper Transform Action Properties panel, open the Data Mapper by
clicking
next to the Data Mapper
Interface field.
- Go to the Transforms tab.
-
Add a Transform by clicking the
- In the Output JSON Path, enter ProviderSearchInput:CustomFilter.
- In Output Data Type, select List<Map>.
-
Add another Transform by clicking
.
- In the Input JSON Path, enter the name of the step that was added to ask the user’s location and the name of the element holding the current state value. For example, CurrentState:CurrentStateValues
- In the Output JSON Path, enter ProviderSearchInput:Licensing_State_PS__c.
- Save your work.
- In the OmniScript Designer, click Activate Version.
Did this article solve your issue?
Let us know so we can improve!

