Gazelle FHIR Validator provides
Create the database to be used by the tool. Execute createdb -U gazelle -E UTF8 gazelle-fhir-validator.
From version 3.0.0, Gazelle Fhir Validator only runs on a Wildfly 10 server.
If your do not have yet a Wildfly server, you can install one using the instructions to install Wildfly 10 page.
A new R4 profile has been implemented in the FhirValidator project to manage two differents versions of FHIRValidator on the same machine (R4 and DSTU3).
You are now ready to deploy the tool and to start the Jboss server:
YOUR_TOOL_DATASOURCES : FhirValidatorDS
YOUR_TOOL_DB : gazelle-fhir-validator
Since version 4.1.0, Gazelle FHIR Validator uses a new version of the HAPI library. In order to deploy it on a Wildfly server, the following JARs are required in the server file system :
Please refer to General > wildfly10 part on how to setup PostgreSQL where a module addition is documented.
A project you can use to deploy a FHIR server using HAPI FHIR JPA validation with the npm implementation support : https://github.com/ahdis/hapi-fhir-jpaserver-starter/tree/ig.
SQL script files available in the project directory imports entries to use the structure definitions and value sets defined by IHE. In order to use them, you can checkout the content of fhir-structure-definitions directory from Inria’s forge into /opt/fhirvalidator folder. It is the default location used by the tool. This can however be changed by updating the path to each custom structure definition in the database.
The endpoint to be contacted will be located at [YOUR_SERVER_URL]/FhirValidator-ejb/ModelBasedValidationWSService/ModelBasedValidationWS?wsdl.
The graphic user interface is available at [YOUR_JBOSS_URL]/GazelleFhirValidator.
Under the Administration menu, you will find a sub-menu entitled “Configuration”. The following preferences must be updated according to the configuration of your system. The table below summarizes the variables used by the Gazelle FHIR Validator tool.
| Variable | Description | Default value |
|---|---|---|
| application_url | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | https://publicUrlOfJboss/GazelleFhirValidator |
| application_issue_tracker | Link to the issue tracker where users can report issues (used in the footer of the app) | https://gazelle.ihe.net/jira/browse/FHIRVAL |
| application_release_note_url | Link to the release note of the tool (used in the footer of the app) | https://gazelle.ihe.net/jira/browse/FHIRVAL |
| contact_email | The email of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| contact_name | Name of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| contact_title | Function of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| documentation_url | Link to the user manual (used in the footer of the tool) | https://gazelle.ihe.net/gazelle-documentation/Gazelle-FHIR-Validator/user.html |
| NUMBER_OF_ITEMS_PER_PAGE | Default number of entries in tables | 20 |
| structure_definition_stylesheet_location | URL of the XSL used to display the structure definition | https://gazelle.ihe.net/xsl/fhir/structureDefinition.xsl |
| time_zone | Default time zone to be used to display dates and times | Europe/Paris |
| value_set_location | Where the tool accesses the value sets to be loaded | /opt/fhir-structure-definition/ValueSet |
| code_system_location | Where the tool accesses the code systems to be loaded | /opt/fhir-structure-definition/CodeSystem |
| ig_fhir_server_url | URL of the Fhir Server used for validation | http://localhost:8080/hapi-fhir-jpavalidator/fhir |
There are additional preferences to configure the SSO authentication.
| Preference name | Description | Example of value |
|---|---|---|
| cas_enabled | Enable or disable the CAS authentication. | true |
| ip_login | Enable authentication by IP address matching ip_login_admin regex. |
false |
| ip_login_admin | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
For more documentation about SSO configurations, follow the link here.
As of version 2.2.0, two types of validators can be defined:
Structure definition files shall be loaded directly on the file system. Future versions will allow the administrator to upload all the necessary files.
When structure definitions and/or value sets are added, removed or modified, you need to use the “Reload structure definitions” button. It will destroy the snapshots of the structure definitions stored in memory and load them again.
Since version 4.0.1, R4 version of Resource Validators are mandatory.
Deploy the FHIR server used for validation that is available here.
You can change which implementation guides are loaded by modifying the hapi.properties file.
Then be sur to correctly set the ig_fhir_server_url property to point to the deployed server. The validators are ready !
Gazelle FHIR Validator makes use of several kind of validation engines:
The configuration of each kind of validations will slightly differs.
For some interactions, like search or read, FHIR uses HTTP operation, in that case the initiator system build a URL. Examples:
GET [base]/[type]?name=value&...{&_format=[mime-type]}}POST [base]/[type] {?_format=[mime-type]}DELETE [base]/[type]/?[search parameters]Gazelle FHIR Validator allows the test designer to describe this syntax which is then processed by an algorithm to detect errors in the provided URL.
For each parameter, the following attributes are used:
The name of the validators uses the following pattern: [TRANSACTION-KEYWORD] Message name where: