Mentions légales du service

Skip to content
Snippets Groups Projects
Commit f774599d authored by Wylem Bars's avatar Wylem Bars
Browse files

Update User Manual for TM 5.13.0 (I/E of OID Roots Definition and Samples' Type)

parent 877c5adb
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 411 additions and 0 deletions
Test-Management/media/oid_export_button.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/oid_export_button.png

27.2 KiB

Test-Management/media/oid_import_panel.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/oid_import_panel.png

27.9 KiB

Test-Management/media/oid_import_report.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/oid_import_report.png

55.5 KiB

Test-Management/media/oid_menu.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/oid_menu.png

78.8 KiB

Test-Management/media/samples_export_button.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/samples_export_button.png

11.6 KiB

Test-Management/media/samples_import_panel.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/samples_import_panel.png

27.5 KiB

Test-Management/media/samples_import_report.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/samples_import_report.png

58.1 KiB

Test-Management/media/samples_menu.png 0 → 100644
+ 0
− 0
View file @ f774599d
Test-Management/media/samples_menu.png

50.7 KiB

Test-Management/user.md
+ 411
− 0
View file @ f774599d
...@@ -1604,6 +1604,417 @@ If the __Review Changes before saving__ option is activated, simply click the __ ...@@ -1604,6 +1604,417 @@ If the __Review Changes before saving__ option is activated, simply click the __
the changes and import them into the Gazelle Test Management instance. If something is not ok with the document, click the __Reset__ button. Changes will the changes and import them into the Gazelle Test Management instance. If something is not ok with the document, click the __Reset__ button. Changes will
not be made on the tools data and you will be able to upload another document. not be made on the tools data and you will be able to upload another document.
#### Import/Export of OID Root Definition
##### Import
OID Root Definition can be extracted from the Gazelle Test Management instance into an XML file. This file can be later on used to import those OID Root
Definitions in any other instance of the tool.
To do so go to the Administration/Manage/Configurations/OIDs Management menu :
![](./media/oid_menu.png)
Once you accessed the OID Management page, when accessing the OID Roots tab, you will have the list of all OID Roots for your instance displayed.
To export them simply click the __Export OID Roots__ button. This will create the XML file corresponding to the OID Roots and
automatically downloads it.
![](./media/oid_export_button.png)
Here is an example of what kind of XML file will be generated :
```
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<oidRootDefinitions>
<oidRootDefinition>
<rootOID>1.3.6.1.4.1.21367.2017.2.3</rootOID>
<lastValue>29</lastValue>
<label>
<label>repositoryUniqueID OID</label>
</label>
<oidRequirements>
<label>repositoryUniqueID OID</label>
<actorIntegrationProfileOptionList>
<actorIntegrationProfile>
<actor>
<keyword>IMG_DOC_SOURCE</keyword>
<name>Imaging Document Source</name>
<description>Publishes imaging data and makes it available for retrieval.</description>
<id>62</id>
</actor>
<integrationProfile>
<keyword>XCA-I</keyword>
<name>Cross-Community Access for Imaging</name>
<description>The Cross-Community Access for Imaging (XCA-I) Integration Profile specifies actors and transactions to query and retrieve patient-relevant medical imaging data being held by other communities. </description>
<id>253</id>
<integrationProfileStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</integrationProfileStatusType>
<domainsForDP>
<keyword>RAD</keyword>
<name>Radiology</name>
<description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description>
<id>1</id>
</domainsForDP>
</integrationProfile>
<profileLinks>
<transaction>
<keyword>RAD-69</keyword>
<name>Retrieve Imaging Doc Set</name>
<description>Retrieve Imaging Doc Set</description>
<id>179</id>
<transactionStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</transactionStatusType>
<transactionLinks>
<fromActor>
<keyword>RESP_IMG_GATEWAY</keyword>
<name>Responding Imaging Gateway</name>
<description>The responding Imaging Gateway proxies Cross Gateway Retrieve Imaging Document Set requests from an Initiating Imaging Gateway to an Imaging Document Source with an Image Document Set Retrieve request.</description>
<id>1192</id>
</fromActor>
<toActor>
<keyword>IMG_DOC_SOURCE</keyword>
<name>Imaging Document Source</name>
<description>Publishes imaging data and makes it available for retrieval.</description>
<id>62</id>
</toActor>
</transactionLinks>
</transaction>
<transactionOptionType>
<keyword>R</keyword>
<name>Required</name>
<description></description>
</transactionOptionType>
</profileLinks>
</actorIntegrationProfile>
<integrationProfileOption>
<keyword>NONE</keyword>
<name>None</name>
<description>None</description>
<reference></reference>
<toDisplay>true</toDisplay>
</integrationProfileOption>
<maybeSupportive>true</maybeSupportive>
</actorIntegrationProfileOptionList>
<prefix></prefix>
</oidRequirements>
</oidRootDefinition>
</oidRootDefinitions>
```
Now with this file, you can import OID Roots into any instance of the tool.
##### Export
On the same page, at the bottom you will find a panel titled __Import OID Roots__.
![](./media/oid_import_panel.png)
This panel explains the basic rules that are used for OID Roots import :
* Actor/Integration Profile/Option detection is based on keywords. If one does not appear in the database but is referenced by a requirement, the requirement will be ignored.
* If an OID Root references an unknown label (or no label) it will be ignored
* If an OID Root is already defined for a label, it will not be imported. Additional requirements from the imported file will be added to the already existing requirements.
You can also see a checkbox for __Review Changes before saving__. This option is activated by default. When activated, a report about the files content
will be displayed as information to the user. The user will then be able to accept the changes and import the OID Roots or cancel the action. If the option
is not activated, the changes will be imported directly in the base. The report will still be displayed but changes have already been made in the database.
The reports sums up what elements were found missing, what Root have been ignored, what Root will be imported and what Root have been found duplicated
and won't be imported.
![](./media/oid_import_report.png)
If the __Review Changes before saving__ option is activated, simply click the __Import OID Roots__ button on the bottom of the report to validate the changes
and import them into the Gazelle Test Management instance. If something is not ok with the uploaded document, just click the __Reset__ button.
Changes will not be made on the tools data and you will be able to upload another document.
#### Import/Export of Samples Type
##### Import
Samples Type can also be extracted into an XML file. The principle is very similar to what is done with other model elements.
To export Samples Type, go to the Administration > Manage > Samples > Manage Samples menu :
![](./media/samples_menu.png)
Once you accessed the Samples Administration page, you will have the list of all Samples Type for your instance displayed. Those Samples Type can be
filtered base on their status. To export them simply click the __Export Filtered Samples' Type__
button. This will create the XML file corresponding to the filtered Samples' Type and automatically downloads it.
![](./media/samples_export_button.png)
Here is an example of what kind of XML file will be generated :
```
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectTypes>
<objectType>
<keyword>GSPS</keyword>
<description>Grey Scale Presentation State</description>
<default_desc>&lt;p&gt;Patient ID:&lt;/p&gt;
&lt;p&gt;Patient Name:&lt;/p&gt;
&lt;p&gt;Your table:&lt;/p&gt;
&lt;p&gt;Your name:&lt;/p&gt;</default_desc>
<instructions>&lt;p&gt;&lt;span style="border-collapse: collapse; line-height: 12px;"&gt;Upload your sample GSPS objects and associated images. See add'l instructions in ...&lt;/span&gt;&lt;/p&gt;
&lt;p&gt;&lt;span style="border-collapse: collapse; line-height: 12px;"&gt;&lt;strong&gt;Pre-Connectathon test:&lt;/strong&gt; MESA test 282 &lt;/span&gt;&lt;/p&gt;
&lt;p&gt;&lt;span style="border-collapse: collapse; line-height: 12px;"&gt;&lt;strong&gt;Connectathon test&lt;/strong&gt; CPI_Store Sample.&lt;/span&gt;&lt;/p&gt;
&lt;p&gt;&lt;span style="border-collapse: collapse; line-height: 12px;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/p&gt;</instructions>
<objectTypeStatus>
<description>The object type can be used</description>
<keyword>ready</keyword>
<labelToDisplay>ready</labelToDisplay>
</objectTypeStatus>
<objectAttributes>
<keyword>Bitmap Display Shutter</keyword>
<description>Dicom Part 3 C7.6.15</description>
</objectAttributes>
<objectCreators>
<description></description>
<AIPO>
<actorIntegrationProfile>
<actor>
<keyword>EC</keyword>
<name>Evidence Creator</name>
<description>A system that creates additional evidence objects such as images, presentation states, Key Image Notes, and/or Evidence Documents and transmits them to an Image Archive. It also makes requests for storage commitment to the Image Manager for the data previously transmitted. It may also retrieve worklist entries for post-processing steps from the Post-Processing Manager and provide notification of completion of the step, allowing the enterprise to track the status of post-processing work.</description>
<id>18</id>
</actor>
<integrationProfile>
<keyword>CPI</keyword>
<name>Consistent Presentation of Images</name>
<description>The Consistent Presentation of Images Integration Profile specifies a number of transactions that maintain the consistency of presentation for grayscale images and their presentation state information (including user annotations, shutters, flip/rotate, display area, and zoom). It also defines a standard contrast curve, the Grayscale Standard Display Function, against which different types of display and hardcopy output devices can be calibrated. It thus supports hardcopy, softcopy and mixed environments.</description>
<id>17</id>
<integrationProfileTypes>
<keyword>EHR_ACCESS</keyword>
<name>EHR Access</name>
<description></description>
</integrationProfileTypes>
<integrationProfileStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</integrationProfileStatusType>
<domainsForDP>
<keyword>RAD</keyword>
<name>Radiology</name>
<description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description>
<id>1</id>
</domainsForDP>
<documentSection>
<section>5_Consistent_Presentation_of_Im</section>
<document>
<name>IHE_RAD_TF_Vol1</name>
<title>IHE Radiology Technical Framework Volume 1</title>
<revision>13.0</revision>
<type>TECHNICAL_FRAMEWORK</type>
<url>http://ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Vol1.pdf</url>
<volume>1</volume>
<domain>
<keyword>RAD</keyword>
<name>Radiology</name>
<description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description>
<id>1</id>
</domain>
<linkStatus>0</linkStatus>
<linkStatusDescription>This url is pointing to a PDF</linkStatusDescription>
<lifecyclestatus>FINAL_TEXT</lifecyclestatus>
<document_md5_hash_code>f7f2125b95d3562447399300aa5aa4a1</document_md5_hash_code>
<dateOfpublication>2014-07-30T00:00:00+02:00</dateOfpublication>
</document>
<type>TITLE</type>
</documentSection>
</integrationProfile>
<profileLinks>
<transaction>
<keyword>RAD-14</keyword>
<name>Query Images</name>
<description>An Image Display queries the Image Archive for a list of entries representing images by patient, study, series, or instance.</description>
<id>15</id>
<transactionStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</transactionStatusType>
<transactionLinks>
<fromActor>
<keyword>ID</keyword>
<name>Image Display</name>
<description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description>
<id>32</id>
</fromActor>
<toActor>
<keyword>IM</keyword>
<name>Image Manager/Archive</name>
<description>A system that provides functions related to safe data storage and image data handling. It supplies image availability information to the Department System Scheduler. It is always grouped with an Image Archive to provide long term storage of images, presentation states, Key Image Notes, and Evidence Documents.</description>
<id>17</id>
</toActor>
</transactionLinks>
</transaction>
<transactionOptionType>
<keyword>O</keyword>
<name>Optional</name>
<description></description>
</transactionOptionType>
</profileLinks>
</actorIntegrationProfile>
<integrationProfileOption>
<keyword>NONE</keyword>
<name>None</name>
<description>None</description>
<reference></reference>
<toDisplay>true</toDisplay>
</integrationProfileOption>
<maybeSupportive>true</maybeSupportive>
</AIPO>
</objectCreators>
<objectFiles>
<description>Upload a screen capture of the document of your peer as rendered by your system. Note that depending on the options supported by your system, the screen capture may also include a capture of the screen showing imported data in your system
</description>
<min>1</min>
<max>1</max>
<type>
<keyword>SNAPSHOT</keyword>
<description>Snapshot of object</description>
<extensions>jpg,png,gif,jpeg</extensions>
<writable>false</writable>
<validate>false</validate>
</type>
<uploader>reader</uploader>
</objectFiles>
<objectReaders>
<description></description>
<AIPO>
<actorIntegrationProfile>
<actor>
<keyword>ID</keyword>
<name>Image Display</name>
<description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description>
<id>32</id>
</actor>
<integrationProfile>
<keyword>CPI</keyword>
<name>Consistent Presentation of Images</name>
<description>The Consistent Presentation of Images Integration Profile specifies a number of transactions that maintain the consistency of presentation for grayscale images and their presentation state information (including user annotations, shutters, flip/rotate, display area, and zoom). It also defines a standard contrast curve, the Grayscale Standard Display Function, against which different types of display and hardcopy output devices can be calibrated. It thus supports hardcopy, softcopy and mixed environments.</description>
<id>17</id>
<integrationProfileTypes>
<keyword>EHR_ACCESS</keyword>
<name>EHR Access</name>
<description></description>
</integrationProfileTypes>
<integrationProfileStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</integrationProfileStatusType>
<domainsForDP>
<keyword>RAD</keyword>
<name>Radiology</name>
<description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description>
<id>1</id>
</domainsForDP>
<documentSection>
<section>5_Consistent_Presentation_of_Im</section>
<document>
<name>IHE_RAD_TF_Vol1</name>
<title>IHE Radiology Technical Framework Volume 1</title>
<revision>13.0</revision>
<type>TECHNICAL_FRAMEWORK</type>
<url>http://ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Vol1.pdf</url>
<volume>1</volume>
<domain>
<keyword>RAD</keyword>
<name>Radiology</name>
<description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description>
<id>1</id>
</domain>
<linkStatus>0</linkStatus>
<linkStatusDescription>This url is pointing to a PDF</linkStatusDescription>
<lifecyclestatus>FINAL_TEXT</lifecyclestatus>
<document_md5_hash_code>f7f2125b95d3562447399300aa5aa4a1</document_md5_hash_code>
<dateOfpublication>2014-07-30T00:00:00+02:00</dateOfpublication>
</document>
<type>TITLE</type>
</documentSection>
</integrationProfile>
<profileLinks>
<transaction>
<keyword>RAD-14</keyword>
<name>Query Images</name>
<description>An Image Display queries the Image Archive for a list of entries representing images by patient, study, series, or instance.</description>
<id>15</id>
<transactionStatusType>
<keyword>FT</keyword>
<name>Final Text</name>
<description></description>
</transactionStatusType>
<transactionLinks>
<fromActor>
<keyword>ID</keyword>
<name>Image Display</name>
<description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description>
<id>32</id>
</fromActor>
<toActor>
<keyword>IM</keyword>
<name>Image Manager/Archive</name>
<description>A system that provides functions related to safe data storage and image data handling. It supplies image availability information to the Department System Scheduler. It is always grouped with an Image Archive to provide long term storage of images, presentation states, Key Image Notes, and Evidence Documents.</description>
<id>17</id>
</toActor>
</transactionLinks>
</transaction>
<transactionOptionType>
<keyword>R</keyword>
<name>Required</name>
<description></description>
</transactionOptionType>
</profileLinks>
</actorIntegrationProfile>
<integrationProfileOption>
<keyword>NONE</keyword>
<name>None</name>
<description>None</description>
<reference></reference>
<toDisplay>true</toDisplay>
</integrationProfileOption>
<maybeSupportive>true</maybeSupportive>
</AIPO>
</objectReaders>
</objectType>
</objectTypes>
```
Now with this file, you can import those Samples' Type into any instance of the tool.
##### Export
On the same page, at the bottom you will find a panel titled __Import Samples' Type__.
![](./media/samples_import_panel.png)
This panel explains the basic rules that are used for Samples' Type import :
* Actor/Integration Profile/Option detection is based on keywords. If one does not appear in the database the Samples' Type will be ignored
* If a Samples' Type references an unknown status (based on keyword) it will be ignored
* If a Samples' Type references a file with unknown typ, the Samples' Type will be ignored
You can also see a checkbox for __Review Changes before saving__. This option is activated by default. When activated, a report about the files content
will be displayed as information to the user. The user will then be able to accept the changes and import the Samples' Type or cancel the action. If
the option is not activated, the changes will be imported directly in the base. The report will still be displayed but changes have already been made
in the database.
The reports sums up what TF Model elements were found missing, what Samples' Type will be ignored, what Samples' Type will be imported and which one have
been found duplicated and won't be imported.
![](./media/samples_import_report.png)
If the __Review Changes before saving__ option is activated, simply click the __Import Samples' Type__ button on the bottom of the report to validate
the changes and import them into the Gazelle Test Management instance. If something is not ok with the document, click the __Reset__ button.
Changes will not be made on the tools data and you will be able to upload another document.
## Systems Management ## Systems Management
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment