Analyze the FHIR Repository for SQL Builder

The goal of analyzing your FHIR Repository is to summarize the available structural relationships, constituent elements, and embedded collections of the repository. It forms the basis for defining a transformation specification by outlining how various elements are related to one another and providing a range of values you can expect for a given element. The analysis task does not need to look at every record in the repository; is up to you to decide the size of the sample that you will analyze.

To configure an analysis:

1. Click New on the right side of the Analyses section to open the New FHIR Analysis dialog.

2. Select a repository from the dropdown. To create a new repository:

   Click New to the right of the field to open the New FHIR Repository Configuration dialog:

   Name

   Enter a name for the repository.

   Host

   Enter the DNS name or IP address of the host where the repository you wish to analyze is hosted.

   Note:

   If the Builder UI and the repository are on the same instance, you can use localhost. If the Builder and the repository are on different instances, keep in mind the following:

   • Hostnames which are assigned to a network’s internal IP addresses may fail to resolve if your network changes. In many cases, clearing your DNS resolver cache can help to reestablish a connection.

   • An application within a Docker container cannot use localhost to access an application outside of that container. See Accessing Endpoints Elsewhere.

   Port

   Enter the port used to access the repository.

   SSL Configuration

   If you are using SSL, select the SSL configuration you want to use. For information about creating a new SSL configuration, refer to “Create or Edit a TLS Configuration” in About Configurations.

   Otherwise, leave this blank.

   Credentials

   Select credentials from the drop-down list or create new credentials by clicking the New button to the right of the field to open the New Credentials dialog. Fill out this dialog as follows

   • Name – Enter a name for this credentials object.

   • Username – Enter the username. This must be the name of a User on the current instance. To see a full list of the available names, open the Management Portal and navigate to System Administration > Security Management > Users.

   • Password – Enter the password.

   • Click Save to return to the New FHIR Repository Configuration dialog.

   Important:

   The user account you specify with a FHIR Repository must also be assigned to the FSB_Admin role.

   FHIR Repository URL

   Select a repository from the drop-down list. When the values entered for Name, Host, Port, and Credentials establish a valid connection, this field provides a list of available FHIR repositories.

   Click Save to return to the New FHIR Analysis dialog

3. Fill out the other fields in the dialog:

   Selectivity Percentage

   Limits analysis to a percentage of the FHIR repository. If used, Maximum Records cannot be used.

   Maximum Records

   Limits analysis to a maximum number of records in the FHIR repository. If used, Selectivity Percentage cannot be used.

   Defer Start of Task

   Select this check box to run the analysis task at a later point in time. If selected, enter a Start Date and a Start Time.

4. Click Launch Analysis Task to start analyzing the FHIR repository.

You will see the newly started analysis on the list of analyses on the Builder home page. Columns provide the following information: