Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 4f217fcd authored by Anne-Gaëlle Bergé's avatar Anne-Gaëlle Bergé
Browse files

first commit

parents
No related branches found
No related tags found
No related merge requests found
Showing
with 1393 additions and 0 deletions
Assertion-Manager/media/mbv_service_report.png

96.8 KiB

Assertion-Manager/media/mbv_services.png

39.3 KiB

Assertion-Manager/media/menu_id_scheme.png

6.76 KiB

Assertion-Manager/media/pdf_icon.png

521 B

Assertion-Manager/media/refresh_icon.png

582 B

Assertion-Manager/media/review_icon.png

623 B

Assertion-Manager/media/scopes_index.png

38.5 KiB

Assertion-Manager/media/view_icon.png

594 B

Assertion-Manager/media/xml_icon.png

602 B

---
title: Release note
subtitle: AssertionManager - 4.0.1
toolversion: 4.0.1
releasedate: 2016-10-04
author: Jean-François Labbé
function:
customer:
reference:
---
# All changes
## Bug
* \[[AM-106](https://gazelle.ihe.net/jira/browse/AM-106)\] We need a field that describe the content of a scheme
* \[[AM-173](https://gazelle.ihe.net/jira/browse/AM-173)\] Filtering in documents from assertion page seems duplicating the document names
* \[[AM-215](https://gazelle.ihe.net/jira/browse/AM-215)\] When logged by CAS, it's impossible to change the page number in the assertions list page
* \[[AM-220](https://gazelle.ihe.net/jira/browse/AM-220)\] Null pointer exception when trying to get an URI in a specific case
* \[[AM-225](https://gazelle.ihe.net/jira/browse/AM-225)\] Unable to find component with ID scopeFilter in view.
## Improvement
* \[[AM-30](https://gazelle.ihe.net/jira/browse/AM-30)\] When a test is deprecated in GMM, then the assertion bound should not be covered anymore
* \[[AM-84](https://gazelle.ihe.net/jira/browse/AM-84)\] Better reporting on IdSchemes upload (progress and errors)
* \[[AM-90](https://gazelle.ihe.net/jira/browse/AM-90)\] Add a create assertion button next to missing assertion reported by mbvServices
* \[[AM-97](https://gazelle.ihe.net/jira/browse/AM-97)\] Mark an assertion as not testable
* \[[AM-108](https://gazelle.ihe.net/jira/browse/AM-108)\] Export to TAML is not exporting the fields "comment" and "status".
* \[[AM-112](https://gazelle.ihe.net/jira/browse/AM-112)\] Document have a field revision. This is confusing. Is that a revision date or a revision number. Do we need
* \[[AM-138](https://gazelle.ihe.net/jira/browse/AM-138)\] A "link all selected assertions" button would be appreciated
* \[[AM-147](https://gazelle.ihe.net/jira/browse/AM-147)\] In the page "Apply To" we need a button "link all" to apply the link to the filtered assertion
* \[[AM-152](https://gazelle.ihe.net/jira/browse/AM-152)\] Add Original language description from the standard as a field
* \[[AM-206](https://gazelle.ihe.net/jira/browse/AM-206)\] When an assertion is covered by a test, display the test name instead of id
* \[[AM-207](https://gazelle.ihe.net/jira/browse/AM-207)\] Add a review filtered assertion feature
* \[[AM-216](https://gazelle.ihe.net/jira/browse/AM-216)\] when adding an assertion to a new idScheme, user should be able to select a document
* \[[AM-223](https://gazelle.ihe.net/jira/browse/AM-223)\] IdScheme page could be managed with CRUD pages instead of popups
* \[[AM-221](https://gazelle.ihe.net/jira/browse/AM-221)\] AM-223 Improve assertion coverage Filtering
* \[[AM-222](https://gazelle.ihe.net/jira/browse/AM-222)\] Some buttons are not in the panel footer
# Dependencies
Scanning for projects...
------------------------------------------------------------------------
Reactor Build Order:
AssertionManagerGui
AssertionManagerGui-model
AssertionManagerGui-EJB
AssertionManagerGui-WAR
AssertionManagerGui - EAR
------------------------------------------------------------------------
Building AssertionManagerGui 4.0.2-SNAPSHOT
------------------------------------------------------------------------
--- gazelle-plugins:1.54:check-dependencies (default-cli) @ AssertionManagerGui ---
Check dependencies :: All the dependencies are up to date.
------------------------------------------------------------------------
Building AssertionManagerGui-model 4.0.2-SNAPSHOT
------------------------------------------------------------------------
--- gazelle-plugins:1.54:check-dependencies (default-cli) @ AssertionManagerGui-model ---
Check dependencies :: All the dependencies are up to date.
------------------------------------------------------------------------
Building AssertionManagerGui-EJB 4.0.2-SNAPSHOT
------------------------------------------------------------------------
--- gazelle-plugins:1.54:check-dependencies (default-cli) @ AssertionManagerGui-ejb ---
Check dependencies :: All the dependencies are up to date.
------------------------------------------------------------------------
Building AssertionManagerGui-WAR 4.0.2-SNAPSHOT
------------------------------------------------------------------------
--- gazelle-plugins:1.54:check-dependencies (default-cli) @ AssertionManagerGui-war ---
Check dependencies :: All the dependencies are up to date.
------------------------------------------------------------------------
Building AssertionManagerGui - EAR 4.0.2-SNAPSHOT
------------------------------------------------------------------------
--- gazelle-plugins:1.54:check-dependencies (default-cli) @ AssertionManagerGui-ear ---
Check dependencies :: All the dependencies are up to date.
------------------------------------------------------------------------
Reactor Summary:
AssertionManagerGui ................................ SUCCESS [ 3.085 s]
AssertionManagerGui-model .......................... SUCCESS [ 3.382 s]
AssertionManagerGui-EJB ............................ SUCCESS [ 3.091 s]
AssertionManagerGui-WAR ............................ SUCCESS [ 1.006 s]
AssertionManagerGui - EAR .......................... SUCCESS [ 1.731 s]
------------------------------------------------------------------------
BUILD SUCCESS
------------------------------------------------------------------------
Total time: 13.940 s
Finished at: 2016-10-04T08:40:20+01:00
Final Memory: 48M/712M
------------------------------------------------------------------------
---
title: Release note
subtitle: AssertionManager - 4.0.2
toolversion: 4.0.2
releasedate: 2016-10-17 00:00:00.0
author: Anne-Gaëlle Bergé
function: Engineer
customer: IHE-Europe
reference: KER3-RNO-IHE_EUROPE-ASSERTION_MANAGER_4_0_2
---
# All changes
## Bug
* \[[AM-230](https://gazelle.ihe.net/jira/browse/AM-230)\] When creating / editing a PDF document, the PDF is not displayed in the right panel
* \[[AM-233](https://gazelle.ihe.net/jira/browse/AM-233)\] I have edited an assertion in the application in the review mode. Last updated and Last modifier are not updated
## Story
* \[[AM-234](https://gazelle.ihe.net/jira/browse/AM-234)\] Release 4.0.2
## Improvement
* \[[AM-228](https://gazelle.ihe.net/jira/browse/AM-228)\] Add the possibility to search in the list linking a document to an idscheme
* \[[AM-229](https://gazelle.ihe.net/jira/browse/AM-229)\] When deleting a document, add a message to warn the user that the idschemes will be unlinked
* \[[AM-231](https://gazelle.ihe.net/jira/browse/AM-231)\] Add informations when linking a document to an idscheme
* \[[AM-232](https://gazelle.ihe.net/jira/browse/AM-232)\] Stay on the same page when user clics the CAS login button
---
title: Release note
subtitle: AssertionManager - 4.1.0
toolversion: 4.1.0
releasedate: 2018-06-06
author: Guillaume THOMAZON
function: Engineer
customer: IHE-Europe
reference: KER3-RNO-IHE_EUROPE-ASSERTION_MANAGER_4_1_0
---
# 4.0.3
## All changes
### Bug
* \[[AM-236](https://gazelle.ihe.net/jira/browse/AM-236)\] Impossible to import assertions when an attribute is present and empty
* \[[AM-237](https://gazelle.ihe.net/jira/browse/AM-237)\] Imported assertions do not have a creator attribute
* \[[AM-242](https://gazelle.ihe.net/jira/browse/AM-242)\] Recent PDF are not displayed
# 4.1.0
## All changes
### Improvement
* \[[AM-252](https://gazelle.ihe.net/jira/browse/AM-252)\] Use new CAS SSO
# Remarks
---
title: User Manual
subtitle: Assertion Manager
author: Jean-François LABBE
function: Engineer
date: 04/10/2016
toolversion: 4.x
version: 3.0.0
status: Draft
reference: KER3-MAN-IHE_EUROPE-ASSERTION_MANAGER_USER-1_02
customer: IHE-EUROPE
---
# Introduction
The assertion manager aims at linking Requirements (assertions) to the entity covering them.
An assertion can be covered by a:
* Test
* Test step
* Technical framework rule
* Model based validation
The assertion manager is linked to gazelle Test Management in order to link assertions to test, test steps and technical framework rules.
The assertion manager can be linked to multiple model based validation services.
The assertion Manager provides a web service to query assertions, the api is described [*here*](https://gazelle.ihe.net/AssertionManagerGui/apidocs/).
# Concepts
![](./media/assertion_concepts.jpeg)
# Assertions
An assertion is the expression of a requirement.
An assertion is linked to an IdScheme.
An assertion is composed of:
* AssertionId
* Predicate
* Prescription level
* Section
* Page
* A document
Click on "Assertions" link in the menu bar.
The page displayed lists all registered assertions and the seach criteria area to filter according to Assertion parameters, Applies to and/or Coverage:
![](./media/assertion_page.png)
## Create assertion
The administrator user can create a new assertion:
![](./media/assertion_admin.png)
Click on the button ![](./media/assertion_add.png), it will open a window containing a new assertion properties:![](./media/assertion_create.png)
Fill the properties and click on button ![](./media/assertion_save.png) to register the new assertion.
Click on button ![](./media/assertion_save_and_new.png) to register and display a new assertion creation window.
## Update deprecated coverage
To check and update the links between assertion and coverage tests click on the button ![](./media/assertion_update_deprecated_coverage.png).
## View assertion
Choose the first assertion of the list and click on the button ![](./media/view_icon.png).
It will display properties and document belonging to the selected assertion:
![](./media/assertion_view.png)
You can edit the assertion details by clicking on the Edit button ![](./media/edit.png) (refer to chapter *Edit assertion* for more details).
Click on button ![](./media/assertion_view_xml.png) to view the selected assertion XML (refer to chapter *View XML* for more details).
## Edit assertion
Choose the first assertion of the list and click on the button ![](./media/edit_icon.png).
It will open a new window containing the selected assertion details to edit.
![](./media/assertion_edit_page.png)
## View assertion XML
Choose an assertion from list and click on the button ![](./media/xml_icon.png).
It will open a new window containing the XML that describes the assertion.
An example of assertion XML is shown below:
```xml
<testAssertionSet xsi:schemaLocation="http://docs.oasis-open.org/ns/tag/taml-201002/ http://gazelle.ihe.net/XSD/OASIS/TAML/testAssertionMarkupLanguage.xsd">
<common>
<normativeSource>
<refSourceItem srcname="IHE IT Infrastructure (ITI) Technical Framework Volume 1 (ITI TF-1) Integration Profiles" uri="https://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf" documentId="" versionId="" revisionId="13.0" resourceProvenanceId="IHE.net"/>
</normativeSource>
<target idscheme="ATNA"/>
</common>
<testAssertion id="ATNA-1">
<predicate>
The Audit Trail and Node Authentication Integration Profile
requires the use of bi-directional certificate-based node authentication
for connections to and from each node.
</predicate>
<prescription level="mandatory"/>
<tag tname="Page">76</tag>
<tag tname="Section">9.4</tag>
<comment>I think this is redundant to ATNA-11.
This is just a generic statement about the ITI-19 transaction.
</comment>
<status>TO_BE_REVIEWED</status>
<testable>true</testable>
</testAssertion>
</testAssertionSet>
```
## View assertion document
Choose the first assertion of the list and click on the button ![](./media/pdf_icon.png).
It will display the pdf document belonging to the selected assertion.
## Delete assertion
To delete selected assertion, click on the delete icon ![](./media/delete_icon.png).
A confirmation panel will appear then click on the delete button.
## Import assertions
Assertions can be imported into the AssertionManager. One assertionId must be unique in one idScheme.
Please use the following template to create your assertion file: [*https://gazelle.ihe.net/files/AssertionTemplate.xml*](https://gazelle.ihe.net/files/AssertionTemplate.xml).
Then go to the IdSchemes page and click the ![](./media/import_idScheme_button.png) button:
![](./media/IdSchemes_importAssertions.png)
Select your XML file containing your assertions.
If the uploaded xml file contains an assertion that is already in assertion manager, then the assertion properties will be updated.
# IdSchemes
An IdScheme is used to group assertions from one document.
It is used to import assertions.
It provides coverage feedback.
Click on "Id schemes" link in the menu bar.
The page displayed lists all registered IdSchemes and the seach criteria area to filter according to Scope Id Scheme and/or Model-based Validator Sevice:
![](./media/idScheme_coverage.png)
## Create IdScheme
As shown on picture above, the administrator user can create a new IdScheme.
Click on the button ![](./media/IdSchemes_create.png).
It will open a window containing a new IdScheme properties:
![](./media/IdSchemes_creation.png)
Fill the properties and click on button ![](./media/IdSchemes_save.png) to register the new IdScheme.
Click on the button ![](./media/back.png) to go back to IdSchemes main page without registring.
## View IdScheme
Choose the first IdSheme of the list and click on the button ![](./media/view_icon.png).
It will display the properties of selected IdScheme:
![](./media/IdSchemes_view_page.png)
You can edit the IdScheme details by clicking on the Edit button ![](./media/edit.png) (refer to chapter *Edit IdScheme* for more details).
## Edit IdScheme
Choose the first IdSheme of the list and click on the button ![](./media/edit_icon.png).
It will open a new window containing the selected IdScheme details to edit:
![](./media/IdSchemes_edit_page.png)
Click on button ![](./media/IdSchemes_save.png) to register the modified IdScheme.
## Review IdScheme
Choose the first IdSheme of the list and click on the button ![](./media/review_icon.png).
It will open a window containing the list of the selected IdScheme assertions.
It also offers the possibility to browse this list and to display each assertion with its properties.
![](./media/IdSchemes_review_page.png)
## View IdScheme XML
Choose the first IdSheme of the list and click on the button ![](./media/xml_icon.png).
It will open a window containing the XML that describes the IdScheme and its assertions.
An example of IdSchme XML is shown below:
```xml
<testAssertionSet xsi:schemaLocation="http://docs.oasis-open.org/ns/tag/taml-201002/ http://gazelle.ihe.net/XSD/OASIS/TAML/testAssertionMarkupLanguage.xsd">
<common>
<normativeSource>
<refSourceItem srcname="IHE IT Infrastructure (ITI) Technical Framework Volume 1 (ITI TF-1) Integration Profiles" uri="https://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf" documentId="" versionId="" revisionId="13.0" resourceProvenanceId="IHE.net"/>
</normativeSource>
<target idscheme="ATNA"/>
</common>
<testAssertion id="ATNA-1">
<predicate>
The Audit Trail and Node Authentication Integration Profile requires the use of bi-directional
certificate-based node authentication for connections to and from each node.
</predicate>
<prescription level="mandatory"/>
<tag tname="Page">76</tag>
<tag tname="Section">9.4</tag>
<comment>I think this is redundant to ATNA-11.</comment>
<status>TO_BE_REVIEWED</status>
<testable>true</testable>
</testAssertion>
<testAssertion id="ATNA-10">
<predicate>
Audit Record Repository actor which claims support
of the Audit Trail and Node Authentication (ATNA) integration profile shall support
the Record Audit Event [ITI-20] transaction.
</predicate>
<prescription level="mandatory"/>
<tag tname="Page">74</tag>
<tag tname="Table">9.4-1</tag>
<status>REVIEWED</status>
<testable>true</testable>
</testAssertion>
...
</testAssertionSet>
```
## View IdScheme documents
Choose the first IdSheme from list and click on the button ![](./media/documents_icon.png).
It list documents belonging to assertions in this IdScheme.
![](./media/document_linked_to_idScheme.png)
You can edit the document details by clicking on the Edit button ![](./media/edit_icon.png):
![](./media/edit_document.png)
## Delete IdScheme
Deleting one idScheme will delete all the assertions it contains.
To delete one IdScheme, click on the delete icon ![](./media/delete_icon.png).
A confirmation panel will appear then click on the delete button.
# Scopes
A scope provides a way to group assertions that are in different IdScheme.
A scope contains assertions and one assertion can be in 0 or multiple scopes.
Click on "Scopes" link in the menu bar.
The page displayed lists all registered scopes and the scope filter area according to the keyword.
![](./media/scopes_index.png)
## Create Scope
As shown on picture above, the administrator user can create a new Scope.
Click on the button ![](./media/Scope_create.png).
It will open a window containing a new Scope properties:
![](./media/Scope_create_page.png)
Fill the properties and click on button ![](./media/Scope_save.png) to register the new Scope.
Click on the button ![](./media/back.png) to go back to Scope main page without registring.
## View Scope
Choose the first Scope of the list and click on the button ![](./media/view_icon.png).
It will display the properties of selected Scope:
![](./media/Scope_view_page.png)
You can edit the Scope details by clicking on the Edit button ![](./media/edit.png) (refer to chapter *Edit Scope* for more details).
## Edit Scope
Choose the first Scope of the list and click on the button ![](./media/edit_icon.png).
It will open a window containing the selected Scope details to edit:
![](./media/Scope_edit_page1.png)
![](./media/Scope_edit_page2.png)
To remove IdSchemes from Scope, select the available IdSchemes and click on button ![](./media/Scope_remove_selection.png).
To add IdSchemes to scope, select the available IdSchemes and click on button ![](./media/Scope_add_selection.png).
And to link IdSchemes to Scope, select available IdSchemes and click on button ![](./media/Scope_link_selection.png).
Click on button ![](./media/Scope_save.png) to register the modified Scope.
## Delete Scope
Deleting one Scope **will not delete** the assertions it contains.
To delete one scope, click on the delete icon ![](./media/delete_icon.png).
A confirmation panel will appear then click on the delete button.
# Assertion Coverage
An Assertion can be covered by:
* A test
* A test step
* A rule
* A Model based validation
Assertion manager queries gazelle test managment to list all tests, test steps and rules available.
![](./media/mbv_concepts.jpeg)
Configure gazelle\_test-managment-url into administration page to point to your test managment instance (example: [*https://gazelle.ihe.net/GMM/rest/*](https://gazelle.ihe.net/GMM/rest/)).
Touch the deployed package so that new configuration are taken into account.
In the following chapters you will learn how to cover an assertion.
## Test
Click on "Coverage" then "Test to Assertions" link in the menu bar.
![](./media/coverage_test.png)
To link a test to an assertion:
Select a domain and integration profile.
Select a test by clicking the select link on the test row.
It will display the test description and enable "Link to" and "Unlink" buttons in the right pane.
Click on the "Link to" in the assertion row to link to the selected test.
The button will become an unlink button in red.
![](./media/coverage_test_linked.png)
## Test Step
Click on "Coverage" then the "Test steps to assertions" menu link
A test step belongs to test so as linking a test to an assertion, select the test.
Then select the test step by clicking on the test step row.
## Rules
Click to "Coverage" then the "Rules to assertions" menu link.
To link a rule to an assertion:
1. Search the rule to link with the rules filtering
1. Rules will appear in the Filtered rules section, Select the rule to link, by clicking the select link in the rule row.
1. Assertion linked to the rule will appear
1. Search the assertion to link with the rule
1. Link the assertion to the rule by clicking the Link to button.
# Assertion Applies to
Assertion can be applied to: an Actor, an AIPO, an Audit message, an Integration profile, a Standard, a Transaction. It works the same way for linking all the entities mentioned above, so only one will be demonstrated. Click to "Apply to" then "Actors" menu link.
![](./media/apply_to_actor.png)
Filter and/or Select an "actor"
The actor description appears
Filter to select the assertion to link. Click "Link to" button
![](./media/apply_to_linked.png)
# Model based validation service (MBVservice)
Assertion manager can fetch assertion coverage from services that provides coverage services.
To provide a coverage service implement: ```net.ihe.gazelle.assertion.coverage.provider.WsInterface```
from:
```xml
<parent>
<groupId>net.ihe.gazelle.assertion.coverage</groupId>
<artifactId>gazelle-assertion-coverage-provider</artifactId>
<version>5.0.1</version>
</parent>
```
List of services that provides an assertion coverage service:
* CDAGenerator
* GazelleHL7Validator
* XdStarClient
## Configuration
Go to Administration -&gt; Mbv Services
The page lists all registered Mbv Services.
You can add, update, Delete a mbv Service and synchronize coverages.
![](./media/mbv_services.png)
### Add a MbvService
To add a new Mbv Service click Add new mbv service :
Set the keyword.
Set the url to the service without trailing slash, example: [*https://gazelle.ihe.net/CDAGenerator*](https://gazelle.ihe.net/CDAGenerator).
Click the **Add new mbv service** button
![](./media/mbv_sercice_edit.png)
### Edit
Click the edit button in the service row ![](./media/edit_icon.png).
Click the update this mbv service button
![](./media/mbv_sercice_edit.png)
### Delete
Click the delete cross in the mbv service row ![](./media/delete_icon.png).
### Coverage Synchronization
Click on the synchronize button ![](./media/refresh_icon.png).
It will fetch the assertions covered by the service and display the synchronization status:
**Covered assertions:** Assertions that are covered by the service and in Assertion manager.
**No more covered:** Assertions that are no longer covered by the service and in Assertion manager.
**Missing assertions:** Assertions that are covered by the service but not in Assertion manager.
![](./media/mbv_service_report.png)
# Coverage FeedBack
Assertion manager provides coverage details.
## Idscheme Page
For each idScheme coverage statistics are displayed, and a progress bar to visualize assertion coverage.
**\#Covered throuh tests**
Number of assertions covered by a test or testStep or more
**\#Covered throuh rules**
Number of assertions covered by a rule or more
**\#Covered throuh MBV**
Number of assertions covered by MbvService validation or more
## Assertions list page
This page lists all assertions and displays coverage statistics by assertion.
**\#Covered by tests**
Number of test or testSteps covering the assertion
**\#Covered by rules**
Number of rules covering the assertion
**\#Covered by MBV**
Number of validations perfromed by MbvServices covering the assertion
## Assertion detail page
When viewing an assertion, a coverage section is visible.
The coverage section lists all the entities covering the assertion and provides a link to the entity.
It is possible to unlink a Test, Test step, rule from this page. When clicking the Unlink button, a confirmation panel is displayed.
SHELL := /bin/bash
include ../Makefile.generic
---
title: Release note
subtitle: Authentication Simulator - 0.1.0
toolversion: 0.1.0
releasedate: 2018-07-27
author: Cédric Eoche-Duval
function: Software Engineer
customer: IHE-Europe
reference: KER3-RNO-IHE-AUTH_0_1_0
---
# All changes
## Story
* \[[AUTH-5](https://gazelle.ihe.net/jira/browse/AUTH-5)\] Display IdP and XSU simulator information
* \[[AUTH-6](https://gazelle.ihe.net/jira/browse/AUTH-6)\] List IdP Simulator authentication attempts
* \[[AUTH-7](https://gazelle.ihe.net/jira/browse/AUTH-7)\] Provide a permanent link for authentication attempts
## Bug
* \[[AUTH-11](https://gazelle.ihe.net/jira/browse/AUTH-11)\] No more log reported by idp-adapter after log-rotate
# Dependencies
All dependencies are up to date
This diff is collapsed.
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>/home/aboufahj/workspaceV7/gazelle-documentation/CDA-Generator/.user.md.html</title>
<style type="text/css">
body {
color: #333;
font: 13px/1.4 "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
padding: 0;
margin: 0;
}
a {
background: transparent;
color: #4183c4;
text-decoration: none;
}
a:active,
a:hover {
outline: 0 none;
text-decoration: underline;
}
abbr[title] {
border-bottom: 1px dotted;
}
b,
strong {
font-weight: bold;
}
dfn {
font-style: italic;
}
h1 {
font-size: 2em;
margin: 0.67em 0;
}
mark {
background: #ff0;
color: #000;
}
small {
font-size: 80%;
}
sub, sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
img {
border: 0 none;
}
svg:not(:root) {
overflow: hidden;
}
figure {
margin: 1em 40px;
}
hr {
box-sizing: content-box;
height: 0;
}
code,
kbd,
pre,
samp {
font-family: monospace,monospace;
font-size: 1em;
}
pre {
overflow: auto;
font: 12px Consolas,"Liberation Mono",Menlo,Courier,monospace;
margin-bottom: 0;
margin-top: 0;
}
.markdown-body {
padding: 30px;
font-size: 16px;
line-height: 1.6;
word-wrap: break-word;
}
.markdown-body>*:first-child {
margin-top: 0 !important;
}
.markdown-body>*:last-child {
margin-bottom: 0 !important;
}
.markdown-body .absent {
color: #c00;
}
.markdown-body .anchor {
position: absolute;
top: 0;
bottom: 0;
left: 0;
display: block;
padding-right: 6px;
padding-left: 30px;
margin-left: -30px;
}
.markdown-body .anchor:focus {
outline: none;
}
.markdown-body h1,
.markdown-body h2,
.markdown-body h3,
.markdown-body h4,
.markdown-body h5,
.markdown-body h6 {
position: relative;
margin-top: 1em;
margin-bottom: 16px;
font-weight: bold;
line-height: 1.4;
}
.markdown-body h1 .octicon-link,
.markdown-body h2 .octicon-link,
.markdown-body h3 .octicon-link,
.markdown-body h4 .octicon-link,
.markdown-body h5 .octicon-link,
.markdown-body h6 .octicon-link {
display: none;
color: #000;
vertical-align: middle;
}
.markdown-body h1:hover .anchor,
.markdown-body h2:hover .anchor,
.markdown-body h3:hover .anchor,
.markdown-body h4:hover .anchor,
.markdown-body h5:hover .anchor,
.markdown-body h6:hover .anchor {
padding-left: 8px;
margin-left: -30px;
line-height: 1;
text-decoration: none;
}
.markdown-body h1:hover .anchor .octicon-link,
.markdown-body h2:hover .anchor .octicon-link,
.markdown-body h3:hover .anchor .octicon-link,
.markdown-body h4:hover .anchor .octicon-link,
.markdown-body h5:hover .anchor .octicon-link,
.markdown-body h6:hover .anchor .octicon-link {
display: inline-block;
}
.markdown-body h1 tt,
.markdown-body h1 code,
.markdown-body h2 tt,
.markdown-body h2 code,
.markdown-body h3 tt,
.markdown-body h3 code,
.markdown-body h4 tt,
.markdown-body h4 code,
.markdown-body h5 tt,
.markdown-body h5 code,
.markdown-body h6 tt,
.markdown-body h6 code {
font-size: inherit;
}
.markdown-body h1 {
padding-bottom: 0.3em;
font-size: 2.25em;
line-height: 1.2;
border-bottom: 1px solid #eee;
}
.markdown-body h2 {
padding-bottom: 0.3em;
font-size: 1.75em;
line-height: 1.225;
border-bottom: 1px solid #eee;
}
.markdown-body h3 {
font-size: 1.5em;
line-height: 1.43;
}
.markdown-body h4 {
font-size: 1.25em;
}
.markdown-body h5 {
font-size: 1em;
}
.markdown-body h6 {
font-size: 1em;
color: #777;
}
.markdown-body p,.markdown-body blockquote,
.markdown-body ul,.markdown-body ol,
.markdown-body dl,.markdown-body table,
.markdown-body pre {
margin-top: 0;
margin-bottom: 16px;
}
.markdown-body hr {
height: 4px;
padding: 0;
margin: 16px 0;
background-color: #e7e7e7;
border: 0 none;
}
.markdown-body ul,
.markdown-body ol {
padding-left: 2em;
}
.markdown-body ul.no-list,
.markdown-body ol.no-list {
padding: 0;
list-style-type: none;
}
.markdown-body ul ul,
.markdown-body ul ol,
.markdown-body ol ol,
.markdown-body ol ul {
margin-top: 0;
margin-bottom: 0;
}
.markdown-body li>p {
margin-top: 16px;
}
.markdown-body dl {
padding: 0;
}
.markdown-body dl dt {
padding: 0;
margin-top: 16px;
font-size: 1em;
font-style: italic;
font-weight: bold;
}
.markdown-body dl dd {
padding: 0 16px;
margin-bottom: 16px;
}
.markdown-body blockquote {
padding: 0 15px;
color: #777;
border-left: 4px solid #ddd;
}
.markdown-body blockquote>:first-child {
margin-top: 0;
}
.markdown-body blockquote>:last-child {
margin-bottom: 0;
}
.markdown-body table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all;
}
.markdown-body table th {
font-weight: bold;
}
.markdown-body table th,
.markdown-body table td {
padding: 6px 13px;
border: 1px solid #ddd;
}
.markdown-body table tr {
background-color: #fff;
border-top: 1px solid #ccc;
}
.markdown-body table tr:nth-child(2n) {
background-color: #f8f8f8;
}
.markdown-body img {
max-width: 100%;
-moz-box-sizing: border-box;
box-sizing: border-box;
}
.markdown-body span.frame {
display: block;
overflow: hidden;
}
.markdown-body span.frame>span {
display: block;
float: left;
width: auto;
padding: 7px;
margin: 13px 0 0;
overflow: hidden;
border: 1px solid #ddd;
}
.markdown-body span.frame span img {
display: block;
float: left;
}
.markdown-body span.frame span span {
display: block;
padding: 5px 0 0;
clear: both;
color: #333;
}
.markdown-body span.align-center {
display: block;
overflow: hidden;
clear: both;
}
.markdown-body span.align-center>span {
display: block;
margin: 13px auto 0;
overflow: hidden;
text-align: center;
}
.markdown-body span.align-center span img {
margin: 0 auto;
text-align: center;
}
.markdown-body span.align-right {
display: block;
overflow: hidden;
clear: both;
}
.markdown-body span.align-right>span {
display: block;
margin: 13px 0 0;
overflow: hidden;
text-align: right;
}
.markdown-body span.align-right span img {
margin: 0;
text-align: right;
}
.markdown-body span.float-left {
display: block;
float: left;
margin-right: 13px;
overflow: hidden;
}
.markdown-body span.float-left span {
margin: 13px 0 0;
}
.markdown-body span.float-right {
display: block;
float: right;
margin-left: 13px;
overflow: hidden;
}
.markdown-body span.float-right>span {
display: block;
margin: 13px auto 0;
overflow: hidden;
text-align: right;
}
.markdown-body code,.markdown-body tt {
padding: 0;
padding-top: 0.2em;
padding-bottom: 0.2em;
margin: 0;
font-size: 85%;
background-color: rgba(0,0,0,0.04);
border-radius: 3px;
}
.markdown-body code:before,
.markdown-body code:after,
.markdown-body tt:before,
.markdown-body tt:after {
letter-spacing: -0.2em;
content: "\00a0";
}
.markdown-body code br,
.markdown-body tt br {
display: none;
}
.markdown-body del code {
text-decoration: inherit;
}
.markdown-body pre>code {
padding: 0;
margin: 0;
font-size: 100%;
word-break: normal;
white-space: pre;
background: transparent;
border: 0;
}
.markdown-body .highlight {
margin-bottom: 16px;
}
.markdown-body .highlight pre,
.markdown-body pre {
padding: 16px;
overflow: auto;
font-size: 85%;
line-height: 1.45;
background-color: #f7f7f7;
border-radius: 3px;
}
.markdown-body .highlight pre {
margin-bottom: 0;
word-break: normal;
}
.markdown-body pre {
word-wrap: normal;
}
.markdown-body pre code,
.markdown-body pre tt {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0;
}
.markdown-body pre code:before,
.markdown-body pre code:after,
.markdown-body pre tt:before,
.markdown-body pre tt:after {
content: normal;
}
.highlight .pl-coc,
.highlight .pl-entl,
.highlight .pl-entm,
.highlight .pl-eoa,
.highlight .pl-mai .pl-sf,
.highlight .pl-mm,
.highlight .pl-pdv,
.highlight .pl-sc,
.highlight .pl-som,
.highlight .pl-sr,
.highlight .pl-v,
.highlight .pl-vpf {
color: #0086b3;
}
.highlight .pl-eoac,
.highlight .pl-mdht,
.highlight .pl-mi1,
.highlight .pl-mri,
.highlight .pl-va,
.highlight .pl-vpu {
color: #008080;
}
.highlight .pl-c,
.highlight .pl-pdc {
color: #b4b7b4;
font-style: italic;
}
.highlight .pl-k,
.highlight .pl-ko,
.highlight .pl-kolp,
.highlight .pl-mc,
.highlight .pl-mr,
.highlight .pl-ms,
.highlight .pl-s,
.highlight .pl-sok,
.highlight .pl-st {
color: #6e5494;
}
.highlight .pl-ef,
.highlight .pl-enf,
.highlight .pl-enm,
.highlight .pl-entc,
.highlight .pl-eoi,
.highlight .pl-sf,
.highlight .pl-smc {
color: #d12089;
}
.highlight .pl-ens,
.highlight .pl-eoai,
.highlight .pl-kos,
.highlight .pl-mh .pl-pdh,
.highlight .pl-mp,
.highlight .pl-pde,
.highlight .pl-stp {
color: #458;
}
.highlight .pl-enti {
color: #d12089;
font-weight: bold;
}
.highlight .pl-cce,
.highlight .pl-enc,
.highlight .pl-kou,
.highlight .pl-mq {
color: #f93;
}
.highlight .pl-mp1 .pl-sf {
color: #458;
font-weight: bold;
}
.highlight .pl-cos,
.highlight .pl-ent,
.highlight .pl-md,
.highlight .pl-mdhf,
.highlight .pl-ml,
.highlight .pl-pdc1,
.highlight .pl-pds,
.highlight .pl-s1,
.highlight .pl-scp,
.highlight .pl-sol {
color: #df5000;
}
.highlight .pl-c1,
.highlight .pl-cn,
.highlight .pl-pse,
.highlight .pl-pse .pl-s2,
.highlight .pl-vi {
color: #a31515;
}
.highlight .pl-mb,
.highlight .pl-pdb {
color: #df5000;
font-weight: bold;
}
.highlight .pl-mi,
.highlight .pl-pdi {
color: #6e5494;
font-style: italic;
}
.highlight .pl-ms1 {
background-color: #f5f5f5;
}
.highlight .pl-mdh,
.highlight .pl-mdi {
font-weight: bold;
}
.highlight .pl-mdr {
color: #0086b3;
font-weight: bold;
}
.highlight .pl-s2 {
color: #333;
}
.highlight .pl-ii {
background-color: #df5000;
color: #fff;
}
.highlight .pl-ib {
background-color: #f93;
}
.highlight .pl-id {
background-color: #a31515;
color: #fff;
}
.highlight .pl-iu {
background-color: #b4b7b4;
}
.highlight .pl-mo {
color: #969896;
}
</style>
<script type="text/javascript">
function getDocumentScrollTop()
{
var res = document.body.scrollTop || document.documentElement.scrollTop || window.pageYOffset || 0;
// alert(res);
return res;
}
function setDocumentScrollTop(ypos)
{
window.scrollTo(0, ypos);
}
</script>
</head>
<body class="markdown-body">
<hr />
<p>title: User Manual subtitle: CDA Generator author: Abderrazek BOUFAHJA function: Engineer date: 22/12/2016 toolversion: 2.1.x version: 1.02 status: Approved document reference: KER3-MAN-IHE_EUROPE-CDA_GENERATOR_USER</p>
<h2> <a id="customer-ihe-europe" class="anchor" href="#customer-ihe-europe" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>customer: IHE-EUROPE</h2>
<h1> <a id="cda-generator--user-guide" class="anchor" href="#cda-generator--user-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Generator – User Guide</h1>
<h2> <a id="introduction" class="anchor" href="#introduction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Introduction</h2>
<p>This application has multiple purposes.</p>
<ul>
<li>it can be used to generate sample CDA documents that can be used for testing purposes
<ul>
<li>today it allows to generate a dispensation document based on a prescription in the context of the epSOS project.</li>
<li>it will be extended to allow the generation of other kind of CDA documents.</li>
</ul> </li>
<li>It hosts the models of the CDA documents and offers the documentation and the edition interface for those models.</li>
<li>Documentation of the model based contraints</li>
<li>Generation and Edition of basic CDA R2 documents</li>
</ul>
<p>Please email questions to the IHE Europe Connectathon Manager (Eric Poiseau) for guidance through the process.</p>
<p><a href="./media/image19.png" target="_blank"><img src="./media/image19.png" alt="" style="max-width:100%;" /></a></p>
<h2> <a id="cda-documentation" class="anchor" href="#cda-documentation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Documentation</h2>
<p>CDAGenerator offer a documentation of CDA templates, CDA constraints, and CDA structure.</p>
<h2> <a id="cda-structure" class="anchor" href="#cda-structure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Structure</h2>
<p>CDAGenerator offers a complete documentation of the structure of CDA standard. It is the same description that we find in the schema of CDA R2. The documentation is generated from the model UML that describes the CDA standard. To go to documentation you have to go to menu -&gt; CDA Documentation -&gt; CDA Content Documentation</p>
<p><a href="./media/image20.png" target="_blank"><img src="./media/image20.png" alt="" style="max-width:100%;" /></a></p>
<p>The html page that describe the Root element (ClinicalDocument) looks like this :</p>
<p><a href="./media/image21.png" target="_blank"><img src="./media/image21.png" alt="" style="max-width:100%;" /></a></p>
<h2> <a id="cda-templates-documentation" class="anchor" href="#cda-templates-documentation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Templates Documentation</h2>
<p>All the templates described and validated by CDAGenerator are documented by the tool.</p>
<p>To go to the documentation you have to go&nbsp; to : menu -&gt; Documentation -&gt; <a href="https://gazelle.ihe.net/CDAGenerator/docum/templates/listTemplates.seam"><em>CDA Templates Documentation</em></a>, which looks like this :</p>
<p><a href="./media/image22.png" target="_blank"><img src="./media/image22.png" alt="" style="max-width:100%;" /></a></p>
<p>The documentation of the templates is generated automatically from the model UML, which describes the template and its constraints.</p>
<h2> <a id="cda-constraints-documentation" class="anchor" href="#cda-constraints-documentation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA constraints documentation</h2>
<p>The CDA constraint documentation is a page that contains all the constraint validated by CDAGenerator. This page allows to do search of a constraint by its name, its dependency to a class or a package, or by keyword from the description, etc.</p>
<p>To go to the page of constraint documentation ou have to go to the menu -&gt; Documentation -&gt; <a href="https://gazelle.ihe.net/CDAGenerator/docum/constraints/constraints.seam"><em>Constraints Search</em></a></p>
<p><a href="./media/image23.png" target="_blank"><img src="./media/image23.png" alt="" style="max-width:100%;" /></a></p>
<h2> <a id="cda-edition" class="anchor" href="#cda-edition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Edition</h2>
<p>CDAGenerator offers the possibility to edit and to create basic CDA documents. To do so, you have to go to menu -&gt; CDA Generation -&gt; CDA-Edition</p>
<p><a href="./media/image24.png" target="_blank"><img src="./media/image24.png" alt="" style="max-width:100%;" /></a></p>
<p>You can Generate an empty file, or you can uplaod a CDA file :</p>
<p><a href="./media/image25.png" target="_blank"><img src="./media/image25.png" alt="" style="max-width:100%;" /></a></p>
<p>To use the module of edition, you have to click on the button edit.</p>
<p>A new page will be opened containg the possibility to edit element by element each sub element of the root ClinicalDocument.</p>
<p><a href="./media/image26.png" target="_blank"><img src="./media/image26.png" alt="" style="max-width:100%;" /></a></p>
<p>The same page allows to download the modified CDA document, or to validate it, or to save it.</p>
<p>The editor of CDA document is generated also from the model of description of the structure of CDA document.</p>
<h2> <a id="cda-web-service" class="anchor" href="#cda-web-service" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CDA Web service</h2>
<p>CDAGenerator include a web service of validation, that could be used as a standalone without using EVSClient, to validate a CDA document</p>
<p><a href="./media/image27.png" target="_blank"><img src="./media/image27.png" alt="" style="max-width:100%;" /></a></p>
<h2> <a id="disclaimer" class="anchor" href="#disclaimer" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Disclaimer</h2>
<p>The CDA Generator Application is an experimental system.</p>
<p>IHE-Europe assumes no responsibility whatsoever for its use by other parties, and makes no guarantees, expressed or implied, about its quality, reliability, or any other characteristic.</p>
<p>We would appreciate acknowledgement if the software is used.</p>
</body>
</html>
SHELL := /bin/bash
include ../Makefile.generic
This diff is collapsed.
CDA-Generator/media/image17.png

10.8 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment