=============================================================================
Run Date: DEC 17, 2020                     Designation: MAG*3*282
Package : MAG - IMAGING                       Priority: Mandatory
Version : 3       SEQ #195                      Status: Released
                  Compliance Date: JAN 04, 2021
=============================================================================

Associated patches: (v)MAG*3*59    <<= must be installed BEFORE `MAG*3*282'

Subject: getTIUNote Web Service Endpoint Enhancement

Category: 
  - Routine

Description:
============

 MAG*3.0*282 adds functionality to support external applications that use 
 the VIX Ingest web services. The general VistA Imaging end-user is not 
 affected by the changes in this patch. The MAGGNTI2 routine which is 
 called by the MAG3 TIU LONG LIST OF TITLES RPC was modified to support 
 additional matching logic.
  
 This patch modifies the getTIUNoteTitles endpoint of the VIX Ingest Web 
 Service to allow the calling application to specify the matching 
 criteria. If the searchText attribute has a ";1" at the end of the search 
 string, the service call results will include any TIU Note Titles that 
 match or begin with the search string. If the search text only contains
 the search text (without ";1" at the end), the results are the same as
 they were prior to the patch install. In addition to the additional
 matching criteria, this patch will also allow the caller to specify more
 than one word in the searchText attribute.  Note that any spaces between
 words sent in the searchText attribute must be replaced with the %5B%5D
 encoding characters before the web service call is made.
  
 An example of using the getTIUNoteTitles endpoint before and after the 
 patch is installed is shown below. Before the patch is installed, the 
 results of a query for the searchText "imed" returns a long list of 
 titles which is intended to dynamically fill a selection list in the 
 calling application. After the patch is installed, the query has an 
 optional parameter that can be added to the searchText attribute to 
 indicate alternative search criteria to be used.  If ";1" (without 
 quotes) is added to the end of the searchText, the results will only 
 contain TIU Titles that contain the search text.
  
 getTIUNoteTitles Query Results before MAG*3.0*282 Install:
  
 query URL:  
 http://{server:port}/TIUWebApp/token/restservices/tiu/notes/titles/{siteId
 }
 searchText:  imed
  
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <notes>
     <note>
         <keyword>IMED  </keyword>
         <noteClass>NOTE</noteClass>
         <title>ADMINISTRATIVE IMED</title>
         <tiuNoteTitleUrn>urn:tiu:500-406</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>IMED  </keyword>
         <noteClass>NOTE</noteClass>
         <title>CONSENT CLINICAL IMED</title>
         <tiuNoteTitleUrn>urn:tiu:500-407</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>IMMUNE  </keyword>
         <noteClass>NOTE</noteClass>
         <title>C&amp;P INFECTIOUS, IMMUNE AND NUTRITIONAL
            DISABILITIES</title>
         <tiuNoteTitleUrn>urn:tiu:500-1326</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>IMPAIRMENT  </keyword>
         <noteClass>NOTE</noteClass>
         <title>VISUAL IMPAIRMENT CLINIC INITIAL VISIT</title>
         <tiuNoteTitleUrn>urn:tiu:500-1391</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>IMPAIRMENT  </keyword>
         <noteClass>NOTE</noteClass>
         <title>VISUAL IMPAIRMENT MEDICAL EXAM</title>
         <tiuNoteTitleUrn>urn:tiu:500-1390</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>INDEPENDENCE  </keyword>
         <noteClass>NOTE</noteClass>
         <title>SCI FUNCTIONAL INDEPENDENCE MEASURE</title>
         <tiuNoteTitleUrn>urn:tiu:500-1364</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>INDEX  </keyword>
         <noteClass>NOTE</noteClass>
         <title>ASI-ADDICTION SEVERITY INDEX</title>
         <tiuNoteTitleUrn>urn:tiu:500-40</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>INFECTIOUS  </keyword>
         <noteClass>NOTE</noteClass>
         <title>C&amp;P INFECTIOUS, IMMUNE AND NUTRITIONAL 
 DISABILITIES</title>
         <tiuNoteTitleUrn>urn:tiu:500-1326</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>INFECTIOUS  </keyword>
         <noteClass>NOTE</noteClass>
         <title>PATIENT RECORD FLAG CATEGORY II - INFECTIOUS 
 DISEASE</title>
         <tiuNoteTitleUrn>urn:tiu:500-1356</tiuNoteTitleUrn>
     </note>
 .
 .
 .
 </notes>
  
 ==========================================================================
  
 getTIUNoteTitles Query Results After MAG*3.0*282 Install: 
  
 Single word query:
 query URL:  
 http://{server:port}/TIUWebApp/token/restservices/tiu/notes/titles/{siteId
 }
 searchText:  imed;1
  
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <notes>
     <note>
         <keyword>IMED CONSENT  </keyword>
         <noteClass>NOTE</noteClass>
         <title>IMED CONSENT</title>
         <tiuNoteTitleUrn>urn:tiu:500-1387</tiuNoteTitleUrn>
     </note>
     <note>
         <keyword>IMED GENERAL  </keyword>
         <noteClass>NOTE</noteClass>
         <title>IMED GENERAL</title>
         <tiuNoteTitleUrn>urn:tiu:500-1388</tiuNoteTitleUrn>
     </note>
 </notes>
  
  
 Multi-word query:
 query URL:  
 http://{server:port}/TIUWebApp/token/restservices/tiu/notes/titles/{siteId
 }
 searchText:  imed%5B%5Dgeneral;1
 Eg. 
 http://x.x.x.x:8080/TIUWebApp/token/restservices/tiu/notes/titles/500?sear
 chText=IMED%5B%5D GENERAL;1&securityToken=tFC8H4kxyt
  
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <notes>
     <note>
         <keyword>IMED GENERAL  </keyword>
         <noteClass>NOTE</noteClass>
         <title>IMED GENERAL</title>
         <tiuNoteTitleUrn>urn:tiu:500-1388</tiuNoteTitleUrn>
     </note>
 </notes>
  
 Patch Components:
 -----------------
 Files & Fields Associated:
  
 File Name (Number)          Field Name (Number)       New/Modified/Deleted
 ------------------          -------------------       --------------------
 N/A
  
 Forms Associated:
  
 Form Name                   File Number               New/Modified/Deleted
 ---------                   -----------               --------------------
 N/A 
  
 Mail Groups Associated:
  
 Mail Group Name             New/Modified/Deleted
 ---------------             --------------------
 N/A
  
 Options Associated:
  
 Option Name                 Type                      New/Modified/Deleted
 -----------                 ----                      --------------------
 N/A
  
 Protocols Associated:
  
 Protocol Name               New/Modified/Deleted
 -------------               --------------------
 N/A
  
 Security Keys Associated: 
  
 Security Key Name
 -----------------
 N/A
  
 Templates Associated:
  
 Template Name         Type    File Name (Number)      New/Modified/Deleted
 -------------         ----    ------------------      --------------------
 N/A
  
 Remote Procedures Associated:
  
 Remote Procedure Name            New/Modified/Deleted
 ---------------------            --------------------
 MAG3 TIU LONG LIST OF TITLES         Modified
  
 Parameter Definitions Associated:
  
 Parameter Name              New/Modified/Deleted
 --------------              --------------------
 N/A
  
 Additional Information:
 -----------------------
  
 Blood Bank Team Coordination:
 N/A
  
 New Service Requests (NSRs):
 N/A
  
 Patient Safety Issues (PSIs):
 N/A
  
 Defect Tracking System Ticket(s) & Overview:
 N/A
  
 Test Sites:
 -----------
 Boston, MA
 El Paso, TX
 Miami, FL
  
 Software and Documentation Retrieval Instructions:
 --------------------------------------------------
 The software for this patch is being released using a host file.
  
 The host file is available at the following location:
 /srv/vista/patches/SOFTWARE/MAG3_0P282.KID
  
  
 File Title                              File Name                     
 ---------------------------------------------------------------------
 Kernel Installation and                 MAG3_0P282.KID
 Distribution System (KIDS) 
 build for MAG*3.0*282
  
 Documentation Title     File Name                     
 ---------------------------------------------------------------------
 Patch Description for MAG*3.0*282       MAG3_0P282_Patch_Description.pdf
  
 Deployment, Installation, Back-Out,     MAG3_0P282_DIBORG.pdf
 and Rollback Guide
  
 Patch Installation:
 -------------------
 Pre/Post Installation Overview:
 --------------------------------
 MAG*3.0*282 must be installed on the VistA System. This patch must be 
 installed by the compliance date.
  
 This patch should take less than five minutes to install.
  
 Note: All released VistA Imaging patches must be installed on the VistA 
 system before installing MAG*3.0*282.
  
 Installation Instructions:
 --------------------------------
 1.  Use the Load a Distribution option contained on the Kernel 
     Installation and Distribution System Menu to load the Host file. 
  
     When prompted to "Enter a Host File:" enter
     /srv/vista/patches/SOFTWARE/MAG3_0P282.KID
  
 2.  From the Kernel Installation and Distribution System Menu, select 
     the Installation Menu. From this menu: 
  
     A.  Select the Verify Checksums in Transport Global option to confirm 
         the integrity of the routines that are in the transport global.
         When prompted for the INSTALL NAME, enter the patch or build name
         (ex. MAG*3.0*282).
  
     B.  Select the Backup a Transport Global option to create a backup
         message of any routines exported with this patch. It will not
         backup any other changes such as Data Dictionaries (DDs) or
         templates. 
  
     C.  You may also elect to use the following options: 
         i. Print Transport Global - This option will allow you to view the
            components of the KIDS build.
        ii. Compare Transport Global to Current System - This option will
            allow you to view all changes that will be made when this patch
            is installed.  It compares all components of this patch, such
            as routines, DDs, templates, etc.
  
     D.  Select the Install Package(s) option and choose the patch to
         install.
         i. If prompted 'Want KIDS to Rebuild Menu Trees Upon Completion of
            Install?,' answer NO.
        ii. When prompted 'Want KIDS to INHIBIT LOGONs during the
            install?,' answer NO.
  
 VistA Client Installation Instructions
 ----------------------------------------
 N/A - Application client installation is not required in a KIDS-only 
 build.
  
 Post-Installation Instructions:
 --------------------------------
 N/A - Application client installation is not required in a KIDS-only 
 build.
  
 Back-Out/Roll Back Plan:
 ------------------------
 If a roll back is necessary, use the 'ROUTINE' LOAD PackMan option to 
 restore the original routine from the Mailman backup copy that was 
 created from the 'Backup A Transport Global' option was run during the 
 initial patch install.
  
 Uninstalling the Application:
 ------------------------------
 N/A - Application client installation is not required in a KIDS-only 
 build.
  
 KIDS Uninstall:
 ----------------
 If it is necessary to uninstall the MAG*3.0*282 VistA KIDS, select the 
 Kernel Installation & Distribution System menu option, Backup a Transport 
 Global, see the Installation Steps section where step 4c must be done 
 before installing the patch.
 Administrators will need to use the PackMan function INSTALL/CHECK 
 MESSAGE. Check the MailMan messages for the backup message sent by the 
 Backup a Transport Global function executed prior to the patch install.
  
 1.  Select the message shown below:
     Backup of MAG*3.0*282 install on <mmm dd, yyyy> <user name>
 2.  Select the Xtract PackMan option.
 3.  Select the Install/Check Message option.
 4.  Enter Yes at the prompt.
 5.  Enter No at the backup prompt. There is no need to back up the 
     backup.
  
 Enter message action (in IN basket): Ignore// Xtract PackMan
 Select PackMan function: ?
     Answer with PackMan function NUMBER, or NAME
    Choose from:
    1            ROUTINE LOAD
    2            GLOBAL LOAD
    3            PACKAGE LOAD
    4            SUMMARIZE MESSAGE
    5            PRINT MESSAGE
    6            INSTALL/CHECK MESSAGE
    7            INSTALL SELECTED ROUTINE(S)
    8            TEXT PRINT/DISPLAY
    9            COMPARE MESSAGE
  
 Select PackMan function: Select PackMan function: 6  INSTALL/CHECK MESSAGE
  
 Warning:  Installing this message will cause a permanent update of globals
 and routines.
 Do you really want to do this? NO// YES<Enter>
  
 Routines are the only parts that are backed up.  NO other parts
 are backed up, not even globals.  You may use the Summarize Message
 option of PackMan to see what parts the message contains.
 Those parts that are not routines should be backed up separately
 if they need to be preserved.
  
 Shall I preserve the routines on disk in a separate back-up message? 
 YES// NO
 No backup message built.
  
 Line 2  Message #43934   Unloading Routine  MAGXXXX (PACKMAN_BACKUP)
  
 Select PackMan function:<Enter>
  
 Routine Information:
  
 This section lists modified routines for the VistA KIDS build. For each 
 routine, the second line will contain the following information: 
  
 ;;3.0;IMAGING;**[Patch List]**; Mar 19, 2002;Build 1;Feb 15, 2017
  
 CHECK1^XTSUMBLD is used to generate the checksums.
  
 Routine Checksums
  
 Routine         Before Checksum        After Checksum       Patch List
 MAGGNTI2        21199592               40037476             **46,59,282**
 MAGIP282        New                    4110419              **282**
  
 Routine MAGIP282 is an installation routine that is automatically deleted 
 after the KIDS installation.

Routine Information:
====================
No routines included.

=============================================================================
User Information:
Entered By  :                               Date Entered  : SEP 29, 2020
Completed By:                               Date Completed: DEC 14, 2020
Released By :                               Date Released : DEC 17, 2020
=============================================================================


Packman Mail Message:
=====================

No routines included