Extend the Return to the Workplace solution

This article provides a detailed description of the data model, workflows, and Power Automate flows used by the Return to the Workplace solution. The solution extends the Common Data Model and uses several of its components. Administrators, developers, and users should be mindful of the solution and possible implications of other solutions that coexist in the same environment.

The definitions provided in this article indicate the intended purpose of the tables, relationships, columns, flows, and workflows contained in the Return to the Workplace solution. These definitions can be fully or partially adopted depending on your business requirements.

Integration and extension

The Return to the Workplace solution is built on Microsoft Power Platform. To learn more about working with model-driven apps and Microsoft Dataverse, go to:

• Model-driven apps guide
• Dataverse developer guide
• Dataverse entities
• Work with data using code in Dataverse
• Best practices and guidance for Dataverse
• Business process flows

To learn more about solutions and application lifecycle management (ALM) guidance to maintain the solution integrity, go to:

• Introduction to solutions
• ALM with Microsoft Power Platform

To learn more about supported extension methods, go to:

• Get started with model-driven apps customizations using code

Guidance

Numerous parts of this solution can be extended. The following are a couple of components where we give additional guidance to customize or tailor them.

Copying a canvas app

The canvas app within the solution can be tailored to your needs. We recommend that you copy the canvas app before you make any changes. That way your changes won't be impacted by new versions. To copy a canvas app:

1. Go to Power Apps.
2. Select the Employee Return to the Workplace app, and then select Edit.
3. Select File, and then select Save As. Select a new location and name, and then select Save.

Note

Although it's possible in canvas apps, if you put interactive controls (for example, HTML anchors) into Dataverse to make them render on Return to the Workplace pages, those controls won't appear in natural focus order—making the pages less accessible. Instead, use native canvas apps controls to present any interactive controls.

Security roles

The security roles included in the solution are set up for test and demo purposes. They must be reviewed and understood thoroughly before moving to a production environment or when importing sensitive data.

To learn more about Microsoft Power Platform and Dataverse security, go to:

• Security in Dataverse
• Security roles

New security roles can be created and tailored to your needs. The supplied security roles can serve as a template here that can be copied. If the new roles need to be moved to different environments, they need to be added to a new solution.

In order to copy the security role:

1. Select Settings, and then select Security.
2. Select Security Roles.
3. Select the role you want to copy.
4. Select More actions, and then select Copy Role.

Entity relationship diagram

The entity relationship diagram illustrates the tables and their relationships that are present in the Dataverse environment. System-generated tables, relationships, and columns, such as Created By and Modified By, aren't displayed in the diagram.

The lists of tables in the following sections are grouped by the app in the Return to the Workplace solution.

Core tables

These tables are used across multiple applications and are considered core to the platform.

Table name	Information in the table
Country	Contains standard country names.
Employee	Contains contact information.
Facility	Contains geographic information about a physical place and reopen phase planning progress.
Facility Group	Contains logic grouping metadata used to create a hierarchical relationship of facilities.
Facility Type	Contains metadata used to segment facilities.
Solution Setting	Contains metadata used to drive platform behavior for specific facility groups.
State	Contains standard state names.

Employee Return to the Workplace tables

These tables are used primarily by the Employee Return to the Workplace canvas app.

Table name	Information in the table
Area	Contains a list of physically or logically segmented spaces.
Floor	Contains a list of physically segmented spaces associated to a single facility and multiple areas.
Daily Occupancy	Contains the capacity and occupancy for an area on a certain day.
Employee Attestation	Contains associations of employees to their attestations.
Employee Booking	Contains associations of employees and specific areas, floors, and facilities for a given time.
Employee Facility Search	Contains a list of most recently used employee app facility results associated with system users.
Employee Sentiment	Contains associations of employee and information relevant to their recorded sentiment.
Employee Visit	Contains associations of employee and facilities for a given time representing a physical entry and exit.
Guest Attestation	Contains associations of guests to their attestations
Guest Registration	Contains associations of employees (hosts) and guests that are associated with an Employee Booking.
Vaccination confirmation	Contains vaccination confirmations of employees.
Vaccination type	Contains a list of vaccination types
Solution settings	Contains metadata used to drive platform behavior for specific facility groups.

Workplace Care Management tables

These tables are used primarily by the Workplace Care Management model-driven app.

Table name	Information in the table
Case Contact	Contains individuals associated with an employee case.
Case Facility	Contains facilities associated with employee cases.
Employee Case	Contains associations of employees and information relevant to their case.

Facility Safety Management tables

These tables are used primarily by the Facility Safety Management model-driven app.

