Introduction

EVSg is an evolution of EVS, using gateway-integration instead of Vitalink connector-integration. It allows the manipulation of vault contents using specific actors and specific patients, manually or based on previously exported vault contents.

EVSg 3.x.y expands on this by adding Sumehr integration.

After initial installation, some examples are available to get familiar with the functionalities of EVSg, without the need for further configuration.

This manual describes EVSg v3.0.1.

Functionality

General

EVSg allows a certain actor to perform a number of actions for a certain patient. These actions are different, depending on the transactiontype.

These actions are triggered by dropping input files in (subfolders of) the input-folder:

EVSg watches these folder(s), executes the action(s) and generates output in the processed-folder:

EVSg can be launched via the "vault-uploader.cmd" batch file:

The behaviour of EVSg must be determined by passing some mandatory parameters. Instead of using the "vault-uploader.cmd" batch file, it is easier to use the example batch file "start EVS.cmd":

This batch file contains parameter values for a standard behaviour. How the parameters change the behaviour can be found in the paragraph EVSg_3_Manual.

Input-folder

Which patient?

The patient is determined by the folder under "..\exe\interaction\input".

After initial installation, 1 patient named "katrien" is available:

Which actor?

The actor is determined by the folder under "..\exe\interaction\input\<patient folder>".

After initial installation, 1 actor named "gp_van_gucht" is available:

Which transactiontype?

The transactiontype is determined by the folder under "..\exe\interaction\input\<patient folder>\<actor folder>".

After initial installation, 2 types named "m" and "s" (meaning "Medicationscheme" and "Sumehr" respectively) are available:

Which files?

Any type of files, with any extension, can be dropped. They are considered as "input-files". EVSg will, depending on the action folder, parse the files and extract the MSE, TS and Sumehr transactions.

What is a Kmehrmessage?

A Kmehrmessage is a part of the file that starts with <kmehrmessage ...> and ends with </kmehrmessage>. One file can contain 0 or more Kmehrmessages. One Kmehrmessage can contain either 0 or more MSE and TS transactions, or it can contain 0 or more Sumehr transactions.

EVSg will work with Kmehrmessages of Kmehr-standard 20120401 and Kmehr-standard 20161201 as input.

All extra data needed for the communication with the gateway will be generated by the EVSg. As input the data as depicted in the image below will be used:

How is a "medication" identified?

For some actions, typically removing and updating "medications", the medication that should be changed needs to have an identification. Those medications are expressed as MSE transactions. These MSE transactions are identified by using an EVS reference.

How is a "sumehr" identified?

For some actions, typically removing and updating "sumehrs", the sumehr that should be changed needs to have an identification. Those sumehrs are expressed as Sumehr transactions. These Sumehr transactions are identified by using an EVS reference.

Identification by EVS reference

An EVS reference is put in 1 (and only 1) free text field in the concerned MSE or Sumehr transaction.

The EVS reference can be freely chosen, and facilitates the definition and execution of scenarios.

In the next example, this REF is "===EVSREF:901===". EVSg detects the reserved format  "===EVSREF:<any text>===" and finally uses "<any text>" as unique REF.

The REF must contain a minimum of 3 characters and can contain up to 512 characters, so both ===EVSREF:123=== and ===EVSREF:A123456789B123456789=== are considered valid REFs.

If multiple EVS REFs have been given for 1 MSE or Sumehr transaction, EVSg will not execute the action and will raise an error.

Which actions for Medicationscheme?

Depending on the folder where the input-file is dropped, EVSg will execute an action.

Action "add"

This action will add a transaction to the vault for all transactions found in each Kmehrmessage found in all dropped files. If one of the MSE transactions within a kmehrmessage does not have an EVS REF yet, an EVS REF will be generated.

In the example below, 3 transactions are dropped to be added to the vault:

Action "export"

This action will export the contents of the vault that belong to transactiontype "Medicationscheme", without any change to the vault itself. EVSg will do this action once for each dropped file, without parsing this file.

In the example below, a newly created file will trigger an export of the contents of the vault:

Action "generateREF"

This action will generate an EVS REF for each MSE transaction currently in the vault.

If an EVS REF exists already in the MSE transaction, no new EVS REF will be generated.

If no EVS REF exists, the new EVS REF is put in the instructionforpatient field.

Action "replace"

This action will replace the contents of the vault that belong to transactiontype "Medicationscheme" by all the transactions found in the input file. Be aware of the fact that dropping multiple files in the replace-folder will result in a vault with as contents the transactions of the last input file! If one of the MSE transactions within a file does not have an EVS REF yet, this will be generated.

In the next example, after processing the next 3 input files, the vault contains 4 transactions.

