Accessing FHIR SQL Builder
To access the FHIR SQL Builder, first ensure that the web applications are enabled. Then you can navigate to the Builder home page as user with a valid role.
The FHIR SQL Builder Web Apps
If your license key is in place before the installation of your InterSystems product finishes, the web applications that implement the Builder will already be enabled. Otherwise, you will need to manually enable them. On the instance that is running the Builder:
-
In the Management Portal, go to System Administration > Security > Applications > Web Applications.
-
On the Web Applications page, enable the applications /csp/fhirsql and /csp/fhirsql/api/ui by selecting the name of the application, which opens the Edit Web Application page.
-
On the General tab of the Edit Web Application page, click the Enable Application check box and then click Save.
The FHIR SQL Builder is designed to work with FHIR repositories across different instances of InterSystems products. On each instance that runs a FHIR server, follow the steps above to enable /csp/fhirsql/api/repository. Only one instance should have the /csp/fhirsql/api/ui API enabled, but any number of instances can have the /csp/fhirsql/api/repository API enabled.
FHIR SQL Builder Home Page
Once the web apps have been properly enabled, you will be able to open the Builder.
-
The URL has the following form, using the <baseURL> of your instance:
<baseURL>/csp/fhirsql/index.html#/
Starting the FHIR SQL Builder application brings you to the home page. The work area is divided into sections which let you configure the Analyses, Transformation Specifications, and Projections of your repository.
FHIR SQL Builder Roles
Users that access the Builder must be assigned to one of the pre-configured FHIR SQL Builder roles:
Allows a user to access the FHIR SQL Builder application. It also allows a user to query a FHIR SQL projection table if the user has been added as a package user for the projection table.
Provides the privileges of FSB_Analyst and also allows a user to launch an analysis of a FHIR Repository, manage transform specifications for a FHIR SQL projection table, and create and manage FHIR SQL projection tables.
Provides the privileges of FSB_Data_Steward and also allows a user to create a new FHIR Repository configuration for analysis.
Users who are not assigned one of these roles encounter a 403 error when they attempt to access the FHIR SQL Builder. For more information about assigning roles to users in InterSystems products, see Managing Roles.