Table name	Information in the table
Goal	Contains associations of reopen phases and key metrics with target values.
Key Metric	Contains a list of measurable indications to evaluate progress.
Measurement	Contains a list of key metric values measured at a point in time with relation to a facility.
Readiness Category	Contains metadata used to group readiness factors.
Readiness Check	Contains a list of activities and their status associated with a checklist for a given facility.
Readiness Checklist	Contains a group of activities associated with a facility and a reopen phase.
Readiness Factor	Contains a list of items that are evaluated through the reopening process.
Reopen Phase	Contains a list of associated readiness factors and metrics to be tracked and evaluated at the current stage.
Reopen Phase Transition	Contains a list of requests to move from one phase to another with relevant process information.

Portal tables

These tables are used primarily by the portal extension. This list includes the tables from the other sections that have been changed.

Table name	Information in the table
Contact	Contains individuals and guests.
Employee Booking	Contains associations of employees and specific areas, floors, and facilities for a given time.
Facility	Contains geographic information about a physical place and reopen phase planning progress.
Guest Attestation	Contains associations of guests to their attestations.
Share Guest Attestation	Contains records of attestations that will be emailed to a guest.
Solution Setting	Contains metadata used to drive platform behavior for specific facility groups.

Data definitions

The data definitions section provides information about a list of tables, columns, and the areas of the solution where they're used. The solution column indicates if the field is part of the base solution or if it is added via the portal extension. System-generated columns such as Created On and Modified On aren't displayed.

Access Action

Display name	Column type	Description	Platform use
Employee	Lookup	Used to associate the contact.	Model-driven app and canvas app
Access Status	Option set	Used to set type of access action.	Model-driven app and canvas app
Access Available date	Date time	Set expire date for this record.	Model-driven app
Submitted by	Lookup	Lookup to system user. Used to capture original creator.	Model-driven app
Source	Text	Used to capture source name, defaults to manual when created in model-driven app.	Model-driven app
Notes	Text	Used to capture reason for the block or instructions to the end user.	Model-driven app
Notification	Lookup	Used to associate to a specific notification so notes and body can be synced.	Model-driven app and canvas app

Area

Display name	Column type	Description	Platform use
Area	Text	Primary identifier of the record.	Model-driven app and canvas app
Capacity	Whole Number	Used to capture total allowable occupancy for the area.	Model-driven app and canvas app
Capacity of Current Phase	Whole Number	Used to capture allowable occupancy for the area in the current phase.	Model-driven app and canvas app
Description	Text	Used to capture additional details to describe the area.	Model-driven app and canvas app
Facility	Lookup	Used to associate the parent facility.	Model-driven app and canvas app
Floor	Lookup	Used to associate the parent floor.	Model-driven app and canvas app

Case Contact

Display name	Column type	Description	Platform use
Name	Text	Primary identifier of the record.	Model-driven app
Employee	Lookup	Contact associated with the record.	Model-driven app
Comment	Text	Used to capture details of the possible contact.	Model-driven app
Risk Assessment	Option set	Used to denote the current risk of the case contact.	Model-driven app
Exposure Score	Whole number	Score calculated by case contact suggestion flow.	Model-driven app
Open Case	Lookup	Used to associate an open case for the case contact.	Model-driven app

Case Facility

Display name	Column type	Description	Platform use
Name	Text	Primary identifier of the record.	Model-driven app
Employee Case	Lookup	Used to associate the employee case with the case facility.	Model-driven app
Facility	Lookup	Used to associate the facility with the case facility.	Model-driven app
Comment	Text	Used to capture details on the visits of this facility.	Model-driven app
Date From	Date and time	Used to indicate the period the employee was in the building.	Model-driven app
Date To	Date and time	Used to indicate the period the employee was in the building.	Model-driven app

Country

Display name	Column type	Description	Platform use
Name	Text	User-friendly name of the country.	Model-driven app
ISO Short Code	Text	ISO identifier of the country.	Model-driven app

Daily Occupancy

Display name	Column type	Description	Platform use
Area ID	Lookup	Used to associate an area to the daily occupancy.	Model-driven app and canvas app
Facility ID	Lookup	Used to associate a facility to the daily occupancy.	Model-driven app and canvas app
Capacity	Whole Number	Total capacity for an area.	Model-driven app and canvas app
Occupancy	Whole Number	Occupied spaces for an area.	Model-driven app and canvas app
Date	Date	The date for which the occupancy and capacity are tracked.	Model-driven app and canvas app

Employee (Worker)

Display name	Column type	Description	Platform use	Solution
Assigned Area	Lookup	Could be used to configure a specific area for an employee.	Model-driven app	Base
Company	Text	Used to store the company name of a guest.	Model-driven app and canvas app	Base
Contact Type	Option set	Used to set type of contact (employee, guest).	Model-driven app and canvas app	Base
Default Area	Lookup	Used to store the default area for an employee.	Model-driven app and canvas app	Base
Default Facility	Lookup	Used to associate a facility to the employee.	Model-driven app and canvas app	Base
Host	Lookup	Used to associate an employee to a guest.	Model-driven app and canvas app	Base
User ID	Text	Used to provide a unique identifier specific to the organization for the employee.	Model-driven app	Base
Requires portal access	Two Option	Used to send an invite to the contact.	Model-driven app	Portal
Health and safety plan	Lookup	Used to associate a contact to a health and safety plan.	Model-driven app	Base
Current to plan	Option set	Determines if a contact is current with their health and safety plan. Available options are: No, Yes, Plan not assigned, Plan expired, Plan not started.	Model-driven app	Base