Action "updateschemeREF"

This action will update the complete contents of the vault that belong to transactiontype "Medicationscheme", based on the input file compared with the current contents of the vault.

The next actions will take place:

• an MSE transaction with EVS REF not yet existing in the vault will be added to the vault, together with all TS transactions which are linked with this MSE transaction
• an MSE transaction with EVS REF already existing in the vault will cause an update if any difference between the input-transaction and vault-transaction is found
• all MSE transactions without corresponding EVS REF in the input file will be removed from the vault

If the input-file contains MSE transactions with EVS REFs that are not unique, the action will not be executed and an error will be thrown.

Which actions for Sumehr?

Action "add"

This action will add a transaction to the vault for all transactions found in each Kmehrmessage found in all dropped files. If one of the Sumehr transactions within a kmehrmessage does not have an EVS REF yet, an EVS REF will be generated.

In the example below, 3 transactions are dropped in the add folder to be added to the vault:

Action "empty"

This action will remove all transactions from the vault that belong to transactiontype "Sumehr". EVSg will do this action once for each dropped file, without any parsing. 

In the example below, a newly created file will trigger emptying of the vault by removing all existing transactions of transactiontype "Sumehr":

Action "export"

This action will export the contents of the vault that belong to transactiontype "Sumehr", without any change to the vault itself. EVSg will do this action once for each dropped file, without parsing this file.

In the example below, a newly created file will trigger an export of the contents of the vault of transactiontype "Sumehr":

Action "generateRef"

This action will generate an EVS REF for each Sumehr transaction currently in the vault.

If an EVS REF exists already in the Sumehr transaction, no new EVS REF will be generated.

If no EVS REF exists, the new EVS REF is put in the first text field.

Action "removeRef"

This action will remove the transactions that belong to transactiontype "Sumehr" identified by the EVS REF in the input file from the vault.

Action "replace"

This action will replace the contents of the vault that belong to transactiontype "Sumehr" by all the transactions found in the input file. Be aware of the fact that dropping multiple files in the replace-folder will result in a vault with as contents the transactions of the last input file! If one of the Sumehr transactions within a file does not have an EVS REF yet, this will be generated.

In the next example, after processing the next 3 input files, the vault contains 4 transactions.

Action "updateRef"

This action will update the transactions that belong to transactiontype "Sumehr" identified by the EVS REF in the input file.

Processed-folder

After execution of an action a variable number of output files are generated in the processed folder.

The next 2 screenshots show the output of a successful action.

The first screenshot shows the output of a successful add-action for transactiontype "Medicationscheme".

The second screenshot shows the output of a successful export-action for transactiontype "Sumehr".

Each output file will be explained below:

Each filename of transactiontype "Medicationscheme" exists out of:

<date>-<time>_<transactiontype>_<patient>_<actor>_<action>_<input filename>_size-<nr of MSE transactions>_<output suffix>.<output extension>

Each filename of transactiontype "Sumehr" exists out of:

<date>-<time>_<transactiontype>_<patient>_<actor>_<action>_<input filename>_size-<nr of Sumehr transactions>.<output extension>

If for some reason the action fails, an error output file is generated:

Logs-folder

Root

This folder will be automatically generated once "start EVS.cmd" or "start EVS exporter.cmd" has been run for the first time.

This folder contains:

• the eHealth technical connector logs for EVSg: ehealth_uploader*.log
• the eHealth technical connector logs for EVSg-exporter: ehealth_exporter*.log
• the proprietary EVSg log for EVSg: evs_uploader.log
• the proprietary EVSg log for EVSg-exporter: evs_exporter.log
• a folder 'communication'

Communicaton-folder

This folder contains all the requests and responses done by EVSg when communicating with the gateway.

Configuration

This paragraph explains how to configure EVSg.

How to add a patient?

Extra patients can be added by creating files in the next folder:

After initial installation, 2 patient config files are already present. Both can be used as example (copy-paste) to add extra patients. The name of the file, without the extension, needs to be used to identify for which patient the action needs to performed.

After copy paste of the example files, insert the correct info for the new patient:

Since EVS follows all the rules for eHealth and Vitalink, it is up to the user to make sure the proper eHealth dependencies (informed consent, therapeutic relation, ...) are set in function of the wanted behaviour.

How to add an actor?

Extra actors can be added by creating files in the next folder:

After initial installation, some actor config files are already present. All can be used as example (copy-paste) to add extra actors. The name of the file, without the extension, needs to be used to identify by which actor the action needs to be performed.

The template examples are given for 3 different types of actors: doctor, nurse and pharmacy.

After copy paste of the appropriate example file, insert the correct info for the new actor:

