diff --git a/EPR-Access-Token-Provider/Makefile b/EPR-Access-Token-Provider/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/EPR-Access-Token-Provider/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/EPR-Access-Token-Provider/release-note.md b/EPR-Access-Token-Provider/release-note.md
new file mode 100644
index 0000000000000000000000000000000000000000..589d90d8600dcf67c37e6f9ae00171f5e094964d
--- /dev/null
+++ b/EPR-Access-Token-Provider/release-note.md
@@ -0,0 +1,21 @@
+---
+title: Release note
+subtitle: EPR Access Token Provider
+toolversion: 1.0.0
+releasedate: 2020-09-04
+author: Wylem BARS
+function: Software Engineer
+customer: IHE Europe
+reference: KER1-RNO-IHE-EPR_ACCESS_TOKEN_PROVIDER
+---
+
+# CH:IUA Access Token Provider 1.0.0
+_Release date: 2020-08-28_
+
+__Story__
+* \[[IUAINFRA-31](https://gazelle.ihe.net/jira/browse/IUAINFRA-31)\] Provide dummy JWS Access token for CH:IUA
+* \[[IUAINFRA-52](https://gazelle.ihe.net/jira/browse/IUAINFRA-52)\] Expose Dummy Authz Server as Webservice
+* \[[IUAINFRA-53](https://gazelle.ihe.net/jira/browse/IUAINFRA-53)\] Add aerne Patient in the Access Token Provider
+
+__Task__
+* \[[IUAINFRA-30](https://gazelle.ihe.net/jira/browse/IUAINFRA-30)\] Simple IUA Access Token Provider Model and API
diff --git a/EPR-Access-Token-Provider/user.md b/EPR-Access-Token-Provider/user.md
new file mode 100755
index 0000000000000000000000000000000000000000..4a927cd6912056351854fc76cd51878e750cdbfd
--- /dev/null
+++ b/EPR-Access-Token-Provider/user.md
@@ -0,0 +1,44 @@
+---
+title: User Manual
+subtitle: Access Token Provider
+author: Wylem BARS
+function: Developer
+releasedate: 02/09/2020
+toolversion: 1.0.0
+version: 0.01
+status: DRAFT
+reference: KER1-MAN-IHE-ACCESS_TOKEN_PROVIDER
+customer: IHE-EUROPE
+---
+
+
+eHealthSuisse Access Token Provider
+-----------------------------------------
+
+ehealthSuisse Access Token Provider is a Dummy rest service providing Token for IUA transactions used in EPR context.
+
+### Data Set
+
+#### Available user ID
+
+| User ID |
+|----------|
+| aamrein |
+| aerne |
+
+Those are the users for whom token can be generated.
+
+### EndPoint
+
+* [Access Token Provider : https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token](https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token)
+
+### Request example
+
+```https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token?userId=aamrein&audienceId=audience```
+
+| Parameter Name | Usage |
+|-------------|-----------------------------------------------------------------------|
+| userId | User for whom the token is generated |
+| audienceId | ID of the audience used to retrieve secret in Gazelle configurations. |
+
+The response body to this request will be the content of the generated token.
diff --git a/Gazelle-FHIR-Validator/installation.md b/Gazelle-FHIR-Validator/installation.md
index 9ffa6e1324701e5adea8b28bb37a182dd63ce703..fe235cff0f3ea57ef92cf063c22d2d747dcd6f8a 100644
--- a/Gazelle-FHIR-Validator/installation.md
+++ b/Gazelle-FHIR-Validator/installation.md
@@ -129,6 +129,7 @@ Gazelle FHIR Validator makes use of several kind of validation engines:
* FHIR library provided by hapi-fhir for default resources
* Custom structure Definitions
+* Use of the FHIR $validate operation on a remote server.
* In-house algorithm for URLs
The configuration of each kind of validations will slightly differs.
diff --git a/Gazelle-HL7-Validator/installation-3.6.0.md b/Gazelle-HL7-Validator/installation-3.6.0.md
deleted file mode 100755
index 83df4bb63356b4f37938e72686ef576f801da298..0000000000000000000000000000000000000000
--- a/Gazelle-HL7-Validator/installation-3.6.0.md
+++ /dev/null
@@ -1,124 +0,0 @@
----
-title: Installation Manual
-subtitle: Gazelle HL7 Validator
-author: Anne-Gaëlle Bergé
-function: Engineer
-date: 13/05/2019
-toolversion: 3.5.x
-version: 1.04
-status: Approved document
-reference: KER1-MAN-IHE-GAZELLE_HL7_VALIDATOR_INSTALLATION-1_04
-customer: IHE-EUROPE
----
-
-# Sources & binaries
-
-To get the name of the latest release, visit the Gazelle HL7 Validator project in *JIRA* and consult the "Change log" section.
-
-A maven artifact is published in our Nexus repository each time we release the application. You can use it, but be aware that the link to the database is hardly expressed within the artifact so you will have to use the same database name, hosted in the server running Jboss, and with the same owner (and password).
-
-To get the artifact on Nexus browse:Â *https://gazelle.ihe.net/nexus/index.html\#nexus-search;gav~~GazelleHL7v2Validator-ear~~~*Â and download the latest version.
-
-If you rather want to build the project by yourself, you must checkout the latest tag and package it. You may want to create a new profile to customize your build.
-
-1. Checkout the latest tag available on Inria’s gitlab: *git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/applications/test-execution/validator/GazelleHL7Validator.git*
-
-2. \[Optional\] Edit the pom.xml file and create a new profile
-
-3. Package the application: `mvn \[-P profile\] clean package`
-
-4. The EAR is available at GazelleHL7v2Validator/GazelleHL7v2Validator-ear/target/GazelleHL7v2Validator.ear
-
-# Step by step installation
-
-First, please consider reading the General installation manual for Jboss 7.2.0 AS.
-
-## Database configuration
-
-If you use the artifact available on Nexus or if you have not change this parameter in the pom.xml file, create a database named gazelle-hl7-validator, owned by the user gazelle.
-
-```
-$ createdb -U gazelle -E UTF8 gazelle-hl7-validator
-```
-
- **WARNING** : From version 3.5.0, datasources have been extracted from the **ear**. The template file can be found in /src/main/datasource in the source or in the file GazelleHL7v2Validator-ear-X.X.X-datasource.zip from the nexus.
-For more informations about how to manage that externalization, please refer to [general considerations for JBoss7](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html).
-
-Datasource name : GazelleHL7v2ValidatorDS
-
-Database name : gazelle-hl7-validator
-
-
-## Deploy the application
-
-* Copy EAR to the deploy folder of JBoss 7.2.0 AS(do not forget to change its name to GazelleHL7v2Validator.ear)
-* Start Jboss ⇒ *sudo service jboss start*
-* Wait until the application has been completly deployed and configure the database running the SQL script for set-up.
-
-## Initialize the application
-
-You first need to initialize the database with some data available in a SQL script. If you have checked out the project, the script is available in *GazelleHL7v2Validator-ear/src/main/sql/import.sql*.
-
-__IMPORTANT NOTICE__: Before to apply this script into your database, open it and replace the 'to be defined.' values to be inserted in the oid_generator table by the root OIDs defined for your instance of the tool. Be carefull and keep the final dot.
-
-Otherwise, download it from Inria’s forge (See Sources section)
-
-Before executing the script, open the file and checked the various preferences to be inserted in the app\_configuration table, especially the cas\_url, application\_url and other preferences relative to the user authentication (see Application configuration section). **Context path for deployment is /GazelleHL7Validator**.
-
-Finally, execute the script:Â
-
-```
-$ psql -U gazelle gazelle-hl7-validator < import.sql
-```
-
-To take those parameters into account, you need to restart either the whole Jboss ```sudo service jboss7 restart```, either only the application (```$ touch GazelleHL7v2Validator.ear``` in the deploy folder of Jboss)
-
-# Application configuration
-
-Use the Administration menu, you will find a sub-menu entitled "Configure application preferences". The following preferences must be updated according to the configuration of your system. The table below summarizes the variables used by the Gazelle HL7 Validator tool.
-
-| Variable | Description | Default value |
-|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
-| application\_issue\_tracker\_url | The URL of the bug tracking system where to post issues | https://gazelle.ihe.net/jira/browse/HLVAL |
-| application\_url | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | http://publicUrlOfJboss/GazelleHL7Validator |
-| cas\_url | If you intent to use a CAS, put its URL here | https://gazelle.ihe.net/cas |
-| force\_stylesheet | HL7MessageProfiles and HL7 resources are XML files displayed with a stylesheet declared in the file and referenced on gazelle.ihe.net. To avoid cross-site references, most browsers do not follow those links and as a consequence do not display the XML file correctly. This property tells the tool to change the link to the stylesheet before sending the file to the client | true |
-| gmm\_hl7messageprofile\_wsdl | Access Hl7MessageProfile webservice exposed by GMM (or TM configured to work also as GMM) | https://gazelle.ihe.net/gazelle-gmm-gazelle-tm-ejb/Hl7MessageProfile?wsdl |
-| gmm\_iheconcepts\_wsdl | Access IHEConcepts web service exposed by GMM (or TM configured to work also as GMM) | http://131.254.209.12:8080/gazelle-gmm-gazelle-tm-ejb/IHEConcepts?wsdl |
-| hl7\_directory | Absolute path of the directory where data (HL7 profiles and tables) are stored | path to Data
-|Â hl7\_profiles\_directory | Relative path (from the hl7_directory) of the directory where XML files representing the message profiles in Gazelle format are stored (used as a basis for updating the database, might be a folder sync with the forge) | example : /HL7MessageProfiles/ProfilesPerOid | $PathToDataProject$/ProfilesPerOid |
-| hl7\_profile\_xsd | Location of the schema for verifying the structure of the XML message profiles. | path to HL7MessageProfileSchema.xsd |
-| hl7\_resource\_xsd | Location of the schema for verifying the structure of the XML resources. | path to HL7TableSchema.xsd |
-| hl7\_table\_directory | Relative path (from the hl7_directory) of the directory where XML files are stored (used as a basis for updating the database, might be a folder sync with forge) | example : /HL7Tables/TablesPerOid |
-| IGAMT\_directory | Relative path (from the hl7_directory) of the directory where XML files representing the message profiles in IGAMT format are stored | example : /HL7IgamtProfiles/ProfilesPerOid
-| jar_path | Location of the GVT jar | path to gvt-validation-jar-jar-with-dependencies.jar
-| length\_is\_an\_error | how to behave when an error on length is encountered | false |
-| NUMBER\_OF\_ITEMS\_PER\_PAGE | How many items are displayed in a datatable element by default | 20 |
-| profile\_xsl\_url | used if force\_stylesheet = true | link to the stylesheet (FDQN must be the same as for the application) |
-| report\_xsl\_location | link to the stylesheet for displaying reports | https://gazelle.ihe.net/xsl/hl7Validation/resultStylesheet.xsl |
-| resource\_xsl\_url | used if force\_stylesheet = true | link to the stylesheet (FDQN must be the same as for the application) |
-| svs\_repository\_url | URL to the Gazelle value set repository. Used to check codes in HL7v3 validation service | https://gazelle.ihe.net |
-| time\_zone | Used to display date/time in the appropriate time zone | Europe/Paris |
-| value\_is\_an\_error | how to behave when an error on data value is encountered | false |
-| xsd\_directory\_location | where to find the XSD files for HL7v3 validation service | example : /home/gazelle/xsd/HL7V3/NE2008/multicacheschemas |
-| xcpd\_plq\_xsd\_location | where to find the XSD files for XCPD/PLQ validation service | example : /home/gazelle/xsd/IHE/XCPD\_PLQ.xsd |
-
-# Home page
-
-The first time you access the application, you may notice that the home page of the tool is not configured. To set a title and a welcome message, log into the application with admin rights.
-
-Note that you will have to set up this page for all the languages supported by the application.
-
-# Upload of the documentation of the model-based validation service (for HL7v3 messages)
-
-The administrator is able to configure the documentation of XDS/DSUB constraints and rules
-
-First the user shall be logged in as an administrator.
-
-Then, go to administration -> Constraints Management -> Constraints-admin
-
-
-
-The user shall then upload the XML file generated from the model of constraints into the tool by using the add button from the previous page.
-
-After the upload is ended, click on the button "Delete and Generate". This button will delete all the constraints related to packages that are mentioned into the uploaded XML file. If there are some constraints related to other packages, they won’t be deleted. The information into the XML document is inserted in the database of the tool.
diff --git a/Gazelle-HL7-Validator/installation.md b/Gazelle-HL7-Validator/installation.md
index 5918891679610a44dfc8ac63081ad6ad7299c00c..e6b205fee0a15bc83779b4c4614839dd364f1eb6 100755
--- a/Gazelle-HL7-Validator/installation.md
+++ b/Gazelle-HL7-Validator/installation.md
@@ -4,7 +4,7 @@ subtitle: Gazelle HL7 Validator
author: Anne-Gaëlle Bergé
function: Engineer
date: 13/05/2019
-toolversion: 3.5.x
+toolVersion: 3.6.x
version: 1.04
status: Approved document
reference: KER1-MAN-IHE-GAZELLE_HL7_VALIDATOR_INSTALLATION-1_04
@@ -13,15 +13,15 @@ customer: IHE-EUROPE
# Sources & binaries
-To get the name of the latest release, visit the Gazelle HL7 Validator project in *JIRA* and consult the "Change log" section.
+To get the name of the latest release, visit the Gazelle HL7 Validator project in *JIRA* and consult the "Releases" section.
A maven artifact is published in our Nexus repository each time we release the application. You can use it, but be aware that the link to the database is hardly expressed within the artifact so you will have to use the same database name, hosted in the server running Jboss, and with the same owner (and password).
-To get the artifact on Nexus browse:Â *https://gazelle.ihe.net/nexus/index.html\#nexus-search;gav~~GazelleHL7v2Validator-ear~~~*Â and download the latest version.
+To get the artifact on Nexus browse [here](https://gazelle.ihe.net/nexus/#nexus-search;quick~GazelleHL7v2Validator-ear)Â and download the latest version.
If you rather want to build the project by yourself, you must checkout the latest tag and package it. You may want to create a new profile to customize your build.
-1. Checkout the latest tag available on Inria’s forge: svn co *https://scm.gforge.inria.fr/svn/gazelle/Maven/GazelleHL7v2Validator/tags/GazelleHL7v2Validator-$versionName*
+1. Checkout the latest tag available on Inria’s gitlab: *git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/applications/test-execution/validator/gazellehl7v2validator.git*
2. \[Optional\] Edit the pom.xml file and create a new profile
@@ -31,7 +31,20 @@ If you rather want to build the project by yourself, you must checkout the lates
# Step by step installation
-First, please consider reading the General installation manual for Jboss 7.2.0 AS.
+## Requirements
+
+First, please consider reading the General installation manual for Jboss 7.2.0 and reading
+the General installation manual for Gazelle Test Management. It shall be deployed and initialized.
+
+The following tools are required :
+
+| Tool | Version |
+|----------------------------------|----------------------------------|
+| java 7 | zulu 7 / open jkd-7|
+| java 8 |openjdk-8|
+| psql | version 9 |
+
+
## Database configuration
@@ -57,9 +70,9 @@ Database name : gazelle-hl7-validator
## Initialize the application
-You first need to initialize the database with some data available in a SQL script. If you have checked out the project, the script is available in *GazelleHL7v2Validator-ear/src/main/sql/import.sql*.
+You first need to initialize the database with some data available in a SQL scrip,. If you have checked out the project, the scripts are available in *GazelleHL7v2Validator-ear/src/main/sql/*.
-__IMPORTANT NOTICE__: Before to apply this script into your database, open it and replace the 'to be defined.' values to be inserted in the oid_generator table by the root OIDs defined for your instance of the tool. Be carefull and keep the final dot.
+__IMPORTANT NOTICE__: Before to apply this script into your database, open it and replace the __'to be defined.'__ values to be inserted in the oid_generator table by the root OIDs defined for your instance of the tool. Be carefull and keep the final dot.
Otherwise, download it from Inria’s forge (See Sources section)
@@ -68,27 +81,60 @@ Before executing the script, open the file and checked the various preferences t
Finally, execute the script:Â
```
-$ psql -U gazelle gazelle-hl7-validator < import.sql
+$ psql -U gazelle gazelle-hl7-validator < schema-3.6.0.sql
+```
+```
+$ psql -U gazelle gazelle-hl7-validator < init-3.6.0.sql
```
To take those parameters into account, you need to restart either the whole Jboss ```sudo service jboss7 restart```, either only the application (```$ touch GazelleHL7v2Validator.ear``` in the deploy folder of Jboss)
+
+
# Application configuration
+## Gazelle HL7v2 Validator resources
+
+A git repository is available to initialize data resource. You shall create a directory GazelleHL7Validator and checkout the last tag on Inria's GitLab
+`git clone https://gitlab.inria.fr/gazelle/test-content/gazelle-hl7v2-validator-resources.git`
+
+It shall create the correct structure and add required resources.
+
+ Project shall be structured as follows :
+
+
+```
+ gazelle-hl7v2-validator-resources
+ |GVTValidatorResources
+ |gvt-validation-jar-jar-with-dependencies.jar
+ |HL7ConformanceProfile
+ |HL7MessageProfiles
+ |ProfilesPerOid
+ |HL7Tables
+ |TablesPerOid
+ |IGAMTConformanceProfile
+ |see_structure
+```
+
+## Application configuration
+
Use the Administration menu, you will find a sub-menu entitled "Configure application preferences". The following preferences must be updated according to the configuration of your system. The table below summarizes the variables used by the Gazelle HL7 Validator tool.
| Variable | Description | Default value |
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
-| application\_issue\_tracker\_url | The URL of the bug tracking system where to post issues | https://gazelle.ihe.net/jira/browse/HLVAL |
+| application\_issue\_tracker\_url | The URL of the bug tracking system where to post issues | https://gazelle.ihe.net/jira/projects/HLVAL/summary |
| application\_url | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | http://publicUrlOfJboss/GazelleHL7Validator |
| cas\_url | If you intent to use a CAS, put its URL here | https://gazelle.ihe.net/cas |
| force\_stylesheet | HL7MessageProfiles and HL7 resources are XML files displayed with a stylesheet declared in the file and referenced on gazelle.ihe.net. To avoid cross-site references, most browsers do not follow those links and as a consequence do not display the XML file correctly. This property tells the tool to change the link to the stylesheet before sending the file to the client | true |
-| gmm\_hl7messageprofile\_wsdl | Access Hl7MessageProfile webservice exposed by GMM (or TM configured to work also as GMM) | https://gazelle.ihe.net/gazelle-gmm-gazelle-tm-ejb/Hl7MessageProfile?wsdl |
+| gmm\_hl7messageprofile\_wsdl | Access Hl7MessageProfile webservice exposed by GMM (or TM configured to work also as GMM) | https://publicUrlOfJboss/gazelle-gmm-gazelle-tm-ejb/Hl7MessageProfile?wsdl |
| gmm\_iheconcepts\_wsdl | Access IHEConcepts web service exposed by GMM (or TM configured to work also as GMM) | http://131.254.209.12:8080/gazelle-gmm-gazelle-tm-ejb/IHEConcepts?wsdl |
-| Â hl7\_profiles\_directory | Â Directory where XML files are stored (used as a basis for updating the database, might be a folder sync with the forge) | $PathToDataProject$/ProfilesPerOid |
+| hl7\_directory | Absolute path of the directory where data (HL7 profiles and tables) are stored | path to Data, Example /opt/GazelleHL7Validator/gazelle-hl7v2-validator-resources/
+|Â hl7\_profiles\_directory | Relative path (from the hl7_directory) of the directory where XML files representing the message profiles in Gazelle format are stored (used as a basis for updating the database, might be a folder sync with the forge) | example : /HL7ConformanceProfiles/HL7MessageProfiles/ProfilesPerOid | $PathToDataProject$/ProfilesPerOid |
| hl7\_profile\_xsd | Location of the schema for verifying the structure of the XML message profiles. | path to HL7MessageProfileSchema.xsd |
| hl7\_resource\_xsd | Location of the schema for verifying the structure of the XML resources. | path to HL7TableSchema.xsd |
-| hl7\_table\_directory | Directory where XML fies are stored (used as a basis for updating the database, might be a folder sync with forge) | $PathToDataProject$/TablesPerOid |
+| hl7\_table\_directory | Relative path (from the hl7_directory) of the directory where XML files are stored (used as a basis for updating the database, might be a folder sync with forge) | example : /HL7ConformanceProfiles/HL7Tables/TablesPerOid |
+| IGAMT\_directory | Relative path (from the hl7_directory) of the directory where XML files representing the message profiles in IGAMT format are stored | example : /IGAMTConformanceProfiles
+| jar_path | Location of the GVT jar | path to gvt-validation-jar-jar-with-dependencies.jar Example : /opt/GazelleHL7Validator/gazelle-hl7v2-validator-resources/GVTValidatorResources/gvt-validation-jar-jar-with-dependencies.jar
| length\_is\_an\_error | how to behave when an error on length is encountered | false |
| NUMBER\_OF\_ITEMS\_PER\_PAGE | How many items are displayed in a datatable element by default | 20 |
| profile\_xsl\_url | used if force\_stylesheet = true | link to the stylesheet (FDQN must be the same as for the application) |
@@ -106,6 +152,7 @@ The first time you access the application, you may notice that the home page of
Note that you will have to set up this page for all the languages supported by the application.
+
# Upload of the documentation of the model-based validation service (for HL7v3 messages)
The administrator is able to configure the documentation of XDS/DSUB constraints and rules
@@ -118,4 +165,30 @@ Then, go to administration -> Constraints Management -> Constraints-admin
The user shall then upload the XML file generated from the model of constraints into the tool by using the add button from the previous page.
-After the upload is ended, click on the button "Delete and Generate". This button will delete all the constraints related to packages that are mentioned into the uploaded XML file. If there are some constraints related to other packages, they won’t be deleted. The information into the XML document is inserted in the database of the tool.
+After the upload is ended, click on the button "Delete and Generate". This button will delete all the constraints related to packages that are mentioned
+ into the uploaded XML file. If there are some constraints related to other packages, they won’t be deleted. The information into the XML document is inserted in the database of the tool.
+
+# What's new in 3.6.x
+
+ In the new GazelleHL7v2Validator version, few major changes have been released.
+
+ Regard to the GDPR (General Data Protection Regulation), this new version will not store some data anymore. The Database will not store all details from
+ a validation, it will keep only the ID, The validation date, caller ip, the profile oid and the test result.
+
+GazelleHL7Validator is now able to perform validation on a new message profile format : IGAMT profile. This new format is composed of four files : 3 XML files,
+Constraints.xml that describes all constraints and conditions, and ValueSets that contains all values required to perform validation; and one HTML file Display. HL7 Conformance
+format will be migrated in this new format.
+
+In the previous version of GazelleHL7Validator, Message Profiles were stored in the database to perform validation, xml file only were used to update the database.
+ To perform a validation, GVT needs access to three xml files (Constraints, Profile and ValueSets) which compose a Conformance Profile from [IGAMT](https://hl7v2.igamt.nist.gov/igamt/#/home).
+ File now are stored on the disk, each validation needs access to files to perform. Files shall have bee upload in the correct IGAMT directory.
+
+ Also, GazelleHL7Validator now integrates two validator engines : HAPI based engine and General Validation Tool ([GVT](https://hl7v2.gvt.nist.gov/gvt/#/home))
+ from the NIST. This last is executed as an external jar and its path shall be specified in application configuration. Depending on the Message Profile format
+ selected to validate, GazelleHL7v2Validator will use the good one.
+
+
+
+
+
+
diff --git a/Gazelle-HL7-Validator/release-note.md b/Gazelle-HL7-Validator/release-note.md
index a67b6b2f9eb95780dcf93fdd672c4fc14b5de43a..1e93576c5270f9fe2b6936f196d08a4f4d21d35d 100644
--- a/Gazelle-HL7-Validator/release-note.md
+++ b/Gazelle-HL7-Validator/release-note.md
@@ -1,13 +1,31 @@
---
title: Release note
subtitle: Gazelle HL7 Validator
-toolversion: 3.5.1
-releasedate: 10/10/2019
+toolversion: 3.6.0
+releasedate: 28/08/2020
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-GAZELLE_HL7_VALIDATOR
---
+# 3.6.0
+_Release date: 2020-08-28_
+
+__Bug__
+* \[[HLVAL-443](https://gazelle.ihe.net/jira/browse/HLVAL-443)\] EVSClient not showing validation report for HL7v2 validation (HealthLink)
+
+__Story__
+* \[[HLVAL-426](https://gazelle.ihe.net/jira/browse/HLVAL-426)\] Use IGAMT and GVT to perform the HL7v2 validation
+* \[[HLVAL-427](https://gazelle.ihe.net/jira/browse/HLVAL-427)\] Distinguish message profiles (format)
+* \[[HLVAL-428](https://gazelle.ihe.net/jira/browse/HLVAL-428)\] Allow user to view the content of the IGAMT conformance profile
+
+__Task__
+* \[[HLVAL-442](https://gazelle.ihe.net/jira/browse/HLVAL-442)\] Inconsistency in GVT validation report
+
+__Improvement__
+* \[[HLVAL-425](https://gazelle.ihe.net/jira/browse/HLVAL-425)\] Read HL7 message profile / resources from the file system
+* \[[HLVAL-429](https://gazelle.ihe.net/jira/browse/HLVAL-429)\] Do not store validation result anymore
+* \[[HLVAL-431](https://gazelle.ihe.net/jira/browse/HLVAL-431)\] The tool shall automatically detect the encoding of the incoming message
# 3.5.1
_Release date: 2019-10-10_
diff --git a/Gazelle-HL7-Validator/user-3.6.0.md b/Gazelle-HL7-Validator/user-3.6.0.md
deleted file mode 100755
index 91cfb932707da27a92fe4b7afeb031838f44395e..0000000000000000000000000000000000000000
--- a/Gazelle-HL7-Validator/user-3.6.0.md
+++ /dev/null
@@ -1,331 +0,0 @@
----
-title: User Manual
-subtitle: Gazelle HL7 Validator
-author: Anne-Gaëlle Bergé
-function: Engineer
-date: 13/05/2019
-toolversion: 3.5.x
-version: 1.04
-status: Approved document
-reference: KER1-MAN-IHE-GAZELLE_HL7_VALIDATOR_USER-1_04
-customer: IHE-EUROPE
----
-
-# Application overview
-
-GazelleHL7Validator is the part of the Gazelle platform dedicated to the validation of HL7 messages.
-
-HL7v2.x messages are validating against HL7 conformance profiles. The validation engine is based on HAPI libraries as well as the JAR validation module from GVT and the conformance profiles are written by the Gazelle team (helped by NIST).
-
-HL7v3 messages are validating using a model-based engine.
-
-These validation services are available through a web service API so it can be integrated in your application.
-
-If you wish to validate messages occasionally you can use the Gazelle Validation Front-End called [EVS Client](https://gazelle.ihe.net/EVSClient) which puts at your disposal a user interface to validate HL7 messages, CDA documents, XD\* requests and so on.
-
-Concerning HL7v2 validation: the application also gathers the HL7 conformance profiles and the HL7 tables (codes) which can be browsed by any user. For each conformance profile, you will find information about its issuer (actor, domain, transaction) and the message type and HL7 version. Each conformance profile can be bound to one or several HL7 tables which gather a list of allowed values for a given field of the message.
-
-# User interface
-
-As shown on picture below, the [User Interface](https://gazelle.ihe.net/GazelleHL7Validator) provides two validation tools: **HL7v2.x Validation tool** and **HL7v3 Validation tool**:
-
-
-
-**HL7v2.x Validation tool** allows user to browse HL7 messages profiles and resources:
-
-
-
-And **HL7v3 Validation tool** allows user to access to validator documentation:
-
-
-
-Both tools provide the possibility to display the result statistics chart forms:
-
-
-## Browse HL7 message profiles
-
-Select option  of **HL7v2 validation tool** menu.
-
-It will display the list of HL7 messages profiles:
-
-
-
-All the HL7 message profiles available are gathered in the tool. You can either select a profile by its full OID (if known) or put filters on the table columns. Each profile is viewable inline and can also be downloaded.
-
-Click on button  to update the list of message profiles displayed.
-
-## Browse HL7 resources
-
-Select option  of **HL7v2 validation tool** menu.
-
-It will display the list of HL7 resources:
-
-
-
-An HL7 resource is an XML file gathering several HL7 tables.
-
-An HL7 table is uniquely defined by an ID and contains the set of allowed values.
-
-Those tables are referenced in the message profiles and at validation time, the validation engine can check that the value of a given field of the submitted message comes from the set of allowed codes for this field.
-
-As for the message profiles, you can see those tables inline or download them.
-
-## Browse HL7v3 validation service documentation
-
-Select entry  of **HL7v3 validation tool** menu.
-
-It will display the documentation of the constraints expressed in the model-based validation service:
-
-
-
-## Validation statistics
-
-This option is accessible only for Administrator users.
-
-Access from  of **HL7v3 validation tool** menu.
-
-It will display the validation requests received by the tool and the associated results presented in chart forms:
-
-
-
-# Web service API
-
-## Gazelle HL7v2.x validation service
-
-The web service API of the tool offers two methods:
-
-
-* validate(): validates the given message against the given message profiles and sends back a validation report
-* about(): gives information about the running version of the tool
-
-The definition of the web service API is available [here](https://gazelle.ihe.net/GazelleHL7v2Validator-ejb/gazelleHL7v2ValidationWSService/gazelleHL7v2ValidationWS?wsdl).
-
-The validate() method has the following prototype:
-
-**public String validate() **;
-
-
-This method uses an attribute named **ValidationContext**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/ValidationContext.xsd](https://gazelle.ihe.net/xsd/ValidationContext.xsd). It gives information about the HL7 message profile to use for the validation process.Â
-
-Then, there are a String stands for the **message to validate**. The message must use ER7 syntax (ie. pipe-based syntax).
-
-Moreover, we have an other attribute, **xmlValidationMetadata**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/MessageMetadata.xsd](https://gazelle.ihe.net/xsd/MessageMetadata.xsd). By now, this parameter is not used but our intent is to add custom validation. That means that, in addition of the basic Hapi validator, the user will be able to put additionnal validation requests as constraints on field usage, component value...
-
-Depending on the profile format, this method call either the Hapi or the GVT based validator to obtain the validation report.
-
-As we also need the client side of this validation service, we have created a useful **SoapUi** project example available [here](https://gazelle.ihe.net/files/GazelleHL7v2Validator-soapui-project.xml).
-
-Note that this validation tool is also available through the simulators based on HL7v2.x (the messages sent and received by the simulator can be validated) and the [EVSClient](https://gazelle.ihe.net/EVSClient).
-
-## Gazelle HL7v3 validation service
-
-See: [Model-based validation web services](https://gazelle.ihe.net/content/model-based-validation-web-services).
-
-# Bug tracking
-
-Error is human. We try to maintain the message profiles and HL7 tables doing our best but we may do mistakes. If you think there are errors in one/several of our message profiles, please report an issue in our [bug tracking system](https://gazelle.ihe.net/jira/browse/HL7VAL) with mention of the profie OID, error location, appropriate fix and reference to the documentation.Â
-
-
-# HL7 conformance profiles and HL7 tables management
-
-This part of the documentation is dedicated to the manager/administrator of the Gazelle HL7 Validator tool.Â
-
-The validation of HL7v2 messages within the Gazelle platform is based on:
-
-1. **HL7 conformance profiles**: XML files which describe the structure of the HL7 messages, they are constrainable. For each segment, field, component and subcomponent, the usage (required, optional, not allowed...), the cardinality and the datatypes are defined.
-
-2. **HL7 resources**: XML files which declare a set of HL7 tables (kind of value sets). HL7 conformance profiles may reference HL7 table for a field, component or subcomponent, in order to constrain the set of allowed values for this element of the message.
-
-Both HL7 conformance profiles and HL7 resources are stored in the database of the tool along with an OID as well as the links between the conformance profiles and the resources. Note that the conformance profile file only reference the number of the the HL7 table, that means that, for a given conformance profile,the tool must be able to know in which HL7 resources looking for the table.
-
-For each HL7 conformance profile, we need to know to which part of the technical framework, which message it applies. That's why, the HL7 conformance profiles are actually referenced in Gazelle Master Model. This enables us to link a conformance profile to a tuple (Domain, Actor, Transaction, HL7 version, message type \[, order control code\]). GazelleHL7Validator and Gazelle Master Model are two tools which have independent databases; as a consequence, the OID is used as a foreign key and two web services offered by Gazelle Master Model allow us to exchange data between those two applications:
-
-1. **IHEConcepts**: This web service lists the different concepts (domain, actor, transaction) based on other parameters. For instance, you can get the list of all domains, the list of actors involved in a given domain and so on.
-
-2. **Hl7MessageProfile**: This web service offers methods to retrieve the complete list of conformance profiles registered in GMM, a subset of these profiles which match certain parameters (actor, message type, HL7 version...). This web service also offers a method to add a new conformance profile reference into the database of GMM.
-
-The URL of the Gazelle Master Model web services are configurable within the application preferences part of Gazelle HL7 Validator. Make sure to reference the correct instance of Gazelle Master Model.
-
-The following sections detail the different actions you may need to perform to maintain the set of conformance profiles available in your instance of Gazelle HL7 Validator. In order to keep a consistency between the references in Gazelle Master Model and the conformance profiles actually available in Gazelle HL7Validator, only one instance of Gazelle HL7 Validator must be used per instance of Gazelle Master Model.
-
-## OID assignments
-
-HL7 conformance profiles and HL7 tables are assigned OIDs. Remember that an OID must be unique through the world; that means that, the first thing to do when you install a new instance of Gazelle HL7 Validator is to update the root of the OIDs which will be generated by the application. Three OIDs are used which are defined in oid\_generator table:
-
-* One for the conformance profiles
-* One for the HL7 resources
-* One for the validation results (messages)
-
-Currently, no user interface is available to perform this update, you will need to modify those values, manually, in the database.
-
-## Add a new conformance profile
-
-Adding a new conformance profile consists in two things:
-
-
-1. Creating a new reference in Gazelle Master Model
-2. Importing the relative path to the XML file representing the conformance profile to the database of GazelleHL7v2Validator in order to load the content
-
-For an IGAMT profile, the path must lead to the folder containing the xml files (Constraints, Profile and ValueSets) and the html file Display. For files in gazelle format, the path leads directly to the xml file of the profile. In both cases, the path starts from the data folder.
-
-Then select option  of Administration menu (you must be logged in as an administrator).
-
-A form is displayed (see screenshot below). Fill out this form with the information that match the conformance profile you are working with. Note that, first, only the domain drop-down list is displayed, then the list of actors is computed depending on the domain you have selected and finally the transactions will be available depending on the actor/domain pair previously selected.
-Then, select the format of the conformance profile. As you can see on the screenshot below, a button  is available on the right of the "Path" field. This button generate the relative path of the conformance profile according to the format and the OID previously entered as well as the preferences.
-
-
-
-As you can notice it on the screenshot, a button  is available on the right of the "Profile OID" field. Clicking on this button will ask the application to automatically assign an OID to this conformance profile.
-
-Depednding on the profile format, Gazelle HL7 Validator uses HAPI or GVT as validation engine. In the case of HAPI, at validation time, message to validate is converted to a java object. Although all the message structures defined by HL7 are available in HAPI, in some cases, you will need to generate your own java class describing the message and tell the application in which java package it will find it. That is the case when IHE defines a new segment or change the structure of a message.Â
-
-A project called gazelle-hl7-messagestructures available on Gazelle's forge and based on HAPI libraries is available to generate the java classes from the conformance profiles.
-
-Finally, upload the XML file representing the conformance profile. As soon as the form is filled and the file is uploaded a button  is available.
-
-Click on this button, the information will be stored in database and the reference to the profile will be sent to Gazelle Master Model.
-
-***In order to facilitate the management of the registered profiles, we recommend to rename the XML file (on your file system) with the OID assigned to the conformance profile.***
-
-## Add a new resource
-
-Basically, one HL7 resource is registered for each version of HL7. In some cases, you will need to customize a table for a given conformance profile or for a set of conformance profiles. In that case, you may need to register a new resource.
-
-Select option  of Administration menu (you must be logged in as an administrator).
-
-A new form is displayed (see screenshot below).
-
-
-
-As for the conformance profile, you can ask the application to generate an OID. You can also generate the relative path of the resource according to the OID and the preferences thanks to the button  which is available on the right of the "Path" field.
-Once the form is filled out and the XML file is uploaded, click on the button  and the HL7 resource will be stored in database.
-
-
-**Tip for filling out the weight attribute**
-
-When the tool initializes a validation, it retrieves all the HL7 resources linked to the selected conformance profile. Then, at validation time, for each reference to an HL7 table, it browses the selected resources to extract the set of allowed values. We have defined a mechanism of weight which allow us to tell the application in which order it must browse the resources. Actually, it may happen that you have overridden a table defined in several of the selected resources. The resource is the higher weight will be processed first. HL7 resources defined by HL7 have usually a weight equals to 1.
-
-***In order to facilitate the management of the registered resources, we recommend to rename the XML file (on your file system) with the OID assigned to the resource.***
-
-## Link conformance profiles to resources
-
-Select option  of Administration menu (you must be logged in as an administrator).
-
-It will display the page to manage links between profiles and ressources as shown below:
-
-
-
-
-This page is composed of four parts:
-
-* The list of available HL7 resources
-* The list of selected HL7 resources
-* A panel to select a set of conformance profile or a profile knowing its OID
-* A panel which lists the selected conformance profiles
-
-To link HL7 resources to conformance profiles, process as follows:
-
-1. First select the HL7 resource(s) you want to link to a set of profiles. Click on the blue plus icon of each row.
-2. Then, select a set of conformance profile (use filters)
-
-Finally hit the button "Link the profiles displayed below to the selected profiles"
-
-## Update conformance profiles and resources
-
-This section assumes that you have renamed your XML files according to the previous advices; that means that on your file system, you have a set of files named \[profile\_oid\|resource\_oid\].xml. Maintenance will be easier if you store the profiles and resources in two different directories.
-
-It will display the definition of application preferences table and a section entitled ***HL7 message profiles and tables import*** as shown below:
-
-
-
-
-To update the conformance profiles, configure the ***"Path to HL7 message profiles"*** and click on the button . **The path must point to a directory on the server**.
-
-To update the conformance profiles, configure the ***"Path to HL7 tables"*** and click on the button . **The path must point to a directory on the server**.
-
-In both cases, the application browses the given folder and lists all the XML files. For each file, it tries to retrieve the relative conformance profile / resource and compare the date of the file with the date of the last changed.
-
-If the file on disk is newer than the last changed, then, the file will be imported into the database to replace the old content.
-
-
-## How conformance profiles and resources are organized on Gazelle's forge
-
-This section describes how we have chosen to organize the conformance profiles and resources on Gazelle's forge and how they are maintained and managed.
-
-Currently, both IHE Europe development team and the NIST contribute to maintain profiles.
-
-A project is called Data and is available at [https://gforge.inria.fr/scm/viewvc.php/Data/?root=gazelle](https://gforge.inria.fr/scm/viewvc.php/Data/?root=gazelle).
-
-This project is made of two main folders:Â
-
-1. **HL7MessageProfiles**: In this folder, conformance profiles are organized by firstly actor keyword then transaction keyword and finally message type (messageType\_triggerEvent). For instance, you will find the conformance profile for validating the ADT^A28^ADT\_A05 message issued by the Patient Demographic Supplier actor in the context of the ITI-30 transaction at the following location: **PDS/ITI-30/ADT\_A28/profile/ADT\_A28.xml**. A sub-directory of HL7MessageProfiles is named ProfilesPerOid and contains a symbolic link to each profile. Name of the link is the OID assigned to the targeted message profile. In this way, when you want to update a profile you do not have to know its OID and in the same way, when updating the message profiles in the database of the tool, the mapping is correctly performed thanks to the symbolic links.
-
-2. **HL7Tables** contains the HL7 resources all with a meaningful name and a child directory named TablesPerOid which contains a symbolic link to each resource. Name of the link is the OID assigned to the targeted resource.
-
-Finally, this project has been checked out on the server hosting Gazelle HL7 Validator application and is periodically updated; which allows us to easily perform the update of the profiles and resources in the application.
-
-# Manage HL7v3 constraints file
-
-Select option  of Administration menu (you must be logged in as an administrator).
-
-It will display the list of HL7v3 constraints as shown below:
-
-
-
-From there, it’s possible to delete individually each HL7v3 constraint by clicking on the button .
-
-It’s also possible to import an XML file with the constraints written inside. This file must be generated with “Topcased†software from the OCL constraints.
-
-# Manage users accesses
-
-Select option  of Administration menu (you must be logged in as an administrator).
-
-It will display the page that allow the management of accesses for users:
-
-
-
-You can restrict the messages an user is allowed to see in the logs page by editing the user preferences.
-
-By adding an user, you can restrict the allowed IP addresses to constraint this user to see only the messages coming from this IP address.
-
-You can add many IP addresses for a single user.
-
-
-
-# HL7v3 validation service
-
-Gazelle HL7 Validator embeds a web service interface to query the HL7v3 validation service. This validation service has been developed using the model-based engine. All model-based validation service exposes a web service which uses the same definition.
-
-Refers to the *general documentation* if you want to use this service from your application.
-
-This service can be easily called using the [EVS Client](https://gazelle.ihe.net/EVSClient) application:
-
-Start a validation as shown on picture below:
-
-
-
-
-The model has been generated from the HL7v3 schema available at [ftp://ftp.ihe.net/TF_Implementation_Material/ITI/schema/HL7V3/NE2008](ftp://ftp.ihe.net/TF_Implementation_Material/ITI/schema/HL7V3/NE2008/). Constraints have been written in accordance with the IHE specifications available in ITI Technical Framework Appendix O and the section from the ITI Technical Framework volume 2 which deals with the HL7v3 protocol.
-
-The following messages can be validated using this service :Â
-
-* PDQv3 Accept Acknowledgement
-* PDQv3 Patient Demographic Query
-* PDQv3 Patient Demographic Query Cancellation
-* PDQv3 Patient Demographic Query Continuation
-* PDQv3 Patient Demographic Query Response
-* PIXV3 Patient Identity Feed HL7V3 (Add Patient Record)
-* PIXV3 Patient Identity Feed HL7V3 (Revise Patient Record)
-* PIXV3 Patient Identity Feed HL7V3 (Patient Identity Feed)
-* PIXV3 Patient Identity Feed HL7V3 (Acknowledgement)
-* PIXV3 Query
-* PIXV3 Query Response
-* PIXV3 Update NotificationÂ
-* PIXV3 Update Notification Acknowledgement
-* XCPD Cross Gateway Patient Discovery Request
-* XCPD Cross Gateway Patient Discovery Request (Deferred option)
-
-Two additional messages can be validated with this tool though they are not HL7v3 based (but defined in the context of XCPD):
-
-* XCPD Patient Location Request
-* XCPD Patient Location Response
diff --git a/Gazelle-HL7-Validator/user.md b/Gazelle-HL7-Validator/user.md
index e0980d417f8e12b67edeffb49786ed5414774011..d23e74a61bd64a4050bb6491c86fda635bb48804 100755
--- a/Gazelle-HL7-Validator/user.md
+++ b/Gazelle-HL7-Validator/user.md
@@ -15,7 +15,7 @@ customer: IHE-EUROPE
GazelleHL7Validator is the part of the Gazelle platform dedicated to the validation of HL7 messages.
-HL7v2.x messages are validating against HL7 conformance profiles. The validation engine is based on HAPI libraries and the conformance profiles are written by the Gazelle team (helped by NIST).
+HL7v2.x messages are validating against HL7 conformance profiles. The validation engine is based on HAPI libraries as well as the JAR validation module from GVT and the conformance profiles are written by the Gazelle team (helped by NIST).
HL7v3 messages are validating using a model-based engine.
@@ -31,33 +31,16 @@ As shown on picture below, the [User Interface](https://gazelle.ihe.net/GazelleH
-**HL7v2.x Validation tool** allows user to browse validation reports, HL7 messages profiles and resources:
+**HL7v2.x Validation tool** allows user to browse HL7 messages profiles and resources:
-
+
And **HL7v3 Validation tool** allows user to access to validator documentation:
-Both tools provide the possibility to display the validation request and result statistics chart forms:
+Both tools provide the possibility to display the result statistics chart forms.
-## Browse validation requests
-
-Select option  of **HL7v2 validation tool** menu.
-
-It will display the list of validation requests received by the tool and the associated results:
-
-
-
-For each validation request, the tool keeps trace of the IP address of the caller. This is the way we choose to "protect" your work. That means that, using this IP address we can restrain the access to the data you have submitted (message content) and the results of those validations. The access rules are the following:
-
-1. Administrator users have access to all validation requests and are allowed to permanently delete some of them on user requests as shown on picture above.
-
-2. Logged in users (Gazelle CAS) can ask the administrator of the tool to register a set of IP addresses they are allowed to see.
-
-3. Not logged in users have only access to the validation requests coming from the same IP address as the one they are using when browsing the requests:
-
-
## Browse HL7 message profiles
@@ -65,7 +48,7 @@ Select option 
It will display the list of HL7 messages profiles:
-
+
All the HL7 message profiles available are gathered in the tool. You can either select a profile by its full OID (if known) or put filters on the table columns. Each profile is viewable inline and can also be downloaded.
@@ -119,13 +102,16 @@ The definition of the web service API is available [here](https://gazelle.ihe.ne
The validate() method has the following prototype:
-**public String validate(String, String, String) throws SOAPException**;
+**public String validate()**;
+
-The first parameter is **xmlValidationMetadata**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/MessageMetadata.xsd](https://gazelle.ihe.net/xsd/MessageMetadata.xsd). By now, this parameter is not used but our intent is to add custom validation. That means that, in addition of the basic Hapi validator, the user will be able to put additionnal validation requests as constraints on field usage, component value...
+This method uses an attribute named **ValidationContext**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/ValidationContext.xsd](https://gazelle.ihe.net/xsd/ValidationContext.xsd). It gives information about the HL7 message profile to use for the validation process.Â
-The second parameter is **xmlValidationContext**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/ValidationContext.xsd](https://gazelle.ihe.net/xsd/ValidationContext.xsd). This parameter is mandatory since it gives information about the HL7 message profile to use for the validation process.Â
+Then, there are a String stands for the **message to validate**. The message must use ER7 syntax (ie. pipe-based syntax).
-Finally, the third String stands for the **message to validate** itself. The message must use ER7 syntax (ie. pipe-based syntax).
+Moreover, we have an other attribute, **xmlValidationMetadata**, it is an XML formatted String respecting the XSD schema given at [https://gazelle.ihe.net/xsd/MessageMetadata.xsd](https://gazelle.ihe.net/xsd/MessageMetadata.xsd). By now, this parameter is not used but our intent is to add custom validation. That means that, in addition of the basic Hapi validator, the user will be able to put additionnal validation requests as constraints on field usage, component value...
+
+Depending on the profile format, this method call either the Hapi or the GVT based validator to obtain the validation report.
As we also need the client side of this validation service, we have created a useful **SoapUi** project example available [here](https://gazelle.ihe.net/files/GazelleHL7v2Validator-soapui-project.xml).
@@ -137,20 +123,35 @@ See: [Model-based validation web services](https://gazelle.ihe.net/content/model
# Bug tracking
-Error is human. We try to maintain the message profiles and HL7 tables doing our best but we may do mistakes. If you think there are errors in one/several of our message profiles, please report an issue in our [bug tracking system](https://gazelle.ihe.net/jira/browse/HL7VAL) with mention of the profie OID, error location, appropriate fix and reference to the documentation.Â
+Error is human. We try to maintain the message profiles and HL7 tables doing our best but we may do mistakes. If you think there are errors in one/several of our message profiles, please report an issue in our [bug tracking system]( https://gazelle.ihe.net/jira/projects/HLVAL) with mention of the profie OID, error location, appropriate fix and reference to the documentation.Â
# HL7 conformance profiles and HL7 tables management
This part of the documentation is dedicated to the manager/administrator of the Gazelle HL7 Validator tool.Â
-The validation of HL7v2 messages within the Gazelle platform is based on:
+The Hapi validation of HL7v2 messages within the Gazelle platform is based on:
1. **HL7 conformance profiles**: XML files which describe the structure of the HL7 messages, they are constrainable. For each segment, field, component and subcomponent, the usage (required, optional, not allowed...), the cardinality and the datatypes are defined.
2. **HL7 resources**: XML files which declare a set of HL7 tables (kind of value sets). HL7 conformance profiles may reference HL7 table for a field, component or subcomponent, in order to constrain the set of allowed values for this element of the message.
-Both HL7 conformance profiles and HL7 resources are stored in the database of the tool along with an OID as well as the links between the conformance profiles and the resources. Note that the conformance profile file only reference the number of the the HL7 table, that means that, for a given conformance profile,the tool must be able to know in which HL7 resources looking for the table.
+
+The GVT validation of HL7v2 messages within the Gazelle platform is based on 3 files:
+
+1. **Profile.xml** : XML file which describes the structure of the HL7 messages. For each segment, field, component and subcomponent, the usage (required, optional, not allowed...), the cardinality and the datatypes are defined.
+
+2. **Constrain.xml** : XML file which describes the constraints of the HL7 messages (Constraints and Predicates).
+
+3. **ValueSets.xml** : XML file which declares a set of HL7 tables (kind of value sets). HL7 conformance profiles may reference HL7 table for a field, component or subcomponent, in order to constrain the set of allowed values for this element of the message.
+
+4. **Display.html** : HTML file which is used to format the structure of the profile webpage.
+
+
+
+In the previous version of GazelleHL7Validator, Message Profiles and HL7 Tables were stored in the database to perform validation, xml file only were used to update the database. To perform a validation, GazelleValidator needs access to three xml files in both validation. File now are stored on the disk, each validation needs access to files to be performed. The OID of the resource links to the file path.
+
+HL7 conformance profiles and HL7 Tables are linked in the database of the tool with their OID. Note that the conformance profile file only reference the number of the HL7 table, that means that, for a given conformance profile,the tool must be able to know in which HL7 resources looking for the table.
For each HL7 conformance profile, we need to know to which part of the technical framework, which message it applies. That's why, the HL7 conformance profiles are actually referenced in Gazelle Master Model. This enables us to link a conformance profile to a tuple (Domain, Actor, Transaction, HL7 version, message type \[, order control code\]). GazelleHL7Validator and Gazelle Master Model are two tools which have independent databases; as a consequence, the OID is used as a foreign key and two web services offered by Gazelle Master Model allow us to exchange data between those two applications:
@@ -178,23 +179,26 @@ Adding a new conformance profile consists in two things:
1. Creating a new reference in Gazelle Master Model
-2. Importing the XML file representing the conformance profile to the database of GazelleHL7v2Validator
+2. Importing the relative path to the XML file representing the conformance profile to the database of GazelleHL7v2Validator in order to load the content
+
+For an IGAMT profile, the path must lead to the folder containing the xml files (Constraints, Profile and ValueSets) and the html file Display. For files in gazelle format, the path leads directly to the xml file of the profile. In both cases, the path starts from the data folder.
Then select option  of Administration menu (you must be logged in as an administrator).
A form is displayed (see screenshot below). Fill out this form with the information that match the conformance profile you are working with. Note that, first, only the domain drop-down list is displayed, then the list of actors is computed depending on the domain you have selected and finally the transactions will be available depending on the actor/domain pair previously selected.
+Then, select the format of the conformance profile. As you can see on the screenshot below, a button  is available on the right of the "Path" field. This button generates the relative path of the conformance profile according to the format and the OID previously entered as well as the preferences.
-
+
As you can notice it on the screenshot, a button  is available on the right of the "Profile OID" field. Clicking on this button will ask the application to automatically assign an OID to this conformance profile.
-Gazelle HL7 Validator uses HAPI as validation engine. At validation time, message to validate is converted to a java object. Although all the message structures defined by HL7 are available in HAPI, in some cases, you will need to generate your own java class describing the message and tell the application in which java package it will find it. That is the case when IHE defines a new segment or change the structure of a message.Â
+Depending on the profile format, Gazelle HL7 Validator uses HAPI or GVT as validation engine. In the case of HAPI, at validation time, message to validate is converted to a java object. Although all the message structures defined by HL7 are available in HAPI, in some cases, you will need to generate your own java class describing the message and tell the application in which java package it will find it. That is the case when IHE defines a new segment or change the structure of a message.Â
A project called gazelle-hl7-messagestructures available on Gazelle's forge and based on HAPI libraries is available to generate the java classes from the conformance profiles.
Finally, upload the XML file representing the conformance profile. As soon as the form is filled and the file is uploaded a button  is available.
-Click on this button, the file will be stored in database and the reference to the profile will be sent to Gazelle Master Model.
+Click on this button, the information will be stored in database and the reference to the profile will be sent to Gazelle Master Model.
***In order to facilitate the management of the registered profiles, we recommend to rename the XML file (on your file system) with the OID assigned to the conformance profile.***
@@ -206,10 +210,12 @@ Select option  of A
A new form is displayed (see screenshot below).
-
+
-As for the conformance profile, you can ask the application to generate an OID. Once the form is filled out and the XML file is uploaded, click on the button  and the HL7 resource will be stored in database.
+As for the conformance profile, you can ask the application to generate an OID. You can also generate the relative path of the resource according to the OID and the preferences thanks to the button  which is available on the right of the "Path" field.
+Once the form is filled out and the XML file is uploaded, click on the button  and the HL7 resource will be stored in database.
+
**Tip for filling out the weight attribute**
When the tool initializes a validation, it retrieves all the HL7 resources linked to the selected conformance profile. Then, at validation time, for each reference to an HL7 table, it browses the selected resources to extract the set of allowed values. We have defined a mechanism of weight which allow us to tell the application in which order it must browse the resources. Actually, it may happen that you have overridden a table defined in several of the selected resources. The resource is the higher weight will be processed first. HL7 resources defined by HL7 have usually a weight equals to 1.
@@ -257,21 +263,28 @@ In both cases, the application browses the given folder and lists all the XML fi
If the file on disk is newer than the last changed, then, the file will be imported into the database to replace the old content.
-## How conformance profiles and resources are organized on Gazelle's forge
+## How conformance profiles and resources are organized on Gazelle's GitLab
-This section describes how we have chosen to organize the conformance profiles and resources on Gazelle's forge and how they are maintained and managed.
+This section describes how we have chosen to organize the conformance profiles and resources on Gazelle's GitLab and how they are maintained and managed.
Currently, both IHE Europe development team and the NIST contribute to maintain profiles.
-A project is called Data and is available at [https://gforge.inria.fr/scm/viewvc.php/Data/?root=gazelle](https://gforge.inria.fr/scm/viewvc.php/Data/?root=gazelle).
+A project is called gazelle-hl7v2-validator-resources and is available at [Gitlab](https://gitlab.inria.fr/gazelle/test-content/gazelle-hl7v2-validator-resources).
+
+This project is made of three main folders:Â
+
+1. **GVTValidatorResources** : In this folder, the GVT jar need to perform validation with IGAMT profile.
+
+2. **HL7ConformanceProfiles** : In this folder
+
+ 2.1. **HL7MessageProfiles**: In this folder, conformance profiles are organized by firstly actor keyword then transaction keyword and finally message type (messageType\_triggerEvent). For instance, you will find the conformance profile for validating the ADT^A28^ADT\_A05 message issued by the Patient Demographic Supplier actor in the context of the ITI-30 transaction at the following location: **PDS/ITI-30/ADT\_A28/profile/ADT\_A28.xml**. A sub-directory of HL7MessageProfiles is named ProfilesPerOid and contains a symbolic link to each profile. Name of the link is the OID assigned to the targeted message profile. In this way, when you want to update a profile you do not have to know its OID and in the same way, when updating the message profiles in the database of the tool, the mapping is correctly performed thanks to the symbolic links.
-This project is made of two main folders:Â
+ 2.2 **HL7Tables** contains the HL7 resources all with a meaningful name and a child directory named TablesPerOid which contains a symbolic link to each resource. Name of the link is the OID assigned to the targeted resource.
-1. **HL7MessageProfiles**: In this folder, conformance profiles are organized by firstly actor keyword then transaction keyword and finally message type (messageType\_triggerEvent). For instance, you will find the conformance profile for validating the ADT^A28^ADT\_A05 message issued by the Patient Demographic Supplier actor in the context of the ITI-30 transaction at the following location: **PDS/ITI-30/ADT\_A28/profile/ADT\_A28.xml**. A sub-directory of HL7MessageProfiles is named ProfilesPerOid and contains a symbolic link to each profile. Name of the link is the OID assigned to the targeted message profile. In this way, when you want to update a profile you do not have to know its OID and in the same way, when updating the message profiles in the database of the tool, the mapping is correctly performed thanks to the symbolic links.
+3. **IGAMTConformanceProfiles** : In this folder, conformance profiles, generated using IGAMT are organized by firstly actor keyword then transaction keyword and finally message type (messageType\_triggerEvent). For instance, you will find the 3 three xml files for validating the ADT^A28^ADT\_A05 message issued by the Patient Demographic Supplier actor in the context of the ITI-30 transaction at the following location: **PDS/ITI-30/ ADT^A28^ADT\_A05/**
-2. **HL7Tables** contains the HL7 resources all with a meaningful name and a child directory named TablesPerOid which contains a symbolic link to each resource. Name of the link is the OID assigned to the targeted resource.
+IHE profiles are available on the master branch. You need to be on your branch to add new profiles.
-Finally, this project has been checked out on the server hosting Gazelle HL7 Validator application and is periodically updated; which allows us to easily perform the update of the profiles and resources in the application.
# Manage HL7v3 constraints file
diff --git a/Gazelle-SSO/installation.md b/Gazelle-SSO/installation.md
index ae18ecf55b96195094b0ff4abb6d165daf8b3b6a..f1efe82d1cc7aab92e115e3fd6d88fae8bbff0b3 100644
--- a/Gazelle-SSO/installation.md
+++ b/Gazelle-SSO/installation.md
@@ -61,6 +61,8 @@ Probably you want to use AJP connector. You need to uncomment this line and cust
<Connector port="8509" protocol="AJP/1.3" redirectPort="8443" />
```
+Also add `secretRequired="false"` in the AJP configuration.
+
## Download and deploy Gazelle SSO
```
@@ -160,6 +162,20 @@ sudo mkdir /var/log/cas
sudo chown tomcat8:tomcat8 /var/log/cas
```
+### Configure logs
+
+To rotate logs, in /etc/cas/config/log4j2.xml, add the following code in the first `<RollingFile>`, below `</Policies>`:
+```xml
+ <DefaultRolloverStrategy max="5">
+ <Delete basePath="${sys:cas.log.dir}">
+ <IfFileName glob="*.log" />
+ <IfLastModified age="7d" />
+ </Delete>
+ </DefaultRolloverStrategy>
+```
+
+Restart tomcat.
+
## Configure the applications to use this new SSO
Gazelle tools read the configuration of the SSO in a file located in `/opt/gazelle/cas`. We need to create this folder and the configuration file `file.properties`.