Health Cloud Administration
jConfigure the Self-Service Appointment Flow
To customize the self-service appointment management flow, edit the steps of the
healthCloudIAM OmniScripts.
|
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions with Health Cloud |
Schedule an Appointment
To edit the appointment management self-service flow, open the OmniStudio app, go to the OmniScripts page, expand the healthCloudIAM/selfService OmniScript, and open the highest version.
| Component Name | Component Type | What It Does | What It Calls | |
|---|---|---|---|---|
| SelectLocation | Step | Prompts the user for a location. | GetMaps_AutoComplete | |
| CheckGuestUser | Set Values | Checks if the user has an existing Person Account. It also checks the user's time zone, their current time, and end of day time. | None | |
| DRFetchUserDetails | DataRaptor Extract Action | Retrieves user details and records for appointment reason options. | HealthCloudIAMExtractAppointmentReason | |
| ScheduleAppointmentOptions | Step | Displays a FlexCard with appointment options for the user. | None | |
| MandateOptionSelection | Set Errors | Uses a formula to check that the user has selected an appointment reason so they can proceed with the flow. | None | |
| SetSelectedWorkTypeId | Set Values | Sets the appointment reason's work type ID and work type name. | None | |
| SetAddressForProvderSearch | Set Values | Assigns the user's address to the provider search attributes. | None | |
| DRFetchSchedulingSystem | DataRaptor Extract Action | Extracts the scheduling system and care specialty for the selected appointment reason. | HealthCloudIAMExtractSchedulingSystem | |
| IPGetProviderAndSlots | Integration Procedure Action | Converts user input into attributes for the provider search functionality and uses the GetProviders API to fetch providers. | healthCloudIAM_FetchProviderAndTimeSlots | |
| IPGetSlotsForProviders | Integration Procedure Action | Retrieves time slots for the selected providers and sorts providers in this order: assigned, past, and other providers. The component then merges these providers into a single list. It also converts the time slots into the provider's operating time zone, if mentioned. If not, the slots are converted to the user's browser time zone. | healthCloudIAM_FetchTimeSlots | |
| SetCalendarDate | Set Values | Sets the calendar date as today along with the address entered by the user. | None | |
| ScheduleProvider | Step | Displays a form with providers within a certain radius of the user's location along with filters to narrow the options. | None | |
| CheckIfAcceptsNewPatient | Set Values | Sets a value to indicate if the provider is accepting new patients. | None | |
| MandateSlotSelection | Set Errors | Uses a formula to check if the patient is new and the provider is accepting new patients so they can proceed with the flow. | None | |
| NotAcceptingNewPatients | Step | Displays a message if the user is new and the provider isn't accepting any new patients at the moment. | None | |
| IPTransformIndividualProviderData | Integration Procedure Action | Separates the selected provider's data and availability information from the list of all available providers. | healthCloudIAM_TransformIndividualProviderData | |
| IPTransformIndividualSlotsData | Integration Procedure Action | Runs when the user wants to see the next soonest appointment for a particular provider. The Integration Procedure fetches the earliest available appointment slots. | healthCloudIAM_TransformIndividualSlotsData | |
| SetCalendarFiltervalue | Set Values | Sets values of the calendar date for the next soonest appointment available. | None | |
| ScheduleProviderIndividual | Step | Displays available slots to book an appointment for the selected provider. | None | |
| NoSlotSelected | Set Errors | Doesn’t let the user proceed in the flow without selecting an appointment slot. | None | |
| SetSelectedSlotValues | Set Values | Assembles the data for the selected appointment slot. | None | |
| ExperienceWithProvider | Step | Displays options to indicate if the user has seen the provider in the last 3 years. | None | |
| CheckExperienceWithProvider | Set Errors | Doesn’t let the user proceed in the flow without selecting if they’ve visited the provider in the last 3 years. | None | |
| SetWorkTypeId | Set Values | If the user has seen the provider in the past 3 years, this component assigns the established work type ID, and name. | None | |
| DRFetchNewSchedulingSystem | DataRaptor Extract Action | Checks if the scheduling system is Salesforce or an external system. | HealthCloudIAMExtractSchedulingSystem | |
| SetCallBookAppointment | Set Values | Checks if the BookAppointment API is to be called. The API is called only when the scheduling system is Salesforce. The API isn’t called for a user who has selected the EHR work type. | None | None |
| IPFetchSlotsForNewPatient | Integration Procedure Action | Uses the established work type ID to make an API call to find slots. Also checks if the selected slot is still available. | healthCloudIAM_TransformForNewPatient | |
| SelectedSlotNotAvailableForExistingPatient | Step | Displays a message if the selected slot isn’t available for a patient. | None | |
| CollectGuestUserInfo | Step | If the selected slot is available, a form collects the guest username, email, and date of birth. | None | |
| IPFetchInsurances | Integration Procedure Action | Retrieves insurance details | HealthCloudIAMExtractInsurance | |
| ExistingInsurance | Step | This step is optional. Displays a form for existing user to verify their insurance details. | None | |
| AddInsurance | Step | This step is optional. Displays a form for new users to enter their insurance details. | None | |
| Referral | Step | This step is optional. Displays a form for users to enter details if they've been referred to the provider. | None | |
| IPCheckSelectedSlotStatus | Integration Procedure Action | Checks if the selected slot is still available. | healthCloudIAM_fetchSlotStatus | |
| SelectedSlotNotAvailable | Step | Displays a message if the selected slot isn’t available. | None | |
| IPTransformAllData | Integration Procedure Action | Transforms user selection data JSON into the appropriate structure so that it can be displayed to the user for review. | healthCloudIAM_TransformBookAppointmentData | |
| Review | Step | Displays the details of the selected appointment. | None | |
| IPCreateGuestUser | Integration Procedure Action | If the flow is run by a guest user, then this Integration Procedure creates a Person Account record for the guest user. | healthCloudIAM_CreateGuestUser | |
| IPBookAppointment | Integration Procedure Action | Transforms user selection into a format that can be passed on to the bookAppointment remote method to book the appointment. Updates the referral data. If the user entered insurance details, a member plan record and a case record are created. Also creates a case record for guest users who select an external work type. | healthCloudIAM_bookAppointment | |
| AppointmentConfirmed | Step | Displays a confirmation message to an existing user that the appointment is booked. | None | |
| NavigateToBenefits | Navigate Action | If the user clicks View Appointments on the confirmation screen, this component navigates them to the My Appointments page. | None | |
| AppointmentConfirmedGuestUser | Step | Displays a confirmation message to a guest user that the appointment is booked. | None | |
| AppointmentFailed | Step | Displays a message if the process workflow terminates abruptly. | None | |
| AppointmentConfirmedGuest | Step | If a guest user selects an external work type (EHR) then this confirmation is displayed after booking their appointment. | None | |
| NavigateAction | Navigate Action | Navigates the user back to the Home page. | None |
Cancel an Appointment
To edit the appointment cancellation self-service flow, open the OmniStudio app, go to the OmniScripts page, expand the healthCloudIAM/myAppointments OmniScript, and open the highest version.
| Component Name | Component Type | What It Does | What It Calls |
|---|---|---|---|
| DR-FetchAppointmentReason-234 | DataRaptor Extract Action | Extracts the reason for the appointment. | HealthCloudIAMExtractAppointmentReason |
| SetValues | Set Values | Sets the Context ID for the logged in user, which is the business account ID associated with that user. | None |
| IPFetchServiceAppointments | Integration Procedure Action | Extracts past and upcoming appointments for the user. | healthCloudIAM_FetchServiceAppointments |
| Appointment_History | Step | Displays the past and upcoming appointments in a FlexCard. | None |
| Cancel_Appointment | Step | Confirms that the user wants to cancel the appointment. | None |
| DR-CancelAppointmentParameters_234 | DataRaptor Extract Action | Retrieves all the appointment parameters from objects ServiceAppointment, CarePractnFacilityAppt, and Identifier. | HealthCloudIAMCancelAppointmentParameters |
| Check_IF_EHR_LS | Set Values | Fetches the values for sourceSystem and externalAppointmentId. | None |
| DR-TransformParameters_LS_234 | DataRaptor Transform Action | If the appointment is on the Lightning Scheduler, then the appointment data is mapped to attribute values for the cancelAppointment API method. | HealthCloudIAMTransformLSParameters |
| DR-TransformParameters_EHR_234 | DataRaptor Transform Action | If the appointment is on an external scheduling system, then the appointment data is mapped to attribute values for the cancelAppointment API method. | HealthCloudIAMTransformEHRParameters |
| CancelAppointmentRemoteAction | Remote Action | Calls the cancelAppointment method from healthcloudext.AppointmentBookingSelfServiceWrapper to cancel the selected appointment. |
Remote Class: healthcloudext.AppointmentBookingSelfServiceWrapper Remote Method: cancelAppointment |
| AppoinmentCancelled | Step | Displays a confirmation that the appointment is canceled. | None |
| NavigateAction | Navigate Action | Restarts the OmniScript and takes the user back to the list of past and remaining upcoming appointments. | None |
View Your Benefits
To edit the benefits self-service flow, open the OmniStudio app, go to the OmniScripts page, expand the healthCloudIAM/viewBenefits OmniScript, and open the highest version.
| Component Name | Component Type | What It Does | What It Calls |
|---|---|---|---|
| DR-GetMemberPlans_234 | DataRaptor Extract Action | Retrieves the active and inactive insurance plans associated with the user's account. | HealthCloudIAMExtractMemberPlans |
| Your_Benefits | Step | Displays the active and inactive insurance plans for the user. | None |
| DR-GetCoverageBenefit_234 | DataRaptor Extract Action | Fetches the latest record from CoverageBenefit. | HealthCloudIAMExtractCoverageBenefit |
| Benefit_Details | Step | Displays benefit details in a FlexCard. | None |