The needed info in the above template is the certificate name, the password of the certificate, the SSIN, the NIHII number and the actor's name. The location of the certificate can be freely chosen, but it is good practice to put it in the same folder as the example by installation:

Since EVS follows all the rules for eHealth and Vitalink, it is up to the user to make sure the proper eHealth dependencies (therapeutic relation, ...) are set in function of the wanted behaviour.

Parameterisation

The next parameters can be passed when launching EVSg:

Example of a parameterisation:

Appendix A: Folder structure EVSg 2.x.y

This paragraph gives a brief overview of the folder structure after initial installation. It can be used as reference while using and configuring EVSg.

Path								Reserved path	Reserved name	Explanation
EVSg										The root folder. The name and location can be freely chosen. Keep in mind that paths used in scenarios, patient and actor files are possibly impacted by changes to this!
	\config									Everything that defines the behaviour of EVSg, configured as needed by the user.
		\actors								All the actors that can be used by EVSg.
		\log4j								Settings of the log4j library. Please refer to https://logging.apache.org/log4j/2.x/manual/configuration.html for more explanation.
		\patients								All the patients that can be used by EVSg.
	\exe
		\certificates								The certificates used in the actor configuration files.
		\exports								The folder were the EVS-exporter will put exported vault contents, see EVSg_3_Manual
		\interaction
			\input
				\katrien
					\gp_van_gucht
						\m				This folder contains the actions for transactiontype "Medicationscheme"
							\add
							\export
							\generateREF
							\replace
							\updateschemeREF
						\s				This folder contains the actions for transactiontype "Sumehr"
							\add
							\empty
							\export
							\generateREF
							\removeREF
							\replace
							\updateREF
				\patient_template
			\processed
	\logs									Can be configured through the log4j settings.
		\communication
	\scenarios
		\basic_example
	\system
		\dependency-jars

Appendix B: EVSg-exporter

Besides the interaction provided by dropping files in the input folder, EVSg offers as extended functionality the continuous monitoring of the vault contents. This functionality is provided by EVSg-exporter.

Launching

EVSg-exporter can be launched via the "vault-exporter.cmd" batch file:

The behaviour of EVSg-exporter must be determined by passing some mandatory parameters. Instead of using the "vault-exporter.cmd" batch file, it is easier to use the example batch file "start EVS exporter.cmd":

After initial installation, launching the EVSg-exporter means that the vault contents of the patient "katrien" will be monitored.

Output

When EVSg-exporter detects for the given patients a change in the vault contents, an export is executed. The export is also executed after initial launch.

The exported files are put in the next folder, with for each monitored patient a subfolder. The subfolder is automatically created when the monitoring for this patient is initially started.

The files contain the same as the files generated by EVSg in the processed-folder, but the filenames differ. As such, there are different naming conventions for "Medicationscheme" and "Sumehr".

For EVSg-exporter, each filename of transactiontype "Medicationscheme" exists out of:
<transactiontype>_<version>_<patient>_<date>_<time>-<author>_size-<nr of MSE transactions>_<unique code>_<output suffix>.<output extension>

For EVSg-exporter, each filename of transactiontype "Sumehr" exists out of:
<transactiontype>_<version>_<patient>_size-<nr of Sumehr transactions>_<unique code>.<output extension>

When the export fails, an error file will be generated, which is the same behaviour as for the folder-triggered export action of EVSg.

Parameterisation

The next parameters can be passed when launching EVSg-exporter:

Example of a parameterisation:

Appendix C: shiftAction

This paragraph gives an explanation about what shiftAction is and how to use it.

shiftAction has three different values:

• tag_and_no_shift
• shift_and_tag
• no_tag_and_no_shift
  
  

Tag sets or updates a reference date as a "recorddatetime"-tag in the XML-file. This reference date is ALWAYS today's date.

Shift ensures that all other dates in the XML-file are adjusted in reference to the reference date.

tag_and_no_shift will set a new reference date to today's date or update an existing reference date.
This reference date will be added/updated in the XML-file as a "recorddatetime"-tag.
it will not change any other date in the XML-file.

shift_and_tag ensures that all other dates in the XML-file are adjusted in reference to today's date.
Afterwards it will update the "recorddatetime"-tag.

Suppose that today's day is 06 Jun 2018:

*The "recorddatetime"-tag needs to exist in the XML-file prior to executing it, else it will not change the dates according to today's date but it will add a "recorddatetime"-tag.

no_tag_and_no_shift will not create or update the "recorddatetime"-tag and it will not adjust all other dates according to today's date.

*If a "recorddatetime"-tag already exists in the XML-file and you run EVS with no_tag_and_no_shift, the tag will be removed.