Difference between revisions of "Single Patient Identifier"
(→Overview) |
m (→SPM Version History) |
||
| (31 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == | + | == Program Overview == |
| − | + | * Project: 179 MFT Single Patient Identifier | |
| + | * Specification: v1.1 | ||
| + | * Specification Date: 10-Dec-2018 | ||
| − | The Aquila Substitution Program Module (SPM) is a Windows 32-bit application. It provides functionality to | + | The Aquila Substitution Program Module (SPM) is a Windows 32-bit application. |
| + | |||
| + | It provides functionality to import a mapping file; produce a legacy identifier report and perform identifier substitution. | ||
<center> | <center> | ||
| Line 13: | Line 17: | ||
</center> | </center> | ||
| − | + | == Installation == | |
| − | + | You will need to be logged in to the website to access the download. A user profile will have been provided to you. | |
| − | + | The SPM installation file is available here: [https://www.evolutionhealthcaresystems.co.uk/download/spm evolutionhealthcaresystems.co.uk/download/spm/] | |
| − | You will need to enter the connection details of an existing AquilaCRS SQL Server database. | + | Alternatively, follow the ''Downloads'' link on the top right of our website, and open the ''Miscellaneous'' folder. |
| + | |||
| + | You will need to enter the connection details of an existing AquilaCRS SQL Server database during the installation. This can be changed at runtime. | ||
| + | |||
| + | === Upgrades === | ||
| + | |||
| + | To upgrade, just install over-the-top of an existing SPM installation. Settings will be remembered. | ||
=== Rollback Procedure === | === Rollback Procedure === | ||
| Line 27: | Line 37: | ||
Therefore please '''ensure you have backed up the database prior to running the substitution'''. | Therefore please '''ensure you have backed up the database prior to running the substitution'''. | ||
| − | + | == Settings == | |
The SPM settings are stored in the logged in users "local app data" folder, under the sub-folder '''AquilaSPM'''. | The SPM settings are stored in the logged in users "local app data" folder, under the sub-folder '''AquilaSPM'''. | ||
| Line 36: | Line 46: | ||
Add the output folders for the Summary Log and Execution Log. Both locations can be the same folder as the filenames are generated automatically. '''**''' | Add the output folders for the Summary Log and Execution Log. Both locations can be the same folder as the filenames are generated automatically. '''**''' | ||
| + | |||
| + | The output folders do not support FTP/SFTP. | ||
The creation of an execution log file is optional and can be turned off via the ''Output Execution Log'' option. (An execution log table is always created, so you have the option of outputting the execution log using SQL Server tools at a later point). | The creation of an execution log file is optional and can be turned off via the ''Output Execution Log'' option. (An execution log table is always created, so you have the option of outputting the execution log using SQL Server tools at a later point). | ||
| Line 43: | Line 55: | ||
Press '''Save Settings''' when done. If the database connection has changed, a new connection will be made at this point. | Press '''Save Settings''' when done. If the database connection has changed, a new connection will be made at this point. | ||
| − | + | == Import Mapping File == | |
[[File:Spi mapping import.png|450px]] | [[File:Spi mapping import.png|450px]] | ||
| Line 57: | Line 69: | ||
A list of previous mapping file imports can be seen on this page also. | A list of previous mapping file imports can be seen on this page also. | ||
| − | + | == Legacy Identifiers == | |
| + | |||
| + | If time allows, it is recommended that the mapping file is imported prior to producing this report. | ||
Switch to the ''Legacy IDs'' tab and press the '''Legacy IDs''' button. | Switch to the ''Legacy IDs'' tab and press the '''Legacy IDs''' button. | ||
| Line 63: | Line 77: | ||
Progress will be shown at the foot of the screen and in the log window. | Progress will be shown at the foot of the screen and in the log window. | ||
| − | A file will be produced in the ''Execution Log Folder'' '''**''' called `LEGACY_systemcode_yyyy-mm-dd_hhnnss.csv` | + | A file will be produced in the ''Execution Log Folder'' '''**''' called `LEGACY_systemcode_yyyy-mm-dd_hhnnss.csv` e.g. LEGACY_IBID_2019-08-19_143200.csv |
| − | + | [[File:Spi legacy.png|400px]] | |
| − | + | === Mapping File Usage === | |
| − | + | If a mapping file has been imported the Legacy ID report will attempt to verify if a non-RM2 number is in fact an RM2 number missing it's prefix by looking it up in the mapping file and comparing patient attributes. | |
| − | To initiate the identifier substitution, switch to the ''Identifier Substitution'' tab and press the '''ID | + | If there is no mapping file imported, the legacy report will include identifiers that do not start with "RM2". |
| + | |||
| + | == Identifier Substitution == | ||
| + | |||
| + | To initiate the identifier substitution, switch to the ''Identifier Substitution'' tab and press the '''ID Substitution''' button. | ||
[[File:Spi substitution.png|450px]] | [[File:Spi substitution.png|450px]] | ||
| − | Once completed, the log files will be created in the folders'''**''' specified in the initial setup. | + | Once completed, the log files will be created in the folders'''**''' specified in the initial setup. |
| − | === | + | The execution log creation is conditional on that option being selected in the settings page. |
| + | |||
| + | A copy of the summary log will also be written to the on-screen log: | ||
| + | |||
| + | [[File:Spi substitution 2.png|400px]] | ||
| + | |||
| + | === Re-Output Logs === | ||
| + | |||
| + | Will re-create the Summary and Execution Log of the identifier substitution. You can turn off the execution log for a decrease in identifier substitution and then output the logs any time afterwards (do not run "clean up" until you have the logs exported at least once). | ||
| + | |||
| + | == Utilities == | ||
'''Clean Up''' | '''Clean Up''' | ||
This option removes all SPM related tables from the AquilaCRS database. To be used when the substitution has taken place and been verified and accepted by the burn unit. | This option removes all SPM related tables from the AquilaCRS database. To be used when the substitution has taken place and been verified and accepted by the burn unit. | ||
| + | |||
| + | |||
| + | == SPM Version History == | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width: 900px; align: center;" | ||
| + | ! scope="col" | Version | ||
| + | ! scope="col" | Date | ||
| + | ! scope="col" | Release Notes | ||
| + | |- | ||
| + | | align="center"|0.9 || align="center"|19-Aug-2019 || Initial Release | ||
| + | |- | ||
| + | | align="center"|0.10 || align="center"|21-Aug-2019 || Deactivate/reactivate indexes on mapping table to improve import performance | ||
| + | |- | ||
| + | | align="center"|1.0 || align="center"|02-Sep-2019 || ID Substitution Implementation (beta) | ||
| + | |- | ||
| + | | align="center"|1.5 || align="center"|10-Sep-2019 || Updates to reflect specification v1.5<br>- new labels & data in Summary Log<br>- alteration of time element of filenames | ||
| + | |- | ||
| + | | align="center"|1.6 || align="center"|10-Sep-2019 || Fixes based on first test runs<br> | ||
| + | - Increase spiExecutionLog.FACIL_RM2 field to 20 chars<br> | ||
| + | - Inclusion of TABLENAME parameter in Summary Log output<br> | ||
| + | - Improvements to responsiveness whilst committing changes (in between processing and writing logs)<br> | ||
| + | - Removal of unnecessary 300 code entries | ||
| + | |- | ||
| + | | align="center"|1.7 || align="center"|09-Oct-2019 || Fixed error in outputting summary log | ||
| + | |- | ||
| + | | align="center"|1.8 || align="center"|18-Dec-2019 || Small bug fix to check for Execution.IsSuccess not IsProcessed in subsitution algorithm | ||
| + | |} | ||
Latest revision as of 19:47, 10 August 2020
Contents
Program Overview
- Project: 179 MFT Single Patient Identifier
- Specification: v1.1
- Specification Date: 10-Dec-2018
The Aquila Substitution Program Module (SPM) is a Windows 32-bit application.
It provides functionality to import a mapping file; produce a legacy identifier report and perform identifier substitution.
** The SPM imports a mapping file and produces a summary and execution log files. It is strongly recommended that all file locations are on the local server and not on a network to avoid performance degredation.
If necessary copy the files to, and from, the required locations outside of the SPM program.
Installation
You will need to be logged in to the website to access the download. A user profile will have been provided to you.
The SPM installation file is available here: evolutionhealthcaresystems.co.uk/download/spm/
Alternatively, follow the Downloads link on the top right of our website, and open the Miscellaneous folder.
You will need to enter the connection details of an existing AquilaCRS SQL Server database during the installation. This can be changed at runtime.
Upgrades
To upgrade, just install over-the-top of an existing SPM installation. Settings will be remembered.
Rollback Procedure
During testing and in the event of a problem, the roll-back procedure is to use SQL Server tools to restore the database to a point in time prior to the start of the process.
Therefore please ensure you have backed up the database prior to running the substitution.
Settings
The SPM settings are stored in the logged in users "local app data" folder, under the sub-folder AquilaSPM.
The database connection information should be correct, but you can alter it here.
Add the output folders for the Summary Log and Execution Log. Both locations can be the same folder as the filenames are generated automatically. **
The output folders do not support FTP/SFTP.
The creation of an execution log file is optional and can be turned off via the Output Execution Log option. (An execution log table is always created, so you have the option of outputting the execution log using SQL Server tools at a later point).
Additional settings can be altered if necessary, i.e. CSV separator, system code & name.
Press Save Settings when done. If the database connection has changed, a new connection will be made at this point.
Import Mapping File
Switch to the Mapping File tab. Press the Import button and select the mapping file **
The progress of the import will be shown at the foot of the window, & messages will appear in the log window. (information is posted every 50k records imported).
You can press "Cancel" at any point, this will roll-back all changes and the database will be returned to the state prior to the Import button being activated.
Existing mapping file records are deleted prior to import.
A list of previous mapping file imports can be seen on this page also.
Legacy Identifiers
If time allows, it is recommended that the mapping file is imported prior to producing this report.
Switch to the Legacy IDs tab and press the Legacy IDs button.
Progress will be shown at the foot of the screen and in the log window.
A file will be produced in the Execution Log Folder ** called `LEGACY_systemcode_yyyy-mm-dd_hhnnss.csv` e.g. LEGACY_IBID_2019-08-19_143200.csv
Mapping File Usage
If a mapping file has been imported the Legacy ID report will attempt to verify if a non-RM2 number is in fact an RM2 number missing it's prefix by looking it up in the mapping file and comparing patient attributes.
If there is no mapping file imported, the legacy report will include identifiers that do not start with "RM2".
Identifier Substitution
To initiate the identifier substitution, switch to the Identifier Substitution tab and press the ID Substitution button.
Once completed, the log files will be created in the folders** specified in the initial setup.
The execution log creation is conditional on that option being selected in the settings page.
A copy of the summary log will also be written to the on-screen log:
Re-Output Logs
Will re-create the Summary and Execution Log of the identifier substitution. You can turn off the execution log for a decrease in identifier substitution and then output the logs any time afterwards (do not run "clean up" until you have the logs exported at least once).
Utilities
Clean Up
This option removes all SPM related tables from the AquilaCRS database. To be used when the substitution has taken place and been verified and accepted by the burn unit.
SPM Version History
| Version | Date | Release Notes |
|---|---|---|
| 0.9 | 19-Aug-2019 | Initial Release |
| 0.10 | 21-Aug-2019 | Deactivate/reactivate indexes on mapping table to improve import performance |
| 1.0 | 02-Sep-2019 | ID Substitution Implementation (beta) |
| 1.5 | 10-Sep-2019 | Updates to reflect specification v1.5 - new labels & data in Summary Log - alteration of time element of filenames |
| 1.6 | 10-Sep-2019 | Fixes based on first test runs - Increase spiExecutionLog.FACIL_RM2 field to 20 chars |
| 1.7 | 09-Oct-2019 | Fixed error in outputting summary log |
| 1.8 | 18-Dec-2019 | Small bug fix to check for Execution.IsSuccess not IsProcessed in subsitution algorithm |