Employee Attestation

Display name	Column type	Description	Platform use
Attestation Date	DateTime	Used to capture the date and time the attestation was recorded.	Model-driven app
Attested	Option Set	Used to capture whether the employee has attested.	Model-driven app and canvas app
Employee	Lookup	Used to denote the employee completing the attestation.	Model-driven app
Facility	Lookup	Used to associate the facility for which the employee is attesting.	Model-driven app and canvas app
Name	Text	Used to create a name for the employee attestation record.	Model-driven app
Employee Booking	Lookup	Used to associate the attestation to an employee booking.	Model-driven app and canvas app
Employee Case	Lookup	Used to associate the attestation to an employee case.	Model-driven app

Employee Booking

Display name	Column type	Description	Platform use
Facility	Lookup	Used to associate the facility booked	Model-driven app and canvas app
Area	Lookup	Used to associate the location booked.	Model-driven app and canvas app
End Arrival Time	DateTime	Used to capture the ending point in time for the booking.	Model-driven app and canvas app
Start Arrival Time	DateTime	Used to capture the beginning point in time for the booking.	Model-driven app and canvas app
Booking Date	Date	Used to determine the date of the booking.	Model-driven app and canvas app
Employee	Lookup	Used to associate the employee creating the booking.	Model-driven app and canvas app
Name	Text	Primary identifier of the record.	Model-driven app

Employee Case

Display name	Column type	Description	Platform use
Case Number	Text	Unique identifier for the employee case.	Model-driven app
Duration in Days	Whole number	Used to capture the number of days a case was open.	Model driven app
Facility Access Available	Option Set	Used to denote whether the employee can get a pass for a facility.	Model-driven app and canvas app
Facility Access Available Date	Date and Time	Used to specify when the employee will be able to get a pass for a facility.	Model-driven app
Employee Instructions	Text Area	Used to give the employee a note on why they are blocked from booking a pass.	Model-driven app and canvas app
Employee	Lookup	Used to associate the employee to the employee case.	Model-driven app
Employee Contacted	Option Set	Used to denote whether the employee was contacted.	Model-driven app
Employee Instructions Provided	Option Set	Used to denote whether the employee was provided instructions.	Model-driven app
Public Health Official Notified	Option Set	Used to denote whether the appropriate public health officials have been notified, if applicable.	Model-driven app
Risk Assessment	Option Set	Used to denote the current risk of the employee case.	Model-driven app
Screened	Option Set	Used to denote whether the screening process has occurred.	Model-driven app
First Time Employee Contacted	Date and Time	Marked by a workflow and used in the Power BI dashboards to track performance.	Model-driven app
First Time to Investigation	Date and Time	Marked by a workflow and used in the Power BI dashboards to track performance.	Model-driven app
Originating Case	Lookup	Used to associate a case to the case where it was created from (via case contacts).	Model-driven app
Process Stage	Text	Indicates the actual process stage of the business process flow.	Model-driven app

Employee Facility Search

Display name	Column Type	Description	Platform use
Employee	Lookup	Used to capture the employee conducting the search.	Model-driven app and canvas app
Facility	Lookup	Used to capture the facility searched.	Model-driven app and canvas app

Employee Sentiment

Display name	Column type	Description	Platform use
Employee	Lookup	Used to capture the employee completing the sentiment.	Model-driven app and canvas app
Name	Text	Used to provide a name for the employee sentiment record.	Model-driven app
Do you feel safe returning to work	Option Set	Used to capture a response to the question: Sad, Neutral, Happy.	Model-driven app and canvas app
Sentiment Date	DateTime	Used to capture the date and time the sentiment was recorded.	Model-driven app

Employee Visit

Display name	Column type	Description	Platform use
Employee Attestation	Lookup	Used to associate an attestation.	Model-driven app
Employee Booking	Lookup	Used to associate a booking.	Model-driven app
Employee	Lookup	Used to associate the employee creating the visit.	Model-driven app
End Time	DateTime	Used to denote the end of the visit.	Model-driven app
Facility	Lookup	Used to denote the facility visited.	Model-driven app
Name	Text	Primary identifier of the record.	Model-driven app
Start Time	DateTime	Used to denote the beginning of the visit.	Model-driven app

Facility

