Introduction

This manual describes EVS v3.3.x. (Best supported by JAVA8)

EVS is an evolution of EVSc, 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.

EVS 3.x.y expands on this by adding Sumehr and Diarynote integration.

Pre-configuration

Due to GDPR, EVS is not configured to work out-of-the-box after initial installation anymore.

Configuration needed to have EVS working in no time:

an actor (with an active acc-key (for Vitalink))
a patient

It is strongly advised to test EVS with this pre-configuration before changing extra configuration for your own needs. Once this test is executed successfully, one should start using his own configuration.

Functionality

General

EVS 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:

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

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

The behaviour of EVS 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 Parameterisation.

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, 3 types named "m", "s" and "d" (meaning "Medicationscheme", "Sumehr" and "Diarynote" respectively) are available:

Which files?

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

All MS transactions are ignored as input.

Where to put the acceptation-environment-token from Vitalink ?

Since EVS went opensource we decided to not use a hard-coded acceptation-key anymore but a 'replaceable' key in the config which is read at run-time.

This key can be added in the (to be used) actor configuration file at the location as described hereabove in the topic 'Which actor?'.

Example:

Acceptation key location in actor config file

<authenticationConfiguration>
    <evs>
        <type>fallback</type>
        <certificates>
            <certificate>
                <type>identification</type>
                <path>..\config\certificates\SSIN=[INSS+SPECIAL CODE].acc-p12</path>
                <password>[PW]</password>
            </certificate>
        </certificates>
    </evs>
    <ehealth>
        <entry>kmehr.hubservicev3.software.id.local.value.1=[VITALINK ACC-KEY]</entry>
        <entry>user.inss=[INSZ]</entry>
        <entry>user.nihii=[NIHII]</entry>
        <entry>user.firstname=[FIRSTNAME]</entry>
        <entry>user.lastname=[LASTNAME]</entry>
        <entry>careprovider.inss=${user.inss}</entry>
        <entry>careprovider.nihii=${user.nihii}</entry>
        <entry>careprovider.firstname=${user.firstname}</entry>
        <entry>careprovider.lastname=${user.lastname}</entry>
...

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.

EVS 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 EVS. 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.

TS transactions can not be updated and should not contain EVS references! They can only be added or removed.

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.

How is a "Diarynote" identified?

For some actions, typically removing "diarynotes", the diarynote that should be changed needs to have an identification. Those sumehrs are expressed as Diarynote transactions. These Diarynote 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, Sumehr or Diarynote 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===". EVS 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, EVS will not execute the action and will raise an error.

Which actions for Medicationscheme?

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

Only transactions of transactiontype "Medicationscheme" can be used for input. Any other transactiontype will be ignored.

To be translated:

Actions

ADD voegt nieuwe lijnen toe, dus daar sturen we nog geen vitalink URI mee waardoor de kluis het als een 'nieuwe' lijn beschouwt,

ADD vraagt achterliggend ook eerst de hele kluisinhoud op, zodat we de nieuwe lijn kunnen toevoegen aan de bestaande kluisinhoud want alles wat je niet zou meesturen wordt gewist uit vitalink (zoals updateREF)

REPLACE doet ( als ik me niet vergis) eerst een empty van de kluis door een puttransactionsetrequest te doen zonder medicatielijnen. Vervolgens een tweede call met daarin de lijnen van het inputbestand

UPDATEREF vraagt ook eerst alles op, en tracht dan de medicatielijn(en) uit het inputbestand op te zoeken in Vitalink, om vervolgens die lijnen als gewijzigd te markeren in uitgaande bericht

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. EVS 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.

The 'old' EVS, with Vitalink connector-integration, added the references to the input file, followed by putting this 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.

If you want to 'empty' the medicationscheme in the vault. Drop an empty textfile OR a valid XML without any MSE in the REPLACE folder.

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.

Action "updateREF"

Looking a lot like updateSchemREF, this action will update 1 or more targetted MSE transactions within the transactiontype MedicationScheme on the vault without touching the other MSE's, not included in the source file. So the source file does NOT include the complete MS with updated + non-updated MSE's but an MS with only the MSE's you want to alter.

An ERROR status is thrown in following cases:

1 or more of the included MSE in the MS of the sourcefile contains an EVSREF that was not found in the MS on the vault, no update will happen untill corrected
1 or more of the included MSE in the MS of the sourcefile does not contain an EVSREF, no update will happen untill corrected

If no difference is found between input MS and vault MS, no update will happen.

The next actions will take place:

If no ERROR is detected in the source file, before executing the update (PutTransaction), a list is provided in the EVS console of all MSE's entries with their maching EVSREF's found within the targetted MS on the vault, together if it will be updated or not.

an MSE transaction with EVSREF already existing in the vault will be updated if any difference between the input-MSE transaction and vault-MSE transaction is found and versionnr of MSE + MS will be +1

Empty

The 'old' EVS, with Vitalink connector-integration, offered an action 'empty'. EVS doesn't offer this action anymore. Now, emptying the vault can be done by dropping an empty file for the actions "updateschemeREF" or "replace".