diff --git a/docs/installation-guide.md b/docs/installation-guide.md index 7111cbe38d6994931eee66a97ab5eccb2be1edc6..648dbdba57fd8a79e5320c594cb301d83b78e84a 100644 --- a/docs/installation-guide.md +++ b/docs/installation-guide.md @@ -11,15 +11,15 @@ date: 19/10/2021 1. ##### [Introduction](#introduction) 2. ##### [Clone Project](#cloneProject) 3. ##### [Run Tests (Optional)](#runTests) -4. ##### [Generate Artifact](#generateArtifact) -5. ##### [Prepare BBR](#prepareBBR) +4. ##### [Prepare BBR](#prepareBBR) +5. ##### [Generate Artifact](#generateArtifact) 6. ##### [Generate Validator](#generateValidator) 7. ##### [Generation Validator form UML (Alternative)](#generateValidatorFromUML) 8. ##### [Validate CDA](#validateCDA) 9. ##### [Utility Scripts](#utilityScripts) 10. ##### [Extras](#extras) -<div id='introduction'/> +<div id='introduction'></div> ## 1. Introduction In this guide, we will show how to retrieve the new version of **Gazelle Objects Cheker**, @@ -31,7 +31,7 @@ build it and generate a CDA Validator in a generic case, and client specific cas - Thanks to maven wrapper, this version is packaged now with GOC, you can find it in `gazelle-objects-checker/hl7templates/hl7templates-packager-jar/src/main/resources/maven-wrapper` - Git -<div id='cloneProject'/> +<div id='cloneProject'></div> ## 2. Clone Project the project is not maintained by the _forge_ anymore.<br> @@ -92,7 +92,7 @@ You can skip tests if you want, but it's not recommend. -<div id='runTests'/> +<div id='runTests'></div> ## 3. Run Tests (Optional) @@ -123,7 +123,7 @@ If Something went wrong, make sure you have mentioned in maven logs: If not, try to run the creation resources script `CreateResourcesForTest.java` in: - _gazelle-objects-checker/gocmodel-jar/src/main/java/net.ihe.gazelle.goc.script_ -<div id='prepareBBR'/> +<div id='prepareBBR'></div> ## 4. Prepare BBR BBR is an abbreviation of Building Block Repository, a large XML file containing all the functional specifications, @@ -149,7 +149,7 @@ then change **ccda-** by **ccda(version)-** for example for version 2.1: NOTICE: A script could be released for this, due to performance issues -<div id='generateArtifacts'/> +<div id='generateArtifact'></div> ## 5. Generate Artifact @@ -183,7 +183,7 @@ The Artifact is generated at _**gazelle-objects-checker/hl7templates-packager-ja > here: [GOC Artifact Nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~hl7templates-packager) > Choose the latest version, and download the: **hl7templates-packager-jar-X.X.X-jar-with-dependencies.jar** artifact -<div id='generateValidator'/> +<div id='generateValidator'></div> ## 6. Generate Validator This section remains to **run** Gazelle Objects Checker and generate the CDA MBVal validator. @@ -304,9 +304,9 @@ Example with SEQUOIA: - **cmdOutput.log:** contains the Standard Output of executed commands during generation (maven command to init project with archetype, generate code from OLC, packaging...) - **cdeModelsErrors.txt:** contains all detected inconsistencies between the provided BBR and pre-defined models used by GOC - + -<div id='generateValidatorFromUML' /> +<div id='generateValidatorFromUML'></div> ## 7. Generate Validator from UML (Alternative) @@ -314,12 +314,12 @@ This section is just an alternative way to regenerate the validator when the fun without re-running GOC, but just from the generated ```model.uml``` file. ```bash -> cd /home/mylap/Documents/GOC-OUTPUT/[validator-name]-validator-jar/model/[validator-name].uml +> cd /home/mylap/Documents/GOC-OUTPUT/validator/[validator-name]-validator-jar/model/[validator-name].uml ``` for example for epsos5 ```bash -> cd /home/mylap/Documents/GOC-OUTPUT/epsos5-validator-jar/model/epsos5.uml +> cd /home/mylap/Documents/GOC-OUTPUT/validator/epsos5-validator-jar/model/epsos5.uml ``` Then you can edit it with a Text Editor, or a dedicated modeling tool (ex: TopCased). @@ -328,7 +328,7 @@ Then you can edit it with a Text Editor, or a dedicated modeling tool (ex: TopCa Go to GOC-OUTPUT/epsos5-validator-jar and do the following: ```bash -> cd /home/mylap/Documents/GOC-OUTPUT/epsos5-validator-jar +> cd /home/mylap/Documents/GOC-OUTPUT/validator/epsos5-validator-jar > mvn exec:exec@generateValidator -DmvnPath="/opt/apache-maven-3.5.4/bin/mvn" -DcdaProps="cdaepsos" -DprojectName="epsos5" > mvn clean package ``` @@ -352,14 +352,13 @@ Now you can refer to [Section 8](#validateCDA) to Validate a CDA document with y -<div id='validateCDA'/> +<div id='validateCDA'></div> ## 8. Validate CDA Now we are going to use the generated validator.<br> We will suppose we generated a validator with a BBR containing the following version: epsos5-.<br> -_We didn't use the SEQUOIA's BBR because the validator needs a hack (access to SVS) before it could be used_ Open the following directory: ```bash @@ -370,6 +369,23 @@ Open the following directory: > ./validator.sh -path <Path_to_CDA.xml> -out <Path_To_output_result.xml> ``` +For SEQUOIA with version ccda21, you need to adapt it to SVS first, and for that we have a generation script that handle all of that automatically: +```bash +> cd gazelle-objects-checker/hl7templates/hl7templates-packager-jar/target +> ./SEQUOIAGeneration.sh +# or just for adapting SVS you can use the SEQUOIASVSAdaptation.sh +``` + +Then: + +```bash +> cd <Path_To_Output>/ccda21-validator-jar/target/appassembler/bin + +> chmod +x validator.sh #if on linux + +> ./validator.sh -path <Path_to_CDA.xml> -out <Path_To_output_result.xml> +``` + Here is a summary of possible parameters for the validator: <table> <thead> @@ -437,7 +453,7 @@ Just import it to SoapUI and run the test cases. -<div id='utilityScripts'/> +<div id='utilityScripts'></div> ## 9. Utility Scripts @@ -470,7 +486,7 @@ For SEQUOIA: ``` -<div id='extras'/> +<div id='extras'></div> ## 10. Extras @@ -482,6 +498,5 @@ You can find some previous made documentation here _(belong the old GOC, and cou #### Next released documentation - Functional description of GOC -- Prepare validator for SEQUOIA -- Use interactive scripts for generation +