Display name	Column type	Description	Platform use
Address Street 1	Text	Used to provide address information for the facility.	Model-driven app
Address Street 2	Text	Used to provide address information for the facility.	Model-driven app
Address City	Text	Used to provide address information for the facility.	Model-driven app
Address Country	Lookup	Used to associate the standardized state to the facility.
Address Latitude	Text	Used to provide address information for the facility.	Model-driven app
Address Longitude	Text	Used to provide address information for the facility.	Model-driven app
Address Postal Code	Text	Used to provide address information for the facility.	Model-driven app
Address State/Province	Lookup	Used to associate the standardized state to the facility.	Model-driven app
Description	Text	Used to provide address information for the facility.
Entry Window Interval	Option set	Used to set entry window size for employees.	Model-driven app and canvas app
Group	Lookup	Used to associate the group this facility belongs to.	Model-driven app and canvas app
Number	Text	Used to provide a recognizable identifier for the facility.	Model-driven app
Type	Lookup	Denotes the facility type.	Model-driven app
Name	Text	Used to provide a recognizable name for the facility.	Model-driven app and canvas app
Reopen Phase	Lookup	Used to associate the current reopen phase.	Model-driven app and canvas app

Facility Group

Display name	Column type	Description	Platform use
Description	Text	Used to provide additional details about the facility group.	Model-driven app
Name	Text	Used to provide a name for the facility group.	Model-driven app
Parent Facility Group	Lookup	Used to group facilities in a hierarchical manner.	Model-driven app

Facility Type

Display name	Column type	Description	Platform use
Description	Text	Used to provide additional details about the facility type.	Model-driven app
Type	Text	Used to provide a name for the facility type.	Model-driven app

Floor

Display name	Column type	Description	Platform use
Description	Text	Used to capture additional details to describe the floor.	Model-driven app and canvas app
Facility	Lookup	Used to associate the parent facility.	Model-driven app and canvas app
Floor	Text	Primary identifier of the record.	Model-driven app and canvas app
Floor Index	Whole Number	Used to create a structured order of floors within a facility.	Model-driven app and canvas app

Goal

Display name	Column type	Description	Platform use
Key Metric	Lookup	Used to associate the appropriate key metric.	Model-driven app
Name	Text	Used to provide a name for the goal.	Model-driven app
Reopen Phase	Lookup	Used to associate the appropriate reopen phase.	Model-driven app
Target Type	Option Set	The option set values for the target type.	Model-driven app
Target Value	Decimal	The value used to evaluate success.	Model-driven app

Guest Attestation

Display name	Column type	Description	Platform use
Attestation Date	DateTime	Used to capture the date and time the attestation was recorded.	Model-driven app
Attested	Option Set	Used to capture whether the guest has attested.	Model-driven
Guest	Lookup	Used to denote the guest completing the attestation.	Model-driven app
Facility	Lookup	Used to associate the facility for which the guest is attesting.	Model-driven
Name	Text	Used to create a name for the guest attestation record.	Model-driven app
Guest Registration	Lookup	Used to associate the attestation to a guest booking.	Model-driven

Guest Registration

Display name	Column type	Description	Platform use
Employee Booking	Lookup	Used to associate the appropriate employee booking tied to the guest registration.	Model-driven app
Guest	Lookup	Used to associate the non-employee to the registration.	Model-driven app
Host	Lookup	Used to associate the employee making the registration.	Model-driven app
Name	Text	Used to provide a name for the guest registration record.	Model-driven app
Registration Date	Date	Used to denote the date of registration.	Model-driven app

Key Metric

Display name	Column type	Description	Platform use
Name	Text	Used to provide a name for the key metric.	Model-driven app

Measurement

Display name	Column type	Description	Platform use
Facility Group	Lookup	Used to associate the appropriate facility group.	Model-driven app
Facility	Lookup	Used to associate the appropriate facility.	Model-driven app
Key Metric	Lookup	Used to associate the appropriate key metric.	Model-driven app
Measurement Date	DateTime	Denotes the date and time a measurement was taken, displayed in user local format.	Model-driven app
Name	Text	Used to provide a name for the measurement.	Model-driven app
Value	Decimal	Used to capture the value of the measurement.	Model-driven app

Notification

Display name	Column type	Description	Platform use
Employee	Lookup	Used to associate the contact.	Model-driven app and canvas app
Notification Type	Option set	Used to set warning level.	Model-driven app and canvas app
Header	Text	Header text to be displayed or subject line of the email.	Model-driven app and canvas app
Body	Text	Main text of the message.	Model-driven app and canvas app
Send as email	Two option	Checked if notification has to be sent by email.	Model-driven app
Send as push notification	Two option	Checked if the notification has to be sent by push message.	Model-driven app
Read?	Two option	Used to capture if the message has been read by the end user.	Model-driven app and canvas app

Readiness Category

Display name	Column type	Description	Platform use
Category	Text	Used to provide a name for the category record.	Model-driven app

Readiness Check

Display name	Column type	Description	Platform use
Comment	Text	Used to capture additional notes about the readiness check.	Model-driven app and canvas app
Factor	Lookup	Denotes the factor being checked.	Model-driven app and canvas app
Check Completed	Two Options	Denotes completion of the readiness check.	Model-driven app and canvas app
Name	Text	Denotes the readiness check name.	Model-driven app and canvas app
Readiness Checklist	Lookup	Used to associate the readiness check to the applicable readiness checklist.	Model-driven app and canvas app

