From 25d7306599cd160c4736dbe163071e6409a1902b Mon Sep 17 00:00:00 2001 From: wbars <wbs@kereval.com> Date: Thu, 27 Jun 2019 16:54:09 +0200 Subject: [PATCH] Documentation on TM Import/Export --- Test-Management/user.md | 713 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 708 insertions(+), 5 deletions(-) diff --git a/Test-Management/user.md b/Test-Management/user.md index 08256de..db51cf3 100644 --- a/Test-Management/user.md +++ b/Test-Management/user.md @@ -3,11 +3,11 @@ title: User manual subtitle: Gazelle Test Management author: Guillaume THOMAZON function: Engineer -date: 25/03/2019 -toolversion: 5.10.x -version: 1.02 -status: Approved document -reference: KER1-MAN-IHE-TEST_MANAGEMENT_USER-1_02 +date: 20/05/2019 +toolversion: 5.11.x +version: 2.01 +status: To be verified +reference: KER1-MAN-IHE-TEST_MANAGEMENT_USER-2_01 customer: IHE-EUROPE --- @@ -902,6 +902,709 @@ As a user with the role ***vendor\_admin***Â visit the page **Registration** -&g  + +### Import/export of Model elements + +Administrater user are able to import or export model elements from the instance of Gazelle Test Management they are working on. + +#### Import/Export of TF Rules + +##### Import + +TF Rules can be extracted from the Gazelle Test Management instance into an XML file. This file can be later on used to import those TF Rules in any other +instance of the tool. +To do so go to the TF/Edit TF Rules menu : + + + +Once you accessed the TF Rules page, you will have the list of all TF Rules for your instance displayed. Those rules can be filter base on Actor, Integration Profile +or option. To export them simply click the __Export Filtered TF Rules__ button. This will create the XML file corresponding to the filtered TF Rules and +automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<aipoRules> + <aipoRule> + <cause xsi:type="aipoSingle" actorKeyword="KWActor1" integrationProfileKeyword="KWIP1" optionKeyword="KWOption1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> + <consequence xsi:type="aipoList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <or>false</or> + <aipoCriterions> + <aipoSingle actorKeyword="KWActor3" integrationProfileKeyword="KWIP3" optionKeyword="KWOption3"/> + <aipoSingle actorKeyword="KWActor4" integrationProfileKeyword="KWIP4" optionKeyword="KWOption4"/> + <aipoSingle actorKeyword="KWActor5" integrationProfileKeyword="KWIP5" optionKeyword="KWOption5"/> + </aipoCriterions> + </consequence> + <comment>This is the first Rule of our list</comment> + </aipoRule> + <aipoRule> + <cause xsi:type="aipoList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <or>false</or> + <aipoCriterions> + <aipoSingle actorKeyword="KWActor9" integrationProfileKeyword="KWIP9" optionKeyword="KWOption9"/> + <aipoList> + <or>true</or> + <aipoCriterions> + <aipoSingle actorKeyword="KWActor11" integrationProfileKeyword="KWIP11" optionKeyword="KWOption11"/> + <aipoSingle actorKeyword="KWActor12" integrationProfileKeyword="KWIP12" optionKeyword="KWOption12"/> + <aipoSingle actorKeyword="KWActor13" integrationProfileKeyword="KWIP13" optionKeyword="KWOption13"/> + </aipoCriterions> + </aipoList> + </aipoCriterions> + </cause> + <consequence xsi:type="aipoSingle" actorKeyword="KWActor7" integrationProfileKeyword="KWIP7" optionKeyword="KWOption7" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> + <comment>This is the Second Rule of our list</comment> + </aipoRule> +<aipoRules> +``` + +Now with this file, you can import TF Rules into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import TF Rules__. + + + +This panel explains the basic rules that are used for TF Rules import : + +* Actor/Integration Profile/Option detection is based on keywords. If one does not appear in the database the criterion will be ignored +* If a "and" or "or" list of criterion gets down to one element, it will be kept as a single criterion +* If a Rule miss either a cause or a consequence criterion, it will be ignored by the import + +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 TF Rules 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 rules have been ignored, what rules will be imported and what rules have been found duplicated +and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import TF Rules__ 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 Standards + +##### Import + +Standards can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export Standards, go to the TF > Standards menu : + + + +Once you accessed the Standards page, you will have the list of all Standards for your instance displayed. Those standards can be filter base on Keyword, +Name or Network Communication Type. To export them simply click the __Export Filtered Standards__ button. This will create the XML file corresponding to +the filtered Standards and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<standards> + <standard> + <keyword>StandardKW1</keyword> + <name>StandardName1</name> + <version>v1</version> + <networkCommunicationType>DICOM</networkCommunicationType> + <url>https://www.test1.com</url> + <transactions> + <transactionKeyword>TransactionKW2</transactionKeyword> + </transactions> + </standard> + <standard> + <keyword>StandardKW3</keyword> + <name>StandardName3</name> + <version>v3</version> + <networkCommunicationType>HTTP</networkCommunicationType> + <url>https://www.test3.com</url> + <transactions> + <transactionKeyword>TransactionKW4</transactionKeyword> + <transactionKeyword>TransactionKW5</transactionKeyword> + <transactionKeyword>TransactionKW6</transactionKeyword> + </transactions> + </standard> +</standards> + +``` + +Now with this file, you can import those Standards into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import Standards__. + + + +This panel explains the basic rules that are used for Standard import : + +* Transaction detection is based on keywords. If one does not appear in the database the transaction link with the Standard will be ignored +* The imported Standard will be linked to all transaction found in the XML that are also in the database + +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 Standards 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 Transactions were found missing, what Standards will be imported and which one have been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import Standards__ 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. + + +#### Import/Export of Configurations + +##### Import + +Configurations based on TF Model can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export Configurations, go to the TF > Gazelle Configuration using TF menu : + + + +Once you accessed the Configurations page, you will have the list of all Configurations for your instance displayed. Those Configurations can be filter base +on Domain, Integration Profile and Actor. To export them simply click the __Export Filtered Configurations__ button. This will create the XML file +corresponding to the filtered configurations and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<configurationTypeMappedWithAIPOList> + <configurationTypeMappedWithAipo> + <actorIntegrationProfileOption> + <actorIntegrationProfile> + <actor> + <keyword>KWActor3</keyword> + <name>NameActor3</name> + </actor> + <integrationProfile> + <keyword>KWIP3</keyword> + <name>NameIP3</name> + </integrationProfile> + </actorIntegrationProfile> + <integrationProfileOption> + <keyword>KWOption2</keyword> + <name>NameOption2</name> + <description>Unused Description2</description> + <toDisplay>true</toDisplay> + </integrationProfileOption> + <maybeSupportive>true</maybeSupportive> + </actorIntegrationProfileOption> + <configurationTypeWithPortsWSTypeAndSopClassList> + <configurationTypeWithPortsWSTypeAndSopClass> + <configurationType name="Type4" category="Category4" usedForProxy="false"/> + <webServiceType> + <description>Description4</description> + <needsOID>false</needsOID> + <integrationProfile> + <keyword>KWIP4</keyword> + <name>NameIP4</name> + </integrationProfile> + </webServiceType> + <wsTransactionUsage> + <usage>Usage4</usage> + <transaction> + <keyword>TRKW4</keyword> + <name>Name4</name> + <description>Desc4</description> + </transaction> + </wsTransactionUsage> + <transportLayer keyword="TLKW4" name="TLName4"/> + </configurationTypeWithPortsWSTypeAndSopClass> + </configurationTypeWithPortsWSTypeAndSopClassList> + </configurationTypeMappedWithAipo> + <configurationTypeMappedWithAipo> + <actorIntegrationProfileOption> + <actorIntegrationProfile> + <actor> + <keyword>KWActor7</keyword> + <name>NameActor7</name> + </actor> + <integrationProfile> + <keyword>KWIP7</keyword> + <name>NameIP7</name> + </integrationProfile> + </actorIntegrationProfile> + <integrationProfileOption> + <keyword>KWOption6</keyword> + <name>NameOption6</name> + <description>Unused Description6</description> + <toDisplay>true</toDisplay> + </integrationProfileOption> + <maybeSupportive>true</maybeSupportive> + </actorIntegrationProfileOption> + <configurationTypeWithPortsWSTypeAndSopClassList> + <configurationTypeWithPortsWSTypeAndSopClass> + <configurationType name="Type8" category="Category8" usedForProxy="false"/> + <webServiceType> + <description>Description8</description> + <needsOID>false</needsOID> + <integrationProfile> + <keyword>KWIP8</keyword> + <name>NameIP8</name> + </integrationProfile> + </webServiceType> + <wsTransactionUsage> + <usage>Usage8</usage> + <transaction> + <keyword>TRKW8</keyword> + <name>Name8</name> + <description>Desc8</description> + </transaction> + </wsTransactionUsage> + <transportLayer keyword="TLKW8" name="TLName8"/> + </configurationTypeWithPortsWSTypeAndSopClass> + </configurationTypeWithPortsWSTypeAndSopClassList> + </configurationTypeMappedWithAipo> +</configurationTypeMappedWithAIPOList> +``` + +Now with this file, you can import those Configurations into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import Configurations__. + + + +This panel explains the basic rules that are used for Configurations import : + +* If the Actor/IntegrationProfile/Option linked to the configuration does not exist in database, the configuration will be ignored. +* If a Transaction linked to a configuration does not exist, the configuration will be ignored. +* Model Elements detection is based on keywords + +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 Configurations 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 Model Elements were found missing, what Configurations will be ignored, what Configurations will be imported and which one have +been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import Configurations__ 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. + + +#### Import/Export of Audit Messages + +##### Import + +Audit Messages can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export Audit Messages, go to the TF > Audit Message menu : + + + +Once you accessed the Audit Messages page, you will have the list of all Audit Messages for your instance displayed. Those Audit Messages can be filter base +on Event, Transaction, OID, Actor or Document Section. To export them simply click the __Export Filtered Audit Messages__ button. This will create the XML file +corresponding to the filtered Audit Messages and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<auditMessages> + <auditMessage> + <id>0</id> + <auditedEvent>PATIENT_RECORD_EVENT</auditedEvent> + <oid>OID0</oid> + <auditedTransaction> + <keyword>TKW0</keyword> + <name>TName0</name> + <description>TDesc0</description> + </auditedTransaction> + <issuingActor> + <keyword>AKW0</keyword> + <name>AName0</name> + </issuingActor> + <documentSection> + <section>Section1</section> + <document> + <document_md5_hash_code>Hash2</document_md5_hash_code> + </document> + <type>TITLE</type> + </documentSection> + <comment>Comment0</comment> + <eventCodeType>ECT0</eventCodeType> + </auditMessage> + <auditMessage> + <id>3</id> + <auditedEvent>PATIENT_RECORD_EVENT</auditedEvent> + <oid>OID3</oid> + <auditedTransaction> + <keyword>TKW3</keyword> + <name>TName3</name> + <description>TDesc3</description> + </auditedTransaction> + <issuingActor> + <keyword>AKW3</keyword> + <name>AName3</name> + </issuingActor> + <documentSection> + <section>Section4</section> + <document> + <document_md5_hash_code>Hash5</document_md5_hash_code> + </document> + <type>TITLE</type> + </documentSection> + <comment>Comment3</comment> + <eventCodeType>ECT3</eventCodeType> + </auditMessage> +</auditMessages> +``` + +Now with this file, you can import those Audit Messages into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import Audit Messages__. + + + +This panel explains the basic rules that are used for Audit Messages import : + +* Actor/Transactions detection is based on keywords. If one does not appear in the database the Audit Message will be ignored +* If a Document Section does not exist on this instance, the Audit Message will be ignored as well + +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 Audit Messages 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 Model Elements were found missing, what Audit Messages will be ignored, what Audit Messages will be imported and which one have +been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import Audit Messages__ 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. + + +#### Import/Export of Documents + +##### Import + +Documents can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export Documents, go to the TF > Manage Documents menu : + + + +Once you accessed the Documents page, you will have the list of all Documents for your instance displayed. Those Documents can be filter base +on Domain, type, volume, title, revision, date of publication, life-cycle status and name. To export them simply click the __Export Filtered Documents__ +button. This will create the XML file corresponding to the filtered Documents and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<documents> + <Document> + <name>IHE_ITI_TF_Vol2a</name> + <title>IHE ITI Technical Framework Volume 2a (ITI-TF-2a)</title> + <revision>11.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2a.pdf</url> + <volume>2a</volume> + <domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>bf130d69e3a4bcf8f30cfdded2f0504c</document_md5_hash_code> + <dateOfpublication>2014-09-23T00:00:00+02:00</dateOfpublication> + </Document> + + <Document> + <name>IHE_ITI_TF_Vol2b</name> + <title>IHE ITI Technical Framework Volume 2b (ITI TF-2b)</title> + <revision>11.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf</url> + <volume>2b</volume> + <domain> + <keyword>TOTO</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>5e8e3def16e02c51e47c31260d1ce599</document_md5_hash_code> + <dateOfpublication>2014-09-23T00:00:00+02:00</dateOfpublication> + </Document> + + <DocumentSection> + <section>Tartiflette1</section> + <document> + <name>Tartiflette</name> + <title>Tartiflette Volume 1 (ITI TF-1)</title> + <revision>69.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf</url> + <volume>1</volume> + <domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>TaRTIFLETTE</document_md5_hash_code> + <dateOfpublication>1995-09-14T00:00:00+02:00</dateOfpublication> + </document> + <type>TITLE</type> + </DocumentSection> + + <DocumentSection> + <section>TestNewSection</section> + <document> + <name>IHE_ITI_TF_Vol2a</name> + <title>IHE ITI Technical Framework Volume 2a (ITI-TF-2a)</title> + <revision>11.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2a.pdf</url> + <volume>2a</volume> + <domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>bf130d69e3a4bcf8f30cfdded2f0504c</document_md5_hash_code> + <dateOfpublication>2014-09-23T00:00:00+02:00</dateOfpublication> + </document> + <type>TABLE</type> + </DocumentSection> + <DocumentSection> + <section>Table_3_21_6__RSP_Segment_Patte</section> + <document> + <name>IHE_ITI_TF_Vol2a</name> + <title>IHE ITI Technical Framework Volume 2a (ITI-TF-2a)</title> + <revision>11.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2a.pdf</url> + <volume>2a</volume> + <domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>bf130d69e3a4bcf8f30cfdded2f0504c</document_md5_hash_code> + <dateOfpublication>2014-09-23T00:00:00+02:00</dateOfpublication> + </document> + <type>TABLE</type> + </DocumentSection> + + <DocumentSection> + <section>1_1_Overview_of_the_Technical_F</section> + <document> + <name>IHE_ITI_TF_Vol2b</name> + <title>IHE ITI Technical Framework Volume 2b (ITI TF-2b)</title> + <revision>11.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf</url> + <volume>2b</volume> + <domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>5e8e3def16e02c51e47c31260d1ce599</document_md5_hash_code> + <dateOfpublication>2014-09-23T00:00:00+02:00</dateOfpublication> + </document> + <type>TITLE</type> + </DocumentSection> +</documents> +``` + +Now with this file, you can import those Documents into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import Documents__. + + + +This panel explains the basic rules that are used for Documents import : + +* Domain detection is based on keywords. If one does not appear in the database the Document and its Sections will be ignored +* Sections that are not already registered will be added to the database if they reference a valid document. + +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 Documents 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 Domains were found missing, what Documents will be ignored, what Documents will be imported and which one have +been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import Documents__ 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. + + +#### Import/Export of HL7 Message Profiles + +##### Import + +HL7 Message Profiles can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export HL7 Message Profiles, go to the TF > HL7 Message Profiles Browsing menu : + + + +Once you accessed the HL7 Message Profiles page, you will have the list of all Profiles for your instance displayed. Those Profiles can be filter base +on Domain, actor, transaction, affinity domain, hl7 version or message types. To export them simply click the __Export Filtered Documents__ +button. This will create the XML file corresponding to the filtered Documents and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<hl7MessageProfiles> + <HL7MessageProfile> + <Oid>1.3.6.1.4.12559.11.1.1.147</Oid> + <Hl7Version>2.3.1</Hl7Version> + <Domain> + <keyword>ITI</keyword> + <name>IT-Infrastructure</name> + <description>The IT Infrastructure Domain supplies infrastructure for sharing healthcare information. An infrastructure interoperability component represents a common IT function that is used as a building block for a variety of use cases... a necessary ingredient, but rarely visible to the end user!! These components may be embedded in an application, but are often deployed as a shared resource within a RHIO or Health Information Exchange.</description> + <id>2</id> + </Domain> + <Actor> + <keyword>PAT_ID_X_REF_MGR</keyword> + <name>Patient Identity Cross-reference Manager</name> + <description>Serves a well-defined set of Patient Identification Domains. Based on information provided by in each Patient Identification Domain by a Patient Identification Source Actor, it manages the cross-referencing of patient identifiers across Patient Identification Domains.</description> + <id>27</id> + </Actor> + <Transaction> + <keyword>ITI-8</keyword> + <name>Patient Identity Feed</name> + <description>Allows a Patient Identity Source Actor to notify a Patient Identity Cross-Referencing Actor of all events related to patient identification (creation, update, merge, etc.).</description> + <id>50</id> + <transactionStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </transactionStatusType> + <transactionLinks> + <fromActor> + <keyword>PAT_ID_SRC</keyword> + <name>Patient Identity Source</name> + <description>Each Patient Identification Domain requires this Actor to assign patient identities and to notify a Patient Identity Cross-reference Manager Actor of all events related to patient identification (creation, update, merge, etc.). For example, the Registration (ADT) Actor defined by the radiology Scheduled Workflow Profile would likely be a Patient Identity Source.</description> + <id>45</id> + </fromActor> + <toActor> + <keyword>DOC_REGISTRY</keyword> + <name>Document Registry</name> + <description>The Document Registry Actor maintains metadata about each registered document in a document entry. This includes a link to the Document in the Repository where it is stored. The Document Registry responds to queries from Document Consumer actors about documents meeting specific criteria. It also enforces some healthcare specific technical policies at the time of document registration.</description> + <id>43</id> + </toActor> + </transactionLinks> + <transactionLinks> + <fromActor> + <keyword>PAT_ID_SRC</keyword> + <name>Patient Identity Source</name> + <description>Each Patient Identification Domain requires this Actor to assign patient identities and to notify a Patient Identity Cross-reference Manager Actor of all events related to patient identification (creation, update, merge, etc.). For example, the Registration (ADT) Actor defined by the radiology Scheduled Workflow Profile would likely be a Patient Identity Source.</description> + <id>45</id> + </fromActor> + <toActor> + <keyword>PAT_ID_X_REF_MGR</keyword> + <name>Patient Identity Cross-reference Manager</name> + <description>Serves a well-defined set of Patient Identification Domains. Based on information provided by in each Patient Identification Domain by a Patient Identification Source Actor, it manages the cross-referencing of patient identifiers across Patient Identification Domains.</description> + <id>27</id> + </toActor> + </transactionLinks> + </Transaction> + <TriggerEvent>ACK^A01^ACK</TriggerEvent> + <MessageOrderControlCode></MessageOrderControlCode> + <AffinityDomains> + <keyword>IHE</keyword> + <labelToDisplay>IHE</labelToDisplay> + <description>IHE</description> + </AffinityDomains> + </HL7MessageProfile> + <HL7MessageProfile> + <Oid>1.1.1.1.1.1.1.1.1.1.1</Oid> + <Hl7Version>2.69.3</Hl7Version> + <Domain> + <keyword>ITI</keyword> + </Domain> + <Actor> + <keyword>PAT_ID_X_REF_MGR</keyword> + </Actor> + <Transaction> + <keyword>ITI-8</keyword> + </Transaction> + <TriggerEvent>ACK^A04^ACK</TriggerEvent> + <MessageOrderControlCode></MessageOrderControlCode> + <AffinityDomains> + <keyword>TOTO</keyword> + <labelToDisplay>TOTO</labelToDisplay> + <description>This is a test</description> + </AffinityDomains> + </HL7MessageProfile> +</hl7MessageProfiles> +``` + +Now with this file, you can import those Profiles into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import HL7 Message Profiles__. + + + +This panel explains the basic rules that are used for Hl7 Message Profiles import : + +* Actor/Domain/Transaction detection is based on keywords. If one does not appear in the database the Message Profile will be ignored. +* Duplicate Message Profile detection is base on the Profile OID. +* Affinity Domain detection is based on keyword. If one does not exist, it will be imported along with the profile. + + +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 Profiles 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 Domains, Actors or Transactions were found missing, what Hl7 Message Profiles will be ignored, what Profiles will be imported +and which one have been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import HL7 Message Profiles__ 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 ### Permanent link to system -- GitLab