| Note | ||
|---|---|---|
| ||
This page is still under construction. |
| Table of Contents |
|---|
Introduction
...
<date>-<time>_<patient>_<actor>_<action>_<input filename>_size-<nr of data entries>_<output suffix>.<output extension>
| Name | Output suffix | Extension | Description | Remarks |
|---|---|---|---|---|
Validation file | VALIDATION-OK VALIDATION-<###>-FAILED | .val | The report of the validation. | The filename contains the number of warnings and errors when the validation fails.
|
Global scheme PDF | globalscheme | A visualisation of the global scheme in PDF format. | - | |
Daily scheme PDF | dailyscheme-<date> | A visualisation of the daily scheme in PDF format. | This is the scheme of the medication that should be taken today. | |
Export file | - | .exp | An export of the contents of the vault. | - |
Input file | - | .inp | The original input file. | The filename does not include the number of data entries in the vault. |
If for some reason the action fails, an error output file is generated:
| Name | Output suffix | Extension | Description | Remarks |
|---|---|---|---|---|
Error file | - | .err | The report containing the error. | The content of the error file will identify the problem. |
Configuration
This paragraph explains how to configure EVS2.
...
The next parameters can be passed when launching EVS:
| Name | Values | Meaning |
|---|---|---|
| rootdir | "..\exe\interaction" | Relative or absolute path to the folder that needs to be watched by EVS. This folder should contain the requested actions. |
| writeAsIs | true|false | false: All patient data from the source Kmehrmessage will be replaced by the correspondign data of the used input patient. Since the Kmehr data model is used for this transformation, it is possible that other Kmehr structure elements are slightly changed too. true: The Kmehrmessage will be sent to the vault untouched. Use this when really no manipulation on the source Kmehrmessage is desired. |
| exportAfterUpload | true|false | true: Each action, excepted "export" itself, should be followed by an export. false: No export is needed after execution of the triggered action. |
| validateExportAfterUpload | true|false | true: Each action should be followed by validation of the vault content. false: No validation is needed. |
| generateGlobalMedicationScheme | true|false | true: Each action should be followed by the generation of a global scheme visualisation PDF. false: No global scheme visualisation is needed. |
| generateDailyMedicationScheme | true|false | true: Each action should be followed by the generation of a daily scheme visualisation PDF. false: No daily scheme visualisation is needed.
|
Example of a parameterisation:
...
This paragraph gives a brief overview of the folder structure after initial installation. It can be used as reference while using and configuring the EVS.
| Path | Reserved path | Reserved name | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| EVS |  | | 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 EVS, configured as needed by the user. | |||||
| \actors | | | All the actors that can be used by EVS. | ||||||
| \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 EVS. | ||||||
| \exe | | | |||||||
| \certificates | | | The certificates used in the actor configuration files. | ||||||
| \exports | |
| The folder were the EVS-exporter will put exported vault contents, see EVS 2 user manual | ||||||
| \interaction | | | |||||||
| \input | | | |||||||
| \katrien | | | |||||||
| \gp_van_gucht | | | |||||||
| \add | | | |||||||
| \empty | | | |||||||
| \export | | | |||||||
| \removeID | | | |||||||
| \removeREF | | | |||||||
| \replace | | | |||||||
| \updateID | | | |||||||
| \updateREF | | | |||||||
| \generateREF | | | |||||||
| \updateschemeREF | | | |||||||
| \patient_template | | | |||||||
| \processed | | | |||||||
\scenarios | | | |||||||
| \basic_example | | | |||||||
| \system | | | |||||||
| \dependency-jars | | | |||||||
Appendix B: EVS-exporter
Besides the interaction provided by dropping files in the input folder, EVS offers as extended functionality the continuous monitoring of the vault contents. This functionality is provided by EVS-exporter.
...
For EVS-exporter, each filename exists out of:
sv-<subject version>_nv-<node version>_<date>-<time>_<patient>_size-<nr of data entries>_<unique code>_updatedby_<actor>_<output suffix>.<output extension>
| Name | Source |
|---|---|
Subject version | "Version" from FetchDataEntriesResponse->Node as returned by the connector:
See http://www.vitalink.be/sites/default/files/atoms/files/Safe_Cookbook_API_v4%202.pdf
|
Node version | "Version" from FetchDataEntriesResponse as returned by the connector.
|
Date | Today. |
Time | Now. |
Patient | Name of the patient as defined in the EVS configuration. |
| Nr of data entries | Number of data entries in the vault as as returned by the connector. |
| Unique code | Code making the filename unique in case multiple exports where done in 1 second. |
| Actor | "Person" from FetchDataEntriesResponse->UpdatedBy as returned by the connector. |
| Output suffix | Hard coded, depending on file type. For the validation file, the number of warnings and errors and possible failure are shown. |
| Output extension | Hard coded, depending on file type. |
When the export fails, an error file will be generated, which is the same behaviour as for the folder-triggered export action of EVS.
...
The next parameters can be passed when launching EVS-exporter:
| Name | Values | Meaning |
|---|---|---|
| transactionType | "medication-scheme" | This parameter is for future use. For the moment only 1 transaction type is supported. |
| patients | name(s) as defined in EVS configuration, comma separated | This(these) is(are) the patient(s) that will be monitored and whose vault content(s) will be exported. |
| actor | name as defined in EVS configuration | This is the actor that will be used for exporting. |
| exportDir | default "..\exe\exports" | This is the path where the output files will be generated. This location can be freely chosen. |
| validate | true|false | true: Each export should be followed by validation of the vault content. false: No validation is needed. |
| generateGlobalMedicationScheme | true|false | true: Each action should be followed by the generation of a global scheme visualisation PDF. false: No global scheme visualisation is needed. |
| generateDailyMedicationScheme | true|false | true: Each action should be followed by the generation of a daily scheme visualisation PDF. false: No daily scheme visualisation is needed.
|
Example of a parameterisation:
...