Readiness Checklist

Display name	Column type	Description	Platform use
Description	Text	Used to provide additional details for this checklist.	Model-driven app
Facility	Lookup	Used to designate the applicable facility for this checklist.	Model-driven app
Name	Text	Denotes the readiness checklist name.	Model-driven app
Reopen Phase	Lookup	Used to designate the applicable reopen phase for this checklist.	Model-driven app

Readiness Factor

Display name	Column type	Description	Platform use
Category	Lookup	Used to group factors by the standard set of category values.	Model-driven app
Description	Text	Used to provide additional details about the readiness factor.	Model-driven app
Factor	Text	The primary name of the readiness factor.	Model-driven app

Reopen Phase

Display name	Column type	Description	Platform use
Capacity Limit Percentage	Decimal Number	Used to scale available capacity in a facility.	Model-driven app
Description	Text	Used to document details about the reopen phase.	Model-driven app and canvas app
Name	Text	The name of the reopen phase.	Model-driven app
Index	Whole Number	Used to provide a logical sequence to reopen phases.	Model-driven app
Process Stage	Lookup	Used to associate a reopen phase to the correct business process flow stage.	Model-driven app

Reopen Phase Transition

Display name	Column type	Description	Platform use
Name	Text	The primary identifier of the record.	Model-driven app
Facility	Lookup	Used to associate the applicable facility.	Model-driven app
Proposed Reopen Phase	Lookup	Used to capture the reopen phase the facility is attempting to transition to.	Model-driven app
Current Reopen Phase	Lookup	Used to capture the current reopen phase of the applicable facility.	Model-driven app
Review Comments	Text	Used to capture notes from the review.	Model-driven app
Reviewer	Lookup	Used to associate the appropriate reviewer to the transition record.	Model-driven app
Review Status	Option Set	Used to denote the current status of the reopen phase transition.	Model-driven app
Summary	Text	Used to provide an additional context for the transition.	Model-driven app

Share Guest Attestation

Display name	Column type	Description	Platform use	Solution
Name	Text	The primary identifier of the record.	Portal	Portal
Recipient	Text	Used to capture email address of the recipient.	Portal	Portal
Language	Text	Used to capture the language used in the e-mail.	Portal	Portal
Guest Attestation	Lookup	Used to associate the guest attestation to share.	Portal	Portal

Share Guest Registration

Display name	Column type	Description	Platform use
Name	Text	The primary identifier of the record.	Canvas app
Facility	Lookup	Used to associate the applicable facility.	Canvas app
Language	Text	Used to capture the language used in the e-mail.	Canvas app
Guest Registration	Lookup	Used to associate the guest registration to share.	Canvas app

Solution Setting

Display name	Column type	Description	Platform use	Solution
Allow Employee Sentiment	Option Set	Disables the employee sentiment survey in the canvas app.	Model-driven app and canvas app	Base
Allow Guest Registrations	Option Set	Indicates if guests are able to register a guest.	Model-driven app and canvas app	Base
Allow on behalf of attestations	option set	Indicates if guest is allowed to register other guest.	Model-driven app	Portal
Allow Storing of Negative Attestations	Option Set	Indicates if you want to store negative attestations.	Model-driven app and canvas app	Base
Allow QR codes	Option Set	Indicates if QR codes are displayed on the pass.	Model-driven app and canvas app	Base
Allow Share Guest Registrations	Option Set	Indicates if sharing of a guest registration is available.	Model-driven app and canvas app	Base
Allow Unauthenticated Guests to Create a Pass	Option Set	Indicates if unauthenticated persons can book a pass on the portal.	Model-driven app	Portal
Company Name	Text	Used to describe the solution settings record.	Model-driven app	Base
Facility Group	Lookup	Links solution settings record to specific facility group.	Model-driven app and canvas app	Base
Health Contact Email	Text	Used to capture the email address of the primary health contact.	Model-driven app and canvas app	Base
Health Contact Instructions	Text	Instructions provided to an employee when they are blocked from booking.	Model-driven app and canvas app	Base
Health & Safety Instructions	Text	Instructions provided to an employee when making a booking.	Model-driven app and canvas app	Base
General Terms & Agreement	Text	Instructions provided to an employee when making a booking.	Model-driven app and canvas app	Base
Guest Health Terms & Agreement	Text	Instructions provided to an employee when registration is for a guest.	Model-driven app and canvas app	Base
Guest Privacy Terms & Agreement	Text	Instructions provided to an employee when registration is for a guest.	Model-driven app and canvas app	Base
Name	Text	The primary name of the setting record.	Model-driven app	Base
Resources Text	Text	Instruction provided to resources when registering on the portal.	Model-driven app and Portal	Portal
Use 24-Hour Format	Option Set	Switches between 24-hour or 12-hour time format on the passes.	Model-driven app and canvas app	Base
Enable vaccination confirmation	Option Set	Enables an employee to submit a vaccination confirmation through the employee app.	Model-driven app and canvas app	Base
Enable manual verification	Option Set	Enables manual verification of a vaccination confirmation. If set to No, the confirmation will be auto approved.	Model-driven app and canvas app	Base
Attestation required	Option Set	Indicates if the employee is required to attest in the General & Health Terms and Conditions pages of the employee app to get a daily pass.	Model-driven app and canvas app	Base
Vaccination confirmation terms and conditions	Option Set	Terms and conditions that an employee will view before submitting a vaccination confirmation.	Model-driven app and canvas app	Base
"Day pass denied" message	Text	Instructions provided when a day pass cannot be issued to a worker.	Model-driven app and canvas app	Base

