Bulk FHIR Roles and Resources

The Bulk FHIR Coordinator employs role-based access:

Bulk FHIR Roles

The Bulk FHIR Coordinator offers the following user roles:

%HS_BFC_Exporter

The %HS_BFC_Exporter role has the following permissions:

View and perform Patient or Group exports on configurations where the user is listed as an authorized user.
Pause, stop, resume, or cancel those exports, and view and download logs for those exports.

Assign this role to each dummy InterSystems IRIS user that you create to match your OAuth client configurations (in addition to making the dummy user an authorized user for the configuration). See the Important callout in Creating or Editing a Bulk FHIR Configuration for information about dummy InterSystems IRIS users.

Because %HS_BFC_Exporter is intended primarily for the dummy user that maps roles to an OAuth client , a user with only this role cannot access the Bulk FHIR Coordinator home page through the Management Portal menu. If you assign this role to a real user, either make the BFC foundation namespace the user’s startup namespace, or provide the user a direct link to the BFC home page in the portal.

When combined with the %HS_BFC_Export_Manage role, this user can initiate Patient or Group exports on all configurations, and view and download logs for exports that the user initiates. They can also access the home page in the portal.

%HS_BFC_Export_Manage

The %HS_BFC_Export_Manage role has the following permissions:

View all configurations and all exports.
Cannot create configurations, initiate exports, or view export logs.

Can be combined with %HS_BFC_Exporter to expand privileges.

%HS_BFC_Administrator

The %HS_BFC_Administrator role has the following permissions:

View, create, edit, copy, and delete all configurations.
Perform system exports on any configuration that supports them.
View, pause, stop, resume, cancel, and view or download logs for all exports.
Download exports that the user initiates.

When combined with %HS_BFC_Download_Manage, can download files from all exports.

%HS_BFC_Download_Manage

The %HS_BFC_Download_Manage role has the following permissions:

Download files from all exports.

Use to expand the privileges of %HS_BFC_Administrator.

Navigate to Home > Security > Roles to view the resources and privileges associated with these roles.

Bulk FHIR Resources and Privileges

Actions within the Bulk FHIR Coordinator are associated with the following privileges:

Resource	Privileges
%HS_BFC_Configuration	W — create, edit or delete configurations R — view configurations
%HS_BFC_Download_Manage	U — download files created by exports which were started by any user
%HS_BFC_Export_Download	U — download files created by exports which were started by the current user only
%HS_BFC_Export_Group	U — start a group export
%HS_BFC_Export_Log	R — view logs for exports which were started by the current user
%HS_BFC_Export_Manage	U — view, pause, stop, and resume exports in progress which were started by any user
%HS_BFC_Export_Patient	U — start a patient export
%HS_BFC_Export_Status	R — view exports started by the current user W — pause or cancel exports started by the current user
%HS_BFC_Export_System	U — start a system export
%HS_BFC_Log_Manage	U — view logs for exports which were started by any user

You can also find a description of these resources and privileges by navigating to Home > Security > Resources.

Creating an OAuth 2.0 Server for the Bulk FHIR Coordinator

Performing a Bulk FHIR Export from a REST Client