State

Display name	Column type	Description	Platform use
Name	Text	User-friendly name of the state.	Model-driven app
State Code	Text	ISO identifier of the state.	Model-driven app
Country	Lookup	Association to the parent company.	Model-driven app

Vaccination confirmation

Display name	Column type	Description	Platform use
Name	Text	Identifies the vaccination record. Contains a combination of the following information on the request: employee name, vaccine type, and date of request.	Model-driven app and canvas app
Employee	Lookup	Employee who initiated the vaccine record request.	Model-driven app and canvas app
Vaccination type	Lookup	Vaccination type.	Model-driven app and canvas app
Status reason	Option Set	Status of the vaccination confirmation submission (pending, approved, declined, and expired).	Model-driven app and canvas app
Date of request	Date	Date of vaccination confirmation submission.	Model-driven app and canvas app
Date of last dose	Date	Date when the last vaccine dose was taken.	Model-driven app and canvas app
Vaccination lapse date	Date	Date when the vaccine is set to lapse.	Model-driven app and canvas app
Fully vaccinated?	Option Set	Yes/No flag that identifies whether a worker is fully vaccinated.	Model-driven app and portal app
Proof of vaccination?	Option Set	Yes/No flag that identifies whether a worker has submitted a vaccination document.	Model-driven app and portal app
Name of health care professional or clinic	Text	Name of health care professional or clinic that administered the test	Model-driven app and portal app

Vaccination Type

Display name	Column type	Description	Platform use
Name	Text	Name of the vaccine.	Model-driven app and canvas app.
Manufacturer	Text	Name of the vaccine manufacturer.	Model-driven app and canvas app
Code	Text	Vaccine code - as provided by the public healthcare organization.	Model-driven app and canvas app
Lapse period (days)	Whole Number	The number of days before the vaccine lapses after the last dose.	Model-driven app and canvas app

Test Locations

Display name	Column type	Description	Platform use
Name	Text	Name of test location.	Model-driven app and portal app
School	Lookup	Test location.

Healthcare Service

Display name	Column type	Description	Platform use
Name	Text	Name of the healthcare service.	Model-driven app and portal app

Location Schedules

Display name	Column type	Description	Platform use
Name	Text	Name of the schedule.	Model-driven app and portal app
Location	Lookup	Associated test location that will offer the schedule.	Model-driven app and portal app
Healthcare Service	Lookup	Associated healthcare service at the test location for which the schedule is being set up.	Model-driven app and portal app
Start Date	Date	Start date of the schedule.	Model-driven app and portal app
End Date	Date	End date of the schedule.	Model-driven app and portal app

Slots

Display name	Column type	Description	Platform use
Name	Text	Name of the slot.	Model-driven app and portal app
Slot Capacity	Whole Number	Capacity of the slot; for example, the number of appointments that can be booked in that time period.	Model-driven app and portal app
Start Time Hour	Whole Number	Hour of the time slot start time.	Model-driven app and portal app
Start Time Minute	Whole Number	Minutes of the time slot start time.	Model-driven app and portal app
End Time Hour	Whole Number	Hour of the time slot end time.	Model-driven app and portal app
End Time Minute	Whole Number	Minutes of the time slot end time.	Model-driven app and portal app

Questionnaire

Display name	Column type	Description	Platform use	Solution
Name	Text	Questionnaire name.	Model-driven app and portal app	Base
Healthcare Service	Lookup	Healthcare service that the questionnaire is associated to.	Model-driven app and portal app	Base
Language	Lookup	Language used to display the questions on the portal.	Model-driven app and portal app	Base

Question

Display name	Column type	Description	Platform use	Solution
Question	Text	Identifier for the question.	Model-driven app and portal app	Base
Question Text	Multiline Text	Question text as it will appear to the user on the portal.	Model-driven app and portal app	Base
Questionnaire	Lookup	Questionnaire that the questions are associated with.	Model-driven app and portal app	Base
Question Order	Whole Number	Order of the question in the questionnaire when displayed in the portal.	Model-driven app and portal app	Base
Response Type	Option Set	Type of response answer, such as Yes/No, Text, Date.	Model-driven app and portal app	Base

Health and Safety Plan

Display name	Column type	Description	Platform use	Solution
Name	Text	Name of the health and safety plan.	Model-driven app	Base
Start Date	Date	Start date of the plan.	Model-driven app	Base
End Date	Lookup	End date of the plan.	Model-driven app	Base
Frequency	Option Set	Frequency of testing for a person.	Model-driven app	Base
Healthcare Service	Lookup	Associated healthcare service.	Model-driven app	Base

Appointments

Display name	Column type	Description	Platform use	Solution
Subject	Text	Subject of the appointment.	Model-driven app and portal app	Base
Start Time	Date and Time	Planned start date and time of the appointment.	Model-driven app and portal app	Base
End Time	Date and Time	Planned end date and time of the appointment.	Model-driven app and portal app	Base
Person	Lookup	Person who was administered the test.	Model-driven app and portal app	Base
Healthcare Service	Lookup	Associated healthcare service.	Model-driven app and portal app	Base
Test Location	Lookup	Onsite location that a person's test will be administered at or was administered from.	Model-driven app and portal app	Base
Actual Start Time	Date and Time	Actual start date and time of the appointment.	Model-driven app and portal app	Base
Actual End Time	Date and Time	Actual end date and time of the appointment.	Model-driven app and portal app	Base

Test Results

Display name	Column type	Description	Platform use	Solution
Test Date	Date	Appointment date when the healthcare service was performed.	Model-driven app and portal app	Base
Lab	Date and Time	The associated lab that will process the test specimens.	Model-driven app and portal app	Base
Test Location	Lookup	Onsite location that a person's test will be administered at or was administered from.	Model-driven app and portal app	Base
Appointment	Lookup	The associated appointment for the test result (blank for self-reported test results).	Model-driven app and portal app	Base
Walk In	Option Set	Yes/No flag that identifies whether the person receiving onsite test had a prior appointment.	Model-driven app and portal app	Base
Self Reported	Option Set	Yes/No flag that identifies whether the test was administered onsite or self-reported.	Model-driven app and portal app	Base
Result	Option Set	A test outcome that will be displayed as one of the following values: Positive, Negative, or Inconclusive.	Model-driven app and portal app	Base
Result Interpretation	Text	A description of an interpretation of the test results.	Model-driven app and portal app	Base
Result Date	Date and Time	Date and time for which the test result or outcome was determined.	Model-driven app and portal app	Base
Specimen Code	Text	A field that labs can populate to allow linking a test result to a particular specimen.	Model-driven app and portal app	Base

Related persons

Display name	Column type	Description	Platform use	Solution
Student	Lookup	Student contact that is associated with the parent/guardian.	Model-driven app and portal app	Base
Relationship type	Option set	Describes the relationship type between the student and parent or guardian. Available options are Parent/Guardian and Others. The default value is Parent/Guardian.	Model-driven app and portal app	Base
Parent/Guardian	Lookup	Parent or guardian contact that is associated with the student.	Model-driven app and portal app	Base

Portal invitations

Display name	Column type	Description	Platform use
Name	Text	Name of the portal invitation batch configuration.	Model-driven app
Max number of invitations to send	Whole Number	Number of invitations to send in a batch.	Model-driven app
Invitations in progress	Two Option	Indicates if the process that sends the invitations is currently running.	Model-driven app

Cloud flows

This section describes the different flows in the solution and explains their purpose. These flows can be extended, used, or turned off, depending on your business requirements.

Flow	Table	Description	Solution
Access Action - Reset facility access	Access Action	Deactivates records when past the date in Access available date.	Base
Access Action - Update linked case	Access Action	Updates linked Employee Case via source field when a record is deactivated.	Base
Access Action - Update notification	Access Action	Updates the body of the linked notification when the notes change.	Base
Access Action - Validate and create notification	Access Action	Checks if owner is set to linked employee and creates a notification record.	Base
Area - Update Capacity for future Occupancies	Area	Updates the daily occupancy when there are capacity changes for an area.	Base
Area - Update Capacity of Current Phase	Area	Updates the capacity of a current phase when a capacity changes.	Base
Checklist - Generate Checks	Checklist	Generate checks based on readiness factors linked to the reopen phase.	Base
Checklist - Update Checks	Checklist	Makes readiness checks inactive or active based on status changes of the checklist.	Base
Employee Attestation - Disable Earlier Pass	Employee Attestation	When an employee creates multiple passes on a single day, earlier passes will be disabled.	Base
Employee Booking - Update Daily Occupancy	Employee Booking	Create or update daily occupancy when an employee booking is created.	Base
Employee Booking - Update Daily Occupancy on Status	Employee Booking	Reactivate occupancy in daily occupancy when employee bookings are disabled.	Base
Employee Case - Create Access Action	Employee Case	Creates Access Action blocking the employee when Facility Access Available is set to No.	Base
Employee Case - Create suggestions	Employee Attestation	Creates case contacts when attestation is linked to the case.	Base
Employee Case - Disable Access Action	Employee Case	Deactivates Access Action linked to the Employee Case when Facility Access Available is set to Yes.	Base
Employee Case – Update Access Action	Employee Case	Updates linked Access Action when Facility Access Available Date or Employee Instructions changes.	Base
Employee Case - Update Case Contacts	Case Contact	Deactivates case contact records for an employee if an employee case is created for the employee.	Base
Employee Visit - Name and match to booking or attestation	Employee Visit	Sets the name of the employee visit and matches a visit to bookings and attestations.	Base
Facility - Apply and Update Phase	Facility	Applies a new phase to a facility, which creates a checklist, changes the business process flow, and updates the capacities.	Base
Guest Attestation - Disable earlier pass	Guest Attestation	Disables earlier attestations and guest registrations for that person so number of guests stays correct.	Base
Guest Registration - Disable earlier pass	Guest Registration	Disables earlier registrations for that person on the same day so number of guests stays correct.	Base
Notification - Send as email	Notification	Sends an e-mail to the employee when the notification is set to Yes on Send as email.	Base
Notification - Validate and set correct owner	Notification	Sets owner to correct user record of the employee contact.	Base
Reopen Phase - Update Capacity	Reopen phase	Update capacity when the capacity limits change for a reopen phase.	Base
Reopen Phase Transition - Update facility reopen phase	Reopen phase transition	Updates and changes the reopen phase for a facility.	Base
Share Guest Attestation - Email	Share Guest Attestation	Shares the guest attestation details with the host and the guest.	Base
Share Guest Registration - Email	Share Guest Registration	Shares the guest registration details with the host and the guest.	Base
Share Guest Registration – Email with portal link	Share Guest Registration	Shares the registration details with the host and the guest, but also includes link to the portal to make a guest attestation.	Portal
Vaccination Attestation - Auto-Lapse scheduled flow	Vaccination confirmation	Runs every day to check if any vaccination confirmation have lapsed before that day. For those lapsed vaccination confirmations, the status will be changed to Lapsed.	Base
Vaccination Attestation - Update Employee status and Send Notification	Vaccination confirmation	Sends notification to the employee if vaccination confirmation is either Lapsed or Declined. Additionally, it updates Employee vaccination confirmation status as Active or Inactive if the employee has any Approved confirmation submission.	Base
Child flow - Calculate current to plan value	Worker (Contact)	Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test results.	Base
Child flow - Calculate test results validity	Test results	Determines if a worker's Test results falls within their Health and safety plan. E.g. If a worker is assigned a weekly Health and safety plan, and if the worker's latest Test results Test result date is still within the last 7 days, then the worker is considered as current to their Health & safety plan (i.e. Current to plan = Yes).	Base
Contact - Update current to plan (Triggered)	Worker (Contact)	Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test results. This flow is triggered when a worker record is created or updated.	Base
Contact - Update current to plan status (Scheduled)	Worker (Contact)	Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test results. This flow is Off by default. Additional configurations and testing on this flow are recommended when processing more than 5,000 worker records.	Base
Test attestation - Calculate contact's current to plan status	Test results	Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test results. This flow is triggered when a Test results record is created or updated and their Approval status is Approved.	Base
Test result - Send notification for declined test results	Test results	Creates a notification for a worker when their Test results is denied.	Base
Test results - Auto-approve on creation	Test results	Updates the Test results Approval status to Approved when the Solution Setting - Enable manual verfication of test results is set to No.	Portal
Vaccination Record - On create - Process requests	Vaccination confirmation	Updates the Vaccination confirmation status reason to Approved when the Solution Setting - Enable manual verfication (for vaccination confirmation) is set to No. In addition, it also calculates the Lapsed date of the Vaccination confirmation if the associated Vaccination type has an existing Lapse period (days).	Portal
Access Action - Create notification when unblocked	Access action	This flow is triggered as soon as an existing active Access action on a worker is deactivated. The flow creates a notification record informing workers that they have regained access to a facility.	Base

Sample Data

Initially in the solution, the flows below were provided to generate sample data that will be refreshed for 12 hours. Starting from version 1.3, these flows will no longer be provided. In the future, the flows will be placed on GitHub for use in a demo environments.

Flow	Description
Sample Data - Create and Update Employee Cases	Create employee cases, and move them through different stages.
Sample Data - Generate Employee Records	Create employee bookings and employee attestations.
Sample Data - Generate Facility Transitions	Create reopen phase transitions and move facilities to other phases.
Sample Data - Guest Registrations	Adds five guest registrations on bookings created the same day.
Sample Data - Visits	Create employee visits.

Give feedback about the solution

To provide feedback about the Return to the Workplace solution, go to aka.ms/rtw-community.