INTEGRATION CONTROL REGISTRATIONS LIST MAY 12, 2021@12:53 PAGE 1 REMOTE PROCEDURE:DESCRIPTION -------------------------------------------------------------------------------- 1 NAME: DBIA1 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other ROUTINE: COMPONENT: Protocol Menu VARIABLES: XQOR Type: Used Set, when an option with type protocol menu is encountered, to the internal number of the option before execution is turned over to OE/RR. ******************** 2 NAME: DBIA2 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other ROUTINE: COMPONENT: MENUMAN VARIABLES: XQUIT Type: Used Tells menuman to quit if a premenu action failed. Since OE/RR also executes premenu actions for protocols, OE/RR needs to tell Menuman to quit when execution is returned. ******************** 3 NAME: DBIA3 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Using the following variables: DT= Date DTIME = Read timeout DUZ = User and paramaters in the DUZ array ROUTINE: ******************** 6 NAME: DBIA6-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The following variables are killed only: D0,DI,DIG,DIH,DIU,DIV,& DIQ DIROUT - Is used as a quick exit when ^^ is entered at prompts. DLAYGO - is used for calls to Fileman. ROUTINE: ******************** 7 NAME: DBIA7 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZOSF( DESCRIPTION: TYPE: File Uses variables DX and DY to call %ZOSF and global %ZOSF to get system specific variables. ROUTINE: ******************** 10 NAME: DBIA10 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: MAR 12,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.5 ROOT: HOLIDAY( DESCRIPTION: TYPE: File USE OF THE HOLIDAY FILE, ^HOLIDAY ROUTINE: ******************** 11 NAME: DBIA11 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: MAR 20,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DPT( & LRT(67, DESCRIPTION: TYPE: File Use of variable pointers to DPT & REFFERAL File. Uses following patient nodes: Address Node .11 Phone node .13 Field 1, Alias subfile 0 Node ^DPT(dfn,0) .01 NAME 0;1 Read w/Fileman .02 SEX 0;2 Read w/Fileman .03 DATE OF BIRTH 0;3 Read w/Fileman .05 MARITAL STATUS 0;5 Read w/Fileman .06 RACE 0;6 Read w/Fileman .07 OCCUPATION 0;7 Read w/Fileman .08 RELIGIOUS PREFERENCE 0;8 Read w/Fileman .09 SOCIAL SECURITY NUMB 0;9 Read w/Fileman .091 REMARKS 0;10 Read w/Fileman .092 PLACE OF BIRTH [CITY 0;11 Read w/Fileman .093 PLACE OF BIRTH [STAT 0;12 Read w/Fileman .14 CURRENT MEANS TEST S 0;14 Read w/Fileman .096 WHO ENTERED PATIENT 0;15 Read w/Fileman .097 DATE ENTERED INTO FI 0;16 Read w/Fileman .081 DUPLICATE STATUS 0;18 Read w/Fileman .082 PATIENT MERGED TO 0;19 Read w/Fileman .083 CHECK FOR DUPLICATE 0;20 Read w/Fileman ^DPT(dfn,.11) .111 STREET ADDRESS [LINE .11;1 Read w/Fileman .112 STREET ADDRESS [LINE .11;2 Read w/Fileman .113 STREET ADDRESS [LINE .11;3 Read w/Fileman .114 CITY .11;4 Read w/Fileman .115 STATE .11;5 Read w/Fileman .116 ZIP CODE .11;6 Read w/Fileman .117 COUNTY .11;7 Read w/Fileman .1112 ZIP+4 .11;12 Read w/Fileman ^DPT(dfn,.13) .131 PHONE NUMBER [RESIDE .13;1 Read w/Fileman .132 PHONE NUMBER [WORK] .13;2 Read w/Fileman ^DPT(dfn,.01,D1,0) .01 ALIAS 0;1 Read w/Fileman 1 ALIAS SSN 0;2 Read w/Fileman ROUTINE: ******************** 12 NAME: DBIA12 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: MAR 21,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other USE OF FILE 63 NODE "LR" AND ^LRDPT FOR DEATH INFORMATION ROUTINE: ******************** 13 NAME: DBIA13 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 21,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File PATIENT NODE .35 - DEATH INFO USED TO STUFF ^LR( GLOBAL. ^DPT(dfn,.35) .351 DATE OF DEATH .35;1 Direct Global Write & .352 DEATH ENTERED BY .35;2 Direct Global Write & ROUTINE: ******************** 15 NAME: DBIA15-A CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File RADIOLOGY PATIENT FILE CROSS REFERENCE ^RAO(75.1,'AS', ROUTINE: ******************** 16 NAME: DBIA16 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 26,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File Surgery file (130). ^SRF(D0,0) .04 SURGERY SPECIALTY 0;4 Read w/Fileman .09 DATE OF OPERATION 0;9 Read w/Fileman ^SRF(D0,.1) .14 SURGEON .1;4 Read w/Fileman ^SRF(D0,14,D1,0) .01 OTHER PREOP DIAGNOSI 0;1 Read w/Fileman 1 PAIRED ORGAN 0;2 Read w/Fileman 2 DIAGNOSIS COMMENTS 1;0 Read w/Fileman ^SRF(D0,15,D1,0) .01 OTHER POSTOP DIAG'S 0;1 Read w/Fileman 1 PAIRED ORGANS 0;2 Read w/Fileman 2 DIAGNOSIS COMMENTS 1;0 Read w/Fileman ^SRF(D0,13,D1,0) .01 OTHER OPERATIVE PROC 0;1 Read w/Fileman 1.5 OP CODE COMMENTS 1;0 Read w/Fileman 2 COMPLETED 0;3 Read w/Fileman 3 PROCEDURE CODE 2;1 Read w/Fileman ^SRF(D0,12,D1,0) 1.15 SURGEON'S DICTATION 12;0 Read w/Fileman Word processing ^SRF(D0,31) 15 DATE/TIME OF DICTATI 31;6 Read w/Fileman 39 DATE OF TRANSCRIPTIO 31;7 Read w/Fileman ^SRF(D0,'OP') 27 PRINCIPAL OP CODE OP;2 Read w/Fileman ^SRF(D0,33) 32 PRINCIPAL PRE-OP DIA 33;1 Read w/Fileman ^SRF(D0,34) 34 PRINCIPAL POST-OP DI 34;1 Read w/Fileman ^SRF(D0,'VER') 43 CASE VERIFICATION VER;1 Read w/Fileman ^SRF(D0,9,D1,0) 49 SPECIMENS AND CULTUR 0;1 Read w/Fileman Multiple ^SRF('B', Used to access data. ROUTINE: ******************** 17 NAME: DBIA17-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAR 12,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File PATIENT MOVEMENT FILE (405). ^DGPM(D0, .05 TRANSFER FACILITY 0;5 Read w/Fileman 99 DIAGNOSIS DX;D1 Direct Global Read & w ^DGPM('ATID'_TT,DFN,INVERSE DT,DA) Movement types will be determined by traversing the following cross-reference: ^DGPM("ATID"_TT,DFN,INVERSE DT,DA), where TT represents code for movement types: 1 - admissions 2 - transfers 3 - discharges 6 - treating speciality NOTE: DA is used to call ^VADPT ^DGPM('APCA', Direct Global Read of the APCA cross-reference on Patient, Admission/Check-In and Movement Date/Time, for sorting data for Health Summary reports. ^DGPM('ATID1', Direct Global Read of the ATID1 cross-reference on Transaction, Patient and Movement Date/Time, for sorting data for Health Summary reports. ^DGPM('ATS', Direct Global Read of the ATS cross-reference on Patient, Admission/Check-In, Movement Date/Time and Treating Specialty, for sorting data for Health Summary reports. ROUTINE: ******************** 19 NAME: DBIA19 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: JAN 29,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File ^DIC(40.7,D0,0) .01 NAME 0;1 Read w/Fileman Pointer to determine Stop Code. Stop Code name used on reports, bulletins. 1 AMIS REPORTING STOP 0;2 Read w/Fileman Used on error-checking validation report to find 700 (non-credit) codes, used on bulletin, used to screen out '900' entries on look-up. 2 INACTIVE DATE 0;3 Read w/Fileman Used on error-checking validation report to find Radiology/Nuc Med procedures pointing to inactive stop codes. Used to screen out inactive selections on look-up. 4 COST DISTRIBUTION CE 0;5 Read w/Fileman Used in sort criteria and heading on Radiology CDR report. ROUTINE: ******************** 21 NAME: DBIA21 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DENTAL USAGE: Private ENTERED: DEC 8,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Fields 220 and 220.1 of the Patient Files were established for Dental use and Dental will begin using them. ^DPT(D0,DENT) 220 DENTAL CLASSIFICATIO DENT;1 Both R/W w/Fileman A code indicating the level of elegibility for Dental Care. 220.1 DENTAL ELIGIBILITY E DENT;2 Both R/W w/Fileman The exiration date of Dental eligibility, if there is one. ROUTINE: ******************** 26 NAME: DBIA26 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK USAGE: Private ENTERED: MAY 8,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: XUTL( DESCRIPTION: TYPE: File ^XUTL('OR',$J,'PSG', Use of ^XUTL("OR",$J,"PSG", Even if OE/RR has not been installed. This makes the options for Inpatient Medications independently invokable. ROUTINE: ******************** 27 NAME: DBIA27 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 17,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File ^DGPT(D0,70) 79 DXLS 70;10 Read w/Fileman Version 4.0 fo Mental Health references field 79, DXLS in the PTF File (^DGPT). The reference is read-only and used for display. ROUTINE: ******************** 29 NAME: DBIA29 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: FEB 13,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Routines LRWU5 & LRWU7 Do direct sets to the Data Dictionary. The routines allow the user to add a new Data Name or Antibiotic without giving programmer access. ROUTINE: ******************** 31 NAME: DBIA31-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK MENTAL HEALTH Added 03/22/21 for Mental Health's Suicide Prevention Project, patch YS*5.01*135. USAGE: Private ENTERED: NOV 14,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File ^DIC(42,D0,0) .01 NAME 0;1 Read w/Fileman .03 SERVICE 0;3 Read w/Fileman 44 HOSPITAL LOCATION FI 44;1 Read w/Fileman ROUTINE: ******************** 33 NAME: DBIA33 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK USAGE: Private ENTERED: NOV 14,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File Inpatient Medications will be referencing the following files & fields: FILE 42 2 ROOM subfile & all fields 2 BED " " X-REF "B" on ROOM-BED FILE 42.3 TRANSFER TYPE EXPIRED AS OF THE RELEASE OF MAS 5. ROUTINE: ******************** 36 NAME: DBIA36-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAR 22,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File ^DIC(42 Used to get link to file 44 for inpatients ROUTINE: ******************** 38 NAME: DBIA38 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: MAY 23,1988 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Cardiology package exports Lab Codes for Cardiology. ROUTINE: ******************** 41 NAME: DBIA41 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JUN 6,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DIBT( DESCRIPTION: TYPE: File Routine DGABTP30 (background job) sets the ^DIBT global. The routine checks for sort templates, specifically [DGPMABSENCES] & [DGPMAB30], through the crossreference, and uses the template's IFN to set node ^DIBT(IFN,1,MOVEMENT IFN) for selected records. ROUTINE: ******************** 42 NAME: DBIA42 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JUN 6,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File LAYGO to the Institution File is allowed through an option in the MCCR module. ROUTINE: ******************** 43 NAME: DBIA43 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: JUN 18,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File ^PRC(442,'B',STATION #) Gets - IFCAP station number with a call to ^PRCFSITE with PRCF("X") ="S" Uses - the IFCAP Station Number to determine whether an obligation number entered by the user exists in IFCAP. Done by doing $D(^PRC(442,"B",STATION NUMBER-OBLIGATION)). ROUTINE: ******************** 44 NAME: DBIA44 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 26,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File ^DG(43,1,'VERSION') 999 VERSION VERSION; Read w/Fileman Checks ^DG(43,1,"VERSION") to determine which version of MAS is running. Migrate to the "VR" node of the DD when made available in Fileman (expected in version 18). ROUTINE: ******************** 47 NAME: DBIA47 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 25,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.9 ROOT: DG(41.9, DESCRIPTION: TYPE: File ^DG(41.9,D0,C,D1,1) 102 OPERATING BEDS 1;2 Direct Global Read & w Used for lookups. ROUTINE: ******************** 51 NAME: DBIA51 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: OCT 22,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 720 ROOT: DESCRIPTION: TYPE: File The .01 field of file 720, "B" crossreference has been modified to be 50 characters rather than the standard 30. ROUTINE: ******************** 54 NAME: DBIA54 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: MCCR BACKBILLING USAGE: Private ENTERED: JUL 5,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MAS version 4.7 will be exporting the following: Routine PRCASVC3 FILE 430.4 AR BILL NUMBER FILE wit input template PRCAF COMMON SERIES Following options make the indicated forgien calls: OPTION ACTION DGCR FILLING SUPERVISOR MENU calls COUNT^PRCAUT2 DGCR BILLING CLERK MENU calls COUNT^PRCAUT2 DGCR RETURNED BILL LIST calls RETN^PRCALST DGCR CANCEL BILL calls CANCEL^PRCASVC1 Return of edited bill calls REL^PRCASVC ROUTINE: ******************** 55 NAME: DBIA55 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION INTEGRATED BILLING The first subscript is the name of the routine (e.g., ^DOPT("IBCMENU", ...) The second subscript is a sequential number. The data is 0-node >> "Billing option^1N^16^16" Following sequential nodes >> only the first piece is filled in, and Fileman line-tags the entry points for the option based on the numerical subscript. USAGE: Controlled Subscri ENTERED: NOV 28,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DOPT( DESCRIPTION: TYPE: File Since the use of ^DOPT has a long and honored history, it may be permitted to be used until further notice. ROUTINE: ******************** 56 NAME: DBIA56 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: NOV 28,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DOPT( DESCRIPTION: TYPE: File Given the longstanding history of the use of ^DOPT, scheduling may continue to use it. ROUTINE: ******************** 57 NAME: DBIA57 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: DEC 4,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File ^SRF(D0,0) .01 PATIENT 0;1 Read w/Fileman .04 SURGERY SPECIALTY 0;4 Read w/Fileman .011 IN/OUT-PATIENT STATU 0;12 Read w/Fileman ^SRF(D0,.1) .14 SURGEON .1,4 Read w/Fileman ^SRF(D0,.2) .21 ANES CARE START TIME .2;1 Read w/Fileman .22 TIME OPERATION BEGAN .2;2 Read w/Fileman .23 TIME OPERATION ENDS .2;3 Read w/Fileman .24 ANES CARE END TIME .2;4 Read w/Fileman .205 TIME PAT IN OR .2;10 Read w/Fileman .232 TIME PAT OUT OR .2;12 Read w/Fileman ^SRF(D0,6,D1,0) .01 ANESTHESIA TECHNIQUE 0;1 Read w/Fileman .05 PRINCIPAL TECH 0;3 Read w/Fileman ^SRF(D0,13,D1,0) .01 OTHER OPERATIVE PROC 0;1 Read w/Fileman ^SRF(D0,13,D1,2) 3 PROCEDURE CODE (CPT) 2;1 Read w/Fileman ^SRF(D0,OP) 26 PRIN OPERATIVE PROCE OP;1 Read w/Fileman 27 PRINCIPAL OP CODE OP;2 Read w/Fileman ^SRF(D0,8) 50 DIVISION 8;1 Read w/Fileman ^SRF('AC', 9 DATE OF OPERATION X-REF ON DATE OF OPERATION (FIELD 9) ROUTINE: ******************** 58 NAME: DBIA58 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: NOV 27,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File ^VA(200,D0,.11) ALL All address information VA(200,D ALL All phone information. ^VA(200,D0,5) 29 SERVICE/SECTION 5;1 Read w/Fileman 28 MAIL CODE 5;2 Read w/Fileman ^VA(200,D0,1) 5 DOB 1;3 Read w/Fileman ROUTINE: ******************** 61 NAME: DBIA61 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: SOCIAL WORK USAGE: Private ENTERED: NOV 5,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File MAS may request Social Work to use an MAS supplied utility for future versions. ^DIC(36,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 62 NAME: DBIA62 CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: OCT 22,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 214.6 ROOT: NURSA(214.6, DESCRIPTION: TYPE: File Subject to version 2.5 purge allowing 6 months data only. DSS uses the "B" cross reference on the CLASSIFICATION DATE/TIME field. Global: ^NURSA(214.6,"B",DATE,D0) ^NURSA(214.6,D0,0) .01 CLASSIFICATION DATE/ 0;1 Read w/Fileman .02 NAME 0;2 Read w/Fileman 1 CATEGORY 0;3 Read w/Fileman 3 ENTERED BY 0;5 Read w/Fileman 4 CLASSIFIER 0;6 Read w/Fileman 6 NURS LOCATION 0;8 Read w/Fileman 7 NURSING BED SECTION 0;9 Read w/Fileman ROUTINE: ******************** 63 NAME: DBIA63 CUSTODIAL PACKAGE: DENTAL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: OCT 22,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 221 ROOT: DENT(221, DESCRIPTION: TYPE: File In addition to the field references as indicated below, a direct global read of the 'B' Cross Reference may be made in the DENTAL TREATMENT (AMIS) file. ^DENT(221,D0,0) .01 DATE 0;1 Direct Global Read & w 3 PATIENT (POINTER) 0;4 Direct Global Read & w .5 DENTAL PROVIDER 0;3 Direct Global Read & w .3 STATION.DIVISION 0;40 Direct Global Read & w 4.5 PATIENT CATEGORY 0;19 Direct Global Read & w 6 SCREENING/COMPLETE E 0;7 Direct Global Read & w 6.2 INTERDISCIPLINARY CO 0;42 Direct Global Read & w 6.4 EVALUATION 0;43 Direct Global Read & w 6.6 PRE AUTH/2ND OPINION 0;44 Direct Global Read & w 6.7 SPOT CHECK EXAM 0;27 Direct Global Read & w 6.8 SPOT CHECK DISCREPAN 0;45 Direct Global Read & w 7 ADMIN PROCEDURE 0;8 Direct Global Read & w 7.1 COMPLETIONS/TERMINAT 0;41 Direct Global Read & w 8 X-RAYS EXTRAORAL # 0;9 Direct Global Read & w 10 X-RAYS INTRAORAL # 0;11 Direct Global Read & w 11 PROPHY NATURAL DENTI 0;12 Direct Global Read & w 12 PROPHY DENTURE 0;13 Direct Global Read & w 14 NEOPLASM CONFIRMED M 0;15 Direct Global Read & w 15 NEWPLASM REMOVED # 0;16 Direct Global Read & w 16 BIOPSY/SMEAR # 0;17 Direct Global Read & w 17 FRACTURE # 0;18 Direct Global Read & w 19 OTHER SIGNIF. SURG. 0;20 Direct Global Read & w 21 SURFACES RESTORED # 0;22 Direct Global Read & w 22 ROOT CANAL THERAPY # 0;23 Direct Global Read & w 23 PERIODONTAL QUADS (S 0;24 Direct Global Read & w 24 PERIO QUADS (ROOT PL 0;25 Direct Global Read & w 25 PATIENT ED. (CTV) 0;26 Direct Global Read & w 27 INDIVIDUAL CROWNS # 0;28 Direct Global Read & w 28 POST & CORES # 0;29 Direct Global Read & w 29 FIXED PARTIALS (ABUT 0;30 Direct Global Read & w 30 FIXED PARTIALS (PONT 0;31 Direct Global Read & w 31 REMOVABLE PARTIALS # 0;32 Direct Global Read & w 32 COMPLETE DENTURES # 0;33 Direct Global Read & w 33 PROSTHETIC REPAIR # 0;34 Direct Global Read & w 34 SPLINTS & SPEC. PROC 0;35 Direct Global Read & w 35 EXTRACTIONS # 0;36 Direct Global Read & w 36 SURGICAL EXTRACTIONS 0;37 Direct Global Read & w 37 OTHER SIGNIFICANT TR 0;38 Direct Global Read & w 38 OPERATING ROOM 0;14 Direct Global Read & w ROUTINE: ******************** 64 NAME: DBIA64 CUSTODIAL PACKAGE: BENEFICIARY TRAVEL SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: AUG 21,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 392.4 ROOT: DGBT(392.4, DESCRIPTION: TYPE: File ^DGBT(392.4,D0,0) .01 MODE OF TRANSPORTATI 0;1 Read w/Fileman Fee Basis points to this file. ROUTINE: ******************** 65 NAME: RAD/NUC MED PATIENT file data extract CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX DSS uses the "AR" cross reference on the EXAM DATE field. Global: ^RADPT("AR",DATE,DFN,REV_DATE) DSS uses the "B" cross reference on the EXAM DATE field. Global: ^RADPT(DFN,"DT","B",DATE,REV_DATE) NETWORK HEALTH EXCHANGE PCE PATIENT CARE ENCOUNTER PATIENT CARE ENCOUNTER (PCE) subscribes to access radiology exam data by date using the 'AR' cross-reference on the EXAM DATE (#.01) field on the REGISTERED EXAMS (#2) sub-file (#70.02). Updated on 07/20/2020 to include mention of PX*1*211. CLINICAL CASE REGISTRIES IMAGING VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: OCT 22,1990 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File This Integration Agreement allows subscribers to read data from the NAME (#.01) field (top-level, DINUMed) and agreed to fields associated with the REGISTERED EXAMS (#70.02) and EXAMINATIONS (#70.03) sub-files. ^RADPT(D0,0) .01 NAME 0;1 Direct Global Read & w ^RADPT(D0,'DT',D1,0) .01 EXAM DATE 0;1 Direct Global Read & w 3 HOSPITAL DIVISION 0;3 Direct Global Read & w 4 IMAGING LOCATION 0;4 Direct Global Read & w 2 TYPE OF IMAGING 0;2 Direct Global Read & w ^RADPT(D0,'DT',D1,'P',D2,0) 2 RADIOLOGY PROCEDURE 0;2 Direct Global Read & w 6 WARD 0;6 Direct Global Read & w 7 SERVICE 0;7 Direct Global Read & w 13 DIAGNOSTIC CODE 0;13 Direct Global Read & w 14 REQUESTING PHYSICIAN 0;14 Direct Global Read & w 3 EXAM STATUS 0;3 Direct Global Read & w 8 PRINCIPAL CLINIC 0;8 Direct Global Read & w 12 PRIMARY INTERPRETING 0;12 Pointed to 26 CREDIT METHOD 0;26 Direct Global Read & w This field indicates the type of credit this location receives for examinations. This field is populated automatically by the system at the time an exam is registered based on the Credit Method entered for the Imaging Location where the exam is registered. If only the interpretation as done at this facility, code 1 should be used. If the exam was performed at this facility, but the interpretation was done elsewhere, code 3 should be used. If both the exam and interpretation were done at this facility, code 0 should be used. If the entire exam was done outside the facility and exam data is being entered for the purposes of record-keeping only, code 2 should be used. 27 VISIT 0;27 Direct Global Read & w This field links the examination of a patient to a specific visit. The VISIT field points to the VISIT (#9000010) file which contains a record of all patient visits at health care facilities or by health care providers, including direct outpatient and clinic visits, as well as inpatient encounters. 17 REPORT TEXT 0;17 Direct Global Read & w The REPORT TEXT field is a pointer data type which links a radiology study to a radiology report record in the RAD/NUC MED REPORTS file (#74). ^RADPT(D0,'DT',D1,'P',D2,'M',D3,0) .01 MODIFIERS 0;1 Direct Global Read & w ^RADPT(D0,'DT',D1,'P',D2,'CMOD',D3,0) 135 CPT MODIFIERS 0;1 Direct Global Read & w ^RADPT(D0,'DT',D1,'P',D2,'H', .01 CLINICAL HISTORY FOR 0;1 Read w/Fileman ^RADPT('AR', .01 EXAM DATE 0;1 Direct Global Read & w This EXAM DATE field contains the date/time of the registered imaging exam. ROUTINE: ******************** 71 NAME: DBIA71 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 1,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Laboratory Package developers have granted the Health Summary team permission to add the application group "GMTS" to ^DIC(60, when file 60, the Laboratory test file, exists. ROUTINE: ******************** 73 NAME: DBIA73 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Permission has been granted for Health Summary to export the routine: FHWHEA as GMTSFHWZ GMTSPOST, the Health Summary post-init, will rename GMTSFHWZ as FHWHEA, if and only if FHWHEA is not found in the UCI by execution of ^%ZOSF("TEST"). ROUTINE: ******************** 75 NAME: DBIA75-A CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 606 ROOT: YSP(606, DESCRIPTION: TYPE: File Agreement has been made for Health Summary to access the following fields in the Mental Health Progress Notes files. - The cross-reference ^YSP(606,"AC", is traversed. - Globals accessed are: ^YSP(606, Progress Notes - The following fields are accessed: ^YSP(606, 606 .03 DATE/TIME OF PROGRESS NOTE 606 1 TYPE OF PROGRESS NOTE 606 2 AUTHOR 606.01 .01 TEXT 606.02 .01 SUBJECTIVE 606.021 .01 OBJECTIVE 606.022 .01 ASSESSMENT 606.023 .01 PLANS 606 30 DXLS 606 31 DISCHARGE BED SECTION 606.032A .01 OTHER DIAGNOSES 606.033 .01 OPERATIONS/PROCEDURES 606.034 .01 INSTRUCTIONS GIVEN TO PATIENT 606.04 .01 EMOTIONAL STATE 606.041 .01 BEHAVIORAL ASSESSMENT 606.042 .01 SOCIAL STATUS 606.043 .01 REHABILITATION POTENTIAL 606.044 .01 EMPLOYMENT POTENTIAL 606.045 .01 DEGREE OF DANGER - SELF/OTHERS 606.046 .01 ABNORMAL PHYSICAL FINDINGS 606.047 .01 INIT IMPRESSION/PROVISIONAL DX 606.048 .01 STATEMENT OF TREATMENT PLANNED 606.03 .01 COMMENTS/CORRECTIONS ROUTINE: ******************** 77 NAME: DBIA77 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 115 ROOT: FHPT( DESCRIPTION: TYPE: File The following fields will be accessed to get patient food allergies: ^FHPT( 115 DIETETICS PATIENT .1 Food Allergies ROUTINE: ******************** 78 NAME: DBIA78 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Vitals Package developers have granted the Health Summary team permission to add the application group "GMTS" to ^DIC(120.51, when file 120.51, the Vital Type file, exists. ROUTINE: ******************** 80 NAME: DBIA80-A CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: HEALTH SUMMARY The Health Summary exports and calls the routine GMTSMCPS, which generates the output for the Health Summary Medicine component. The following fields and cross references are being referenced: ^MCAR(690, Medical Patient File Uses "AC" cross reference ORDER ENTRY/RESULTS REPORTING SURGERY ADDED 5/12/2011 USAGE: Controlled Subscri ENTERED: FEB 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 690 ROOT: MCAR(690, DESCRIPTION: TYPE: File This DBIA documents references to the MEDICAL PATIENT file (#690). ^MCAR(690,'AC' ROUTINE: ******************** 85 NAME: DBIA85-A CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 9,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 195.4 ROOT: DIC(195.4, DESCRIPTION: TYPE: File 1. Activation interface 2. Make an appointment Checkin/unscheduled visit 3. Cancel an appointment 4. Changing clinic names 1. Use of the Record Tracking System Parameter file # 195.4 SD calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ 2. When a clinic appointment is made if the appointment is 'today' or if the Record Tracking System Parameter 'Batch requests' is set to 'No' or if records are requested for an unscheduled visit. A. An entry is made in the Requested Records file #190.1 ^RTV(190.1,n) by a call from RT^SDUTL to a tasked job QUE^RTQ or RT^SDI B. After the entry is added to the Requested Records file #190.1 an entry is made in Parent Record Request field of the Patient subfield of the Hospital Location file #44 ^SC(n,"S",,,,"RTR")=n^ by a return call from CREATE+11^RTQ2 to RTSET^SDUTL 3. When a clinic appointment is canceled: If there is a Requested Records entry in file #190.1 the status is changed to 'canceled' by a call RTV(190.1,n)=^^^^^x^ from RT+2^SDUTL to CANCEL^RTQ2. 4. When the name of a clinic is changed the corresponding names of entries in the Pull List file #194.2 are changed by a trigger on the .01 field of the Hospital Location file #44. Clinic ^SC(1,0)=DJones Medical Clinic^ ^RTV(194.2,n)=Dr Jones Medical Clinic [04/01/91]^ Clinic names are changed in a compiled input template. To insure the use of this trigger the following action is taken: The Record Tracking package includes the .01 field of the Hospital Location file #44 so that the SDB template is re-compiled when the Record Tracking package is initialized. ROUTINE: ******************** 87 NAME: DBIA87-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 10,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.1 ROOT: DGS(41.1, DESCRIPTION: TYPE: File SCHEDULED ADMISSION FILE: Loops through ARSV x-ref and looks at RESERVATION DATE/TIME field. (routine YSCEN) ROUTINE: ******************** 88 NAME: DBIA88-A CUSTODIAL PACKAGE: GRECC SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: AUG 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other 1. The 'DG' package for MAS v5.1 will be exporting the following Generic Code Sheet input templates: a. DG AMS1 AMIS from file 2100 b. DG AMS1 AMIS 334 from file 2100 c. DG AMS1 AMIS 336 from file 2100 d. DG AMS1 AMIS 345 from file 2100 ROUTINE: ******************** 89 NAME: DBIA89 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Controlled Subscri ENTERED: AUG 8,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 411 ROOT: PRC(411, DESCRIPTION: TYPE: File Read access to File 411, ADMIN. ACTIVITY SITE PARAMETER, following fields: field 15 HOSPITAL STREET ADDR.1 field 16 HOSPITAL STREET ADDR.2 field 17 HOSPITAL CITY field 18 HOSPITAL STATE field 19 HOSPITAL ZIP field 19.2 HOSPITAL PHONE ROUTINE: ******************** 91 NAME: DBIA91-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION CLINICAL REMINDERS CLINICAL CASE REGISTRIES PHARMACY BENEFITS MANAGEMENT ORDER ENTRY/RESULTS REPORTING MRSA INITIATIVE REPORTS ADDED 4/23/09 HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expires on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR VIA needs access to the Laboratory Test (#60) file for VIAB LOAD RPC and OrderMgmtSvc - getLabTestSpecificParams. USAGE: Controlled Subscri ENTERED: SEP 11,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File ^LAB(60,D0,0) .01 NAME 0;1 Direct Global Read & w 1 TEST COST 0;11 Direct Global Read & w 4 SUBSCRIPT 0;4 Direct Global Read & w 5 LOCATION (DATA NAME) 0;5 Direct Global Read & w ^LAB(60,'B', The 'B' cross-reference is used to locate patient data by the specific Laboratory Test Name. ^LAB(60,'C', The 'C' cross-reference is used to locate the Laboratory Test Name when all data for a selected patient is being evaluated based on the Location (DATA NAME) for a particular result ^LAB(60,D0,2) This is a check used in DIC('S') for LAB TESTS INCLUDED IN PANEL in the following manner: S DIC("S")="I '$D(^LAB(60,+Y,2))" S DIC("?")="The lab test may not be a panel of tests." S DIC="60",DIC(0)="AEQMZ" F D ^DIC Q:Y=-1 D ROUTINE: ******************** 92 NAME: DBIA92 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION CLINICAL INFO RESOURCE NETWORK CLINICAL CASE REGISTRIES LEXICON UTILITY The Lexicon Package needs to be able to query files 45 for the purpose of DRG calculation to verify that versioned data is correct. Effctive with LEX*2.0*80. MASTER PATIENT INDEX VISTA MPI is requesting global read access to the 'B' cross reference and FileMan read access to the Admission Date (#2) and Discharge Date (#70) fields to support the validity of date of death of patients. MPI needs access to the PTF file to search for records that may be non-VA care (FEE) related. This ICR provides the needed data elements to search through the global to find such records as the FEE entries are not complete PTF records. The application will look for activity that could indicate the patient is not deceased as of a given date. If the date of death is defined and after the proposed date of death or an admission date is defined after the proposed date of death, the record is logged for additional follow up. The PTF file is used for this validity check to check for both VA and Fee Basis inpatient activity. USAGE: Controlled Subscri ENTERED: SEP 11,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File Amended October 28, 1997. fields DGPT(D0,0) .01 and DGPT(D0,70) 80 added for CIRN 11/24/98 ^DGPT(D0,0) 2 ADMISSION DATE 0;2 Read w/Fileman 5 SUFFIX 0;5 Read w/Fileman 6 STATUS 0;6 Read w/Fileman 11 TYPE OF RECORD 0;11 Read w/Fileman .01 PATIENT 0;1 Read w/Fileman Field need added for CIRN ^DGPT(D0,70) 70 DISCHARGE DATE 70;1 Read w/Fileman 71 DISCHARGE SPECIALTY 70;2 Read w/Fileman 72 TYPE OF DISPOSITION 70;3 Read w/Fileman 79 DXLS 70;10 Read w/Fileman 79.16 ICD 2 70;16 Read w/Fileman 79.17 ICD 3 70;17 Read w/Fileman 79.18 ICD 4 70;18 Read w/Fileman 79.19 ICD 5 70;19 Read w/Fileman 79.201 ICD 6 70;20 Read w/Fileman 79.21 ICD 7 70;21 Read w/Fileman 79.22 ICD 8 70;22 Read w/Fileman 79.23 ICD 9 70;23 Read w/Fileman 79.24 ICD 10 70;24 Read w/Fileman 73 OUTPATIENT TREATMENT 70;4 Read w/Fileman 80 PRINCIPAL DIAGNOSIS 70;11 Read w/Fileman Field need added for CIRN ^DGPT(D0,'M',D1,0) 2 LOSING SPECIALTY 0;2 Read w/Fileman 5 ICD 1 0;5 Read w/Fileman 6 ICD 2 0;6 Read w/Fileman 7 ICD 3 0;7 Read w/Fileman 8 ICD 4 0;8 Read w/Fileman 9 ICD 5 0;9 Read w/Fileman 10 MOVEMENT DATE 0;10 Read w/Fileman Accessed via 'AM' cross-reference 11 ICD 6 0;11 Read w/Fileman 12 ICD 7 0;12 Read w/Fileman 13 ICD 8 0;13 Read w/Fileman 14 ICD 9 0;14 Read w/Fileman 15 ICD 10 0;15 Read w/Fileman ^DGPT(D0,'P',D1,0) .01 PROCEDURE DATE 0;1 Read w/Fileman 4 PROCEDURE CODE 1 0;5 Read w/Fileman 5 PROCEDURE CODE 2 0;6 Read w/Fileman 6 PROCEDURE CODE 3 0;7 Read w/Fileman 7 PROCEDURE CODE 4 0;8 Read w/Fileman 8 PROCEDURE CODE 5 0;9 Read w/Fileman ^DGPT(D0,'S',D1,0) .01 SURGERY/PROCEDURE DA 0;1 Read w/Fileman 8 OPERATION CODE 1 0;8 Read w/Fileman 9 OPERATION CODE 2 0;9 Read w/Fileman 10 OPERATION CODE 3 0;10 Read w/Fileman 11 OPERATION CODE 4 0;11 Read w/Fileman 12 OPERATION CODE 5 0;12 Read w/Fileman ^DGPT('B',X,DA) Eligible records will be determined by using the 'b' cross reference to determine matches with patients. ROUTINE: ******************** 93 NAME: DBIA93-A CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION TEXT INTEGRATION UTILITIES CLINICAL CASE REGISTRIES GEN. MED. REC. - VITALS MYHEALTHEVET Added 2/15/13 for MHV*1.0*10. HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HMP processes sync the data from a patient visit in VistA with the HMP JSON Data Source . As part of this sync process, HMP is accessing the Hospital Location File (#44) to retrieve the Stop Code information for the Clinic using the GETS^DIQ FileMan API. USAGE: Controlled Subscri ENTERED: FEB 17,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File ^SC(D0,0) 8 STOP CODE NUMBER 0;7 Direct Global Read & w ROUTINE: ******************** 94 NAME: DBIA94 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: SEP 23,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other As a requirement for the AMIE C&P (phase III), Central Office requested that we report lab and X-ray results in conjunction with the examination. After speaking with Troy about such a venture and attempting to procure an agreement to make calls to the Radiology package, it was decided that it would be better for them to write a special routine for AMIE purposes. I have initially set this up under my DVBC national name space and will rename it (using Kernel tools) to RAUTL3 which is its true name. However, before doing this I check to see if it already exists. As the package cannot function without this and some sites may not have the latest Radiology package up (v 4.0, I think) by the time it is sent out nationally (probably 1/92), I have been advised by Troy to request an agreement to export this and rename it. This would be required just for the initial release. ROUTINE: ******************** 95 NAME: DBIA95-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: COMPENSATON AND PENSION USAGE: Private ENTERED: SEP 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Request an agreement with the lab developers for usage of the following: Cross-references: CH xref in ^LR MI xref in ^LR ^LR(D0,'CH', ^LR(D0,'MI', ROUTINE: ******************** 97 NAME: DBIA97-A CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: AUG 26,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 730 ROOT: ECC(730, DESCRIPTION: TYPE: File The DSS developers have agreed that the IMS developers may export file 730 (NATIONAL SERVICE) with data and field 730 (NATIONAL SERVICE) in file 49 (SERVICE/SECTION) with no data. ROUTINE: ******************** 98 NAME: DBIA98-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 20,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Version 5.1 of the laboratory package has a temporary agreement for the following: 1) To save system $Z variables in local variables for storage in our error trap. When Kernel release their error trapping system, Lab will convert to the Kernel supported methodology. ROUTINE: ******************** 99 NAME: DBIA99 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: CREDENTIALS TRACKING USAGE: Private ENTERED: JUL 27,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 730 ROOT: ECC(730, DESCRIPTION: TYPE: File The agreement consists of the following: 1) Credentials Tracking package will include the field GENERAL PRIVILEGE (#747) and associated data in the National Service fle (#730). 2) Credentials Tracking will export the National Service file (#730). This export will only install the data dictionary for file 730 if the dictionary does not exist on the system. If file 730 does exist, Credentials Tracking will not overwrite the data dictionary. ROUTINE: ******************** 100 NAME: DBIA100 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CREDENTIALS TRACKING USAGE: Private ENTERED: SEP 25,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The agreement consists of the following: 1) The Credentials Tracking module will incorperate fields in the NEW PERSON file within the field number range of 747-747.999. Data node for these fields will be in the QAR namespace (ex. QAR1, QAR17, etc). Sub-data dictionary numbers will be within the 200.0747-200.074799999 range. The right is reserved to use the QAR and AQAR prefix for any cross-reference indicies. 2) The Credentials Tracking module will export a "clean" partial data dictionay for file 200. This partial will include only the 747 number spaced fields and the .01 name field. The partial was created in an environment that contained only the 747 numberspaced fields and a partial of the .01 name field. The .01 name field contains only the basic field definition, "B" cross- reference (only), and the input transform. All other fields and information were deleted. ROUTINE: ******************** 101 NAME: DBIA101 CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: CREDENTIALS TRACKING USAGE: Private ENTERED: AUG 26,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 453 ROOT: PRSP(453, DESCRIPTION: TYPE: File The agreement consists of the following: 1) Credentials Tracking module will include fields in the 747-747.999 number range. 2) Credentials Tracking will export the APPLICANT file (#453) partial data-dictionary. The partial will include only fields in the 747-747.999 number range, and those other fields in the APPLICANT file that Credentials Tracking is dependant upon. ROUTINE: ******************** 103 NAME: SURGERY file (#130) CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: JUL 28,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File The DSS Extracts SURGERY EXTRACT file (#727.811) contains a field, CASE NUMBER, which is a pointer to the SURGERY file (#130). DSS Extracts has permission to execute direct global reads of the 'B' Cross Reference on the SURGERY file (#130). DSS uses the "ADT" and "AC" cross references on the DATE OF OPERATION field: Global: ^SRF("ADT",DFN,DATE) Global: ^SRF("AC",DATE,IEN)=DFN ^SRF(D0,0) .01 PATIENT 0;1 Direct Global Read & w .02 OPERATING ROOM 0;2 Direct Global Read & w .04 SURGERY SPECIALTY 0;4 Direct Global Read & w .09 DATE OF OPERATION 0;9 Direct Global Read & w .011 IN/OUT-PATIENT STATU 0;12 Direct Global Read & w DSS reads the entire zero node into a local variable. The fields above are used. ^SRF(D0,.1) .14 SURGEON .1;4 Direct Global Read & w .164 ATTEND SURG .1;13 Direct Global Read & w DSS reads the entire .1 node into a local variable. The fields above are used. ^SRF(D0,.2) .21 ANES CARE START TIME .2;1 Direct Global Read & w .22 TIME OPERATION BEGAN .2;2 Direct Global Read & w .23 TIME OPERATION ENDS .2;3 Direct Global Read & w .24 ANES CARE END TIME .2;4 Direct Global Read & w .205 TIME PAT IN OR .2;10 Direct Global Read & w .232 TIME PAT OUT OR .2;12 Direct Global Read & w .203 TIME PAT IN HOLD ARE .2;15 Direct Global Read & w .234 OR CLEAN START TIME .2;13 Direct Global Read & w .236 OR CLEAN END TIME .2;14 Direct Global Read & w DSS reads the entire .2 node into a local variable. The fields above are used. ^SRF(D0,.3) .34 ANESTHESIOLOGIST SUP .3;4 Direct Global Read & w .31 PRINCIPAL ANESTHETIS .3;1 Read w/Fileman ^SRF(D0,1,D1,0) .01 PROSTHESIS ITEM 0;1 Direct Global Read & w From the PROSTHESIS INSTALLED multiple (.47). ^SRF(D0,1,D1,1) 7 QUANTITY 1;2 Direct Global Read & w ^SRF(D0,1.1) 1.17 ADMIT PAC(U) TIME 1.1;7 Direct Global Read & w 1.18 PAC(U) DISCH TIME 1.1;8 Direct Global Read & w ^SRF(D0,6,D1,0) .01 ANESTHESIA TECHNIQUE 0;1 Direct Global Read & w .05 PRINCIPAL TECH 0;3 Direct Global Read & w From the ANESTHESIA TECHNIQUE multiple (.37). ^SRF(D0,8) 50 DIVISION 8;1 Direct Global Read & w ^SRF(D0,13,D1,2) 3 OTHER PROCEDURE CPT 2;1 Direct Global Read & w From the OTHER PROCEDURES multiple (.42). ^SRF(D0,30) 17 CANCEL DATE 30;1 Direct Global Read & w ^SRF(D0,NON) 118 NON-OR PROCEDURE NON;1 Direct Global Read & w 119 NON-OR LOCATION NON;2 Direct Global Read & w 121 TIME PROCEDURE BEGAN NON;4 Direct Global Read & w 122 TIME PROCEDURE ENDED NON;5 Direct Global Read & w 123 PROVIDER NON;6 Direct Global Read & w 124 ATTEND PROVIDER NON;7 Direct Global Read & w DSS reads the entire NON node into a local variable. The fields above are used. ^SRF(D0,OP) 27 PRINCIPAL PROCEDURE OP;2 Direct Global Read & w 26 PRINCIPAL PROCEDURE OP;1 Direct Global Read & w DSS reads the entire OP node into a local variable. The field above is used. ^SRF(D0,OPMOD,D1,0) 28 PRIN. PROCEDURE CPT 0;1 Direct Global Read & w ^SRF(D0,13,D1,MOD,D2,0) 4 OTHER PROCEDURE CPT 0;1 Direct Global Read & w ^SRF(D0,CON) 35 CONCURRENT CASE CON;1 Direct Global Read & w The CONCURRENT CASE (#35) field was added to this ICR in support of the FY14 Annual Sustainment patch ECX*3*144. Access to the CONCURRENT CASE field will not be reliable after a site has implemented Surgery Quality and Workflow Manager (SQWM), patch SR*3*180. The handling of concurrent cases is different in SQWM than in VistA Surgery. After SQWM implementation, concurrent case information must be accessed by other means yet to be determined as of the date of adding the CONCURRENT CASE field to this ICR. ^SRF(D0,50,D1,0) .213 ANES CARE TIME BLOCK 50;0 Direct Global Read & w The ANES CARE TIME BLOCK multiple was added to this ICR in support of the DSS FY17 Annual Sustainment Patch ECX*3*161. The ANES CARE MULTIPLE START TIME and ANES CARE MULTIPLE END TIME fields are used in calculating the patient's total anesthesia time. .01 ANES CARE MULTIPLE S 0;1 Direct Global Read & w 1 ANES CARE MULTIPLE E 0;2 Direct Global Read & w ^SRF(D0,63,D1,0) .01 ORGANS TO BE TRANSPL 0;1 Direct Global Read & w The ORGANS TO BE TRANSPLANTED multiple was added to this ICR in support of the DSS FY18 Annual Sustainment Patch ECX*3*166. The ORGANS TO BE TRANSPLANTED field will be used to identify organs transplanted during the operation. ROUTINE: ******************** 111 NAME: DBIA111-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: MAY 14,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGAINP3 COMPONENT: EN VARIABLES: 1) AMIS Segments 334-341 This entry point prints the inpatient AMIS segments 334-341 for a select month/year. If the variable DGMYR is not defined, the user will be prompted for the AMIS month/year to print. ******************** 115 NAME: DBIA115-A CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 195.4 ROOT: DIC(195.4, DESCRIPTION: TYPE: File Use of the Record Tracking System Parameter file # 195.4. RA calls RT if the field 'RADIOLOGY INTERFACE STATUS' is 'UP', ^DIC(195.4,1,"UP")=^1, and checks if the record tracking radiology application is defined . $D(^DIC(195.4,1,"RAD")) ROUTINE: ******************** 116 NAME: DBIA116 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: RECORD TRACKING USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File With Record Tracking implementaion, records may be created for for all the entries in Radiology Patient file. When using the Record Tracking (radiology application) the routines RTSM1 and RTSM3 look at the Radiology Patient file #70 ^RADPT(dfn,0) => ^RT(n,0)=dfn;DPT(^ to create entries in the Records file #190 for each radiology patient when initializing records. ROUTINE: ******************** 118 NAME: DBIA118-A CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION USAGE: Controlled Subscri ENTERED: NOV 9,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File Amended October 28, 1997. ^RADPT(D0,'DT',D1,0) .01 EXAM DATE 0;1 Read w/Fileman The ICR package may use a direct global read to get the EXAM DATE value. ^RADPT(D0,'DT',D1,'P',D2,0) 2 RADIOLOGY PROCEDURE 0;2 Read w/Fileman 3 EXAM STATUS 0;3 Read w/Fileman ^RADPT(D0,'DT',D1,'P',D2,'M',D3,0) .01 MODIFIERS 0;1 Read w/Fileman ROUTINE: ******************** 119 NAME: DBIA119 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: OCT 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSCH( DESCRIPTION: TYPE: File Routine PRCFQ uses the following extrinsic function to determine whether Taskman is runnig: TM() ;extrinsic function--is taskman running? N ZTH,ZTR S ZTH=$H,ZTR=$S(^%ZTSCH("RUN"))#2:^("RUN"),1:"") Q ZTH-ZTR*86400+$P(ZTH,",",2)-$P(ZTR,",",2)<500 Till otherwise agreed, or release of Kernel 8 ^%ZTSCH('RUN') ROUTINE: ******************** 120 NAME: DBIA120-A CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 195.4 ROOT: DIC(195.4, DESCRIPTION: TYPE: File 1. Use of the Record Tracking System Parameter file # 195.4: DG calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ ^DIC(195.4,1,'UP') ROUTINE: ******************** 121 NAME: DBIA121 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: SEP 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: PATIENT FILE DESCRIPTION: TYPE: File APSJD X-reference on field .351, DATE OF DEATH, of file 2, PATIENT not used for sorting or look up. The code is: set: S XX=X,X="PSJADT" X ^%ZOSF("TEST") I S X=XX D END^PSJADT kill: Q The event driver messages are not displayed. ^DD(2,.351,1,6,0) = 2^APSJD^MUMPS ^DD(2,.351,1,6,1) = S XX=X,X="PSJADT" X ^%ZOSF("TEST") I S X=XX D END^PSJ ADT ^DD(2,.351,1,6,2) = Q ^DD(2,.351,1,6,"%D",0) = ^^2^2^2910806^ ^DD(2,.351,1,6,"%D",1,0) = Pharmacy cross-reference for notification upon entry/deletion of date of ^DD(2,.351,1,6,"%D",2,0) = death information. ^DD(2,.351,1,6,"DT") = 2910806 ^DD(2,.351,1,6, ROUTINE: ******************** 124 NAME: DBIA124-A CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine PSOCPVW is called by Integrated Billing to display information from the Prescription file (52) to provide a full profile of the prescription that caused the Co-Pay Charges. Input Variable: X $P1: RX Entry Number. The pointer to the Prescription file. $P2: Refill. The second piece is delimited by a colon is optional, if defined is expected to be the entry number of the refill multiple that caused the charges if the charges were created by a refill. Output Writes pertinent data from the prescription file for the requested entry in captioned format. ROUTINE: PSOCPVW COMPONENT: PSOCPVW VARIABLES: X Type: Input Requires X = "RXN^fill #" e.g. X="3007^2" means second refill of RX in ^PSRX(3007, . "3007^0" would mean oringinal fill. ******************** 125 NAME: DBIA125-A CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This private agreement between PSO and IB will allow for PSO to notify IB when an Outpatient Medication Co-payment bill needs to be created, updated, or cancelled. It will also allow PSO to cancel or update a potential charge. There are also entry points for PSO to verify that a patient is subject to Pharmacy Co-payment and allow PSO to check the status of a Co-payment charge. ROUTINE: IBARX COMPONENT: XTYPE VARIABLES: X Type: Input $P1: Service. Pointer to Service/Section file (49) for Pharmacy service $P2: Patient. Pointer to Patient file (2) (DFN) Y Type: Output $P1: Success. Returns 1 if successful or -1 if unsuccessful determination $P2: If unsuccessful error code Y(action t Type: Output sub: First subscript. New Action Types for Service, pointer to IB ACTION TYPE file (350.1). sub: Second subscript. Value n (n = 0, 1, or 2) where 0 indicates this action type not billable, 1 indicates it is billable, 2 indicates that additional information is needed $P1: Action Type. Pointer to the IB ACTION TYPE file (350.1) $P2: Unit Cost. The dollar charge for one unit $P3: Service. Pointer to Service/Section file (49) for service that can use this action type Supported for Outpatient Pharmacy for determining eligibility for Co-payment and correct IB ACTION TYPE. COMPONENT: NEW VARIABLES: X Type: Input $P1: Service. Pointer to Service Section file (49) $P2: Patient. Pointer to the Patient File (2) (DFN) $P3: Action Type. Pointer to the IB Action Type file (350.1) $P4: User. Pointer to New Person file (200) (DUZ) X(n) Type: Input sub: First subscript. Any value, same value is returned in Y(n) $P1: Softlink. Link to prescription file for entry causing charges in the format of: file number:entry pointer;[node:sub-entry;node:sub-entry...] $P2: Units. The number of units to be charged Y Type: Output $P1: Success flag. Returns 1 if successful, -1 if unsuccessful $P2: Grand Total. Sum of total charges if successful, error code if unsuccessful Y(n) Type: Output sub: First subscript. Any value, same value as passed in X(n) $P1: IB Action Entry. Pointer to Integrated Billing file 350 $P2: Total Charges. Charges for this entry $P3: AR Charge ID. Accounts receivable Charge ID (Bill Number), name field from Accounts Receivable file (430) $P4: Cap met flag (1=yes,0=no) $P5: Full or Partial bill ("F", "P" or "") $P6: Exempt (1=exempt,0=non-exempt,-1=copay off) $P7: IEN from file 354.71 Supported for Outpatient Pharmacy to process charges for new, renew, or refilled prescriptions COMPONENT: CANCEL VARIABLES: X Type: Input $P1: Service. Pointer to the Service/Section file for Pharmacy service $P2: Patient. Pointer to the Patient File (2) (DFN) $P3: Null $P4: User. Pointer to the New Person file (200) (DUZ) X(n) Type: Input sub: First subscript. Any value, same value as returned in Y(n) $P1: Integrated Billing Action. Action to be canceled, pointer to the Integrated Billing Action file (350) $P2: Charge Removal Reason. Reason for the cancellation pointer to the IB Charge Removal Reasons file (350.3) Y Type: Output $P1: Success flag. Returns 1 if successful, -1 if unsuccessful $P2: Error Code. Error code from IB Error file (350.8) if unsuccessful, Null if successful Y(n) Type: Output $P1: Integrated Billing Action. IB Action that is the result of the cancellation, pointer to Integrated Billing Action file (350) if successful or -1^error code if unsuccessful $P2: Error Code. Error code from IB Error file (350.8) if unsuccessful, Null if successful Supported for Outpatient Pharmacy to remove charges for one new, renewed, or refilled prescription. COMPONENT: UPDATE VARIABLES: X Type: Input $P1: Service. Pointer to the Service/Section file for Pharmacy service $P2: Patient. Pointer to the Patient File (2) (DFN) $P3: Action Type. Pointer to the IB Action Type file (350.1) $P4: User. Pointer to the New Person file (200) (DUZ) X(n) Type: Input sub: First subscript. Any value, same value is returned in Y(n) $P1: Softlink. Link to prescription file for entry causing charges in the format of: file number:entry pointer;[node:sub-entry;node:sub-entry...] $P2: Units. The number of units to be charged $P3: Integrated Billing Action. Action to be canceled, pointer to the Integrated Billing Action file (350) $P4: Charge Removal Reason. Reason for the cancellation pointer to file 350.3 Y Type: Output $P1: Success flag. Returns 1 if successful, -1 if unsuccessful $P2: Error Code. Error code from IB Error file (350.8) if unsuccessful, Null if successful Y(n) Type: Output $P1: Integrated Billing Action. IB Action that is the result of the cancellation, pointer to Integrated Billing Action file (350) if successful or returns -1 if unsuccessful $P2: Total charge this entry $P3: AR bill number $P4: Cap met flag (1=yes,0=no) $P5: Full or Partial bill ("F", "P" or "") $P6: Exempt (1=exempt,0=non-exempt,-1=copay off) $P7: IEN from file 354.71 To update charges when the days supply has been edited to change the number of units to be charged. (Note: for audit purposes this call actually cancels the most recent charges and processes new charges for the current amount) COMPONENT: STATUS VARIABLES: This entry point will return the status of an entry in file 350. Call with $$STATUS^IBARX(ien from 350). Output will be: 0 = not a valid 350 ien 1 = Billed 2 = Cancelled 3 = Updated COMPONENT: CANIBAM VARIABLES: X(n) Type: Input sub: First subscript. Any value, same value as returned in Y(n) $P1: IEN from file 354.71 $P2: Charge Removal Reason. Reason for the cancellation pointer to the IB Charge Removal Reasons file (350.3) Y(n) Type: Output $P1: 0 or any positive number for OK or -1 for not accepted $P2: If not accepted, error message This entry point will allow to cancel a potential charge that has not been charged. COMPONENT: UPIBAM VARIABLES: X Type: Input $P1: Service. Pointer to Service Section file (49) $P2: Patient. Pointer to the Patient File (2) (DFN) $P3: Action Type. Pointer to the IB Action Type file (350.1) $P4: User. Pointer to New Person file (200) (DUZ) X(n) Type: Input sub: First subscript. Any value, same value is returned in Y(n) $P1: Softlink. Link to prescription file for entry causing charges in the format of: file number:entry pointer;[node:sub-entry;node:sub-entry...] $P2: Units. The number of units to be charged $P3: IEN from file 354.71 to be updated $P4: Charge Removal Reason. Reason for the cancellation pointer to the IB Charge Removal Reasons file (350.3) Y Type: Input $P1: 1 if success, -1 if error $P2: If error, error message Y(n) Type: Output $P1: New IEN from file 354.71 if success, -1 if error $P2: If error, error message This entry point will cancel current potential charge and create updated potential charge entry. ******************** 126 NAME: DBIA126 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: IBOLK COMPONENT: ENB VARIABLES: X Type: Input Supported for Accounts Receivable to print a brief profile of prescription entries that caused the AR transaction. Input Variable: X $P1: AR Transaction Number. The AR Transaction number, the pointer to file 433. Output Writes one line profile for each Integrated Billing Action that caused the AR Transaction (may be more than one) COMPONENT: ENF VARIABLES: X Type: Input Supported for Accounts Receivable to print a full inquiry of prescription entries that caused the AR Transaction. Input Variable: X $P1: AR Transaction Number. The AR Transaction number, the pointer to file 433. Output Writes a full inquiry for each Integrated Billing Action that caused the AR Transaction (may be more than one). This will include the information from the brief profile plus the data printed by routine PSOCPVW from the prescription file ******************** 127 NAME: DBIA127-A CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PRCASER This routine is used for setting up or establishing a new charge (bill) for a debtor. When calling this routine, a new charge (pharmacy Co-Pay, etc, should be added to the patients account. Input Variable: X $P1: Site. This is the site number the charge is being created by. For example: 503, 516, etc. This is the station number field from the Institution file (4). $P2: Service. This is the service that is creating the bill. This is the pointer to the Service/Section file (49). $P3: Category Number. This is the AR Category that the charge should fall under. This is the pter to the AR Category file (430.2). $P4: Debtor. This is the debtor that the charge should fall under. This is a variable pointer to the following files: Vendor, Person, Insurance, Institution. For Pharmacy Co-Pay the debtor should be the patient in the format of "36;DPT(" whe re 36 is the internal number of the patient in the patient file. $P5: Fiscal Year. Fiscal Year charge should be charged to. $P6: Amount. Must be zero or greater and less than 9999999.99. $P7: User. The person who created the charge. Pointer to the User file (3). $P8: Date charge generated. This is the internal VA FileMan date the charge was issued. Output Variable: Y (if no error is encountered) P1: Internal Bill Number. This is the internal file number from the Accounts Receivable file (430). $P2: Charge ID. This is the .01 field from the Accounts Receivable file (430) and will be 10 characters in length. $P3: Transaction Number. Since an "OPEN" bill may already exist and can be used, it may be necessary to add this charge to an already existing bill as a transaction, then this would be the pointer value to the AR Transaction file (433). Howev er, if a new bill is set up for the current charges then this piece equals zero. Variable: Y (if error is encountered) $P1: Error Indicator. -1 . $P2: Error Code. This is the error code from the IB Action Error file. $P3: Additional Text. If additional text is required to describe the error it is in the third piece. ROUTINE: PRCASER COMPONENT: PRCASER VARIABLES: X Type: Input Y Type: Output ******************** 128 NAME: DBIA128-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: NOV 20,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File New Bill and Edit Bill options have been modified to prompt the user "Edit Debtor Address" after he/she has entered/edited the bill. This prompt as well as the Edit AR Debtor Address option allow edits to the NEW PERSON and INSTITUTION file. The fields edited include: for NEW PERSON file ^VA(200, 1) .111 - Street Address 1 2) .112 - Street Address 2 3) .113 - Street Address 3 4) .114 - City 5) .115 - State 6) .116 - Zip Code 7) .131 - Phone The edits would also be transposed in the PERSON file (^DIC(16)). Please keep in mind that "all users" with access to the Billing menu will be able to edit the debtor address fields (option 2). ROUTINE: ******************** 129 NAME: DBIA129 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: NOV 21,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Call to STAT^PSOEXDT: The routine expects the 0 node of the prescription in RX0, the 2 node of the prescription in RX2 and returns the printable form of the prescription status in ST. The call will be abandonded when Health Summary provides the clinical information. ROUTINE: PSOEXDT COMPONENT: STAT VARIABLES: ******************** 130 NAME: DBIA130-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM USAGE: Private ENTERED: DEC 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Read only access to the following Files, Fields, & X-References: FILE : Patient (2) FIELDS : Receiving A&A Benefits (.36205) Eligibility Status Date (.3612) Agerncy/Allied Country (.309) Receiving Housebound Benefits (.36215) Rated Disabilities (.3721) *stipulation* *this is being requested by other packages and may be incorporated into VADPT at which time we will ask packages to use the utility ROUTINE: ******************** 131 NAME: DBIA131-A CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: SOCIAL WORK USAGE: Private ENTERED: DEC 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File 'Status of the clinic appointment' field in ^DPT('S' node will be used to determine appointment status. If the status of the appointment is active and not an inpatient visit, it will be counted as an outpatient visit for social work totals. ROUTINE: ******************** 132 NAME: DBIA132-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other DGPM MOVEMENT EVENT DRIVER For movements other than 'death': The Inpatient inits send out the protocol 'PSJ OR PAT ADT' which is 'hooked' to the MAS protocol 'DGPM MOVEMENT EVENTS'. 'PSJ OR PAT ADT' uses the PSJADT routines to take the appropriate actions. ROUTINE: ******************** 136 NAME: DBIA136 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 27,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMTSLROE COMPONENT: XTRCT VARIABLES: DFN Type: Input SEX Type: Input GMTS1 Type: Input GMTS2 Type: Input MAX Type: Input ~TMP("LRO" Type: Output IA 532 permits setting this global. It's an output from XTRCT. It may be killed before calling and after use after the call. The input variables are: DFN = IFN of patient in Patient file. SEX = Sex of patient. GMTS1 = Inverse end date of search for lab orders. GMTS2 = Inverse start date of search for lab orders. MAX = Maximum number of lab orders to be extracted The data is returned in the following array: ^UTILITY("LRO",$J,IDT,SN_FN)=CDT^TST^SPC^URG^OS^MD^ODT^ACC^RDT ^COL^CD where: IDT = Inverse collection date/time of order. SN = IFN in Specimen # (1) multiple of Lab Order Entry (69) file. FN = IFN in Test (6) multiple of Specimen# (1) multiple of (69) Lab Order Entry(69) file. CDT = Collection date/time of order. TST = Lab test ordered. This variable has format A;B where A is the internal pointer and B is external printable form. SPC = Specimen for lab order. This variable has format A;B where A is the internal pointer and B is external printable form. URG = Urgency of lab order. OS = Status of lab order. MD = Provider. This variable has format A;B where A is the internal pointer and B is the external printable form. ODT = Date/Time lab ordered. ACC = Accession number of lab order. RDT = Date/Time results for this lab order available. COL = Lab or ward collect. CD = IFN in Lab Order Entry (69) file. ******************** 141 NAME: DBIA141 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: JAN 7,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ^PRCSDIC - Routine to perform lookup into File 410 (Control Point Activity). Variables: DIC DIC(0) DIC("A") ROUTINE: PRCSDIC COMPONENT: PRCSDIC VARIABLES: DIC Type: Input DIC(0) Type: Input DIC('A') Type: Input ******************** 142 NAME: DBIA142-A CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: PROSTHETICS CLINICAL PROCEDURES VISTA INTEGRATION ADAPTOR Access will be used for VIAB SCDIS RPC USAGE: Controlled Subscri ENTERED: JAN 23,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File ^DIC(31,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 143 NAME: DBIA143 CUSTODIAL PACKAGE: VETERANS ADMINISTRATION SUBSCRIBING PACKAGE: HINQ USAGE: Private ENTERED: FEB 5,1992 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other HINQ v4 inits will transfer data from field 14.9 in File 3 to field 14.9 in File 200. ROUTINE: ******************** 144 NAME: DBIA144 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: FEB 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19.1 ROOT: DIC(19.1, DESCRIPTION: TYPE: File A patch (pre-release of Inpatient Meds V4) containing new keys will add the new keys to File #19.1, field .01 name. Then based on the present version, it will preload key holders for the new keys into the 'Holder' multiple (19.12) For Inpatient Medications V4 only. ROUTINE: ******************** 145 NAME: DBIA145-A CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 5,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR2 COMPONENT: EN VARIABLES: In rtn GMRPNA, the user's input is accepted, if in the form ^^XXX, X is set equal to the requested protocol, N ORVP and set ORVP to the current patient in the usual form ("#;DPT("), and D EN^OR2. All GMRP variables required to be intact upon return.are newed. ******************** 146 NAME: DBIA146 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SOCIAL WORK USAGE: Private ENTERED: MAR 11,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File This request is for permission to access some information from the DPT global directly. The data needed is the 'Other Income' field which is not returned from VADPT. This data is used by social work service with other monetary benefits information as an income screen for newly admitted patients. The data is accessed from piece 9 of the .362 DPT node. When the MB entry point of VADPT is restructed and this information included, it's agreed a patch will be issued to replace the direct access a VADPT entry point call. DURATION: Till otherwise agreed, and VADPT contains "other income". ROUTINE: ******************** 147 NAME: DBIA147-A CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: MAR 11,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other 1. The REQUEST/CONSULTATION file, 123, has a variable pointer field called "Results" which points to the following fields. 691 Echo Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 691.1 Cardiac Catheterization Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 691.5 Electrocardiogram (EKG/ECG) Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 691.6 Holter Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 691.7 Exercise Tolerance Test Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 691.8 Electrophysiology (EP) Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 694 Hematology Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 698 Generator Implant 698V1 V Lead Implant 698.2 A Lead Implant 698.3 Pacemaker Surveillance 699 Endoscopy/Consult Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 700 Pulmonary Function Tests Field 1506 RELEASE CODE Field 1511 MARK FOR DELETION 701 Rheumatology ROUTINE: ******************** 148 NAME: DBIA148 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: HEALTH SUMMARY TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: MAR 12,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Health Summary calls PATIENT^ORU1 ROUTINE: ORU1 COMPONENT: PATIENT VARIABLES: ******************** 150 NAME: PSNNGR CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: MAR 26,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Adverse Reaction Tracking (ART) package can use the PSONGR utility from the Outpatient Pharmacy package. This utility will return all of the primary ingredients to an entry in the Drug (50) file. ROUTINE: PSNNGR COMPONENT: PSONGR VARIABLES: PSODA Type: Both Input/Output = Internal entry number in File 50. PSOID Type: Output VA generic name pointer_"A"_VA product name pointer TMP("PSO", Type: Output ^TMP("PSO",$J,IFN)=PI where: IFN = internal entry number in file 50.416 of primary ingredient. PI = Primary ingredient name. ******************** 151 NAME: PSNNGR CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: MAR 26,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Adverse Reaction Tracking (ART) package can use the PSNNGR utility from the National Drug File package. This utility will return all of the primary ingredients to an entry in the National Drug (50.6) file. The ART package will use the DISPDRG entry point, if it exists, otherwise ART will call the routine from the top (i.e., D ^PSNNGR). ROUTINE: PSNNGR COMPONENT: PSNNGR VARIABLES: PSNDA Type: Both Input/Output = Internal entry number in File 50.6. PSNID Type: Output VA generic name pointer_"A"_VA product name pointer TMP("PSN", Type: Output ^TMP("PSN",$J,IFN)=PI where: IFN = internal entry number in File 50.416 of primary ingredient. PI = Primary ingredient name. COMPONENT: DISPDRG VARIABLES: PSNDA Type: Input Internal entry number to File 50.6. PSNVPN Type: Input Internal entry number of the VA PRODUCT NAMES (#7) multiple in File 50.6. TMP("PSNDD Type: Output ^TMP("PSNDD",$J,K)=DI where: K = internal entry number to the Drug Ingredients (#50.416) file DI = the NAME of the File 50.416 entry ******************** 153 NAME: DBIA153-A CUSTODIAL PACKAGE: QUALITY ASSURANCE INTEGRATION SUBSCRIBING PACKAGE: EXTERNAL PEER REVIEW USAGE: Private ENTERED: APR 20,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 741 ROOT: QA(741, DESCRIPTION: TYPE: File Read access to find patients who have had a QA occurrence which was refered to peer review associated with a particular admission. File 741 QA OCCURRENCE SCREEN The B cross reference Field 1 DATE REVIEWER (MULTIPLE) Field .01 REVIEW LEVEL Field 11 STATUS ROUTINE: ******************** 154 NAME: DBIA154 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: EXTERNAL PEER REVIEW USAGE: Private ENTERED: APR 27,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 1. CallS EN^DGYEPRP and AUTO^DGYEPRP entry points.The EN entry point is used by a option to print an external peer review report and AUTO entry point is used to by an option to autoque the report. There are no input variables to the entry points. ROUTINE: DGYEPRP COMPONENT: EN VARIABLES: COMPONENT: AUTO VARIABLES: ******************** 155 NAME: DBIA155 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: APR 29,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File A large number of users have requested that Health Summary's Chemistry and Hematology component appear in a manner analogous to the interim report. Health Summary has modified the code to look at: 1.) The PRINT ORDER field in file 60, and use it or the record number divided by 1000000, to determine the print sequence. 2.) The PRINT CODE FIELD (#53) of file 60 to format lab results ROUTINE: ******************** 156 NAME: DBIA156 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAY 21,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Clinical Warnings hooks from within MAS are needed to call PN at an appropriate time in the patient lookup process to display any warnings that may exist. That code has been developed, but not released yet by the MAS pkg. In order to beta test PN along with OE/RR and for internal Verification, two routines,DGSEC and DPTLK, have been modified in the GMRP namespace and released to the test sites/ISCs. In the post-init, DGSEC and DPTLK will be renamed in lowercase, and then the GMRP hooks installed. Documentation for the editing of the Post-Selection Action field of file #2 will also be provided. AMENDMENT TO DBIA #156 DATED 10/7/93: This agreement was originally written to allow Progress Notes to export the routines DGSEC and DPTLK to its Beta test sites and to its verifying ISC; the MAS developers had added the hooks required to call the Clinical Warnings portion of Progress Notes at the appropriate time in a patient look-up, but this code was not in the field yet. It has since been verified and released. Version 5.2 of MAS and Progress Notes no longer exports them. This agreement is updated to simply provide maintenance of those hooks in the Registration pkg until otherwise agreed; Progress Notes will maintain the entry point ENPAT^GMRPNCW called from ^DGSEC. ROUTINE: ******************** 157 NAME: DBIA157 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: MAY 21,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other As a standing integration agreement, the Progress Notes pkg (GMRP) will support the entry point ENPAT^GMRPNCW for the use of MAS in the Patient Warnings application. A line was inserted after Q^DGSEC to invoke this entry point if the rtn GMRPNCW is present in the system. Lines DGSEC+2 and CHKDFN+2^DPTLK were also modified somewhat to accomodate this call, as well as the Post-Selection Action of the Patient file (#2). The function of ENPAT^GMRPNCW sets flag (GMRPEN) which turns on Patient Warnings (CWAD) which lists directly under the patient's name on a ^DIC lookup the most recent Crisis Notes, Clinical Warning note, Allergy information, and/or Directive note in the form "C: date time"; a secondary menu option exists to allow users to view the text of these notes at their convenience. No variables are to be returned to MAS, and the only variable required to be received is the patient DFN in Y. ROUTINE: ******************** 160 NAME: DBIA160-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Pulling over the following MAS data: PATIENT (#2) file: ^DPT(D0,.21) (#.211) K-NAME OF PRIMARY NOK Direct Global Read (#.212) K-RELATIONSHIP TO PATIENT Direct Global Read (#.218) K-ZIP CODE Direct Global Read (#.219) K-PHONE NUMBER Direct Global Read (#.2125) K-ADDRESS SAME AS PATIENT'S? Direct Global Read ^DPT(D0,.211) (#.2191) K2-NAME OF SECONDARY NOK Direct Global Read (#.2192) K2-RELATIONSHIP TO PATIENT Direct Global Read (#.2198) K2-ZIP CODE Direct Global Read (#.2199) K2-PHONE NUMBER Direct Global Read (#.21925) K2-ADDRESS SAME AS PATIENT'S? Direct Global Read ^DPT(D0,.34) (#.341) D-NAME OF DESIGNEE Direct Global Read (#.342) D-RELATIONSHIP TO PATIENT Direct Global Read (#.348) D-ZIP CODE Direct Global Read (#.349) D-PHONE NUMBER Direct Global Read (#.3405) D-DESIGNEE SAME AS NOK? Direct Global Read ^DPT(D0,.321) (#.32102) AGENT ORANGE EXPOS. INDICATED? Read w/FileMan (#.32103) RADIATION EXPOSURE INDICATED? Read w/FileMan ^DPT(D0,.322) (#.32201) PERSIAN GULF SERVICE? Read w/FileMan ^DPT(D0,.21) .211 K-NAME OF PRIMARY NO .21;1 Direct Global Read & w The name of the primary next-of-kin for this applicant. .212 K-RELATIONSHIP TO PA .21;2 Direct Global Read & w If a primary next-of-kin is specified, the relationship of that person to the applicant. .218 K-ZIP CODE .21;8 Direct Global Read & w If a primary next-of-kin is specified, the zip code in which his/her city lies. .219 K-PHONE NUMBER .21;9 Direct Global Read & w If a primary next-of-kin is specified, that person's telephone number. .2125 K-ADDRESS SAME AS PA .21;10 Direct Global Read & w 'Y' if the next-of-kin should be contacted at the same address and phone number as the applicant, otherwise 'N'. ^DPT(D0,.211) .2191 K2-NAME OF SECONDARY .211;1 Direct Global Read & w If a primary next-of-kin is specified, the secondary next-of-kin name. .2192 K2-RELATIONSHIP TO P .211;2 Direct Global Read & w If a secondary next-of-kin is specified, the relationship of that person to the applicant. .2198 K2-ZIP CODE .211;8 Direct Global Read & w If a secondary NOK is specified, the zip code for the city in which that person resides. .2199 K2-PHONE NUMBER .211;9 Direct Global Read & w If a secondary NOK is specified, e telephone number at which that person may be reached. .21925 K2-ADDRESS SAME AS P .211;10 Direct Global Read & w 'Y' if the secondary NOK should be contacted at the same address and phone number as the applicant, otherwise 'N'. ^DPT(D0,.34) .341 D-NAME OF DESIGNEE .34;1 Direct Global Read & w The name of the person designated by the applicant to receive his/her personal effects. .342 D-RELATIONSHIP TO PA .34;2 Direct Global Read & w If a designee is specified, the relationship of that person to the applicant. .348 D-ZIP CODE .34;8 Direct Global Read & w If a designee is specified, the zip code for the city in which s/he resides. .349 D-PHONE NUMBER .34;9 Direct Global Read & w If a designee is specified, the telephone number at which that person may be reached. .3405 D-DESIGNEE SAME AS N .34;10 Direct Global Read & w If a primary NOK is defined, 'Y' if that person is also the designee appointed by the applicant, otherwise 'N' for no. ^DPT(D0,.321) .32102 AGENT ORANGE EXPOS. .321;2 Read w/Fileman For this veteran applicant, 'Y' if s/he was exposed to the chemical agent orange, 'N' if not, or 'U' if unknown. .32103 RADIATION EXPOSURE I .321;3 Read w/Fileman For this veteran applicant, 'Y' if s/he was exposed to ionizing radiation while in the military, 'N' if not exposed, or 'U' if unknown. ^DPT(D0,.322) .32201 PERSIAN GULF SERVICE .322;10 Read w/Fileman If the patient served in the Persian Gulf during the war (anytime after August 2, 1990), 'Y'. If the patient did not serve in the Persian Gulf during this timeframe, 'N'. 'U" if this information could not be obtained from the patient. ROUTINE: ******************** 161 NAME: DBIA161 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other 1.) A conversion rtn will copy the data found in ^YSP(606) into ^GMR(121) in the proper format. If pointers to file #16 still exist, they will be re-pointed to file #200. If version 5 is present, the codes for signature will also be converted. NO data will be automatically deleted by this process!! 2.) Documentation for the archive, purge the deletion, thru Fileman, of Files #606 & #606.5 will be provided. Also documentation for replacing the YSPN* options with GMRPN* options wherever they occur, to assure continued user access to the data. All YSPN*, GMRPN*, and YSMOVP (move Crisis Note to PN) options will be disabled for the duration of the conversion; when finished, the GMRPN* and YSMOVP options will be re-enabled and the YSPN* options will remain disabled with a message referencing the GMRPN options. Documentation will also be provided for deletion, at the sites disgression, of the old Mental Health options that will no longer be needed. 3.) When the conversion is completed, two Mental Health rtns will be updated to allow uninterrupted user access to the data: YSPP8 will be updated to check ^GMR(121) for the date of the most recent note on a given patient, and YSMV1 will be updated to transfer moving Mental Health Crisis Notes and Messages to the ^GMR(121) global from the ^YSP(606) global. These rtns will be exported as GMRPYSP8 and GMRPYSMV respectively, and renamed in the YS namespace 4.) Pointer to file #627.5, DSM-III-R Code.in field #30, DXLS, to ensure compatibility of this field in file 606. 5.) An optional tool to be run before the conversion, is a utility that will allow a site to edit the titles in the MH file (#606) before running the conversion. It has two entry points, one to generate a FileMan listing of all currently used MH titles and the other to edit the titles not desired in the new file. ROUTINE: ******************** 162 NAME: DBIA162 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Accessing the ^LR global as follows: 1) Searching the ^LR - cross references: "ASP","ACY","AEM","AAU" 2) Accessing the Topography and Morphology multiples: ^LR(D0,"SP",D1,0) - (0;1) "SP",D1,2,D2,0)) - (0;1) "SP",D1,2,D2,2,D3,0) - (0;1) 3) The same nodes for ^LR(D0,"CY") AND ^LR(D0,"EM") 4) Also the Autopsy nodes: ^LR(D0,"AU") - ("AU";1) "AU",D1,0) - (0;1) "AU",D1,2,D2,0) - (0;1) Accessing malignancies, AND the date of the test. This information is temporarily stored in the Oncology Patient file. The date of the test possibly being the date of diagnosis. In addition I should note that if the Casefinding Lab Report is printed all these nodes are accessed for the report data for each patient that has been previously "found" in a search. ROUTINE: ******************** 163 NAME: DBIA163-A CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 78.3 ROOT: RA(78.3, DESCRIPTION: TYPE: File For Automatic Casefinding Radiology: Oncology looking at: ^RA(78.3 for a defined diagnostic code containing the word Malignancy... Check the ^RADPT("AR") cross-reference for date. Look at; ^RADPT(D0,"DT",D1,"P",D2,0) NODES for procedures which have the diagnostic code found above in ^RA(78.3 - we capture those patients and the date of the "suspicious procedures" ROUTINE: ******************** 164 NAME: DBIA164 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 4,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine In order to facilitate displaying Allergy alerts and data, a call is made to Health Summary to use components there for all the alerts -- Allergies, Crisis notes, Clinical Warning notes, and Advance Directive notes. In rtn GMRPNCW, GMTSPRM is set to the appropriate abbreviation, i.e. CN=Crisis Notes, CW=Clinical Warnings and Advance Directives, and ADR=Allergies; GMTSTITL is set to an appropriate heading for the HS report, depending on the value of GMTSPRM. A call is then made to D ENCWA^GMTS to print the report of alerts selected to view by the user. ROUTINE: GMTS COMPONENT: ENCWA VARIABLES: GMTSPRM Type: Input ******************** 165 NAME: DBIA165-A CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR2 COMPONENT: EN VARIABLES: ORVP Type: Input X Type: Input Consult/Request Tracking review screens use a "Select Action: " prompt at the bottom of each screen, similiar to OE/RR. Once a protocol item is selected at the "Select Action: " prompt, the response is analyzed by the GMRCUP routine to see if the response is prefixed with "^^" for navigation to protocols outside of the immediate protocol menu being provided. If "^^" was prefixed to a protocol name the GMRCUP1 routine will setup the following variables, ORVP and X=PROTOCOL TEXT and call EN^OR2. This entry point envokes the protocol jumped to. Upon completion of the protocol, the routine control is returned to the C/RT package. ******************** 166 NAME: DBIA166 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: JUN 10,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Four components of the Health Summary package use data from the Progress Notes package -- Progress Notes, Brief Progress Notes, Crisis Notes and Clinical Warnings display components. There are structural changes to the Progress Notes global in the new version, they are reflected in changes to three Health Summary routines that access this data. Request permission to send these routines out with the tape containing the new global structure and routines for Progress Notes; they will be saved in the GMRP namespace, and in the post-init routine, using the code provided in the Kernel %ZOSF nodes, they will be saved at the site under the given Health Summary names. The routines are GMTSPN, GMTSPNE, GMTSCW. This agreement is for current release only. This release only. ROUTINE: ******************** 167 NAME: DBIA167 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File 1. Agreement to point to the Option File from the Request Services File (123.5). This will be used to establish security for service updating based on the option entered. Two special options are distributed with the Consult/Request Package which are specific to the Packages users for Pharmacy and Medicine. The GMRC initialization process sets up the option/service relationships for IRM in the Request Services File (123.5). 2. Agreement to use the XQY and XQY0 variables to determine which option the user used to get to the "Select Action: " logic for a given service. ROUTINE: ******************** 170 NAME: DBIA170 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 17,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Agreement is made to allow the AMIE package to make references to ^VA(200,DA(1),2,DA) directly. Generally lookup into ^VA(200 is blessed. Any changes to security/access information is NOT blessed. Such items of concern are: NAME, FILEMANAGER ACCESS, ACCESS CODES, VERIFY CODES, PRIMARY & SECONDARY MENUS, SECURITY KEYS, and FILE ACCESS list. ROUTINE: ******************** 171 NAME: DBIA171 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: JUN 17,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File 1.) The SURGERY SITE PARAMETERS file contains a multiple titled REQUIRED FIELDS FOR SCHEDULING which containg fields that must be entered prior to allowing a surgical case to be scheduled. This field points to the global ^DD(130, allowing selection of filed names. ^DD(133.028,.01,0) = REQUIRED FIELDS FOR SCHEDULING^P130'^DD(130,^0;1^Q 2.) The same concept is used in the RISK MODEL LAB TEST file excep we're pointing to the DDs for one of the lab files or sub-files. ^DD(139.21,.01,0) = LABORATORY DATA NAME^M*P63'X^DD(63.04,^0;1^S DIC("S")="I Y>1" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X ^DD(133.028,.01,0) ^DD(139.21,.01,0) ROUTINE: ******************** 172 NAME: DBIA172-A CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: JUN 17,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DSS Extracts needs data from the Inpatient Medications package which cannot be extracted from any file. The Inpatient Medications team has agreed to modify two routines (PSGPLF and PSGAMSA) to call, after executing %ZOSF("TEST"), routine ECXUD1 to place data into a DSS file for future extract by DSS. The requested data is placed in the ECUD variable, which the ECXUD1 routine uses to store the data in the UNIT DOSE EXTACTS file (#720.904). ROUTINE: ECXUD1 COMPONENT: ECXUD1 VARIABLES: ECUD Type: Input Variable ECUD contains the following pieces of data: 1. DFN of the patient for whom the drug was dispensed. 2. Date drug was dispensed in FileMan format (no time). 3. The IEN of the drug dispensed. 4. Units dispensed. For example: number of tablets. 5. The IEN of the ward location for the patient. Pointer to file #42. 6. The IEN of the provider who placed the order. 7. Cost of the units dispensed. 8. Order Start Date/Time in FileMan format. 9. The IEN of the order number. ******************** 173 NAME: DBIA173 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HINQ USAGE: Private ENTERED: JUN 17,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The MAS package will carry along the HINQ mini inits when it installs MAS v5.2. The HINQ mini inits (DVBY*) are a collection of routines that will install a new edit template field into the HINQ edit template (DVBHINQ UPDATE) which is part of the patient file. The entry point to call is ^DVBYCHK . This routine will check to ensure the proper version of the HINQ package is installed (V4.0). If at least 4.0 is not installed the init will not be run. Installation notes will be provided to the MAS developers for inclusion into the MAS release notes. ROUTINE: ******************** 174 NAME: DBIA174 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: QUASAR CLINICAL CASE REGISTRIES REMOTE ORDER/ENTRY SYSTEM CLINICAL PROCEDURES USAGE: Controlled Subscri ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Direct global access to patient file, Field .3721--Rated Disabilities (VA). ^DPT(DFN,.372) .01 RATED DISABILITIES ( Direct Global Read & w 2 DISABILITY % Direct Global Read & w 3 SERVICE CONNECTED Direct Global Read & w ROUTINE: ******************** 175 NAME: DBIA175 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDX routines will be exported with MAS 5.2. ROUTINE: ******************** 176 NAME: DBIA176 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DG( DESCRIPTION: TYPE: File PDX uses direct access to ^DG global. ROUTINE: ******************** 177 NAME: DBIA177 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Progress Notes has permission to place the XUSESIG option on one of its menus during export. ROUTINE: ******************** 178 NAME: DBIA178 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other OR/RR has permission to place the XUSESIG option on one of its menus during export. ROUTINE: ******************** 180 NAME: DBIA180 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: JUN 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Surgery uses the entry point DI^DIU as follows: Prior to entry, the following input variables must be supplied: DI = file number N = 0 X = null (or you can set it to any combination of "WC.01" where W" will screen out word-processing fields, "C" will screen out computed fields, and ".01" will screen out the .01 field at both top and subfile levels.) At the end, all variables set by Surgery will be killed, and in addition, %,C,DA,DDH,DI,DIC,DISYS,I,J and Y will be killed. After calling this routine, varible N will tell how many levels down you went into subfiles (0 is top level, 1 is 1 level down, etc.). The I array will tell the subscript for each multiple level at which the data is located (ex., I(1) for first level down, I(2) for second). The J array will tell the subfile number at each multiple level (ex.,J(1) for first level down, J(2) for second). ROUTINE: DIU COMPONENT: DI VARIABLES: DI Type: Input N Type: Input X Type: Input I Type: Output J Type: Output ******************** 181 NAME: DBIA181-A CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUHDR COMPONENT: EXT VARIABLES: ORIFN Type: Both ORAGE Type: Output ORIO Type: Output ORANSI Type: Output ORDOB Type: Output ORFT Type: Output ORHI Type: Output ORNP Type: Output ORL Type: Output ORPD Type: Output ORPNM Type: Output ORPV Type: Output ORSEQ Type: Output ORSEX Type: Output ORSSN Type: Output ORTIT Type: Output ORTS Type: Output ORVP Type: Output ORWARD Type: Output Displays a standard header for detailed order displays. If calling this from within OE/RR, it is not necessary to kill the returned variables. OE/RR will kill them. REQUIRED VARIABLES: ORIFN RETURNED VARIABLES: ORAGE,ORIO ORANSI,ORDOB, ORFT,ORHI,ORIFN, ORNP,ORL,ORPD, ORPNM,ORPV,ORSEQ, ORSEX,ORSSN,ORTIT, ORTS,ORVP,ORWARD COMPONENT: PGBRK VARIABLES: DIROUT Type: Output OREND Type: Output Displays "Press return to continue or "^" to escape" at page breaks. REQUIRED VARIABLES none RETURNED VARIABLES: DIROUT,OREND ******************** 182 NAME: DBIA182 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JUL 14,1992 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.3 FILE: ROOT: DESCRIPTION: TYPE: Routine DGPTFMO1 AT LINE 17 ISSUES A CALL TO N^DIP1. This is currently being renegotiated to use a supported reference that will be available in version 21 of Fileman. V21 will still have the entry point N^DIP1, but it is recommended that the new supported reference be used when available. ROUTINE: DIP1 COMPONENT: N VARIABLES: ******************** 185 NAME: DBIA185-A CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JUL 16,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 131.7 ROOT: SRS( DESCRIPTION: TYPE: File An E3R has been issued, asking to modify the Health Summary Print by location option to allow selection of an Operating Room, and to queue the selected Health Summary Type to print for all patients scheduled for surgery in that OR on a user-specified date. To that end, the Print by Location driver has been modified to look at the "B" cross reference of the Operating Room File (i.e., ^SRS("B",+LOC,ORLOC)) to get the record number of the selected OR, and then traverse the "AOR" cross reference of the Surgery File (i.e., ^SRF("AOR",+ORLOC,SDT,SRN) to get the record number of each surgery. It then visits the zero-node of each Surgery record to get the patient, whom it adds to the list of patients for Health Summaries to be printed. Health Summary makes direct references to the above cited globals and cross references. ^SRS('B',+LOC,ORLOC) ROUTINE: ******************** 186 NAME: DBIA186-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Means Test Billing Conversion. ROUTINE: DGINPW ******************** 187 NAME: DBIA187-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS CLINICAL REMINDERS added 5/14/09 USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Integrated Billing uses the following functions, routines, files and fields: 2 DPT PATIENT FILE .01 NAME-- Used for sorting and printed on a patients Check-off Sheet and on the 'Unbilled BASC codes for insured Patients' report, returned by function PT, function created to replace DEM^VADPT call .363 PRIMARY LONG ID-- Returned by function PT, function created to replace DEM^VADPT call .364 PRIMARY SHORT ID-- Returned by function PT, function created to replace DEM^VADPT call 2.98 (1900) APPOINTMENT SUBFILE 3-- STATUS-- Used to determine if Check-off sheet should be printed 9.5-- APPOINTMENT TYPE Printed on a patients Check-off Sheet .3721(2.04) RATED DISABILITIES SUBFILE printed on a patients Check-off Sheet if SERVICE CONNECTED is true .01 RATED DISABILITIES 2 DISABILITY % 3 SERVICE CONNECTED ^DPT(patient file)-- "ADIS"-- ^IBOVOP1: xref on login date/time - "DIS"-- ^IBOVOP1: disposition node - 0;2 STATUS - 0;3 TYPE OF BENEFIT APPLIED FOR - 0;7 DISPOSITION - "S"-- ^IBECEA, ^IBOVOP, ^IBOVOP1 check appointments for a C&P - "ACS"-- ^IBOVOP: means test status - .311 node-- ^IBEHCFA: insured's info PATIENT, #2-- "CN" cross-reference Billing of all current Category C clients. ROUTINE: ******************** 190 NAME: DBIA190-A CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY CLINICAL PROCEDURES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 6,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Medicine package has the permission of the Allergy Tracking System developers to use the following items from ATS V2.2. EN2^GMRAPEM0: This entry point is to be used by the Medicine package to enter data into the Allergy Tracking System. The input variable is DFN (pointer to file 2). ROUTINE: GMRAPEM0 COMPONENT: EN2 VARIABLES: ******************** 193 NAME: DBIA193 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: MCCR NATIONAL DATABASE USAGE: Private ENTERED: SEP 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To activate the data extraction process of the Accounts Receivable package, the MCCR National Database - Field Component, using indirection, will issue the following call using parameter passing: D EN1^PRCANRU(PRQDAT,PRQSTR,PRQIDN,.PRQERR) Where: PRQDAT is a pieced variable, with ^ as the piece delimiter, as follows: site number ^ batch number ^ from date ^ to date PRQSTR is a variable which defines a global root where the package extraction routine will place the data according to the format below. PRQIDN is a unique identifier number PRQERR is an error flag which will be set to "1 DATA COLLECTION ABORTED". The extract routine must reset this variable so it evaluates to zero as an indicator that the extraction process ran to completion. Data is stored using the global root as follows: PRQSTR_","_criteria#1_"-"_criteria#2)=#count^$amount for example: ^TMP("PRQ","2020D611","1-1")=50^25000 The actual line of code in the MCCR National Database - Field Component will appear as: D @(extractor entry point) D DRIVER^PRQSD. Finally, the code for invoking the routine will exist as an entry in the MCCR Collections Routine file. The AR package may directly enter an extractor routine into the MCCR Collection Routines file (file #466), as part of its installation procedure. The entry must include routine name and status, and proper cross-references for these two fields. The routine name should include a "#" character to indicate the proper position of the "^". Status may be either active or inactive. Inactive extractors will not be invoked by the MCCR National Database software. The following extractor will be entered during installation of the MCCR National Database - Field Component: EN1#PRCANRU(PRQDAT,PRQSTR,PRQIDN,.PRQERR). This entry may be modified, or other entries added, in subsequent AR releases with prior notification to, and concurrence of, the San Francisco ISC. ROUTINE: PRCANRU COMPONENT: EN1 VARIABLES: ******************** 194 NAME: DBIA194 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: SEP 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File The Risk Assessment module of the Surgery package contains options that locate and store lab test values for certain lab tests, which are later transmitted to the Surgery Risk Assessment database at Hines for eventual analysis. These options allow for the automatic input of pre-operative and post-operative lab test values into the Surgery file. Each lab test and its associated specimen is defined in one of the Surgery package files along with the site-specific 'Data Name(s)' associated with each test. The information in this file is used to locate the latest pre-operative test value within 30 days of the operation and the highest and/or the lowest test value within 30 days after the operation. The following files within the LABORATORY package are pointed to by Surgery: - File 61 (TOPOGRAPHY FIELD) - File 63 (LAB DATA) Sub-File 63.04 (CHEM, HEM, TOX, RIA, SER, etc.) Surgery reads data in the following fields within file 63 (LAB DATA): - 63.04,.01 - DATE/TIME SPECIMEN TAKEN Global Reference: ^LR(LRDFN,"CH",INVERSE DATE/TIME,0), piece #1 The INVERSE DATE/TIME subscript is determined by looping through ^LR(LRDFN,"CH",INVERSE DATE/TIME) for the inverse date/time range based on the date/time of operation and the date/time of operation +/- 30 days (minus 30 days for pre-operative data or plus 30 days for post-operative data). - 63.04,.03 - DATE REPORT COMPLETED Global Reference: ^LR(LRDFN,"CH",INVERSE DATE/TIME,0), piece #3 - 63.04,.05 - SPECIMEN TYPE Global Reference: ^LR(LRDFN,"CH",INVERSE DATE/TIME,0), piece #5 - 63.04,* All LAB TEST fields associated with Risk Assessment Global Reference: ^LR(LRDFN,"CH",INVERSE DATE/TIME,DATA NAME), piece #1 The DATA NAME subscript is determined by looping through ^LR(LRDFN,"CH",INVERSE DATE/TIME,DATA NAME) checking for a match with site specific Risk Assessment lab test data names stored in the Surgery package. Because the Surgery package will be making direct reference to data in the Laboratory namespace, we request a Database Integration Agreement with the developers of the Laboratory package permitting Surgery to reference the above mentioned Laboratory data structures. ROUTINE: ******************** 196 NAME: DBIA196-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: SEP 24,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 62.5 ROOT: LAB(62.4, DESCRIPTION: TYPE: File The Medicine Package has permission from the Lab developers for read and write access to the ^LA node for the purpose of LSI autoinstrument interfacing. The Medicine Package has permission from the Lab developers for creating entries in the Autoinstrument file for the purpose of LSI autoinstrument interfacing. ROUTINE: ******************** 197 NAME: DBIA197 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: OCT 7,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61.6 ROOT: LAB(61.6, DESCRIPTION: TYPE: File Oncology is granted LAYGO access to the SNOMED Occupational File in Laboratory. ROUTINE: ******************** 198 NAME: DBIA198 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES DRUG ACCOUNTABILITY USAGE: Controlled Subscri ENTERED: NOV 24,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410 ROOT: PRCS(410, DESCRIPTION: TYPE: File In an effort to provide a receiving mechanism for Controlled Substances module, several look-ups and pointers are necessary for an interim interface. For Purchase Order receipts, a lookup to PROCUREMENT & ACCOUNTING TRANSACTIONS file 442, screened by cost center [822400] is used. For Issue Receipts, a lookup occurs, screened by cost center [822400], in CONTROL POINT ACTIVITY file 410. A connection between the DRUG file 50 and ITEM MASTER file 441 is crucial for posting receipt information. This may be a one-to-many relationship and therefore involves the creation of a multiple IFCAP ITEM NUMBER field (#50.0441) in the DRUG file 50 pointing to the ITEM MASTER file 441. This field includes an input transform similar to that found in the NDC field in the ITEM MASTER file 441 preventing the linking of the same item to more than one drug. It also includes an 'AB' whole file cross-reference. Pointer to CONTROL POINT ACTIVITY file 410 Pointer to ITEM MASTER file 441 Pointer to PROCUREMENT & ACCOUNTING TRANSACTIONS file 442 References information (Read only) from CONTROL POINT ACTIVITY file 410 .01 TRANSACTION NUMBER 10 ITEM .01 LINE ITEM NUMBER 1 DESCRIPTION 2 QUANTITY 3 UNIT OF PURCHASE 5 REPETITIVE (PR CARD) NO. 6 STOCK NUMBER 7 EST. ITEM (UNIT) COST 13 QUANTITY POSTED (WHSE) 14 QUANTITY REC'D (PRIMARY) IFCAP files are used solely to gather and display receipt information and so the Controlled Substances files 58.8 and 58.81 can accumulate a receipt history. DURATION: Till otherwise agreed, when the GIP & Drug Accountability interf ace is available ROUTINE: ******************** 200 NAME: DBIA200 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ADP PLANNING (PLANMAN) USAGE: Private ENTERED: DEC 14,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The ADP USER file 497.2 may have its top level .01 field DINUMed to the NEW PERSON file 200. The ADP USER file is limited to distribution to the ISCs. ROUTINE: ******************** 201 NAME: DBIA201 CUSTODIAL PACKAGE: EXTERNAL PEER REVIEW SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: DEC 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine DGYEPRN makes a call to $$QA^QIEQA($P(DGPT0,"^"),$P(DPT0,"^",2).$P(DGPT70,"^")). Resolving the $P functions it equates to $$QA^QIEQA(DFN,ADM,DIS). DFN=patient, ADM=admit date, DIS=discharge date. The function checks to see if the patient was referred to peer review in the QA application. (See DBIA # 153 for agreement between EPRP and QA for global access.) ROUTINE: QIEQA COMPONENT: $$QA VARIABLES: ******************** 202 NAME: DBIA202 CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING EXTERNAL PEER REVIEW USAGE: Controlled Subscri ENTERED: JAN 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IRT has permission to call in the following RT routines: MED^RTUTL3 calls LATEST^RTUTL3 where the doc is LATEST^RTUTL3 input variable is RTE entity DFN_";DPT(" output RTDATA=volume^borrower^phone/room#^date/time charged RT = internal record number. ROUTINE: RTUTL3 COMPONENT: MED VARIABLES: RT Type: Output RTE Type: Input RTDATA Type: Output COMPONENT: LATEST VARIABLES: RTE Type: Input RTDATA Type: Output RT Type: Output ******************** 205 NAME: DBIA205 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: JAN 29,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 723 ROOT: ECC(723, DESCRIPTION: TYPE: File Version 3.0 of the Surgery software had permission to export the MEDICAL SPECIALTY file (#723) with data in the inits. ^ECC(723, .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 206 NAME: DBIA206 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: JAN 29,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery package has permission to invoke the entry point DCOR^PSIVACT, which is exported as part of the Inpatient Meds package. This entry point allows surgery to discontinue all of a specific patient's IV orders, and is documented in the version 4.0 Inpatient Meds will continue to support this entry point until agreed. When DCOR^PSIVACT is invoked DFN, must be set to the IEN for the patient whose orders are to be discontinued. DCOR^PSIVACT uses the following variables: ON1, PSIVRES, PSIVREA, PSIVDFN,PSIVON, PSIVLN. These variables are killed upon exit from the utility. DFN is unchanged. In setting up the call to DCOR^PSIVACT, Surgery sets DFN and PSIVRES. The other variables mentioned are set within PSIVACT. ROUTINE: PSIVACT COMPONENT: DCOR VARIABLES: DFN Type: Input ON1 Type: Used PSIVRES Type: Input PSIVREA Type: Used PSIVDFN Type: Used PSIVON Type: Used PSIVLN Type: Used ******************** 207 NAME: DBIA207 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: FEB 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Surgery is granted a database integration agreement with Laboratory allowing Surgery to make a call to LRRP2 by executing %ZOSF("TEST"), then calling LRRP2. ROUTINE: LRRP2 ******************** 208 NAME: PSSGIU CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery package is given formal permission from Inpatient Medications to make calls to the routine PSGIU to mark and unmark entries in the DRUG file (#50) for anesthesia use. The entry points ENS^PSGIU and END^PSGIU are the same entry points Surgery Version 2.12 has been using and we want to continue using them in Version 3.0. Both entry points are documented in the Inpatient Medications Technical Manual for Version 4.0. ROUTINE: PSSGIU COMPONENT: ENS VARIABLES: PSIUDA Type: Input PSIUX Type: Input Entry point to mark drug for anesthesia use Surgery package sets variables PSIUDA and PSIUX prior to calling ENS^PSIGU. COMPONENT: END VARIABLES: PSIUDA Type: Input PSIUX Type: Input Entry point to unmark drug for anesthesia use. Surgery package sets variables PSIUDA and PSIUX prior to calling END^PGIGU. ******************** 209 NAME: DBIA209 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.6 ROOT: PSNDF( DESCRIPTION: TYPE: File Drug Accountability is granted this agreement to connect the DRUG (#50) file to the ITEM MASTER (#441) file to make use of a look-up to the NATIONAL DRUG (#50.6) file. If a selected DRUG file entry has a NATIONAL DRUG FILE ENTRY (#20), a beloved path is followed to the NDC (#1) multiple in the NATIONAL DRUG (#50.6) file. The user is allowed to check as many of these NDCs as they choose for a match in the ITEM MASTER (#441) file. GLOBAL MAP DATA DICTIONARY #50 -- DRUG FILE STORED IN ^PSDRUG( SITE: BIRMINGHAM ISC (#14) (VERSION 6) ------------------------------------------------------------------------- ^PSDRUG(D0,0)=(#.01) GENERIC NAME [1F] ^ ^PSDRUG(D0,441,0)=^50.0441P^^ (#441) IFCAP ITEM NUMBER ^PSDRUG(D0,441,D1,0)= (#.01) ITEM NUMBER [1P] ^ ^PSDRUG(D0,ND)= (#20) NATIONAL DRUG FILE ENTRY [1P] ^ GLOBAL MAP DATA DICTIONARY #50.6 -- NATIONAL DRUG FILE 02/11/93 STORED IN ^PSNDF( (2269 ENTRIES) SITE: BIRMINGHAM ISC (#14) ------------------------------------------------------------------------- ^PSNDF(D0,0)= (#.01) VA GENERIC NAME [1F] ^ ^PSNDF(D0,2,D1,3,D2,4,D3,5,D4,6,D5,7,0)=^50.67^^ (#1) NDC ^PSNDF(D0,2,D1,3,D2,4,D3,5,D4,6,D5,7,D6,0)= (#.01) NDC [1F] ^ Drug Accountability/Inventory Interface v3.0 interfaces with the prime vendor invoice data. It uses the 12-digit NDC to match the invoice's line items to drugs in the DRUG file (#50) if the NDC is not in the DRUG file. If the NDC is found in the "NDC" cross-reference, the VA PRODUCT NAME POINTER field (#3) is read to locate the VA PRODUCT NAMES field (#7). The DRUG file's "VAPN" cross-reference is traversed to determine if any drugs have the same VA product name. If so, the drugs are used as a suggested possible match to the line item. GLOBAL MAP DATA DICTIONARY #50.6 -- NATIONAL DRUG FILE -------------------------------------------------------------------------- CROSS REFERENCED BY: NDC(NDC) ^PSNDF(D0,2,D1,3,D2,4,D3,5,D4,6,D5,7,D6,0)= (#.01) NDC [1F] ^^^ (#3) VA ==>PRODUCT NAME POINTER [4N] ^ ^PSNDF(D0,5,0)=^50.68A^^ (#7) VA PRODUCT NAMES ^PSNDF(D0,5,D1,0)= (#.01) VA PRODUCT NAMES [1F] ^ ^PSNDF(D0,0) .01 VA GENERIC NAME 0;1 Direct Global Read & w This is the VA Generic name of drug 3-64 characters in length. This file contains a list of available drug products. It includes specific information for each product, including trade name, NDC number, manufacturer , VA Drug Class code, dosage form, route of administration, strength, units, ingredients, ingredient strength and units, package code, package size, package type, VA Product Name, and VA Generic Name. The NDF software attempts to match products from this file with products in the local DRUG file. ^PSNDF(D0,2,D1,3,D2,4,D3,5,D4,6,D5,7,D6,0 .01 NDC 0;1 Direct Global Read & w This is the NDC (National Drug Code) of this product. 3 VA PRODUCT NAME POIN 0;4 Direct Global Read & w This is the entry number in the VA Product Name multiple of this product. This is the NDC (National Drug Code) multiple. ^PSNDF(D0,5,D1,0) .01 VA PRODUCT NAMES 0;1 Direct Global Read & w This is the VA Product Name. This is the VA Product Name multiple. ROUTINE: ******************** 210 NAME: DBIA210 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 66 ROOT: LAB(66, DESCRIPTION: TYPE: File The Surgery package is granted permission from the Laboratory package to read from the BLOOD PRODUCT file (#66) for purposes of storing the blood components requested for surgical cases. Surgery will point to the BLOOD PRODUCT file (#66), using a screen which looks at the CAN BE REQUESTED field (#.15) to allow selection of only those blood products that have been flagged for patient use. In summary, Surgery will READ only, the NAME field (#.01) and the CAN BE REQUESTED field (#.15) of the BLOOD PRODUCT file (#66). The BLOOD PRODUCT file is stored in ^LAB(66). The NAME is stored in $P(^LAB(66,DA,0),"^") where DA is the internal entry number in the file for the blood product. The CAN BE REQUESTED information is stored in $P(^LAB(66,DA,0),"^",15). ROUTINE: ******************** 211 NAME: DBIA211-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File ^LAB(60,D0,0) 4 SUBSCRIPT 0;4 Direct Global Read & w 5 LOCATION (DATA NAME) 0;5 Direct Global Read & w ^LAB(60,D0,10) 504 CIS TEST CODE 10;1 Direct Global Read & w Accessed to support CIS interface, e.g., EMTEK ROUTINE: ******************** 212 NAME: DBIA212 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59 ROOT: PS(59, DESCRIPTION: TYPE: File ^PS(59, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 213 NAME: DBIA213 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Permission is granted for Controlled Substances to: Export AR/WS files 58.16 AOU INVENTORY TYPE 58.17 AOU ITEM LOCATION 58.2 AOU INVENTORY GROUP (partial file) .01 NAME 2 GROUP DESCRIPTION 3 NARCOTIC AREA OF USE (NAOU) .01 NARCOTIC AREA OF USE (NAOU) 1 INVENTORY TYPE .01 INVENTORY TYPE 2 SORT KEY "CS" X-REF ON NARCOTIC AREA OF USE (NAOU) Pointer to AOU INVENTORY TYPE file 58.16 Pointer to AOU ITEM LOCATION file 58.17 GLOBAL MAP DATA DICTIONARY #58.16 -- AOU INVENTORY TYPE FILE STORED IN ^PSI(58.16, (4 ENTRIES) SITE: BIRMINGHAM ISC (#14) ^PSI(58.16,D0,0)= (#.01) NAME [1F] ^ ^PSI(58.16,D0,1,0)=^58.18^^ (#1) TYPE DESCRIPTION ^PSI(58.16,D0,1,D1,0)= (#.01) TYPE DESCRIPTION [1W] ^ GLOBAL MAP DATA DICTIONARY #58.17 -- AOU ITEM LOCATION FILE STORED IN ^PSI(58.17, (2 ENTRIES) SITE: BIRMINGHAM ISC (#14) ------------------------------------------------------------------------ ^PSI(58.17,D0,0)= (#.01) ITEM ADDRESS CODE [1F] ^ ^ (#.5) CODE EXPANSION ==>[3F] ^ GLOBAL MAP DATA DICTIONARY #58.2 -- AOU INVENTORY GROUP FILE STORED IN ^PSI(58.2, (2 ENTRIES) SITE: BIRMINGHAM ISC (#14) ------------------------------------------------------------------------ ^PSI(58.2,D0,0)= (#.01) NAME [1F] ^ ^PSI(58.2,D0,2,0)=^58.23^^ (#2) GROUP DESCRIPTION ^PSI(58.2,D0,2,D1,0)= (#.01) GROUP DESCRIPTION [1W] ^ ^PSI(58.2,D0,3,0)=^58.29P^^ (#3) NARCOTIC AREA OF USE (NAOU) ^PSI(58.2,D0,3,D1,0)= (#.01)NARCOTIC AREA OF USE (NAOU)[1P]^(#2)SORT KEY ==>[2N] ^ ^PSI(58.2,D0,3,D1,1,0)=^58.291PA^^ (#1) INVENTORY TYPE ^PSI(58.2,D0,3,D1,1,D2,0)= (#.01) INVENTORY TYPE [1P] ^ ROUTINE: ******************** 214 NAME: DBIA214 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY CONTROLLED SUBSTANCES PHARMACY DATA MANAGEMENT USAGE: Controlled Subscri ENTERED: FEB 22,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The following is entered as DBIA until the next version of DA: All components indentified in this integration request involve reading from IFCAP files. Drug Accountability does not write to any IFCAP files. Looking toward an interface with the IFCAP Generic Inventory Package, Drug Accountability (PSA) begins the process with a Connection Menu. The PSAINIT creates in the DRUG file (#50) a multiple (#50.0441) pointing to the IFCAP ITEM MASTER file (#441), enabling a direct link between the DRUG file (#50) and the ITEM MASTER file (#441). The first connecting tool provided in the Connection Menu is a sub- menu using the National Drug Code (NDC) to attempt matching entries. In the ITEM MASTER file (#441), the NDC field (#4) is located in the VENDOR multiple (#6). This field has an input transform that prevents a user from using the same NDC for more than one ITEM MASTER file entry. In studying an ITEM MASTER file from a local site, it was discovered that there were several entries in their ITEM MASTER file that did possess the same NDC. Since this situation might lead a connector to link a drug to a potentially less active item, the first option in the NDC Menu is the NDC Duplicates Report (ITEM file). This report loops through the NDC ("F") x-ref in #441. If more than one item contains the same NDC and is not inactive (field #16, '$G(^PRC(441,D0,3))), the duplicates are listed. The report displays the NDC that has more than one item attached to it, the item numbers attached, their SHORT DESCRIPTION (#.05), and the VENDOR (#6) => VENDOR file (#440,#1) that contains the duplicated NDC. The second item on the NDC Menu is the Report Potential NDC Matches option. This report loops through the active, unlinked (to #441) entries in the DRUG file (#50) that have an NDC. If a corresponding NDC is found in the "F" x-ref in the ITEM MASTER file (#441), the NDC and drug name are listed from the DRUG file (#50) and the ITEM NUMBER (#.01) and DESCRIPTION (#.1) listed from the ITEM MASTER file (#441). Using the ITEM NUMBER ("AB") x-ref in the DRUG file (#50), a check is made to see if the matched ITEM MASTER file entry is already linked to another DRUG file entry. If so the user is informed of the existing connection. Using this same loop and display criteria, the Controlled Connection by NDC Match allows the user the opportunity to actually link matched entries. If the user approves the displayed match, a ^DIE stuff of the item number into the item multiple (#50.0441) in the DRUG file occurs. Likewise, the Automated DRUG/ITEM file link by NDC option uses the same loop and display criteria and the ^DIE stuff for all matches in the loop. In the event that the user requires more information about a selected drug from either the DRUG file or the ITEM MASTER file before linking, the Inquire/Compare DRUG file/ITEM file option is available. This option uses a FM inquire with a no-link pointer jump from the DRUG file to the ITEM MASTER file via the NDC "F" x-ref in #441. The user selects the drug from the DRUG file and along with corresponding info from the DRUG file the DESCRIPTION (#.1), NSN (#5), NDC (VENDOR (#6),#4) by which the jump occurred, and from that same VENDOR multiple the UNIT COST (#1), UNIT OF PURCHASE (#1.5), DATE OF UNIT PRICE (#2.5), PACKAGING MULTIPLE (#1.6), calculated unit cost = UNIT COST (#1)/DISPENSE UNITS PER ORDER UNIT from the DRUG file, VENDOR (#.01), CREATED BY (#15), and with a jump to #200 their OFFICE PHONE NUMBER. Using this same jump, the DRUG file/ITEM file Comparison Report displays the same data with the user selecting a range of drugs from the DRUG file. The FSN Menu functions similar to the NDC Menu. The Report Potential FSN Matches option loops through the active, unlinked (to #441) entries in the DRUG file that have an FSN. If a corresponding NSN is found in the "BA" x-ref in the ITEM MASTER file, the FSN and drug name are listed from the DRUG file and the ITEM NUMBER (#.01) and DESCRIPTION (#.1) listed from the ITEM MASTER file. Using the ITEM NUMBER ("AB") x-ref in the DRUG file, a check is made to see if the matched ITEM MASTER file entry is already linked to another DRUG file entry. If so the user is informed of the existing connection. Using this same loop and display criteria the Controlled Connection by FSN Match option allows the user to actually link matched entries. If the user approves the displayed match, a ^DIE stuff of the item number into the item multiple (#50.0441) in the DRUG file occurs. Likewise, the Automated DRUG/ITEM File Link by FSN option uses the same loop and display criteria and the ^DIE stuff for all matches in the loop. The Single Drug Match option uses both the NDC and FSN/NSN tools described previously to offer a connection for a single selection from the DRUG file. If a link to an ITEM MASTER file entry already exists, it is displayed to the user and they may edit the connection in the DRUG file. Using the ITEM NUMBER multiple pointer (#50.0441) in the DRUG file, the user can also do look-ups to the ITEM MASTER file via available x-refs (NSN (BA), SHORT DESCRIPTION (C), VENDOR STOCK # (D), or NDC (F)) in order to select additional connections. The Report of Unlinked DRUG/ITEM File Entries lists active drugs from the DRUG file which do not yet have any entries in the ITEM NUMBER multiple (#50.0441). The Connect Unlinked DRUG/ITEM file Entries option loops through these unlinked entries and offers all the tools described in the Single Drug Match option to perform the links. The Active, Unlinked Drugs in the ITEM File option allows the user to select a purchase date from which to consider an ITEM MASTER file drug active. It then loops through the ITEM MASTER file and when an entry's FSC (#2) = 6505 (Federal Supply Classification for drugs), is not an INACTIVATED ITEM? (#16), is not linked to a drug('$O(^PSDRUG,"AB",ITEM,"")), has an entry in the FCP (#1) multiple, and has within at least one FCP entry, an entry in the PURCHASE ORDER (#1) multiple, the P.O. DATE(s) (#442,#.1) are checked against the user selected purchase date. For entries that pass this criteria, the ITEM NUMBER (#.01), SHORT DESCRIPTION (#.05), NSN (#5), LAST VENDOR ORDERED (#9), NDC (#6,#4) (for the LAST VENDOR ORDERED), and the DESCRIPTION (#.1) are displayed. The Display Connected Drug option allows the user to print both a vendor catalog for a selected item as well as a procurement history. The user selects an entry from the DRUG file. If it is connected to more than one entry in the ITEM MASTER file the user is asked to select one of the connected entries from the ITEM NUMBER multiple (#50.0441). From the ITEM MASTER file, the ITEM NUMBER (#.01), SHORT DESCRIPTION (#.05),and NSN are displayed. If the selected ITEM MASTER file entry has only one VENDOR (#6) or has a MANDATORY SOURCE (#10), then that vendor is displayed along with the VENDOR STOCK # (#3), NDC (#4), PACKAGING MULTIPLE (#1.6), UNIT OF PURCHASE (#1.5), UNIT COST (#1), MINIMUM ORDER (#8), DATE OF UNIT PRICE (#2.5), and REQUIRED ORDER MULTIPLE (#9). If there is more than one vendor for the item, the LAST VENDOR ORDERED (#9) is displayed as well as each available vendor sorted by DATE OF UNIT PRICE (#2.5), beginning with the most recent date. For each vendor the PACKAGING MULTIPLE (#1.6), UNIT OF PURCHASE (#1.5), UNIT COST (#1), DATE OF UNIT PRICE(#2.5), and whether or not the vendor has a current contract is listed. The contract verification is made by looping through the CONTRACT NUMBER multiple (#6) in the VENDOR file (#440) and checking the EXPIRATION DATE (#1). If there is an entry in the FCP (#1) multiple for the selected item and any of the FCP entries have an entry in their PURCHASE ORDER (#1) multiple, the user is offered a procurement history. They can enter a date from which they wish to view the history. They must also select an FCP. For each purchase order that passes the criteria, the PURCHASE ORDER NUMBER (#.01), VENDOR (#5), P.O. DATE (#.1), QUANTITY (#40,#2) (LINE ITEM NUMBER located using the "AE" x-ref in the ITEM (#40) multiple), UNIT OF PURCHASE (#3), TOTAL COST(#15), and QUANTITY PREVIOUSLY RECEIVED (#11) are displayed. Average ordered/month, total ordered, and total cost are also listed. If the MANDATORY SOURCE (#10) for the selected item is flagged in the VENDOR file (#440) with an "S" in the SUPPLY WHSE. INDICATOR (#.05), then the user is informed that the Supply Warehouse is the mandatory source. Using the "AD" x-ref in the INVENTORY TRANSACTION file (#445.2) a check is made for any distribution by the warehouse of this item. If procurement history exists, the user is informed and allowed to enter a date from which to view the history. By looping through the "AD" x-ref in #445.2 and checking the TRANSACTION ID (#1)?1"R".N and the DATE POSTED (#2.5) is not less than the user entered date, a history is displayed. From the INVENTORY TRANSACTION file (#445.2), the DATE POSTED (#2.5), TRANSACTION/P.O. NUMBER (#410), -QUANTITY (#6), PACKAGING UNIT (#5), SELLING UNIT PRICE (#8), and OTHER INVENTORY POINT AFFECTED (#14) are displayed. The Unposted Procurement History and Posted Drug Procurement History options are an effort to restore some of the drug accountability lost with the disappearance of the LOG 036 report. For the Unposted Procurement History, the user is asked to select a month to review. A loop through the PROCUREMENT & ACCOUNTING TRANSACTION file (#442), using the P.O. DATE ("AB") x-ref collects PO's for the user selected month. If the COST CENTER (#2) = 822400 (Pharmacy) and the SUPPLY STATUS (#.5)>14 & <45 (basically ordered), the PO's are sorted into ^TMP by Station/FCP. For each Station/FCP the PO's are listed, displaying PURCHASE ORDER NUMBER (#.01), P.O. DATE (#.1), FCP(#1), VENDOR (#5), and TOTAL AMOUNT (#91). While looping through these PO's another ^TMP is created, sorted by the DESCRIPTION (#1) of each ITEM (#40) on each PO. The user is asked if they would like to print item totals. If so, an alphabetical listing occurs displaying each ITEM's (#40) DESCRIPTION (#1) and REPETITIVE (PR CARD) NO. (#1.5) and each PURCHASE ORDER NUMBER (#.01), P.O. DATE (#.1), FCP (#1), QUANTITY (#40,#2), ACTUAL UNIT COST (#40,#5), and TOTAL COST (#40,#15). Finally, the user is if they would like a list of high dollar items. They are invited to enter a cut-off dollar amount and each item exceeding that amount is listed beginning with the highest total cost. The total cost was determined by totaling the TOTAL COST (#40,#15) amounts for each item listed in the previous display and building a ^TMP to sort from high to low. Each ITEM's (#40) DESCRIPTION (#1), total TOTAL COST (#15), and Station/FCP is shown. The Posted Drug Procurement History option uses the TYPE OF INVENTORY POINT ("AC") x-ref in the GENERIC INVENTORY file (#445) to locate a "W" or the warehouse inventory. A loop through the INVENTORY ITEM (#1) multiple, using the ITEM NO. (#.01) to check in the ITEM MASTER (#441) file for a FSC (#2) = 6505 (Federal Supply Classification for drugs) isolates the warehouse drugs in ^TMP. Looping through ^TMP a check is made using the INVENTORY POINT ("AD") x-ref in the INVENTORY TRANSACTION (#445.2) file to isolate items that have had distribution (TRANSACTION ID (#1)?"R".N) and fall within the user selected month (DATE POSTED (#2.5)). These transactions are sorted by the OTHER INVENTORY POINT AFFECTED (#14) and the OTHER INVENTORY POINT AFFECTED (#14) , -QUANTITY (#6), QUANTITY (#410,#10,#2) obtained by using the TRANSACTION /P.O. NUMBER (#445.2,#410), PACKAGING UNIT (#5), SELLING UNIT PRICE (#8), total cost (-QUANTITY (#6) * SELLING UNIT PRICE (#8)), DATE POSTED (#2.5), and TRANSACTION/P.O. NUMBER (#410). Similar to the Unposted Procurement History, a high dollar sort is also offered. As stated in the opening paragraph, the Connection Menu lays the groundwork for an interface with the IFCAP Generic Inventory Package. Phase two of this process is contained in a Pharmacy Location Menu. With this menu the Pharmacy user will create and edit the parameters of a Drug Accountability location such as Inpatient, Outpatient, or a Combined (IP/OP) operation. The purpose of the interface is to allow the receiving that occurs in the Inventory Package to pass the converted dispensing unit quantity of a connected drug (ITEM/DRUG file) from a Generic Inventory point (#445) to a Drug Accountability location (#58.8). To establish a direct link between these two files, a PRIMARY INVENTORY POINT field exists in the DRUG ACCOUNTABILITY STATS file (#58.8). This field points to the GENERIC INVENTORY file (#445) uses the TYPE OF INVENTORY POINT (#.7) = "P" and COST CENTER (#.9) = 822400 (Pharmacy) fields as screens. The input transform also contains a call to ^PSAUTL where the "E" x-ref in #58.8 is checked to prevent the linking of one primary inventory point to more than one DA location. The Set up/edit a Pharmacy Location option allows the user to edit this link. If a DA location (#58.8)is linked to an Inventory point (#445), the INVENTORY ITEMS (#1) are checked both against the "AB" x-ref in the DRUG (#50) file and the "C" x-ref in the DA (#58.8) file to see if all Inventory items are tracked in DA. If not the user is given the ability (^DIE) to add Inventory items to the DA location. The Display Location option shows the PRIMARY INVENTORY POINT (#11) currently linked to the selected DA location. The Inventory Interface sub-menu contains three report options and a populate option. The Report of Inventory items' link to DRUG file displays from a selected GENERIC INVENTORY point (#445), selection screened by COST CENTER (#.9) = 822400 and TYPE OF INVENTORY POINT (#.7) = "P", the ITEM NO. (#445,#1,#.01), either the DESCRIPTION (#.7) or from the ITEM MASTER file (#441), the SHORT DESCRIPTION (#.05)and if connected the DRUG (#50) name. The Loadable Inventory Items Report operates exactly the same, however, only lists connected items. The Populate Pharmacy Location with Inventory items option uses the same criteria and if a connected drug within an inventory point does not yet exist in the DRUG (#10) multiple in the selected DA location (#58.8), a ^DIE stuff occurs with a list of drugs loaded displayed at a user selected device. The Display Drugs Not Loaded in Primary option loops through the DRUG (#10) multiple in a selected DA location (#58.8) and using the "AB" x-ref in the DRUG (#50) file, checks the "AE" x-ref in the GENERIC INVENTORY (#445) file for the existance of each drug in the linked Primary Inventory Point. Those drugs not found in the Inventory point are displayed along with their ITEM MASTER (#441) file NUMBER (#.01) and SHORT DESCRIPTION (#.05). CONDENSED DATA DICTIONARY---DRUG FILE (#50) VERSION: 6 STORED IN: ^PSDRUG( 01/26/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: ITEM NUMBER(AB) FILE STRUCTURE FIELD FIELD NUMBER NAME .001 NUMBER (NJ5,0), [ ] .01 GENERIC NAME (RF), [0;1] 6 FSN (F), [0;6] 12 ORDER UNIT (P51.5'), [660;2] 13 PRICE PER ORDER UNIT (NJ7,2), [660;3] 14.5 DISPENSE UNIT (F), [660;8] 15 DISPENSE UNITS PER ORDER UNIT (NJ4,0), [660;5] 16 PRICE PER DISPENSE UNIT (NJ6,2), [660;6] 17 SOURCE OF SUPPLY (F), [660;7] 31 NDC (FX), [2;4] 100 INACTIVE DATE (D), [I;1] 441 IFCAP ITEM NUMBER (Multiple-50.0441), [441;0] .01 ITEM NUMBER (M*P441'X), [0;1] CONDENSED DATA DICTIONARY---ITEM MASTER FILE (#441)UCI: LTL,VAA STORED IN: ^PRC(441, 01/26/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: SHORT DESCRIPTION(AC) INACTIVATED ITEM?(AD) NUMBER(B) NSN(BA) NSN(BB) SHORT DESCRIPTION(C) VENDOR STOCK #(D) NDC(F) NSN(G) FILE STRUCTURE FIELD FIELD NUMBER NAME .01 NUMBER (RNJ6,0X), [0;1] .05 SHORT DESCRIPTION (RFX), [0;2] .1 DESCRIPTION (Multiple-441.02), [1;0] .01 DESCRIPTION (W), [0;1] 1 FCP (Multiple-441.03), [4;0] .01 FCP (RFX), [0;1] 1 PURCHASE ORDER (Multiple-441.04), [1;0] .01 PURCHASE ORDER (P442'X), [0;1] 3 PREFERRED VENDOR (*P440'), [0;3] 2 FSC (RP441.2'), [0;3] 5 NSN (FX), [0;5] 6 VENDOR (Multiple-441.01), [2;0] .01 VENDOR (MP440X), [0;1] 1 UNIT COST (RNJ10,3), [0;2] 1.5 UNIT OF PURCHASE (RP420.5'), [0;7] 1.6 PACKAGING MULTIPLE (RNJ6,0), [0;8] 2 CONTRACT (NJ6,0XO), [0;3] 2.2 CONTRACT EXP. DATE (CJ8), [ ; ] 2.5 DATE OF UNIT PRICE (RD), [0;6] 3 VENDOR STOCK # (FX), [0;4] 4 NDC (FX), [0;5] 8 MINIMUM ORDER (NJ6,0), [0;12] 9 REQUIRED ORDER MULTIPLE (NJ6,0), [0;11] 9 LAST VENDOR ORDERED (P440'), [0;4] 10 MANDATORY SOURCE (*P440'), [0;8] 14 DATE ITEM CREATED (D), [0;9] 15 CREATED BY (P3'), [0;11] 16 INACTIVATED ITEM? (S), [3;1] CONDENSED DATA DICTIONARY---VENDOR FILE (#440) UCI: LTL,VAA STORED IN: ^PRC(440, 01/26/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: SUPPLY WHSE. INDICATOR(AC) NAME(AD) INACTIVATED VENDOR(AE) NAME(B) SYNONYM(C) FILE STRUCTURE FIELD FIELD NUMBER NAME .001 NUMBER (NJ6,0), [ ] .01 NAME (RFX), [0;1] .05 SUPPLY WHSE. INDICATOR (SX), [0;11] 6 CONTRACT NUMBER (Multiple-440.03), [4;0] .01 CONTRACT NUMBER (MFX), [0;1] 1 EXPIRATION DATE (RD), [0;2] CONDENSED DATA DICTIONARY---NEW PERSON FILE (#200) VERSION: 6.5 STORED IN: ^VA(200, 01/27/93 -------------------------------------------------------------------------- FILE STRUCTURE FIELD FIELD NUMBER NAME .01 NAME (RFX), [0;1] .132 OFFICE PHONE (F), [.13;2] CONDENSED DATA DICTIONARY---PROCUREMENT & ACCOUNTING TRANSACTIONS FILE (#442) STORED IN: ^PRC(442, 01/27/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: P.O. DATE(AB) FCP(AC) ISSUE VOUCHER NO.(SUPPLY)(AD) FILE STRUCTURE FIELD FIELD NUMBER NAME .01 PURCHASE ORDER NUMBER (RFX), [0;1] .1 P.O. DATE (RDX), [1;15] .5 SUPPLY STATUS (*P442.3'), [7;1] 1 FCP (RFX), [0;3] 2 COST CENTER (FX), [0;5] 5 VENDOR (R*P440X), [1;1] 40 ITEM (Multiple-442.01), [2;0] .01 LINE ITEM NUMBER (RMNJ2,0X), [0;1] 1 DESCRIPTION (Multiple-442.05), [1;0] .01 DESCRIPTION (W), [0;1] 1.5 REPETITIVE (PR CARD) NO. (*P441'X), [0;5] 2 QUANTITY (RNJ9,2), [0;2] 3 UNIT OF PURCHASE (RP420.5'X), [0;3] 5 ACTUAL UNIT COST (RNJ9,2X), [0;9] 11 QUANTITY PREVIOUSLY RECEIVED (NJ9,2), [2;8] 15 TOTAL COST (RNJ9,2), [2;1] 91 TOTAL AMOUNT (RNJ10,2), [0;15] CONDENSED DATA DICTIONARY---INVENTORY TRANSACTION FILE (#445.2) STORED IN: ^PRCP(445.2, 01/27/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: DATE POSTED(ABEG) ITEM NO.(AC) INVENTORY POINT(AD) ITEM NO.(AE) INVENTORY POINT(ANXT) INVENTORY POINT(B) TRANSACTION/P.O. NUMBER(C) TRANSACTION ID(T) FILE STRUCTURE FIELD FIELD NUMBER NAME .01 INVENTORY POINT (RP445'), [0;1] 1 TRANSACTION ID (RF), [0;2] 2.5 DATE POSTED (D), [0;17] 5 PACKAGING UNIT (F), [0;6] 6 QUANTITY (NJ6,0), [0;7] 8 SELLING UNIT PRICE (NJ11,3), [0;9] 14 OTHER INVENTORY POINT AFFECTED (P445'), [0;18] 410 TRANSACTION/P.O. NUMBER (F), [0;19] CONDENSED DATA DICTIONARY---GENERIC INVENTORY FILE (#445) STORED IN: ^PRCP(445, 01/27/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: DISTRIBUTION POINT(AB) TYPE OF INVENTORY POINT(AC) INVENTORY USER(AD) ITEM NO.(AE) ABBREVIATED NAME(AF) KEEP PERPETUAL INVENTORY?(AG) INVENTORY POINT(B) INVENTORY POINT(C) FILE STRUCTURE FIELD FIELD NUMBER NAME .01 INVENTORY POINT (RFX), [0;1] .7 TYPE OF INVENTORY POINT (R*SX), [0;3] .9 COST CENTER (P420.1'), [0;7] 1 INVENTORY ITEM (Multiple-445.01), [1;0] .01 ITEM NO. (MP441'X), [0;1] CONDENSED DATA DICTIONARY---DRUG ACCOUNTABILITY STATS FILE (#58.8) STORED IN: ^PSD(58.8, 01/27/93 -------------------------------------------------------------------------- CROSS REFERENCED BY: DRUG(C) PRIMARY INVENTORY POINT(E) FILE STRUCTURE FIELD FIELD NUMBER NAME .01 PHARMACY LOCATION (RF), [0;1] 10 DRUG (Multiple-58.8001), [1;0] .01 DRUG (MR*P50'X), [0;1] 11 PRIMARY INVENTORY POINT (*P445'X), [0;6] This DBIA is effective until 18 months following Drug Accountability V2.0. ROUTINE: ******************** 215 NAME: DBIA215 CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: FEB 24,1993 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Export Drug Accountability files 58.8 DRUG ACCOUNTABILITY STATS 58.81 DRUG ACCOUNTABILITY TRANSACTION 58.16 AOU INVENTORY TYPE 58.83 CS COMPLETION STATUS 58.82 CS ORDER STATUS 58.86 CS DESTRUCTION 58.84 DRUG ACCOUNTABILITY TRANSACTION TYPE TEMPORARY FOR V1.0. ROUTINE: ******************** 218 NAME: DBIA218-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY DSS - DECISION SUPPORT SYSTEM EX INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.3 ROOT: DIC(45.3, DESCRIPTION: TYPE: File ^DIC(45.3, .01 CODE 0;1 Direct Global Read & w 1 SPECIALTY 0;2 Direct Global Read & w 2 DEPARTMENT CODE 0;3 Direct Global Read & w ROUTINE: ******************** 219 NAME: DBIA219 CUSTODIAL PACKAGE: INCOMPLETE RECORDS TRACKING SUBSCRIBING PACKAGE: DISCHARGE SUMMARY TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A DBIA with INCOMPLETE RECORD TRACKING is granted for the following: Purpose: To allow the IRT file to be updated automatically with data generated through the Discharge Summary or Test Integration Utilities Package whenever a discharge or other deficiency type summary is dictated, transcribed, signed or reviewed. Distribution of the IRT interface routine: DGJSUM. Responsibilities: It will be the Albany IRMFO's responsibility to maintain the interface routine DGJSUM and make sure that it functions properly to lookup, create and update IRT records. The Salt Lake IRMFO will be responsible to make sure that the entry points to DGJSUM are accessed in an appropriate manner with good data being passed. If any modification to either package is made that will affect the functionality of this interface, then it will be necessary for the IRMFO responsible for the change to communicate with the other IRMFO in order to resolve any issues. ROUTINE: DGJSUM COMPONENT: CHECK VARIABLES: Access to CHECK^DGJSUM(DFN,DGJTDT,DGJPARM,DGJIRTDA,DGJT,DGJFLG,DJGSUM) to check to see if the IRT package is enabled. If it is enabled to find and return a pointer to the matching IRT record for the given Patient and Admission. When a matching IRT record isn't found, a new record will need to be created. This entry point will be passed the DFN, Discharge Date (DGJTDT), pointer to the IRT record (DGJIRTDA) if previously passed to the Discharge Summary file, and an array (DGJT) with Division (DGJT("DIV")), Admission IFN (DGJT("AD#")), Ward (DGJT("WARD")), and Treating Specialty (DGJT("TS")). In addition, the IRT TYPE OF DEFICIENCY may be passed in DGJTYP (parameter is optional.) The default value will be "DISCHARGE SUMMARGY". Parameter passing by reference will return the IRT parameter (DGJPARM) which contains a number greater than zero in the first piece if IRT is enabled and a number greater than zero in the 3rd piece if Review Discharge Summary Required is enabled, the pointer to the IRT record (DGJIRTDA) and a Flag (DGJFLG) equal to 1 if a new record is created. In all cases, this entry point will be accessed to check to see if the IRT package is enabled and if so retrieve the pointer to the IRT record. If the IRT package isn't enabled or a pointer to the IRT record isn't returned then no other entry points will be accessed to update the IRT file. COMPONENT: EDIT VARIABLES: Access to EDIT^DGJSUM(DGJIRTDA,DGJVDD,DGJVDB,DGJVDT,DGJVTB,DGJPARM) to update the following fields in the IRT record: Date Dictated, Dictated By, Date Transcribed, and Transcribed by. This entry point will be passed Date Dictated (DGJVDD) , Dictated By (DGJVDB), Date Transcribed (DGJVDT) and Transcribed By (DGJVTB), as well as the following variables returned from the entry point described in item #1: the pointer to the IRT record (DGJIRTDA) and the IRT parameter (DGJPARM). Nothing needs to be returned. COMPONENT: SIGUP VARIABLES: Access to SIGUP^DGJSUM(DGJIRTDA,DGJDS,DGJSB,DGJDR,DGJRB,DGJPARM) to update the following fields in the IRT record: Date Signed and Signed By, Date Reviewed and Reviewed By. This entry point will be passed Date Signed (DGJDS), Signed By (DGJSB), Date Reviewed (DGJDR) and Reviewed By (DGJRB). If the IRT package parameter is set to review Discharge Summaries (determine by 3rd field of DGJPARM being greater than 1, then Date Reviewed and Reviewed By will be passed with what is in the Discharge Summary record other wise the "@" will be passed. The following variables returned from the entry point described in item #1 will also be passed: the pointer to the IRT record (DGJIRTDA) and the IRT parameter (DGJPARM). Nothing is returned. COMPONENT: DCSDEL VARIABLES: Access to DCSDEL^DGJSUM(DGJIRTDA,DGJPARM) to delete the following fields in the IRT file: Date Dictated, Dictated By, Date Transcribed, Transcribed by, Date Signed, Signed By, Date Reviewed, and Reviewed By. This entry point will be passed the pointer to the IRT record (DGJIRTDA) and the IRT parameter (DGJPARM) returned from the entry point described in item #1. Nothing is returned. This is necessary in case a Discharge Summary is accidently entered for the wrong admission or patient. ******************** 220 NAME: DBIA220 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: MAR 24,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Outpatient Pharmacy has permission to edit fields in Patient File (#2): Outpatient Pharmacy has used two input templates, PSO OUTPT and PSO OUTPTA in the Patient File (#2) since about 1984. PSO OUTPT template edits the following fields: .03,.09,.111:.116, .131, 148, .172, .12105, .1211:.1213, .1219 and .091. PSO OUTPTA template edits the following fields: .12105, .1211:.1213, .1219 and .1214:.1218. The MAS developers have agreed to allow the Outpatient Pharmacy package to edit these fields using the above input templates under the following conditions: 1. Patch per ZIP+4. There will soon be two new zip+4 fields associated with Permanent and Temporary Address fields that should be used instead of the zip code fields listed above. 2. MAS developers will provide a utility to edit the above information and with the next release of Outpatient Pharmacy I will use their utility. Outpatient Pharmacy developers agree to the above stated conditions of use. ROUTINE: ******************** 221 NAME: DBIA221-A CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS CONTROLLED SUBSTANCES SURGERY PHARMACY BENEFITS MANAGEMENT BAR CODE MED ADMIN MENTAL HEALTH LAB SERVICE ORDER ENTRY/RESULTS REPORTING NATIONAL DRUG FILE E CLAIMS MGMT ENGINE CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: MAY 24,1999 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. All fields and x-refs in file 50 have global read access by the subscribing packages. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. ROUTINE: ******************** 223 NAME: DBIA223 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.8 ROOT: PSD(58.8, DESCRIPTION: TYPE: File Outpatient Pharmacy is given permission by Controlled Substances to make the following calls: GLOBAL MAP DATA DICTIONARY #58.8 -- DRUG ACCOUNTABILITY STATS FILE 2/26/93 --------------------------------------------- STORED IN ^PSD(58.8 SITE: ISC BIRMINGHAM -------------------------------------------------------------------------- ^PSD(58.8,D0,0)= (#20) OUTPATIENT SITE [10P] ^ ROUTINE: ******************** 224 NAME: DBIA224 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY PHARMACY DATA MANAGEMENT INTEGRATED BILLING USAGE: Private ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Outpatient Pharmacy is given permission by Kernel to make calls to the following: GLOBAL MAP DATA DICTINARY #200 -- NEW PERSON FILE 2/25/93 STORED IN ^VA(200, SITE: ISC BIRMINGHAM (VERSION 6.5) ---------------------------------------------------------------------- ^VA(200,D0,PS)= (#53.1) AUTHORIZED TO WRITE MED ORDERS [1S] ^ (#53.2) ==>DEA# [2F] ^ (#53.3) VA# [3F] ^ (#53.4) INACTIVE DATE [4D] ^ ==>(#53.5) PROVIDER CLASS [5P] ^ (#53.6) PROVIDER TYPE [6S] ^ ==>(#53.7) REQUIRES COSIGNER [7S] ^ (#53.8) USUAL COSIGNER ==>[8P] ^ (#53.9) REMARKS/COMMENTS [9F] ^ ^VA(200,D0,PS1,0)=^200.541P^^ (#54.1) LICENSING STATE ^VA(200,D0,PS1,D1,0)= (#.01) LICENSING STATE [1P] ^ ^VA(200,D0,PS2,0)=^200.55P^^ (#54.2) STATE ISSUING DEA NUMBER ^VA(200,D0,PS2,D1,0)= (#.01) STATE ISSUING DEA NUMBER [1P] ^ ^VA(200,D0,TPB)= (#53.91) NON-VA PRESCRIBER [1S] ^ (#53.92) EXCLUSIONARY ==>CHECK PERFORMED [2S] ^ (#53.93) DATE EXCLUSIONARY LIST ==>CHECKED [3D] ^ (#53.94) ON EXCLUSIONARY LIST [4S] ^ (#53.95) ==>TAX ID [5F] ^ (#53.96) EXCLUSIONARY CHECKED BY [6P:200] ^ ROUTINE: ******************** 227 NAME: DBIA227-A CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAY 5,1993 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 445 ROOT: PRCP(445, DESCRIPTION: TYPE: File Prosthetics is granted permission to make the following calls to the IFCAP package (GIP and 1358 Modules). As stated below this is until the next version of either IFCAP or Prosthetics. For GIP (Items 1 - 3): Item 1 is needed so that we can check to see if an item that is being returned from loan is in an inventory point, so that it can be placed back into inventory. Item 2 is needed to so that we can do a lookup to make sure that the user returning a loaned item is an Inventory User. Item 3 is needed so that we can make sure that the user returning an item is an Inventory User for that particular Inventory Point. Item 1 Description: Read Only access to File #445, GENERIC INVENTORY, to look at the cross-referenced node ^PRCP(445,"AE",ITEM#,DA). Item 2 Description: Read Only access to File #445, GENERIC INVENTORY, so that we can look at the "AD" cross-reference in the file. Item 3 Description: Read Only access File #445, field 6, INVENTORY USER. Item 5 DIC lookup on File #445 Generic Inventory. Read access only to the .01 field. The variable PRCPPRIV may be set by Prosthetics. ROUTINE: ******************** 228 NAME: DBIA228-A CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: MAY 12,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 353.1 ROOT: IBE(353.1, DESCRIPTION: TYPE: File ^IBE(353.1,D0,0) .01 CODE 0;1 Pointed to ROUTINE: ******************** 229 NAME: DBIA229-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MailMan V7 has permission to make the following calls to FileMan: 1. MailMan has a special way of calling the FileMan editor. It calls EN^DIWE and supplies DWPK, DWLW, DIA, DIC and DIA("P"). The way that MailMan calls DIWE allows a slightly different set of functionalities. The transfer command is defaulted to use the 3.9 (Message) file if no file is specified. DWPK forces automatic wrapping of text at DWLW number of characters. Because of this the variable DC must have the appropriate value and MailMan kills it to may sure it is undefined. DWLW and DWPK have recently been released along with EN^DIWE as a callable entry point, but the use of DIC and DIA together still provide to MailMan special functionality in the FileMan line editor, namely the ability to transfer lines of text in from other messages that the user is the sender or a recipient of. ROUTINE: DIWE COMPONENT: EN VARIABLES: DWPK Type: Input DWLW Type: Input DIA Type: Input DIC Type: Input DIA('P') Type: Input ******************** 230 NAME: DBIA230 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MailMan V7 has permission to make the following calls to Kernel: 1. The modules affected by this agreement are in the namespace: o Device Handler (ZIS* & %ZIS*, not ZISL* & %ZISL*) 2. REQ^%ZTLOAD is called in the following manner to ensure a back-up task exists if this one should fail: I $L(ION) S ZTIO(1)="D",ZTIO=ION D REQ^%ZTLOAD The result of this call leaves the task in the IO queue for the device it is running on (and no other, even if the device is a member of a hunt group). 3. The Kernel Site Parameters file contains fields that are used by modules in Kernel other than MailMan. The MailMan development team will maintain the file and will reserve fields and field numbers in the range of 3000 to 3999 for the use of this module. No alpha subscripts will be used by non-MailMan kernel packages without agreement from the MailMan development team except for those already in use and noted below. The exception to the above are nodes beginning with the Kernel namespace (ZI) which is reserved for this kernel packages and cross references beginning with any letter, but having the above namespace immediately follow that letter (EG. AZI5). Any changes to this file require the notification of the MailMan development team. A method for ensuring that the distribution of the file by MailMan will then be negotiated. The fields that are currently in use and are not *'ed for removal within 18 months are: (#=multiple) Field Number # Description node;piece 31.1 Max spool lines SPL;1 31.2 Max spool documents SPL;2 31.3 Max spool doc life SPL;3 4. By agreement files 3.51, Spool Document [in ^XMB(3.51,] and file 3.519, Spool Data [in ^XMBS(3.519,] can continue to exist in the MailMan namespaced globals. ROUTINE: ******************** 231 NAME: DBIA231 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MailMan V7 has permission to make the following calls from Kernel Task Manager V7: 1. The Kernel modules that this document refers to are: o Task Management (ZTM* and %ZTM*) 2. REQ^%ZTLOAD is called in the following manner to ensure a back-up task exists if this one should fail: I $L(ION) S ZTIO(1)="D",ZTIO=ION D REQ^%ZTLOAD The result of this call leaves the task in the IO queue for the device it is running on (and no other, even if the device is a member of a hunt group). 3. The routine XMS5 tries to confirm that tasks exist by looking at: $D(^%ZTSK(task,0)) ==> if the node exists the task exists $D(^%ZTSCH("TASK",task)) ==> If the node exists, the task is running "12345AG"[%ZTSCH("TASK",.1) $D(^%ZTSCH("IO",device,$h,task)) ==> The task is scheduled 4. MailMan 7 looks at ^%ZTSK(task,"C",0) for a count of the times the task has run. The next version will not use this any more. ROUTINE: ******************** 232 NAME: DBIA232 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The Inpatient Medications package requests a DBA exemption to allow the .01 field of the INPATIENT USER PARAMETERS file (53.45) to point to the NEW PERSON file (200). This file contains fields that are used by Inpatient Medications to store data used in the order entry process, and has been DINUMED to the NEW PERSON file as recommended in the peer review, to allow these fields to be more easily moved to 200 if necessary in a future release. ROUTINE: ******************** 233 NAME: DBIA233 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MAILMAN has permission to make the following calls to VA Fileman: 1. FileMan has a special way of using the XMD interface and it also has special calls into the XMP series of routines so that it can load INITs directly into a message during a DIFROM. As such the variable DIFROM effects that way some of these routines work so that the DIFROM procedure can use them to enter data and routines reiteratively into messages. o In the routine XMD, if $D(DIFROM) security keys are not ignored. o In the routine XMD, if $D(DIFROM) will cause a call to XMD at either tag EN1 or tag EN2 to quit after text is added to a message, but before the message is delivered. o In the routine XMD, if $D(DIFROM) before delivery, security will be added automatically by a call to XMASEC. o In the routine XMASEC, if $D(DIFROM) security is forced onto the message. o In the routine XMP, if $D(DIFROM) the string " (DIFROM)" is added to the 1st line of the PackMan message to show how it was created. o In the routine XMPH a special prompt is provided where DIFROM loading into a message causes special help for the programmer. 2. Kernel modules to which this document refers are (even if they are at some point separated from the Kernel and become independent modules of their own): FileMan (DI*) ROUTINE: ******************** 234 NAME: DBIA234 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Mailman is given permission to make the following calls to Kernel: 1. CHK^XM is an entry point set aside only for calls external from MailMan. It is used by KERNEL routines to notify users of new messages for a user during logon or as invoked from MenuMan. XMDUZ is used if supplied, otherwise DUZ is a pointer to the user's Mailbox. The symbol table of the caller is changed as the code currently stands. Y is output as a count of new messages. % and D are also used and not killed by MailMan. The Kernel security routine will continue to use this entry point, which also is necessary to make sure that ^TMP("XMY",$J) is cleaned out on login and ensures that when job numbers are reused after reboot, there is not data in ^TMP("XMY",$J) to include recipients from old mail sessions in currently generated bulletins that come from outside of MailMan. An example is the 'Dropping into Programmer Mode bulletin'. 2. ^XM may be called in order to offer MailMan as a service directly to users on logon. 3. The XMUSER and XMMGR menus may be used in high level menu structures. 4. Kernel modules to which this document refers are (even if they are at some point separated from the Kernel and become independent modules of their own) are System security (XU* and XT*). 5. Kernel security and user related modules currently can call NEW^XM to set up an new user's or reactivated user's mail box. The entry point uses the variables I, Y and K destructively. If it is called for a user who is being reactivated, that user will not receive responses to messages he is a recipient of and were created before his reinstatement, unless he is explicitly forwarded them, or he 'owns' the original message in one of his mail boxes. 6. XMPC is called by the Kernel routine comparer. All the proper set-up has been done and MailMan will coordinate any changes in this area with the programmer responsible for Kernel Utilities. 7. Kernel directly references the 5th piece of the Mail Basket multiple of the Mail Box file (3.7) to get the number of messages in a mail basket. 8. Kernel directly references the 6th piece of the zero node of the Mail Box file (3.7) to get the number of new messages in a mail box 9. There are some data fields in the Mail Box file (3.7) that are not used in MailMan. They are used by sign-on security and should be maintained by sign-on security routines also. field # Description node;piece 20 Last Sign-on Date/Time .1;1 21 Last Terminal Type Used .2;1 22 Already Signed On To Devices 100 (multiple) 10. The Kernel Site Parameters file contains fields that are used by modules in Kernel other than MailMan. The MailMan development team will maintain the file and will reserve fields and field numbers in the range of 1000 to 1999 for the use of this kernel module. No alpha subscripts will be used by non-MailMan kernel packages without agreement from the MailMan development team except for those already in use and noted below. The exception to the above are nodes beginning with the namespaces (XU amd XT) which are reserved for non-MailMan kernel packages and cross references beginning with any letter, but having the above namespaces immediately follow that letter (EG. AXT5). Any changes to this file require the notification of the MailMan development team. A method for ensuring that the distribution of the file by MailMan will then be negotiated. Field Number # Description node;piece 11 Auto-generate access codes 3;1 12 User char Template 3;2 202 Default number of attempts XUS;2 203 Default lock-out time XUS;3 204 Default Multiple sign-ons XUS;4 205 Ask device at sign-on XUS;5 209 Default type-ahead XUS;9 211 Bypass Device lock-out XUS;10 212.1 Device to audit 4.33 (subfile) 240 INTRO text INTRO ROUTINE: ******************** 237 NAME: DBIA237-A CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing is given permission from Outpatient Pharmacy to call HD^PSOSD2 and PAT^PSOSD for the purpose of printing the Action Profile and the Information Profile in batch. CONDITIONS: The entry points may only be used in an approved fashion. The following subroutine uses the entry points in an acceptable manner: RXPROF ;For printing the Outpatient Pharmacy Action Profile or the ;Information Profile for a single patient whose DFN is defined. ;Does not ask for the device nor close the device. ;INPUTS: ;PSDAYS = number of days to print the medication profile for ;PSTYPE=1 for the Action Profile, =0 for the Information Profile ;DFN ; N IBDFN,ADDR,ADDRFL,CLASS,CNDT,DRUG,HDFL,I,II,J,L,LINE,P,PAGE, PSDOB,PSII X,PSNAME,PSOI,PSSN,PSIX,PGM,PRF,PSDATE,VAL,VAR,RX, RX0,RX2,ST,ST0,PSDAY,RF,RFS,PSOPRINT,X1,X2,ZTSK,X,Y,PSII,PSDT,LMI S IBDFN=DFN S X1=DT,X2=-PSDAYS D C^%DTC S (PSDATE,PSDAY)=X S LINE="" F I=1:1:132 S LINE=LINE_"-" S PAGE=1 D HD^PSOSD2,PAT^PSOSD W @IOF S DFN=IBDFN Q ROUTINE: PSOSD2 COMPONENT: HD VARIABLES: ******************** 238 NAME: DBIA238-A CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File Radiology has agreed for AMIE to make the following calls: GLOBAL REF. NODE;PIECE USAGE ^RADPT 0 Zero node check ^RADPT(D0,0) ROUTINE: ******************** 239 NAME: DBIA239-A CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.3 ROOT: XMB(1, DESCRIPTION: TYPE: File ^XMB(1,D0,0) .01 DOMAIN NAME 0;1 Read w/Fileman ROUTINE: ******************** 240 NAME: DBIA240-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Laboratory Package has given permission to AMIE to make the following calls: GLOBAL REF. NODE;PIECE USAGE ^LR( "CH";11 Current Agreement number 95 "MI";11 Current Agreement number 95 ^LR(D0,'CH', ^LR(D0,'MI', ROUTINE: ******************** 241 NAME: DBIA241-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File ^DIC(4,D0,0) .01 NAME 0;1 Read w/Fileman ^DIC(4,D0,99) 99 STATION NUMBER 0;1 Read w/Fileman ROUTINE: ******************** 242 NAME: DBIA242-A CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PIMS (MAS) users often have a need to print a Health Summary after printing the 10-10. PIMS, therefore, is given permission for a database integration agreement with Health Summary to allow PIMS to call the line tag ENXQ^GMTSDVR. This call allows tasked or non-tasked Health Summary printout. Prior to the call, the following two variables will be defined: ROUTINE: GMTSDVR COMPONENT: ENXQ VARIABLES: DFN Type: Input (the internal entry number for the Patient File) GMTSTYP Type: Input (the internal entry number for the desired Health Summary type) ******************** 244 NAME: AMIE Access to Patient File Fields CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ALL FIELDS ACCESSIBLE TO AMIE THROUGH THIS AGREEMENT ARE BASED ON FILEMAN CALLS ONLY. AMIE has permission from PIMS to make the following calls: GLOBAL REF. NODE;PIECE USAGE ^DPT( .11;1 Street address line 1 .11;2 Street address line 2 .11;3 Street address line 3 .11;4 City .11;5 State .11;6 Zip Code .11;7 County .11;8 Province .11;9 Postal Code .11;10 Country .11;12 Zip+4 .13;1 Residence PhoneNumber .13;2 Work Phone Number .29;1 Date Ruled Incompetent (VA) .29;2 Date Ruled Incompetent(CIVIL) .29;12 Rated Incompetent .3;1 Service Connected .31;2 Claim Folder Location .31;3 Claim Number .32;4 Service Discharge Type [LAST] .32;5 Service Branch [LAST] .32;6 Service Entry Date [LAST] .32;7 Service Separation Date [LAST] .36;1 Primary Eligibility Code .36;2 Eligibility Status Date .361;1 Eligibility Status .362;12 Receiving A&A Benefits .372;1 Rated Disabilities VA .372;2 Disability Percentage .372;3 Service Connected "DIS"; Disposition Log-in Date "S";1 Appointment Clinic "S";16 Appointment Type Directly edits the following fields in the Patient file: .02 SEX .03 DOB .09 SSN .111 Street Address 1 .1112 ZIP+4 .112 Street Address 2 .113 Street Address 3 .114 City .115 State .116 Zip Code .117 County .1171 Province .1172 Postal Code .1173 Country .131 Phone Number Res. .132 Phone Number Work .301 Service Connected .302 Ser. Con. Percentage .313 Claim Number .312 Claim Folder Location .323 Period of Service .324 Service Discharge Type [LAST] .325 Service Branch [LAST] .326 Service Entry Date [LAST] .327 Service Separation Date [LAST] .3611 Eligibility Status .361 Primary Eligibility Code .525 POW Status Indicated .3612 Elig. Status Dat 1901 Veterab Yes/No -Editing of the permanent address information .111;.1112;.112;.113;.114;.115;.116; .1112;.117;.1171;.1172; .1173;.131; .132; - Fields .1171, .1172, .1173 (Province, Postal Code, Country) will be set using FM input template(s) -AMIE also has LAYGO access to the Patient file per agreement with the MAS SIUG. Following release of patch DG*5.3*797, AMIE/CAPRI will use FileMan to edit the following fields of File 2, Subfile .3216, Military Service Episode multiple: .01 Service Entry Date .02 Service Separation Date .03 Service Branch .06 Service Discharge Type ROUTINE: ******************** 245 NAME: DBIA245 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: JUN 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Engineering version 7.0 has permission to export the following: FILE 446.4 BARCODE PROGRAM with two entries (ENNX and ENPM) FILE 446.6 SPECIALTY COMMANDS with one entry (TRAKKER 9440) These files and entries are necessary for uploading equipment data from portable bar code readers into the Engineering database. ROUTINE: ******************** 246 NAME: DBIA246 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: JUN 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Version 4.0 of IFCAP will call an Engineering routine whenever an Engineering work order is entered into the SORT GROUP of a Control Point Activity Transaction (Field 49 of File 410). The effect of this call will be to enter a pointer to the Control Point Activity Transaction in the Work Order File and to update the work order status. MUMPS cross-reference AR on Field 49 of File 410 will call ACCX^ENLIB2. Before calling this foreign routine, the IFCAP cross-reference will make sure that ^ENG("VERSION") is greater than 6.4. This insures the existence of the foreign routine. ROUTINE: ******************** 248 NAME: DBIA248 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM E CLAIMS MGMT ENGINE USAGE: Controlled Subscri ENTERED: DEC 1,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2, DESCRIPTION: TYPE: File ROES acesses the following entities in Kernel: 1) DOMAIN - DIC 4.2 ^DIC(4.2,i,0) Field .01 Name (Cross-reference) ^DIC(4.2,"B",NAME,i) Name 2) KERNEL SITE PARAMETERS - DIC 4.3 ^XMB(1,1,0) Field .01 Domain Name 3) SECURITY KEY - DIC 19.1 (Cross-reference) ^XUSEC(KEY,DUZ) Field 2 Holder ROUTINE: ******************** 249 NAME: DBIA249 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: FEB 1,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Kernel is adding the field "COORDINATOR' to the Service/Section File. It will be field 16000 located at node 16000. The field will be exported with Kernel V7 in a post-init, and the entire file for a 'virgin' install. ROUTINE: ******************** 250 NAME: DBIA250 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: OCCURRENCE SCREEN USAGE: Private ENTERED: JUL 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File Occurrence Screen has permission from Surgery to make the following calls: Cross References on file 130: AC - DATE OF OPERATION ADT - DATE OF OPERATION Fields: subscript;piece 130,.01 PATIENT 130,.011 IN/OUT-PATIENT STATUS (0;12) 130,.03 MAJOR/MINOR (0;3) 130,.09 DATE OF OPERATION (0;9) 130,10 SCHEDULED START TIME (31;4) ROUTINE: ******************** 251 NAME: DBIA251-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: JUL 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.5 ROOT: DIC(3.5, DESCRIPTION: TYPE: File Clinical Monitoring System and Kernel have entered into an agreement for access to the following data: The "B" cross-reference of the device file. (To check that a free- text pointer value is still valid.) ROUTINE: ******************** 252 NAME: DBIA252-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: JUL 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 69 ROOT: LRO(69, DESCRIPTION: TYPE: File Cross References on file 69 - LAB ORDER ENTRY AN - DATE/TIME RESULTS AVAILABLE ROUTINE: ******************** 253 NAME: DBIA253-A CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS AUTOMATED MED INFO EXCHANGE OUTPATIENT PHARMACY Added 1/22/21 TEXT INTEGRATION UTILITIES Added 1/22/21 USAGE: Controlled Subscri ENTERED: JUL 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File Integrated Billing has permission from Health Summary to make the following calls: 1) Permission to do lookups on the HEALTH SUMMARY TYPE file (# 142) and to store the IEN in an Integrated Billing file. 2) If ENX^GMTSDVR does not exist (version 2.5 or latter not installed), permission to print Health Summaries by: a) Accessing the file HEALTH SUMMARY TYPE (# 142), fields NAME (# .01) and TITLE (# .02), to obtain the title to be used. ROUTINE: ******************** 254 NAME: DBIA254 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: JUL 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52 ROOT: PSRX( DESCRIPTION: TYPE: File Drug Accountability has permission from Outpatient Pharmacy for the following: To collect dispensing data, the Drug Accountability ^PSAOP* routines loop through the "AL" (original & refills), "AJ" (return to stock), "AM" & "AN" (partials), and "AR" (status) x-refs in the PRESCRIPTION (#52) file. A date/time is stored as a starting point for each drug. Using these x-refs, the 6th piece of ^PSRX(D0,0) is checked to see if the drug is stocked in a Drug Accountability location and the 9th piece of ^PSRX(D0,2) is checked for Outpatient site. Quantity for original prescriptions, the 7th piece of ^PSRX(D0,0) is used. For refills, the 4th piece of ^PSRX(D0,1,D1,0) is used. For partials, the 4th piece of ^PSRX(D0,P,D1,0) is used. GLOBAL MAP DATA DICTIONARY #52 -- PRESCRIPTION FILE STORED IN ^PSRX( (VERSION 6.0) -------------------------------------------------------------- CROSS REFERENCED BY: RETURNED TO STOCK(AJ),RETURNED TO STOCK(AJ1) RELEASED DATE/TIME(AL), RELEASED DATE/TIME(AL1), RELEASED DATE/TIME(AM), RETURNED TO STOCK(AN), ^PSRX(D0,0)= (#.01) RX # [1F] ^ (#6) DRUG [6P] ^ (#7) QTY [7N] ^PSRX(D0,1,0)=^52.1DA^^ (#52) REFILL ^PSRX(D0,1,D1,0)=^ (#1) QTY [4N] ^ (#14) RETURNED TO STOCK[16D] ==>^ (#17) RELEASED DATE/TIME [18D] ^PSRX(D0,2)=^(#20) DIVISION [9P] ^(#31) RELEASED DATE/TIME[13D] ==>^ (#32.1) RETURNED TO STOCK[15D] ^ ^PSRX(D0,P,0)=^52.2DA^^ (#60) PARTIAL DATE ^PSRX(D0,P,D1,0)=^(#.04) QTY [4N] ^(#5)RETURNED TO STOCK [16D] ==>^ (#8) RELEASED DATE/TIME [19D] ^ ROUTINE: ******************** 255 NAME: DBIA255 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: JUL 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD(301.5, DESCRIPTION: TYPE: File IVM is granted permission from FM Integration to make the following calls: Permission to add cross-references to the PATIENT file. The cross- references have set and kill logic as follows: S IVMX=X,X="IVMPXFR" X ^%ZOSF("TEST") D:$T DPT^IVMPXFR S X=IVMX K IVMX The code in IVMPXFR looks as follows: DPT ; Update transmit status if patient file fields are updated ; N DFN S DFN=+DA I '$D(^DPT(DFN,0)) Q D IVM Q ; IVM ; check to see if patient needs to be retransmitted N DA,I,NODE,X Q:'$D(^IVM(301.5,"B",DFN)) F DA=0:0 S DA=$O(^IVM(301.5,"B",DFN,DA)) Q:'DA D .S X=$G(^IVM(301.5,DA,0)) .S $P(^IVM(301.5,DA,0),"^",3)=0 .F I=0:0 S I=$O(^DD(301.5,.03,1,I)) Q:'I I $G(^(I,0))'["TRIGGER" D ..S X=1 X ^DD(301.5,.03,1,I,2) ; kill xfr ..S X=0 X ^DD(301.5,.03,1,I,1) ; set xfr Q Permission is also given to execute the DD nodes. At this point, there is a single MUMPS cross-reference on the .03 field (TRANSMISSION STATUS) of the IVM PATIENT file (301.5). Its logic is: set I X=0 S ^IVM(301.5,"ATR",0,DA)="" kill I X=0 K ^IVM(301.5,"ATR",0,DA) The purpose is just to flag the record as needing to be transmitted and have the cross-reference only set for those that require transmission. ROUTINE: ******************** 256 NAME: DBIA256 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JUL 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Health Summary has permission to add the "GMTS" application group to file 71, Radiology Procedures, in order to allow selection of specific procedures to be displayed by the Selected Radiology Component of Health Summary. Only verified results may be printed, although results with the report status Released/Unverified may be viewed through Health Summary. Unverified reports may not be viewed or printed through Health Summary, in compliance with the Radiology Package's specifications. ROUTINE: ******************** 257 NAME: DBIA257 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: JUL 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM is given permission from IB to use the following code (routine IVMUFNC): N DGCRINDT,DGCRINS,IBINDT,IBINS,X S X="IBCNS" X ^%ZOSF("TEST") I $T S:$G(IVMDT) IBINDT=IVMDT D ^IBCNS G IN SQ ; for IB 2.0 and higher S X="DGCRNS" X ^%ZOSF("TEST") I $T S:$G(IVMDT) DGCRINDT=IVMDT D ^DGCRNS ; remove when IB 2.0 is required INSQ Q $S($D(IBINS):IBINS,$D(DGCRINS):DGCRINS,1:"") IVM needs this code to determine whether the patient has insurance. If he does not, he is automatically sent to IVM for verification. ROUTINE: IBCNS ******************** 258 NAME: DBIA258 CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 28,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Scheduling package of PIMS v5.3 is granted permission by the Record Tracking package for the following: 1. Permission to access following options: o RT MAS-CHART-PROFILE -- Profile of Charts o RT MAS-CHART-REQUEST -- Chart Request o RT MAS-FILL-NEXT -- Fill Next Clinic Request o RT MAS-RE-CHARGE -- Re-charge a Chart 2. The above options will be available under 'Appointment Management' option only if the MAS INTERFACE STATUS field of the OVERALL PARAMETERS entry in the RECORD TRACKING SYSTEM PARAMETERS file is set to 'UP'. The following check will be made: IF +$G(^DIC(195.4,1,"UP")... ROUTINE: ******************** 259 NAME: DBIA259 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY CONTROLLED SUBSTANCES USAGE: Controlled Subscri ENTERED: AUG 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Drug Accountability, V2.0, has established agreement with IFCAP to make the following calls: IFCAP inventory provides a Primary Inventory Point with the SPECIAL INVENTORY POINT TYPE = "D" for Drug Accountability, the ability to update a Drug Accountability Location with all receiving activity. IFCAP has added two new fields to the INVENTORY ITEM multiple in the GENERIC INVENTORY file (#445), the DISPENSING UNIT and DISPENSING UNIT CONV FACTOR. Each item that a Primary Inventory Point receives, the IFCAP routines PRCPPOL1, PRCPWPL4, PRCPWPP3, and PRCPUUIW call EN^PSAGIP to update drug accountability. It is here that Drug Accountability is called (EN^PSAGIP) passing the Primary Inventory Point, the item, the quantity*dispensing unit conv factor, the PO#, the CP transaction #, the inventory transaction #, and the total price and in some cases the NDC. Drug Accountability adds each item received to a temporary global. After the receipt is processed, the IFCAP routines PRCPAWI1, PRCPPOL1, PRCPWPL5, and PRCPWPP3 call EX^PSAGIP to complete the drug accountability update. At this time a task is started, looping through the temporary global and either updating the Drug Accountability Location or building and sending a mailman message listing those items that could not be updated and why. In version 2.0 of Drug Accountability the cost center screen on the Primary Inventory pointer in the DRUG ACCOUNTABILITY STATS file (#58.8) has been replaced with the "D" for special inventory type. Also the IFCAP security variable, PRCPPRIV is used to enable this pointer. ^DD(58.8445,.01,0) = PRIMARY INVENTORY POINT(S)^M*P445'X ^PRCP(445,^0;1^S PRCPPRIV=1,DIC("S")="I $P(^(0),U,20)=""D""" D ^DIC K DIC S DIC=DIE,X=+Y K PRCPPRIV K:Y<0 X S:$D(X) DINUM=X Wherever available, calls to IFCAP extrinsics have replaced Drug Accountability version 1.0 look-ups to ^PRC globals. The IFCAP inventory routine PRCPUX1 is called extensively throughout the Drug Accountability package at the following line tags: UNITVAL(V1,V2,V3) ; unit per issue for values passed as follows ; v1=packaging multiple, v2=units da, ; v3=delimiter; UNITCODE(V1) ; get 2 character unit code from file 420.5 ; for entry v1; NSN(V1) ; return nsn for item v1; DESCR(V1,V2) ; description from inventory point or item ; master file for item v2 and inventory point ; v1; INVNAME(V1) ; inventory point name for inventory point v1; VENNAME(V1) ; return vendor name for da;global (445 or ; 440). ROUTINE: PRCPUX1 COMPONENT: UNITVAL(V1,V2,V3) VARIABLES: COMPONENT: UNITCODE(V1) VARIABLES: COMPONENT: NSN(V1) VARIABLES: COMPONENT: DESCR(V1,V2) VARIABLES: COMPONENT: INVNAME(V1) VARIABLES: COMPONENT: VENNAME(V1) VARIABLES: ******************** 260 NAME: DBIA260 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: AUG 9,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File REQUEST: "ARCDTH" CROSS-REFERENCE ON DATE OF DEATH FIELD IN PATIENT FILE FILE NUMBER: 2 FILE NAME: PATIENT FIELD NUMBER: .351 FIELD NAME: DATE OF DEATH CROSS REF NUM: 7 CROSS REF NAME: "ARCDTH" TYPE: MUMPS NOT USED FOR SORTING OR LOOKUP SET STATEMENT: S RCX=X,X="RCAMDTH" X ^%ZOSF("TEST") S X=RCX K RCX I D SET^RCAMDTH KILL STATEMENT: S RCX=X,X="RCAMDTH" X ^%ZOSF("TEST") S X=RCX K RCX I D ERR^RCAMDTH NO-DELETION MESSAGE: ACCOUNTS RECEIVABLE DEATH NOTIFICATION DESCRIPTION: This cross-reference is used to notify the Accounts Receivable package (v4 or higher) of a patient's death so that the patient's account may be reviewed for appropriate action. ^DPT('ARCDTH', ROUTINE: ******************** 262 NAME: DBIA262 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: AUG 9,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other DataBase Integration Agreement between IFCAP V4.0 package and FileMan V19.0 for the use of and the KILLing of a local FileMan variable in an Input Template. The IFCAP Input Template uses the FileMan local variable D1 in the input transform for field #40 in File #423, the CALM/LOG CODE SHEET file. The local variable D1 is used as a counter for the multiple field 423.05, subfield .01. IFCAP uses the counter within the Input Template to ensure that no more than 10 entries are made into the code sheet for this multiple. Prior to prompting the user for entries into this field, the FileMan variable D1 is KILLed. The reason or reasons for KILLing the FileMan local variable D1 and subsequently using D1 as a counter have been obscured in the history of IFCAP development. The variable D1 is the internal record number within the multiple; it is stored as piece 3 of the file or subfile header. It is not necessarily accurate as the count of entries within the multiple. For example, the user may make one or more deletions within the template, reducing the number of entries. The user could then add more entries to the multiple. This scenario could possibly increase the internal record number (D1) to a number greater than 9, when there may actually be fewer than 9 entries. Based on the input transform, the user would not be able to make the additional entries, although in reality, more entries should be allowed. In addition, piece 4 of the file or subfile header contains the number of records in the file and/or subfile. Once again, this number cannot be guaranteed as the accurate number of records in the file or subfile. The use of D1 is an existing convention that has been in place for several versions of IFCAP. We request the Integration Agreement with FileMan to continue this use for IFCAP V4.0. The Input Templates are used in the creation of CALM code sheets. Since FMS will be replacing CALM, the use of the FileMan local variable will be needed until all sites have converted from CALM to FMS. The next planned release of IFCAP V5.0 will replace this function. INTEGRATION POINT: 1. The IFCAP Input Template PRCFA TT982.00 FIRST EDIT FIELD: .1///CLM// THEN EDIT FIELD: S Y=4// THEN EDIT FIELD: STATION NUMBER// THEN EDIT FIELD: TRANSACTION TYPE// THEN EDIT FIELD: TRANSACTION DATE// THEN EDIT FIELD: REFERENCE NUMBER// THEN EDIT FIELD: YALD CODE// THEN EDIT FIELD: K D1// THEN EDIT FIELD: REC STA OR FCP// THEN EDIT FIELD: REC STA OR FCP// THEN EDIT FIELD: 1ST QTR AMOUNT// THEN EDIT FIELD: 2ND QTR AMOUNT// THEN EDIT FIELD: W !," "// THEN EDIT FIELD: 3RD QTR AMOUNT// THEN EDIT FIELD: I X="$" S Y=""// THEN EDIT FIELD: 4TH QTR AMOUNT// THEN EDIT FIELD: 998///$// 2. The Input Transform Using the FileMan Variable STANDARD DATA DICTIONARY #423.05 -- REC STA OR FCP SUB-FILE 05/20/93 PAGE 1 STORED IN ^PRCF(423, (811 ENTRIES) SITE: IFA UCI: DVA,IFA DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE ---------------------------------------------------------------- 423.05,.01 REC STA OR FCP 0;1 FREE TEXT (Multiply asked) INPUT TRANSFORM: K:$L(X)>3!($L(X)<3)!'(X?3N) X Q:'$D(X) I $D(D1),D1>9 W " ONLY 10 ENTRIES PER CODE SHEET ARE PERMITTED",*7 K X LAST EDITED: MAR 21, 1986 HELP-PROMPT: ANSWER MUST BE 3 CHARACTERS IN LENGTH DESCRIPTION: This is the 3 character receiving station or fund control point. NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER 3. FileMan Local Variable D1 When working below the main level of the file, DIE maintains the references to the file hierarchy being handled in the variables DA and Dn (D0, D1, etc) in which n varies according to the level of the file hierarchy. DA always contains the item number of the record being handled. Dn indicates the item numbers in the file hierarchy. D0 contains the main level record number; D1 contains the first sub-file level sub-record number and D2 contains the second sub-file level sub-record number. ROUTINE: ******************** 263 NAME: DBIA263-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLPID COMPONENT: $$EN(DFN,VAFSTR,VAFNUM,PTID) VARIABLES: DFN Type: Input Pointer to entry in PATIENT file (#2) VAFSTR Type: Input String of requested fields separated by commas (ex: 1,2,3) VAFNUM Type: Input Sequential number for SET ID (sequence 1). Default value is '1'. PTID Type: Input Flag denoting which Patient ID (sequence 3) to use 0 - Use DFN formatted as data type CK (default) 1 - Use ICN 2 - Use DFN formatted as data type CX 3 - Use SSN (with dashes) VAFPID(1) Type: Output If the returned string is longer than 245 characters, the remaining characters will be returned in VAFPID(1). VAFPID(1) will not be set if the returned string is less than 245 characters. Assumed Va Type: Input Call assumes that all HL7 variables returned from INIT^HLTRANS are defined Function call returns the standard HL7 PID segment for a given patient ** Warning ** This function makes external calls to VADPT. Non-namespaced variables may be altered. ******************** 264 NAME: DBIA264 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other VA FileMan has permission to export the Package file and to update entries in the Package file for exporting and importing packages. ROUTINE: ******************** 266 NAME: LIST TEMPLATE FILE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.61 ROOT: SD( DESCRIPTION: TYPE: Other The List Template file 409.61 may be populated with entries that are namespaced (following the same principles as with the Option file). Refer to List Manager documentation for current export utilities. Entries should not be made to this file other than through VA FileMan and the export utilities. ^SD(409.61, ROUTINE: ******************** 267 NAME: DBIA267 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The PDX team is granted permission to add the following protocols to the protocol file ^ORD(101. We also request permission to use all generic protocols as listed in the List Managers development guide. The protocol names are: 1 VAQ ADD PATIENT Add Patient 2 VAQ ADD/EDIT REQUEST Add/Edit Request 3 VAQ CHANGE PATIENT Change Patient 4 VAQ COPY REQUEST Copy Request 5 VAQ CREATE REATE REQUEST Create Request 6 VAQ DIS ALL SEGMENT Display all 7 VAQ DIS SELECTED SEG Display Selected 8 VAQ DIS1 (MENU) List Request Options 9 VAQ DISPLAY PDX Display PDX 10 VAQ DISPLAY SELECT Select Entry 11 VAQ DUPLICATE Select Entry 12 VAQ LOAD DATA Load Data (all) 13 VAQ LOAD EDIT Load/Edit 14 VAQ LOAD FIELD Load Field(s) 15 VAQ NEW PATIENT New Patient 16 VAQ PDX1 (MENU) CUSTOM ENTRIES FOR PDX1 17 VAQ PDX11 (MENU) MENU FOR DISPLAY SEGMENT 18 VAQ PDX12 (MENU) MENU OPTIONS FOR PDX DISPLAY 19 VAQ PDX2 (MENU) CUSTOM ENTRIES FOR PDX2 20 VAQ PDX3 (MENU) custom entries for PDX3 21 VAQ PDX4 (MENU) VAQ PDX4 MANUAANUAL PROCESS 22 VAQ PDX5 (MENU) VAQ LED STATUS MENU 23 VAQ PDX6 (MENU) VAQ LED DIFFERENCES MENU 24 VAQ PDX7 (MENU) VAQ LED ADD PT MENU 25 VAQ PDX8 (MENU) VAQ LED POSSIABLE MATCH MENU 26 VAQ PDX9 (MENU) OPTIONS MENU FOR PDX REQUEST 27 VAQ PROCESS MANUAL Procecess Manual 28 VAQ PROCESS REJECT Reject W/Comment 29 VAQ PROCESS RELEASE Release W/Comment 30 VAQ TRANSMIT REQUEST Transmit Request ROUTINE: ******************** 268 NAME: DBIA268-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The PDX team has permission to access the MAS Duplicate Checker, DPTDUP. This routine will be used as a filter in adding new or selecting existing patients. The following fields are accessed by PDX for extract, display, edit and load. [ MINIMAL ] Following is a list of fields used when creating a new patient. Note: Temporary address is only filled in if active and dates valid. FILE NO. FIELD NO NONODE;PIECE DESCRIPT 2 .01 0;1 NAME .02 0;2 SEX .03 0;3 DATE OF BIRTH .05 0;5 MARITAL STATUS .08 0;8 RELIGIOUS PREFERENCE .09 0;9 SOCIAL SECURITY NUMBER .111 .11;1 STREET ADDRESS [LINE 1] .112 .11;2 STREET ADDRESS [LINE 2] .113 .11;3 STREET ADDRESS [LINE 3] .114 .11;4 CITY .115 .11;5 STATE .116 .11;6 ZIP CODE .117 .11;7 COUNTY .131 .13;1 PHONE NUMBER [RESIDENCE] .301 .3;1 SERVICE CONNECTED? .302 .3;2 SERVICE CONNECTED PERCENTAGE .323 .32;3 PERIOD OF SERVICE .361 .36;1 PRIMARY ELIGIBILITY CODE 391 TYPE;1 TYPE 1901 VET;1 VETERAN (Y/N)? .12105 .121;9 TEMPORARY ADDRESS ENTER/EDIT? .1211 .121;1 TEMPORARY STREET [LINE 1] .12111 .121;11 TEMPORARY ADDRESS COUNTY .12112 .121;12 TEMPORARY ZIP+4 .1212 .121;2 TEMPORARY STREET [LINE 2] .1213 .121;3 TEMPORARY STREET [LINE 3] .1214 .121;4 TEMPORARY CITY .1215 .121;5 TEMPORARY STATE .1216 .121;6 TEMPORARY ZIP CODE .1217 .121;7 TEMPORARY ADDRESS START DATE .1218 .121;8 TEMPORARY ADRESS END DATE .1219 .121;10 TEMPORARY PHONE NUMBER [ MAS ] Following is the list of the MAS fields PDX extracts. These fields are compared agianst the local database and the differences are displayed. The user is given the choice to update the local data with the PDX data. (Read/Write Access) FILE NO. FIELD NO NODE;PIECE DESCRIPT 2 .01 0;1 NAME .02 0;2 SEX .03 0;3 DATE OF BIRTH .05 0;5 MARITAL STATUS .07 0;7 OCCUPATION .08 0;8 RELIGIOUS PREFERENCE .09 0;9 SOCIAL SECURITY NUMBER .091 0;10 REMARKS .092 0;11 PLACE OF BIRTH [CITY] .093 0;12 PLACE OF BIRTH [STATE] .111 .11;1 STREET ADDRESS [LINE 1] .112 .11;2 STREET ADDRESS [LINE 2] .113 .11;3 STREET ADDRESS [LINE 3] .114 .11;4 CITY .115 .11;5 STATE .116 .11;6 ZIP CODE .117 .11;7 COUNTY .1211 .121;1 TEMPORARY STREET [LINE 1] .1212 .121;2 TEMPORARY STREET [LINE 2] .1213 .121;3 TEMPORARY STREET [LINE 3] .1217 .121;7 TEMPORARY ADDRESS START DATE .1218 .121;8 TEMPORARY ADDRESS END DATE .1219 .121;10 TEMPORARY PHONE NUMBER .131 .13;1 PHONE NUMBER [RESIDENCE] .132 .13;2 PHONE NUMBER [WORK] .152 .15;2 INELIGIBLE DATE .153 .15;3 MISSING PERSON DATE .1651 INE;1 INELIGIBLE TWX SOURCE .1653 INE;3 INELIGIBLE TWX CITY .1654 INE;4 INELIGIBLE TWX STATE .1656 INE;6 INELIGIBLE VARO DECISION .1657 INE;7 MISSING PERSON TWX SOURCE .1658 INE;8 MISSING PERSON TWX CICITY .1659 INE;9 MISSING PERSON TWX STATE .211 .21;1 K-NAME OF PRIMARY NOK .212 .21;2 K-RELATIONSHIP TO PATIENT .213 .21;3 K-STREET ADDRESS [LINE 1] .214 .21;4 K-STREET ADDRESS [LINE 2] .215 .21;5 K-STREET ADDRESS [LINE 3] .216 .21;6 K-CITY .217 .21;7 K-STATE .218 .21;8 K-ZIP CODE .219 .21;9 K-PHONE NUMBER .2191 .211;1 K2-NAME OF SECONDARY NOK .2192 .211;2 K2-RELATIONSHIP TO PATIENT .2193 .211;3 K2-STREET ADDRESS [LINE 1] .2194 .211;4 K2-STREET ADDRESS [LINE 2] .2195 .211;5 K2-STREET ADDRESS [LINE 3] .2196 .211;6 K2-CITY .2197 .211;7 K2-STATE .2198 .211;8 K2-ZIP CODE .2199 .211;9 K2-PHONE NUMBER .2401 .24;1 FATHER'S NAME .2402 .24;2 MOTHER'S NAME .2403 .24;3 MOTHER'S MAIDEN NAME .251 .25;1 SPOUSE'S EMPLOYER NAME .252 .25;2 SPOUSE'S EMP STREET [LINE 1] .253 .25;3 SPOUSE'S EMP STREET [LINE 2] .254 .25;4 SPOUSE'S EMP STREET [LINE 3] .255 .25;5 SPOUSE'S EMPLOYER'S CITY .256 .25;6 SPOUSE'S EMPLOYER'S STATE .257 .25;7 SPOUSE'S EMP ZIP CODE .258 .25;8 SPOUSE'S EMP PHONE NUMBER .301 .3;1 SERVICE CONNECTED? .302 .3;2 SERVICE CONNECTED PERCENTAGE .3025 .3;11 RECEIVING VA DISABILITY? .303 .3;3 AMOUNT OF VA DISABILITY .306 .3;6 MONETARY BEN. VERIFY DATE .307 .3;7 INELIGIBLE REASON .3111 .311;1 EMPLOYER NAME .31115 .311;15 EMPLOYMENT STATUS .3112 .311;2 GOVERNMENT AGENCY .3113 .311;3 EMPLOYER STREET [LINE 1] .3114 .311;4 EMPLOYER STREET [LINE 2] .3115 .311;5 EMPLOYER STREET [LINE 3] .3116 .311;6 EMPLOYER CITY .3117 .311;7 EMPLOYER STATE .3118 .311;8 EMPLOYER ZIP CODE .3119 .311;9 EMPLOYER PHONE NUMBER .312 .31;2 CLAIM FOLDER LOCATION .313 .31;3 CLAIM NUMBER .32101 .321;1 VIETNAM SERVICE INDICATED? .32102 .321;2 AGENT ORANGE EXPOS. INDICATED? .32103 .321;3 RADIATION EXPOSURE INDICATED? .32104 .321;4 VIETNAM FROM DATE .32105 .321;5 VIETNAM TO DATE .32107 .321;7 AGENT ORANGE REGISTRATION DATE .32109 .321;9 AGENT ORANGE EXAM DATE .3211 .321;10 AGENT ORANGE REGISTRATION # .32111 .321;11 RADIATION REGISTRATION DATE .3212 .321;12 RADIATION EXPOSURE METHOD .322 .32;2 SERVICE VERIFICATION DATE .323 .32;3 PERIOD OF SERVICE .324 .32;4 SERVICE DISCHARGE TYPE [LAST] .325 .32;5 SERVICE BRANCH [LAST] .326 .32;6 SERVICE ENTRY DATE [LAST] .327 .32;7 SERVICE SEPARATION DATE [LAST] .328 .32;8 SERVICE NUMBER [LAST] .329 .32;9 SERVICE DISCHARGE TYPE [NTL] .3291 .32;10 SERVICE BRANCH [NTL] .3292 .32;11 SERVICE ENTRY DATE [NTL] .3293 .32;12 SERVICE SEPARATION DATE [NTL] .3294 .32;13 SERVICE NUMBER [NTL] .3295 .32;14 SERVICE DISCHARGE TYPE [NNTL] .3296 .32;15 SERVICE BRANCH [NNTL] .3297 .32;16 SERVICE ENTRY DATE [NNTL] .3298 .32;17 SERVICE SEPARATION DATE [NNTL] .3299 .32;18 SERVICE NUMBER [NNTL] .331 .33;1 E-NAME .3311 .331;1 E2-NAME OF SECONDARY CONTACT .3312 .331;2 E2-RELATIONSHIP TO PATIENT .3313 .331;3 E2-STREET ADDRESS [LINE 1] .3314 .331;4 E2-STREET ADDRESS [LINE 2] .3315 .331;5 E2-STREET ADDRESS [LINE 3] .3316 .331;6 E2-CITY .3317 .331;7 E2-STATE .3318 .331;8 E2-ZIP CODE .3319 .331;9 E2-PHONE NUMBER .332 .33;2 E-RELATIONSHIP TO PATIENT .333 .33;3 E-STREET ADDRESS [LINE 1] .334 .33;4 E-STREET ADDRESS [LINE 2] .335 .33;5 E-STREET ADDRESS [LINE 3] .336 .33;6 E-CITY .337 .33;7 E-STATE .338 .33;8 E-ZIP CODE .339 .33;9 E-PHONE NUMBER .341 .34;1 D-NAME OF DESIGNEE .342 .34;2 D-RELATIONSHIP TO PATIENT .343 .34;3 D-STREET ADDRESS [LINE 1] .344 .34;4 D-STREET ADDRESS [LINE 2] .345 .34;5 D-STREET ADDRESS [LINE 3] .346 .34;6 D-CITY .347 .34;7 D-STATE .348 .34;8 D-ZIP CODE .349 .34;9 D-PHONE NUMBER .361 .36;1 PRIMARY ELIGIBILITY CODE .3611 .361;1 ELIGIBILITY STATUS .3612 .361;2 ELIGIBILITY STATUS DATE .3614 .361;4 ELIGIBILITY INTERIM RESPONSE .3615 .361;5 ELIGIBILITY VERIF. METHOD .3616 .361;6 ELIGIBILITY STATUS ENTERED BY .362 .36;2 DISABILITY RET. FROM MILITARY? .36205 .362;12 RECEIVING A&A BENEFITS? .3621 .362;1 AMOUNT OF AID & ATTENDANCE .36215 .362;13 RECEIVING HOUSEBOUND BENEFITS? .3622 .362;2 AMOUNT OF HOUSEBOUND .36225 .362;15 RECEIVING SOCIAL SECURITY? .3623 .362;3 AMOUNT OF SOCIAL SECURITY .36235 .362;14 RECEIVING A VA PENSION? .3624 .362;4 AMOUNT OF VA PENSION .3625 .362;5 AMOUNT OF MILITARY RETIREMENT .36255 .362;16 RECEIVING MILITARY RETIREMENT? .3626 .362;6 AMOUNT OF GI INSURANCE .36265 .362;17 GI INSURANCE POLICY? .3627 .362;7 AMOUNT OF SSI .36275 .362;19 RECEIVING SUP. SECURITY (SSI)? .3628 .362;8 AMOUNT OF OTHER RETIREMENT .36285 .362;18 TYPE OF OTHER RETIREMENT .3629 .362;9 AMOUNT OF OTHER INCOME .368 .36;8 SERVICE DENTAL INJURY? .369 .36;9 SERVICE TEETH EXTRACTED? .525 .52;5 POW STATUS INDICATED? .526 .52;6 POW CONFINEMENT LOCATION .527 .52;7 POW FROM DATE .528 .52;8 POW TO DATE .5291 .52;11 COMBAT SERVICE INDICATED? .5292 .52;12 COMBAT SERVICE LOCATION .5293 .52;13 COMBAT FROM DATE .5294 .52;14 COMBAT TO DATE 57.4 57;4 SPINAL CORD INJURY 391 TYPE;1 TYPE 1010.15 1010.15;5 RECEIVED VA CARE PREVIOUSLY? 1010.151 1010.15;1 MOST RECENT DATE OF CARE 1010.152 1010.15;2 MOST RECENT LOCATION OF CARE 1010.153 1010.15;3 2ND MOST RECENT DATE OF CARE .21011 .21;11 K-WORK PHONE NUMBER .211011 .211;11 K2-WORK PHONE NUMBER .381 .38;1 ELIGIBLE FOR MEDICAID? .3221 .322;1 LEBANON SERVICE INDICATED? .3222 .322;2 LEBANON FROM DATE .3223 .322;3 LEBANON TO DATE .3224 .322;4 GRENADA SERVICE INDICATED? .3225 .322;5 GRENADA FROM DATE .3226 .322;6 GRENADA TO DATE .3227 .322;7 PANAMA SERVICE INDICATED? .3228 .322;8 PANAMA FROM DATE .3229 .322;9 PANAMA TO DATE .32201 .322;10 PERSIAN GULF SERVICE? .322011 .322;11 PERSIAN GULF FROM DATE .322012 .322;12 PERSIAN GULF TO DATE .322013 .322;13 ENV CONTAM INDICATED? .322014 .322;14 REGISTRATION DATE .322015 .322;15 EXAM DATE .322016 .322;16 SOMALIA SERVICE INDICATED? .322017 .322;17 SOMALIA FROM DATE .322018 .322;18 SOMALIA TO DATE .304 .3;4 P&T .305 .3;5 UNEMPLOYABLE .3012 .3;12 SC AWARD DATE .293 .29;12 RATED INCOMPETENT? .292 .29;2 DATE RULED INCOMPETENT (CIVIL) .291 .29;1 DATE RULED INCOMPETENT (VA) .36205 .362;12 RECEIVING A&A BENEFITS? .36215 .362;13 RECEIVING HOUSEBOUND BENEFITS? .36235 .362;14 RECEIVING A VA PENSION? .3025 .3;11 RECEIVING VA DISABILITY? .36295 .36295;20 TOTAL ANNUAL VA CHECK AMOUNT .36265 .362;17 GI INSURANCE POLICY? .3626 .362;6 AMOUNT OF GI INSURANCE .34011 .34;11 D-WORK PHONE NUMBER .2514 .25;14 SPOUSE'S OCCUPATION .2515 .25;15 SPOUSE'S EMPLOYMENT STATUS 1010.154 1010.15;4 2ND MOST RECENT LOCATION 1901 VET;1 VETERAN (Y/N)? .33011 .33;11 E-WORK PHONE NUMBER .331011 .331;11 E2-WORK PHONE NUMBER .1112 .11;12 ZIP+4 .12105 .121;9 TEMPORARY ADDRESS ENTER/EDIT? .12111 .121;11 TEMPORARY ADDRESS COUNTY .12112 .121;12 TEMPORARY ZIP+4 .382 .38;2 DATE MEDICAID LAST ASKED FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.04 .01 0;1 RATED DISABILITIES (VA) 2 0;2 DISABILITY % 3 0;3 SERVICE CONNECTED FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.001 .01 0;1 ENROLLMENT CLINIC FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.16 .01 0;1 MISSING OR INELIGIBLE FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.01 .01 0;1 ALIAS 1 0;2 ALIAS SSN FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.05 .01 0;1 SERVICE CONNECTED CONDITIONS .02 0;2 PERCENTAGE FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.101 .01 0;1 LOG IN DATE/TIME 2 0;3 TYPE OF BENEFIT APPLIED FOR 3 0;4 FACILITY APPLYING TO 20 2;1 NEED RELATED TO OCCUPATION 23 2;4 NEED RELATED TO AN ACCIDENT [ ELIGIBILITY ] FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.0361 .01 0;1 ELIGIBILITY [ DENTAL ] Extract the five most recent FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.11 .01 0;1 DATE OF DENTAL TREATMENT 2 0;2 CONDITION 3 0;3 DATE CONDITION FIRST NOTICED [ APPOINTMENT ] Extract the five most recent FILE NO. FIELD NO NODE;PIECE DESCRIPT 2.98 .01 0;1 CLINIC 3 0;2 STATUS 9 0;7 PURPOSE OF VISIT 9.5 0;16 APPOINTMENT TYPE The PDX development team has permission to access ^DPT (directly) for the verification of a valid DFN. This is done extensively through out PDX. Other places ^DPT is accessed directly. a) $O thru eligibility multiple b) $O thru appointments multiple c) $O thru dental appointments multiple ^SEE DESCRIPTION ROUTINE: ******************** 269 NAME: DBIA269 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.1 ROOT: PSI(58.1, DESCRIPTION: TYPE: File Version 2.0 of Drug Accountability will require previous installation of Automatic Replenishment/Ward Stock version 2.3. The ^PSGWUAS routine contains a call to ^PSARWS. ^PSARWS will traverse the ^PSI(58.5,"AMIS") x-ref to update the AR/WS dispensing in Drug Accountability. Using the sixth subscript, a look-up is made to ^PSI(58.1,D0,"SITE") to determine the Inpatient Site. GLOBAL MAP DATA DICTIONARY #58.1 -- PHARMACY AOU STOCK FILE STORED IN ^PSI(58.1, (1 ENTRY) SITE: BIRMINGHAM ISC (#14) ------------------------------------------------------------ ^PSI(58.1,D0,SITE)= (#4) INPATIENT SITE [1P] ^ ROUTINE: ******************** 270 NAME: DBIA270-A CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6, DESCRIPTION: TYPE: File Drug Accountability will use the IV STATS (#50.8) file to update IV dispensing activity in a Drug Accountability Location. To correctly identify the DRUG (#50) file entry a look up is first made to the IV ADDITIVES (#52.6) and/or the IV SOLUTION (#52.7) files. Looping through ^PS(50.8,D0), all IV Rooms are checked. Looping through ^PS(50.8,D0,2,D1), dates are checked. Looping through ^PS(50.8,D0,2,D1,2,D2), drugs are checked with support from the "AC" x-ref. Looping through ^PS(50.8,D0,2,D1,2,D2,3,D3), ward is checked. It is here that, if a match occurs, $P($G(^PS(50.8,D0,2,D1,2,D2,3,D3,0)),U,2)-$P($G(^(0)),U,5) is used to update the balance in Drug Accountability. GLOBAL MAP DATA DICTIONARY #52.6 -- IV ADDITIVES FILE STORED IN ^PS(52.6, (1 ENTRY) SITE: BIRMINGHAM ISC ------------------------------------------------------------------------ CROSS REFERENCED BY: GENERIC DRUG(AC) ^PS(52.6,D0,0)= (#1) GENERIC DRUG [2P] ROUTINE: ******************** 271 NAME: DBIA271-A CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The following routines and file entries will be exported by PDX with version 1.5: IBAPDX IBAPDX0 IBAPDX1 ROUTINE: ******************** 272 NAME: DBIA272-A CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.61 ROOT: VAT(394.61, DESCRIPTION: TYPE: File a) The following fields are referenced by the global directly, NOT by a fileman call. - PDX Transaction File (394.61) field # .03 Patient Name ROUTINE: ******************** 274 NAME: DBIA274 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 9,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Progress Note users have asked that notes printed for a given location begin the print with big letter identification of location. Since Health Summary has such lovely code for accomplishing this, and since PN already relies on HS routines (to display the text of patient warnings), PN is relying on HS code to print the big letters. Specifically, PN 2.5 is issuing a patch in which routine GMRPNP1 news GMTSLTR, and checks for the existence of routine GMTSLTR and calls it if exists, with GMTSLTR =a four letter string. ROUTINE: GMTSLTR COMPONENT: GMTSLTR VARIABLES: GMTSLTR Type: Input ******************** 277 NAME: DBIA277-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 13 ROOT: DIC(13, DESCRIPTION: TYPE: File File #13 - Religion Field #.01 - Name - ^DIC(13,D0,0) piece 1 ROUTINE: ******************** 278 NAME: DBIA278 CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 211.6 ROOT: NURSF(211.6, DESCRIPTION: TYPE: File Mental Health V. 5.0 references the 'Nurs Tour of Duty' file: File #211.6 - Nurs Tour of Duty Field #.01 - Tour of Duty - ^NURSF(211.6,D0,0) piece 1 "B" X-Ref - Tour of Duty ROUTINE: ******************** 279 NAME: DBIA279 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Mental Health V. 5.0 no longer contains its own Progress Notes options, but references within two Mental Health options the newly released 'generic' Progress Notes Package. Verbal agreement with the Progress Notes developer has been made. Approval to include within the Mental Health menu options references to the Progress Notes package options have been agreed upon, these menu options replace the old MentalHealth Progress Notes option. ROUTINE: ******************** 282 NAME: DBIA282-A CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCS58 COMPONENT: EN3 VARIABLES: Checks for Fund Control Point user authorization access. ******************** 283 NAME: DBIA283 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Electronic Signature encode created for IFCAP V4.0 for the Electronic Signature codes will work with AR V3.7 code sheet creator without having to modifiy any AR routines. The exception to the above is, the 'Forward IRS Offsets to Austin' option in the AR package. This option is used thru the 15th - 21st days of the month. Since this option generates code sheets in the background AR uses the PRCAOFF2 routine to create code sheets. This one routine is not compatible with IFCAP V4.0 AR plans to create a patch (not to be released till IFCAP V4.0 is released) to include the change. This patch was forwarded to the IFCAP V4.0 test sites and were considered as test sites for the AR patch. Since the sites have until the 21st of the month to send the IRS code sheets, this patch should not delay the implementation plans for IFCAP V4.0. The patch number is PRCA*3.7*17 IFCAP version 4 will export this routine in the IFCAP namespace as routine PRC4OFF2 and renamed back to PRCAOFF2 during the pre- initialization routine. ROUTINE: ******************** 284 NAME: DBIA284 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 340 ROOT: RCD(340, DESCRIPTION: TYPE: File Data Dictionary integration - IFCAP calls to AR IFCAP FILES FIELD - RELATION TO IFCAP CALM/LOG Code Sheet File 423 VA IDENT NO. Field 1005.17 (1005;17) - points to the AR Debtor File (#340) Procurement & Accounting Transaction File 442 Debtor Field 5.1 (1;16) - points to the AR Debtor File 340 Purchase Order Number Field .01 (0;1) - Executable Help checks for AR variable $D(PRCAREF) ROUTINE: ******************** 286 NAME: DBIA286 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: QUALITY ASSURANCE INTEGRATION USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2, DESCRIPTION: TYPE: File MailMan v 7.1 will invoke a QA conversion in MailMan's post init. It will manipulate the fields as follows: DBIA for MailMan with the QUALITY ASSURANCE SITE PARAMETERS file (#740). This DBIA is for the purpose of a post-init conversion of two free-text pointers to the DOMAIN file (#4.2). Read/write access to the following fields: 740,740.02 EWS DOMAIN (0;3) 740,740.04 NQADB DOMAIN (0;5) ROUTINE: ******************** 287 NAME: DBIA287 CUSTODIAL PACKAGE: FEE BASIS SUBSCRIBING PACKAGE: IFCAP FEE BASIS CLAIMS SYSTEM ADDED JUNE 2009 USAGE: Controlled Subscri ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IFCAP needs to determine the appropriate header for FEE code sheets based on the version of Fee Basis. In the past the header was altered by a coordinated patch between the two packages. A new call has been added, in fee, which will eliminate the need for patches. IFCAP version 4 will be using the following function call to determine the codesheet header. If the routine FBAAUTL3 does not exist the header will be FEN. Otherwise the following call, being sent with version 3 of Fee Basis will return the appropriate header (FEE or FEN). $$HDR^FBAAUTL3() ROUTINE: FBAAUTL3 COMPONENT: $$HDR VARIABLES: ******************** 288 NAME: DBIA288-A CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Discharge Summary adds two new components to the HS Component file (#142.1), which present detailed and brief Discharge Summary information, while respecting Time and Occurrence limits. These are added by the Discharge Summary post-init as record #'s 57 and 58, and you can see them in either the SIUG or OE/RR accounts. The post-init also adds these components to the GMTS HS ADHOC OPTION Health Summary Type by calling the subroutine ENPOST^GMTSLOAD, and installs the routines GMRDHSDS as GMTSDS and GMRDHSDB as GMTSDSB (these are the driver routines for the respective components). ROUTINE: GMTSLOAD COMPONENT: ENPOST VARIABLES: ******************** 289 NAME: DBIA289-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: OCT 12,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Manage Security Keys [GMRD KEY -------1 Allocation of Security Keys MANAGEMENT] [XUKEYALL] |---------------------------------2 De-allocation of Security Keys| | [XUKEYDEALL]| |---------------------------------3 Delegate keys [XQKEYDEL]| |---------------------------------4 Remove delegated keys| | [XQKEYRDEL]| ------------------------------------------------------------------------ |---------------------------------5 List users holding a certain| key [XQSHOKEY] Discharge Summary will export the above menu until a corresponding delegatable menu is provided in Kernel. Discharge Summary will indicate in its manuals (User, Technical, and Security), references to the appropriate Kernel chapters, and indicate that keys cannot be allocated (for end user use) until they are delegated to the person doing the allocating. And IRM must delegate individual keys before a delegated key can be delegated or allocated. DURATION: Till otherwise agreed--UNTIL KERNEL CHANGES MENU ROUTINE: ******************** 290 NAME: DBIA290-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: FEE BASIS CMOP FEE BASIS CLAIMS SYSTEM ADDED 7/14/2009 USAGE: Controlled Subscri ENTERED: OCT 12,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.5 ROOT: %ZIS(1, DESCRIPTION: TYPE: File ============================================================= Field 33, Unauthorized Claim Printer, in file 161.4 (Fee Basis Site Parameters file) references the device (%ZIS(1) and terminal type (%ZIS(2) files in the Input transform (extrinsic function), Executable help (routine call) and Screen. Fee routine is FBUCDD1. The Screen is: S DIC("S")= "S Z=$G(^%ZIS(1,+Y,""SUBTYPE"")),Z=$G(^%ZIS(2,Z,0)) I $E($P(Z,U),1)=""P""K Z" Global references in the routine calls are: %ZIS(1,"B" %ZIS(1,ien,0 (XHELP only) %ZIS(1,ien,"SUBTYPE" %ZIS(1,ien,1 (XHELP only) %ZIS(2,ien,0 where $E(0 node,1)="P" is checked ROUTINE: ******************** 294 NAME: DBIA294 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HOME BASED PRIMARY CARE USAGE: Private ENTERED: OCT 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File A DBIA is established between the Hospital Based Home Care system and the Patient file (#2), for read access to the following. ***************************************************************** ********** FIELDS *********************************************** ***************************************************************** FIELD NODE PIECE TITLE ----------------------------------------------------------------- .01 0 1 Name .02 0 2 Sex .03 0 3 Date of Birth .05 0 5 Marital Status .06 0 6 Race .131 .13 1 Phone Number [Residence] .323 .32 3 Period of Service .361 .36 1 Primary Eligibility Code All seven fields in the .11 node (address information). **************************************************************** In addition reference is made to "^DPT(IEN,"S"," in the routine HBHCCAN. ROUTINE: ******************** 295 NAME: DBIA295 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: OCT 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Integration Agreement Request between Toolkit (all versions) and Kernel (all versions). Toolkit and Kernel agree that both packages shall distribute all routines and data for M operating system interfaces (e.g. ZOSF, ZOSV*, ZTBK). These two packages also agree that both shall distribute the function library as designated by the routine namespace XLF. Toolkit and Kernel also agree that the menus, XUPROG, XTMENU, and XUCM MAIN, can be attached to the Kernel menu EVE. ROUTINE: ******************** 296 NAME: DBIA296 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.8 ROOT: PS(50.8, DESCRIPTION: TYPE: File Outpatient Pharmacy 6.0v will be printing a management report. In order to complete the report, we need to read ^PS(50.8 (IV STATS FILE). We are reporting the outpatient ward's number of dispensed units, average cost of the dispensed units, and the total costs of the dispensed units. To obtain this data, we need to read the 0 node in subfile 50.804, the Average Drug Cost Per Unit field (#4) on the 0 node piece 5 in subfile 50.805, the Dispensed Units (Ward) field (#2) on the 0 node piece 2 in the subfile 50.808, and the B cross-reference in subfile 50.808. GLOBAL MAP DATA DICTIONARY #50.8 -- IV STATS FILE STORED IN ^PS(50.8, SITE: BIRMINGHAM ISC -------------------------------------------------------------------------- ^PS(50.8 D0,2,D1,1,0)=^50.804P^^ (#1) WARD ^PS(50.8,D0,2,D1,2,D2,0)=^^^^ (#4) AVERAGE DRUG COST PER UNIT [5N] ^PS(50.8,D0,2,D1,2,D2,3,D3,0)=^ (#2) DISPENSED UNITS (WARD) [2N] ^ ROUTINE: ******************** 297 NAME: DBIA297-A CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The routine GMTSPDX will be exported by version 1.5 of PDX. Installation of GMTSPDX will only be done if the routine does not exist on the installing system. A partial data dictionary for the HEALTH SUMMARY PARAMETERS file (#142.99) will be exported by version 1.5 of PDX. The partial data dictionary will export the SPOOL DEVICE NAME field (#.04). The PDX application is grynted permission to include instructions for editing the GMTS IRM/ADPAC PARAMETER EDIT option. These instructions explain how to add the SPOOL DEVICE NAME field to the existing DR string contaioed in the DR {DIE} field (#51). The PDX application is granted pesmission to included instructions for editing the SPOOL DEVICE NAME field (#.04) of the HEALTH SUMMARY PARAMETERS file (#142.99) using the GMTS IRM/ADPAC PARAMETER EDIT option. These instructions explain how to enter the name of the spooling device used at the installing facility. ROUTINE: ******************** 298 NAME: DBIA298-A CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.61 ROOT: VAT(394.61, DESCRIPTION: TYPE: File The Health Summary application is granted read access to the following fields and, if listed, their associated cross references: File Field Node;Piece Description (Field name) X-Refs ------ ----- ---------- ------------------------------ ------ 394.61 .01 0;1 Transaction Number B .03 0;3 Patient Ptr ROUTINE: ******************** 299 NAME: DBIA299-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File The PDX (V 1.5) application is granted read access to the DD and DIC globals to accomplish the following tasks: 1) See DBIA 821 2) Get node a field/multiple is stored on $P($P(^DD(FILE,FIELD,0),"^",4),";",1) 3) Get field name $P(^DD(FILE,FIELD,0),"^",1) 4) Determine if a field is date valued $P(^DD(FILE,FIELD,0),"^",2)["D" 5) Determine if a subfile is a word processing field $P(^DD(SUBFILE,.01,0),"^",2)["W" 6) Determine what file a field points to +$P($P(^DD(FILE,FIELD,0),"^",2),"P",2) 7) Determine if a file is a subfile $G(^DD(FILE,0,"UP"))'="" 8) Determine main file number for a subfile $G(^DD(SUBFILE,0,"UP")) 9) Determine main field number for a subfile $O(^DD(MAINFILE,"SB",SUBFILE,"")) 10) Determine subfile number +$P(^DD(FILE,FIELD,0),"^",2) 11) Check for valid file number $D(^DD(FILE)) 12) Check for valid field number $D(^DD(FILE,FIELD)) ROUTINE: ******************** 300 NAME: DBIA300 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to SVDT^IBRFN returns service dates for a specific bill. Input Variable: BN, bill number (external form) VDT, name of array to hold outpatient visit dates, pass by value if needed. Output Variable: _________________________________________________________________ | Piece | Bill not found | Inpatient | Outpatient |-----------------------------------------------------------------| | 1 | 0 | 1 | 2 | 2 | -- | event Date | Event Date | 3 | -- | stmt from date | stmt from Date | 4 | -- | stmt to date | stmt to Date | 5 | -- | LOS (I) | LOS (I) | 6 | -- | # of visit date |# of visit date ----------------------------------------------------------------- all are internal form, any piece may be null if not defined for the bill array containing outpatient visit dates as subscripts/no data, if VDT passed by value. ROUTINE: IBRFN COMPONENT: SVDT VARIABLES: BN Type: Input VDT Type: Both ******************** 301 NAME: DBIA301 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine Call to STMT^IBRFN1 to pass clinical data to AR for the patient statement. INPUT VARIABLE: TRAN, AR Transaction Number, the pointer file 433. OUTPUT VARIABLE: Returns ^TMP("IBRFN1",$J,n)=1^2^3^4^5^6^7^8, where _________________________________________________________________ | | Transaction Type |___________ |____________________________________________________ | Piece | Pharmacy |Outpatient | Inpatient |-----------------------------------------------------------------| | 1 | IB REF # | IB REF # | IB REF # | 2 | Rx # | Visit Date | Adm Date | 3 | Drug | -- | Bill From Date | 4 | Day Supply | -- | Bill To Date | 5 | Physician | -- | Disc Date | 6 | Quantity | -- | -- | 7 |Fill/Refill Date | -- | -- | 8 | Charge Amt | Charge Amt | Charge Amt ----------------------------------------------------------------- ROUTINE: IBRFN1 COMPONENT: STMT VARIABLES: TRAN Type: Input AR Type: Input ******************** 302 NAME: DBIA302-A CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. The PDX application is granted read access to the following fields and, if listed, their associated cross references: File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 50 .01 0;1 GENERIC NAME B 20 ND;1 NATIONAL DRUG FILE ENTRY ROUTINE: ******************** 304 NAME: DBIA304 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AR (ACCOUNTS RECEIVABLE) USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Call to routine IB^IBRUTL to find if there are any IB Actions on hold for this bill. Input Variables: IEN - internal entry number of bill (#399) internal entry number of bill (#430) RETN (OPT) - want array of IB Actions? 1=yes, 0=no if yes, returns IBA(num)=ibn Output Variable: 1=Yes, 0=N0 ROUTINE: IBRUTL COMPONENT: IB VARIABLES: COMPONENT: IB(IEN,RETN) VARIABLES: ******************** 305 NAME: DBIA305 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.281 ROOT: %ZISL(4.281, DESCRIPTION: TYPE: File MailMan should be allowed the use of the %ZISL file as follows: MailMan uses the 4.281 file whose global root is ^%ZISL(4.281, to facilitate InterUCI transfers. This file is part of the MailMan file set. MailMan may distribute and use this file. ROUTINE: ******************** 306 NAME: DBIA306 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AR (ACCOUNTS RECEIVABLE) USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This option allows the agent cashier to release 'holds' on Means Test Bills. ENTRY ACTION: D ^IBRREL ROUTINE: IBRREL ******************** 307 NAME: DBIA307 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to REPRNT^IBCF13 to print 2nd and 3rd notice UB-82's. INPUT VARIABLES: PRCASV("ARREC")=internal number of bill PRCASV("NOTICE")=number of notice OUTPUT VARIABLES: IBAR("ERR")=ERROR MESSAGE IBAR("OKAY")=1 normal finish, 0 not finished ROUTINE: IBCF13 COMPONENT: REPRNT VARIABLES: PRCASV() Type: Input DGCRAR() Type: Output IBAR() Type: ******************** 308 NAME: DBIA308 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AR (ACCOUNTS RECEIVABLE) USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This option prints totals of Revenue Code amounts by Rate Type to collect data for AMIS Segments 295 and 296. ENTRY ACTION: D ^IBOAMS K DTOUT ROUTINE: IBOAMS ******************** 309 NAME: DBIA309 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to IBCAMS to determine amis segment for reimbursable insurance bills. 249 = NSC - outpatient 292 = SC - inpatient 293 = SC - outpatient 297 = NSC - inpatient INPUT VARIABLE: X = internal entry number in #399. OUTPUT VARIABLE: Y= amis segment number or -1 if can't determine. (With the 1st release 18 months) ROUTINE: IBCAMS COMPONENT: IBCAMS VARIABLES: ******************** 310 NAME: DBIA310 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AR (ACCOUNTS RECEIVABLE) USAGE: Private ENTERED: OCT 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to MESS^IBRFN to return an error message from File 350.8. INPUT VARIABLE: Y=error code - from File 350.8 (piece 3) OUTPUT: error message from piece 2 file 350.8. ROUTINE: IBRFN COMPONENT: MESS(Y) VARIABLES: ******************** 311 NAME: DBIA311-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File The Discharge Summary package has permission to access the Patient Information Management System package in the following ways: 1. The Discharge Summary contains a field which is a pointer to the Facility Treating Specialty File (#45.7), to keep track of the Treating Specialty from which a patient was discharged (for searches and sorts). This field value is set to the treating specialty returned by the IN5^VADPT call. 2. Discharge Summary allows the user to do a lookup to get all Discharge Summaries for a given treating specialty by signature status and dictation date. To do this query we need to identify the treating specialty, using a ^DIC call with DIC=45.7, DIC(0)="AEMQ", DIC("A")="TREATING SPECIALTY". ROUTINE: ******************** 312 NAME: DBIA312-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File The Discharge Summary has permission to access the Patient Information Management System package in the following ways: 1. Upon record creation, Discharge Summary will perform a screened look-up on the PTF File to associate the new discharge summary with a valid admission. The screening logic will exclude Census PTF records. Discharge Summary also offers a site parameter to allow selection of Open PTF records only. To that end, the DIC("S") screen will make direct reference to the ^DGPT( global as follows: S DIC=45,DIC(0)=$S($D(GMRDBG):"MXZ",1:"IEZ") ; Exclude "Census" PTF records S DIC("S")="I +$P(^DGPT(+Y,0),U,11)=1" ; If an admission date has been specified, find the corresponding ; PTF record S:$D(GMRDADT) DIC("S")=DIC("S")_",($P($P(^DGPT(+Y,0),U,2),""."")=G MRDADT)" ; If site allows OPEN PTF selection only, then exclude closed or ; transmitted records S:+$P(GMRDPRM0,U,8) DIC("S")=DIC("S")_",'$P(^DGPT(+Y,0),U,6)" where GMRDBG is a boolean flag, indicating that the look-up is being called non-interactively, with a patient SSN and admission date, GMRDADT is the patient's admission date, as dictated by the physician, to be passed in by the non-interactive call, and GMRPRM0 is the zero-node of the GMRD PARAMETERS FILE (#128.99), the eighth piece of which specifies whether the site will allow selection of open PTF records only. Note that this screen will always refer to the 11th piece of the zero node of the PTF record to exclude non-PTF types, and will conditionally refer to the 2nd and 6th pieces, to match the admission date and exclude non-open records, as the site specifies. 2. The Discharge Summary database contains a field that is a pointer to the PTF file (#45), which is stored upon creation of the discharge summary record. 3. Discharge Summary calls the documented IN5^VADPT entry-point to get information on the patient. Using the PTF record number retained in our database, the input variable VAIP("E") is set to the value of field #2.1 (INTERNAL Admission #), which is obtained by a call to EN^DIQ1 after setting DIC=45, DR=2.1, and DA = PTF record number. ROUTINE: ******************** 313 NAME: DBIA313 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 393 ROOT: VAS(393, DESCRIPTION: TYPE: File Discharge Summary has permission to reference the Incomplete Records File (#393), from the GMR REPORTS FILE (#128), IRT RECORD field (#.13). ROUTINE: ******************** 314 NAME: DBIA314-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File To support the table-driven upload of transcribed text to various DHCP files, the Discharge Summary application has permission to access the Data Dictionary and File of Files in the following ways: 1. In order to allow the site to specify the target file, fixed-field header elements, and word-processing field for each report type, Discharge Summary version 1 will make several references to either the File of Files or ^DD(. These are ONLY done in setting up a ^DIC call (to look-up a given field in the target file), or in screening logic (e.g., to exclude the programmer at the site from choosing a non-Word-Processing field in the target file as the destination for the body of a report). Needless to say, NO SETs or KILLs are ever executed on any of FileMan's supporting data structures (i.e., ^DD( or ^DIC(). All hard-coded references to ^DIC( or ^DD( are made from within the following code: GMRDUPAR ; SLC/JER - Upload Parameter Edit ;4/23/93 14:53 ;;1.0V2;Discharge Summary;;Sep 02, 1993 MAIN ; Controls branching N DIC,DA,DIE,DLAYGO,DR,GMRDPRM0,GMRDPRM1,GMRDPRM3,GMRDUSRC,GMRD1ST,X,Y D:'$D(GMRDPRM0) SETPARM^GMRDLIBE W !,"First edit Division-wide upload parameters:",! S (DIC,DLAYGO)=128.99,DIC(0)="AEMQL",DIC("A")="Select DIVISION: " D ^DIC K DLAYGO Q:+Y'>0 S DA=+Y S DIE=128.99,DR="[GMRD UPLOAD PARAMETER EDIT]" D ^DIE D SETPARM^GMRDLIBE W !!,"Now edit the REPORT TYPE file:",! F D Q:+$G(Y)'>0 . N GMRDREP,GMRDX . S DIC="^GMR(128.1,",DIC(0)="AEMQZ",DIC("A")="Select REPORT TYPE: " . I $D(^DISV(DUZ,DIC)),'$D(GMRD1ST) S DIC("B")=$G(^DISV(DUZ,DIC)), GMRD1ST=1 . D ^DIC K DIC Q:+Y'>0 S DA=+Y,GMRDREP=Y,GMRDREP(0)=Y(0) . S DIE=128.1,DR="[GMRD UPLOAD PARAMETER EDIT]" . D ^DIE S Y=1 . I $D(^GMR(128.1,+DA,"HEAD"))>9!($D(^GMR(128.1,+DA,"ITEM"))>9) D . . W !!,"The header for the ",$P(GMRDREP,U,2)," Report type is now defined as:" . . I $P(GMRDPRM0,U,16)="D" D DHDR^GMRDTHLP(.GMRDREP,GMRDPRM0,GMRDPRM1) . . I $P(GMRDPRM0,U,16)="C" D CHDR^GMRDTHLP(.GMRDREP,GMRDPRM0,GMRDPRM1) . . W ! Q TXTFLD(TFILE,GMRDFLT) ; Get Text Field # from ^DD(Target file #, N DIC,X,Y S DIC="^DD("_TFILE_",",DIC(0)="AEMQZ",DIC("A")="Select TARGET TEXT FIELD : " S DIC("S")="I +$$ISWP^GMRDUPAR(TFILE,+Y)" I $D(GMRDFLT) S DIC("B")=GMRDFLT D ^DIC G:+Y'>0 TXTFLDX S Y=+Y_";"_$P($P(Y(0),U,4),";") TXTFLDX Q Y ISWP(TFILE,TFLD) ; Is a given field a Word-processing type field N X,Y S Y=0 I +$P(^DD(TFILE,TFLD,0),U,2)>0 D . N SFILE S SFILE=+$P(^DD(TFILE,TFLD,0),U,2) . S Y=$S($P(^DD(SFILE,.01,0),U,2)="W":1,1:0) Q Y 2. The input transform for the TARGET FILE field (#.05) in the GMR REPORT TYPE file, which is a pointer to the File of Files, assures that only files which include the "GMRD" application group may be chosen for inclusion in the upload. This was done to assure that the site could not inadvertently choose an inappropriate target file (NOTE: the only file exported with this Application Group is the GMR REPORTS FILE (#128), where Discharge Summaries themselves are housed). The input transform looks like this: S DIC("S")="I $D(^DIC(+Y,""%"",""B"",""GMRD""))" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X ROUTINE: ******************** 315 NAME: DBIA315-A CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: FEE BASIS FEE BASIS CLAIMS SYSTEM ADDED 1/6/2009 USAGE: Controlled Subscri ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCS58 COMPONENT: EN1 VARIABLES: PRCS() Type: Input Y Type: Output Utility Call #1 entry point is EN1^PRCS58. Input variables: Required - None Optional - 'PRCS("X")' set to the full Obligation Number (3 character station number, a dash, 6 character obligation number. IE 503-C97211. - 'PRCS("A")' set to the prompt to be displayed to the user. (IE Select Obligation Number: ) - 'PRCS("TYPE")="FB"' Output variables: Y (Y=-1 no good) Piece Data ----------------------------------------------------------- 1 Internal Entry number of Obligation in IFCAP file 2 Obligation Number (full number, includes station number) 3 Control Point (3 numbers, space, description) 4 Appropriation symbol 5 Cost Center (number, space, description) 6 Sub-account 1 7 Sub-account 1 Amount 8 Sub-account 2 9 Sub-account 2 Amount Process: If PRCS("X") variable is defined, there will be NO user dialogue. The utility will use the variable as the lookup value (Obligation Number). If the variable is NOT defined, there will be user dialogue to determine the Obligation Number. COMPONENT: EN2 VARIABLES: PRCS() Type: Input Y Type: Output Utility Call #2 entry point is EN2^PRCS58. Input variables: PRCS("TYPE")="FB" Required - 'X' will contain the following: Piece Data -------------------------------------------------------------- - 1 Obligation Number (full) 2 Date/Time (Internal format) 3 Authorized Amount (If this is a commitment) 4 Payment Amount (If this is a Payment) 5 Reference Number (for Fee this will either be the batch number or the 7078 sequence number) 6 Comment (up to 78 characters) 7 Interface ID (free text) 8 Complete Payment Flag Output variables - 'Y' Process: If 'Y' is equal to 1, transaction was posted. If +Y=0 nothing was posted and 'Y' will contain the error message COMPONENT: EN3 VARIABLES: PRCS() Type: Input Y Type: Output Input Variables: 'PRCS("X")' set equal to the full Obligation Number 'PRCS("TYPE")="FB"' Output Variables: 'Y' Process: If 'Y' is equal to 1, the 1358 is open and available for posting 0 If 'Y' is equal to -1, 1358 is not available for posting ******************** 316 NAME: DBIA316-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File 1. When a new file is configured for use with MTLU, the variable-pointer 'ENTRY' field is automatically updated in the LOCAL KEYWORD and LOCAL SHORTCUT files to reflect the new file. This must be handled via DIC/DIE calls with DIC/DIE being set to ^DD(file,.02,"V", It is fully compatible with the interactive way of creating variable pointer type fields. 2. MTLU uses the string maintained in ^DD("KWIC"). There is currently no way of retrieving this information without directly referencing this node. As stated there is currently no way of extracting data stored in the node except by direct global hit. *Amendment 5/11/94* Toolkit DBIA 316 has been amended to include the $order of ^DD in line QU+5^XTLKEFOP. This code identifies the variable pointer prefix associated with the selected lookup file and was inadvertently ommitted. S XTLKY=Y,XTLKPF=+$O(^DD(8984.2,.02,"V","B",+Y,"")) G:'XTLKPF KL S XTLKPF=$P(^DD(8984.2,.02,"V",XTLKPF,0),U,4),XTLKUT=1 ^DD(D0,.02,'V', ^DD('KWIC') ROUTINE: ******************** 317 NAME: DBIA317-A CUSTODIAL PACKAGE: VETERANS ADMINISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: NOV 2,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VALM1 COMPONENT: PRTLQ VARIABLES: this was used so PDX output would format like printing from List manager COMPONENT: PRTLS VARIABLES: same as PRTLQ COMPONENT: SAVE VARIABLES: save variables for queue ******************** 318 NAME: DBIA318 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: NOV 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other See DBIA #315. ROUTINE: ******************** 319 NAME: DBIA319 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: NOV 2,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Version 7.0 of the Engineering Work Order Module will call IFCAP to display Control Point Activity information related to specific Engineering work orders. Routine ^ENWOD will call ^PRCSP13. Before calling this foreign routine, ^ENWOD will execute ^%ZOSF("TEST") to make sure that ^PRCSP13 exists. Upon entry into ^PRCSP13, local variable DA must contain the internal entry number of the Control Point Activity that is to be displayed. Local variable DA is not returned by ^PRCSP13. If local variables DIWL, DIWR, and/or DIWF are defined when the call to ^PRCSP13 is made, they will not be preserved. ROUTINE: PRCSP13 COMPONENT: PRCSP13 VARIABLES: DA Type: Input DIWL Type: Used DIWR Type: Used DIWF Type: Used ******************** 322 NAME: DBIA322 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: EVENT CAPTURE CONTROLLED SUBSTANCES DSS - DECISION SUPPORT SYSTEM EX USAGE: Controlled Subscri ENTERED: DEC 7,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File DSS is granted permission to make the following call: After callilng IN5^VADPT using the first ^ piece of VAIP(8) Read access to the following field. File Field Name Global Location ---- ----- ---- -------- 45.7 1 Specialty 0;2 ROUTINE: ******************** 323 NAME: DBIA323-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: DEC 16,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2, DESCRIPTION: TYPE: File To support bar code label printing and downloading/uploading, the Controlled Substances package has found it necessary to develop hardware specific parameters for the TERMINAL TYPE and DEVICE file. Centralized procurements of Hewlett Packard and Kyocera laser printers and Intermec trakkers have steered this package toward the use of these hardware types. As testing has proceeded, the need to accurately communicate complex strings for insertion into the TERMINAL TYPE file has proved difficult. An l misinterpreted as a 1, a 0 mininterpreted as a O, or an inadvertant space or lack thereof all can render a device inoperable. It is therefore agreed that IRM utility routines (PSDTER*) be exported which would allow ^DIC look-ups to the TERMINAL TYPE and DEVICE files, ^DIR verification of the selections, and ^DIE stuffs to the necessary fields identified as follows: GLOBAL MAP DATA DICTIONARY #3.2 -- TERMINAL TYPE FILE STORED IN ^%ZIS(2, (VERSION 7.1) -------------------------------------------------------------------------- ^%ZIS(2,D0,0)= (#.01) NAME [1F] ^ ^%ZIS(2,D0,1)= (#1) RIGHT MARGIN [1N] ^ (#2) FORM FEED [2F] ^ (#3) PAGE ==>LENGTH [3N] ^ ^%ZIS(2,D0,1)= (#4) BACK SPACE [4F] ^ ^%ZIS(2,D0,2)= (#6) OPEN EXECUTE [E1,245K] ^ ^%ZIS(2,D0,9)= (#99) DESCRIPTION [1F] ^ ^%ZIS(2,D0,10)= (#110) OPEN PRINTER PORT [E1,245K] ^ ^%ZIS(2,D0,11)= (#111) CLOSE PRINTER PORT [E1,245K] ^ ^%ZIS(2,D0,BAR0)= (#61) BAR CODE OFF [E1,245F] ^ ^%ZIS(2,D0,BAR1)= (#60) BAR CODE ON [E1,245F] ^ ^%ZIS(2,D0, 110 OPEN PRINTER PORT 10;1 Direct Global Read & w 111 CLOSE PRINTER PORT 11;1 Direct Global Read & w ROUTINE: ******************** 324 NAME: DBIA324 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: DEC 23,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM has permission to use the following routine call in the Integrated Billing (IB) package: Means Test Billing module: $$IGN^IBEFUNC(Appt Type, Visit Date) The call is being made to determine if a patient may be billed the Means Test Outpatient copayment, given the visit date and the appointment Type for the visit. Function Call: $$IGN^IBEFUNC(Appt Type, Visit Date) Input Parameters: Appt Type: Pointer to file #409.1, APPOINTMENT TYPE. For a specific patient appointment, this specifies the type of appointment (Regular, Research, Employee,.) Visit Date: Fileman date. For a specific patient appointment, this is the date of the appointment. Output from the call: 1 : On the specified date, for an appointment with the specified appointment type, Means Test billing should be IGNORED (so the Means Test copay should NOT be billed) 0 : On the specified date, for an appointment with the specified appointment type, Means Test billing should NOT be IGNORED (so the Means Test copay SHOULD be billed) ROUTINE: IBEFUNC COMPONENT: $$IGN(,) VARIABLES: ******************** 325 NAME: DBIA325-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH PCE PATIENT CARE ENCOUNTER VISIT TRACKING INTEGRATED BILLING ORDER ENTRY/RESULTS REPORTING LAB SERVICE MENTAL HEALTH CLINICAL PROCEDURES added 10/31/2011 VIRTUAL PATIENT RECORD SCHEDULING CLINICAL CASE REGISTRIES HEALTH MANAGEMENT PLATFORM ***************************************************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ***************************************************** DIETETICS EPIP Intake 11, NSR 20170519 has a requirement to print the Diet orders next to the patient supplemental feeding list. To find the order it is necessary to find the admission date to access the data in NUTRITION PERSON FILE# 115. Existing Dietetics option Run SF Labels/Consolid Ingred List, [FHNO2], will be updated in patch FH*5.5*43. USAGE: Controlled Subscri ENTERED: DEC 23,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VADPT2 COMPONENT: ADM VARIABLES: VAINDT Type: Input DFN Type: Input VADMVT Type: Output Used to determine if a patient is an inpatient on a specified date. Input: variable VAINDT: The date being used to check if the patient was an inpatient. variable DFN: Pointer to the PATIENT in file #2. Output: variable VADMVT: if null (""), then the patient was not an inpatient on VAINDT. otherwise, VADMVT is positive and points to the patient's admission in the PATIENT MOVEMENT (#405) file, so the patient is an inpatient on VAINDT. ******************** 326 NAME: DBIA326 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JAN 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File The following is the Problem File as it has been designed for the DHCP Problem List Application. STANDARD DATA DICTIONARY #9000011 -- PROBLEM FILE 2/9/94 STORED IN ^AUPNPROB( (VERSION 2.0V2) DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE ----------------------------------------------------------------- This file contains patient specific problems entered by the various providers of service. The PATIENT NAME field (.02) is a backward pointer to the IHS PATIENT file. This file contains one record for each problem for each patient, therefore, the KEY field (.01) is duplicated. As of March 17, 1986 the FACILITY must be entered prior to the NUMBER. If the NUMBER is entered without previously entering the FACILITY the "AA" index is created with no FACILITY pointer. DD ACCESS: @ DEL ACCESS: @ IDENTIFIED BY: PATIENT NAME (#.02),FACILITY (#.06),NMBR (#.07) POINTED TO BY: PROBLEM field (#.01) of the PROBLEM LIST AUDIT File (#125.8) CROSS REFERENCED BY: NMBR(AA), PATIENT NAME(AATOO), FACILITY(AATOO2), PATIENT NAME(AC), STATUS(ACTIVE), PATIENT NAME(ACTIVE1), FACILITY(AV1), DIAGNOSIS(AV9), DIAGNOSIS(B), PROBLEM(C) 9000011,.01 DIAGNOSIS 0;1 POINTER TO ICD DIAGNOSIS FILE (#80) (Required) INPUT TRANSFORM: S DIC("S")="I 1 Q:$G(DUZ(""AG""))=""V"" I $E(^(0))'="E", $P(^(0),U,9)="""" Q:$P(^(0),U,10)="""" I $P(^(0),U,10)=AUPNSEX" D ^DIC K DIC S DIC=DIE, X=+Y K:Y<0 X LAST EDITED: JAN 10, 1994 HELP-PROMPT: Enter the ICD Code for this problem. DESCRIPTION: This is the ICD coded diagnosis of the narrative entered describing this problem. TECHNICAL DESCR: The DHCP Problem List application derives its entries from a lookup into the Clinical Lexicon Utility rather than the ICD Diagnosis file. If the term selected from the CLU is not coded to ICD, then code 799.99 "Other Unknown or Unspecified Cause, NEC" will be used here in order to be able to create a new entry. This field may later be edited. SCREEN: S DIC("S")="I 1 Q:$G(DUZ(""AG""))=""V"" I $E(^(0))'="E", $P(^(0),U,9)="""" Q:$P(^(0),U,10)="""" I $P(^(0),U,10)=AUPNSEX" D ^DIC K DIC S DIC=DIE, X=+Y K:Y<0 X EXPLANATION: Cannot be an E code or an inactive code and must be appropriate for the sex of the Patient. CROSS-REFERENCE: 9000011^B 1)= S^AUPNPROB("B",$E(X,1,30),DA)="" 2)= K ^AUPNPROB("B",$E(X,1,30),DA) CROSS-REFERENCE: 9000011^AV9^MUMPS 1)= S:$D(APCDLOOK) DIC("DR")="" 2)= Q Controls the behaviour of the input templates used by IHS to populate and maintain this file. 9000011,.02 PATIENT NAME 0;2 POINTER TO PATIENT/IHS FILE (#9000001) (Required) LAST EDITED: SEP 9, 1993 HELP-PROMPT: Enter the name of the patient for whom this problem has been observed. DESCRIPTION: This is the patient for whom this problem has been observed and recorded. UNEDITABLE CROSS-REFERENCE: 9000011^AC 1)= S ^AUPNPROB("AC",$E(X,1,30),DA)="" 2)= K ^AUPNPROB("AC",$E(X,1,30),DA) CROSS-REFERENCE: 9000011^AATOO^MUMPS 1)= I $P(^AUPNPROB(DA,0),U,6)]"",$P(^(0),U,7)]" " S X1=$P($P(^(0),U,7),"."),X2=$P($P(^(0),U,7), ".",2),^AUPNPROB("AA",X,$P(^(0),U,6)," "_$E("00 0",1,4-$L(X1)-1)_X1_"."_X2_$E("00",1,3-$L(X2)-1 ),DA)="" K X1,X2 2)= I $P(^AUPNPROB(DA,0),U,6)]"",$P(^(0),U,7)]" " S X1=$P($P(^(0),U,7),"."),X2=$P($P(^(0),U,7), ".",2) K ^AUPNPROB("AA",X,$P(^(0),U,6)," "_$E(" 000",1,4-$L(X1)-1)_X1_"."_X2_$E("00",1,3-$L(X2) -1),DA),X1,X2 Allows problem retrieval by patient, facility, and problem number (Nmbr); the number is used as a string in " 000.00" format to assure a consistent ordering. CROSS-REFERENCE: 9000011^ACTIVE1^MUMPS 1)= S:$L($P(^AUPNPROB(DA,0),U,12)) ^AUPNPROB("ACTIVE",X,$P(^(0),U,12),DA)="" 2)= K:$L($P(^AUPNPROB(DA,0),U,12)) ^AUPNPROB("A CTIVE",X,$P(^(0),U,12),DA) Allows problem retrieval by patient and status, in order of entry. 9000011,.03 DATE LAST MODIFIED 0;3 DATE (Required) INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:DTX) X LAST EDITED: JUL 6, 1993 HELP-PROMPT: TYPE A DATE BETWEEN 1900 AND TODAY DESCRIPTION: This is the last date/time this problem was changed. SOURCE OF DATA: 018/PRCOND 9000011,.04 CLASS 0;4 SET 'P' FOR PERSONAL HISTORY; 'F' FOR FAMILY HISTORY; LAST EDITED: OCT 7, 1987 HELP-PROMPT: If this problem is historical, indicate if it is Personal or Family history. DESCRIPTION: This flag is used by the IHS Problem List to indicate if this problem is documented for historical purposes. TECHNICAL DESCR: VA sites using the DHCP Problem List application will not be prompted for this information. 9000011,.05 PROVIDER NARRATIVE 0;5 POINTER TO PROVIDER NARRATIVE FILE (#9999999.27) (Required) INPUT TRANSFORM: S DIC(0)=$S($D(APCDALVR):"LO",1:"EMQLO") D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X LAST EDITED: NOV 28, 1988 HELP-PROMPT: Enter a description of this patient's problem. DESCRIPTION: This contains the actual text used by the provider to describe this problem. SCREEN: S DIC(0)=$S($D(APCDALVR):"LO",1:"EMQLO") EXPLANATION: OLD LOOKUP 9000011,.06 FACILITY 0;6 POINTER TO LOCATION FILE (#9999999.06) (Required) LAST EDITED: JAN 10, 1994 HELP-PROMPT: Enter the location at which this problem was first observed and recorded. DESCRIPTION: This is the facility at which this problem was originally observed and documented. UNEDITABLE CROSS-REFERENCE: 9000011^AV1^MUMPS 1)= Q 2)= Q No longer in use. CROSS-REFERENCE: 9000011^AATOO2^MUMPS 1)= I $P(^AUPNPROB(DA,0),U,2)]"",$P(^(0),U,7)]" " S X1=$P($P(^(0),U,7),"."),X2=$P($P(^(0),U,7), ".",2),^AUPNPROB("AA",$P(^(0),U,2),X," "_$E("00 0",1,4-$L(X1)-1)_X1_"."_X2_$E("00",1,3-$L(X2)-1 ),DA)="" K X1,X2 2)= I $P(^AUPNPROB(DA,0),U,2)]"",$P(^(0),U,7)]" " S X1=$P($P(^(0),U,7),"."),X2=$P($P(^(0),U,7), ".",2) K ^AUPNPROB("AA",$P(^(0),U,2),X," "_$E(" 000",1,4-$L(X1)-1)_X1_"."_X2_$E("00",1,3-$L(X2) -1),DA),X1,X2 Allows problem retrieval by patient, facility, and problem number (Nmbr); the number is used as a string in " 000.00" format to assure a consistent ordering. 9000011,.07 NMBR 0;7 NUMBER (Required) INPUT TRANSFORM: K:+X'=X!(X>999.99)!(X<1)!(X?.E1"."3N.N) X Q:'$D (X) K:$D(^AUPNPROB("AA",$P(^AUPNPROB(DA,0),U,2 ),$P(^(0),U,6)," "_$E("000",1,4-$L($P(X,".",1)) -1)_$P(X,".",1)_"."_$P(X,".",2)_$E("00",1,3-$L( $P(X,".",2))-1))) X LAST EDITED: JUL 26, 1993 HELP-PROMPT: TYPE A NUMBER BETWEEN 1 AND 999.99 DESCRIPTION: This is a number which, together with the Patient (#.02) and Facility (#.06) fields, serves as a unique identifier for this problem. Up to 2 decimal places may be used to indicate that a problem is a result of, or related to, another problem. SOURCE OF DATA: 018/PRNUMB NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER CROSS-REFERENCE: 9000011^AA^MUMPS 1)= S ^AUPNPROB("AA",$P(^AUPNPROB(DA,0),U,2),$P (^(0),U,6)," "_$E("000",1,4-$L($P(X,".",1))-1)_ $P(X,".",1)_"."_$P(X,".",2)_$E("00",1,3-$L($P(X ,".",2))-1),DA)="" 2)= K ^AUPNPROB("AA",$P(^AUPNPROB(DA,0),U,2),$P (^(0),U,6)," "_$E("000",1,4-$L($P(X,".",1))-1)_ $P(X,".",1)_"."_$P(X,".",2)_$E("00",1,3-$L($P(X ,".",2))-1),DA) Allows problem retrieval by patient, facility, and problem number (Nmbr); the number is used as a string in " 000.00" format to assure a consistent ordering. 9000011,.08 DATE ENTERED 0;8 DATE (Required) INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:DTX) X LAST EDITED: MAR 7, 1988 HELP-PROMPT: TYPE A DATE BETWEEN 1900 AND TODAY DESCRIPTION: This is the date this problem was entered into this file. SOURCE OF DATA: 018/PREDAT UNEDITABLE 9000011,.12 STATUS 0;12 SET (Required) 'A' FOR ACTIVE; 'I' FOR INACTIVE; LAST EDITED: JUL 6, 1993 HELP-PROMPT: Enter the current status of this problem, active or inactive. DESCRIPTION: This is the current activity status of this problem, whether active or inactive; if more detail is needed, a notation may be filed with this problem. SOURCE OF DATA: 018/PRSTAT CROSS-REFERENCE: 9000011^ACTIVE^MUMPS 1)= S:$P(^AUPNPROB(DA,0),U,2) ^AUPNPROB("ACTIVE ",+$P(^(0),U,2),X,DA)="" 2)= K ^AUPNPROB("ACTIVE",+$P(^AUPNPROB(DA,0),U, 2),X,DA) Allows problem retrieval by patient and status, in order of entry. 9000011,.13 DATE OF ONSET 0;13 DATE INPUT TRANSFORM: S %DT="E" D ^%DT S X=Y K:DTX) X LAST EDITED: JUN 13, 1993 HELP-PROMPT: TYPE A DATE BETWEEN 1880 AND TODAY DESCRIPTION: This is the approximate date this problem appeared, as precisely as known. 9000011,1.01 PROBLEM 1;1 POINTER TO EXPRESSIONS FILE (#757.01) LAST EDITED: JUL 28, 1993 HELP-PROMPT: Enter the problem observed for this patient. DESCRIPTION: This field contains the standardized text stored in the Clinical Lexicon for this problem. CROSS-REFERENCE: 9000011^C 1)= S ^AUPNPROB("C",$E(X,1,30),DA)="" 2)= K ^AUPNPROB("C",$E(X,1,30),DA) 9000011,1.02 CONDITION 1;2 SET 'T' FOR TRANSCRIBED; 'P' FOR PERMANENT; 'H' FOR HIDDEN; LAST EDITED: JUL 26, 1993 DESCRIPTION: This reflects the current condition of this entry, whether transcribed by a clerk from the paper chart, entered or verified by a provider, or marked as removed from the patient's list. TECHNICAL DESCR: This flag is used internally by the DHCP Problem List; entries having an H in this field have been "deleted" and are maintained for historical use but are generally ignored. If the parameter "Verify Transcribed Entries" is turned on in File #125.99, entries made by a clerk will have a T here, and a flag will appear on the clinician's display of the list. P entries have been entered or verified by a provider. 9000011,1.03 ENTERED BY 1;3 POINTER TO NEW PERSON FILE (#200) LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter the name of the current user. DESCRIPTION: This is the user who actually entered this problem into this file. 9000011,1.04 RECORDING PROVIDER 1;4 POINTER TO NEW PERSON FILE (#200) LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter the name of the provider responsible for the recording of this data. DESCRIPTION: This is the provider who either directly entered this problem into the file or requested it be entered, and is initially responsible for this problem's inclusion on the problem list. 9000011,1.05 RESPONSIBLE PROVIDER 1;5 POINTER TO NEW PERSON FILE (#200) LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter the name of the local provider treating this problem. DESCRIPTION: This is the provider currently responsible for treating this problem. 9000011,1.06 SERVICE 1;6 POINTER TO SERVICE/SECTION FILE (#49) LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter the service to be associated with this problem. DESCRIPTION: This is the service primarily involved in the treatment of this problem; the DHCP Problem List defaults this field to the service defined in File #200 for the Recording Provider of this problem, upon entry of the problem. It may later be used to categorize problems for screening and sorting. 9000011,1.07 DATE RESOLVED 1;7 DATE INPUT TRANSFORM: S %DT="E" D ^%DT S X=Y K:Y<1 X LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter the date this problem became resolved or inactive, as precisely as known. DESCRIPTION: This is the date this problem was resolved or inactivated, as precisely as known. 9000011,1.08 CLINIC 1;8 POINTER TO HOSPITAL LOCATION FILE (#44) INPUT TRANSFORM: I $P(^(0),U,3)="C" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X LAST EDITED: DEC 23, 1993 HELP-PROMPT: Enter the clinic in which the patient is being seen for this problem. DESCRIPTION: This is the clinic in which this patient is being seen for this problem. The problem list may be screened based on this value, to change one's view of the list. SCREEN: I $P(^(0),U,3)="C" EXPLANATION: Only clinics are allowed here. 9000011,1.09 DATE RECORDED 1;9 DATE INPUT TRANSFORM: S %DT="E" D ^%DT S X=Y K:DTX) X LAST EDITED: JAN 11, 1994 HELP-PROMPT: TYPE A DATE BETWEEN 1900 AND TODAY DESCRIPTION: This is the date this problem was originally recorded, either online or in the paper chart; it may be the same as, or earlier than, the Date Entered. 9000011,1.1 SERVICE CONNECTED 1;10 SET '1' FOR YES; '0' FOR NO; LAST EDITED: JUL 26, 1993 HELP-PROMPT: If this problem is service connected, enter YES here. DESCRIPTION: If the patient has service connection on file in the DHCP Patient file #2, this problem specifically may be flagged as being service connected. TECHNICAL DESCR: This data will be prompted for in the DHCP Problem List only if the patient is indicated for service connection. Non-VA sites will not be prompted for this information. 9000011,1.11 AGENT ORANGE EXPOSURE 1;11 SET '1' FOR YES; '0' FOR NO; LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter YES if this problem is related to exposure to Agent Orange. DESCRIPTION: If this problem is related to a patient's exposure to Agent Orange, it may be flagged here. TECHNICAL DESCR: This data will be prompted for in the DHCP Problem List only if a patient has Agent Orange exposure indicated. Non-VA sites will not be prompted for this information. 9000011,1.12 IONIZING RADIATION EXPOSURE 1;12 SET '1' FOR YES; '0' FOR NO; LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter YES if this problem is related to exposure to ionizing radiation. DESCRIPTION: If this problem is related to a patient's exposure to ionizing radiation, it may be flagged here. TECHNICAL DESCR: This data will be prompted for in the DHCP Problem List only if the patient has ionizing radiation exposure indicated. Non-VA sites will not be prompted for this information. 9000011,1.13 PERSIAN GULF EXPOSURE 1;13 SET '1' FOR YES; '0' FOR NO; LAST EDITED: JUL 26, 1993 HELP-PROMPT: Enter YES if this problem is related to a Persian Gulf exposure. DESCRIPTION: If this problem is related to a patient's service in the Persian Gulf, it may be flagged here. TECHNICAL DESCR: This data will be prompted for only if a patient has Persian Gulf service indicated. Non-VA sites will not be prompted for this information. 9000011,1.14 PRIORITY 1;14 SET 'A' FOR ACUTE; 'C' FOR CHRONIC; LAST EDITED: FEB 1, 1994 HELP-PROMPT: You may further refine the status of this problem by assigning it a priority; acute problems will be flagged on the list display. DESCRIPTION: This is a flag to indicate how critical this problem is for this patient; problems marked as Acute will be flagged on the Problem List display. 9000011,1101 NOTE FACILITY 11;0 POINTER Multiple #9000011.11 (Add New Entry without Asking) DESCRIPTION: This is the location at which the notes in this multiple originated. 9000011.11,.01 NOTE FACILITY 0;1 POINTER TO LOCATION FILE (#9999999.06) (Multiply asked) LAST EDITED: SEP 9, 1993 HELP-PROMPT: Enter the location at which these notes originated. DESCRIPTION: This is the location at which the notes in this multiple originated. CROSS-REFERENCE: 9000011.11^B 1)= S ^AUPNPROB(DA(1),11,"B",$E(X,1,30),DA)=" " 2)= K ^AUPNPROB(DA(1),11,"B",$E(X,1,30),DA) 9000011.11,1101 NOTE 11;0 Multiple #9000011.1111 (Add New Entry without Asking) DESCRIPTION: Each entry in this multiple is a notation appended to a problem for further clarification or information. Data includes a note number and status, the date the note was added, the provider who added it, and the actual text of the note. IDENTIFIED BY: NOTE NARRATIVE(#.03), 9000011.1111,.01 NOTE NMBR 0;1 NUMBER (Required) INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X LAST EDITED: JAN 25, 1994 HELP-PROMPT: Type a Number between 1 and 999, 0 Decimal Digits DESCRIPTION: This is the unique note identifier. CROSS-REFERENCE: 9000011.1111^B 1)= S ^AUPNPROB(DA(2),11,DA(1),11,"B",$E(X, 1,30),DA)="" 2)= K ^AUPNPROB(DA(2),11,DA(1),11,"B",$E(X, 1,30),DA) CROSS-REFERENCE: 9000011.1111^AV9^MUMPS 1)=S:$D(APCDLOOK) DIC("DR")="" 2)= Q Controls the behaviour of the input templates used by IHS to populate and maintain this file. 9000011.1111,.03 NOTE NARRATIVE 0;3 FREE TEXT (Required) INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X LAST EDITED: JUL 26, 1993 HELP-PROMPT: Answer must be 3-60 characters in length. DESCRIPTION: Additional comments may be entered here to further describe this problem. 9000011.1111,.04 STATUS 0;4 SET (Required) 'A' FOR ACTIVE; LAST EDITED: MAY 1, 1990 HELP-PROMPT: If this note is currently ACTIVE, indicate it here. DESCRIPTION: This flag indicates if this note is currently active. 9000011.1111,.05 DATE NOTE ADDED 0;5 DATE INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:DTX) X LAST EDITED: JUL 26, 1993 HELP-PROMPT: TYPE A DATE BETWEEN 1880 AND TODAY DESCRIPTION: This is the date this note was entered into this file. 9000011.1111,.06 AUTHOR 0;6 POINTER TO NEW PERSON FILE (#200) LAST EDITED: MAR 30, 1993 HELP-PROMPT: Enter the name of the provider who authored the text of this note. DESCRIPTION: This is the provider who authored the text of this note. FILES POINTED TO FIELDS EXPRESSIONS (#757.01) PROBLEM (#1.01) HOSPITAL LOCATION (#44) CLINIC (#1.08) ICD DIAGNOSIS (#80) DIAGNOSIS (#.01) LOCATION (#9999999.06) FACILITY (#.06) NOTE FACILITY:NOTE FACILITY (#.01) NEW PERSON (#200) ENTERED BY (#1.03) RECORDING PROVIDER (#1.04) RESPONSIBLE PROVIDER (#1.05) NOTE:AUTHOR (#.06) PATIENT/IHS (#9000001) PATIENT NAME (#.02) PROVIDER NARRATIVE (#9999999.27) PROVIDER NARRATIVE (#.05) SERVICE/SECTION (#49) SERVICE (#1.06) INPUT TEMPLATE(S): APCD FUD PROB OCT 23, 1987 USER #0 PCC Data Entry - Used to edit uncoded ICD diagnoses in the Problem file. PRINT TEMPLATE(S): SORT TEMPLATE(S): ROUTINE: ******************** 327 NAME: DBIA327 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JAN 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .401 ROOT: DIBT( DESCRIPTION: TYPE: File Laboratory V5.2 (only V5.2) is granted the following exemption: The laboratory is supplying a pre release 5.2 patch. The patch will allow the site to mimic the conversion process required for V5.2 install. As a part of the process a FileMan sort template is created of all providers the software was unable to repoint to VA(200. The creation of the sort template is done with a DIC call and a DR string. We are not aware of a method to load the actual data. Therefore, this function is hard coded. The exemption is only required for the one time conversion process. Listed below is the actual code involved. Please advise of any suggestion you feel will be of benefit. EXCEPT(LRFILE,LRD0) ;- LOGS EXCEPTIONS FROM THE CONVERSIONS OF DATA FROM 6 A ND 16 ; exceptions are put into a SORT template so the the site can ; then use fileman enter edit to correct problems found. ; N DIC,LRSORT,X,Y I '$D(^DIBT("B",LRFILE_"-EXCEPTIONS")) D ADD I '$D(LRSORT) S LRSORT=$O(^DIBT("B",LRFILE_"-EXCEPTIONS",0)) S ^DIBT(LRSORT,1,LRD0)="" Q ; ADD ; add a new sort template to be used for exception logging and editing N X,Y S DIC="^DIBT(",DIC(0)="L",DIC("DR")="2///^S X=""T"";4///^S X=$P(LR FILE," "-"",2);5///^S X=0;" S X=LRFILE_"-EXCEPTIONS" D FILE^DICN S LRSORT=+Y Q ROUTINE: ******************** 328 NAME: DBIA328 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JAN 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to POT^PSOCOPAY to pass the DFN, the internal entry number for the patient and returns a number for 30 days Rx supplies. Input Variable: DFN-the patient's internal entry number Output Variable: X-a number, of 30 day supplies that a patient has for potential bills. ROUTINE: PSOCOPAY COMPONENT: POT VARIABLES: DFN Type: Input X Type: Output ******************** 329 NAME: DBIA329-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: POLICE & SECURITY USAGE: Private ENTERED: JAN 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DIP COMPONENT: EN1 VARIABLES: PRNT+1^ESPFM S L=1 G EN1^DIP ******************** 330 NAME: PSOHCSUM CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING PCE PATIENT CARE ENCOUNTER MYHEALTHEVET ORDER ENTRY/RESULTS REPORTING HEALTH SUMMARY CLINICAL CASE REGISTRIES ADDED 8/26/2010 USAGE: Controlled Subscri ENTERED: JAN 12,1994 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Provides a list of active Rxs (Active/Non-Verified/Hold/Suspend/Provider Hold) and Non-VA MEDS (Not dispensed by VA) sorted in the reverse fill date order for a given DFN. ROUTINE: PSOHCSUM COMPONENT: PSOHCSUM VARIABLES: DFN Type: Input IFN of patient in Patient file. PSOBEGIN Type: Both The date/time to begin the search for prescriptions. ~TMP("PSOO Type: Output ^TMP("PSOO",$J) should be killed before and after data is extracted for use. ^TMP("PSOO",$J,IFD,0)=ID^FD^DR^PR^ST^RX^QT^R F^IF^CF^EX^ON^R ISSUE DATE^LAST FILL DATE^DRUG^PROVIDER^STATUS^RX#^QTY^#REFILLS^I FN^COST /FILL^QTY^#REFILLS^IFN^COST/FILL^EXP/CANC DATE^CPRS ORDER#^R where: IFD = Inverse last fill date of Rx. ID = Issue date of Rx. FD = Last fill date of Rx. DR = Drug in Rx. This variable has format A;B where A is the internal pointer and B is external printable form. PR = Provider. This variable has format A;B where A is the internal pointer and B is external printable form. ST = Status of Rx. This variable has format A;B where A is the internal representation and B is external printable form. RX = Rx number. QT = Quantity of DRG in Rx. RF = Number of refills remaining. IF = IFN.of Rx in Prescription (52) file. CF = Cost/Fill. EX = Expire/Cancel date of Rx. ON = Placer order # (CPRS) R = Letter "R" only when the original fill is returned to stock. Patch PSO*7*441 added Indication ("IND") node to the Rx entry. If an Indication is populated then ^TMP("PSOO",$J,IFD,"IND")=Indication^ NON-VA Meds: added with PSO*7*132 ^TMP("PSOO",$J,"NVA",n,0)=orderable item_" "_dose form^status (active or discontinued)^start date(fm format)^cprs order # (ptr to 100)^date/time documented (fm format)^documented by (ptr to 200_";"_.01)^dc date/time(fm format) ^TMP("PSOO",$J,"NVA",n,1,0)=dosage^med route^schedule^drug (file #50_";"_.01)^clinic (file #44_";"_.01) ^TMP("PSOO",$J,"NVA",n,"DSC",nn,0)=statement /explanation ^TMP("PSOO",$J,"NVA",n,"OCK",nn,0)=order checks^overriding provider (ptr to 200_";"_.01) ^TMP("PSOO",$J,"NVA",n,"OCK",nn,"OVR",nnn,0) =override reason ~TMP("PSOO Type: Output IFD = Inverse last fill date of Rx. SIG = Medication instruction for this Rx. The value of ^TMP("PSOO",$J,IFD,n,0) ******************** 331 NAME: DBIA331 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: JAN 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other An enhancement patch will be issued to add the most recent lab results to the Action Profile. If the pharmacy supervisor wants the lab data printed, he/she selects the new option to select the drug, specimen type, and number of days back to search for lab test results. An option will be added to the pharmacy supervisor's menu. Since only one option and menu item need to be added to the OPTION (#19) file, we would like to add them by using DIC calls. We would prefer not to send inits only to add the option. Checks are made in the routine to assure that the site is running version 6.0, the option is installed only once, there are no other options with the same name, and the supervisor's menu exist. The user may run the routine many times and only install the option and menu item once. ROUTINE: ******************** 332 NAME: DBIA332 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: JAN 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The Radiology/Nuclear Medicine package is granted this DBIA to use field 53.4 of the New Person File(#200). ROUTINE: ******************** 333 NAME: DBIA333-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY MENTAL HEALTH USAGE: Controlled Subscri ENTERED: JAN 14,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File Outpatient Pharmacy is granted a temporary integration agreement with Laboratory to obtain results for a given lab test specimen type within a date range. This data may be used many different ways. Current uses are clozapine monitoring, printing on action profile, and drug usage evaluation. GLOBAL MAP DATA DICTIONARY #60 -- LABORATORY TEST FILE STORED IN ^LAB(60, SITE: BIRMINGHAM ISC ^-------------------------------------------------------------------------- ^LAB(60,D0,0)= (#.01) NAME [1F] ^^^^ (#5) LOCATION (DATA NAME) [5F] ^ ^LAB(60,D0,.2)= (#400) DATA NAME [1P] ^ ^LAB(60,D0,1,D1,0) = ^^^^^^ (#6) UNITS [7F] ^ DURATION: Till next version--LAB will incorporate an HL7 exchange ROUTINE: ******************** 334 NAME: DBIA334 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: JAN 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Outpatient Pharmacy is granted permission to enter/edit the following fields. File: New Person (#200) Field # Node;Piece Field Name .111 .11;1 STREET ADDRESS 1 .112 .11;2 STREET ADDRESS 2 .113 .11;3 STREET ADDRESS 3 .114 .11;4 CITY .115 .11;5 STATE .116 .11;6 ZIP CODE .131 .13;1 PHONE .132 .13;2 OFFICE PHONE .133 .13;3 PHONE #3 .134 .13;4 PHONE #4 .141 .14;1 ROOM ROUTINE: ******************** 336 NAME: DBIA336 CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JAN 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Problem List Application is granted permission to use the function calls, "$$GETFORM^IBDF18" and "$$COPYFORM^IBDF18". These calls are used to collect common problem lists defined under the Encounter Form Utility. By replicating the previously entered lists, the clinician is spared duplicate entry. $$GETFORM^IBDF18() Input: NONE Returned:
^ $$COPYFORM^IBDF18(FORM,ARY) Input: FORM= ien of form that has clinic common problem list ARY= Location where clinic common problem list should be copied to. ARY is accessed via indirection, as in @ARY@(1) for the first entry Returns: Length of the list ROUTINE: IBDF18 COMPONENT: $$GETFORM VARIABLES: COMPONENT: $$COPYFORM(FORM,ARY) VARIABLES: ******************** 337 NAME: DBIA337 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JAN 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Problem List Application will produce three (3) Problem List components for the Health Summary Application. These components are: ACTIVE PROBLEMS, INACTIVE PROBLEMS, and FULL PROBLEM LIST. In order to load the new components of the Ad Hoc Summary on to existing systems, the Problem List Application requests permission to use the entry point: ENPOST^GMTSLOAD Input: INCLUDE=0 Returned: Nothing ROUTINE: GMTSLOAD COMPONENT: ENPOST VARIABLES: INCLUDE Type: Input ******************** 338 NAME: DBIA338 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JAN 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142.1 ROOT: GMT(142.1, DESCRIPTION: TYPE: File The Problem List Application is granted permission to add three (3) components to the Health Summary Application's Health Summary Component File (142.1). They are: ACTIVE PROBLEMS, INACTIVE PROBLEMS and FULL PROBLEM LIST. The new components will be added in a post-init using ^DIC. The components are installed using code provided to us by the Health Summary developers. FileMan variables DIC, DIC(0), DLAYGO, DINUM, and X are set to add each component to the Health Summary Component file if it's not already there; entry numbers 59-61 were given to the Problem List pkg to use for these components. Once entered into the file, DR is set and DIE called to stuff in the values of the other fields. The following was added on 4/12/94: To support the addition of new components to the Health Summary Application, the following actions are taken in the post-init. 1. Routine GMPLHSPL is renamed to GMTSPLST. 2. The post-init sets ^GMT(142.1,DA,3.5 nodes. ROUTINE: ******************** 341 NAME: DBIA341 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JUN 25,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Problem List Application is granted permission from Scheduling to use the entry point "DIS^SDROUT2". This will display a patient's service connected data for the clinician. DIS^SDROUT2 Input: DFN Returned: Display of patient's service-connected data. ROUTINE: SDROUT2 COMPONENT: DIS VARIABLES: DFN Type: Input ******************** 342 NAME: DBIA342 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: JAN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The Problem List Application is granted permission for the addition of the following fields to the NEW PERSON FILE (^VA(200,)). Also granted is permission to read and write to these fields as appropriate. These fields are used to tailor the Problem List Application for individual use. 125 PRIMARY VIEW 125.01 PROBLEM LIST SEARCH FILTER 125.02 PROBLEM LIST DISPLAY CODES 125.03 PROBLEM VOCABULARY 125.1 PROBLEM SELECTION LIST ROUTINE: ******************** 343 NAME: DBIA343 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: JAN 25,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine It is agreed that MailMan can call XQSRV for servers. MailMan sends XQSRV: XMZ, XMXX, XMFROM, XMCHAN, XMSEN, XMREC & XMB("TYPE"). ROUTINE: XQSRV COMPONENT: XQSRV VARIABLES: XMZ Type: Input XMXX Type: Input XMFROM Type: Input XMCHAN Type: Input XMXEN Type: Input XMREC Type: Input XMB('TYPE' Type: Input ******************** 345 NAME: DBIA345-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: FEB 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Read only access for the ^DD( Global Read ^DD(FN), where FN is a file number, to determine the existence of a file prior to initiating a look-up (GMPTA4). Read ^DD(757*,FLD in indexing routines to obtain the location (node/piece) of data in Clinical Lexicon files 757-757.3 prior to eXecuting Set/Kill logic (GMPTNDX2). ROUTINE: ******************** 346 NAME: DBIA346-A CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: FEB 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.1 ROOT: XT(8984.1, DESCRIPTION: TYPE: File Read only access to ^XT(8984.* globals for $D checks in the Environment Check routine prior to installing the Clinical Lexicon (GMPTIENV). i.e. I '$D(^XT(8984.1)) W !,"Multi-Term Look-Up Untility not found" K DIFQ Q Read/Write access to ^XT(8984.* global in Post-Init routines to setup the Multi-Term Look-Up Utility for the Clinical Lexicon (GMPTIPST). i.e., a. Seeding the Local Look-Up file #8984.4 with the Clinical Lexicon Expression file #757.01, the "AWRD" index and the XTLK^GMPTPRNT display routine. b. Seeding the Synonym file #8984.3 with Cancer as a sample synonym for Carcinoma c. Seeding the Short Cut file #8984.2 with DM II as a sample short cut for Diabetes Mellitus, Non-Insulin Dependent ROUTINE: ******************** 347 NAME: DBIA347 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: FEB 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Problem List Application has permission to use of the entry point "IN^OR" for patient selection, using the OE/RR patient lookup engine and resetting of all needed OE/RR patient variables within the OE/RR context. The OE/RR variable ORVP is checked for (via $D) to see if PL was invoked from within OE/RR; if so, and the user wishes to switch to a different patient, this call will pass control to OE/RR to do the prompting and resetting of any important OE/RR patient variables. Problem List only references ORVP on return. It should be noted that the call to IN^OR is only made if the Problem list application is being selected from within the Order Entry application itself. Therefore the PL application simply has a screen to check for ORVP. If it exists it knows that it is within OE/RR and and only calls IN^OR if the SP (select Patient) action is selected before exiting the PL mode. This call updates the variables within OE so that it will not return to the previous patient when PL is exited. OE/RR is responsible for setting and killing all OR variables. IN^OR Input: ORVP Returned: ORVP ROUTINE: ORVP COMPONENT: IN VARIABLES: ORVP Type: Both ******************** 348 NAME: DBIA348 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: FEB 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Problem List has permission to access File #2, Field #.32201. This will allow supported reference to draw Persian Gulf duty information from the Patient File. ROUTINE: ******************** 349 NAME: DBIA349 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: FEB 17,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMTSDVR COMPONENT: ENX VARIABLES: DFN Type: Input Patient file record number GMTSTYP Type: Input Health Summary Type file record number (142) DIROUT Type: Output =1 if '^^' is entered. This entry point is called to print a pre-defined health summary. Radiology uses this call to print a site-defined health summary along with the Radiology Request form. COMPONENT: ENXQ VARIABLES: DFN Type: Input Patient file record number GMTSTYP Type: Input Health summary Type file record number (142) This entry point is called to task the printing of a pre-defined health summary in the following manner: S ZTRTN="ENXQ^GMTSDVR",ZTSAVE("GMTSTYP")="",ZTSAVE("DFN")="" D ^%ZTLOAD ******************** 350 NAME: DBIA350 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: FEB 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File I. Direct read access to the DPT global. A. ^DPT("SSN") -> Used to obtain a list of all patient SSN's currently on file. These SSN's are then compared to the SSN's on the MPD CDROM to check for visits to other hospitals. B. ^DPT(DFN) -> Used to verify that a patient is in the file. C. ^DPT(DFN,"S",DATE,0) -> Used to verify that a clinic appointment has not been canceled. II. The addition of a Mumps cross-reference to the SSN field for the purpose of setting the SSN in the PPP NEW SSN file. Any new SSN's will be checked at night for visits to other hospitals and then deleted from the PPP NEW SSN file. We suggest the Mumps cross-reference be implemented as follows: SET -> S PPP=X,X="PPPFMX" X ^%ZOSF("TEST") D:$T SNSSN^PPPFMX S X=PPP K PPP KILL -> S PPP=X,X="PPPFMX" X ^%ZOSF("TEST") D:$T KNSSN^PPPFMX S X=PPP K PPP The referenced routines are as follows: SNSSN ; N PPPNOD0,PPPTR N ZTRTN,ZTIO,ZTDTH,ZTDESC,ZTSAVE ; ; Check that this is either an edit or a new entry to avoid ; setting during a re-index of the Patient file. ; PPPOK is defined in the kill logic below if the new entry ; does not equal the old. ; DPTDFN is defined in the Patient Registration routines. ; I ($D(PPPOK))!($D(DPTDFN)) D .S PPPNOD0=$G(^PPP(1020.7,0)) .Q:PPPNOD0="" .; .; Get the File Descriptor Node for updating. .; .S PPPTR=$P(PPPNOD0,"^",4) .; .; Set the entry and the "B" Xref .; .S ^PPP(1020.7,DA,0)=X .S ^PPP(1020.7,"B",X,DA)="" .; .; Update the Descriptor node. .; .S $P(PPPNOD0,"^",3)=DA .S $P(PPPNOD0,"^",4)=PPPTR+1 .S ^PPP(1020.7,0)=PPPNOD0 .; .; Task out the MPD lookup. .; .S ZTRTN="NEWSSN^PPPBLD5" .S ZTIO="" .S ZTDTH=$H .S ZTDESC="NEW SSN/MPD ROUTINE" .S ZTSAVE("PPPSSN")=PPP .S ZTSAVE("PPPIFN")=DA .D ^%ZTLOAD ; K PPPOK Q KNSSN ; N PPPNOD0 ; ; Check that this is an edit and not a re-index. ; I X'=$P($G(^DPT(DA,0)),"^",9) D .S PPPOK=1 .; .; Check that the node currently exists, kill it if it does. .; .I $D(^PPP(1020.7,"B",PPP)) D ..K:$D(^PPP(1020.7,DA)) ^(DA) ..K:$D(^PPP(1020.7,"B",PPP,DA)) ^(DA) ..; ..; If the record count is alredy 0 then quit. ..; ..S PPPNOD0=^PPP(1020.7,0) ..Q:+$P(PPPNOD0,"^",4)=0 ..S $P(PPPNOD0,"^",4)=$P(PPPNOD0,"^",4)-1 ..S ^PPP(1020.7,0)=PPPNOD0 ROUTINE: ******************** 352 NAME: DBIA352 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: FEB 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File PCE (PX) is granted permission to execute the DD nodes for completing cross-references in the 9000001 file from within cross-reference logic on the Social Security (.09) field in the Patient file. There is a Regular "B" cross-reference on the .01 field (NAME) of the PATIENT/IHS file (9000001). There is also a Regular "D" cross- reference on the .02 field of the 9000001.41 Health Record Number multiple. Since the fields in the 9000001 file are being populated from during the execution of the Patient File (2) PX09 cross- reference, the DD logic for setting these cross-references is being handled by executing the 9000001 and 9000001.41 DD nodes with the set and kill logic. Routine PXXDPT executes the set logic of the 'B' cross reference of file 9000001, (Patient/IHS File), field .01 (Name). It also executes the set and kill logic of the 'D' whole file cross reference of subfile 9000001.41, (Health Record Fac), field .02 (Health Record No.) In V21 of FileMan, the entry points in ^DIK that reindex cross references are reentrant. Thus, direct execution of set/kill logic will not be necessary. Also PCE's Debugging Utility does a Global Read in the form of '$D(^DD(2,.09,1,800)) to check that the cross reference to update the PATIENT/IHS file (#9000001) exists. ROUTINE: ******************** 353 NAME: DBIA353 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: FEB 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCPUX1 COMPONENT: $$DESCR(X,Y) VARIABLES: X Type: Input pointer to an inventory point in the GENERIC INVENTORY (#445) file. The value of '0' is always passed as this parameter. Y Type: Input pointer to an item in the ITEM MASTER (#441) file. Output: Short Description of the item from the ITEM MASTER file. Purpose: The short description describes the name of the Prosthetic device which is being billed on a claim to an Insurance company. ******************** 354 NAME: DBIA354 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: FEB 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMPLENFM COMPONENT: ACTIVE VARIABLES: 1) Permission granted to call ACTIVE^GMPLENFM for the purpose of obtaining a list of the patient's active problems. Requires DFN = ien of patient in File #2 Returns the data in the ^TMP global as follows, at the request of IB - ^TMP("IB",$J,"INTERFACES",DFN,"GMP PATIENT ACTIVE PROBLEMS",#) = Piece 1: Text of problem 2: ICD code of problem 3: Date of Onset in 00/00/00 format 4: "SC" or "NSC" or "", if problem is [not] related to a SC Cond. 5: "Y" or "N" or "", if problem is [not] related to a SC Condition (Pieces 4 and 5 give the same data, just in different formats.) 6: "A" or "I" or "P" or "H" or "M" or "C" or "S" or "L" or "", if problem is related to exposure to Agent Orange, Ionization, Persian Gulf, Head and/or Neck Cancer, Military Sexual Trauma, Combat Veteran, SHAD, Camp Lejeune or null respectively 7: Full text of the special exposure indicated in piece 6, if any where each # is a different problem, 1 - n with n being the total number of active problems; the 0-node is also set to the total (n). COMPONENT: SELECT VARIABLES: 2) Permission granted to call SELECT^GMPLENFM for the purpose of allowing users access to the EXPRESSIONS file to create lists of Clinic Common Problems. SELECT^GMPLENFM is used for the lookup rather than a simple ^DIC call in order to setup the Problem List context for searching the Lexicon. Requires no input values. Returns the entry in the Lexicon Utility selected to add to a form as a commonly selected problem in the ^TMP global as follows, as requested - ^TMP("IB",$J,"INTERFACES","GMP SELECT CLINIC COMMON PROBLEMS") = Piece 1: IEN of problem in Lexicon Utility's Expressions file (#757.01) 2: Text of problem 3: ICD Code of problem, if known ******************** 355 NAME: DBIA355 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Read access to the following fields and cross-references: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER **APPOINTMENT DATE/TIME PATIENT 1 1900 2 2 .001 2.98 **APPOINTMENT STATUS PATIENT 1 1900 2 2 3 2.98 **APPOINTMENT TYPE PATIENT 1 1900 2 2 9.5 2.98 **APPT. CANCELLATION REASON PATIENT 1 1900 2 2 16 2.98 **CLINIC PATIENT 1 1900 2 2 .01 2.98 (The above fields related to field 1900 will be eliminated with the scheduling redesign.) **DATE OF ENROLLMENT PATIENT XREF: AEB ROUTINE: ******************** 357 NAME: DBIA357 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Read access to the following fields and cross-references. FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER DATE OF DEATH PATIENT 1 .351 2 DISPOSITION PATIENT 1 1000 2 2 6 2.101 LOG IN DATE/TIME PATIENT 1 1000 2 2 .01 2.101 LOG IN STATUS PATIENT 1 1000 2 2 1 2.101 LOG OUT DATE/TIME PATIENT 1 1000 2 2 5 2.101 PURPOSE OF VISIT PATIENT 1 1900 2 2 9 2.98 REASON FOR LATE DISPOSITION PATIENT 1 1000 2 2 8 2.101 SERVICE CONNECTED PERCENTAGE PATIENT 1 .302 2 SERVICE CONNECTED? PATIENT 1 .301 2 SPINAL CORD INJURY PATIENT 1 $ 57.4 2 TYPE OF BENEFIT APPLIED FOR PATIENT 1 1000 2 2 2 2.101 TYPE OF CARE APPLIED FOR PATIENT 1 1000 2 2 2.1 2.101 CROSS REFERENCES: DATE OF BIRTH PATIENT XREF: ADOB SEX PATIENT XREF: ASX **DATE OF ENROLLMENT PATIENT XREF: AEB DATE OF DEATH PATIENT XREF: AEXP1 LOG IN DATE/TIME PATIENT XREF: ADIS ROUTINE: ******************** 358 NAME: DBIA358 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM CLINICAL PROCEDURES TEXT INTEGRATION UTILITIES SCHEDULING USAGE: Controlled Subscri ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Read access to the following fields and cross-references. FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER TYPE OF MOVEMENT PATIENT MOVEMENT 1 .04 405 WARD LOCATION PATIENT MOVEMENT 1 .06 405 TRANSACTION TYPE PATIENT MOVEMENT 1 .02 405 ROOM-BED PATIENT MOVEMENT 1 .07 405 ADMITTED FOR SC CONDITION? PATIENT MOVEMENT 1 .11 405 ADMITTING REGULATION PATIENT MOVEMENT 1 .12 405 ATTENDING PHYSICIAN PATIENT MOVEMENT 1 .19 405 DIAGNOSIS [SHORT] PATIENT MOVEMENT 1 .1 405 FACILITY TREATING SPECIALTY PATIENT MOVEMENT 1 .09 405 MAS MOVEMENT TYPE PATIENT MOVEMENT 1 .18 405 MOVEMENT DATE/TIME PATIENT MOVEMENT 1 .01 405 PRIMARY CARE PHYSICIAN PATIENT MOVEMENT 1 .08 405 ^DGPM( 200 WARD AT DISCHARGE computed Read w/Fileman ROUTINE: ******************** 359 NAME: DBIA359 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER PATIENT PTF 1 .01 & 45 PTF ADMISSION DATE PTF 1 2 45 PTF DISCHARGE DATE PTF 1 70 45 PTF DISCHARGE SPECIALTY PTF 1 71 45 PTF DRG PTF 1 9 45 PTF DXLS PTF 1 79 45 PTF ICD 10 PTF 1 79.24 45 PTF ICD 2 PTF 1 79.16 45 PTF ICD 3 PTF 1 79.17 45 PTF ICD 4 PTF 1 79.18 45 PTF ICD 5 PTF 1 79.19 45 PTF ICD 6 PTF 1 79.201 45 PTF ICD 7 PTF 1 79.21 45 PTF ICD 8 PTF 1 79.22 45 PTF ICD 9 PTF 1 79.23 45 PTF PROCEDURE 1 PTF 1 45.01 45 PTF PROCEDURE 2 PTF 1 45.02 45 PTF PROCEDURE 3 PTF 1 45.03 45 PTF PROCEDURE 4 PTF 1 45.04 45 PTF PROCEDURE 5 PTF 1 45.05 45 PTF TYPE OF DISPOSITION PTF 1 72 45 PTF WARD AT DISCHARGE PTF 1 2.2 45 SURGERY/PROCEDURE DATE PTF 1 401 45 2 .01 45.01 OPERATION CODE 1 PTF 1 401 45 2 8 45.01 OPERATION CODE 2 PTF 1 401 45 2 9 45.01 OPERATION CODE 3 PTF 1 401 45 2 10 45.01 OPERATION CODE 4 PTF 1 401 45 2 11 45.01 OPERATION CODE 5 PTF 1 401 45 2 12 45.01 CROSS REFERENCES: CLOSE OUT DATE PTF CLOSE OUT XREF: AC DATA GLOBAL PTF XREF: ^DGPT(D0,"S",D1,... ^ |-- SURGERY/PROCEDURE DATE| ROUTINE: ******************** 360 NAME: DBIA360 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.3 ROOT: DG(405.3, DESCRIPTION: TYPE: File Read access to the following fields: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER MAS MOVEMENT TRANSACTION TYPE MAS MOVEMENT TRANSACTION TYPE 1 .01 405.3 ROUTINE: ******************** 361 NAME: DBIA361 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 37 ROOT: DIC(37, DESCRIPTION: TYPE: File Read access to the following fields: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER NAME DISPOSITION 1 .01 37 ROUTINE: ******************** 362 NAME: DBIA362 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File Read access to the following fields: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER NAME FACILITY TREATING SPECIALTY 1 .01 45.7 FACILITY TREATING SPECIALTY SERVICE 1 2 45.7 ROUTINE: ******************** 363 NAME: DBIA363 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM DSS - DECISION SUPPORT SYSTEM EX LAB SERVICE ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.2 ROOT: DG(405.2, DESCRIPTION: TYPE: File Read access to the following fields: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER NAME MAS MOVEMENT TYPE 1 .01 405.2 ^DG(405.2,D0,0) .02 TRANSACTION TYPE 0;2 Direct Global Read & w This field contains a pointer to the MAS MOVEMENT TRANSACTION TYPE file containing the allowable types of bed control movements (admissions, discharges, transfers, lodger movements, etc.). This file holds all MAS accepted/approved movement types. ROUTINE: ******************** 366 NAME: DBIA366 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: MAR 3,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 80.1 ROOT: ICD0( DESCRIPTION: TYPE: File Read access to the following Fields: FIELDS: ELEMENT FILE DD LEVEL FIELD # DD NUMBER CODE NUMBER ICD OPERATION/PROCEDURE 1 .01 80.1 ROUTINE: ******************** 367 NAME: DBIA367 CUSTODIAL PACKAGE: LIST MANAGER SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 9,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Request: Use of the routine calls REFRESH^VALM and RESET^VALM4:VALMCC Input: none Output: none Purpose: These calls are used to refresh the screen and reset the scrolling area while program control remains within an action (as opposed to performing the same action when exiting an action, which is accomplished by setting VALMBCK="R"). Request permission to set the variable VALM("PROTOCOL"). The purpose of setting this variable is to be able to define the specific protocol to be executed for a list template, as opposed to defining three identical list templates, all with different protocol menus. Resetting VALM("PROTOCOL") resets the protocol menu. This allows having the same list manager definitions for a screen that may have different input capabilities, for example one with input and one just view only actions. RESET^VALM4 can ONLY be called if VALMCC is high(1) The context for these calls are as follows: The calls will be made within a List Manager application, specifically within various options of the Encounter Form Utilities. The reason for making the calls is that we want to be able to display an encounter form in the top part of the screen while having a dialogue with the user in the bottom part of the screen. The problem is that it is necessary to call FileMan at certain points within the dialogue. FileMan assumes it has the entire screen at its disposal, so when it communicates with the user the display#is likely to scroll out of the scrolling area on the bottom of the screen, so the user is unable to read what FileMan displays. To avoid that, what we do is: 1) Everywhere FileMan is called in the situation described above we call FULL^VALM1. That sets the scrolling area to the entire screen. 2) When the problem point is passed and we want to continue the dialogue with the encounter form displayed at the top we call REFRESH^VALM to redraw the screen. Then we call RESET^VALM4 to reset the scrolling area so that the dialogue can occur on the bottom of the screen with the form displayed at the top. VALMCC is an input variable to RESET^VALM4. VALMCC must test true or RESET^VALM4 should not be called. There are dozens of variables that are set by the List Manager, but those are part of the internal workings of the List Manager and are not the concern of this application. There are some List Manager variables that the application is responsible for setting, but those are well documented by the List Manager, i.e., they are not specific to calling these entry points. The context is that the List Manager has been called. Then, from within the List Manager, the user has selected an action, which invokes a protocol. The protocol invokes a routine, which is where those calls are made. ROUTINE: VALM COMPONENT: REFRESH VARIABLES: VALMCC Type: Input ******************** 371 NAME: DBIA371 CUSTODIAL PACKAGE: DRG GROUPER SUBSCRIBING PACKAGE: INTEGRATED BILLING REGISTRATION LEXICON UTILITY Lexicon queries files 80 and 80.1, and calculates DRG group to verify that versioned data is correct. Effective with LEX*2.0*80. USAGE: Controlled Subscri ENTERED: MAR 9,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ICDDRG COMPONENT: ICDDRG VARIABLES: ICDEXP Type: Input Did patient expire during episode? ICDTRS Type: Input Patient transfer to acute facility? ICDDMS Type: Input Patient have irregular discharge? ICDDX(1,2, Type: Input Set of pointers (X) to diagnosis codes in file #80. ICDPRC(1,2 Type: Input Set of pointers (X) to procedures in file #80.1. SEX Type: Input Patient gender (M-Male|F-Female)| ICDPOA(1,2 Type: Input Set of values (Y,N,W,U OR BLANK) corresponding to ICDDX input array to indicate Presence on Admission ICDDRG Type: Output Pointer to assigned DRG in file #80.2 ICDDATE Type: Input The date of service (optional parameter, the default value is DT - today's FileMan date). The routine call is made to calculate interim DRGs to determine the expected length of stay for a visit. Changes were made to this ICR to add the ICDDATE parameter in July 2014. The ICD-10 team's analysis did not find calls to the ICDDRG API in the YS* routine namespace. ******************** 372 NAME: DBIA372 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 9,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File Integrated Billing requests permission to add entries to the INSTITUTION (#4) when creating bills. The user is required to hold the IB SUPERVISOR security key to add entries into file #4. ROUTINE: ******************** 373 NAME: DBIA373 CUSTODIAL PACKAGE: PROSTHETICS SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 660 ROOT: RMPR(660, DESCRIPTION: TYPE: File ^RMPR(660, .01 ENTRY DATE 0;1 Pointed to .02 PATIENT NAME 0;2 Read w/Fileman 4 ITEM 0;6 Read w/Fileman 7 VENDOR 0;9 Read w/Fileman 10 DELIVERY DATE 0;12 Read w/Fileman 12 SOURCE 0;14 Read w/Fileman 14 TOTAL COST 0;16 Read w/Fileman 15 HISTORICAL DATA 0;15 Read w/Fileman 62 PATIENT CATEGORY AM;3 Read w/Fileman 30 PRIMARY ICD DIAGNOSI BA1;1 Read w/Fileman 30.1 PRIMARY AGENT ORANGE BA1;2 Read w/Fileman 30.2 PRIMARY IONIZED RADI BA1;3 Read w/Fileman 30.3 PRIMARY SERVICE-CONN BA1;4 Read w/Fileman 30.5 PRIMARY MST BA1;6 Read w/Fileman 30.4 PRIMARY ENVIRONMENTA BA1;5 Read w/Fileman 30.6 PRIMARY HEAD/NECK CA BA1;7 Read w/Fileman 30.7 PRIMARY COMBAT VET BA1;8 Read w/Fileman 31 SECONDARY ICD DIAGNO BA2;1 Read w/Fileman 31.1 SECONDARY AGENT ORAN BA2;2 Read w/Fileman 31.2 SECONDARY IONIZED RA BA2;3 Read w/Fileman 31.3 SECONDARY SERVICE-CO BA2;4 Read w/Fileman 31.4 SECONDARY ENVIRONMEN BA2;5 Read w/Fileman 31.5 SECONDARY MST 1 BA2;6 Read w/Fileman 31.6 SECONDARY HEAD/NECK BA2;7 Read w/Fileman 31.7 SECONDARY COMBAT VET BA2;8 Read w/Fileman 32 SECONDARY ICD DIAGNO BA3;1 Read w/Fileman 32.1 SECONDARY AGENT ORAN BA3;2 Read w/Fileman 32.2 SECONDARY IONIZED RA BA3;3 Read w/Fileman 32.3 SECONDARY SERVICE-CO BA3;4 Read w/Fileman 32.4 SECONDARY ENVIR. CON BA3;5 Read w/Fileman 32.5 SECONDARY MST 2 BA3;6 Read w/Fileman 32.6 SECONDARY HEAD/NECK BA3;7 Read w/Fileman 32.7 SECONDARY COMBAT VET BA3;8 Read w/Fileman 33 SECONDARY ICD DIAGNO BA4;1 Read w/Fileman 33.1 SECONDARY AGENT ORAN BA4;2 Read w/Fileman 33.2 SECONDARY IONIZED RA BA4;3 Read w/Fileman 33.3 SECONDARY SERVICE-CO BA4;4 Read w/Fileman 33.4 SECONDARY ENVIRON. C BA4;5 Read w/Fileman 33.5 SECONDARY MST 3 BA4;6 Read w/Fileman 33.6 SECONDARY HEAD/NECK BA4;7 Read w/Fileman 33.7 SECONDARY COMBAT VET BA4;8 Read w/Fileman ^RMPR(660,'B',date) $O through cross reference to find potentially billable prosthetic items. ^RMPR(660,'CT',DATE) $O through cross reference to find prosthetic items which may have been delivered to a patient within a specific date range. ^RMPR(660,'C', $O through the "C" x-ref. ^RMPR(660,'AF', $O through the "AF" x-ref by date. ROUTINE: ******************** 374 NAME: DBIA374 CUSTODIAL PACKAGE: PROSTHETICS SUBSCRIBING PACKAGE: INTEGRATED BILLING IFCAP USAGE: Controlled Subscri ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 661 ROOT: RMPR(661, DESCRIPTION: TYPE: File ^RMPR(661,D0,0) .01 NAME 0;1 Direct Global Read & w Field is also pointed to from IB files. ROUTINE: ******************** 376 NAME: DBIA376 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442.3 ROOT: PRCD(442.3, DESCRIPTION: TYPE: File See DBIA375. ^PRCD(442.3,'AC', Read acces to check if the Procurement and Accounting Transaction has already been completed. ROUTINE: ******************** 377 NAME: DBIA377 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: pre-CoreFLS FILE: 424.1 ROOT: PRC(424.1, DESCRIPTION: TYPE: File See DBIA375 ^PRC(424.1,D0,0) .03 AUTHORIZATION AMOUNT 0;3 Write w/Fileman .04 DATE/TIME 0;4 Write w/Fileman .05 USER 0;5 Write w/Fileman .08 REFERENCE 0;8 Write w/Fileman .1 LAST EDITED BY 0;10 Write w/Fileman ROUTINE: ******************** 378 NAME: DBIA378 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: Routine See DBIA375 ROUTINE: PRCH58 COMPONENT: BALUP VARIABLES: PODA Type: Input ien of file 442 BAL1 Type: Input Authorization Amount. Updates field #96 (Estimated 1358 Balance) in file 442. ******************** 379 NAME: DBIA379 CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call allows billing clerks to place requests for HINQs for patients with unverified eligibility who are going to be billed. ROUTINE: DVBHQZ4 COMPONENT: EN VARIABLES: DFN Type: Input Points to patient file. ******************** 380 NAME: DBIA380 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The following function calls are made to the routine PRCAFN. The input X for each call is the internal entry number of an entry in the BILL/CLAIMS (#399) file, which is dinumed to the ACCOUNTS RECEIVABLE (#430) file. Each function will return -1 if a legitimate value cannot be returned. Also note that these functions only work for categories of receivables which are not PATIENT or MEANS TEST PATIENT (except for the PST, PUR, and CATN functions). ROUTINE: PRCAFN(X) COMPONENT: $$BN VARIABLES: This returns the receivable bill number. COMPONENT: $$CAT VARIABLES: This function returns the receivable category (pointer to file #430.2). COMPONENT: $$CLO VARIABLES: This function returns the date that a receivable was closed (or -1 if the receivable is not closed). COMPONENT: $$ORI VARIABLES: This function returns the receivable Original Amount. COMPONENT: $$PUR VARIABLES: This function is called by the IB purge routines and is used to determine the date that a receivable was closed out. COMPONENT: $$RETN VARIABLES: This function determines whether a bill has the AR Status RETURNED FROM AR (NEW) in Accounts Receivable. The call is made to determine whether a bill has been returned to billing and is thus editable in Integrated Billing. COMPONENT: $$STA VARIABLES: This function returns the receivable status. COMPONENT: $$TPR VARIABLES: This function returns the total paid principal on the receivable. COMPONENT: $$PST VARIABLES: X Type: Input Equals the string DFN_";DPT(" being the pointer to the patient in file #2) This call is made to retrieve the day of the month that a patient's statement is generated. COMPONENT: $$CATN VARIABLES: X Type: Input Pointer to the category in file 430.2 This call is made to retrieve the AR Category name. ******************** 381 NAME: DBIA381 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This Accounts Receivable routine is the entry point for the Returned Bill List output. The routine is invoked by the Integrated Billing option IB RETURN BILL LIST. ROUTINE: PRCALST COMPONENT: RETN VARIABLES: ******************** 382 NAME: DBIA382 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine call displays the number of bills that have been returned to the service from Fiscal. There is no variable input required to make the call. This routine is invoked as an Entry Action of the following Integrated Billing menu options: IB BILLING CLERK MENU IB BILLING SUPERVISOR MENU IB RETURN BILL MENU ROUTINE: PRCAUT2 COMPONENT: COUNT VARIABLES: ******************** 383 NAME: DBIA383 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is used in Pharmacy copay exemption processing to cancel Pharmacy copay charges who become exempt from copay. ROUTINE: PRCAX(DFN,BEG,E COMPONENT: EN1 VARIABLES: DFN Type: Input Patient pointer BEG Type: Input Begin date to cancel Pharmacy copay charges. END Type: Input End date to cancel Pharmacy copay charges. ERR Type: Input Set to 0, used to return an error condition. ERR Type: Output Free-text error, if an error condition occurs. ******************** 384 NAME: DBIA384 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is made just prior to passing a claim to the Accounts Receivable package. This routine call performs a check on all data required to establish a receivable and passes errors back to Integrated Billing. ROUTINE: PRCASVC6 COMPONENT: PRCASVC6 VARIABLES: PRCASV('BD Type: Input Date bill generated (fileman date format) PRCASV('AR Type: Input Record # of 430. PRCASV('DE Type: Input Debtor (ex.'4;DPT(','3;DIC(36,' OR '3;DIC(4') PRCASV('PA Type: Input Patient pointer. PRCASV('CA Type: Input Category pointer to 430.2 PRCASV('FY Type: Input Fiscal year,amount (multiple) (FY^AMOUNT^FY^AMOUNT) PRCAXV('CA Type: Input For only means test c-type of bill two digits: 1st digit :nursing home care 2nd digit :in or outpatient PRCASV('AP Type: Input Person approved the bill, pointer to 200) PRCSAV('2N Type: Input 2nd insurance company (pointer to 36) PRCASV('3R Type: Input 3rd ins. company (pointer to 36) PRCASV('ID Type: Input Primary ins. policy number. PRCASV('GP Type: Input Prim. ins. group number. PRCASV('GP Type: Input Prim. ins. group name. PRCASV('IN Type: Input Prim. ins. insured patient. PRCASV('OK Type: Output Flag - bill passes checks. PRCAERR Type: Output -1^ERROR CODE to IB ERROR file. ******************** 385 NAME: DBIA385 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is used to pass a new or returned bill to the Accounts Receivable package. This call is made right after the call D ^PRCASVC6, if that call returns PRCASV("OKAY") as a positive number. ROUTINE: PRCASVC COMPONENT: REL VARIABLES: Input: same as the call to D ^PRCASVC6 Output: same as the call to D ^PRCASVC6 ******************** 386 NAME: DBIA386 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call sets up a stub receivable in Accounts Receivable. The internal entry number for the receivable is used as the internal entry number of the bill in the BILL/CLAIMS (#399) file. ROUTINE: PRCASVC3 COMPONENT: SETUP VARIABLES: PRCASV('SE Type: Input MAS Service pointer in file 49 PRCASV('SI Type: Input Station Number PRCASV('AR Type: Both Pointer to the receivable in file 430 With IB*2.0*433/PRCA*4.5*270 Preserve Claim # Patch, this variable was changed from Output to Both. If the user comes from the new CRD option, ARREC will be set to the internal bill# of the copied FROM claim/bill. PRCASV('AR Type: Both Bill number of the receivable. With IB*2.0*433/PRCA*4.5*270 Preserve Claim # Patch, this variable was changed from Output to Both. If the user comes from the new CRD option, ARBIL will be set to the external bill# of the copied FROM claim/bill. PRCASV('AR Type: Input This variable is a flag indicating that the user came from the new CRD option. CRD is the new Correct Rejected/Denied Claim option introduced with IB*2.0*433/PRCA*4.5*270 - Preserve Claim #. If the user came from CRD (PRCASV('ARCRD')=1),then the original claim/AR# will be assigned an iteration # (ie. -01), and the newly created claim/AR entry will retain the original claim#. PRCASV('AR Type: Input This new variable was introduced w/IB*2.0*433/PRCA*4.5*270-Preserve Claim #. If the user came from the new CRD option (Correct/Reject Denied Claim), this variable will contain the original bill# PLUS the iteration # that needs to be added to the corrected FROM claim/bill# (ie. K00001-01). ******************** 387 NAME: DBIA387 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These calls are made when a bill is cancelled in Integrated Billing. If the receivable has the AR Status of New Bill, Bill Incomplete, or Returned From AR (NEW), the bill is cancelled using the call D CANCEL^PRCASVC1; otherwise, the bill is amended using the call D AMEND^PRCASVC1. ROUTINE: PRCASVC1 COMPONENT: CANCEL VARIABLES: PRCASV('AM Type: Input Amended Amount (difference between original amount and the amend ment total amount) PRCASC('DA Type: Input Date Bill Amended PRCASC('BY Type: Input Amended by (points to 200) PRCASV('AR Type: Input Pointer to the receivable in file 430 PRCASV('CO Type: Input Comments for the amendment COMPONENT: AMEND VARIABLES: Same input variables as entry point CANCEL. COMPONENT: STATUS VARIABLES: PRCASV('AR Type: Input This is a pointer to the receivable in file #430 which needs to have the Current Status updated. PRCASV('ST Type: Input This is a pointer to the Current Status in the ACCOUNTS RECEIVABLE TRANS.TYPE (#430.3) file to which the receivable is being updated. This call is used to set the Current Status (#8) of a receivable in the Accounts Receivable (#430) file when a CHAMPVA subsistence charge is being created. The Current Status is set to PENDING CALM CODE, if the site is running AR v4.0 (or lower). Otherwise, the Current Status is set to ACTIVE. ******************** 388 NAME: DBIA388 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is used to find the internal entry number for a bill in file #430, so it may be used as input to the function $$PUR^PRCAFN(X). Note that a check is done to determine if the routine RCFN03 exists on the system before the call is made. ROUTINE: RCFNO3(X) COMPONENT: $$BIEN VARIABLES: X Type: Input AR Bill number. Returns the ien for the bill in file 430. ******************** 389 NAME: DBIA389 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 15,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 430 ROOT: PRCA(430, DESCRIPTION: TYPE: File Integrated Billing has permission to reference this file in a ^DIC call to do a look-up on the bill number. It also has permission to access the following fields and cross-references: ^PRCA(430,'B',BN) Request direct access to the "B" cross reference of the ACCOUNTS RECEIVABLE (#430) file to determine the internal entry number for a receivable [S IEN=$O(^PRCA(430,"B",BN,0))]. This call is made when purging Pharmacy copay charges, in order to determine the input for the function call $$PUR^PRCAFN(IEN). Integrated Billing will no longer need direct access to this cross reference once the routine RCFN03 is available. This routine is checked for and called to get the same information. ^PRCA(430,'AC',STS,BN) This cross-reference is used by various reports in the Diagnostic Measures module to retrieve receivables of a specific status, i.e. Active. Some examples of the reports that use this cross-reference are: First Party Follow-up Report, Repayment Plan Follow-up Report, AR Productivity Report, among others. ^PRCA(430,BN,0) .01 BILL NO. 0;1 Direct Global Read & w 9 DEBTOR 0;9 Read w/Fileman 2 CATEGORY 0;2 Direct Global Read & w 10 DATE BILL PREPARED 0;10 Direct Global Read & w These fields are being displayed in various reports in the Diagnostic Measures module. Some examples of these reports are: Miscellaneous Bills Follow-up report, Repayment Plan report, among others. ^PRCA(430,BN,7) 71 PRINCIPAL BALANCE 7;1 Direct Global Read & w 72 INTEREST BALANCE 7;2 Direct Global Read & w 73 ADMINISTRATIVE COST 7;3 Direct Global Read & w 74 MARSHAL FEE 7;4 Direct Global Read & w 75 COURT COST 7;5 Direct Global Read & w The fields 71-75 are being used in the calculation of the account balance for the patient in two Diagnostic Measures reports: First Party Follow-up and Repayment Plan Follow-up reports. ^PRCA(430,BN,9) 97 PROCESSED BY (SERVIC 9;8 Read w/Fileman This field is being displayed by the Miscellaneous Bills Follow-up report. This report belongs to the Diagnostic Measures module. ^PRCA(430,BN,12) 121 DATE SENT TO DMC 12;1 Read w/Fileman This field is used by the First Party Follow-up report in the Diagnostic Measures module. It uses it to identify if a receivable has been referred to DMC. ^PRCA(430,BN,14) 141 DATE BILL REFERRED T 14;1 Direct Global Read & w This field is used by the First Party Follow-up report in the Diagnostic Measures module. It uses it to identify if a receivable has been referred to TOP. ^PRCA(430,BN,6) 64 REFERRAL DATE 6;4 Direct Global Read & w This field is used by the First Party Follow-up report in the Diagnostic Measures module. It uses it to identify if a receivable has been referred to RC. ROUTINE: ******************** 390 NAME: DBIA390 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAR 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File See DBIA 375. ^PRC(442,0) .07 PRIMARY 2237 0;12 Read w/Fileman ^PRC(442,7) .5 SUPPLY STATUS 7;1 Read w/Fileman ROUTINE: ******************** 391 NAME: DBIA391 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: MAR 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.1 ROOT: XT(8984.1, DESCRIPTION: TYPE: File AMIE v2.6 will be using the MTLU functionality from the Kernel tool kit in order to do a look up on the Disability Condition file (#31). As part of the functionality provided to the users, there needs to be a set of distributed Keywords, Synonyms and short cuts. AMIE would like to distribute these lists in,a post init fashion with little to no user intervention. ^XT(8984.1,D0,0) .01 NAME 0;1 Both R/W w/Fileman .02 ENTRY 0;2 Both R/W w/Fileman ^XT(8984.1,'B', ROUTINE: ******************** 392 NAME: DBIA392 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: MAR 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.2 ROOT: XT(8984.2, DESCRIPTION: TYPE: File AMIE v2.6 will be using the MTLU functionality from the Kernel tool kit in order to do a look up on the Disability Condition file (#31). As part of the functionality provided to the users, there needs to be a set of distributed Keywords, Synonyms and short cuts. AMIE would like to distribute these lists in a post init fashion with little to no user intervention. ^XT(8984.2,D0,0) .01 FREQUENTLY USED NARR 0;1 Both R/W w/Fileman .02 ENTRY 0;2 Both R/W w/Fileman ^XT(8984.2,'B', ROUTINE: ******************** 393 NAME: DBIA393 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: MAR 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.3 ROOT: XT(8984.3, DESCRIPTION: TYPE: File AMIE v2.6 will be using the MTLU functionality from the Kernel tool kit in order to do a look up on the Disability Condition file (#31). As part of the functionality provided to the users, there needs to be a set of distributed Keywords, Synonyms and short cuts. AMIE would like to distribute these lists in a post init fashion with little to no user intervention. ^XT(8984.3,D0,0) .01 TERM 0;1 Both R/W w/Fileman ^XT(8984.3,'B', ^XT(8984.3,D0,1,'B', ROUTINE: ******************** 394 NAME: DBIA394 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: MAR 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.4 ROOT: XT(8984.4, DESCRIPTION: TYPE: File AMIE v2.6 will be using the MTLU functionality from the Kernel tool kit in order to do a look up on the Disability Condition file (#31). As part of the functionality provided to the users, there needs to be a set of distributed Keywords, Synonyms and short cuts. AMIE would like to distribute these lists in a post init fashion with little to no user intervention. ^XT(8984.4,D0,0) .01 NAME 0;1 Both R/W w/Fileman ROUTINE: ******************** 395 NAME: DBIA395 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: MAR 23,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File VA FileMan grants this integration request. The following calls are allowed within the AMIE package. CHK+13^DVBAPLL S DIC="^DD(8984.1,.02,""V"",",DIC(0)="Z",D="P",X=VAR1 D IX^DIC CHK+19^DVBAPLL S DIC="^DD(8984.2,.02,""V"",",DIC(0)="Z",D="P",X=VAR1 D IX^DIC ADDV+1^DVBAPLL Calls using ^DIC and ^DIE to update the variable pointer field in the Local Keyword and Local Synonym file for use with MTLU. The ^DIE call is fully compatible with the interactive way of creating variable pointer type fields. ^DD(8984.1,.02,'V', ^DD(8984.2,.02,'V', ROUTINE: ******************** 396 NAME: DBIA396 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: FEE BASIS REGISTRATION USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement was updated on 3/3/97 to convert it from an 'Other' type agreement (to support IB v2.0 installation requirements with Fee Basis) to a 'Routine' type agreement to support IB's callable routine IBCNSP2. Please note that this agreement also supercedes agreement DBIA226-C which Fee Basis held with the Registration package. The terms under which IB exported the Fee Basis patch FB*3*5 are listed below, so they are not lost: IB will transport routine FBUINS in routine IB20PT8C, and ZSave as FBUINS during the installation process if version 3 is running and patch 5 has not been installed. Patch 5 of Fee contains the following special instructions: - Do not apply if version 3 of Fee is installed but Version 2 has not been installed. - If version 3 of Fee has been installed, IB 2 will automatically apply this patch. There is no need to apply. - If you install version 2 of IB prior to installing version 3 of Fee, then this patch needs to be applied prior to allowing Fee users back on the system. Verification of FB*3*5 is pending this agreement. ROUTINE: IBCNSP2 COMPONENT: FEE VARIABLES: DFN Type: Input Pointer to the patient in file #2 This entry point is called from within the Fee Basis package to add patient insurance policy information for patients. Please note that new insurance policies may be added, but existing patient policy information cannot be edited. This call also allows Insurance Plan information in file #355.3 to be added and edited. COMPONENT: REG VARIABLES: This entry point is called from Screen 5 of the Registration process and the 10-10T Registration process to allow patient insurance policy information to be added and edited. This call also allows Insurance Plan information in file #355.3 to be added and edited. ******************** 397 NAME: DBIA397 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.95 ROOT: SD(409.95, DESCRIPTION: TYPE: File Request to export the following Scheduling files with the release of Integrated Billing v2.0: #409.95 PRINT MANAGER CLINIC SETUP Also request read and write access for all fields in these files. These files are used by the Print Manager to determine which forms should be printed for each clinic. ROUTINE: ******************** 398 NAME: DBIA398 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.96 ROOT: SD(409.96, DESCRIPTION: TYPE: File Request to export the following Scheduling files with the release of Integrated Billing v2.0: #409.96 PRINT MANAGER DIVISION SETUP Also request read and write access for all fields in these files. These files are used by the Print Manager to determine which forms should be printed for each clinic. ROUTINE: ******************** 399 NAME: DBIA399 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,'S',D1,0) .01 CLINIC 0;1 Both R/W w/Fileman The appointment clinic is listed on reports and encounter forms. 5 LAB DATE/TIME 0;3 Both R/W w/Fileman This field is used to determine if there was a lab stop associated with the appointment. 6 X-RAY DATE/TIME 0;4 Both R/W w/Fileman This field is used to determine if there was an X-RAY stop associated with the appointment. 7 EKG DATE/TIME 0;5 Both R/W w/Fileman This field is used to determine if there was an EKG stop associated with the appointment. 21 OUTPATIENT ENCOUNTER 0;21 Both R/W w/Fileman The pointer to the outpatient encounter is used to determine the classification answers for the appointment. 22 ENOUNTER FORMS PRINT 0;21 Both R/W w/Fileman This field is set by the Encounter Form utilities when a form is printed. 23 ENCOUNTER FORMS AS A 0;22 Both R/W w/Fileman This field is set by the Encounter Form utilities when the form and other reports where printed as add-ons It is understood that these references will need to be changed when Scheduling's new APIs are available. ^DPT(D0,'DIS',D1,0) 18 OUTPATIENT ENCOUNTER 0;18 Direct Global Read & w The pointer to the outpatient encounter is used to determine the classification answers for the registration. ROUTINE: ******************** 400 NAME: DBIA400 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File ^DIC(40.7,D0,0) 1 AMIS REPORTING STOP 0;2 Read w/Fileman The AMIS Reporting Stop Code is printed on several reports .01 NAME 0;1 Pointed to This pointer is used to flag clinic stop codes as non-billable. ROUTINE: ******************** 402 NAME: DBIA402 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS REGISTRATION MENTAL HEALTH OUTPATIENT PHARMACY The variable SDDA will not be supported No direct references to appointments are allowed in the subscriber routine. USAGE: Controlled Subscri ENTERED: APR 4,1994 STATUS: Under Revision EXPIRES: DURATION: VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File This pointer is needed to retrieve data from this file when a claim is being generated. ^SCE(D0,0) .01 DATE 0;1 Direct Global Read & w Determine date of encounter .02 PATIENT 0;2 Direct Global Read & w Determine patient for encounter .03 CLINIC STOP CODE 0;3 Direct Global Read & w Can't bill clinic stops related to dental .05 VISIT FILE ENTRY 0;5 Direct Global Read & w Stored for future use .06 PARENT ENCOUNTER 0;6 Direct Global Read & w Cannot bill child encounters .07 CHECK OUT PROCESS CO 0;7 Direct Global Read & w Make sure check out is complete .08 ORIGINATING PROCESS 0;8 Direct Global Read & w Determine type of encounter .09 EXTENDED REFERENCE 0;9 Direct Global Read & w Determine disposition for registrations .1 APPOINTMENT TYPE 0;10 Direct Global Read & w Must have billable appointment type .11 MEDICAL CENTER DIVIS 0;11 Direct Global Read & w Determine division of encounter .12 STATUS 0;12 Direct Global Read & w Only checked out encounters are billable .13 ELIGIBILITY OF ENCOU 0;13 Read w/Fileman ^SCE('ADFN',DFN, The "ADFN" cross-reference is used to look at all encounters for a patient on a specific date. ^SCE('B', The "B" cross-reference is used to find all outpatient encounters which occurred within a user-specified date range. ROUTINE: ******************** 406 NAME: DBIA406 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING SURGERY RADIOLOGY/NUCLEAR MEDICINE REGISTRATION PROSTHETICS LAB SERVICE ORDER ENTRY/RESULTS REPORTING EVENT CAPTURE added 2/28/2012 USAGE: Controlled Subscri ENTERED: JUN 30,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: SDCO21 COMPONENT: CL(DFN,DATE,SDOE,.ARR) VARIABLES: DFN Type: Input ptr to patient in file #2 DATE Type: Input date to determine if classification is active. SDOE Type: Input encounter for which classification should be asked (optional - we will pass 'null' in all cases) ARR(n) Type: Output array of classifications that should be asked, where n equals the entry number in the OUTPATIENT CLASSIFICATION TYPE file (#409.41) This call is made to determine what classification questions should be asked for a specific patient. ******************** 407 NAME: DBIA407 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS EVENT CAPTURE USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: SDCOU2 COMPONENT: $$EX(X,Y) VARIABLES: X Type: Input Pointer to clinic stop code in file #40.7 Y Type: Input Date on which clinic stop may be exempt. Output: Is the clinic stop exempt from classification? [1-Yes|0-No]| This call is made to determine if an individual clinic stop, which is being billed the Means Test copayment, is exempt from classification. ******************** 409 NAME: DBIA409 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING REGISTRATION USAGE: Controlled Subscri ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.42 ROOT: SDD(409.42, DESCRIPTION: TYPE: File ^SDD(409.42,D0,0) .01 TYPE 0;1 Direct Global Read & w The type indicates the classification: 1 = Agent Orange 2 = Ionizing Radiation 3 = Service Connected 4 = Environmental Contaminants .03 VALUE 0;3 Direct Global Read & w The value indicates whether care was related to the specified exposure: 1 = Yes otherwise, No ROUTINE: ******************** 410 NAME: DBIA410 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.72 ROOT: SD(409.72, DESCRIPTION: TYPE: File ^SD(409.72,D0,0) .05 ACTIVE STATUS 0;5 Direct Global Read & w The status is used to determine if an ambulatory procedure is active ^SD(409.72,'AIVDT', The "AIVDT" cross reference is used to determine if an ambulatory procedure is active on a specific date. ROUTINE: ******************** 412 NAME: DBIA412 CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File AMIE v2.6 will use the Disability Condition file extensively in a portion of its new functionality. AMIE will need to change and access the file in various ways that will require an integration agreement. In order to use MTLU to its fullest extent AMIE would need to add a new field 'LONG DESCRIPTION' to the Disability Condition file (#31). This field would be a free text field 1-200 characters, on the '1' node. It would not be a multiple or used during lookup. There would be a MUMPS cross reference (ADVB) in order to enhance an MTLU look up. This MUMPS cross reference would be of the format defined in the Kernel 7.2 Tool Kit manual. Ability to carry the new field in the AMIE init. Ability to populate the LONG DESCRIPTION field during the AMIE post init. Access to the 'C' cross reference and LONG DESCRIPTION field for quick look up and comparison during the post init. ROUTINE: ******************** 413 NAME: DBIA413 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE AMIE may only call with DGQCODE="ADD1" FEE BASIS FEE BASIS may only call with DGQCODE="ADD4" SCHEDULING USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGRPU1 COMPONENT: QUES(DFN,DGQCODE) VARIABLES: DFN Type: Input Pointer to the patyent in file #2 DGQCODE Type: Input Indicates that QUES^DGRPU1 is to edit the patient's permanent address. DGCHANGE Type: Output = 1 if data modified = 0 if data NOT modified To be killed after the call. DGERR Type: Output Error value. To be killed after the call. If DGQCODE="ADD1" then: The edit is to the patient's permanent address. QUES^DGRPU1 will edit the following fields as the patient's permanent address: Field Number Field Name ============ ========== .111 STREET ADDRESS [LINE 1] .112 STREET ADDRESS [LINE 2] .113 STREET ADDRESS [LINE 3] .114 CITY .115 STATE .1112 ZIP+4 .117 COUNTY .131 PHONE NUMBER [RESIDENCE] .132 PHONE NUMBER [WORK] The permanent address fields are those currently defined by the indicated MAS routines and are subject to change per the redefinition of those fields by that routine. 2) If DGQCODE= ADD4 then: The editing is of the patient's confidential address fields. Fee Basis will be calling QUES^DGRPU1 to allow user editing of the patient's confidential address information in the Patient (#2) file. QUES^DGRPU1(DFN, ADD4 ) will prompt the user for the following fields: Field # Field Name ====== ========= .1411 CONFIDENTIAL STREET [LINE 1] .1412 CONFIDENTIAL STREET [LINE 2] .1413 CONFIDENTIAL STREET [LINE 3] .1414 CONFIDENTIAL ADDRESS CITY .1415 CONFIDENTIAL ADDRESS STATE .1416 CONFIDENTIAL ADDRESS ZIP CODE .1417 CONFIDENTIAL START DATE .1418 CONFIDENTIAL END DATE .14105 CONFIDENTIAL ADDRESS ACTIVE? .14111 CONFIDENTIAL ADDRESS COUNTY CONFIDENTIAL ADDRESS CATEGORY Multiple (#2.141) .01 CONFIDENTIAL ADDRESS CATEGORY 1 CONFIDENTIAL CATEGORY ACTIVE ******************** 414 NAME: DBIA414 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Request to export the INSURANCE TYPE (#.3121) multiple of the PATIENT (#2) file with the release of Integrated Billing v2.0. This sub-dictionary is maintained in the PATIENT file for Integrated Billing, and may be addressed by Integrated Billing as needed. Integrated Billing agrees to maintain supported references to this data for other applications, as well as Registration. This would.include the "AB" cross reference on the .01 field of the sub-dictionary (^DPT("AB",). ROUTINE: ******************** 415 NAME: DBIA415 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The INSURANCE COMPANY (#36) file will now be released exclusively by Integrated Billing unless otherwise agreed upon. ROUTINE: ******************** 416 NAME: DBIA416 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 37 ROOT: DIC(37, DESCRIPTION: TYPE: File ^DIC(37,D0,0) .01 NAME 0;1 Direct Global Read & w This pointer is used to flag dispositions as non-billable. The disposition name is printed on several outputs. ROUTINE: ******************** 417 NAME: DBIA417 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING ACCOUNTS RECEIVABLE CLINICAL REMINDERS ONCOLOGY added 8/23/2010 CLINICAL CASE REGISTRIES ADDED 5/15/2009 CLINICAL PROCEDURES ADDED 9/28/2009 HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HMP v.2.0 is using the Institution File Pointer (#.07) field as part of the patient sync process that syncs the data between the local VistA system and the JSON DATA System (JDS). HMP collects admission data including the ward and institution. The HMP code gets the division from the Ward Location File (#42), Division (#.015) field (pointer to Medical Center Division (#40.8) file) and then uses this value to get the value from the Institution File Pointer (#.07) field. $$NS^XUAF4 is used to get the text name and station number for the institution. BAR CODE MED ADMIN The Existing Product Intake Program (EPIP) Project, Patch PSB*3.0*100 (Bar Code Medical Administration, PSB), will access the fields specified in ICR #417 for file #40.8, Medical Center Division. USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File ^DG(40.8, .01 NAME 0;1 Pointed to Used to associate a charge or procedure with a location. .07 INSTITUTION FILE POI 0;7 Direct Global Read & w Display the institution associated with a division. 3 OUTPATIENT ONLY 0;3 Direct Global Read & w Determine if the location of care was in the hospital or clinic. .001 NUMBER ENTRY IE Direct Global Read & w 1 FACILITY NUMBER 0;2 Direct Global Read & w ROUTINE: ******************** 418 NAME: DBIA418 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING LAB SERVICE MENTAL HEALTH ORDER ENTRY/RESULTS REPORTING ACCOUNTS RECEIVABLE AR references only the ADMISSION DATE and the DISCHARGE DATE. ONCOLOGY added 2/25/09 USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT DESCRIPTION: TYPE: File This ICR supports access to PTF (#45) file cross-references and data fields. Data fields may be accessed using a Direct Global Read or with Fileman. NOTE: Existing subscribers to this ICR are grandfathered in for accessing PTF (#45) Diagnosis, Present on Admission (POA), Procedure code, and Surgical code data fields. However, current subscribers are encouraged to use ICR 6130 in the future. ICR 6130 supports the use of PTF Utility API's to access PTF (#45) Diagnosis, Present on Admission (POA) indicators, Procedure code, and Surgical code fields, instead of accessing fields directly or using Fileman. New subscribers should not be added to this ICR if PTF (#45) file data fields may be obtained using the PTF Utility API's supported by ICR 6130. ^DGPT(D0,0) .01 PATIENT 0;1 Pointed to This pointer is needed to find the associated PTF record for a claim and extract the required data. 2 ADMISSION DATE 0;2 Direct Global Read & w The admission date is used to the end of the date range for a claim 4 FEE BASIS 0;4 Direct Global Read & w This field is used to determine if the PTF update routine must be called (not called for Fee admissions). 6 STATUS 0;6 Direct Global Read & w This field is used to determine if the PTF record has been closed. ^DGPT(D0,70) 70 DISCHARGE DATE 70;1 Direct Global Read & w The discharge date is used to determine the end of the date range for the claim. 71 DISCHARGE SPECIALTY 70;2 Direct Global Read & w The discharge specialty is used to determine if the admission is billable. 72 TYPE OF DISPOSITION 70;3 Direct Global Read & w The type of disposition is used to determine the discharge status for the claim. 79 PRINCIPAL DX 70;10 Direct Global Read & w The PRINCIPAL DIAGNOSIS is printed on the Amb Proc check off sheet. 79.16 SECONDARY DX 1 70;16 Direct Global Read & w The SECONDARY DIAGNOSIS 1 is printed on the Amb Proc check off sheet. 79.17 SECONDARY DX 2 70;17 Direct Global Read & w The SECONDARY DIAGNOSIS 2 is printed on the Amb Proc check off sheet. 79.1 PROVIDER 70;15 Direct Global Read & w 79.18 SECONDARY DX 3 70;18 Direct Global Read & w 79.19 SECONDARY DX 4 70;19 Direct Global Read & w 79.201 SECONDARY DX 5 70;20 Direct Global Read & w 79.21 SECONDARY DX 6 70;21 Direct Global Read & w 79.22 SECONDARY DX 7 70;22 Direct Global Read & w 79.23 SECONDARY DX 8 70;23 Direct Global Read & w 79.24 SECONDARY DX 9 70;24 Direct Global Read & w 79.25 TREATED FOR SC CONDI 70;25 Direct Global Read & w ^DGPT('B', The "B" cross-reference is used to find a specific PTF record for a patient. ^DGPT('AAD', The "AAD" cross reference is used to find all admissions for a patient within a specified date range. ^DGPT('AFEE', The "AFEE" cross reference is used to find all Fee admissions for a patient within a specified date range. ^DGPT(D0,'M',D1,0) 2 LOSING SPECIALTY 0;2 Direct Global Read & w The specialty is used to determine if a 501 movement is billable. 3 LEAVE DAYS 0;3 Direct Global Read & w Leave days are used to determine the number of billable days of care. 4 PASS DAYS 0;4 Direct Global Read & w Pass days are used to determine the number of billable days of care. 5 ICD 1 0;5 Direct Global Read & w 6 ICD 2 0;6 Direct Global Read & w 7 ICD 3 0;7 Direct Global Read & w 8 ICD 4 0;8 Direct Global Read & w 9 ICD 5 0;9 Direct Global Read & w 10 MOVEMENT DATE 0;10 Direct Global Read & w The movement date is used to determine if the 501 movement is within the date range of the bill 18 TREATED FOR SC CONDI 0;18 Direct Global Read & w This flag is used to determine if the 501 movement is billable. 11 ICD 6 0;11 Direct Global Read & w 12 ICD 7 0;12 Direct Global Read & w 13 ICD 8 0;13 Direct Global Read & w 14 ICD 9 0;14 Direct Global Read & w 15 ICD 10 0;15 Direct Global Read & w ^DGPT(D0,'M','AM', The "AM" cross reference is used to find all 501 movements based on a specified date range. ^DGPT(D0,'P',D1,0) .01 PROCEDURE DATE 0;1 Direct Global Read & w 4 PROCEDURE CODE 1 0;5 Direct Global Read & w 5 PROCEDURE CODE 2 0;6 Direct Global Read & w 6 PROCEDURE CODE 3 0;7 Direct Global Read & w 7 PROCEDURE CODE 4 0;8 Direct Global Read & w 8 PROCEDURE CODE 5 0;9 Direct Global Read & w 9 PROCEDURE CODE 6 0;10 Direct Global Read & w 10 PROCEDURE CODE 7 0;11 Direct Global Read & w 11 PROCEDURE CODE 8 0;12 Direct Global Read & w 12 PROCEDURE CODE 9 0;13 Direct Global Read & w 13 PROCEDURE CODE 10 0;14 Direct Global Read & w 14 PROCEDURE CODE 11 0;15 Direct Global Read & w 15 PROCEDURE CODE 12 0;16 Direct Global Read & w 16 PROCEDURE CODE 13 0;17 Direct Global Read & w 17 PROCEDURE CODE 14 0;18 Direct Global Read & w 18 PROCEDURE CODE 15 0;19 Direct Global Read & w 19 PROCEDURE CODE 16 0;20 Direct Global Read & w 20 PROCEDURE CODE 17 0;21 Direct Global Read & w 21 PROCEDURE CODE 18 0;22 Direct Global Read & w 22 PROCEDURE CODE 19 0;23 Direct Global Read & w 23 PROCEDURE CODE 20 0;24 Direct Global Read & w ^DGPT(D0,'S',D1,0) .01 SURGERY/PROCEDURE DA 0;1 Direct Global Read & w The surgery/procedure date is included on the claim. 8 OPERATION CODE 1 0;8 Direct Global Read & w 9 OPERATION CODE 2 0;9 Direct Global Read & w 10 OPERATION CODE 3 0;10 Direct Global Read & w 11 OPERATION CODE 4 0;11 Direct Global Read & w 12 OPERATION CODE 5 0;12 Direct Global Read & w 13 OPERATION CODE 6 0;13 Direct Global Read & w 14 OPERATION CODE 7 0;14 Direct Global Read & w 15 OPERATION CODE 8 0;15 Direct Global Read & w 16 OPERATION CODE 9 0;16 Direct Global Read & w 17 OPERATION CODE 10 0;17 Direct Global Read & w 18 OPERATION CODE 11 0;18 Direct Global Read & w 19 OPERATION CODE 12 0;19 Direct Global Read & w 20 OPERATION CODE 13 0;20 Direct Global Read & w 21 OPERATION CODE 14 0;21 Direct Global Read & w 22 OPERATION CODE 15 0;22 Direct Global Read & w 23 OPERATION CODE 16 0;23 Direct Global Read & w 24 OPERATION CODE 17 0;24 Direct Global Read & w 25 OPERATION CODE 18 0;25 Direct Global Read & w 26 OPERATION CODE 19 0;26 Direct Global Read & w 27 OPERATION CODE 20 0;27 Direct Global Read & w ^DGPT(D0,300) 300.06 CURRENT FUNCTIONAL A 300;6 Direct Global Read & w ^DGPT(D0,'M',D1,'P') 20 TRANSFER DRG P;1 Direct Global Read & w 24 PROVIDER P;5 Direct Global Read & w ^DGPT(D0,535,D1,0) 6 LOSING WARD 0;6 Direct Global Read & w 10 MOVEMENT DATE 0;10 Direct Global Read & w ^DGPT('AF', Admission date cross-reference. ^DGPT('ADS', For discharge date ranges ^DGPT(D0,71 79.241 SECONDARY DX 10 71;1 Direct Global Read & w 79.242 SECONDARY DX 11 71;2 Direct Global Read & w 79.243 SECONDARY DX 12 71;3 Direct Global Read & w 79.244 SECONDARY DX 13 71;4 Direct Global Read & w 79.245 SECONDARY DX 14 71;5 Direct Global Read & w 79.246 SECONDARY DX 15 71;6 Direct Global Read & w 79.247 SECONDARY DX 16 71;7 Direct Global Read & w 79.248 SECONDARY DX 17 71;8 Direct Global Read & w 79.249 SECONDARY DX 18 71;9 Direct Global Read & w 79.2491 SECONDARY DX 19 71;10 Direct Global Read & w 79.24911 SECONDARY DX 20 71;11 Direct Global Read & w 79.24912 SECONDARY DX 21 71;12 Direct Global Read & w 79.24913 SECONDARY DX 22 71;13 Direct Global Read & w 79.24914 SECONDARY DX 24 71;14 Direct Global Read & w 79.24915 SECONDARY DX 24 71;15 Direct Global Read & w ^DGPT(D0,82 82.01 POA PRINCIPAL DX 82;1 Direct Global Read & w 82.02 POA SECONDARY DX 1 82;2 Direct Global Read & w 82.03 POA SECONDARY DX 2 82;3 Direct Global Read & w 82.04 POA SECONDARY DX 3 82;4 Direct Global Read & w 82.05 POA SECONDARY DX 4 82;5 Direct Global Read & w 82.06 POA SECONDARY DX 5 82;6 Direct Global Read & w 82.07 POA SECONDARY DX 6 82;7 Direct Global Read & w 82.08 POA SECONDARY DX 7 82;8 Direct Global Read & w 82.09 POA SECONDARY DX 8 82;9 Direct Global Read & w 82.1 POA SECONDARY DX 9 82;10 Direct Global Read & w 82.11 POA SECONDARY DX 10 82;11 Direct Global Read & w 82.12 POA SECONDARY DX 11 82;12 Direct Global Read & w 82.13 POA SECONDARY DX 12 82;13 Direct Global Read & w 82.14 POA SECONDARY DX 13 82;14 Direct Global Read & w 82.15 POA SECONDARY DX 14 82;15 Direct Global Read & w 82.16 POA SECONDARY DX 15 82;16 Direct Global Read & w 82.17 POA SECONDARY DX 16 82;17 Direct Global Read & w 82.18 POA SECONDARY DX 17 82;18 Direct Global Read & w 82.19 POA SECONDARY DX 18 82;19 Direct Global Read & w 82.2 POA SECONDARY DX 19 82;20 Direct Global Read & w 82.21 POA SECONDARY DX 20 82;21 Direct Global Read & w 82.22 POA SECONDARY DX 21 82;22 Direct Global Read & w 82.23 POA SECONDARY DX 22 82;23 Direct Global Read & w 82.24 POA SECONDARY DX 23 82;24 Direct Global Read & w 82.25 POA SECONDARY DX 24 82;25 Direct Global Read & w ^DGPT(D0,'M',D1,81 81.01 ICD 11 81;1 Direct Global Read & w 81.02 ICD 12 81;2 Direct Global Read & w 81.03 ICD 13 81;3 Direct Global Read & w 81.04 ICD 14 81;4 Direct Global Read & w 81.05 ICD 15 81;5 Direct Global Read & w 81.06 ICD 16 81;6 Direct Global Read & w 81.07 ICD 17 81;7 Direct Global Read & w 81.08 ICD 18 81;8 Direct Global Read & w 81.09 ICD 19 81;9 Direct Global Read & w 81.1 ICD 20 81;10 Direct Global Read & w 81.12 ICD 22 81;12 Direct Global Read & w 81.11 ICD 21 81;11 Direct Global Read & w 81.13 ICD 23 81;13 Direct Global Read & w 81.14 ICD 24 81;14 Direct Global Read & w 81.15 ICD 25 81;15 Direct Global Read & w ^DGPT(D0,'M',D1,82 82.01 POA FOR ICD 1 82;1 Direct Global Read & w 82.02 POA FOR ICD 2 82;2 Direct Global Read & w 82.03 POA FOR ICD 3 82;3 Direct Global Read & w 82.04 POA FOR ICD 4 82;4 Direct Global Read & w 82.05 POA FOR ICD 5 82;5 Direct Global Read & w 82.06 POA FOR ICD 6 82;6 Direct Global Read & w 82.07 POA FOR ICD 7 82;7 Direct Global Read & w 82.08 POA FOR ICD 8 82;8 Direct Global Read & w 82.09 POA FOR ICD 9 82;9 Direct Global Read & w 82.1 POA FOR ICD 10 82;10 Direct Global Read & w 82.11 POA FOR ICD 11 82;11 Direct Global Read & w 82.12 POA FOR ICD 12 82;12 Direct Global Read & w 82.13 POA FOR ICD 13 82;13 Direct Global Read & w 82.14 POA FOR ICD 14 82;14 Direct Global Read & w 82.15 POA FOR ICD 15 82;15 Direct Global Read & w 82.16 POA FOR ICD 16 82;16 Direct Global Read & w 82.17 POA FOR ICD 17 82;17 Direct Global Read & w 82.18 POA FOR ICD 18 82;18 Direct Global Read & w 82.19 POA FOR ICD 19 82;19 Direct Global Read & w 82.2 POA FOR ICD 20 82;20 Direct Global Read & w 82.21 POA FOR ICD 21 82;21 Direct Global Read & w 82.22 POA FOR ICD 22 82;22 Direct Global Read & w 82.23 POA FOR ICD 23 82;23 Direct Global Read & w 82.24 POA FOR ICD 24 82;24 Direct Global Read & w 82.25 POA FOR ICD 25 82;25 Direct Global Read & w ^DGPT(D0,'P',D1,1 24 PROCEDURE CODE 21 1;1 Direct Global Read & w 25 PROCEDURE CODE 22 1;2 Direct Global Read & w 26 PROCEDURE CODE 23 1;3 Direct Global Read & w 27 PROCEDURE CODE 24 1;4 Direct Global Read & w 28 PROCEDURE CODE 25 1;5 Direct Global Read & w ^DGPT(D0,'S',D1,1 28 OPERATION CODE 21 1;1 Direct Global Read & w 29 OPERATION CODE 22 1;2 Direct Global Read & w 30 OPERATION CODE 23 1;3 Direct Global Read & w 31 OPERATION CODE 24 1;4 Direct Global Read & w 32 OPERATION CODE 25 1;5 Direct Global Read & w ^COMPUTED 9 DRG COMPUTED Read w/Fileman Only Integrated Billing has permission to reference this field. ROUTINE: ******************** 419 NAME: DBIA419 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING BENEFICIARY TRAVEL SOCIAL WORK ACCOUNTS RECEIVABLE MRSA INITIATIVE REPORTS LAB SERVICE LR ADDED 3/21/11 USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File ^DGPM(D0,0) .01 DATE/TIME 0;1 Direct Global Read & w This pointer is needed to associate Claims Tracking and special inpatient billing case records with an admission. Movement date/time is displayed on several reports. .02 TRANSACTION 0;2 Direct Global Read & w The transaction type is printed on several reports. .03 PATIENT 0;3 Direct Global Read & w Determine the patient for the movement .06 WARD LOCATION 0;6 Direct Global Read & w Ward location is printed on several reports. .09 FACILITY TREATING SP 0;9 Direct Global Read & w Billing for the movement is dependent upon treating specialty. .11 ADMITTED FOR SC COND 0;11 Direct Global Read & w Determine if the admission is related to an SC condition. .16 PTF ENTRY 0;16 Direct Global Read & w Determine the associated PTF entry for an admission. .17 DISCHARGE/CHECK-OUT 0;17 Direct Global Read & w Determine the discharge movement for an admission. .14 ADMISSION/CHECK-IN M 0;14 Direct Global Read & w The field is used to find the pointer to the admission movement that is associated with a discharge movement. ^DGPM('AMV1', The "AMV1" cross-reference is used to find all admissions within a specified date/time range. ^DGPM('AMV2', The "AMV2" cross-reference is used to find all transfers within a specified date/time range. ^DGPM('AMV3', The "AMV3" cross-reference is used to find all discharges within a specified date/time range. ^DGPM('ATID1', The "ATID1" cross-reference is used to find all admissions for a patient. ^DGPM('ATS', The "ATS" cross-reference is used to find the treating specialty for a patient for a given date/time. ^DGPM('APTF', The "APTF" cross-reference is used to find the pointer to the admission movement for a specific PTF entry. ^DGPM('ATID3',DFN, The "ATID3" cross-reference is used to find all discharges that are associated with a patient (where DFN is a pointer to the patient in file #2). ^DGPM('ATT3', The "ATT3" cross-reference is used to find all discharges which occurred during a user-specified date range. ROUTINE: ******************** 420 NAME: DBIA420 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU COMPONENT: DIS VARIABLES: DFN Type: Input Pointer to the patient in file #2 There is no varible output from this call. The call is used to display to the screen current Means Test information for a patient when creating a bill. ******************** 421 NAME: DBIA421 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGUTL2 COMPONENT: PLASIH VARIABLES: DGBDT Type: Input Begin date of date range DGEDT Type: Input End date of date range DGADM Type: Input Admission date DGPMCA Type: Input Pointer to corresponding admission in the Patient Movement (405) file. DGREC Type: Output Number of days on pass, leave and ASIH for a dage range within an admission. This call is used to determine the number of days in an admission which are not billable on a claim. ******************** 422 NAME: DBIA422 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGPTUTL COMPONENT: UPDT VARIABLES: DFN Type: Input Pointer to the patient in file #2 PTF Type: Input Pointer to the PTF record in file 45. There is no variable output from this call. The call is used to update the movements on the PTF record before the automatic bill calculator determines the charges for the admission. ******************** 423 NAME: DGMTCOU1 - Medication Copay Exemption API CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTCOU1 COMPONENT: $$AUTOINFO(DFN) VARIABLES: Output: The following string of characteristics for a patient: 1^2^3^4^5^6^7^8^9^10^11, where 1 = Pt SC>50% [1-yes|0 or null-no]| 2 = Receives Aid & Attendance [1-yes|0 or null-no]| 3 = Receives Housebound benefits [1-yes|0 or null-no]| 4 = Receives VA Pension [1-yes|0 or null-no]| 5 = Receives Military Disability Retirement [1-yes|0 or null-no]| 6 = Non-veteran [1-yes|0 or null-no]| 7 = Inpatient [1-yes|0 or null-no] (not used by IB)| 8 = Former POW veteran [1-yes|0 or null-no]| 9 = Unemployable veteran [1-yes|0 or null-no]| 10 = Catastrophically Disabled veteran [1-yes|0 or null-no]| 11 = Medal of Honor [1-yes|0 or null-no]| This call is used to determine if a patient is automatically exempt from Pharmacy copay. COMPONENT: $$LST(DFN,DATE,IND) VARIABLES: DFN Type: Input Pointer to the patient in file #2. DATE Type: Input Desired date to return Means test data IND Type: Input Indicator to determine what types of tests to use: 1 -> Means Tests only 2 -> Copay Tests only else -> both Means Tests and Copay Tests Output: The following string of characteristics for a patient's Means Test: 1^2^3^4^5, where 1 = Pointer to the test in file #408.31 2 = Date of Test 3 = Test Status Name 4 = Test Status Code 5 = Type of Test used This call is used to determine which Means Test or Copay Test should be used to determine if a patient is exempt from Pharmacy copay based on reported income. ******************** 424 NAME: DBIA424 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU11 COMPONENT: GETREL(DFN,IND,DATE) VARIABLES: DFN Type: Input Pointer to the patient in file 2 IND Type: Input Indicator to determine what types of dependents toeturn data for (input is always 's' for spouse). DATE Type: Input Desired effective date to return relations data. DGREL('S') Type: Output Pointer to the spouse reference in the patient relation file (408.12) The call is used to determine the spouse relation so that the spouse name and SSN may be retrieved. ******************** 425 NAME: DBIA425 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU1 COMPONENT: $$NAME(IND) VARIABLES: IND Type: Input Pointer to the spouse reference in the patient relation file (408.12) This function returns the spouse name, which is displayed on a report. COMPONENT: $$SSN(IND) VARIABLES: IND Type: Input Pointer to the spouse reference in the patient relation file (408.12) This function returns the spouse Social Security Number, which is displayed on a report. ******************** 426 NAME: DBIA426 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,.11) .111 STREET ADDRESS [LINE .11;1 Direct Global R/W & w/ Printed on screens and bills .112 STREET ADDRESS [LINE .11;2 Direct Global R/W & w/ Printed on screens and bills .113 STREET ADDRESS [LINE .11;3 Direct Global R/W & w/ Printed on screens and bills .114 CITY .11;4 Direct Global R/W & w/ Printed on screens and bills .115 STATE .11;5 Direct Global R/W & w/ Printed on screens and bills .1112 ZIP+4 .11;12 Direct Global R/W & w/ Printed on screens and bills .117 COUNTY .11;7 Write w/Fileman ^DPT(D0,.13) .131 PHONE NUMBER [RESIDE .13;1 Direct Global R/W & w/ Printed on screens and bills .132 PHONE NUMBER [WORK] .13;2 Direct Global R/W & w/ Printed on screens and bills ^DPT(D0,.121) .12105 TEMPORARY ADDRESS AC .121;9 Direct Global R/W & w/ Used to determine if the patient's temporary address should be used on screens and bills. .1215 TEMPORARY STATE .121;5 Direct Global R/W & w/ Used as an indicator that the temporary address exists. .1211 TEMPORARY STREET [LI .121;1 Write w/Fileman .1212 TEMPORARY STREET [LI .121;2 Write w/Fileman .1213 TEMPORARY STREET [LI .121;3 Write w/Fileman .1214 TEMPORARY CITY .121;4 Write w/Fileman .1217 TEMPORARY ADDRESS ST .121;7 Write w/Fileman .1218 TEMPORARY ADDRESS EN .121;8 Write w/Fileman .12112 TEMPORARY ZIP+4 .121;12 Write w/Fileman ^DPT(D0,.22) .2205 EMPLOYER ZIP+4 .22;5 Direct Global R/W & w/ Printed on screens and bills .2206 SPOUSE'S EMP ZIP+4 .22;5 Direct Global R/W & w/ Printed on screens and bills ^DPT(D0,.25) .251 SPOUSE'S EMPLOYER .25;1 Direct Global R/W & w/ Printed on screens and bills .252 SPOUSE'S EMP STREET 25;2 Direct Global R/W & w/ Printed on screens and bills .256 SPOUSE'S EMPLOYER'S 25;6 Direct Global R/W & w/ Printed on screens and bills .258 SPOUSE'S EMP PHONE N 25;8 Direct Global R/W & w/ Displayed on screens. .253 SPOUSE'S EMP STREET .25;3 Write w/Fileman .254 SPOUSE'S EMP STREET .25;4 Write w/Fileman .255 SPOUSE'S EMPLOYER CI .25;5 Write w/Fileman ^DPT(D0,.3) .301 SERVICE CONNECTED? 3;1 Direct Global Read & w Used to determine whether to check for SC related movements for claims. ^DPT(D0,.311) .3111 EMPLOYER NAME .311;1 Direct Global R/W & w/ Printed on screens and bills .31115 EMPLOYMENT STATUS .311;15 Direct Global R/W & w/ Printed on screens, and used to determine whether employer data is printed on a claim. .3116 EMPLOYER CITY .311;6 Direct Global R/W & w/ Printed on screens and bills .3117 EMPLOYER STATE .311;7 Direct Global R/W & w/ Printed on screens and bills .3119 EMPLOYER PHONE NUMBE .311;9 Direct Global R/W & w/ Displayed on screens .3113 EMPLOYER STREET [LIN .311;3 Write w/Fileman .3114 EMPLOYER STREET [LIN .311;4 Write w/Fileman .3115 EMPLOYER STREET [LIN .311;5 Write w/Fileman ^DPT(D0,.36) .361 PRIMARY ELIGIBILITY .36;1 Direct Global R/W & w/ This code is printed on several reports. ^DPT(D0,.361) .3611 ELIGIBILITY STATUS .361;1 Direct Global Read & w This status is used to determine if a HINQ request should be made. ^DPT(D0,.01,D1,0) .01 ALIAS 0;1 Direct Global Read & w Displayed on screens. 1 ALIAS SSN 0;2 Write w/Fileman ^DPT(D0,0) .02 SEX 0;2 Write w/Fileman .03 DATE OF BIRTH 0;3 Write w/Fileman .05 MARITAL STATUS 0;5 Write w/Fileman .07 OCCUPATION 0;7 Write w/Fileman ^DPT(D0,'VET') 1901 VETERAN (Y/N)? VET;1 Write w/Fileman ^DPT(D0,DIS,D1,0) 3 FACILITY APPLYING TO 0;4 Direct Global Read & w Used to place registration on correct report when printing by division. ^DPT(D0,DIS,D1,2) 20 NEED RELATED TO OCCU 2;1 Direct Global Read & w Used to determine if the registration may be claimed as a Worker's Compensation case. 23 NEED RELATED TO AN A 2;4 Direct Global Read & w Used to determine if the registration may be claimed as a Tort Feasor case. ^DPT(D0 .001 NUMBER ENTRY IE Direct Global Read & w This global reference defines direct global access to the internal entry number of each entry in file #2. A full file scan of all entries in file #2 is required to find all patients who were entered into the file (using field #.097, DATE ENTERED INTO FILE) within a user-specified date range. ^DPT(D0,.38) .381 ELIGIBLE FOR MEDICAI .38;1 Read w/Fileman This field is displayed on the First Party Follow-Up Report [IBJD FOLLOW-UP FIRST PARTY] so that the Accounts Receivable clerk conducting follow-up activities knows that the patient has been covered under Medicaid. ROUTINE: ******************** 427 NAME: DBIA427 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING DSS - DECISION SUPPORT SYSTEM EX DSS EXTRACTS performs a FileMan read on MAS ELIGIBILITY CODE (#8) only. No other fields in the record are accessed. CLINICAL INFO RESOURCE NETWORK PHARMACY BENEFITS MANAGEMENT BENEFICIARY TRAVEL SCHEDULING ACCOUNTS RECEIVABLE EVENT CAPTURE ADDED 2/28/2012 USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8 ROOT: DIC(8, DESCRIPTION: TYPE: File ^DIC(8,D0,0) .01 NAME 0;1 Direct Global Read & w Eligibility code name is printed on several reports. 3 VA CODE NUMBER 0;4 Direct Global Read & w The VA code number is printed in place of the eligibility code on one report 5 PRINT NAME 0;6 Direct Global Read & w Eligibility code print name is printed on several reports. 8 MAS ELIGIBILITY CODE 0;9 Direct Global Read & w The MAS eligibility code is used to determine if a patient is a CHAMPVA patient (code=12) 6 INACTIVE 0;7 Direct Global Read & w 4 TYPE 0;5 Direct Global Read & w The value of the TYPE field is required to determine if a patient is receiving care due to his Veteran or Non-Veteran eligibility. ROUTINE: ******************** 428 NAME: DBIA428 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 11 ROOT: DIC(11, DESCRIPTION: TYPE: File ^DIC(11,D0,0) .01 NAME 0;1 Direct Global Read & w Marital status name is printed on reports, screens, and bills. ROUTINE: ******************** 429 NAME: DBIA429 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.1 ROOT: DGS(41.1, DESCRIPTION: TYPE: File ^DGS(41.1,D0,0) .01 PATIENT 0;1 Direct Global Read & w Determine the patient who is scheduled for admission 2 RESERVATION DATE/TIM 0;2 Direct Global Read & w Determine the scheduled admission date/time 13 DATE/TIME CANCELLED 0;13 Direct Global Read & w This field is used to determine if the scheduled admission has been canceled. 17 ADMITTED 0;17 Direct Global Read & w This field is used to determine if the patient is already admitted. 5 PROVIDER 0;5 Read w/Fileman ^DGS(41.1,'C', The "C" cross-reference is used to find all scheduled admissions within a specified date range. ^DGS(41.1,'B', The 'B' cross-reference is used to find all scheduled admissions associated with a patient. ROUTINE: ******************** 430 NAME: DBIA430 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File ^DIC(42.4,D0,0) .01 NAME 0;1 Direct Global Read & w The specialty name is printed on several reports. 3 SERVICE 0;3 Direct Global Read & w The service is used to track changes in jajor bed sections. 5 BILLING RATE BEDSECT 0;5 Direct Global Read & w The billing rate bedsection is used to determine if a specialty is billable. ROUTINE: ******************** 431 NAME: DBIA431 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING BENEFICIARY TRAVEL INCOME VERIFICATION MATCH Using VERSION(#999) field. ENROLLMENT APPLICATION SYSTEM Using Field (#76) -USE HIGH INTENSITY ON SCREENS Using Field (#77) - EXCLUDE WHICH TERMINAL TYPES USAGE: Private ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File ^DG(43,D0,0) 76 USE HIGH INTENSITY O 0;36 Direct Global Read & w This field is used to determine if high intensity should be used on the billing screens. ^DG(43,D0,'TERM',D1,0) .01 EXCLUDE WHICH TERMIN 0;1 Direct Global Read & w This field is used to determine if high intensity should be used on the billing screens, based on the terminal type. ^DG(43,D0,'VERSION) 999 VERSION VERSION; Direct Global Read & w This field is used in the pre-init routine to determine if PIMS v5.3 has been installed. ^DG(43,D0,'VFA') 1205 VFA START DATE VFA;1 Read w/Fileman The date, January 1,2013, that the Veteran Financial Assessment(VFA) project becomes operational. ROUTINE: ******************** 432 NAME: DBIA432 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING PHARMACY BENEFITS MANAGEMENT TEXT INTEGRATION UTILITIES EVENT CAPTURE ADDED 2/28/2012 USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49, DESCRIPTION: TYPE: File ^DIC(49,D0,0) .01 NAME 0;1 Direct Global Read & w Service name is displayed n several screens. ROUTINE: ******************** 433 NAME: DBIA433 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING SPINAL CORD DYSFUNCTION VISTA INTEGRATION ADAPTOR VIA will be referencing the Name (#.01) field in the MAS Movement Transaction Type (#405.3) file in VIAB BMS RPC. USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.3 ROOT: DG(405.3, DESCRIPTION: TYPE: File ^DG(405.3,D0,0) .01 NAME 0;1 Direct Global Read & w The disposition name is printed on several outputs. ROUTINE: ******************** 434 NAME: DBIA434 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING BENEFICIARY TRAVEL ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: APR 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.31 ROOT: DGMT(408.31, DESCRIPTION: TYPE: File ^DGMT(408.31,D0,0) .01 DATE OF TEST 0;1 Direct Global Read & w The date/time is needed to determine the date/time of the RX copay exemption. .019 TYPE OF TEST 0;19 Direct Global Read & w The type is used to determine if the test is a copay test. .02 PATIENT 0;2 Direct Global Read & w This field is used to determine the patient ofr the copay test. .03 STATUS 0;3 Direct Global Read & w The status of the copay test is used to determine RX copay exemption status. .04 INCOME 0;4 Direct Global Read & w The income is used to determine RX copay exemption status. .05 NET WORTH 0;5 Direct Global Read & w The net worth is used to determine RX copay exemption status .1 ADJUDICATION DATE/TI 0;10 Direct Global Read & w The adjudication date/time is used to determine RX copay exemption hardships. .14 DECLINES TO GIVE INC 0;14 Direct Global Read & w This field is used to determine is not exempt from rx copay based on no available income. .15 DEDUCTIBLE EXPENSES 0;15 Direct Global Read & w Deductible expenses is used to determine rx copay exemption status. .18 TOTAL DEPENDENTS 0;18 Direct Global Read & w Total Dependents is used to determine the appropriate pension threshold level for rx copay exemptions. ROUTINE: ******************** 435 NAME: DBIA435 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.8 ROOT: PS(50.8, DESCRIPTION: TYPE: File ^PS(50.8,D0,2,D1,2,D2,0) .01 IV DRUG 0;1 Read w/Fileman 1 DISPENSED UNITS (IV 0;2 Read w/Fileman 2 RETURNED UNITS (IV D 0;3 Read w/Fileman 3 DESTROYED UNITS (IV 0;4 Read w/Fileman 4 AVERAGE DRUG COST PE 0;5 Read w/Fileman 5 DRUG UNIT 0;6 Read w/Fileman 6 TYPE 0;7 Read w/Fileman ^PS(50.8,D0,0) .01 IV ROOM 0;1 Pointed to ^PS(50.8,D0,2,D1,2,'AC', ROUTINE: ******************** 436 NAME: DBIA436 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT BAR CODE MED ADMIN USAGE: Controlled Subscri ENTERED: APR 11,1994 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. ^PS(52.6, .01 PRINT NAME 0;1 Read w/Fileman 1 GENERIC DRUG 0;2 Read w/Fileman 2 DRUG UNIT 0;3 Read w/Fileman 7 AVERAGE DRUG COST PE 0;7 Read w/Fileman 12 INACTIVATION DATE I;1 Read w/Fileman 15 PHARMACY ORDERABLE I 0;11 Read w/Fileman X-REF AOI x-ref Read w/Fileman ROUTINE: ******************** 437 NAME: DBIA437 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT BAR CODE MED ADMIN USAGE: Controlled Subscri ENTERED: APR 11,1994 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 52.7 ROOT: PS(52.7, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. ^PS(52.7, .01 PRINT NAME 0;1 Pointed to 1 GENERIC DRUG 0;2 Read w/Fileman 7 AVERAGE DRUG COST 0;7 Read w/Fileman 8 INACTIVATION DATE I;1 Read w/Fileman 2 VOLUME 0;3 Read w/Fileman 9 PHARMACY ORDERABLE I 0;11 Read w/Fileman X-REF AOI x-ref Read w/Fileman ROUTINE: ******************** 438 NAME: DBIA438 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 57.6 ROOT: PS(57.6, DESCRIPTION: TYPE: File ^PS(57.6,D0,0) .01 DATE 0;1 Pointed to ^PS(57.6,D0,1,D1,1,D2,1,D3,0) .01 DRUG 0;1 Read w/Fileman 1 DISPENSED AMOUNT 0;2 Read w/Fileman 2 DISPENSED COST 0;3 Read w/Fileman 3 RETURNED AMOUNT 0;4 Read w/Fileman 4 RETURNED COST 0;5 Read w/Fileman ROUTINE: ******************** 439 NAME: DBIA439-A CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.61 ROOT: VAT(394.61, DESCRIPTION: TYPE: File ^VAT(394.61,'A1AY', As the result of changing from a local name space (A1AY) and numbering sequence to a national name space (PPP) and numbering sequence, Pharmacy Prescription Practices v1.0 (PPP) will need to kill and directly set MUMPS cross references in the VAQ - TRANSACTION file. ^VAT(394.61,D0,SEG,'A1AY2', As the result of changing from a local name space (A1AY) and numbering sequence to a national name space (PPP) and numbering sequence, Pharmacy Prescription Practices v1.0 (PPP) will need to kill and directly set MUMPS cross references in the VAQ - TRANSACTION file. ^VAT(394.61,'PPP', The cross reference to create this is a MUMPS cross reference on the Current Status field (#.02) of the VAQ - TRANSACTION file (#394.61) This cross reference is used to update information in the PPP FOREIGN FACILITY XREF file (#1020.2). ^VAT(394.61,D0,0) .01 Transaction Number 0;1 Read w/Fileman ROUTINE: ******************** 440 NAME: DBIA439-B CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQUPD25 COMPONENT: EXTARR(...) VARIABLES: TRAN Type: Input Pointer to VAQ - Transaction file SEG Type: Input Pointer to VAQ - Data segment file ROOT Type: Input Where to store the extraction array (full global ref). OFFSET Type: Input Where to begin placing information (defaults to 0) (Only valid for extractions that are in Display Ready format). Output: 0 - Success (non-display ready) n - Number of lines in display (display ready format) -1^Error_Text - Error Notes: If the segment is not in display ready format ROOT("VALUE",File,Field,Seq)=Data ROOT("ID",File,Field,Seq)=Identifier If the segment is in display ready format ROOT("DISPLAY",LineNumber,0)=Line of display ******************** 441 NAME: DBIA439-C CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQUIN01 COMPONENT: PDX(.......) VARIABLES: VAQOPT Type: Input REQ=request, UNS=unsolicited VAQDFN Type: Input IFN of patient in patient file VAQNM Type: Input Name of patient VAQISSN Type: Input Patient SSN (no dashes) VAQIDOB Type: Input patients date of birth (external format) DOMROOT Type: Input array of domains (full global reference) (ie: PXB.ISC-ALBANY.VA.GOV)=Institution name or null) SEGROOT Type: Input array of segments (full globlobal reference) (ie: PDX*MIN)=P1^P2 P1 = TIME LIMIT P2 = OCCURRENCE LIMIT NOTROOT Type: Input array of who to notify (only used for request) TLIMIT Type: Input time limit for health summary (ie: 1D,12M,5Y) OLIMIT Type: Input occurrence limit for health summary, up to 5 digits Output: 0 - ok -1^error text ******************** 443 NAME: DBIA439-E CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.71 ROOT: VAT(394.71, DESCRIPTION: TYPE: File Used to extract segment pointer information ^VAT(394.71,D0,0) .01 Data Segment Name 0;1 Direct Global Read & w ^VAT(394.71,C,SEGMENT NAME, .01 Data Segement Name 0;1 Direct Global Read & w ROUTINE: ******************** 444 NAME: DBIA439-F CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.62 ROOT: VAT(394.62, DESCRIPTION: TYPE: File Used to extract segment data from data file ^VAT(394.62,D0,0) .01 Data 0;1 Direct Global Read & w ^VAT(394.62,A-SEGMENT, .01 Data 0;1 Direct Global Read & w ^VAT(394.62,DATAPTR,VAL, 10 Value VAL;1 Direct Global Read & w ^VAT(394.62,DATAPTR,SQNCE, 30 Sequence number SQNCE;1 Direct Global Read & w ROUTINE: ******************** 445 NAME: DBIA439-G CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: APR 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.85 ROOT: VAT(394.85, DESCRIPTION: TYPE: File Used to extract PDX status ^VAT(394.85,D0,0) .01 Code 0;1 Direct Global Read & w 1 Status 0;2 Direct Global Read & w ROUTINE: ******************** 446 NAME: DBIA446 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: APR 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.27 ROOT: AUTNPOV( DESCRIPTION: TYPE: File Access to the IHS Provider Narrative File (^AUTNPOV). Access is defined as the ability to READ to and WRITE from this file. The Problem List Application stores the original problem narrative entered by the clinician in ^AUTNPOV. The natural language narrative, along with the accompanying coded data, is displayed for use by the clinician. ^AUTNPOV(D0,0) .01 NARRATIVE 0;1 Direct Global R/W & w/ ROUTINE: ******************** 447 NAME: DBIA447 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: APR 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000001 ROOT: AUPNPAT( DESCRIPTION: TYPE: File READ only access to the Patient/IHS File (^AUPNPAT). This file is a subset of the IHS Patient File. It is required to be installed as all VAMCs wishing to use the Problem List Application. Use of this file assures backward compatibility with IHS software. The patient's name and IFN is initially selected from this file. Then used for look-up purposes with the VA's Patient File (^DPT). ^AUPNPAT(D0,0) .01 NAME 0;1 Read w/Fileman This field points to the Patient File (#2) and has the same internal file number as that file. Thus, the patient's name is the Patient File (#2) name. ROUTINE: ******************** 449 NAME: DBIA449 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CPT/HCPCS CODES USAGE: Private ENTERED: APR 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The CPT package currently has five table files which reside in the DIC global. These are as follows: o CPT CATEGORY (#81.1) data is in ^DIC(81.1, o CPT COPYRIGHT (#81.2) data is in ^DIC(81.2, o CPT MODIFIER (#81.3) data is in ^DIC(81.3, o CPT MODIFIER CATEGORY (#81.4) data is in ^DIC(81.4, o CPT SOURCE (#81.5) data is in ^DIC(81.5, ROUTINE: ******************** 452 NAME: DBIA452 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CPT/HCPCS CODES USAGE: Private ENTERED: APR 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.72 ROOT: SD(409.72, DESCRIPTION: TYPE: File Reason: To populate the Ambulatory Procedure Time Sensitive file with current CPT codes. ^SD(409.72 ROUTINE: ******************** 456 NAME: DBIA456 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.5 ROOT: PSI(58.5, DESCRIPTION: TYPE: File Used to extract the AR/WS statistics for a selected time frame. ^PSI(58.5,D0,0) .01 DATE 0;1 Pointed to ^PSI(58.5,D0,'S',D1,'AMIS',D2,0) .01 AMIS FIELD 0;1 Read w/Fileman 1 DOSES DISPENSED 0;2 Read w/Fileman 2 DISPENSED COST 0;3 Read w/Fileman 3 DOSES RETURNED 0;4 Read w/Fileman 4 RETURNS COST 0;5 Read w/Fileman ^PSI(58.5,D0,'S',D1,0) .01 INPATIENT SITE 0;1 Read w/Fileman ^PSI(58.5,D0,'S',D1,'DRG',D2,0) .01 DRUG 0;1 Read w/Fileman 2 MISSING DATA 0;2 Read w/Fileman ^PSI(58.5,D0,'S',D1,'DRG',D2,'CAT',D3,0) .01 CATEGORY 0;1 Read w/Fileman 1 QUANTITY DISPENSED 0;2 Read w/Fileman ^PSI(58.5,'B', to identify statistics for a selected time frame ROUTINE: ******************** 457 NAME: CLINICAL LEXICON EXPRESSIONS CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 26,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: 757.01 ROOT: GMP(757.01, DESCRIPTION: TYPE: File The Clinical Lexicon Utility will maintain static internal entry numbers (IENs) for the Expression file (#757.01). As a result, this file may be pointed to to retrieve the Display Text (.01) for both current Expressions and formerly used (deleted) Expressions. ^GMP(757.01,D0,0) .01 DISPLAY TEXT 0;1 Direct Global Read & w The Display Text contained in the Clinical Lexicon is the text which will be used in all display/print routines. ROUTINE: ******************** 458 NAME: DBIA458 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: APR 25,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MailMan 7.1 is permitted to the make calls to MAGAPI routine in the imaging package: ROUTINE: MAGAPI COMPONENT: MAGFILE VARIABLES: MAGXX Type: Input MAGXX is a pointer to the image file. MAGFILE Type: Output MAGFILE is an array containing data about the image passed to the MAGFILE routine. This entry point is used to get data about an image attached to a mail message. ******************** 459 NAME: DBIA459 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: APR 25,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 2005 ROOT: MAG(2005, DESCRIPTION: TYPE: File This agreement describes data that MailMan can access from the imaging package. ^MAG(2005,0) MailMan $ORDERs from here to test to see if there are images in the system and if there are none, assumes that imaging is not installed. ^MAG(2005,entry,0) .01 Image Name 0;1 Both R/W w/Fileman 2 DISK & VOL,MAGNETIC 0;3 Both R/W w/Fileman 1 FILEREF 0;2 Both R/W w/Fileman 3 OBJECT TYPE 0;6 Both R/W w/Fileman 14 COLLECTION DATE 0;9 Both R/W w/Fileman 2.1 DISK & VOLUME. - ABS 0;4 Both R/W w/Fileman 2.2 DISK & VOL.: WORM 0;5 Both R/W w/Fileman ROUTINE: ******************** 460 NAME: DBIA460 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: APR 25,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 2005.2 ROOT: MAG(2005.2, DESCRIPTION: TYPE: File MailMan has permission to access file 2005.2 so that it can find where images are and record their position appropriately. ^MAG(2005.2,entry,0) .01 NAME 0;1 Both R/W w/Fileman 1 PHYSICAL REFERENCE 0;2 Both R/W w/Fileman This file (NETWORK LOCATION) is used to store information about where an image may be found. ROUTINE: ******************** 461 NAME: DBIA461 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: APR 25,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 2005.02 ROOT: MAG(2005.02, DESCRIPTION: TYPE: File Before an image can be displayed, the type of file it is stored in must be known. ^MAG(2005.02,entry,0) .01 OBJECT TYPE 0;1 Both R/W w/Fileman The object type tells the software which software to use to display it. ROUTINE: ******************** 462 NAME: DBIA462 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 3,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MailMan has permission to call MAGAPI for 3 purposes. ROUTINE: MAGAPI COMPONENT: SELIM VARIABLES: Parameter1 Type: Input Pointer to the image file y Type: Output The pointer to the image chosen and its name (same as DIC output). SELIM^MAGAPI(x) allows MailMan to select an image from the image file to attach to a message. COMPONENT: ERASE VARIABLES: Parameter1 Type: Input Parameter1 is a pointer to the image. file. ERASE^MAGAPI(x) allows MailMan to erase an image from the screen. COMPONENT: EXPORT(X,Y,Z) VARIABLES: Parameter1 Type: Input When this entry point is called Imaging will copy an image into the export directory. x Type: Input Pointer to the image file. X Type: Input Directory to move an image into. Y Type: Input Pointer to the image file. Z Type: Input Wait flag if set to other than zero. Images must be in a special directory so that they can be transmitted across the network. This entry point creates a copy of the image file in that directory. COMPONENT: $$EXPORT(X,Y,Z) VARIABLES: ******************** 463 NAME: DBIA463 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 3,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MailMan has permission to call MAGBAPI so that images that are imported can be moved into a permanent storage location. ROUTINE: MAGBAPI COMPONENT: $$IMPORT(X) VARIABLES: X Type: Input Pointer to the image file. Y Type: Output Returned because call is in the form of an extrinsic function. Causes image file to be moved to a permanent location from the import directory. ******************** 464 NAME: DBIA464 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: APR 25,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MailMan has permission to call MAGOBJ in order to display an image on a screen while a user is reading a message. ROUTINE: MAGOBJ COMPONENT: ENTRY(X,Y,Z) VARIABLES: X Type: Input Pointer to the image file. Y Type: Input "DISPLAY" is the hardcoded value that is sent. Z Type: Input "" is the hardcoded value that is sent. This entry point displays an image. E.G. ENTRY^MAGOBJ(X,Y,Z) ******************** 465 NAME: DBIA465 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 26,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 52 ROOT: PSRX( DESCRIPTION: TYPE: File The Pharmacy Benefits Management software will use the prescription file to extract drug statistics for a selected time frame. ^PSRX(D0,0) .01 RX # 0;1 Read w/Fileman 6 DRUG 0;6 Read w/Fileman 7 QTY 0;7 Read w/Fileman 17 UNIT PRICE OF DRUG 0;17 Read w/Fileman ^PSRX(D0,1,D1,0) .01 REFILL DATE 0;1 Read w/Fileman 1 QTY 0;4 Read w/Fileman ROUTINE: ******************** 470 NAME: DBIA470 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: OCT 20,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2005 ROOT: MAG(2005 DESCRIPTION: TYPE: File The Medicine package has been given permission by the Imaging package to do the following: Point to the Imaging File (#2005) to reference each Medicine Procedure that has images. ^MAG(2005, The Medicine package is pointing to File 2005 to reference each Medicine Procedure that has images. ROUTINE: ******************** 472 NAME: DBIA472 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 26,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 50.8 ROOT: PS(50.8, DESCRIPTION: TYPE: File D&PPM extracts drug data from the IV Statistics file for a selected time frame. ^PS(50.8,D0,2,D1,2,D2,0) .01 IV DRUG 0;1 Read w/Fileman 1 DISPENSED UNIT (IV D 0;2 Read w/Fileman 2 RETURNED UNITS (IV D 0;3 Read w/Fileman 3 DESTROYED UNITS (IV 0;4 Read w/Fileman 4 AVERAGE DRUG COST PE 0;5 Read w/Fileman 5 DRUG UNIT 0;6 Read w/Fileman 6 TYPE 0;7 Read w/Fileman ROUTINE: ******************** 475 NAME: DBIA475 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 26,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 57.6 ROOT: PS(57.6 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts drug usage statistics for a selected time frame from the UNIT DOES PICK LIST STATS file. ^PS(57.6,D0,1,D1,1,D2,1,D3,0) .01 DRUG 0;1 Read w/Fileman 1 DISPENSED AMOUNT 0;2 Read w/Fileman 2 DISPENSED COST 0;3 Read w/Fileman 3 RETURNED AMOUNT 0;4 Read w/Fileman 4 RETURNED COST 0;5 Read w/Fileman ROUTINE: ******************** 479 NAME: DBIA479 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File Visit Tracking (PIMS/MAS) Entries used by Visit Tracking are passed by package developers making calls to the Visit Tracking package. The Visit Tracking package requests permission to read and point to the following file: Visit File Fields ----------------- #08 Clinic Pointer to the Clinic Stop File #40.7 ^DIC(40.7,D0,0) .01 NAME 0;1 Direct Global Read & w 1 AMIS REPORTING STOP 0;2 Direct Global Read & w ROUTINE: ******************** 480 NAME: DBIA480 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8 ROOT: DIC(8, DESCRIPTION: TYPE: File Visit File Field ---------------- #21 Eligibility Pointer to the Eligibility Code File #8 Visit Tracking software references the Eligibility Code file for the patient's eligibility. ^DIC(8,D0,0) .01 NAME 0;1 Pointed to .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 482 NAME: DBIA482 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Visit Tracking (PIMS/MAS) Entries used by Visit Tracking are passed by package developers making calls to the Visit Tracking package. The Visit Tracking package requests permission to read the following file: File Field ------------------------------------------------ Patient Movement #405 Date/Time #.01 VT Entry #.27 Ward Location #.06 ^DGPM(D0,0) .01 DATE/TIME Direct Global Read & w .27 VT ENTRY Direct Global Read & w .06 WARD LOCATION Direct Global Read & w ROUTINE: ******************** 483 NAME: DBIA483 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISIT TRACKING ENROLLMENT APPLICATION SYSTEM ORDER ENTRY/RESULTS REPORTING SCHEDULING MENTAL HEALTH Added 10/2/19 for Mental Health's Suicide Prevention Project (SPP) adding new functionality in patch YS*5.01*140 (MHA Forms) to provide clinicians with a web-based interface to submit a form as an Unsigned Note. USAGE: Controlled Subscri ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File Visit Tracking (PIMS/MAS) Entries used by Visit Tracking are passed by package developers making calls to the Visit Tracking package. The Visit Tracking package requests permission to read the following file: File Field ------------------------------------------------ MAS Parameter #43 Domiciliary Wards #16 ^DG(43,D0,0) 16 DOMICILIARY WARDS Direct Global Read & w ROUTINE: ******************** 484 NAME: DBIA484 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File Visit Tracking (PIMS/MAS) Entries used by Visit Tracking are passed by package developers making calls to the Visit Tracking package. The Visit Tracking package requests permission to read the following file: File Field -------------------------------------------------------------- Medical Center Division #40.8 Institution File Pointer #.07 ^DG(40.8,D0,0) .07 INSTITUTION FILE POI Direct Global Read & w ROUTINE: ******************** 485 NAME: DBIA485 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: MAY 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Visit Tracking (PIMS/MAS) Entries used by Visit Tracking are passed by package developers making calls to the Visit Tracking package. The Visit Tracking package requests permission to read the following file: ^DPT(D0,0) .01 NAME Direct Global Read & w ^DPT(D0,.36) .361 PRIMARY ELIGIBILITY Direct Global Read & w ^DPT(D0,E,0) .01 ELIGIBILITY Direct Global Read & w ROUTINE: ******************** 486 NAME: PSJEEU0 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: HEALTH SUMMARY ADVERSE REACTION TRACKING CONTROLLED SUBSTANCES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PSJEEU0 COMPONENT: ENHS VARIABLES: DFN Type: Input Internal entry number of the patient in the PATIENT file (2) for which orders are to be returned. PSJEDT Type: Input Internal VA Fileman date (opt). If PSJEDT is null, all Inpatient orders active on or after the current date/time are returned. If PSJEDT contains a date, all Inpatient orders active on or after that date are returned. List a patient's IV and Unit Dose medications. The output variables for this entry point are: For each Unit Dose order: ^UTILITY("PSG",$J,S1)=P1^P2^P3^P4^P5^P6^P7^P8^P9 where: S1 = The inverse of the start date/time of the order. If this subscript already exists, .000001 is subtracted from the date until it does not equal an existing subscript. P1 = The start date/time of the order. P2 = The stop dat/time of the order. P3 = The drug in the form of: a) If there is more than one dispense drug or a dosage ordered entered for the order - pointer to Orderable Item_:PS(50.7,_;_Orderable Item name_Dose Form b) If there is only one dispense drug and no dosage ordered entered for the order - pointer to Dispense drug_:PSDRUG(_;_Dispense drug name P4 = The provider in the form of - pointer to the New Person file_VA(200_;_name of the provider. P5 = The status of the order in the form of - status code_;_status name. P6 = The dosage ordered in the form of: a) If Orderable Item was sent in P3 - Dosage ordered b) If Dispense Drug was sent in P3 - Units Per Dose entered P7 = The med route of the order in the form of - pointer to the med route file_:PS(51.2,;_med route abbreviation_;_med route name. P8 = The schedule of the order. P9 = The schedule type of the order in the form of - schedule type code_;_schedule type name. For each IV order: ^UTILITY("PSIV",$J,S1,0)=P1^P2^P3^P4^P5^P6 ^UTILITY("PSIV",$J,S1,"A",S2)=P7^P8 ^UTILITY("PSIV",$J,S1,"S",S2)=P9^P10 where: S1 = The inverse of the start date/time of the order. If this subscript already exists, .000001 is subtracted from the date until it does not equal an existing subscript. S2 = A sequential number. P1 = The start date/time of the order. P2 = The stop dat/time of the order. P3 = The provider in the form of - pointer to the New Person file_VA(200_;_name of the provider. P4 = The status of the order in the form of - status code_;_status name. P5 = The infusion rate of the order P6 = The schedule of the order. P7 = An additive of the order in the form of - pointer to the IV Additive file_;_additive name. P8 = The strength of the additive in P7. P9 = A solution of the order in the form of - pointer to the IV Solutions file_;_solution name. P10 = The volume of the solution in P9. ******************** 488 NAME: DBIA488 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: MAY 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD(8984.1 AND 8984.2 DESCRIPTION: TYPE: File 1. DLL^XTLKMGR: This procedure non-interactively removes an entry from file 8984.4 and the associated variable pointer in the DD of 8984.1 and 8984.2. Line DLL+7 $orders on the variable pointer node to set DA, then ^DIK is called to remove the entry. ^DD(8984.2,.02,'V','B',+Y ^DD(8984.1,.02,'V','B',+Y ROUTINE: COMPONENT: DLL VARIABLES: ******************** 489 NAME: DBIA489 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Controlled Subscri ENTERED: SEP 18,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Interface with Visit Tracking to create Visits. ROUTINE: VSIT COMPONENT: VSIT VARIABLES: VSIT(0) Type: Input A string of characters that defines how the visit processor will function. F Force adding a new entry. I Interactive mode. E Use patients primary eligibility if not defined on call with VSIT("ELG"). N Allow creation of new visit. D Look back n number of days for matc h, defaults to one (1). D[] i.e., VSIT(0)="D7" e.g., VSIT(0)=" D5" (visit date to visit date - 4) use "D0" to require exact match on visit date and time. M Impose criteria on matching/screening of visits. Uses the VSIT() array: Matchin g elements must equal their corresponding field. VSIT(VDT) Type: Input The date [and time] of the visit. VSIT(IEN) Type: Input NUMBER (visit internal entry number) VSIT(CDT) Type: Input DATE VISIT CREATED (date) VSIT(TYP) Type: Input TYPE (set) VSIT(BIL) Type: Input THIRD PARTY BILLED (set) VSIT(PAT) Type: Input PATIENT NAME (pointer PATIENT file #9000001) (IHS file DINUMed to PATIENT f ile #2) VSIT(INS) Type: Input LOC. OF ENCOUNTER (pointer LOCATION file #9999999.06) VSIT(SVC) Type: Input SERVICE CATEGORY (set) VSIT(CLN) Type: Input CLINIC (pointer to CLINIC STOP file) VSIT(CTR) Type: Input DEPENDENT ENTRY COUNTER (number) VSIT(DEL) Type: Input DELETE FLAG (set) VSIT(LNK) Type: Input PARENT VISIT LINK (pointer VISIT file #9000010) VSIT(MDT) Type: Input DATE LAST MODIFIED (date) VSIT(XDT) Type: Input DATE VISIT EXPORTED (date) VSIT(MFI) Type: Input MFI STATUS (set) VSIT(LOS) Type: Input Evaluation and Management code pointer to the Type of Visit file (#357.69) VSIT(COD) Type: Input CHECK OUT DATE&TIME (date) VSIT(ELG) Type: Input ELIGIBILITY (pointer ELIGIBILITY CODE file #8) VSIT(LOC) Type: Input HOSPITAL LOCATION (pointer HOSPITAL LOCATION file #44) VSIT(USR) Type: Input CREATED BY USER (pointer NEW PERSON file #200) VSIT(OPT) Type: Input OPTION USED TO CREATE (pointer OPTION file #19) VSIT(AMT) Type: Input AMOUNT BILLED (number) VSIT(PRI) Type: Input PRIMARY TYPE OF VISIT FLAG. VSIT(OUT) Type: Input OUTSIDE LOCATION (free text) VSIT(AO) Type: Input AGENT ORANGE EXPOSURE (set) VSIT(SC) Type: Input Service connected (set) VSIT(EC) Type: Input PERSIAN GULF EXPOSURE (set) VSIT(SVP) Type: Input SERVICE PROVIDED (pointer to the service provided file #150.1) VSIT(IO) Type: Input INPATIENT OUTPATIENT VSIT(COM) Type: Input COMMENTS (free text) VSIT(IEN,P Type: Output PATIENT NAME (pointer PATIENT file #9000 001) (IHS file DINUMed to PATIENT f ile #2) VSIT( Type: Output N^S[^1] where: -1 = -2 = N = S = 1 = VSIT( Type: Output where: = IEN of visit. = Mnemonics for Zer o node of visit. VSIT(ien,B Type: Output THIRD PARTY BILLED (set) VSIT(ien,C Type: Output DATE VISIT CREATED (date) VSIT(ien,C Type: Output CLINIC (pointer to CLINIC STOP file) VSIT(ien,C Type: Output CHECKOUT DATE&TIME (date) VSIT(ien,C Type: Output DEPENDENT ENTRY COUNTER (number) VSIT(ien,D Type: Output DELETE FLAG (set) VSIT(ien,E Type: Output ELIGIBILITY (pointer ELIGIBILITY CODE file #8) VSIT(ien,I Type: Output LOC. OF ENCOUNTER (pointer LOCATION file #9999999.06) VSIT(ien,L Type: Output PARENT VISIT LINK (pointer VISIT file #9000010) VSIT(ien,L Type: Output HOSPITAL LOCATION (pointer HOSPITAL LOCATION file #44) VSIT(ien,L Type: Output EVALUATION AND MANAGEMENT CODE (pointer to the type of visit file (#357.69) VSIT(ien,M Type: Output DATE LAST MODIFIED (date) VSIT(ien,M Type: Output MFI STATUS (set) VSIT(ien,O Type: Output OPTION USED TO CREATE (pointer OPTION file #19) VSIT(ien,S Type: Output SERVICE CATEGORY (set) VSIT(ien,T Type: Output TYPE (set) VSIT(ien,U Type: Output CREATED BY USER (pointer NEW PERSON file #200) VSIT(ien,V Type: Output The date [and time] of the visit. VSIT(ien,W Type: Output WALK IN APPOINTMENT (set) VSIT(WIA) Type: Input WALK IN APPOINTMENT (set) VSIT(ien,X Type: Output DATE VISIT EXPORTED (date) VSIT(HNC) Type: Input HEAD AND NECK CANCER (set) VSIT(IR) Type: Input IONIZING RADIATION EXPOSURE(set) VSIT(MST) Type: Input MILITARY SEXUAL TRAUMA (set) VSIT(CV) Type: Input COMBAT VETERAN (set) VSIT(SHAD) Type: Input PROJ 112/SHAD (set) VSIT(CLV) Type: Input CAMP LEJEUNE EXPOSURE (set) Entry Point to Find or Create a Visit. ******************** 491 NAME: DBIA491 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: EVENT CAPTURE OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: JUN 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 7 ROOT: DIC(7 DESCRIPTION: TYPE: File Read access to the .01 field of the provider class file for provider identification. ^DIC(7,DA,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 492 NAME: DBIA492 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: JUN 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.1 ROOT: PRCD(420.1, DESCRIPTION: TYPE: File DMMS units must be associated with a cost center to make it possible associate the work for the unit as gathered in DHCP with financial data contained in reports from the AAC. To this end, we request read access to the COST CENTER file (420.1). Currently the CC field is a 6 digit code with the first 4 being Cost Center and the last two being Sub-cost center. Thats how it is broken up to pass to FMS for IFCAP V5.0. Current plans are to increase the code to 8 digits. There are discussions going on between OF&IRM and VAH's CFO's office. At some point IFCAP will be changing the content of the file. When that happens, this DBIA will have to be revisited. ^PRCD(420.1,DA,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 500 NAME: DBIA15-B CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 72 ROOT: RA( DESCRIPTION: TYPE: File EXAMINATION STATUS ^RA(72,0) .01 CURRENT EXAM STATUS 1 Read w/Fileman ROUTINE: ******************** 501 NAME: DBIA15-C CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY CLINICAL CASE REGISTRIES USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT( DESCRIPTION: TYPE: File RADIOLOGY REPORTS FILE ^RARPT( 5 REPORT STATUS 0;5 Read w/Fileman ^RARPT(D0,"R", .01 REPORT TEXT 0;1 Read w/Fileman ^RARPT(D0,"I", .01 IMPRESSION TEXT 0;1 Read w/Fileman ^RARPT(D0,"H", .01 ADDITIONAL CLINICAL 0;1 Read w/Fileman ROUTINE: ******************** 502 NAME: DBIA15-D CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71, DESCRIPTION: TYPE: File RADIOLOGY PROCEDURES FILE ^RAMIS(71,D0,0) .01 NAME 0;1 Direct Global Read & w 9 CPT CODE 0;9 Direct Global Read & w 6 TYPE OF PROCEDURE 0;6 Direct Global Read & w ROUTINE: ******************** 503 NAME: DBIA15-E CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71.2 ROOT: RAMIS(71.2, DESCRIPTION: TYPE: File PROCEDURE MODIFIERS FILE ^RAMIS(71.2,D0,0) .01 NAME 1 Read w/Fileman ROUTINE: ******************** 504 NAME: DBIA15-F CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 23,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 75.1 ROOT: RAO(75.1, DESCRIPTION: TYPE: File RADIOLOGY ORDERS FILE ^RAO(75.1,'AS', ^RAO(75.1, 1.1 REASON FOR STUDY Read w/Fileman 2 PROCEDURE Read w/Fileman 5 REQUEST STATUS Read w/Fileman 14 REQUESTING PHYSICIAN Read w/Fileman 16 REQUEST ENTERED DATE Read w/Fileman 23 SCHEDULED DATE (TIME Read w/Fileman ROUTINE: ******************** 505 NAME: DBIA5-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19.1 ROOT: DIC(19.1, DESCRIPTION: TYPE: File This ICR had been retired, but was reactivated due to a review of patch OR*3*397, where SQA found ORUPREF1 had some pre-existing code (probably going back to the original package release) that reads from file 19.1. The reads are to: 1. ^DIC(19.1,"B",X,D0) ? B cross-reference 2. ^DIC(19.1,D0,1,D1,0) ? Description ^DIC(19.1 Used to access security keys. ROUTINE: ******************** 507 NAME: DBIA4-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: XUTL( DESCRIPTION: TYPE: File ^XUTL('OR',$J Used to hold package defined parameters in ^XUTL("OR",$J,package namespace,... This node is killed by menuman when the terminal session ends. ROUTINE: ******************** 508 NAME: DBIA6-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File ^DD('DD') Used to format date. ROUTINE: ******************** 510 NAME: DISV CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING OE/RR requests the following access to the DISV global. All are ^DISV(DUZ,x where x is defined as follows: The only non-file reference we use is "ORDITM". Read and write. We save under "^DPT" to save the patient looked up through the GUI. Read and write. We retrieve "^GMT(142," to default the last health summary type the user referenced. Read only. There is also a utility routine ORUS which will end up doing a kill, set, or read in DISV. The called utility looks like it can be called in with "^XUTL("OR",$J,"ORLP",","^ORD(100.9,", or multiples from "^OR(100.21,n,sub," where sub is 1, 2, or 10. This one is a carryover from previous versions. Read, write, and delete. READ access allowed. WRITE access allowed in routines ORGUEM, and ORUS1. An example of a set is S ^DISV(DUZ,"^ORD(101,")=+ORGMENU DELETE access allowed in ORUS1. KERNEL The Unwinder uses ^DISV(DUZ,"XQORM") to store the items that were selected for spacebar recall. READ and WRITE access to ^DISV(DUZ,"XQORM") allowed. LAB SERVICE Laboratory V 5.2 uses ^DISV(DUZ,"LRACC") and ^DISV(DUZ,"LRAN") to store items. An example is in routine LRACC at line LRACC+4: S:$L(X)>2 ^DISV(DUZ,"LRACC")=X S:X=" " X=$S($D(^DISV(DUZ,"LRACC")): ^("LRACC"),1:"?") READ and WRITE access to ^DISV(DUZ,"LRACC") and ^DISV(DUZ,"LRAN" allowed. TEXT INTEGRATION UTILITIES READ access allowed. Added read access to ^DISV(DUZ,"^TIU("_FILE_",") for TIU*1*197. WRITE access allowed to ^DISV(DUZ,"VALMMENU", DISCHARGE SUMMARY READ access allowed. CONSULT/REQUEST TRACKING READ access allowed. IFCAP READ access allowed. The inventory package V5 uses the global ^DISV(DUZ,"PRCProutine name", and ^DISV(DUZ,globalnode, to allow the user to press the space bar to select the last response. WRITE access allowed. The reference to ^DISV(DUZ,"PRCProutine", is used to store non-fileman responses to the reader. NURSING SERVICE Read access "Till Otherwise Agreed". QUASAR PCE PATIENT CARE ENCOUNTER TOOLKIT The parameter tools component of toolkit would like permission to use DISV to allow spacebar-return within the parameter tools edit option. This will allow the most recently selected parameters and entities to be recalled by a user when editing. This information is stored in ^DISV(DUZ,"XPAR01",... ACCOUNTS RECEIVABLE WOMEN'S HEALTH LEXICON UTILITY GEN. MED. REC. - VITALS CLINICAL REMINDERS HEALTH SUMMARY JSH/10-23-2006 Added per agreement between Skip Ormsby & Jason Hawsey. Health Summary reads global reference ^DISV(DUZ,"^GMT(142,") in order to get the last chosen Health Summary Type. It uses the value found here as the default in the prompt to choose a Health Summary Type. SCHEDULING ADDED 5/11/09 OUTPATIENT PHARMACY 04/11/11 Outpatient Pharmacy is providing a standalone option, PSO HRC PROFILE/REFILL, to the Compensation and Pension Record Interchange (CAPRI) package. OP requests read and write access to ^DISV(DUZ,"VALMMENU",x) when the protocol x is PSO PENDING ORDER MENU. The node value for x will be temporarily set to 0 (if it is not, and reset after use to its original value) so as to turn off the display of actions associated with this protocol. EVENT CAPTURE Event Capture patient data filer sets the following DISV nodes for recall when entering multiple patient records. ^DISV(DUZ,"^ICD9(") is set to recall the last ICD code ^DISV(DUZ,"^VA(200,") is set to recall the last provider DRG GROUPER DRG Grouper READ and WRITE access to: ^DISV(DUZ,"^ICD9(")=IEN ^DISV(DUZ,"^ICD0(")=IEN REGISTRATION REGISTRATION: After a user selects a patient in the PTF file (#45) in routine DGPTF, the routine will set the following DISV node for recall: ^DISV(DUZ,"^DPT(") to recall the selected patient HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** Health MGMT Platform (HMP) uses ^DISV(DUZ, "HMPM EVT QUE MGR", X), where X can be HMPSRV, HMPDOM, HMPFIL, HMPDFN, HMPLIM. This allows HMP to recall default values for the user in routine HMPEQLM. READ and WRITE access to ^DISV(DUZ, "HMPM EVT QUE MGR", X) allowed. USAGE: Controlled Subscri ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DISV( DESCRIPTION: TYPE: File Used to process 'space-bar return' on user input. ROUTINE: ******************** 511 NAME: DBIA6-D CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING LAB SERVICE HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: JUL 27,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DIC( DESCRIPTION: TYPE: File ^DIC("AC" - Screen lookup on files of a particular application group. ^DIC('AC',namespace, ROUTINE: ******************** 512 NAME: DBIA17-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 12,1990 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGPMLOS COMPONENT: DGPMLOS VARIABLES: Used to determine Length of Stay. ******************** 513 NAME: DBIA30-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK USAGE: Private ENTERED: MAR 1,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File ^DIC(45.7,0) .01 NAME 0;1 Read w/Fileman 1 SPECIALTY 0;2 Read w/Fileman Name of original agreement was BEDSECTION. It appears to be in error The correct name should be SPECIALTY. DCM ROUTINE: ******************** 514 NAME: DBIA31-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK USAGE: Private ENTERED: NOV 14,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.5 ROOT: DGWAIT( DESCRIPTION: TYPE: File ^DGWAIT(D0,0) .01 DIVISION 0;1 Read w/Fileman ROUTINE: ******************** 515 NAME: DBIA31-C CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTO REPLENISHMENT/WARD STOCK USAGE: Private ENTERED: NOV 14,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File ^SC(D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 519 NAME: FACILITY TREATING SPECIALTY (#45.7) File Access CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VA Point of Service (Kiosks) VPS will use the "B" cross reference on file #45.7 to get the IEN of a Facility Treating Specialty. USAGE: Private ENTERED: MAR 22,1989 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File ^DIC(45.7 Used to lookup treating specialty and print name ROUTINE: ******************** 524 NAME: DBIA67-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY DSS - DECISION SUPPORT SYSTEM EX CLINICAL REMINDERS VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61 ROOT: LAB(61, DESCRIPTION: TYPE: File ^LAB(61,D0,0) .01 NAME 0;1 Direct Global Read & w 2 SNOMED CODE 0;2 Direct Global Read & w 4.1 COLLECTION SAMPLE 0;6 Direct Global Read & w ROUTINE: ******************** 525 NAME: DBIA67-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY CLINICAL CASE REGISTRIES WOMEN'S HEALTH ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS DSS - DECISION SUPPORT SYSTEM EX MRSA INITIATIVE REPORTS ADDED 4/23/09 NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD USAGE: Controlled Subscri ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Next Version VERSION: LAB 5.2 FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File This DBIA needed to be updated for HS 2.7 to include additional data for several of the HS components. This was done on June 12, 1995. For the next version of either Lab or Health Summary a LAB API will need to be set up to access this data. ^TMP("LRA",$J, may be Set and Killed during collection of field data. ditto ^TMP("LRCY",$J, ditto ^TMP("LRM",$J, ^LR(D0,'CH',D1,0) .03 DATE REPORT COMPLETE 0;3 Direct Global Read & w .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .05 SPECIMEN TYPE 0;5 Direct Global Read & w .06 ACCESSION 0;6 Direct Global Read & w .11 REQUESTING LOCATION 0;11 Direct Global Read & w ^LR(D0,'CH',D1,1,D2,0) .01 COMMENT 0;1 Direct Global Read & w ^LR(D0,'CH',D1,2...x) x TEST RESULT ~ FLAG Piece 1, Direct Global Read & w ^LR(D0,'MI',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .03 DATE REPORT COMPLETE 0;3 Direct Global Read & w .05 SITE/SPECIMEN 0;5 Read w/Fileman .06 MICROBIOLOGY ACCESSI 0;6 Direct Global Read & w .08 WARD 0;8 Direct Global Read & w .055 COLLECTION SAMPLE 0;11 Read w/Fileman ^LR(D0,'MI',D1,1) 11.5 BACT RPT STATUS 0;2 Read w/Fileman 11.58 SPATUM SCREEN 0;5 Read w/Fileman 11.57 URINE SCREEN 0;6 Read w/Fileman 11.51 STERILITY CONTROL 0;7 Read w/Fileman ^LR(D0,'MI',D1,5) 15 PARASITE RPT STATUS 0;2 Read w/Fileman ^LR(D0,'MI',D1,8) 19 MYCOLOGY RPT STATUS 0;2 Read w/Fileman ^LR(D0,'MI',D1,11) 23 TB RPT STATUS 11;2 Read w/Fileman 24 ACID FAST STAIN 11;3 Read w/Fileman 25 QUANTITY 11;4 Read w/Fileman ^LR(D0,'MI',D1,16) 34 VIROLOGY REPORT STAT 0;2 Read w/Fileman ^LR(D0,'MI',D1,2,D2,0) .01 GRAM STAIN 0;1 Direct Global Read & w ^LR(D0,'MI',D1,3,D2,0) .01 ORGANISM 0;1 Direct Global Read & w 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,3,D2,2.0001...x) x ANTIBIOTIC 0;1 Direct Global Read & w x.1 INTERP 0;2 Direct Global Read & w x.2 SCREEN 0;3 Direct Global Read & w ^LR(D0,'MI',D1,4,D2,0) .01 BACT RPT REMARK 0;1 Direct Global Read & w ^LR(D0,'MI',D1,6,D2,0) .01 PARASITE 0;1 Direct Global Read & w ^LR(D0,'MI',D1,6,D2,1,D3,0) .01 STAGE 0;1 Read w/Fileman 1 QUANTITY 0;2 Read w/Fileman ^LR(D0,'MI',D1,7,D2,0) .01 PARASITE RPT REMARK 0;1 Direct Global Read & w ^LR(D0,'MI',D1,9,D2,0) .01 FUNGUS/YEAST 0;1 Direct Global Read & w 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,10,D2,0) .01 MYCOLOGY RPT REMARK 0;1 Direct Global Read & w ^LR(D0,'MI',D1,12,D2,0) .01 MYCOBACTERIUM 0;1 Direct Global Read & w 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,13,D2,0) .01 TB RPT REMARK 0;1 Direct Global Read & w ^LR(D0,'MI',D1,17,D2,0) .01 VIRUS 0;1 Direct Global Read & w ^LR(D0,'MI',D1,18,D2,0) .01 VIROLOGY RPT REMARK 0;1 Direct Global Read & w ^LR(D0,0) .05 ABO GROUP 0;5 Direct Global Read & w .06 RH TYPE 0;6 Direct Global Read & w ^LR(D0,1.6,D1,0) .01 TRANSFUSION DATE/TIM 0;1 Direct Global Read & w .02 COMPONENT 0;2 Direct Global Read & w .07 UNITS POOLED 0;7 Direct Global Read & w ^LR(D0,'SP',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .06 SURGICAL PATH ACC # 0;6 Direct Global Read & w .11 REPORT RELEASE DATE/ 0;11 Direct Global Read & w ^LR(D0,'SP',D1,.1,D2,0) .01 SPECIMEN 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1,D2,0) .01 GROSS DESCRIPTION 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1.1,D2,0) .01 MICROSCOPIC DESCRIPT 0;1 Direct Global Read & w ^LR(D0,'SP',D1,2,D2,0) .01 ORGAN/TISSUE 0;1 Read w/Fileman ^LR(D0,'SP',D1,2,D2,2,D3,0) .01 MORPHOLOGY 0;1 Read w/Fileman ^LR(D0,'SP',D1,2,D2,2,D3,1,D4,0) .01 ETIOLOGY 0;1 Read w/Fileman ^LR(D0,'SP',D1,2,D2,4,D3,0) .01 PROCEDURE 0;1 Read w/Fileman ^LR(D0,'SP',D1,3,D2,0) .01 ICD DIAGNOSIS 0;1 Read w/Fileman ^LR(D0,'CY',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .06 ACCESSION # 0;6 Direct Global Read & w .11 REPORT RELEASE DATE/ 0;11 Direct Global Read & w ^LR(D0,'CY',D1,.1,0) .01 SPECIMEN 0;1 Direct Global Read & w ^LR(D0,'CY',D1,1,D2,0) .01 GROSS DESCRIPTION 1;0 Direct Global Read & w ^LR(D0,'CY',D1,1.1,D2,0) .01 MICROSCOPIC EXAMINAT 1;0 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,0) .01 CYTOPATH ORGAN/TISSU 0;1 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,1,D3,0) .01 DISEASE 0;1 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,2,D3,0) .01 MORPHOLOGY 0;1 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,2,D3,1,D4,0) .01 ETIOLOGY 0;1 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,4,D3,0) .01 PROCEDURE 0;1 Direct Global Read & w ^LR(D0,'CY',D1,2,D2,3,D3,0) .01 ICD DIAGNOSIS 0;1 Direct Global Read & w ^LR(D0,'CY',D1,1.4,0) .01 CYTOPATHOLOGY DIAGNO 1.4;0 Direct Global Read & w ^LR(D0,'CY',D1,1.2,D2,0) .01 SUPPLEMENTARY REPORT 0;1 Direct Global Read & w .02 RELEASE SUPPLEMENTAR 0;2 Direct Global Read & w ^LR(D0,'CY',D1,1.2,D2,1,0) 1 DESCRIPTION 1;0 Direct Global Read & w ^LR(D0,'CY',D1,3,D2,0) .01 ICD DIAGNOSIS 0;1 Direct Global Read & w ^LR(D0,'CY',D1,.2,D2,0) .01 BRIEF CLINICAL HISTO .2;0 Direct Global Read & w ^LR(D0,'SP',D1,.2,0) ^LR(D0,'SP',D1,.2,D2,0) .01 BRIEF CLINICAL HISTO 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1.2,D2,0) .01 SUPPLEMENTARY REPORT 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1.2,D2,1,D3,0) .01 DESCRIPTION 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1.3,D2,0) .01 FROZEN SECTION 0;1 Direct Global Read & w ^LR(D0,'SP',D1,1.4,D2,D2,0) .01 SURGICAL PATH DIAGNO 0;1 Direct Global Read & w ^LR(D0,'MI',D1,6,D2,1,D3,1,D4,0) .01 COMMENT 0;1 Direct Global Read & w ^LR(D0,'MI',D1,9,D2,1,D3,0) .01 COMMENT 0;1 Direct Global Read & w ^LR(D0,'MI',D1,12,D2,1,0) .01 COMMENT 0;1 Direct Global Read & w ^LR(D0,'MI',D1,12,D2,2.0001...X) X SUSCEPTABILITIES X;1 Direct Global Read & w ^LR(D0,'MI',D1,14,D2,0) .01 ANTIBIOTIC(for SERUM 0;1 Direct Global Read & w 1 DRAW TIME 0;2 Direct Global Read & w 2 CONC(ug/ml) 0;3 Direct Global Read & w ^LR(D0,'MI',D1,15,D2,0) 19.6 MYCOLOGY SMEAR/PREP 0;1 Direct Global Read & w ^LR(D0,'MI',D1,24,D2,0) 15.51 PARASITOLOGY SMEAR/P 0;1 Direct Global Read & w ^LR(D0,'MI',D1,31,D2,0) 11.52 STERILITY RESULTS 0;1 Direct Global Read & w ^LR(D0,'MI',D1,99) .99 COMMENT ON SPECIMEN 99;1 Read w/Fileman ^LR(D0,'MI',D1,3,D2,1,D3,0) .01 COMMENT 0;1 Direct Global Read & w ^LR(D0,'MI',D1,25,D2,0) 11.7 BACTERIOLOGY SMEAR/P 0;1 Direct Global Read & w ^LR(D0,'EM',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .06 ACCESSION # 0;6 Direct Global Read & w .11 REPORT RELEASE DATE 0;11 Direct Global Read & w ^LR(D0,'EM',D1,.1,D2,0) .01 SPECIMEN 0;1 Direct Global Read & w ^LR(D0,'EM',D1,.2,D2,0) .01 BRIEF CLINICAL HISTO 0;1 Direct Global Read & w ^LR(D0,'EM',D1,1,D2,0) .01 GROSS DESCRIPTION 0;1 Direct Global Read & w ^LR(D0,'EM',D1,1.1,D2,0) .01 MICROSCOPIC EXAMINAT 0;1 Direct Global Read & w ^LR(D0,'EM',D1,1.2,D2,1,D3,0) .01 DESCRIPTION 0;1 Direct Global Read & w ^LR(D0,'EM',D1,1.2,D2,0) .01 SUPPLEMENTARY REPORT 0;1 Direct Global Read & w ^LR(D0,'EM',D1,1.4,D2,0) .01 EM DIAGNOSIS 0;1 Direct Global Read & w ^LR(D0,'EM',D1,2,D2,0) .01 EM ORGAN/TISSUE 0;1 Read w/Fileman ^LR(D0,'EM',D1,2,D2,2,D3,0) .01 MORPHOLOGY 0;1 Read w/Fileman ^LR(D0,'EM',D1,2,D2,2,D3,1,D4,0) .01 ETIOLOGY 0;1 Read w/Fileman ^LR(D0,'EM',D1,2,D2,4,D3,0) .01 PROCEDURE 0;1 Read w/Fileman ^LR(D0,'EM',D1,3,D2,0) .01 ICD9CM CODE 0;1 Read w/Fileman ^LR(D0,'EM',D1,2,D2,1,D3,0) .01 DISEASE 0;1 Read w/Fileman ^LR(D0,'EM',D1,.2,0) .013 BRIEF CLINICAL HISTO Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'EM',D1,1.1,0) 1.1 MICROSCOPIC EXAMINAT Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'EM',D1,1.2,0) 1.2 SUPPLEMENTARY REPORT Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'EM',D1,1.4,0) 1.4 EM DIAGNOSIS Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'SP',D1,.2,0) .013 BRIEF CLINICAL HISTO Direct Global Read & w Check 3rd piece of Multiple Header to see if data exists. ^LR(D0,'SP',D1,1,0) 1 GROSS DESCRIPTION Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'SP',D1,1.2,0) 1.2 SUPPLEMENTARY REPORT Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'SP',D1,1.3,0) 1.3 FROZEN SECTION Direct Global Read & w Check 3rd piece of multiple header to see if data exists. ^LR(D0,'SP',D1,1.4,0) 1.4 SURGICAL PATH DIAGNO Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ^LR(D0,'SP',D1,1.1,0) 1.1 MICROSCOPIC DESCRIPT Direct Global Read & w Check 3rd piece of Multiple header to see if data exists. ROUTINE: ******************** 526 NAME: DBIA67-D CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61.2 ROOT: LAB(61.2, DESCRIPTION: TYPE: File ^LAB(61.2,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 527 NAME: DBIA67-E CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 65 ROOT: LRD(65, DESCRIPTION: TYPE: File This agreement allows the Health Summary package to look at specified fields in the Lab Package in order to display Blood Bank related information on a patient. Amended 7-18-97 to include field .16, DIVISION on some reports. ^LRD(65,D0,0) .01 UNIT ID 0;1 Direct Global Read & w .06 EXPIRATION DATE/TIME 0;6 Direct Global Read & w .07 ABO GROUP 0;7 Direct Global Read & w .08 RH TYPE 0;8 Direct Global Read & w .11 VOLUME (ml) 0;11 Direct Global Read & w .16 DIVISION 0;16 Direct Global Read & w ^LRD(65,D0,4) 4.1 DISPOSITION 0;1 Read w/Fileman ^LRD(65,D0,8) 8.3 DONATION TYPE 0;3 Read w/Fileman ^LRD(65,D0,2,D1,0) .02 DATE/TIME UNIT ASSIG 0;2 Direct Global Read & w ^LRD(65,D0,2,D1,1,D2,0) .04 XMATCH RESULT 0;4 Read w/Fileman ^LRD(65,'AP', PATIENT XMATCHED/ASSIGNED ROUTINE: ******************** 528 NAME: DBIA67-F CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 66 ROOT: LAB(66, DESCRIPTION: TYPE: File Note: This IA will become void upon the release of VBECS. ^LAB(66,D0,0) .01 NAME 0;1 Direct Global Read & w .02 ABBREVIATION 0;2 Direct Global Read & w BLOOD PRODUCT FILE ROUTINE: ******************** 529 NAME: DBIA67-G CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61.1 ROOT: LAB(61.1, DESCRIPTION: TYPE: File ^LAB(61.1,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 530 NAME: DBIA67-H CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 62.05 ROOT: LAB(62.05, DESCRIPTION: TYPE: File ^LAB(62.05,D0,0) .01 URGENCY 0;1 Direct Global Read & w ROUTINE: ******************** 531 NAME: DBIA67-I CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 68 ROOT: LRO(68, DESCRIPTION: TYPE: File ^LRO(68,D0,1,D1,1,D2,.2) 15 ACCESSION .2;1 Direct Global Read & w ^LRO(68,D0,1,D1,1,D2,4,D3,0) .01 TESTS 0;1 Direct Global Read & w 4 COMPLETE DATE 0;5 Direct Global Read & w ROUTINE: ******************** 532 NAME: DBIA67-J CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 69 ROOT: LRO(69, DESCRIPTION: TYPE: File Data is passed in ^TMP("LRO",$J, which may be killed before and after its use. ^LRO(69,D0,1,D1,0) 4 LAB,IMM OR WARD COLL 0;4 Direct Global Read & w 5 DATE/TIME ORDERED 0;5 Direct Global Read & w 7 PROVIDER 0;6 Direct Global Read & w 8 REPORT ROUTING LOCAT 0;7 Direct Global Read & w ^LRO(69,D0,1,D1,1) 10 DATE/TIME OF COLLECT 0;1 Direct Global Read & w ^LRO(69,D0,1,D1,3) 21 DATE/TIME RESULTS AV 3;2 Direct Global Read & w ^LRO(69,D0,1,D1,2,D2,0) .01 TEST/PROCEDURE 0;1 Direct Global Read & w 1 URGENCY 0;2 Direct Global Read & w 2 ACCESSION DATE 0;3 Direct Global Read & w 3 ACCESSION AREA 0;4 Direct Global Read & w 4 ACCESSION NUMBER 0;5 Direct Global Read & w ^LRO(69,'D', Get patient LRDFN. ROUTINE: ******************** 534 NAME: DBIA68-C CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.1 ROOT: PS(53.1, DESCRIPTION: TYPE: File For non-verified orders: ^PS( 53.1 1 Provider 3 Medicinal Route 7 Schedule Type 10 Start Date/Time 26 Schedule 28 Status 25 Stop Date/Time 53.11 .01 Drug 1 Dosage Ordered The following cross-references are used: ^PS( 53.1 "AC" Stop Date/Time ROUTINE: ******************** 537 NAME: DBIA69-D CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JAN 31,1991 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 52.7 ROOT: PS(52.7, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. ^PS(52.7, IV SOLUTION FILE 52.7 .01 Solution Name ROUTINE: ******************** 539 NAME: DBIA75-B CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 606.5 ROOT: YSP(606.5, DESCRIPTION: TYPE: File Agreement has been made for Health Summary to access the following fields in the Mental Health Progress Notes files. - Globals accessed are: ^YSP(606.5, Prgress Note Type - The following fields are accessed: ^YSP(606.5, 606.5 .01 TYPE ROUTINE: ******************** 540 NAME: DBIA80-B CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 699 ROOT: MCAR(699, DESCRIPTION: TYPE: File The Health Summary exports and calls the routine GMTSMCPS, which generates the output for the Health Summary Medicine component. The following fields and cross references are being referenced: ^MCAR(699, Endoscopy File Fields: 1 Procedure 20 Summary ROUTINE: ******************** 541 NAME: DBIA80-C CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 694 ROOT: MCAR(694, DESCRIPTION: TYPE: File The Health Summary exports and calls the routine GMTSMCPS, which generates the output for the Health Summary Medicine component. The following fields and cross references are being referenced: ^MCAR(694, Hematology File Fields: 2 Procedure 1.5 Summary ROUTINE: ******************** 542 NAME: DBIA80-D CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 697.2 ROOT: MCAR(697.2, DESCRIPTION: TYPE: File The Health Summary exports and calls the routine GMTSMCPS, which generates the output for the Health Summary Medicine component. The following fields and cross references are being referenced: ^MCAR(697.2, Procedure Location File Fields: .01 Name 1 Global Location Uses "C" cross reference on Global Location field. The "C" cross reference could result in pointing to global locations in the Global Location field which currently contains global roots for the range on files from ^MCAR(691, through ^MCAR(699,. ROUTINE: ******************** 543 NAME: DBIA85-B CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 9,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 190.1 ROOT: RTV(190.1, DESCRIPTION: TYPE: File 1. Activation interface 2. Make an appointment Checkin/unscheduled visit 3. Cancel an appointment 4. Changing clinic names 1. Use of the Record Tracking System Parameter file # 195.4 SD calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ 2. When a clinic appointment is made if the appointment is 'today' or if the Record Tracking System Parameter 'Batch requests' is set to 'No' or if records are requested for an unscheduled visit. A. An entry is made in the Requested Records file #190.1 ^RTV(190.1,n) by a call from RT^SDUTL to a tasked job QUE^RTQ or RT^SDI B. After the entry is added to the Requested Records file #190.1 an entry is made in Parent Record Request field of the Patient subfield of the Hospital Location file #44 ^SC(n,"S",,,,"RTR")=n^ by a return call from CREATE+11^RTQ2 to RTSET^SDUTL 3. When a clinic appointment is canceled: If there is a Requested Records entry in file #190.1 the status is changed to 'canceled' by a call RTV(190.1,n)=^^^^^x^ from RT+2^SDUTL to CANCEL^RTQ2. 4. When the name of a clinic is changed the corresponding names of entries in the Pull List file #194.2 are changed by a trigger on the .01 field of the Hospital Location file #44. Clinic ^SC(1,0)=DJones Medical Clinic^ ^RTV(194.2,n)=Dr Jones Medical Clinic [04/01/91]^ Clinic names are changed in a compiled input template. To insure the use of this trigger the following action is taken: The Record Tracking package includes the .01 field of the Hospital Location file #44 so that the SDB template is re-compiled when the Record Tracking package is initialized. ROUTINE: ******************** 544 NAME: DBIA85-C CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 9,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 1. Activation interface 2. Make an appointment Checkin/unscheduled visit 3. Cancel an appointment 4. Changing clinic names 1. Use of the Record Tracking System Parameter file # 195.4 SD calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ 2. When a clinic appointment is made if the appointment is 'today' or if the Record Tracking System Parameter 'Batch requests' is set to 'No' or if records are requested for an unscheduled visit. A. An entry is made in the Requested Records file #190.1 ^RTV(190.1,n) by a call from RT^SDUTL to a tasked job QUE^RTQ or RT^SDI B. After the entry is added to the Requested Records file #190.1 an entry is made in Parent Record Request field of the Patient subfield of the Hospital Location file #44 ^SC(n,"S",,,,"RTR")=n^ by a return call from CREATE+11^RTQ2 to RTSET^SDUTL 3. When a clinic appointment is canceled: If there is a Requested Records entry in file #190.1 the status is changed to 'canceled' by a call RTV(190.1,n)=^^^^^x^ from RT+2^SDUTL to CANCEL^RTQ2. 4. When the name of a clinic is changed the corresponding names of entries in the Pull List file #194.2 are changed by a trigger on the .01 field of the Hospital Location file #44. Clinic ^SC(1,0)=DJones Medical Clinic^ ^RTV(194.2,n)=Dr Jones Medical Clinic [04/01/91]^ Clinic names are changed in a compiled input template. To insure the use of this trigger the following action is taken: The Record Tracking package includes the .01 field of the Hospital Location file #44 so that the SDB template is re-compiled when the Record Tracking package is initialized. ROUTINE: RTQ COMPONENT: QUE VARIABLES: ******************** 545 NAME: DBIA85-D CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 9,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 1. Activation interface 2. Make an appointment Checkin/unscheduled visit 3. Cancel an appointment 4. Changing clinic names 1. Use of the Record Tracking System Parameter file # 195.4 SD calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ 2. When a clinic appointment is made if the appointment is 'today' or if the Record Tracking System Parameter 'Batch requests' is set to 'No' or if records are requested for an unscheduled visit. A. An entry is made in the Requested Records file #190.1 ^RTV(190.1,n) by a call from RT^SDUTL to a tasked job QUE^RTQ or RT^SDI B. After the entry is added to the Requested Records file #190.1 an entry is made in Parent Record Request field of the Patient subfield of the Hospital Location file #44 ^SC(n,"S",,,,"RTR")=n^ by a return call from CREATE+11^RTQ2 to RTSET^SDUTL 3. When a clinic appointment is canceled: If there is a Requested Records entry in file #190.1 the status is changed to 'canceled' by a call RTV(190.1,n)=^^^^^x^ from RT+2^SDUTL to CANCEL^RTQ2. 4. When the name of a clinic is changed the corresponding names of entries in the Pull List file #194.2 are changed by a trigger on the .01 field of the Hospital Location file #44. Clinic ^SC(1,0)=DJones Medical Clinic^ ^RTV(194.2,n)=Dr Jones Medical Clinic [04/01/91]^ Clinic names are changed in a compiled input template. To insure the use of this trigger the following action is taken: The Record Tracking package includes the .01 field of the Hospital Location file #44 so that the SDB template is re-compiled when the Record Tracking package is initialized. ROUTINE: RTQ2 COMPONENT: CANCEL VARIABLES: ******************** 546 NAME: DBIA85-E CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 9,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 194.2 ROOT: RTV(194.2, DESCRIPTION: TYPE: File 1. Activation interface 2. Make an appointment Checkin/unscheduled visit 3. Cancel an appointment 4. Changing clinic names 1. Use of the Record Tracking System Parameter file # 195.4 SD calls RT if the field 'MAS INTERFACE STATUS' is 'UP' ^DIC(195.4,1,"UP")=1^ 2. When a clinic appointment is made if the appointment is 'today' or if the Record Tracking System Parameter 'Batch requests' is set to 'No' or if records are requested for an unscheduled visit. A. An entry is made in the Requested Records file #190.1 ^RTV(190.1,n) by a call from RT^SDUTL to a tasked job QUE^RTQ or RT^SDI B. After the entry is added to the Requested Records file #190.1 an entry is made in Parent Record Request field of the Patient subfield of the Hospital Location file #44 ^SC(n,"S",,,,"RTR")=n^ by a return call from CREATE+11^RTQ2 to RTSET^SDUTL 3. When a clinic appointment is canceled: If there is a Requested Records entry in file #190.1 the status is changed to 'canceled' by a call RTV(190.1,n)=^^^^^x^ from RT+2^SDUTL to CANCEL^RTQ2. 4. When the name of a clinic is changed the corresponding names of entries in the Pull List file #194.2 are changed by a trigger on the .01 field of the Hospital Location file #44. Clinic ^SC(1,0)=DJones Medical Clinic^ ^RTV(194.2,n)=Dr Jones Medical Clinic [04/01/91]^ Clinic names are changed in a compiled input template. To insure the use of this trigger the following action is taken: The Record Tracking package includes the .01 field of the Hospital Location file #44 so that the SDB template is re-compiled when the Record Tracking package is initialized. ROUTINE: ******************** 547 NAME: DBIA87-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 10,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File PTF FILE: Looks at 70 node (Discharge and ICD diagnosis info) and M multiple (movement data) and its ICD 1 field. (routine YSCEN32) ROUTINE: ******************** 548 NAME: DBIA87-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH QUASAR AUTOMATED INFO COLLECTION SYS WOMEN'S HEALTH CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: JUL 10,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8 ROOT: DIC(8, DESCRIPTION: TYPE: File ELIGIBILITY CODE: Looks at .01. (routines: YSCEN23, YSCEN54, YSDGDEM, YSPP1A) Quality: Audiology and Speech Pathology Audit and Review (QUASAR) Package, A&SP CLINIC VISIT File (#509850.6), VISIT ELIGIBILITY Field (#80) points to the ELIGIBILITY CODE File (#8) to accommodate recording, tracking and reporting workload by visit eligibility. Quality: Audiology and Speech Pathology Audit and Review (QUASAR) Package, A&SP CLINIC VISIT File (#509850.6), PATIENT ELIGIBILITY Field (#2) points to the ELIGIBILITY CODE File (#8) to accommodate recording, tracking and reporting workload by patient eligibility. ROUTINE: ******************** 549 NAME: DBIA87-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 10,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 37 ROOT: DIC(37, DESCRIPTION: TYPE: File DISPOSITION FILE: (routine: YSPP4) ROUTINE: ******************** 550 NAME: DBIA87-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: JUL 10,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File PATIENT FILE (listed by field or node referenced. If a node is referenced, it will follow in ()s): CLAIM NUMBER and CLAIM FOLDER LOCATION (YSCEN23, YSDGDEM,YSCEN54, and YSPP1) RELIGION (YSCEN23, YSDGDEM, and YSCEN54) ELIGIBILITY CODE (YSCEN23, YSDGDEM, YSCEN54, and YSPP1A) EMERGENCY CONTACT NODE (.33) (YSCEN23, YSCEN54, and YSPP) NEXT OF KIN NODE (.21) (YSPP1) DESIGNEE NODE (.34) (YSPP1) ADDRESS NODE (.11) (YSCEN23 and YSDGDEM) PHONE NODE (.13) (YSCEN23, YSDGDEM, and YSPP) TEMPORARY ADDRESS NODE (.121) (YSCEN23 and YSDGDEM) ELIGIBILITY STATUS NODE (.361) (YSCEN23, YSDGDEM, and YSPP1A) SERIOUSLY ILL (YSDGDEM0) ENROLLMENT MULTIPLE (YSDGDEM0) APPOINTMENT MULTIPLE (YSDGDEM0) DISPOSITION MULTIPLE (YSPP4) INELIGIBLE DATE (YSPP, YSPP1) EMPLOYER NODE (.311) (YSPP1) SERVICE CONNECTED? (YSPP1) SERVICE CONNECTED PERCENTAGE (YSPP1) PARENTS' NAMES NODE (.24) (YSPP1) PRIOR CARE RECIEVED NODE (1010.15) (YSPP2) SERVICE RECORD NODE (.32) (YSPP2) AGENCY/ALLIED COUNTRY (YSPP2) COMBAT DATA (.52) (YSPP2) POW DATA (.52) (YSPP2) IONIZING RADIATION DATA (.321) (YSPP2) VIETNAM SERVICE DATA (.321) (YSPP3) AGENT ORANGE DATA (.321) (YSPP3) SERVICE DENTAL INJURY (YSPP3) SERVICE TEETH EXTRACTED? (YSPP3) ROUTINE: ******************** 551 NAME: DBIA88-B CUSTODIAL PACKAGE: GRECC SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: AUG 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 1. The 'DG' post-init for MAS v5.1 will be calling the Generic Code Sheet routine A^GECSX5 to re-build the template maps for the input templates listed above. ROUTINE: GECSX5 COMPONENT: A VARIABLES: ******************** 554 NAME: DBIA91-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION CLINICAL CASE REGISTRIES CCR added as a subscriber on 11/27/13 after developer review found reference to ICR in routine RORUTL10 and believes reference has been in the routine since 2006. USAGE: Controlled Subscri ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Amended October 28, 1997. ^LR(D0,'CH',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w 2... TEST RESULT~FLAG 0;1-2 Direct Global Read & w Direct global read of DD(63.04 is used to determine laboratory test names. ^LR(D0,'MI',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w .05 SITE/SPECIMEN 0;5 Direct Global Read & w ^LR(D0,'MI',D1,3,D2,0) .01 ORGANISM 0;1 Direct Global Read & w Direct global read of DD(63.3 and DD(63.3,"GL" nodes [Organism Sub-field]. 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,3,D2,IFN) 5... ANTIBIOTIC~INTERP IFN;1-2 Direct Global Read & w ^LR(D0,'MI',D1,6,D2,0) .01 PARASITE 0;1 Direct Global Read & w Direct global read of DD(63.34 and DD(63.34,"GL" nodes [Parasite Sub-field]. ^LR(D0,'MI',D1,6,D2,1,D3,0) .01 STAGE 0;1 Direct Global Read & w 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,9,D2,0) .01 FUNGUS/YEAST 0;1 Direct Global Read & w Direct global read of DD(63.37 and DD(63.37,"GL" nodes [Fungus/Yeast Sub-field]. 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,12,D2,0) .01 MYCOBACTERIUM 0;1 Direct Global Read & w Direct global read of DD(63.39 and DD(63.39,"GL" nodes [Mycobacterium Sub-field]. 1 QUANTITY 0;2 Direct Global Read & w ^LR(D0,'MI',D1,17,D2,0) .01 VIRUS 0;1 Direct Global Read & w Direct global read of DD(63.43 and DD(63.43,"GL" nodes [Virus Sub-field]. ROUTINE: ******************** 555 NAME: DBIA91-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION USAGE: Controlled Subscri ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61 ROOT: LAB(61, DESCRIPTION: TYPE: File Amended October 28, 1997. Data from the following fields are accessed for read only (Read w/FileMan or Direct Global Read): ^LAB(61 TOPOGRAPHY FIELD File .01 NAME ^LAB(61,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 557 NAME: DBIA93-C CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION PCE PATIENT CARE ENCOUNTER PCE is the only user of the 'INACTIVE DATE' field. QUASAR DSS - DECISION SUPPORT SYSTEM EX AUTOMATED INFO COLLECTION SYS MENTAL HEALTH CLINICAL REMINDERS TEXT INTEGRATION UTILITIES VA CERTIFIED COMPONENTS - DSSI CLINICAL CASE REGISTRIES GEN. MED. REC. - VITALS INTEGRATED BILLING E CLAIMS MGMT ENGINE SURGERY VIRTUAL PATIENT RECORD MYHEALTHEVET HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ADVANCED PROSTHETICS ACQUISITION USAGE: Controlled Subscri ENTERED: SEP 11,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File ^DIC(40.7,D0,0) .01 NAME 0;1 Direct Global Read & w 1 AMIS REPORTING STOP 0;2 Direct Global Read & w 2 INACTIVE DATE 0;3 Direct Global Read & w ^DIC(40.7,'C',X,DA) The C cross-reference is used to determine Stop Code, as a direct global read. ROUTINE: ******************** 558 NAME: DBIA95-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: COMPENSATON AND PENSION VA POINT OF SERVICE (KIOSKS) USAGE: Private ENTERED: SEP 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Request an agreement with the lab developers for usage of the following: variables: Only those associated with the routines below Routines from indicated entry points: PT^LRX ROUTINE: LRX COMPONENT: PT VARIABLES: ******************** 559 NAME: DBIA95-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: COMPENSATON AND PENSION USAGE: Private ENTERED: SEP 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Request an agreement with the lab developers for usage of the following: variables: Only those associated with the routines below Routines from indicated entry points: SWITCH^LRRP2 ROUTINE: LRRP2 COMPONENT: SWITCH VARIABLES: ******************** 560 NAME: DBIA97-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: AUG 26,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49, DESCRIPTION: TYPE: File The DSS developers have agreed that the IMS developers may export file 730 (NATIONAL SERVICE) with data and field 730 (NATIONAL SERVICE) in file 49 (SERVICE/SECTION) with no data. ROUTINE: ******************** 561 NAME: DBIA98-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 20,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSK( DESCRIPTION: TYPE: File Version 5.1 of the laboratory package has a temporary agreement for the following: 2) To reference the global %ZTSK directly to display the error trap data. (Rick has been notified of our usage of the %ZTSK global) When Kernel release their error trapping system, Lab will convert to the Kernel supported methodology. ROUTINE: ******************** 563 NAME: DBIA103-B CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: JUL 28,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 131.9 ROOT: SRO(131.9, DESCRIPTION: TYPE: File ^SRO(131.9,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 565 NAME: DBIA104-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Controlled Subscri ENTERED: JUN 22,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File The listed references will be made from the QIP1* & QIP3SR* routines which, while belonging to the QIP namespace, will be maintained by the PIMS developers (for QIP1*) and surgery developers (for QIP3SR*). Coordination of release and patches will be through the QIP custodial ISC. To determine the associated admission for perioperative extracts, the following cross-reference is used: ^DGPM("APTT1" ^DGPM(D0,0) .06 WARD LOCATION 0;6 Read w/Fileman ROUTINE: ******************** 581 NAME: DBIA111-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTERIM MANAGEMENT SUPPORT USAGE: Private ENTERED: MAY 14,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGANHD3 COMPONENT: EN VARIABLES: 2) AMIS Segments 345-346 This entry point prints the inpatient AMIS segments 345-346 for a select month/year. If the variable DGMYR is not defined, the user will be prompted for the AMIS month/year to print. ******************** 583 NAME: DBIA115-B CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology uses a call to APL1^RTPSET to access the RTAPL variable (record tracking system wide application variable) to insure the radiology application of record tracking is set prior to making a record request or displaying record information ROUTINE: RTPSET COMPONENT: APL1 VARIABLES: ******************** 584 NAME: DBIA115-C CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When registering a patient exam, requests for records from the radiology application of Record Tracking can be made by a call from the Radiology/Nuclear Medicine package to ^RTQ5. ROUTINE: RTQ5 ******************** 585 NAME: DBIA115-D CUSTODIAL PACKAGE: RECORD TRACKING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 24,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When displaying exam profiles, location and record information is displayed by a call from RT^RAPROQ to ^RTUTL2. Paging assistance is provided by variable RTESC from a call to ESC^RTRD. ROUTINE: RTRD COMPONENT: ESC VARIABLES: ******************** 586 NAME: DBIA118-B CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION PCE PATIENT CARE ENCOUNTER CLINICAL REMINDERS CLINICAL CASE REGISTRIES VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: OCT 30,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71, DESCRIPTION: TYPE: File ^RAMIS(71,D0,0) .01 NAME 0;1 Direct Global Read & w 9 CPT CODE 0;9 Direct Global Read & w 10 COST OF PROCEDURE 0;10 Direct Global Read & w ^RAMIS(71,'D',X,DA) 9 CPT CODE Direct Global Read & w D cross-reference is used to determine CPT code. ROUTINE: ******************** 587 NAME: DBIA118-C CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP 2.0 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: OCT 30,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71.2 ROOT: RAMIS(71.2, DESCRIPTION: TYPE: File ^RAMIS(71.2,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 590 NAME: DBIA124-C CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. C. Direct reference to ^PSRX(n,0) and ^PSDRUG(n,0) by Integrated Billing for use to determine prescription number and drug name when calculating the Brief Description field. The MUMPS code to do this is stored in the IB ACTION TYPE file. D. Direct reference to ^PSRX by Integrated Billing to determine if the link between Integrated Billing and the Prescription file is intact. ROUTINE: ******************** 592 NAME: DBIA125-B CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 350.1 ROOT: IBE(350.1, DESCRIPTION: TYPE: File 5. Direct reference to ^IBE(350.1,"B" to automatically determine the IB CHARGE REMOVAL REASON of "RX DELETED" when a prescription is deleted. . 6. Look-up by Outpatient Pharmacy to the IB CHARGE REMOVAL REASON file, as this is passed back to Integrated Billing with cancel transactions. The OUTPATIENT SITE File (#59) has a pointer field to the SERVICE/SECTION File (#49). For Pharmacy Copay to work, this field must match the SERVICE Field (#.04) for pharmacy action types in the IB ACTION TYPE File (#350.1). This is done by checking the "ANEW" cross reference on the SERVICE Field (#.04) in File 350.1 with a Direct Global read: I '$D(^IBE(350.1,"ANEW",pharmacy pointer,1,1))... ^IBE(350.1,DA, .05 SEQUENCE 0;5 Direct Global Read & w A check is done when deleting a refill of a prescription that has Copay charges to this field, and if this field is not equal to "Cancel", a warning is given to user when deleting the refill that Copay charges must be removed before deleting the refill. ROUTINE: ******************** 593 NAME: DBIA127-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine is used for making transactions to an already existing bill. This would be used, for example, if a Pharmacy Co-Pay was charged and later canceled because the patient did not receive the RX. INPUT Variable: X $P1: Transaction type. This is the pointer to the Accounts Receivable Trans.Type file (430.3. Currently this program will support two types of transactions: INCREASE ADJUSTMENT Number: 1 DECREASE ADJUSTMENT Number: 21 This piece should be set to the internal value for these types, this may be found by direct accessing the "AC" cross-reference on the Number to determine the internal value. $P2: Amount. This would be the amount of the transaction. This number must be greater than 0 and less than 9999999.99. $P3: Bill Number. This must be the .01 value of the bill from the Accounts Receivable file (430) and must be 10 characters in length. (ex: 503-K10001). $P4: User. this is the person who is making the adjustment. Pointer to the User file (3). $P5: Adjustment Date. This is the internal VA FileMan date when the adjustment occurred. $P6: Reason. This is the free text reason that the adjustment took place (optional). Output Variable: Y $P1: Success flag. Equals 1 if successful, -1 if unsuccessful $P2: Error Code. This is the error code from the IB Error file. $P3: Addition Text. If additional text is required to describe the error then it is in the third piece. ROUTINE: PRCASER1 ******************** 594 NAME: DBIA127-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 430.2 ROOT: PRCA(430.2, DESCRIPTION: TYPE: File Integrated Billing has permission to access the following fields: ^PRCA(430.2,CAT,0) .01 CATEGORY 0;1 Direct Global Read & w This field is used by various reports in the Diagnostic Measures module. Some examples of these reports are: First Party Follow-up Report, Miscellaneous Bills Report, among others. 1 ABBREVIATION 0;2 Direct Global Read & w This field is used by various reports in the Diagnostic Measures module. Some examples of these reports are: First Party Follow-up Report, Miscellaneous Bills Report, among others. 5 TYPE 0;6 Direct Global Read & w This field is used by IB in the Diagnostic Measures module. The value in this field is used to classify an AR Category as FIRST PARTY or THIRD PARTY category. Basically, categories of types PATIENT or MEANS TEST PATIENT are considered First Party categories and the others Third Party. Two exceptions to this are the categories EX-EMPLOYEE and CURRENT EMPLOYEE that are always FIRST PARTY categories, independent of their type. ROUTINE: ******************** 596 NAME: DBIA127-E CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Export of data, files, functions, options, routines, templates and security keys by Version 1 of Integrated Billing as necessary to successfully implement the Pharmacy Co-pay project as follows: File Data ACCOUNTS RECEIVABLE (partial) (430) NO ACCOUNTS RECEIVABLE CATEGORY (430.2) YES ACCOUNTS RECEIVABLE TRANS.TYPE (430.3) YES ACCOUNTS RECEIVABLE FORM LETTER (434) YES BATCH TRANSACTION (435) YES AR DEBTOR (412) NO VENDOR (partial) (440) NO Functions PRCADDR1, PRCADDR2, PRCACITY, PRCASTATE, PRCAZIP Security keys PRCAY PAYMENT SUP Options PRCAL LIST MENU Accounts Receivable Status Reports PRCAD REPORT MENU Report Menu for Accounts Receivable PRCA CLERK`MENU Clerk's AR Menu PRCAC TR PAYMENT Enter a Payment Transaction PRCAC PROFILE Profile of Accounts Receivable PRCAE FOLLOW-UP Follow-up Letter Menu PRCAC TRANSACTION Adjustment to Accounts Receivable PRCAC CHANGE Update Accounts Receivable PRCAA SET/AUDIT NEW BILL Audit/Set up a New Accounts Receivable PRCAD RECON CASHIER Agent Cashier Report PRCAL REFER DC DC Pending Referral AR Listing PRCAL REF DOJ DOJ Pending Referral AR Listing PRCAL STATUS LIST Status listing for Bills PRCAB PRINT BILLS New Bill Forms Print PRCAA OLD BILL Establish/Edit Old Bills PRCAC TRANS PROFILE Transaction Profile PRCAL MEANS LIST Means Test AR List PRCAL OTHER LIST Other Category AR List PRCA FORWARD IRS OFFSETS Forward IRS OFFSETs to Austin PRCAY CREATE/EDIT BATCH Create/Edit Payment Batch PRCAT CREATE CALM Create CALM Code Sheet for Other AR Transactions PRCAT LIST NEW TRANSACTION Other Bills pending CALM Transaction (Print) PRCAT PAT REF NUMBER AR (New) Processing PRCAT USER AR - Accounts Receivable Menu PRCAT PAT COMMON Establish PAT Common Number Series PRCAY APPROVE BATCH Approve Batch PRCAY POST TRANS Post an approved batch to A/R PRCAY MASTER Agent Cashier PRCAY BATCH STATUS Batch Status Report PRCAY ENTER A PAYMENT Enter a Payment (Agent Cashier) Routines PRCAAD, PRCABIL, PRCABD, PRCABP1, PRCABP2, PRCABP3, PRCABP31, PRCACLM, PRCADJ, PRCADR, PRCADR1, PRCALST, PRCALT, PRCALT1, PRCAOFF, PRCAOFF2, PRCAPAT, PRCAPAY, PRCAPAY1, PRCAPAY2, PRCAPCL, PRCAPRO, PRCAPTR, PRCAREPT, PRCARLT, PRCASER, PRCASER1 , PRCASTA, PRCASVC3, PRCASVC4, PRCASVC5, PRCAUDT, PRCAUT1, PRCAWO, PRCAY, PRCAYAPP, PRCAYE, PRCAYHLP, PRCAYPT, PRCAYUT, PRCFACX0 Templates Type File --------------------------------------- PRCABILLVEN Input VENDOR PRCA FY ADJ2 BATCH Input AR TRANSACTION PRCA FY ADJ1 Input AR TRANSACTION PRCA FY ADJ2 Input AR TRANSACTION PRCA BATCH PAYMENT Input AR TRANSACTION PRCA PAYMENT Input AR TRANSACTION PRCA OLD SET Input ACCOUNTS RECEIVABLE PRCA SET Input ACCOUNTS RECEIVABLE PRCASVC STATUS Input ACCOUNTS RECEIVABLE PRCASV REL Input ACCOUNTS RECIEVABLE PRCAE AUDIT Input ACCOUNTS RECEIVABLE PRCAC LOCATE DEBTOR Input ACCOUNTS RECEIVABLE PRCAY TRANSACTION EDIT Input BATCH TRANSACTION PRCAY BATCH STATUS Print BATCH TRANSACTION PRCAR CASH Print AR TRANSACTION ROUTINE: ******************** 599 NAME: DBIA127-H CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 430.6 ROOT: PRCA(430.6, DESCRIPTION: TYPE: File Direct reference to the global ^PRCA(430.6, to add a new entry in version 1 on the post initialization routine. Direct refe rence to global ^PRCA(430.6 to determine and set pointer values in the ACCOUNTS RECEIVABLE CATEGORY file and in the IB ACTION TYPE file in the post initialization routine. ROUTINE: ******************** 600 NAME: DBIA127-I CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 6,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 430.3 ROOT: PRCA(430.3, DESCRIPTION: TYPE: File Direct reference to global ^PRCA(430.3, to determine the internal number of the decrease adjustment type when doing a decrease adjustment and to determing the internal number of the increase adjustment type when doing an increase adjustment type (required for input to supported call PRCASER1). ROUTINE: ******************** 601 NAME: DBIA128-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: NOV 20,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File New Bill and Edit Bill options have been modified to prompt the user "Edit Debtor Address" after he/she has entered/edited the bill. This prompt as well as the Edit AR Debtor Address option allow edits to the NEW PERSON and INSTITUTION file. for the INSTITUTION file ^DIC(4, 1) 4,1.01 - Street Address 1 2) 4,1.02 - Street Address 2 3) 4,1.03 - City 4) 4,.02 - State 5) 4,1.04 - Zip Code 6) 4.03,.03 - Phone Please keep in mind that "all users" with access to the Billing menu will be able to edit the debtor address fields (option 2). ROUTINE: ******************** 602 NAME: DBIA130-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM OUTPATIENT PHARMACY USAGE: Private ENTERED: DEC 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8 ROOT: DIC(8, DESCRIPTION: TYPE: File Read only access to the following Files, Fields, & X-References: FILE: Eligibility Code (DIC 8) FIELDS: Name (.01) ^DIC(8,i,0) Uses the "B" X-reference ^DIC(8,"B",NAME,i) *this is being requested by other packages and may be incorporated into VADPT at which time we will ask packages to use the utility ROUTINE: ******************** 603 NAME: DBIA130-C CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM USAGE: Private ENTERED: DEC 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File Read only access to the following Files, Fields, & X-References: FILE: DISABILITY CONDITION (31) ^DIC(31,i,0) Field .01 Name "C" X-ref ^DIC(31,"C",DX CODE,i) Field 2 DX Code (The diagonostic codes that may be used for eligibility determinations for ROES are stored in ^RMPFL(791810.3,. ROES $O's through these disabilities and looks them up in ^DIC 31 using the "C" c ross-reference. The array RMPFL is built to hold the disability conditions found.) *this is being requested by other packages and may be incorporated into VADPT at which time we will ask packages to use the utility ROUTINE: ******************** 604 NAME: DBIA130-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM USAGE: Private ENTERED: DEC 4,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 35 ROOT: DIC(35, DESCRIPTION: TYPE: File Read only access to the following Files, Fields, & X-References: FILE: OTHER FEDERAL AGENCY (35) ^DIC(35,i,0) FIELD .01 NAME *this is being requested by other packages and may be incorporated into VADPT at which time we will ask packages to use the utility ROUTINE: ******************** 606 NAME: DBIA132-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 5,1991 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File For a 'death' movement: Inpatient Meds has a MUMPS cross-reference (#6) under DATE OF DEATH field (#.351) of the PATIENT file. This cross-reference also uses the PSJADT routines, first checking for the existence of the routine PSJADT. ROUTINE: ******************** 612 NAME: DBIA142-B CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: JAN 23,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File ^DIC(36,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 613 NAME: DBIA142-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: JAN 23,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,.372,D1,0) .01 RATED DISABILITIES ( 0;1 Read w/Fileman ROUTINE: ******************** 614 NAME: DBIA145-B CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 5,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR COMPONENT: IN VARIABLES: When a user selects to review progress notes through OE/RR, one possible action to take is to select a new patient to review notes for. Rather than have the user return to the original patient upon exiting to OE/RR, I am using a call to D IN^OR to handle selecting a new patient; this call selects a new patient and updates all needed OR variables as well. As this piece of code requires ORVP be defined, I have placed a screen on the selection of the protocol that invokes this code from the Progress Notes review screen: I +XQORNOD(0),$D(ORVP) This eliminates the potential for a user to "^^"-jump to the review screen and error out of the program because ORVP was not defined. (The first piece of XQORNOD(0) holds the IFN of the selected protocol unless it was "^^"-jumped to.) ******************** 615 NAME: DBIA147-B CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: MAR 11,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 2. This results pointer is updated via calls from the Medicine options which enter/edit results to EN^GMRCR and RESULT^GMRCR, which are documented in the Consult/Request Tracking package. Once the results variable pointer is defined, the Medicine Package has provided Consult/Request Tracking with an entry point PRINT^MCOR which extracts results information and stores them in an ^TMP array for display purposes in OE/RR and Consult/Request Tracking. In order to call PRINT^MCOR the Consult/Request Tracking package must define the following variables. ORACTION=8 GMRCSR=variable pointer to results file GMRCPRNM=Name of procedure type, which should equal one of the Procedure Types in File 697.2, the eighth piece. The call to get the Medicine Results formats the results in ^TMP("MC",$J,... The ^TMP("MC",$J temporary global may be deleted upon completion of use. ROUTINE: MCOR COMPONENT: PRINT VARIABLES: ******************** 616 NAME: DBIA147-C CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: MAR 11,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 697.2 ROOT: MCAR(697.2, DESCRIPTION: TYPE: File 3. In addition to the interface the Medicine Package has provided, an alternative method for the Medicine Package Users is provided in a stand alone option provided by the Consult/Request Tracking Package. This option functions as follows: - The user selects the Medicine Procedure Type from a Protocol Menu - The service related to the Procedure Type defined in the FILE LINK field in Protocol File is determined - The patient is selected. - Consults/Request for the Service and Patient are displayed. - At the Select Action: prompt, the user may select "AR" for associate results - The PRINT NAME field, in the 8th piece of the ^MCAR(697.2,D0,0) node is the text that the Consults package uses to do a look up on the "BA" cross-reference. The consult package gets the text for the look-up from the Protocol name by removing the "GMRCR " prefix. The result of the "BA" lookup allows us to find the entry in 697.2 that represents the type of procedure that consults is processing. The GLOBAL LOCATION, the 2nd piece of the ^MCAR(697.2,D0,0) global node tells Consults what file to look for the results in. A look-up in the GLOBAL LOCATION file allows the user to "ASSOCIATE RESULTS" with a consult, and provide the Medicine package with the consult it is linked to. - The user is allowed to select from the list of Results in this results file for the Patient. (Using Medicine "C" cross-ref.) - Once a result entry is selected, it may be viewed using the PRINT^MCOR, to verify these are the correct results to associate with the request. - The user is asked if the order status should be updated to 'Completed' (default is yes, if no, ORSTS is incomplete) - The user is asked to enter the name of the clinician responsible for the results. ^MCAR(697.2,D0, 1 GLOBAL LOCATION 0;2 Read w/Fileman 7 PRINT NAME 0;8 Read w/Fileman ROUTINE: ******************** 617 NAME: DBIA149-B CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING INPATIENT MEDICATIONS USAGE: Private ENTERED: FEB 27,1995 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50.6 ROOT: PSNDF( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSN*4*94. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. The Adverse Reaction Tracking (ART) package will point to the National Drug (50.6) file. The ART package will do a direct global read of the VA DRUG CLASSIFICATION (3) field of the DOSAGE FORM subfield (2) multiple of the NATIONAL DRUG (50.6) file to get all the VA Drug Classes for an entry, e.g., D0=$O(^PSNDF(DA,2,D0)) ;loop through DOSAGE FORM subfield Drug Class=$P(^PSNDF(DA,2,D0,0),"^",3) The ART package can loop through the "B" and "T" cross-references. The "T" cross-reference is on the TRADE NAME field which is field #2 on the subfile 50.67. ^PSNDF(D0,2,D1,0) 3 VA DRUG CLASSIFICATI 0;3 Direct Global Read & w ^PSNDF(D0,2,D1) Direct global read used to $ORDER through the DOSAGE FORM subfield. ^PSNDF('B', Direct global read access to the "B" cross-reference will be used to get the internal entry number of the entry. ^PSNDF('T', Direct global read access to the "T" cross-reference will be used to look up a drug by its TRADE NAME. ^PSNDF(D0,0) .01 VA GENERIC NAME 0;1 Read w/Fileman .01 VA GENERIC NAME 0;1 Pointed to .01 VA GENERIC NAME 0;1 Direct Global Read & w ROUTINE: ******************** 619 NAME: DBIA149-D CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: FEB 27,1995 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. The Adverse Reaction Tracking (ART) package will point to the Drug (50) file. The ART package will: a. Use a direct global read on the GENERIC NAME (.01) field of the DRUG (50) file to get the Name of an entry, e.g., Name=$P(^PSDRUG(DA,0),"^"). b. Use a direct global read on the VA CLASSIFICATION (2) field of the DRUG (50) file to get the VA Drug Class of an entry, e.g., VA Class=$P(^PSDRUG(DA,0),"^",2). c. Use a direct global read on the NATIONAL DRUG CLASS (25) field of the DRUG (50) file to get the VA Drug Class of an entry, e.g., Drug Class=$P(^PSDRUG(DA,"ND"),"^",6). In each of these examples DA is an entry in the DRUG (50) file. ^PSDRUG(DA,0) .01 GENERIC NAME 0;1 Direct Global Read & w 2 VA CLASSIFICATION 0;2 Direct Global Read & w .01 GENERIC NAME 0;1 Pointed to .01 GENERIC NAME 0;1 Read w/Fileman ^PSDRUG(DA,'ND') 25 NATIONAL DRUG CLASS ND;6 Direct Global Read & w ROUTINE: ******************** 620 NAME: DBIA153-B CUSTODIAL PACKAGE: QUALITY ASSURANCE INTEGRATION SUBSCRIBING PACKAGE: EXTERNAL PEER REVIEW USAGE: Private ENTERED: APR 20,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 741.2 ROOT: QA(741.2, DESCRIPTION: TYPE: File Read access to find patients who have had a QA occurrence which was refered to peer review associated with a particular admission. FILE 741.2 QA OCCURRENCE REVIEW LEVEL Field 1 REVIEW LEVEL NUMBER ROUTINE: ******************** 625 NAME: DBIA160-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File Pulling over the following MAS data: 2) Automatic Casefinding PTF file Oncology is looking at the ^DGPT("ADS") cross-reference and accessing the ^DGPT(D0,70) NODE to find the malignant ICD9 discharge codes. Accessing pieces 10,16-19 and 20-24 on node 70. ROUTINE: ******************** 626 NAME: DBIA163-B CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUN 8,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File For Automatic Casefinding Radiology: Oncology looking at: ^RA(78.3 for a defined diagnostic code containing the word Malignancy... Check the ^RADPT("AR") cross-reference for date. Look at; ^RADPT(D0,"DT",D1,"P",D2,0) NODES for procedures which have the diagnostic code found above in ^RA(78.3 - we capture those patients and the date of the "suspicious procedures" ROUTINE: ******************** 627 NAME: DBIA165-B CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUHDR COMPONENT: TIT VARIABLES: The Detailed Display (DT) and Results Display (RT) actions available in OE/RR are also available via Consult/Request Tracking screens. The OE/RR DT and RT require an ORIFN (Order File internal entry number), but the Consult/Request Tracking DT and RT needs to be able to occur even after the Order in the Order File has been purged. The documented entry point in the OE/RR developers Guide EXT^ORUHDR, has been previous used which set ORDG (Display Group), and ORVP (Patient variable pointer), and then called TIT^ORUHDR. The EXT^ORUHDR depends on the ORIFN to be defined in order to print the headers. To enable printing of headers from the Consult/Request Tracking review screens, a GMRC routine sets variables that EXT^ORUHDR would have set and calls TIT^ORUHDR directly, eliminating the requirement for ORIFN (File 100 internal entry number) to exist. ******************** 628 NAME: DBIA165-C CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR6 COMPONENT: SERV VARIABLES: SERV^OR6 ;entry point to print service copy when order released As a result of the beta test at SALEM, the need came up to be able to print the Consult Form automatically at a "forwarded TO services" printer. Presently this entry point is called by OE/RR when the order is "RELEASED" from OE/RR so the Consult Form will print automatically at the "TO service" printer. When a Consult is "Forwarded " from one service to another, the following OR variables are set and then the SERV^OR6 entry point is called enabling the automatic print of the Consult Form at the Forwarded TO service: ORIFN=Order File internal entry number ORAL(PKG,ORIFN)="", where PKG is the "Consult/Request Tracking" Package File internal entry number and ORVP=Variable pointer format for Patient File internal entry number ORPRES="6;NEW/UNSIGNED ORDERS" ORCHART=1 ORPX="" ******************** 629 NAME: DBIA165-D CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX4 COMPONENT: SCOPY VARIABLES: SCOPY^ORX4(ORPKG,ORDERS) ; Print Service Copies of orders for a package The Consult Form is generated from the Print Format utilities created by OE/RR. This entry point allows the user to be in the Consult/Request Tracking Review screen and select PS (Print Service Copy), similiar to the PS action in OE/RR processing. The two variables it uses are the Package File internal entry number, and the Order File internal entry number. ******************** 630 NAME: DBIA165-E CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PRINT TEMPLATES: GMRC PROTOCOL LIST - This template uses the following fields to print a list of GMRC protocols defined in the Protocol File NAME ITEM TEXT GMRC PROTOCOL RPT - This template(uses the following fields to print details about GMRC protocols defined in the Protocol File NAME ITEM TEXT TYPE PRINT NAME PACKAGE FILE LINK DESCRIPTION SYNONYM ITEM SEQUENCE MNEMONIC GMRC PROTOCOL RPT HDR - This template is the HEADING for the GMRC PROTOCOL RPT print template. It includes a namespaced key for users to understand the namespacing of Protocol file entries used by the Consult/ Request Tracking package. ROUTINE: ******************** 631 NAME: DBIA165-F CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other SORT TEMPLATE: GMRC PROTOCOLS - This sort template is used for printing the Print Templates GMRC PROTOCOL LIST, and GMRC PROTOCOL RPT. The NAME field is used to extract all Protocol entries with a Prefix of GMRC. ROUTINE: ******************** 633 NAME: DBIA170-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 17,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3 ROOT: DIC(3, DESCRIPTION: TYPE: File In the AMIE package a direct reference is made to the USER file ^DIC(3,X,2,X1) to determine if a user has the division in question. When this code is run in a Kernel 7 account it will not work properly. ROUTINE: ******************** 635 NAME: DBIA181-B CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUPREF2 COMPONENT: EN3 VARIABLES: Utility for "on-the-fly" protocol creation. A default protocol is defined in file 101 for this to work off. Parameters are set in 100.99 to allow Clinical Coordinators to create their own package-specific protocols. The entry in the PROTOCOL file has the format: LR 121 GLUCOSE (where LR=namespace, 121=internal #, and GLUCOSE=name) Packages may also identify their own independent code to manage the building of protocols. REQUIRED VARIABLES: ORPKG (Package pointer (9.4); ORDEF (Default protocol for setting up protocols (101).); ORFL (File link - variable pointer format for procedure file. May be equal to ""if a package can't use a specific procedure file.); ORDANM (Optional name of the protocol. Should be in the format: NAMESPACE_PROCEDURE); ORDA (internal number of an existing protocol to be updated.); OPTIONAL VARIABLES: ORDA (pointer to existing protocol to be modified.); ORDNM (new .01 protocol name.); OREA (action used in lieu of default defined in OROEF.); ORTXT (name of protocol; if not defined, the .01 field of the procedure referenced is used.) ******************** 636 NAME: DBIA181-C CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUTL COMPONENT: READ VARIABLES: Displays "Press return to continue" and waits. REQUIRED VARIABLES: NONE RETURNED VARIABLES: NONE ******************** 637 NAME: DBIA181-D CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX COMPONENT: FILE VARIABLES: Creates new order and sets fields in the ORDER file (100). This entry point includes a 'D ST^ORX' to update the status. REQUIRED VARIABLES; ORL,ORPCL,ORNP or ORPV, ORVP OPTIONAL VARIABLES: ORCOST,OREVENT,ORIT,ORLOG,ORPK,ORPURG,ORSTOP,ORSTRT,ORSTS,ORTO , ORTS,ORTX(i). RETURNED VARIABLES: ORIFN NOTE: a) ORSTRT updates both the CURRENT and ORIGINAL Start Date fields. b) ORNP/ORPV updates both the CURRENT and ORIGINAL Agent/ Provider fields. COMPONENT: RETURN VARIABLES: Updates order information such as the start date/time, stop date/time, display text, or order status. Call RETURN^ORX with ORIFN to update order information. This entry point includes a 'D ST^ORX' to update the status, if the variable ORETURN ("ORSTS") is defined. The array ORETURN with the appropriate subscripts for updating the order must be defined prior to calling this entry point. For example, if you want to update the cost of the order to $10, then you would call RETURN^ORX with the variable ORETURN ("ORCOST")=10. REQUIRED VARIABLES: ORIFN OPTIONAL VARIABLES: ORETURN ORETURN subscripts: ORCOST,OREVENT,ORIT,ORPK,ORPURG,ORNP/ORPV,ORSTOP,ORSTRT,ORSTS, ORETURN(ORTX,i) RETURNED VARIABLES: NONE NOTE: ORETURN(ORSTRT) updates the CURRENT Start Date. ORETURN (ORPV) updates the CURRENT agent/Provider. COMPONENT: ST VARIABLES: Updates status. Call ST^ORX where ORIFN is defined and ORSTS is the internal entry number of the status in the ORDER STATUS file (100.1). This will replace the status for this ORIFN with the status in ORSTS. REQUIRED VARIABLES: ORIFN,ORSTS RETURNED VARIABLES: NONE ******************** 638 NAME: DBIA181-E CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX3 COMPONENT: NOTE VARIABLES: This is an entry point that creates a notification for a package. If the variable ORIFN is defined, the notification will be linked to an order in the ORDER file (100); otherwise, just the notification will be generated for a patient. ******************** 639 NAME: DBIA181-F CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX8 COMPONENT: NOTIF VARIABLES: NOTIF^ORX8(ORIFN,ORNOTE) Used when cleaning up a notification that is linked to an order. REQUIRED VARIABLES: ORNOTE(notification entry #) - must be set to null - notification entry number is from File 100.9, field .001(IFN) ORVP - patient identifier in the formal "DFN;DPT(" (ORVP is also used by other OE/RR routines and may already be available in your package.) REUTNRED VARIABLES; None OPTIONAL VARIABLES: ORIFN - the order that you want this notification to be linked to. ORIFN - the order that you want this notification to be linked to. ******************** 640 NAME: DBIA181-G CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 19,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX5 COMPONENT: DC VARIABLES: DC^ORX5 This entry is called when a package needs to create a DC order for an ordered item. When the DC order is signed, the ordered item is discontinued or cancelled. REQUIRED VARIABLES: ORIFN ******************** 641 NAME: DBIA185-B CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JUL 16,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File An E3R has been issued, asking to modify the Health Summary Print by location option to allow selection of an Operating Room, and to queue the selected Health Summary Type to print for all patients scheduled for surgery in that OR on a user-specified date. To that end, the Print by Location driver has been modified to look at the "B" cross reference of the Operating Room File (i.e., ^SRS("B",+LOC,ORLOC)) to get the record number of the selected OR, and then traverse the "AOR" cross reference of the Surgery File (i.e., ^SRF("AOR",+ORLOC,SDT,SRN) to get the record number of each surgery. It then visits the zero-node of each Surgery record to get the patient, whom it adds to the list of patients for Health Summaries to be printed. Health Summary makes direct references to the above cited globals and cross references. ^SRF(D0,0) ^SRF('AOR',+ORLOC,SDT,SRN) ROUTINE: ******************** 642 NAME: DBIA186-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING BENEFICIARY TRAVEL ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU COMPONENT: $$LST VARIABLES: Retrieve last Means Test date and status. COMPONENT: $$MTS VARIABLES: Needed to display the Means Test status description for a given code in the bulletins which are generated when a patient's billable status changes. ******************** 643 NAME: DBIA186-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING FEE BASIS Fee Basis has an agreement only to call entry point $$BIL. ENROLLMENT APPLICATION SYSTEM SCHEDULING ADDED 9/27/07 USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTUB COMPONENT: $$BIL VARIABLES: Determine if a patient was Category C on a specified date. If Medal of Honor Indicator is "YES" Means Test is not required. COMPONENT: $$BILST VARIABLES: Determine the last date on which a patient was Category C. COMPONENT: $$CK VARIABLES: Determine if a Means Test is Category C or Pending Adjudication, and patient agrees to pay deductible. COMPONENT: $$GMT(DFN,DGDT) VARIABLES: $$GMT Type: Output 1 - If the patient had GMT Copayment Status (or pending adjudication) at the given moment of time 0 - If the patient did not have GMT Copayment Status at the given moment of time -1 - If the GMT Copayment Status is unknown because the conversion is not completed. DFN Type: Input Patient's IEN DGDT Type: Input Date in FM format. GMT Copayment Status (or pending adjudication) ******************** 644 NAME: DBIA186-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VADPT COMPONENT: ELIG VARIABLES: Patient eligibility data printed on the appointment Check-off Sheets ******************** 645 NAME: DBIA186-E CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File ^DIC(36,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 646 NAME: DBIA186-F CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File 40.8 DG(40.8, MEDICAL CENTER DIVISION FILE -- Printed as part of BASC Locality Modifier entry/edit, the user is allowed to specify which division Check-off Sheets will be printed for, the user is allowed to choose clinics by division in the 'Clinic CPT Usage'report, pointed to by DIVISION field in the BASC Locality Modifier file (350.5), division is used in the BASC charge calculation .01 NAME 45 DGPT PTF -- Printed on the patient appointment Check-off Sheet 70 DISCHARGE DATE 79 DXLS 79.16 ICD 2 79.17 ICD 3 X-REF: AAD ROUTINE: ******************** 649 NAME: DBIA186-I CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS CLINICAL PROCEDURES VISTA INTEGRATION ADAPTOR Access will be used by VIAB SCDIS RPC. USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 391 ROOT: DG(391, DESCRIPTION: TYPE: File ^DG(391,D0,0) .02 IGNORE VETERAN CHECK 0;2 Read w/Fileman Used on a patients Check-off Sheet when determining veteran status ROUTINE: ******************** 651 NAME: DBIA186-K CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.3 ROOT: DG(41.3, DESCRIPTION: TYPE: File Date of Test multiple Conversion of Month/Year multiple MT billing data. ROUTINE: ******************** 652 NAME: DBIA186-L CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File 0th node-- Determine ward type, division of ward. ROUTINE: ******************** 653 NAME: DBIA186-M CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File 0th node-- Determine billable SPECIALTY, #42.4 0th node-- bedsection ROUTINE: ******************** 654 NAME: DBIA186-N CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File 101 node-- Determine if admitted VA ADM. REG., #43.4 "D" cross-reference for Observation & SOURCE OF ADM.,#45.1 "B" cross-reference Examination ROUTINE: ******************** 655 NAME: DBIA186-O CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File PATIENT MOVEMENT, #405 0th nod-- Determine whether to bill patient. -- "ATT1" cross-reference Determine whether -- "APCA" cross-reference patients have been -- "APTT1" cross-reference cont. hospitalized ROUTINE: ******************** 656 NAME: DBIA186-P CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.1 ROOT: DG(405.1, DESCRIPTION: TYPE: File FAC. MVMT TYPE, #405.1 0th node-- List movement type ROUTINE: ******************** 657 NAME: DBIA186-Q CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40 ROOT: DESCRIPTION: TYPE: File IB DIVISION DISPLAY on file 40.-- Displays a division's billing fields: .01 NAME-- history ROUTINE: ******************** 658 NAME: DBIA187-B CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: INTEGRATED BILLING QUASAR AUTOMATED INFO COLLECTION SYS OUTPATIENT PHARMACY VISUAL IMPAIRMENT SERVICE TEAM LAB SERVICE USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File ^DIC(31, .01 NAME 0;1 Direct Global Read & w 3 SENSITIVE CONDITION 0;4 Direct Global Read & w ROUTINE: ******************** 664 NAME: VA UTILITY ONE/MANY/ALL CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS DIETETICS TEXT INTEGRATION UTILITIES INPATIENT MEDICATIONS added 6/3/09 SCHEDULING ADDED 11/6/08 ACCOUNTS RECEIVABLE AR ADDED 6/6/2011 PROBLEM LIST Added 6/19/2018. USAGE: Controlled Subscri ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAUTOMA COMPONENT: CLINIC VARIABLES: Used to choose which clinics to search for the 'Clinic CPT Usage' report ^ COMPONENT: DIVISION VARIABLES: Used to choose divisions to search for the 'Clinic CPT' report and Check Sheets COMPONENT: FIRST VARIABLES: Used to choose clinics (limited to specific divisions) to search for Check-off Sheets COMPONENT: WARD VARIABLES: Used to choose wards (limited to specific divisions) from the WARD LOCATION file (#42). (INPATIENT MEDICATION) Note: This tag will define variable DUOUT if the user selects the up-arrow ('^') to exit from its prompt, or when exiting from the question mark-generated ('?') list of selectable wards. In the latter case, if the user then selects the 'ALL' default response, DUOUT remains defined, but variable VAUTW will be set to 1 (one). ******************** 668 NAME: DBIA188-K CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.71 ROOT: SD(409.71, DESCRIPTION: TYPE: File SD(409.71 AMBULATORY PROCEDURE--Pointed to by PROCEDURE field in the BILLABLE AMBULATORY SURGICAL CODE file (350.4), pointed to by PROCEDURE field in the AMBULATORY SURG.CHECK-OFF SHEET PRINT FIELDS file (350.71) 409.71 SD(409.71 AMBULATORY PROCEDURE .01 CODE-- When BASC codes are added to 350.4 the CPT is added to 409.71 if its not already there [SD-AMB-PROC-EDIT] Edit template used if new entry is added to file 409.71 during interactive edit of file 350.4 100 SYNONYMS SUBFILE (ALL) ROUTINE: ******************** 669 NAME: DBIA188-L CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 22,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File ^DIC(40.7,Clinic Stop)-- ^IBOVOP1: get clinic name - 0;1 NAME ROUTINE: ******************** 672 NAME: DBIA190-B CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES CLINICAL CASE REGISTRIES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 6,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8, DESCRIPTION: TYPE: File The Medicine package also needs to reference the following data elements: Patient Allergies (120.8) file: REACTION:REACTION (10,.01) and REACTION:OTHER REACTION (10,1) which is located in $P(^GMR(120.8,D0,10,D1,0),U,1,2). -D0 would be obtained from a call to ^GMRADPT, and D1 would be obtained by looping through the multiple. ROUTINE: ******************** 673 NAME: DBIA190-C CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 6,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.83 ROOT: GMRD(120.83, DESCRIPTION: TYPE: File "B" xref on NAME (.01) field which is located in ^GMRD(120.83,"B") -This is used to determine if an entry in the REACTIONS multiple, described above, points to the entry "OTHER REACTION". ^GMRD(120.83,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 674 NAME: DBIA191-B CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: AUG 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ^PSODEM: This is Pharmacy's MAS patient demographic function which is used in conjunction with the Pharmacy Patient profile. The input variable is DA and is the internal entry number of the VA Patient file and is equivalent to the DFN. ROUTINE: PSODEM ******************** 675 NAME: DBIA191-C CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: AUG 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine STAT^PSOFUNC: This is the Pharmacy treatment status function and is used in the Pharmacy patient profile. The required variables are RX0, RX2, and J. ROUTINE: PSOFUNC COMPONENT: STAT VARIABLES: ******************** 676 NAME: DBIA191-D CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: AUG 18,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DOIT^PSOP: This is the Pharmacy queue report entry point. ROUTINE: PSOP COMPONENT: DOIT VARIABLES: ******************** 679 NAME: DBIA191-G CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: AUG 18,1992 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. ^PSDRUG(DA, for drug data. ROUTINE: ******************** 680 NAME: DBIA196-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: SEP 24,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 61.5 ROOT: LAB(61.5, DESCRIPTION: TYPE: File The Medicine package has permission from the Lab developers to correct the double entry (CARDIOASSIST, AORTIC BALLOON PUMP) in the Lab SNOMED file. The Medicine package has permission from the Lab developers to create pointer values to the Lab SNOMED code file entries. ROUTINE: ******************** 681 NAME: DBIA196-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: SEP 24,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File The Medicine package has permission from the Lab developers to use the following root for Fileman access to Lab chemistry values: ^LR(DFN,""CH"", (for display only) . ^LR(D0,'CH', ROUTINE: ******************** 682 NAME: DBIA198-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: NOV 24,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File In an effort to provide a receiving mechanism for Controlled Substances module, several look-ups and pointers are necessary for an interim interface. For Purchase Order receipts, a lookup to PROCUREMENT & ACCOUNTING TRANSACTIONS file 442, screened by cost center [822400] is used. For Issue Receipts, a lookup occurs, screened by cost center [822400], in CONTROL POINT ACTIVITY file 410. A connection between the DRUG file 50 and ITEM MASTER file 441 is crucial for posting receipt information. This may be a one-to-many relationship and therefore involves the creation of a multiple IFCAP ITEM NUMBER field (#50.0441) in the DRUG file 50 pointing to the ITEM MASTER file 441. This field includes an input transform similar to that found in the NDC field in the ITEM MASTER file 441 preventing the linking of the same item to more than one drug. It also includes an 'AB' whole file cross-reference. Pointer to CONTROL POINT ACTIVITY file 410 Pointer to ITEM MASTER file 441 Pointer to PROCUREMENT & ACCOUNTING TRANSACTIONS file 442 References information (Read only) from PROCUREMENT & ACCOUNTING TRANSACTIONS file 442 .01 PURCHASE ORDER NUMBER .6 PARTIAL 40 ITEM .01 LINE ITEM NUMBER 1 DESCRIPTION 1.5 REPETITIVE (PR CARD) NO. 3.1 PACKAGING MULTIPLE 9 VENDOR STOCK NUMBER 5 ACTUAL UNIT COST 20 DATE RECEIVED 1 QTY BEING RECEIVED "AB" X-REF ON P.O. DATE (FIELD .1) IFCAP files are used solely to gather and display receipt information and so the Controlled Substances files 58.8 and 58.81 can accumulate a receipt history. DURATION: Till otherwise agreed, when the GIP & Drug Accountability interf ace is available ROUTINE: ******************** 684 NAME: DBIA211-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File The current verification cycle of Health Summary (v2.5) has identified a number of references to fields in Laboratory files, most of which were present in our previous version (v1.2), but which were not documented in our DBIA's (#67, #71, or #155) with the LAB SERVICE Package. All Health Summary components which present Laboratory data have continued to function without incident at all sites where Health Summary is known to be in use, but we wanted to be sure that all of our external references were known to the developers of the custodial packages, if only to avoid the potential for future surprises. So, the previously undocumented references include: Global: ^LR( File #: 63 File Name: LAB DATA File In all cases, before calling the appropriate extract routine, we check for the existence of Laboratory data for the patient in question by evaluating the condition: I '$D(^LR(LRDFN)) D NOLABS Q, where LRDFN is derived from: S LRDFN=+^DPT(DFN,"LR"). These references were not expicitly documented in existing DBIA's. Node: "MI" Sub-file #: 63.05 Sub-File Name: MICROBIOLOGY Sub-node: 3 Sub-Sub-file: 63.3 Sub-Sub-file Name: ORGANISM Before extrancting antibiotic susceptibilities, we test for results using the condition: I $O(^LR(LRDFN,"MI",IX,3,ISO,1)). Reference to this multiple was not documented in existing DBIA's. Sub-nodes: 5 & 6 Sub-Sub-file: 63.34 Sub-Sub-file Name: PARASITE Before extracting parasitology data, we test for results using the condition: Q:'($D(^LR(LRDFN,"MI",IX,5))&($D(^(6)))). (i.e., we only proceed when data are available). Reference to these nodes was not documented in existing DBIA's. Sub-nodes: 8&9 Sub-Sub-file: 63.37 Sub-Sub-file Name: FUNGUS/YEAST Before extracting mycology data, we test for results using the condition: Q:'($D(^LR(LRDFN,"MI",IX,8))&($D(^(9)))). (i.e., we only proceed when data are available). Reference to these nodes was not documented in existing DBIA's. Sub-nodes: 11&12 Sub-Sub-file: 63.39 Sub-Sub-file Name: MYCOBACTERIUM Before extracting mycobacteriology data, we test for results using the condition: Q:'($D(^LR(LRDFN,"MI",IX,11))&($D(^(12)))). (i.e., we only proceed when data are available). Reference to these nodes was not documented in existing DBIA's. Sub-nodes: 16&17 Sub-Sub-file: 63.43 Sub-Sub-file Name: VIRUS Before extracting virology data, we test for results using the condition: Q:'($D(^LR(LRDFN,"MI",IX,16))&($D(^(17)))). (i.e., we only proceed when data are available). Reference to these nodes was not documented in existing DBIA's. Sub-node: 14 Sub-Sub-file: 63.42 Sub-Sub-file Name: ANTIBIOTIC LEVEL Sub-Sub-node piece Sub-Sub-fld Sub-Sub-Fld Name 0 1 .01 ANTIBIOTIC (for SERUM LEVEL) 0 2 1 DRAW TIME 0 3 2 CONC(ug/ml) Before checking for antibiotic serum levels under this multiple, we test for results using the condition: I $D(^LR(LRDFN,"MI",IX,14)). This was added to accommodate those sites which still store peak and trough antibiotic levels in this manner, rather than under the "CH" subscript (e.g., Hines VAMC). Node: "SP" Sub-file #: 63.08 Sub-File Name: SURGICAL PATHOLOGY Sub-node piece Sub-fld Sub-Fld Name 0 11 .11 REPORT RELEASE DATE (This sub-field was documented in DBIA #67, but was referred to under its old field name "RELEASE REPORT") ROUTINE: ******************** 685 NAME: DBIA211-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 65 ROOT: LRD(65, DESCRIPTION: TYPE: File The current verification cycle of Health Summary (v2.5) has identified a number of references to fields in Laboratory files, most of which were present in our previous version (v1.2), but which were not documented in our DBIA's (#67, #71, or #155) with the LAB SERVICE Package. All Health Summary components which present Laboratory data have continued to function without incident at all sites where Health Summary is known to be in use, but we wanted to be sure that all of our external references were known to the developers of the custodial packages, if only to avoid the potential for future surprises. So, the previously undocumented references include: Global: ^LRD(65, File #: 65 File Name: BLOOD INVENTORY File Node piece field # Field Name 0 4 .04 COMPONENT 8 3 8.3 DONATION TYPE (we check for the existence of the "8-node prior" to calling EN^DIQ1 to get the external format of the DONATION TYPE field) Node: 3 Sub-file #: 65.03 Sub-File Name: DATE/TIME UNIT RELOCATION Sub-node piece Sub-fld Sub-Fld Name 0 4 .04 LOCATION (this sub-field is accessed to determine the last known location of a given unit). ROUTINE: ******************** 686 NAME: DBIA211-D CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 69 ROOT: LRO(69, DESCRIPTION: TYPE: File The current verification cycle of Health Summary (v2.5) has identified a number of references to fields in Laboratory files, most of which were present in our previous version (v1.2), but which were not documented in our DBIA's (#67, #71, or #155) with the LAB SERVICE Package. All Health Summary components which present Laboratory data have continued to function without incident at all sites where Health Summary is known to be in use, but we wanted to be sure that all of our external references were known to the developers of the custodial packages, if only to avoid the potential for future surprises. So, the previously undocumented references include: Global: ^LRO(69, File #: 69 File Name: LAB ORDER ENTRY File Node: 1 Sub-file #: 69.01 Sub-File Name: SPECIMEN # Sub-node piece Sub-fld Sub-Fld Name 3 1 .01 LAB ARRIVAL TIME 3 2 .02 DATE/TIME RESULTS AVAILABLE (these fields are accessed to determine the status of a given lab order). Sub-node: 4 Sub-sub-file #: 69.02 Sub-sub-file Name: SPECIMEN Sub-sub-node piece Sub-sub-fld Sub-sub-fld Name 0 1 .01 SPECIMEN ROUTINE: ******************** 687 NAME: DBIA211-E CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 68 ROOT: LRO(68, DESCRIPTION: TYPE: File The current verification cycle of Health Summary (v2.5) has identified a number of references to fields in Laboratory files, most of which were present in our previous version (v1.2), but which were not documented in our DBIA's (#67, #71, or #155) with the LAB SERVICE Package. All Health Summary components which present Laboratory data have continued to function without incident at all sites where Health Summary is known to be in use, but we wanted to be sure that all of our external references were known to the developers of the custodial packages, if only to avoid the potential for future surprises. So, the previously undocumented references include: Global: ^LRO(68, File #: 68 File Name: ACCESSION File Node: 1 Sub-file #: 68.01 Sub-File Name: DATE Sub-node: 1 Sub-sub-file #: 68.02 Sub-sub-file Name: ACCESSION # Sub-sub-node piece Sub-sub-fld Sub-sub-fld Name .2 1 15 ACCESSION We determine the Accession number using the following code: S ACC=$S($D(^LRO(68,+ACCA,1,+ACCD,1,+ACCN,.2)):^(.2),1:"NONE") ROUTINE: ******************** 688 NAME: DBIA218-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery package has permission from the MAS package to do the following: Make a call to the routine VACPT. The call to ^VACPT is made upon entry into the Surgery package to display the CPT copyright message. Surgery executes ^%ZOSF("TEST") before calling ^VACPT. ROUTINE: VACPT ******************** 689 NAME: DBIA218-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Surgery is also granted permission from the MAS package to make the following references (READ only) to MAS data. The first two references listed are used in conjunction with the Surgery Mortality Report. ^DPT("AEXP1",DATE OF DEATH,DFN) The Surgery Mortality Report loops through the "AEXP1" cross reference to locate patients who expired within a selected date range. Surgery also has permission to call the following: The Surgery Waiting List reports include items from the PATIENT file (#2) almost all of which we are able to retrieve by means of supported calls to VADPT. One item that is not returned by VADPT is the patient's telephone number at work, which is stored in the PHONE NUMBER [WORK] field (#.132), located in $P(^DPT(DFN,.13),"^",2). Surgery has permission to READ only the second piece of the .13 node for the patient's work telephone number. ROUTINE: ******************** 690 NAME: DBIA218-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File Surgery is also granted permission from the MAS package to make the following references (READ only) to MAS data. 3rd piece of ^DGPT(INTERNAL ENTRY IN FILE 45,70) Once the patient's last admission is determined, the Mortality Report checks this piece, which stores the TYPE OF DISPOSITION, to determine whether an autopsy was performed. If the TYPE OF DISPOSITION is 6, an autopsy was performed; if 7, no autopsy was performed; if not 6 or 7, the autopsy information is not available. ROUTINE: ******************** 691 NAME: DBIA218-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 4,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.1 ROOT: DGS(41.1, DESCRIPTION: TYPE: File Surgery is also granted permission from the MAS package to make the following references (READ only) to MAS data. The following two items are used together on several reports. ^DGS(41.1,"B",DFN,INTERNAL ENTRY IN FILE 41.1) The various Surgery Schedule reports loop through the B cross reference to locate scheduled admissions for the patient if the patient is not an inpatient already. Second piece of ^DGS(41.1,INTERNAL ENTRY IN FILE 41.1,0) This piece, which holds the RESERVATION DATE/TIME of the scheduled admission, is checked for each scheduled admission found in the B cross reference to determine if the RESERVATION DATE/TIME is future. If there is a future scheduled admission, the report prints "ADM. PENDING" for the patient. ROUTINE: ******************** 692 NAME: DBIA221-B CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.416 ROOT: PS(50.416, DESCRIPTION: TYPE: File Outpatient Pharmacy is given permission by Pharmacy to make the following calls: GLOBAL MAP DATA DICTIONARY #50.416 -- DRUG INGREDIENTS FILE 2/26/93 STORED IN ^PS(50.416, SITE: ISC BIRMINGHAM ----------------------------------------------------------------------- ^PS(50.416,D0,0)= (#.01) NAME [1F] ^ ^PS(50.416,D0,1,0)=^50.4161A^^ (#1) DRUG IDENTIFIER ^PS(50.416,D0,1,D1,0)= (#.01) DRUG IDENTIFIER [1F] ^ ^PS(50.416,D0,1,0) 1 DRUG IDENTIFIER Direct Global Read & w ^PS(50.416,D0,1,D1,0) .01 DRUG IDENTIFIER 0;1 Direct Global Read & w ^PS(50.416,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 694 NAME: READ AND WRITE ACCESS TO FILE 59.7 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP USAGE: Controlled Subscri ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.7 ROOT: PS(59.7, DESCRIPTION: TYPE: File Outpatient Pharmacy is given permission by Pharmacy Data Mgmt for direct global read/write access and read/write access with Fileman to the fields listed explicitly in this agreement which reside on the 47 multiple. CMOP and OPT PS are given read with FM/DGR access permission to all other fields listed explicitly in this agreement. ^PS(59.7,D0,47,0) 47 SCRIPTALK PRINT DEVI 47;0 Both R/W w/Fileman ^PS(59.7,D0,0) .01 SITE NAME 0;1 Direct Global Read & w ^PS(59.7,D0,40) 40 DEFAULT OUTPATIENT S 0;1 Direct Global Read & w ^PS(59.7,D0,40.01) 42 DEFAULT OUTPATIENT S 40;1 Direct Global Read & w ^PS(59.7,D0,40.1) 40.1 ADMISSION CANCEL OF 40.1;1 Direct Global Read & w 40.11 INTERDIVISIONAL PROC 40.1;2 Direct Global Read & w 40.12 DIVISION PROMPT ASKE 40.1;2 Direct Global Read & w 40.13 REFILL/RENEW DIVISIO 40.1;3 Direct Global Read & w 40.14 DAYS PRINTED RX STAY 40.1;5 Direct Global Read & w 40.16 POLYPHARMACY W/ACTIO 40.1;6 Direct Global Read & w ^PS(59.7,D0,49.19,0) 40.19 EXEMPT WARD FROM AUT 40.19;0 Direct Global Read & w ^PS(59.7,D0,40.19,D1,0) .01 EXEMPT WARD FROM AUT 0;1 Direct Global Read & w ^PS(59.7,D0,46) 46.1 TRANSMISSION START D 46;1 Direct Global Read & w 46.2 TRANSMISSION 46;2 Direct Global Read & w 46.3 BATCH CONTROL ID 46;3 Direct Global Read & w 46.4 NUMBER OF MSH COUNT 46;4 Direct Global Read & w 46.5 NUMBER OF LINES COUN 46;5 Direct Global Read & w ^PS(59.7,D0,48) 48 OUTPATIENT ORDERS CO 48;1 Direct Global Read & w 48.1 LAST PATIENT CONVERT 48;2 Direct Global Read & w ^PS(59.7,D0,49.99) 49.99 OUTPATIENT VERSION 49.99;1 Direct Global Read & w 49.98 DATE OP 6 INSTALLED 49.99;2 Direct Global Read & w 49.97 LAST RX CONVERTED 49.99;3 Direct Global Read & w 49.96 DATE V7 INSTALLED 49.99;4 Direct Global Read & w 41 LAST RX 49.99;5 Direct Global Read & w 49.982 V7 POST BACKGROUND S 49.99;6 Direct Global Read & w 49.981 V7 POST BACKGROUND S 49.99;7 Direct Global Read & w 49.983 V7 POST BACKFILL STA 49.99;8 Direct Global Read & w 49.984 V7 POST BACKFILL 49.99;9 Direct Global Read & w ROUTINE: ******************** 696 NAME: DBIA221-F CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS USAGE: Private ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.605 ROOT: PS(50.605, DESCRIPTION: TYPE: File Outpatient Pharmacy is given permission by Pharmacy to make the following calls: GLOBAL MAP DATA DICTIONARY #50.605 -- VA DRUG CLASS FILE STORED IN ^PS(50.605 SITE: ISC BIRMINGHAM ----------------------- All fields in the file. ROUTINE: ******************** 698 NAME: DBIA225-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: APR 21,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 445 ROOT: PRCP(445, DESCRIPTION: TYPE: File Read only access to the .01 field of File 445 to get the IEN of the Inventory Point so that we can set it in variable PRCP("I") and use it to a call to routine PRCPUSA. The look-up to the .01 field would be through a Fileman call to ^DIC, and a successful lookup would return the IEN which would then be used in setting the above IFCAP variable. ROUTINE: ******************** 699 NAME: DBIA226-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: MAY 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGREG COMPONENT: FEE VARIABLES: ******************** 700 NAME: DBIA226-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: FEE BASIS PATIENT REPRESENTATIVE Patient Reps often respond to patient complaints about not receiving some type of care, such as dental, eyeglasses, etc. Most patient reps have been given options to pull up the rated disabilities data for a patient so they can make some quick assessments and take some action. The Patient Rep Work Group would like this information to be displayed when they enter a new contact or edit a contact on a patient so they don't have to exit one system and go into another to get the data. It would be displayed along with other patient data such as SSN, age, sex, eligibility status and means test category. AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING INTEGRATED BILLING SURGERY RADIOLOGY/NUCLEAR MEDICINE INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: MAY 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGRPDB COMPONENT: DIS VARIABLES: Rated Disabilities ******************** 701 NAME: DBIA226-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: FEE BASIS CLINICAL REMINDERS INSURANCE CAPTURE BUFFER ADDED JUNE 2009 USAGE: Controlled Subscri ENTERED: MAY 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU COMPONENT: $$LST VARIABLES: DFN Type: Input IEN of PATIENT file DGDT Type: Input Date/Time optional DGMTYPT Type: Input Type of Test (optional - if not defined "Means Test" will be assumed) Last means test for a patient Value returned is: Annual Means Test IEN^Date of Test^Status Name^Status Code ******************** 702 NAME: DBIA226-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: MAY 3,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 21 ROOT: DIC(21, DESCRIPTION: TYPE: File Point to the following file PERIOD OF SERVICE - 21 ROUTINE: ******************** 704 NAME: DBIA227-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: MAY 5,1993 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File Prosthetics is granted permission to make the following calls to the IFCAP package (GIP and 1358 Modules). As stated below this is until the next version of either IFCAP or Prosthetics. For the 1358 Module: Item 4 is needed so that Prosthetics can calculate the amount remaining on the original 1358 obligation by subtracting Field #94 from field #96. Item 4 Description: Read Only access to File #442, PROCUREMENT & TRANSACTIONS FILE, fields 94, ACTUAL 1358 BALANCE, and 96, ESTIMATED 1358 BALANCE. ROUTINE: ******************** 705 NAME: DBIA228-B CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: MAY 12,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 353.2 ROOT: IBE(353.2, DESCRIPTION: TYPE: File ^IBE(353.2,D0,0) .01 CODE 0;1 Pointed to ROUTINE: ******************** 706 NAME: DBIA229-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: MAY 18,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MailMan V7 has permission to make the following calls to FileMan: 2. MailMan has always used its text field such that non-integer nodes are not a problem to it. This is explicitly done for network mail headers, which are not expected to be in any way handled by FileMan. In this case the lines .001 through .999 are reserved for recording information passed by the network on message deliveries. 3. While editing the Message file users have a capability to 'transfer text' from other text processing fields. Currently they can reference the text fields of other messages that they either sent or are a recieient of and the responses to these messages. Other prospective files from which textual information may be extracted via this method include the Help Frame file. Security is kept for the privacy of each user by using the screen on the file during the look-up when transfering text from the Message file. ROUTINE: ******************** 707 NAME: DBIA237-B CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing is given permission from Outpatient Pharmacy to call HD^PSOSD2 and PAT^PSOSD for the purpose of printing the Action Profile and the Information Profile in batch. CONDITIONS: The entry points may only be used in an approved fashion. The following subroutine uses the entry points in an acceptable manner: RXPROF ;For printing the Outpatient Pharmacy Action Profile or the ;Information Profile for a single patient whose DFN is defined. ;Does not ask for the device nor close the device. ;INPUTS: ;PSDAYS = number of days to print the medication profile for ;PSTYPE=1 for the Action Profile, =0 for the Information Profile ;DFN ; N IBDFN,ADDR,ADDRFL,CLASS,CNDT,DRUG,HDFL,I,II,J,L,LINE,P,PAGE, PSDOB,PSII X,PSNAME,PSOI,PSSN,PSIX,PGM,PRF,PSDATE,VAL,VAR,RX, RX0,RX2,ST,ST0,PSDAY,RF,RFS,PSOPRINT,X1,X2,ZTSK,X,Y,PSII,PSDT,LMI S IBDFN=DFN S X1=DT,X2=-PSDAYS D C^%DTC S (PSDATE,PSDAY)=X S LINE="" F I=1:1:132 S LINE=LINE_"-" S PAGE=1 D HD^PSOSD2,PAT^PSOSD W @IOF S DFN=IBDFN Q ROUTINE: PSOSD COMPONENT: PAT VARIABLES: ******************** 708 NAME: DBIA238-B CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: RAUTL3 ******************** 710 NAME: DBIA240-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Laboratory Package has given permission to AMIE to make the following calls: Routine Calls: CH^LRRP2 MI^LRRP2 PT^LRX Current Agreement number 95 Per our phone conversation on 6/7/93. No more setting of the ZTSK AND ZTQUEUED variables. Call the following entry points: D DT^LRX,EN^LRPARAM. This will work for any version of Lab. ROUTINE: LRRP2 COMPONENT: CH VARIABLES: COMPONENT: MI VARIABLES: ******************** 711 NAME: DBIA241-B CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2, DESCRIPTION: TYPE: File ^DIC(4.2,D0,0) .01 NAME 0;1 Read w/Fileman 2 RELAY DOMAIN 0;3 Read w/Fileman ROUTINE: ******************** 713 NAME: DBIA241-D CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File ^VA(200,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 714 NAME: DBIA241-E CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: WPSEFM ******************** 715 NAME: DBIA240-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Laboratory Package has given permission to AMIE to make the following calls: Routine Calls: PT^LRX Current Agreement number 95 Per our phone conversation on 6/7/93. No more setting of the ZTSK AND ZTQUEUED variables. Call the following entry points: D DT^LRX,EN^LRPARAM. This will work for any version of Lab. ROUTINE: LRX COMPONENT: PT VARIABLES: COMPONENT: DT VARIABLES: ******************** 716 NAME: DBIA240-D CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Laboratory Package has given permission to AMIE to make the following calls: Per our phone conversation on 6/7/93. No more setting of the ZTSK AND ZTQUEUED variables. Call the following entry points: D DT^LRX,EN^LRPARAM. This will work for any version of Lab. ROUTINE: LRPARAM COMPONENT: EN VARIABLES: ******************** 717 NAME: DBIA242-B CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: REGISTRATION CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File PIMS will also store the DEFAULT HEALTH SUMMARY (Field #43) in the MAS PARAMETERS File (File #43) which will be a pointer to the HEALTH SUMMARY TYPE File (#142). Access to the .01 field of File #142 will be read- only. Data will be retrieved via KERNEL utilities. ^GMT(142,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 723 NAME: DBIA243-G CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER ENROLLMENT APPLICATION SYSTEM INCOMPLETE RECORDS TRACKING ORDER ENTRY/RESULTS REPORTING SCHEDULING VIRTUAL PATIENT RECORD USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File ^DIC(42,D0,0)= (#.03) SERVICE [3S] Direct Global Read ROUTINE: ******************** 728 NAME: DBIA244-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE AUTOMATED INFO COLLECTION SYS OUTPATIENT PHARMACY POLICE & SECURITY MRSA INITIATIVE REPORTS added 4/23/09 INPATIENT MEDICATIONS 20090710 - added Inpt Meds PHARMACY DATA MANAGEMENT Added 01/24/20 to support Pharmacy API's for Virtual Patient Record. USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File ^DG(40.8,D0,0) .01 NAME 0;1 Direct Global Read & w Medical Center Division Name ROUTINE: ******************** 729 NAME: DBIA244-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE INCOMPLETE RECORDS TRACKING USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.2 ROOT: DG(405.2, DESCRIPTION: TYPE: File ^DG(405.2, 0;1 MAS Movement Type ROUTINE: ******************** 730 NAME: DBIA244-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File ^DGPM( 0;1 Date/Time of Movement 0;2 Transaction 0;17 Discharge/Check out Movement 0;18 MAS Movement Type ^DGPM("AMV1" ^DGPM("APTT1" ^DGPM("APID" ^DGPM("AMV3" ROUTINE: ******************** 731 NAME: DBIA244-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE SCHEDULING USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8 ROOT: DIC(8, DESCRIPTION: TYPE: File ^DIC(8, 0;6 Print Name of elig. code ^DIC(8,"D" ROUTINE: ******************** 732 NAME: DBIA244-F CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 21 ROOT: DIC(21, DESCRIPTION: TYPE: File ^DIC(21, 0;1 Period Service name ^DIC(21,"D" ROUTINE: ******************** 733 NAME: READ ACCESS TO ICD9 CODE INFORMATION CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE SCHEDULING REGISTRATION VIRTUAL PATIENT RECORD USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File ^DIC(31 .01 NAME 0;1 Direct Global Read & w 2 DX CODE 0;3 Direct Global Read & w 20;.01 RELATED ICD9 CODES ICD;1 Direct Global Read & w 20;.02 ICD9 MATCH ICD;2 Direct Global Read & w ROUTINE: ******************** 734 NAME: DBIA244-H CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File ^DIC(42, 0;2 Bedsection ROUTINE: ******************** 738 NAME: DBIA244-L CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.5 ROOT: HOLIDAY( DESCRIPTION: TYPE: File ^HOLIDAY Check if date is a holiday ^HOLIDAY(D0) .01 DATE 0;1 Direct Global Read & w 2 NAME 0;2 Direct Global Read & w ROUTINE: ******************** 740 NAME: DBIA244-N CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGRPD ******************** 741 NAME: DBIA244-O CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JUN 15,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Variables: MAS variables used: DGCHANGE 0 DGCODE DGDR DGERR DGNODE DGPC DGPTND DGPTND( DGQ DGQCODE DGQNODES DGRPS DGX The call to DGRPE and the DG variables are part of an PIMS routine and call to edit the patient address information. It will be under the AMIE namespace until which time the routine is released with PIMS. ROUTINE: DGRPE ******************** 742 NAME: DBIA251-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM USAGE: Private ENTERED: JUL 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File Read/write access to the following fields in the OPTION file (#19). (To save/restore these values upon an installation.) 200 QUEUED TO RUN AT WHAT TIME 201 DEVICE FOR QUEUED JOB OUTPUT 202 RESCHEDULING FREQUENCY 203 QUEUED TO RUN ON VOLUME SET ROUTINE: ******************** 743 NAME: DBIA252-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL MONITORING SYSTEM SURGERY USAGE: Controlled Subscri ENTERED: JUL 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Fields: subscript;piece 63,.02 PARENT FILE 0;2 63,.03 NAME 0;3 The ^LR(D0,"CH",D1,Node) nodes for read access to the lab test results. ROUTINE: ******************** 744 NAME: DBIA253-B CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: INTEGRATED BILLING AUTOMATED INFO COLLECTION SYS TEXT INTEGRATION UTILITIES CLINICAL REMINDERS OUTPATIENT PHARMACY Added 1/22/21 USAGE: Controlled Subscri ENTERED: JUL 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission from Health Summary to make the following calls: 1) Permission to print Health Summaries by calling ENX^GMTSDVR if it exists. ROUTINE: GMTSDVR COMPONENT: ENX(DFN,GMTSTYP,GMTSPX2,GMTSPX1) VARIABLES: DFN Type: Input Record # of patient in file 2 GMTSTYP Type: Input Record # of HS type in file 142 GMTSPX2 Type: Input Optional internal FM beginning date GMTSPX1 Type: Input Optional internal FM ending date ******************** 745 NAME: DBIA253-C CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS IMAGING USAGE: Controlled Subscri ENTERED: JUL 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission from Health Summary to make the following calls: 1) If ENX^GMTSDVR does not exist (version 2.5 or latter not installed), permission to print Health Summaries by: b) Calling SELTYP1^GMTS and then EN^GMTS1 to print the Health Summary. ROUTINE: GMTS COMPONENT: SELTYP1 VARIABLES: ******************** 746 NAME: DBIA253-D CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUL 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission from Health Summary to make the following calls: 1) If ENX^GMTSDVR does not exist (version 2.5 or latter not installed), permission to print Health Summaries by: A) Calling SELTYP1^GMTS and then EN^GMTS1 to print the Health Summary. ROUTINE: GMTS1 COMPONENT: EN VARIABLES: ******************** 750 NAME: DBIA263-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZCT COMPONENT: $$EN VARIABLES: ******************** 751 NAME: DBIA263-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZDP COMPONENT: $$EN VARIABLES: ******************** 752 NAME: DBIA263-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH MASTER PATIENT INDEX VISTA CLINICAL INFO RESOURCE NETWORK SCHEDULING USAGE: Controlled Subscri ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Supported calls for building of HL7 ZPD segment (VA Specific Patient Demographics). ROUTINE: VAFHLZEL COMPONENT: $$EN(DFN,VAFSTR,VAFNUM) VARIABLES: DFN Type: Input Pointer to PATIENT file (#2) VAFSTR Type: Input String of fields requested separated by commas (Defaults to all fields) VAFNUM Type: Input Eligibility number to determine type of data returned 1 = primary eligibility only 2 = all eligibilities HL7 variab Type: Input Call assumes that all HL7 variables returned from INIT^HLFNC2 are defined. VAFMSTDT Type: Input Date to use when getting MST status (optional) $$EN Type: Output String of data forming the ZEL segment for the patient's primary eligibility. VAFZEL(n) Type: Output If all eligibilities are chosen, an array of string(s) forming the ZEL segments for the patient's other entitled eligibilities This function call has been left for backwards compatability and is superceeded by EN1^VAFHLZEL. This function call is designed to build the HL7 ZEL segment. This segment contains VA-specific patient eligibility data. Because a patient can have more than eligibility, the ZEL segment for the patient's primary eligibility will be the output of the function call and all other eligibilities will be returned in the array VAFZEL. Because this call was not designed to accomodate a segment length greater than 245, sequence numbers 1 to 24 are the only fields supported. Notes: All fields will be returned with the primary eligibility : Eligibility Code, Long ID, and Short ID will be the only fields returned for other eligibilities : VAFZEL is initialized (KILLed) on entry COMPONENT: EN1(DFN,VAFSTR,FAFNUM,.VAFZEL) VARIABLES: DFN Type: Input Pointer to PATIENT file (#2) VAFSTR Type: Input String of fields requested separated by commas (Defaults to all fields) VAFNUM Type: Input Eligibility number to determine type of data teturned 1 = primary eligibility only 2 = all eligibilities VAFZEL Type: Both Array to return segment(s) in VAFZEL(X) = ZEL segment (first 245 characters) VAFZEL(X,Y) = Remaining portion of ZEL segment in chunks of 245 chars. HL7 variab Type: Input Call assumes that all HL7 variables returned from INIT^HLFNC2 are defined VAFMSTDT Type: Input Date to use when getting MST status (optional) This procedure call is designed to build the HL7 ZEL segment. This segment contains VA-specific patient eligibility data. Because a patient can have more than one eligibility, the ZEL segment(s) will be returned in the array VAFZEL. This call superceeds $$EN^VAFHLZEL because it accomodates a segment length greater than 245. Notes: VAFZEL(1) will be the primary eligibility : VAFZEL(2..n) will be other eligibilities : All fields will be returned with the primary eligibility : Eligibility Code, Long ID, and Short ID will be the only fields returned for other eligibilities : Fields will not be split across nodes in VAFZEL() : VAFZEL is initialized (KILLed) on entry ******************** 753 NAME: DBIA263-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZEM COMPONENT: $$EN VARIABLES: ******************** 754 NAME: DBIA263-F CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZGD COMPONENT: $$EN VARIABLES: ******************** 755 NAME: DBIA263-G CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZIC COMPONENT: $$EN VARIABLES: ******************** 756 NAME: DBIA263-H CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZMT COMPONENT: $$EN VARIABLES: ******************** 758 NAME: DBIA263-J CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAFHLZTA COMPONENT: $$EN VARIABLES: ******************** 760 NAME: DBIA263-L CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Means Test integration: IVM uses means test extensively as means test is the vehicle by which patients are determined to require income verification. We request the following integration with the means test module: Routines: $$LYR^DGMTSCU1 ROUTINE: DGMTSCU1 COMPONENT: $$LYR VARIABLES: ******************** 761 NAME: DBIA263-M CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Means Test integration: IVM uses means test extensively as means test is the vehicle by which patients are determined to require income verification. We request the following integration with the means test module: Routines: $$LST^DGMTU ROUTINE: DGMTU COMPONENT: $$LST VARIABLES: ******************** 763 NAME: DBIA263-O CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.31 ROOT: DGMT(408.31, DESCRIPTION: TYPE: File ^DGMT(408.31,: - "B" x-ref used to loop through means tests since January 1 in 2 places (one is a counter, one is the bulk transmission code). It then looks at piece 2 (DFN). These references will be removed after this version. - 0 node used to retrieve the following other fields: .03 STATUS - used in determining if pt meets IVM transmission criteria...checks for 4 or 6. .04 INCOME \ used to determine if .1 ADJUDICATION DATE/TIME > pts income changed .12 THRESHOLD A / from C to A ROUTINE: ******************** 764 NAME: DBIA263-P CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other IVM attaches a protocol to the event driver. ROUTINE: ******************** 765 NAME: DBIA263-Q CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 10,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other IVM exports VAFHL* routines ROUTINE: ******************** 766 NAME: DBIA268-B CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File FILE NO. FIELD NO NODE;PIECE DESCRIPT 36 .111 .11;1 STREET ADDRESS [LINE 1] .112 .11;2 STREET ADDRESS [LINE 2] .113 .11;3 STREET ADDRESS [LINE 3] .114 .11;4 CITY .115 .11;5 STATE .116 .11;6 ZIP CODE .131 .13;1 PHONE NUMBER ^SEE DESCRIPTION ROUTINE: ******************** 767 NAME: DBIA268-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE NETWORK HEALTH EXCHANGE IMAGING ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES REMOTE ORDER/ENTRY SYSTEM RADIOLOGY/NUCLEAR MEDICINE INTEGRATED BILLING SCHEDULING ADDED 9/27/07 VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HMP routines HMPDJ00 and HMPDJ00A are doing a direct global read of the second piece of the zero node for the record in the DG Security Log file (#38.1) in order to determine if the patient is marked as a sensitive patient. This is part of the patient sync process that keeps the local VistA in sync with the JDS database for eHMP. As part of the sync, they are sending this flag with the patient record. At that point, the data is simply being collected and not viewed. When HMP users see the data in the user interface the PTSEC^DGSEC4 call is being made. FEE BASIS CLAIMS SYSTEM USAGE: Controlled Subscri ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 38.1 ROOT: DGSL(38.1, DESCRIPTION: TYPE: File This DBIA allows access to the DG SECURITY LOG file to determine whether a patient is considered sensitive. Since this file is DINUMed to the PATIENT file, security can be checked by ensuring that the 2nd piece of the 0 node is equal to 1: I $P($G(^DGSL(38.1,DFN,0)),"^",2) ROUTINE: ******************** 768 NAME: DBIA268-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Parts of the following routines have been copied and altered from DGMTSC* routines. This was done in order to include Means Test data for PDX. All DG variables are newed. The alterations mainly consist of changing writes to sets. The PDX routines are based on the following routines: a) HD^DGMTSCU b) DIS^DGMTSC1 c) CHILD^DGMTSC11 d) DIS^DGMTSC2 e) FLD^DGMTSC2 f) DIS^DGMTSC3 g) CHILD^DGMTSC31 h) DIS^GDMTSC4 i) FLD^DGMTSC4 Within these routines the following entry points are accessed: a) $$LST^DGMTU b) SETUP^DGMTSCU c) $$LYR^DGMTSCU1 d) ALL^DGMTU21 e) $$YN^DGMTSCU1 f) $$AMT^DGMTSCU1 g) $$NAME^DGMTU1 h) $$SSN^DGMTU1 i) $$DOB^DGMTU1 j) CHILD^DGMTSC11 k) DIS^DGMTSC2 l) DEP^DGMTSCU2 m) INC^DGMTSCU3 n) FLD^DGMTSC2 o) DIS^DGMTSCSC3 p) SET^DGMTSC31 q) CHILD^DGNTSC4 r) DIS^DGMTSC4 s) FLD^DGMTSC4 ROUTINE: SEE DESCRIPTION ******************** 770 NAME: DBIA270-B CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.7 ROOT: PS(52.7, DESCRIPTION: TYPE: File Drug Accountability will use the IV STATS (#50.8) file to update IV dispensing activity in a Drug Accountability Location. To correctly identify the DRUG (#50) file entry a look up is first made to the IV ADDITIVES (#52.6) and/or the IV SOLUTION (#52.7) files. Looping through ^PS(50.8,D0), all IV Rooms are checked. Looping through ^PS(50.8,D0,2,D1), dates are checked. Looping through ^PS(50.8,D0,2,D1,2,D2), drugs are checked with support from the "AC" x-ref. Looping through ^PS(50.8,D0,2,D1,2,D2,3,D3), ward is checked. It is here that, if a match occurs, $P($G(^PS(50.8,D0,2,D1,2,D2,3,D3,0)),U,2)-$P($G(^(0)),U,5) is used to update the balance in Drug Accountability. GLOBAL MAP DATA DICTIONARY #52.7 -- IV SOLUTIONS FILE STORED IN ^PS(52.7, *** NO DATA STORED YET *** SITE: BIRMINGHAM ISC ------------------------------------------------------------------------ CROSS REFERENCED BY: GENERIC DRUG(AC) ^PS(52.7,D0,0)= (#1) GENERIC DRUG [2P] ROUTINE: ******************** 771 NAME: DBIA271-C CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.8 ROOT: PS(50.8, DESCRIPTION: TYPE: File Drug Accountability will use the IV STATS (#50.8) file to update IV dispensing activity in a Drug Accountability Location. To correctly identify the DRUG (#50) file entry a look up is first made to the IV ADDITIVES (#52.6) and/or the IV SOLUTION (#52.7) files. Looping through ^PS(50.8,D0), all IV Rooms are checked. Looping through ^PS(50.8,D0,2,D1), dates are checked. Looping through ^PS(50.8,D0,2,D1,2,D2), drugs are checked with support from the "AC" x-ref. Looping through ^PS(50.8,D0,2,D1,2,D2,3,D3), ward is checked. It is here that, if a match occurs, $P($G(^PS(50.8,D0,2,D1,2,D2,3,D3,0)),U,2)-$P($G(^(0)),U,5) is used to update the balance in Drug Accountability. GLOBAL MAP DATA DICTIONARY #50.8 -- IV STATS FILE STORED IN ^PS(50.8, (1 ENTRY) SITE: BIRMINGHAM ISC (#14) -------------------------------------------------------------------------- CROSS REFERENCED BY: IV DRUG(AC) ^PS(50.8,D0,0)= (#.01) IV ROOM [1P] ^ ^PS(50.8,D0,2,0)=^50.803D^^ (#2) DATE ^PS(50.8,D0,2,D1,0)= (#.01) DATE [1D] ^ ^PS(50.8,D0,2,D1,2,0)=^50.805A^^ (#2) IV DRUG ^PS(50.8,D0,2,D1,2,D2,0)= (#.01) IV DRUG [1F] CROSS-REFERENCE: 50.8^AC^MUMPS 1)= I '$D(PSIVV),$D(^PS(50.8)) D ^PSIVXREF Q 2)= Q ^PS(50.8,D0,2,D1,2,D2,3,0)=^50.808P^^ (#10) WARD ^PS(50.8,D0,2,D1,2,D2,3,D3,0)= (#.01) WARD [1P] ^ (#2) DISPENSED UNITS ==>(WARD) [2N] ^ (#5) CANCELED UNITS [5N] ^ ROUTINE: ******************** 772 NAME: DBIA271-D CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 26,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 57.6 ROOT: PS(57.6, DESCRIPTION: TYPE: File Drug Accountability will use the UNIT DOSE PICK LIST STATS (#57.6) file to update UD dispensing activity in a Drug Accountability Location. Looping through ^PS(57.6,D0), each date since the last update is checked. Looping through ^PS(57.6,D0,1,D1), wards are checked. Looping through ^PS(57.6,D0,1,D1,1,D2), providers are checked. Looping through ^PS(57.6,D0,1,D1,1,D2,1,D3), drugs checked. It is here that, if a match occurs, $P($G(^PS(57.6,D0,1,D1,1,D2,1,D3,0)),U,2)-$P($G(^(0)),U,4) is used to update the balance in Drug Accountability. GLOBAL MAP DATA DICTIONARY #57.6 -- UNIT DOSE PICK LIST STATS FILE STORED IN ^PS(57.6, ------------------------------------------------------------------ Contains medication amounts and costs for the Unit Dose package. Data is entered into this file when pick lists are filed away, and when pre- exchange units, extra units dispensed, and returns are entered through the package. Most of the cost reports gather their data from this file. ^PS(57.6,D0,0)= (#.01) DATE [1D] ^ ^PS(57.6,D0,1,0)=^57.61PA^^ (#1) WARD ^PS(57.6,D0,1,D1,0)= (#.01) WARD [1P] ^ ^PS(57.6,D0,1,D1,1,0)=^57.62PA^^ (#1) PROVIDER ^PS(57.6,D0,1,D1,1,D2,0)= (#.01) PROVIDER [1P] ^ ^PS(57.6,D0,1,D1,1,D2,1,0)=^57.63PA^^ (#1) DRUG ^PS(57.6,D0,1,D1,1,D2,1,D3,0)=(#.01) DRUG [1P] ^ (#1) DISPENSED AMOUNT [2N] ==>^ (#2) DISPENSED COST [3N] ^ (#3) RETURNED ==>AMOUNT [4N] ^ (#4) RETURNED COST [5N] ^ ROUTINE: ******************** 773 NAME: DBIA271-B CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IBAPDX - Extraction means test billing data for PDX Entry: $$EXTR^IBAPDX(TRAN,DFN,ROOT) Input: TRAN -- pointer to transaction file 394.61 DFN -- pointer to patient file 2 ROOT -- root for the output extraction array Output: 0 -- extraction was successful, or -1^err -- if an error was encountered during extraction ROUTINE: IBAPDX COMPONENT: $$EXTR(TRAN,DFN,ROOT) VARIABLES: ******************** 774 NAME: DBIA271-C CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IBAPDX1 - Build display set for extracted PDX billing data Entry: $$DISP^IBAPDX(XTRACT,ROOT,SEGPTR,OFFSET) Input: XTRACT -- root for the input extract array ROOT -- root for the output display array SEGPTR -- pointer to extracted segment in file 394.71 OFFSET -- offset to begin line numbering Output: NUM -- number of lines in the output display array, or -1^ERR -- if an error was encountered ROUTINE: IBAPDX COMPONENT: DISP(...) VARIABLES: ******************** 775 NAME: DBIA272-B CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.71 ROOT: VAT(394.71, DESCRIPTION: TYPE: File a) The following fields are referenced by the global directly, NOT by a fileman call. - PDX Segment File (394,71) field # .01 Data Segment Name ROUTINE: ******************** 776 NAME: DBIA272-C CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQULT3 COMPONENT: NAMEKEY VARIABLES: COMPONENT: DUZKEY VARIABLES: COMPONENT: TRANENC VARIABLES: ******************** 777 NAME: DBIA272-D CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQUTL2 COMPONENT: NCRPFLD VARIABLES: ******************** 778 NAME: DBIA272-E CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQCON2 COMPONENT: SENDER VARIABLES: ******************** 779 NAME: DBIA272-F CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 27,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAQDIS20 COMPONENT: CENTER VARIABLES: ******************** 788 NAME: DBIA277-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 22 ROOT: DIC(22, DESCRIPTION: TYPE: File File #22 - POW Period Field #.01 - Name - ^DIC(22,D0,0) piece 1 ROUTINE: ******************** 789 NAME: DBIA277-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 23 ROOT: DIC(23, DESCRIPTION: TYPE: File File #23 - Branch of Service Field #.01 - Name - ^DIC(23,D0,0) piece 1 ROUTINE: ******************** 790 NAME: DBIA277-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 24 ROOT: DIC(24, DESCRIPTION: TYPE: File File #24 - Non-Veterans Class Field #.01 - Name - ^DIC(24,D0,0) piece 1 ROUTINE: ******************** 791 NAME: DBIA277-E CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 25 ROOT: DIC(25, DESCRIPTION: TYPE: File File #25 - Type of Discharge Field #.01 - Name - ^DIC(25,D0,0) piece 1 ROUTINE: ******************** 792 NAME: DBIA277-F CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File File #31 - Disability Condition Field #.01 - Name - ^DIC(31,D0,0) piece 1 ROUTINE: ******************** 793 NAME: DBIA277-G CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 35 ROOT: DIC(35, DESCRIPTION: TYPE: File File #35 - Other Federal Agency Field #.01 - Name - ^DIC(35,D0,0) piece 1 ROUTINE: ******************** 794 NAME: DBIA277-H CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: MENTAL HEALTH HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File ^DIC(36, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 795 NAME: DBIA277-I CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File File #42.4 - Specialty Field #.01 - Name - ^DIC(42.4,D0,0) piece 1 ROUTINE: ******************** 796 NAME: DBIA277-J CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: SEP 13,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File File #45.7 - Treating Specialty Field #.01 - Name - ^DIC(45.7,D0,0) piece 1 ROUTINE: ******************** 797 NAME: DBIA282-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCS58 COMPONENT: EN1 VARIABLES: Ask for control Point and Obligation Number^ COMPONENT: EN2 VARIABLES: Variables: PRCS("TYPE")="FB" or "COUNTER" X - 7 Piece variable delimited by "^" Piece 1 = Obligation Number Piece 2 = Date/Time (internal format) Piece 3 = estimated amount Piece 4 = actual amount Piece 5 = reference Piece 6 = comments(up to 78 characters) Piece 7 = interface id Y - one or two '^' - piece delimited variable where Piece 1 = (zero) or (one) Piece 2 = Internal entry number or free text error message. ^ ******************** 798 NAME: DBIA282-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCS58CC COMPONENT: PRCS58CC VARIABLES: Support for the close/complete action on a 1358 daily record. Variables: PRCSX - 5-piece variable delimited by '^' piece 1 = Internal daily reference no. piece 2 = Date/Time (internal format) piece 3 = Amount of Payment piece 4 = Comments (limited to 78 characters) piece 5 = Completed flag Y - a one or two '^'-piece delimited variable where piece 1 = 0 (zero) or 1 (one) piece 2 = a free-text error message.^ ******************** 799 NAME: DBIA282-D CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS M DATA EXTRACTOR ADVANCED PROSTHETICS ACQUISITION APAT and Above PAR request permission for READ access to the UNIT OF ISSUE (#420.5) file using FileMan APIs during the creation and display of purchase orders, stock issues, and Orthotic and Lab Work Orders (OWL) in order to procure or display using the correct packaging unit. Fields accessed include .01 NAME and 1 FULL NAME. The "B" cross reference is used in determining that a UNIT OF ISSUE is valid. ABOVE PAR APAT and Above PAR request permission for READ access to the UNIT OF ISSUE (#420.5) file using FileMan APIs during the creation and display of purchase orders, stock issues, and Orthotic and Lab Work Orders (OWL) in order to procure or display using the correct packaging unit. Fields accessed include .01 NAME and 1 FULL NAME. The "B" cross reference is used in determining that a UNIT OF ISSUE is valid. USAGE: Controlled Subscri ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.5 ROOT: PRCD(420.5, DESCRIPTION: TYPE: File Read access to file 420.5 (Unit of Issue) ROUTINE: ******************** 800 NAME: DBIA282-E CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS M DATA EXTRACTOR USAGE: Controlled Subscri ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Next Version VERSION: pre-CoreFLS FILE: 440 ROOT: PRC(440, DESCRIPTION: TYPE: File Prosthetics to have Read, Write, and LAYGO access to files 440 (vendor) and 441 (Item Master), through options PRCHPC ITEM EDIT and PRCHRC VEN EDIT, restricted through assignment of the RMPRSUPERVISOR key. This key will be issued to a prosthetics clerk who has completed training by Supply Service on the IFCAP conventions and procedures for entering data into the above named files. Read access to file 440 VENDOR FILE - Field #.01 NAME and Field #6 CONTRACT NUMBER MULTIPLE, global node ^PRC(440,D0,4) and Global Node ^PRC(440,D0,4,D1,0). Display Vendor Name and check for valid or expired contract number. ROUTINE: ******************** 801 NAME: DBIA282-F CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS M DATA EXTRACTOR USAGE: Controlled Subscri ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Next Version VERSION: pre-CoreFLS FILE: 441 ROOT: PRC(441, DESCRIPTION: TYPE: File Prosthetics to have Read, Write, and LAYGO access to files 440 (vendor) and 441 (Item Master), through options PRCHPC ITEM EDIT and PRCHRC VEN EDIT, restricted through assignment of the RMPRSUPERVISOR key. This key will be issued to a prosthetics clerk who has completed training by Supply Service on the IFCAP conventions and procedures for entering data into the above named files. Read access to file 441 IFCAP ITEM MASTER FILE Field #.05 SHORT DESCRIPTION, global node ^PRC(441,D0,0) and Index ^PRC(441,"C",X,DA). Display IFCAP ITEM MASTER Short Description. ROUTINE: ******************** 802 NAME: DBIA282-G CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS M DATA EXTRACTOR USAGE: Controlled Subscri ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410 ROOT: PRCS(410, DESCRIPTION: TYPE: File Read access to file 410 (Control Point Activity) - Access required to check the status of 2237's. ROUTINE: ******************** 803 NAME: DBIA282-H CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 20,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File Read access to file 442 PROCUREMENT & ACCOUNTING TRANSACTION To get Obligation number through a ^DIC lookup. Obligation # is returned in Y(0). ROUTINE: ******************** 804 NAME: DBIA285-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 423 ROOT: PRCF(423, DESCRIPTION: TYPE: File CALM/LOG Code Sheet File (#423) of IFCAP sets and/or references to the entire file are under this agreement. Access to the CALM/LOG Code Sheet File 423 and the Procurement & Accounting Transaction File 442 is needed to repoint AR Debtor File 412 pointers to the AR V4.0 AR Debtor File 340. (included in inits) ROUTINE: ******************** 805 NAME: DBIA285-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 440 ROOT: PRC(440, DESCRIPTION: TYPE: File AR Debtor File 340 Debtor Field .01V5 (0;1) - variable pointer to the Vendor File (#440) ROUTINE: ******************** 806 NAME: DBIA285-D CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File AR File 430 Fiscal Year sub-file 430.01, Pat Ref. No. Field 430.01,2 (0;3) - points to Procurement & Accounting Transaction File (#442) ROUTINE: ******************** 807 NAME: DBIA285-E CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Appropriation Symbol Field 430.01,3 (0;4) - input transform calls EN1^PRCHPAT ROUTINE: PRCHPAT COMPONENT: EN1 VARIABLES: ******************** 808 NAME: DBIA285-F CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.3 ROOT: PRCD(420.3, DESCRIPTION: TYPE: File Ald Code Field 430.01,4 (0;5) - points to the Ald Code File (#420.3) Ald Code Field 4 (0;5) - points to the Ald Code File (#420.3) ROUTINE: ******************** 809 NAME: DBIA285-G CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.5 ROOT: PRCD(420.5, DESCRIPTION: TYPE: File Unit Field 430.02,5 (0;5) - points to the Unit of Issue File (#420.5) ROUTINE: ******************** 810 NAME: DBIA285-H CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: OCT 5,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 411 ROOT: PRC(411, DESCRIPTION: TYPE: File The AR V4.0 PRCACV* Conversion routines call to IFCAP. Access to the Admin. Activity Site Parameter File, #411, is needed to populate the AR V4.0 AR Site Parameter File 342. Admin. Activity Site Parameter File 411 Station Number Filed .01 (0;1) - Global reference Primary Station Field 21 (0;2) - "AC" Cross-reference global reference Admin. Activity Site Parameter File 411, Printer Location sub-file 411.02 Printer Location Field 411.02,.01 (0;1) - Global references UB for UB-82 and A for Accounts Receivable Device Field 411.02,1 (0;2) - Global reference ROUTINE: ******************** 812 NAME: DBIA290-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: FEE BASIS OUTPATIENT PHARMACY BAR CODE MED ADMIN USAGE: Private ENTERED: OCT 12,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2, DESCRIPTION: TYPE: File ============================================================= Unauthorized Claim Printer, field 33 in file 161.4 (Fee Basis Site Parameters file) references the device (%ZIS(1) and terminal type (%ZIS(2) files in the Input transform (extrinsic function), Executable help (routine call) and Screen. Fee routine is FBUCDD1. The Screen is: S DIC("S")= "S Z=$G(^%ZIS(1,+Y,""SUBTYPE"")),Z=$G(^%ZIS(2,Z,0)) I $E($P(Z,U),1)=""P""K Z" This IA grants the subscribing packages direct global read of %ZIS(1,"B" %ZIS(1,IEN,0 %ZIS(1,IEN,1 %ZIS(1,IEN,90 %ZIS(1,IEN,91 %ZIS(1,IEN,95 %ZIS(1,IEN,SUBTYPE %ZIS(1,IEN,TIME %ZIS(1,IEN,TYPE %ZIS(2,IEN,0 ROUTINE: ******************** 813 NAME: DBIA297-B CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File The PDX application is granted read access to the following fields and, if listed, their associated cross references: File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 142 .01 0;1 NAME B 1 (multiple in STRUCTURE file 142.01) File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 142.01 .01 0;1 SUMMARY ORDER B .02 0;2 COMPONENT NAME C 2 0;3 OCCURRENCE LIMIT 3 0;4 TIME LIMIT ROUTINE: ******************** 814 NAME: DBIA297-C CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142.1 ROOT: GMT(142.1, DESCRIPTION: TYPE: File File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 142.1 .01 0;1 NAME B 3 0;4 ABBREVIATION C 2 0;3 TIME LIMITS APPLICABLE 4 0;5 MAXIMUM OCCURRENCES APPLICABLE ROUTINE: ******************** 815 NAME: DBIA297-D CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PDX application is granted permission to use the function call $$GET^GMTSPDX(TRAN,DFN,SEGPTR,ROOT,GMTSLCNT,GMTSDLM,GMTSNDM) in order to extrqct Health Summary Components. Input: TRAN - Pointer to the VAQ - TRANSACTION file. If passed, the patient referenced in the transaction will be used when extracting the Health Summary Component. DFN - Pointer to the PATIENT file. If TRAN is not passed, the patient referenced by this pointer will be used when extracting the Health Summary Component. SEGPTR - Pointer to the VAQ - DATA SEGMENT file. This is the PDX Data Segment being extracted. ROOT - Root for the output extraction array (full global reference) GMTSLCNT - Offset in ROOT to begin placing information into (defaults to 0) GMTSDLM - Time limit to use for extraction (if applicable) GMTSNDM - Occurrence limit to use for extraction (if applicable) Output: A^B - Health Summary Component successfully extracted. A - Total number of lines inserted into ROOT B - Last line number inserted into ROOT -1^Err - Error occurred while extracting Health Summary Component. Err - Printable error text (reason for failure) Notes: a) Currently, output begins with GMTSLCNT+1 b) If TRAN is passed The patient pointer of the transaction will be used Encryption will be based on the transaction If DFN is passed Encryption will be based on the site parameter c) Use of TRAN takes precedence over DFN. If TRAN>0 the extraction will be based on the patient contained in the transaction. ROUTINE: GMTSPDX COMPONENT: $$GET(,,,,,,) VARIABLES: ******************** 816 NAME: HEALTH SUMMARY COMPONENTS FOR PDX CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The PDX application is granted permission to extract the following Health Summary Components using the function documented in integration agreement #815: Health Summary Component Abbreviation --------------------------- ------------ ADVERSE REACTIONS/ALLERGIES ADR CLINICAL WARNINGS CW CRISIS NOTES CN DIETETICS DI EKG EKG LAB BLOOD AVAILABILITY BA LAB BLOOD TRANSFUSIONS BT LAB CHEMISTRY & HEMATOLOGY CH LAB CUMULATIVE SELECTED SCLU LAB CUMULATIVE SELECTED 1 SCL1 LAB CUMULATIVE SELECTED 2 SCL2 LAB CUMULATIVE SELECTED 3 SCL3 LAB CUMULATIVE SELECTED 4 SCL4 LAB CYTOPATHOLOGY CY LAB MICROBIOLOGY MIC LAB MICROBIOLOGY BRIEF BMIC LAB ORDERS LO LAB ORDERS BRIEF BLO LAB SURGICAL PATHOLOGY SP LAB TESTS SELECTED SLT MAS ADMISSIONS/DISCHARGES ADC MAS ADT HISTORY ADT MAS CLINIC VISITS FUTURE CVF MAS CONTACTS CON MAS CLINIC VISITS PAST CVP MAS DEMOGRAPHICS DEM MAS DEMOGRAPHICS BRIEF BDEM MAS DISABILITIES DS MAS DISCHARGE DIAGNOSIS DD MAS DISCHARGES DC MAS MH CLINIC VISITS FUTURE MHFV MAS PROCEDURES ICD CODES PRC MAS SURGERIES ICD CODES OPC MAS TRANSFERS TR MAS TREATING SPECIALTY TS MEDICINE SUMMARY MED MEDS BY DRUG CLASS RXDC MEDS BY RX ORD ITEM RXOI MH HIGH RISK PRF HX MHRF MH TREATMENT COORDINATOR MHTC ORDERS CURRENT ORC ORDERS PENDING ORP PCE IMMUNIZATIONS IM PCE IMMUNIZATIONS DETAILED DIM PHARMACY (OP BY DRUG CLASS) RXDC PHARMACY (OP BY RX ORD ITEM) RXOI PHARMACY INTRAVENOUS RXIV PHARMACY OUTPATIENT RXOP PHARMACY UNIT DOSE RXUD PROGRESS NOTES PN PROGRESS NOTES BRIEF BPN PROGRESS NOTES SELECTED TITLE SPNT RADIOLOGY IMPRESSION RI RADIOLOGY PROFILE RP RADIOLOGY STATUS RS SURGERY ONLY REPORTS SRO SURGERY NON OR PROCEDURES NSR SURGERY REPORTS SR SURGERY REPORTS BRIEF BSR SURGERY SEL NON OR PROCEDURES SNSR VITAL SIGNS VS VITAL SIGNS SELECTED SVS WH PREGNANCY DOCUMENTATION WHP WH LACTATION DOCUMENTATION WHL WH PREGNANCY & LACTATION DOC WHPL ROUTINE: ******************** 817 NAME: DBIA298-B CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary application is granted permission to use the function call $$TRANENC^VAQUTL3(TRAN,0) in order to determine if encryption for a PDX Transaction has been turned on. Input: TRAN - Pointer to the VAQ - TRANSACTION file 0 - Input of 0 as second parameter will only be supported Output: 0 - Encryption for the transaction has been turned off 1 - Encryption for the transaction has been turned on Notes: a) Existence of VAQIGNC will be checked. If it exists and is set to 1 encryption will be ignored for this transaction. b) If encryption is on and the transaction does not include an encryption method, the default encryption method will be used. c) Encryption off will be returned on error. ROUTINE: VAQUTL3 COMPONENT: $$TRANENC(TRAN,0) VARIABLES: ******************** 818 NAME: DBIA298-C CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary application is granted permission to use the function call $$NCRYPTON^VAQUTL2(0) in order to determine the default encryption method for a facility. Input: 0 - Input of 0 (the default value) will only be supported Output: 0 - Encryption has been turned off at the facility X - Pointer to VAQ - ENCRYPTION METHOD file (#394.72) Notes: a) Existence of VAQIGNC will be checked. If it exists and is set to 1 encryption will be ignored. b) Encryption off will be returned on error. ROUTINE: VAQUTL2 COMPONENT: $$NCRYPTON(0) VARIABLES: ******************** 819 NAME: DBIA298-D CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary application is granted permission to use the function call $$ENCDSP^VAQHSH(TRAN,ROOT,ENCPTR,DSPOFF,DSPCNT) in order to encrypt a Health Summary component that has been extracted in display ready format. Input: TRAN - Pointer to VAQ - TRANSACTION file ROOT - Where the Display Array is (full global reference) ENCPTR - Pointer to VAQ - ENCRYPTION METHOD file DSPOFF - Offset into Display Array to begin at (defaults to 0) DSPCNT - Number of lines in Display Array (defaults to all lines) Output: 0 - Success -1^Text - Error Notes: a) If TRAN>0 Encryption will be based on the transaction Encryption keys will be based on the transaction Else Encryption will be based on ENCPTR Encryption keys based on current user b) Existence of TRAN takes precedence over ENCPTR ROUTINE: VAQHSH COMPONENT: $$ENCDSP(,,,,) VARIABLES: ******************** 820 NAME: DBIA298-E CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 394.71 ROOT: VAT(394.71, DESCRIPTION: TYPE: File The Health Summary application is granted read access to the following fields and, if listed, their associated cross references: File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 394.71 .01 0;1 Data Segment Name B .04 0;4 Health Summary Component ROUTINE: ******************** 821 NAME: DBIA299-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DIC( DESCRIPTION: TYPE: File The PDX (V 1.5) application is granted read access to the DD and DIC globals to accomplish the following tasks: 1) Get global location for a file ^DIC(FILE,0,"GL") ROUTINE: ******************** 823 NAME: DBIA302-C CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 25,1993 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 51 ROOT: PS(51, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. File Field Node;Piece Description (Field name) X-Refs ----- ----- ---------- ------------------------------ ------ 51 .01 0;1 NAME B,A .5 0;3 SYNONYM AD 1 0;2 EXPANSION 0 AB 9 9;1 PLURAL AC ROUTINE: ******************** 828 NAME: DBIA311-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File The Discharge Summary package has permission to access the Patient Information Management System package in the following ways: 3. When printing VA Form 10-1000 Discharge Summary uses the externally formatted name of the Division from which the patient was discharged, as found in field .015 of the Ward Location File (#42). The division is obtained by a call to EN^DIQ1 with DIC=42, DR=.015, and DA = WARD LOCATION record # returned from the IN5^VADPT call. ROUTINE: ******************** 829 NAME: DBIA311-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY In order to accommodate multi-divisional sites, where any of our package site parameters may vary by division, the .01 field of the GMRD SITE PARAMETERS file (#128.99) points to MEDICAL CENTER DIVISION file (#40.8). QUASAR 1. Quality: Audiology and Speech Pathology Audit and Review (QUASAR) Package, A&SP SITE PARAMETERS File (#509850.8), DIVISION Field Multiple (#3), DIVISION Field (#.01) points to the MEDICAL CENTER DIVISION File (#40.8) to accommodate recording, tracking and reporting workload by division. 2. Quality: Audiology and Speech Pathology Audit and Review (QUASAR) Package, A&SP CLINIC VISIT File (#509850.6), DIVISION Field (#60) points to the MEDICAL CENTER DIVISION File (#40.8) to accommodate recording, tracking and reporting workload by division. 3. Quality: Audiology and Speech Pathology Audit and Review (QUASAR) Package, A&SP DELETE VISIT File (#509850.9), DIVISION Field (#10) points to the MEDICAL CENTER DIVISION File (#40.8) to accommodate recording, tracking and reporting workload by division. USAGE: Controlled Subscri ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File ROUTINE: ******************** 830 NAME: DBIA314-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DIC( DESCRIPTION: TYPE: File To support the table-driven upload of transcribed text to various DHCP files, the Discharge Summary application has permission to access the Data Dictionary and File of Files in the following ways: 1. In order to allow the site to specify the target file, fixed-field header elements, and word-processing field for each report type, Discharge Summary version 1 will make several references to either the File of Files or ^DD(. These are ONLY done in setting up a ^DIC call (to look-up a given field in the target file), or in screening logic (e.g., to exclude the programmer at the site from choosing a non-Word-Processing field in the target file as the destination for the body of a report). Needless to say, NO SETs or KILLs are ever executed on any of FileMan's supporting data structures (i.e., ^DD( or ^DIC(). All hard-coded references to ^DIC( or ^DD( are made from within the following code: GMRDUPAR ; SLC/JER - Upload Parameter Edit ;4/23/93 14:53 ;;1.0V2;Discharge Summary;;Sep 02, 1993 MAIN ; Controls branching N DIC,DA,DIE,DLAYGO,DR,GMRDPRM0,GMRDPRM1,GMRDPRM3,GMRDUSRC,GMRD1ST,X,Y D:'$D(GMRDPRM0) SETPARM^GMRDLIBE W !,"First edit Division-wide upload parameters:",! S (DIC,DLAYGO)=128.99,DIC(0)="AEMQL",DIC("A")="Select DIVISION: " D ^DIC K DLAYGO Q:+Y'>0 S DA=+Y S DIE=128.99,DR="[GMRD UPLOAD PARAMETER EDIT]" D ^DIE D SETPARM^GMRDLIBE W !!,"Now edit the REPORT TYPE file:",! F D Q:+$G(Y)'>0 . N GMRDREP,GMRDX . S DIC="^GMR(128.1,",DIC(0)="AEMQZ",DIC("A")="Select REPORT TYPE: " . I $D(^DISV(DUZ,DIC)),'$D(GMRD1ST) S DIC("B")=$G(^DISV(DUZ,DIC)), GMRD1ST=1 . D ^DIC K DIC Q:+Y'>0 S DA=+Y,GMRDREP=Y,GMRDREP(0)=Y(0) . S DIE=128.1,DR="[GMRD UPLOAD PARAMETER EDIT]" . D ^DIE S Y=1 . I $D(^GMR(128.1,+DA,"HEAD"))>9!($D(^GMR(128.1,+DA,"ITEM"))>9) D . . W !!,"The header for the ",$P(GMRDREP,U,2)," Report type is now defined as:" . . I $P(GMRDPRM0,U,16)="D" D DHDR^GMRDTHLP(.GMRDREP,GMRDPRM0,GMRDPRM1) . . I $P(GMRDPRM0,U,16)="C" D CHDR^GMRDTHLP(.GMRDREP,GMRDPRM0,GMRDPRM1) . . W ! Q TXTFLD(TFILE,GMRDFLT) ; Get Text Field # from ^DD(Target file #, N DIC,X,Y S DIC="^DD("_TFILE_",",DIC(0)="AEMQZ",DIC("A")="Select TARGET TEXT FIELD : " S DIC("S")="I +$$ISWP^GMRDUPAR(TFILE,+Y)" I $D(GMRDFLT) S DIC("B")=GMRDFLT D ^DIC G:+Y'>0 TXTFLDX S Y=+Y_";"_$P($P(Y(0),U,4),";") TXTFLDX Q Y ISWP(TFILE,TFLD) ; Is a given field a Word-processing type field N X,Y S Y=0 I +$P(^DD(TFILE,TFLD,0),U,2)>0 D . N SFILE S SFILE=+$P(^DD(TFILE,TFLD,0),U,2) . S Y=$S($P(^DD(SFILE,.01,0),U,2)="W":1,1:0) Q Y 2. The input transform for the TARGET FILE field (#.05) in the GMR REPORT TYPE file, which is a pointer to the File of Files, assures that only files which include the "GMRD" application group may be chosen for inclusion in the upload. This was done to assure that the site could not inadvertently choose an inappropriate target file (NOTE: the only file exported with this Application Group is the GMR REPORTS FILE (#128), where Discharge Summaries themselves are housed). The input transform looks like this: S DIC("S")="I $D(^DIC(+Y,""%"",""B"",""GMRD""))" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X ROUTINE: ******************** 831 NAME: DBIA315-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: FEE BASIS FEE BASIS CLAIMS SYSTEM ADDED 1/6/2009 USAGE: Controlled Subscri ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCS58CC COMPONENT: PRCS58CC VARIABLES: PRCSX Type: Input String value consisting of pieces delimited by the caret (^). Piece Data --- --------------------------------------- ----- 1 IEN of Daily Reference # in 424 =$O(^PRC(424,"B","STA#-OBLIGATION#-REF#",0)) 2 INTERNAL DATE/TIME 3 AMOUNT of PAYMENT 4 COMMENTS 5 COMPLETE FLAG 6 INTERFACE ID 7 (optional) SKIP FCP CHECK FLAG, set = 1 to skip the fund control point access check (7th piece added by patch PRC*5.1*162) Y Type: Output If Y'=1 call failed and reason is in the second piece of Y Post a payment or credit amount to a 1358 authorization. ******************** 832 NAME: DBIA315-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCSUT31 COMPONENT: EN1 VARIABLES: Input variables: Required - 'X' equal to the full Obligation Number 'PRCS("TYPE")' equal to the namespace of the application. (For Fee it is 'FB') Output variables: 'Y' Process: If 'Y' equal null, invalid Obligation Number 'Y' equal the next sequence number ******************** 833 NAME: DBIA316-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: NOV 1,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 3. The lookup routine, XTLKDICL, is often executed recursively by Fileman. under some conditions, it is not appropriate to proceed with the lookup and processing must pass back to DIC at the appropriate entry point. MTLU therefore needs support for the entry points, ASK^DIC and RTN^DIC. Some of the variables that are used by the ASK^DIC and RTN^DIC calls are: Variables: Used in: DO(2 EN2+3,EN2+5 DIC TS+1 DIC(0 XTLKDICL+3,EN1+2 DIE XTLKDICL+3 DIPGM(0 XTLKDICL+3,XTLKDICL+5 DO TS DO(2 TS,TS+1,TS+2 X XTLKDICL+4,EN2+1,EN2+3,EN2+5,TS+1,TS+4,TS+8,TS+9 Y EN2+1,TS,TS+8,TS+9 Label References: EN1 TS+9 EN2 XTLKDICL+5,TS+8 External References: ASK^DIC EN1+2 RTN^DIC XTLKDICL+3,EN2+3,EN2+5 The calls to RTN^DIC and ASK^DIC are granted for the exclusive use of the Kernel's Toolkit package. ROUTINE: DIC COMPONENT: ASK VARIABLES: COMPONENT: RTN VARIABLES: ******************** 834 NAME: DBIA317-B CUSTODIAL PACKAGE: VETERANS ADMINISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE FEE BASIS SCHEDULING USAGE: Controlled Subscri ENTERED: NOV 2,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VALM2 COMPONENT: SEL VARIABLES: This is what the selector was converted from SDUL ******************** 835 NAME: DBIA323-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: DEC 16,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.5 ROOT: %ZIS(1, DESCRIPTION: TYPE: File To support bar code label printing and downloading/uploading, the Controlled Substances package has found it necessary to develop hardware specific parameters for the TERMINAL TYPE and DEVICE file. Centralized procurements of Hewlett Packard and Kyocera laser printers and Intermec trakkers have steered this package toward the use of these hardware types. As testing has proceeded, the need to accurately communicate complex strings for insertion into the TERMINAL TYPE file has proved difficult. An l misinterpreted as a 1, a 0 mininterpreted as a O, or an inadvertant space or lack thereof all can render a device inoperable. It is therefore agreed that IRM utility routines (PSDTER*) be exported which would allow ^DIC look-ups to the TERMINAL TYPE and DEVICE files, ^DIR verification of the selections, and ^DIE stuffs to the necessary fields identified as follows: GLOBAL MAP DATA DICTIONARY #3.5 -- DEVICE FILE STORED IN ^%ZIS(1, (VERSION 7.1) -------------------------------------------------------------------------- ^%ZIS(1,D0,0)= (#.01) NAME [1F] ^ (#1) $I [2F] ^ (#4) ASK DEVICE [3S] ^ ==>(#5) ASK PARAMETERS [4S] ^ ==> ^ (#1.95) SIGN-ON/SYSTEM DEVICE [11S] ^ ^%ZIS(1,D0,1)= (#.02) LOCATION OF TERMINAL [1F] ^ ^%ZIS(1,D0,91)= (#9) MARGIN WIDTH [1N] ^ (#10) FORM FEED [2F] ^ (#11) PAGE ==>LENGTH [3N] ^ (#12) BACK SPACE [4F] ^ ^%ZIS(1,D0,SUBTYPE)= (#3) SUBTYPE [1P] ^ ^%ZIS(1,D0,TYPE)= (#2) TYPE [1S] ^ ^%ZIS(1,D0,VMS)= (#61) LAT SERVER NODE [1F] ^ (#62) LAT SERVER PORT [2F] ^ ==>(#63) VMS DEVICE TYPE [3S] ^ (#64) LAT PORT SPEED [4S] ^ ROUTINE: ******************** 836 NAME: DBIA325-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: DEC 23,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Globals -- For the PATIENT MOVEMENT (#405) file: Zeroth node (^DGPM(ien,0)): Field Name/#/Piece on node Reason Needed ============================ ============= DATE/TIME (#.01) (1) Determine the movement date/time TRANSACTION (#.02) (2) Determine if the movement is an admission PATIENT (#.03) (3) Determine the pointer to the patient whose movement it is ADMISSION/CHECK-IN MOVEMENT (#.14) (14) Determine the pointer to the admission for a particular movement DISCHARGE/CHECK-OUT MOVEMENT (#.17) (17) Determine the pointer to the discharge for a particular movement MAS MOVEMENT TYPE (#.18) (18) Determine the movement type ASIH TRANSFER (#.21) (21) Determine if the movement was due to ASIH "APCA" cross reference (^DGPM("APCA",DFN,Adm Ptr,Mvmt Date,ien)): This cross-reference is used to find all of the movements, as of a specified date, for a specific admission for a patient. "ATID1" cross reference (^DGPM("ATID1",DFN,Inv Adm Date,ien)): This cross-reference is used to find all of a patient's admissions as of a specific date. Please note that all of these references may be found in the routine IVMUFNC1. ROUTINE: ******************** 837 NAME: DBIA325-C CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: DEC 23,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Globals -- For the APPOINTMENT (#1900) field (sub-file #2.98) of the PATIENT (#2) file: Zeroth node (^DPT(DFN,"S",Visit Date/Time,0)): Field Name/#/Piece on node Reason Needed ============================ ============= APPOINTMENT DATE/TIME (#.001) (ien) Determine the visit date CLINIC (#.01) (1) Need clinic to see of it is non-count STATUS (#3) (2) Need to see if visit was cancelled APPOINTMENT TYPE (#9.5) (16) Need to see if Appointment Type is billable OUTPATIENT ENCOUNTER (#21) (20) Need pointer to the Outpatient Encounter (if it exists) to see if visit was related to claimed exposures For the DISPOSITION LOG-IN DATE/TIME (#1000) field (sub-file #2.101) of the PATIENT (#2) file: Zeroth node (^DPT(DFN,"DIS",Inv Log-In Date/Time,0)): Field Name/#/Piece on node Reason Needed ============================ ============= STATUS (#1) (2) Make sure registration is not Application w/o Exam OUTPATIENT ENCOUNTER (#18) (18) Need pointer to the Outpatient Encounter (if it exists) to see if visit was related to claimed exposures ROUTINE: ******************** 839 NAME: DBIA325-E CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: DEC 23,1993 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 209.42 ROOT: SDD(409.42, DESCRIPTION: TYPE: File For the OUTPATIENT CLASSIFICATION (#409.42) file: Zeroth node (^SDD(409.42,ien,0)): Field Name/#/Piece on node Reason Needed ============================ ============= TYPE (#.01) (1) Determine whether question relates to AO, SC, IR, or EC VALUE (#.03) (3) Determine whether care was related to the claimed exposure. "OE" cross reference (^SDD(409.42,"OE",ptr to #409.68,ien)): This cross-reference is used to find all classification answers for a specific outpatient encounter. Please note that all of these references may be found in the routine IVMUFNC2. ROUTINE: ******************** 840 NAME: DBIA329-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: POLICE & SECURITY USAGE: Private ENTERED: JAN 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DII COMPONENT: B VARIABLES: INQ+1^ESPFM S DI=DIC,DPP(1)=+Y_"^^^@",DK=+Y G B^DII ******************** 842 NAME: DBIA329-D CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: POLICE & SECURITY USAGE: Private ENTERED: JAN 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File 1. Read only: ^DD(910.2,.01,0) - ESP POLICE REGISTRATION LOG File - Displays an identifier. 2. Read only: ^DD(910.7,IEN,0,U,R) - ESP SELECTABLES file - Displays the color field as an identifier. 3. ^DD(912,.01,1,2,1.4) - ESP OFFENSE REPORT file - Executes a trigger to stuff institution information. 4. Read only: ^DD(914,.03,0) - ESP VIOLATIONS file - Displays if courtesy or violation identifier. 5. ^DD("SITE" - IEN - INSTITIUTION file read only. 6. Read only: ^DD(915,.01,0) ESP OFFENSE CODES file - Displays Offense Code as an identifier. ROUTINE: ******************** 844 NAME: DBIA333-C CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: JAN 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Outpatient Pharmacy is granted a temporary integration agreement with Laboratory to obtain results for a given lab test specimen type within a date range. This data may be used many different ways. Current uses are clozapine monitoring, printing on action profile, and drug usage evaluation. GLOBAL MAP DATA DICTIONARY #63 -- LAB DATA FILE STORED IN ^LR( SITE: BIRMINGHAM ISC -------------------------------------------------------------------------- ^LR(D0,"CH",D1,0)= (#.01) DATE/TIME SPECIMEN TAKEN [1D] ^^ (#.03) DATE REPORT COMPLETED [3D] ^^ (#.05) SPECIMEN TYPE [5P] ^ ^LR(D0,"CH",D1,data name#)= (data name#) results ^ ROUTINE: ******************** 845 NAME: DBIA335-B CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: JAN 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Pharmacy Prescription Practices Prototype is granted this DBIA with Scheduling to make the following calls: C. ^DPT(DFN,"S",DATE,0) -> Used to verify that a clinic appointment has not been canceled. ROUTINE: ******************** 846 NAME: DBIA344-B CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Unwinder was originally written as part of OE/RR in the namespace OR. When the Unwinder functionality was separated into the XQOR routines, all the links to OE/RR were isolated into the routine, XQORO. This routine uses OE/RR variables, and calls into OE/RR entry points. The following integration agreements are needed to support this routine (XQORO). OE/RR Variables: The XQORO routine makes sure OE/RR variables are set to the proper values between each protocol that is executed. The following variables are killed between each protocol to protect the OE/RR environment - ORIFN,ORCOST,ORIT,ORSTRT,ORSTOP,ORTO,ORPURG,ORTX,ORSTS,ORPK,ORLOG, ORPCL,OR,ORZ,ORNS The following variables are reset between each protocol - ORVP,ORPV,ORL,ORTS,ORDUZ,ORNP,OROLOC,ORGY,ORACTION,OROLD,ORNS, ORTX,ORUP ORPRFRM is used in conjunction with response time monitoring. ROUTINE: ******************** 847 NAME: DBIA344-C CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.99 ROOT: ORD(100.99, DESCRIPTION: TYPE: File Read Access to File 100.99: The OE/RR Parameters file (100.99) is accessed in setting up some of the OE/RR variables and in determining if OE/RR is running. ROUTINE: ******************** 848 NAME: DBIA344-D CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR1 COMPONENT: ADD VARIABLES: Use of ADD^OR1: This is called to set up a context for adding orders. OREND and ORPTLK are checked after this call to see if the context was successfully established. This agreement, along with the one concerning the use of AFT^OR1, would replace DBIA #8 and DBIA #46. COMPONENT: AFT VARIABLES: Use of AFT^OR1: This is called to present and OE/RR review screen and to clear the 'add orders' context. ******************** 849 NAME: DBIA344-E CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX2 COMPONENT: PT1 VARIABLES: Use of PT1^ORX2: This unlocks the patient when exiting an 'add orders' context. ******************** 850 NAME: DBIA344-F CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUTL COMPONENT: READ VARIABLES: Use of READ^ORUTL: This awaits user input in a manner consistant with OE/RR. ******************** 851 NAME: DBIA344-G CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORGKEY COMPONENT: SET VARIABLES: Use of SET^ORGKEY: This sets up keywords that are allowed during the 'add orders' context. ******************** 852 NAME: DBIA344-H CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: JAN 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUHDR COMPONENT: OE VARIABLES: Use of OE^ORUHDR: This sets up the menu headers appropriate for OE/RR with the display of a protocol menu during an 'add orders' context. The variable ORUIEN, which identifies the menu, is set and killed. ******************** 854 NAME: DBIA346-B CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: FEB 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.2 ROOT: XT(8984.2, DESCRIPTION: TYPE: File Read only access to ^XT(8984.2,"B" and the associated data node ^XT(8984.2,DA,0) If the user input is found in the "B" cross-reference, and it is a valid "Short Cut" for the Clinical Lexicon - ^XT(8984.2,DA,0)[GMP(757.01 - then the preprocessing of the input string is disabled and the Multi-Term Look-Up Utility (MTLU) is called directly (GMPTA2). Read only access to ^XT(8984.* globals for $D checks in the Environment Check routine prior to installing the Clinical Lexicon (GMPTIENV). i.e. I '$D(^XT(8984.1)) W !,"Multi-Term Look-Up Untility not found" K DIFQ Q Read/Write access to ^XT(8984.* global in Post-Init routines to setup the Multi-Term Look-Up Utility for the Clinical Lexicon (GMPTIPST). i.e., a. Seeding the Local Look-Up file #8984.4 with the Clinical Lexicon Expression file #757.01, the "AWRD" index and the XTLK^GMPTPRNT display routine. b. Seeding the Synonym file #8984.3 with Cancer as a sample synonym for Carcinoma c. Seeding the Short Cut file #8984.2 with DM II as a sample short cut for Diabetes Mellitus, Non-Insulin Dependent ROUTINE: ******************** 855 NAME: DBIA346-C CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: FEB 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.3 ROOT: XT(8984.3, DESCRIPTION: TYPE: File Read only access to ^XT(8984.* globals for $D checks in the Environment Check routine prior to installing the Clinical Lexicon (GMPTIENV). i.e. I '$D(^XT(8984.1)) W !,"Multi-Term Look-Up Untility not found" K DIFQ Q Read/Write access to ^XT(8984.* global in Post-Init routines to setup the Multi-Term Look-Up Utility for the Clinical Lexicon (GMPTIPST). i.e., a. Seeding the Local Look-Up file #8984.4 with the Clinical Lexicon Expression file #757.01, the "AWRD" index and the XTLK^GMPTPRNT display routine. b. Seeding the Synonym file #8984.3 with Cancer as a sample synonym for Carcinoma c. Seeding the Short Cut file #8984.2 with DM II as a sample short cut for Diabetes Mellitus, Non-Insulin Dependent ROUTINE: ******************** 856 NAME: DBIA346-D CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: FEB 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.4 ROOT: XT(8984.4, DESCRIPTION: TYPE: File Read only access to ^XT(8984.* globals for $D checks in the Environment Check routine prior to installing the Clinical Lexicon (GMPTIENV). i.e. I '$D(^XT(8984.1)) W !,"Multi-Term Look-Up Untility not found" K DIFQ Q Read/Write access to ^XT(8984.* global in Post-Init routines to setup the Multi-Term Look-Up Utility for the Clinical Lexicon (GMPTIPST). i.e., a. Seeding the Local Look-Up file #8984.4 with the Clinical Lexicon Expression file #757.01, the "AWRD" index and the XTLK^GMPTPRNT display routine. b. Seeding the Synonym file #8984.3 with Cancer as a sample synonym for Carcinoma c. Seeding the Short Cut file #8984.2 with DM II as a sample short cut for Diabetes Mellitus, Non-Insulin Dependent ROUTINE: ******************** 861 NAME: OR CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: OR COMPONENT: EN VARIABLES: X Type: Input Variable pointer of the protocol. OE/RR Processor. This is the main entry point to run the OE/RR program. It is called with X set as a variable pointer to the initial protocol. ******************** 862 NAME: ORUHDR CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUHDR COMPONENT: EXT VARIABLES: ORIFN Type: Both Internal number in file 100 of the order to display. ORAGE Type: Output Patient age. ORIO Type: Output ORANSI Type: Output ORDOB Type: Output Patient Date of Birth ORFT Type: Output ORHI Type: Output ORNP Type: Output Pointer to file 200 for Current Agent/Provider ORL Type: Output Variable pointer to the variable pointer. ORPD Type: Output ORPNM Type: Output Patient name ORPV Type: Output Pointer to Provider file for the person requesting the order. ORSEQ Type: Output ORSEX Type: Output Patient sex. ORSSN Type: Output Patient SSN ORTIT Type: Output Title ORTS Type: Output Pointer to Treating Specialty associated with the order. ORVP Type: Output Variable pointer toe object of an order. ORWARD Type: Output Inpatient Ward location Displays a standard header for detailed order displays. If calling this from within OE/RR, it is not necessary to killthe returned variables. OE/RR will kill them. COMPONENT: PGBRK VARIABLES: DIROUT Type: Output User entered a '^^' OREND Type: Output User entered a '^' Displays 'Press return to continue or "^" to escape' at page breaks. ******************** 864 NAME: ORUTL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORUTL COMPONENT: READ VARIABLES: ******************** 865 NAME: ORVOM CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORVOM ******************** 866 NAME: ORX CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING SURGERY USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX COMPONENT: FILE VARIABLES: OREPDUZ Type: Input DUZ of the person entering the order. ORL Type: Input Variable pointer to the variable pointer. ORPCL Type: Input Variable pointer to the protocol that created the order. ORNP Type: Input Pointer to file 200 for Current Agent/Provider ORVP Type: Input Variable pointer to the object of an order. ORCOST Type: Input Cost of the order OREVENT Type: Input Two piece variable delimited by a semicolon. The first piece is the time at which an event should occur. The second piece is a character that has meaning to a package. ORIT Type: Input Variable pointer to the item ordered. ORLOG Type: Input Time the order is entered. ORPK Type: Input Package reference defined by the package when an order is created. ORPURG Type: Input Grace days before an order is purged. ORSTOP Type: Input Order Stop Date ORSTRT Type: Input Order start date ORSTS Type: Input Order status ORTO Type: Input Pointer to Display Group file. Identifies the service receiving the order. ORTS Type: Input Pointer to Treating Specialty associated with the order. ORTX(i) Type: Input Order Text. ORIFN Type: Output Internal entry number of order in file 100 COMPONENT: RETURN VARIABLES: ORIFN Type: Input Internal entry number of order. ORETURN(OR Type: Input Cost of the order. ORETURN(OR Type: Input Two piece variable delimited by a semicolon. The first piece is the time at which an event should occur. The second piece is a character that has meaning to a package. ORETURN(OR Type: Input Variable pointer to the item ordered. ORETURN(OR Type: Input Free text, package defined reference. ORETURN(OR Type: Input Grace period before purging order. ORETURN(OR Type: Input Pointer to file 200 for Current Agent/Provider ORETURN(OR Type: Input Stop Date ORETURN(OR Type: Input Start Date ORETURN(OR Type: Input Pointer to Order Status ORETURN(OR Type: Input Order Text COMPONENT: ST VARIABLES: ORIFN Type: Input Internal entry number of the order. ORSTS Type: Input Order Status ******************** 867 NAME: ORX2 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING OUTPATIENT PHARMACY CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX2 COMPONENT: LK VARIABLES: X Type: Input Variable pointer of patient. Y Type: Output Y=1 if lock is successful, 0 if failed. This interactive call will attempt to lock a patient's "chart" when adding new orders; if the lock fails, a message will be displayed indicating who has the patient's chart locked currently. Applications using this entry point must also call ULK^ORX2 to unlock the chart when finished. COMPONENT: ULK VARIABLES: X Type: Input Variable pointer to the patient. This silent call will unlock a patient's "chart" after adding new orders. Do not call this entry point unless you have already successfully locked the chart via LK^ORX2. COMPONENT: LOCK VARIABLES: DFN Type: Input This parameter is a pointer to the Patient file #2. $$LOCK Type: Output Function returns 1 if lock is successful or 0^message if failed. This silent call will attempt to lock a patient's "chart" when adding new orders. Applications using this entry point must also call UNLOCK^ORX2 to unlock the chart when finished. COMPONENT: UNLOCK VARIABLES: DFN Type: Input This parameter is a pointer to the Patient file #2. This silent call will unlock a patient's "chart" after adding new orders. Do not call this entry point unless you have already successfully locked the chart via $$LOCK^ORX2(DFN). COMPONENT: LOCK1 VARIABLES: ORIFN Type: Input This parameter is a pointer to the Orders file #100. $$LOCK1 Type: Output Function returns 1 if lock is successful or 0^message if failed. This silent call will attempt to lock an order in the Orders file #100 when it is updated. Applications using this entry point must also call UNLK1^ORX2 to unlock the order when finished. COMPONENT: UNLK1 VARIABLES: ORIFN Type: Input This parameter is a pointer to the Orders file #100. This silent call will unlock an order after updating it. Do not call this entry point unless you have already successfully locked the order via $$LOCK1^ORX2(ORIFN). ******************** 868 NAME: ORX3 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX3 COMPONENT: NOTE VARIABLES: ORNOTE(i) Type: Input i=internal # of the notification ORVP Type: Input Variable pointer to the patient. ORIFN Type: Input Order number that you want this notification to linked to. This is an entry point that creates a notification for a package. ******************** 869 NAME: ORX5 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX5 COMPONENT: DC VARIABLES: ORIFN Type: Input Pointer to the order. This entry is called when a package needs to create a DC order. COMPONENT: HOLD VARIABLES: ORIFN Type: Input Pointer to the order. This entry is called when a package needs to place a HOLD on an ordered item. ******************** 870 NAME: ORX7 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX7 COMPONENT: DC VARIABLES: ORIFN Type: Input Pointer to the order. ORNATR Type: Input Identifies the Nature of Order. This entry point is provided for orders that are discontinued by the service. This creates a DC order for the order identified by ORIFN. ******************** 871 NAME: ORX8 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING MRSA INITIATIVE REPORTS VIRTUAL PATIENT RECORD 4/24/13 DT: Added for use with VPR*1*1 HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR VIA added as a subscriber to ICR #871 for access to EN~ORX8. This API will be referenced in VIAB MEDHIST RPC for their OrderMgmtSv - getMedHistory. CLINICAL REMINDERS Added 4/13/21, effective with PXRM*2.0*45 and OR*3.0*377. USAGE: Controlled Subscri ENTERED: APR 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX8 COMPONENT: EN(ORIFN) VARIABLES: ORIFN Type: Input Pointer to the order. ORUPCHUK(' Type: Output =WHO ENTERED^External Format ORUPCHUK(' Type: Output =PATIENT LOCATION ORUPCHUK(' Type: Output =CURRENT AGENT/PROVIDER^External format ORUPCHUK(' Type: Output =WHEN ENTERED ORUPCHUK(' Type: Output =PROTOCOL ORUPCHUK(' Type: Output =CURRENT AGENT/PROVIDER^External Format ORUPCHUK(' Type: Output =STOP DATE ORUPCHUK(' Type: Output =CURRENT START DATE ORUPCHUK(' Type: Output =STATUS^External format ORUPCHUK(' Type: Output =TO (display group)^External Format ORUPCHUK(' Type: Output =ORDER TEXT (Multiple) ORUPCHUK(' Type: Output =OBJECT OF ORDER This entry point returns data from the Order file (100) for a particular order. ******************** 872 NAME: File 101 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE LAB ADDED 2/16/2011 RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING VISIT TRACKING PROBLEM LIST TEXT INTEGRATION UTILITIES PCE PATIENT CARE ENCOUNTER DISCHARGE SUMMARY To allow the user to get a detailed description of the actions that are executable from menu-type protocols, applications need to be able to $ORDER through the subscript ^ORD(101,DO,10,D1,0) to get sub-fields #1 (ITEM) and # 3 (SEQUENCE) of the 101.01 multiple for each ITEM. Then get field #1 (ITEM TEXT) and #3.5 (DESCRIPTION) for each PROTOCOL encountered in the ITEM MULTIPLE for a given menu. To allow the user to retrieve Discharge Summaries into the review screen based on Signature Status and Search Category (e.g., by PATIENT, PROVIDER, or TREATING SPECIALTY), we need to be able to execute a DIC call on file 101 to retrieve the zero node of a record and to reference field # 24 (SCREEN) in order to set up the local variables to be used to execute the ^XQORM call. KERNEL LEXICON UTILITY OUTPATIENT PHARMACY SURGERY CLINICAL INFO RESOURCE NETWORK ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS AUTHORIZATION/SUBSCRIPTION PHARMACY DATA MANAGEMENT CONTROLLED SUBSTANCES CLINICAL CASE REGISTRIES ADVERSE REACTION TRACKING E CLAIMS MGMT ENGINE USAGE: Controlled Subscri ENTERED: APR 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101 ROOT: ORD(101, DESCRIPTION: TYPE: File This file may be referenced by packages to maintain protocols within their namespace. This file may also be pointed to. ROUTINE: ******************** 873 NAME: File 100.98 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING CARE MANAGEMENT AUTOMATED MED INFO EXCHANGE AMIE ADDED 4/13/2011 VIRTUAL PATIENT RECORD Added for use with VPR*1*1 VISTA INTEGRATION ADAPTOR This documents the Vista Integration Adapter application's use of the DISPLAY GROUP file (#100.98). The ICR will be used by the following RPCs and Services: VIAB MEDHIST OrderMgmtSvc - getMedHistory OUTPATIENT PHARMACY Added 4/18/19 CMOP Added 4/18/19 USAGE: Controlled Subscri ENTERED: APR 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.98 ROOT: ORD(100.98, DESCRIPTION: TYPE: File This file may be referenced to determine an appropriate Display Group for an order in the manner: S ORTO=$O(^ORD(100.98,'B','OTHER HOSPITAL SERVICES',0)) ROUTINE: ******************** 874 NAME: File 100.99 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING PROBLEM LIST TEXT INTEGRATION UTILITIES SURGERY USAGE: Controlled Subscri ENTERED: APR 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.99 ROOT: ORD(100.99, DESCRIPTION: TYPE: File This file may be referenced by packages interfacing with OE/RR to see if OE/RR has been installed in the manner: I $D(^ORD(100.99)) ... Packages may also setup entries in the Package Parameters portion of this file. ROUTINE: ******************** 875 NAME: File 100.01 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE DIETETICS CONSULT/REQUEST TRACKING CLINICAL PROCEDURES REGISTRATION SCHEDULING CLINICAL REMINDERS AUTOMATED MED INFO EXCHANGE OUTPATIENT PHARMACY Added 4/18/19. CMOP Added 4/18/19. USAGE: Controlled Subscri ENTERED: APR 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.01 ROOT: ORD(100.01, DESCRIPTION: TYPE: File This file may be pointed to. ROUTINE: ******************** 886 NAME: DBIA886 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: EXTERNAL PEER REVIEW USAGE: Private ENTERED: NOV 17,1994 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. As described in DBIA885, External Peer Review needs to identify patients receiving prescriptions in certain VA classes. ^PSDRUG(D0,0) 2 VA CLASSIFICATION 0;2 Direct Global Read & w ROUTINE: ******************** 887 NAME: MTLU setup CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: CLINICAL LEXICON UTILITY USAGE: Controlled Subscri ENTERED: MAY 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.4 ROOT: XT(8984.4, DESCRIPTION: TYPE: File The Clinical Lexicon Utility needs to write to the Kernel Toolkit Multi-Term Look-up Utility's (MTLU) files/DDs during the Post-Init. ^XT(8984.4,757.01,0) .01 NAME 0;1 Both R/W w/Fileman .03 INDEX 0;3 Both R/W w/Fileman ^XT(8984.4,757.01,1) .02 DISPLAY PROTOCOL 1;1 Both R/W w/Fileman ROUTINE: ******************** 888 NAME: MTLU setup CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: MAY 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.1 ROOT: DD(8984.1 DESCRIPTION: TYPE: File The Clinical Lexicon Utility needs to write to the DD of the Kernel Toolkit Multi-Term Look-up Utility (MTLU) during the Post-Init. ^DD(8984.1,.02,'V',D0,0) .01 FILE 0;1 Both R/W w/Fileman .02 MESSAGE 0;2 Both R/W w/Fileman .03 ORDER 0;3 Both R/W w/Fileman .05 SHOULD ENTRIES BE SC 0;5 Both R/W w/Fileman .06 SHOULD USER BE ALLOW 0;6 Both R/W w/Fileman .04 PREFIX 0;4 Both R/W w/Fileman ROUTINE: ******************** 889 NAME: MTLU setup CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: MAY 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.2 ROOT: DD(8984.2, DESCRIPTION: TYPE: File The Clinical Lexicon Utility needs to write to the DD of Kernel Toolkit Multi-Term Look-up Utility (MTLU) during the Post-Init. ^DD(8984.2,.02,'V',D0,0) .01 FILE 0;1 Both R/W w/Fileman .02 MESSAGE 0;2 Both R/W w/Fileman .03 ORDER 0;3 Both R/W w/Fileman .05 SHOULD ENTRIES BE SC 0;5 Both R/W w/Fileman .06 SHOULD USER BE ALLOW 0;6 Both R/W w/Fileman .04 PREFIX 0;4 Both R/W w/Fileman ROUTINE: ******************** 890 NAME: MTLU setup CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Controlled Subscri ENTERED: MAY 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.2 ROOT: XT(8984.2, DESCRIPTION: TYPE: File The Clinical Lexicon Utility needs to write to the Kernel Toolkit Multi-Term Look-up Utillity's (MTLU) files/DDs during the Post-Init. ^XT(8984.2,D0,0) .01 FREQUENTLY USED NARR 0;1 Both R/W w/Fileman .02 ENTRY 0;2 Both R/W w/Fileman .03 CODE 0;3 Both R/W w/Fileman ROUTINE: ******************** 891 NAME: MTLU setup CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Controlled Subscri ENTERED: MAY 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8984.3 ROOT: XT(8984.3, DESCRIPTION: TYPE: File The Clinical Lexicon Utility needs to write to the Kernel Toolkit Multi-Term Look-up Utility's (MTLU) files/DDs during the Post-Init. ^XT(8984.3,D0,0) .01 TERM 0;1 Both R/W w/Fileman .02 ASSOCIATED FILE 0;2 Both R/W w/Fileman .03 SYNONYM 1;0 Both R/W w/Fileman Multiple ^XT(8984.3,D0,1,D1,0) .01 SYNONYM 0;1 Both R/W w/Fileman ROUTINE: ******************** 892 NAME: GMTSLRCE CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING MYHEALTHEVET ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: FEB 15,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Adverse Reaction Tracking (ART) package uses a call to XTRCT^GMTSLRCE to extract lab results. A check is made for the existence of the routine i.e., $T(GMTSLRCE^GMTSLRCE). ROUTINE: GMTSLRCE COMPONENT: XTRCT VARIABLES: LRDFN Type: Input IFN of patient in Lab Data (63) file. SEX Type: Input Sex of patient, where F=female and M=male. GMTS1 Type: Input Inverse end date of search for lab data. GMTS2 Type: Input Inverse start date of search for lab data. MAX Type: Input Maximum number of lab orders to be extracted. RETURN_GLO Type: Output The following global will be returned: @REF@("LRC",$J,IDT,SQN)=CDT^SPC^TST^RSL^FLG^ UNT^LO^HI where: REF = "^UTILITY" if Health Summary V1.2, or "^TMP" if Health Summary V2.5+. IDT = Inverse collection date/time. SQN = Print order sequence number from file 60. CDT = Collection date and time. SPC = Specimen for lab order in an external printable form. TST = Lab test ordered in a external printable form. RSL = Numeric result of test. FLG = Reference flag (H,*H,L,*L). UNT = Unit of measure (external format). LO = Reference/Therapeutic Lower bound. HI0= Reference/Therapeutic Upper bound. ******************** 893 NAME: SURGERY Data Interface for LABORATORY SERVICE CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: DEC 7,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine SROSPLG was written as an interface to provide SURGERY data for LABORATORY SERVICE Surgical Pathology reports created during Anatomic Pathology Log-In. Entry point SROSPLG allows the LABORATORY SERVICE user to select from a list of surgeries performed in the last seven days for the given patient. Entry point DISP extracts the chosen surgery data and copies it into the corresponding Surgical Pathology report. ROUTINE: SROSPLG COMPONENT: SROSPLG VARIABLES: LRDFN Type: Input (Required) This is the LRDFN (#.01) from the patient's record in the LAB DATA file (#63). Based on the provided LRDFN, the code checks the PARENT FILE field (#.02). This field should contain a value of 2, indicating the PATIENT file (#2). If not, program execution ends. DFN Type: Input (Optional) This is the patient's DFN from the PATIENT file (#2). If this variable is not already defined, the program sets it to the value stored in the NAME field (#.03) of the LAB DATA file (#63). SRTN Type: Output Based on the DFN for the patient, a list of surgeries from the last seven days is presented to the user. The IEN from the SURGERY file (#130) for the chosen surgery is return in variable SRTN. If no surgery was found or was selected by the user, SRTN will be undefined. SRDOC Type: Output If the chosen surgery is a non-OR procedure, the PROVIDER (#123) of the SURGERY file (#130) is returned in variable SRDOC. If it is an OR procedure, the SURGEON (#.14) of the SURGERY file (#130) is returned in variable SRDOC. The value in SRDOC will then be stored in field SURGEON/PHYSICIAN (sub-field #.07) of SURGICAL PATHOLOGY (#8) of the LAB DATA file (#63). The purpose of this component/entry point is to lookup recent surgery data that may exist for this patient/specimen. For the given Surgical Pathology patient, this entry point searches the SURGERY file (#130) for any surgeries performed in the last seven days. If none are found, the user is informed of this. If only one surgery is found, the user is asked if the given surgery is the correct surgery for the specimen. If more than one is found, a surgery may be selected from a list presented to the user. COMPONENT: DISP VARIABLES: SRTN Type: Input (Required) The IEN from the SURGERY file (#130) for the surgery chosen in component SROSPLG. LRDFN Type: Input (Required) This is the LRDFN (#.01) from the patient's record in the LAB DATA file (#63). LRSS Type: Input (Required) The accession area for the record in the LAB DATA file (#63). It will always be "SP" for SURGICAL PATHOLOGY (#8). LRI Type: Input (Required) The inverse DATE/TIME SPECIMEN TAKEN (sub-field #.01) of SURGICAL PATHOLOGY (#8) of the LAB DATA file (#63). This component/entry point is used to extract data from the SURGERY file (#130) for the surgery selected in component SROSPLG and store it in the corresponding sub-fields of SURGICAL PATHOLOGY (#8) of the LAB DATA file (#63). These fields include BRIEF CLINICAL HISTORY (#.013), PREOPERATIVE DIAGNOSIS (#.014), OPERATIVE FINDINGS (#.015), POSTOPERATIVE DIAGNOSIS (#.016). ******************** 894 NAME: DBIA894 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAY 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File The Surgery package has written routines to be used with the Surgical Pathology (SP) portion of the Laboratory package. When an SP specimen is accessioned, the Laboratory package will call the above mentioned Surgery routines. The Surgery routines will allow the accessioning person to associate the specimen with a surgical case and transfer certain information from the SURGERY file (#130) to the LAB DATA file (#63). The information (Brief Clinical History, Preoperative Diagnosis, Operative Findings and Postoperative Diagnosis) will be written to File 63. This agreement gives permission to Surgery to write this information to File 63 if the matching field in File 63 does not already contain data. Also, this agreement allows Surgery to read the PARENT FILE field (.02) and the NAME field (.03) of File 63 to establish the patient identity. ^LR(D0,0) .02 PARENT FILE 0;2 Read w/Fileman In determining the identity of the patient, this field is read to insure this lab record is for a patient in the PATIENT file (#2). .03 NAME 0;3 Read w/Fileman This field provides the internal entry number of the patient in File 2. This IEN is then used in the lookup in the SURGERY file (#130), so the proper surgical case can be displayed to the accessioning person for selection of a case. ^LR(D0,'SP',D1,.2,0) 63.08,.0 BRIEF CLINICAL HISTO .2;0 Both R/W w/Fileman The reading is in the form: I '$O(^LR(D0,'SP',D1,.2,0)). If the read finds no existing data the write will occur. The writing is in the form of a call to %XY^%RCR which moves in the information stored in the matching word-processing field in File 130. ^LR(D0,'SP',D1,.3,0) 63.08,.0 PREOPERATIVE DIAGNOS .3;0 Both R/W w/Fileman The reading is in the form: I '$O(^LR(D0,'SP',D1,.3,0)). If the read finds no existing data, the write will occur. The writing is in the form of hard sets from ^UTILITY created by calls to DIWP and containing information from the matching fields in File 130. Another hard set updates the zero node of this word processing field. ^LR(D0,'SP',D1,.4,0) 63.08,.0 OPERATIVE FINDINGS .4;0 Both R/W w/Fileman The reading is in the form: I '$O(^LR(D0,'SP',D1,.4,0)). If the read finds no existing data, the write will occur. The writing is in the form of a call to %XY^%RCR which moves in the information stored in the matching word-processing field in File 130. ^LR(D0,'SP',D1,.5,0) 63.08,.0 POSTOPERATIVE DIAGNO .5;0 Both R/W w/Fileman The reading is in the form: I '$O(^LR(D0,'SP',D1,.5,0)). If the read finds no existing data, the write will occur. The writing is in the form of hard sets from ^UTILITY created by calls to DIWP and containing information from the matching fields in File 130. Another hard set updates the zero node of this word processing field. ROUTINE: ******************** 895 NAME: PSSGIU CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CLINICAL PROCEDURES SURGERY CONTROLLED SUBSTANCES USAGE: Controlled Subscri ENTERED: JUN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Gives the ability to mark entries in the Drug file (50) for use with various packages. ROUTINE: PSSGIU COMPONENT: EN VARIABLES: PSIUDA Type: Input Internal entry number of the drug in the Drug file (50). The variable is not killed by this entry point. PSIUX Type: Input Package information => package code^package name where: Package code. The code used to mark the entry. This code is provided by the Birmingham ISC. Package name. The name of the package for which the item will be used. The variable is not killed by this entry point. Prompts users to mark or unmark drug entries for use by their package. COMPONENT: ENS VARIABLES: PSIUDA Type: Input Internal entry number of the drug in the Drug file (50). The variable is not killed by this entry point. PSIUX Type: Input Package information => package code^package name where: Package code. The code used to mark the entry. This code is provided by the Birmingham ISC. Package name. The name of the package for which the item will be used. The variable is not killed by this entry point. Automatically marks drug entry for use with the package without any user interaction. COMPONENT: END VARIABLES: PSIUDA Type: Input Internal entry number of the drug in the Drug file (50). The variable is not killed by this entry point. PSIUX Type: Input Package information => package code^package name where: Package code. The code used to mark the entry. This code is provided by the Birmingham ISC. Package name. The name of the package for which the item will be used. The package name is not required for the END entry point. This variable is not killed by this entry point. Automatically unmarks drug entry for use with package with no user interaction. ******************** 896 NAME: DBIA896 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER The Patient/IHS file is distributed in the VA via the Patient/IHS Subset package. USAGE: Private ENTERED: SEP 6,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000001 ROOT: AUPNPAT( DESCRIPTION: TYPE: File ** A DBIA agreement is being requested by the Patient/IHS Subset package (PXPT) with the Indian Health Service. This agreement would document the changes in the use of the Patient/IHS file in the VA. ** This description includes a comparison of the VA's Patient/IHS File (9000001) as distributed in the PXPT package and the IHS's Patient/IHS File (9000001). NOTE: Per discussions previously with IHS developers, George Huggins has agreed to have the file named "Patient" file (9000001) in IHS changed to the name "Patient/IHS" file. VA Patient/IHS File: ==================== The VA version of 9000001 has a subset of fields defined in the IHS version. The main consideration for determining what should be distributed in the VA was: "What is the minimal set of data required to have the Patient/IHS file defined and be useable by IHS tools, such as QMAN". Sending out the minimum set limits the confusion of sending out Patient/IHS fields and pointed to files that could cause confusion in the VA. Summary of differences in File and fields: File SPECIAL LOOKUP ROUTINE is sent out as DPTLK File POST SELECTION ACTION is sent out as D ^AUPNPAT The only fields destributed in VA nationally are NAME, LOCATION OF HOME, and HEALTH RECORD NO. multiple. The Health Record No. multiple has had a few changes. The .01 field is based on the Default institution in the Kernel Site Parameter file because the DUZ(2) upon adding a patient may not reflect the institution the patient should be related to. (e.g., Regional Office adding Patients) The .02 field has been changed to be a freetext field long enough for a SSN or pseudo-SSN or DOD PID with dependent counters. The following is the Standard List of Attributes for the VA version: +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ STANDARD DATA DICTIONARY #9000001 -- PATIENT/IHS FILE 05/26/94 PAGE 1 STORED IN ^AUPNPAT( (406 ENTRIES) SITE: SLC UCI: DVA,DEV DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE ------------------------------------------------------------------------- This file is IHS's primary patient data file. The NAME (.01) field of this file is a pointer to the VA's patient file (#2). Fields in common between the two dictionaries actually exist only in the VA patient file and are referenced by the IHS patient file as computed fields. All other files containing patient data have backward pointers linking them to this file. The linkage is by patient name and the internal FileMan gener- ated number of the ancillary file is the same number used in this file. All applications developed for the RPMS which require patient data will point to this file. FILE SCREEN (SCR-node) : X "I '$P(^DPT(Y,0),U,19)" W $E(^AUPNPAT(Y,0),0) SPECIAL LOOKUP ROUTINE : DPTLK POST-SELECTION ACTION : D ^AUPNPAT DD ACCESS: @ DEL ACCESS: @ POINTED TO BY: PATIENT field (#.02) of the TIU DOCUMENT File (#8925) PATIENT NAME field (#.05) of the VISIT File (#9000010) PATIENT NAME field (#.02) of the V MEASUREMENT File (#9000010.01) PATIENT NAME field (#.02) of the V PROVIDER File (#9000010.06) PATIENT NAME field (#.02) of the V POV File (#9000010.07) PATIENT NAME field (#.02) of the V LAB File (#9000010.09) PATIENT NAME field (#.02) of the V IMMUNIZATION File (#9000010.11) PATIENT NAME field (#.02) of the V SKIN TEST File (#9000010.12) PATIENT NAME field (#.02) of the V EXAM File (#9000010.13) PATIENT NAME field (#.02) of the V MEDICATION File (#9000010.14) PATIENT NAME field (#.02) of the V TREATMENT File (#9000010.15) PATIENT NAME field (#.02) of the V PATIENT ED File (#9000010.16) PATIENT NAME field (#.02) of the V CPT File (#9000010.18) PATIENT NAME field (#.02) of the V HEALTH FACTORS File (#9000010.23) PATIENT NAME field (#.02) of the PROBLEM File (#9000011) CROSS REFERENCED BY: NAME(B), HEALTH RECORD NO.(D) 9000001,.01 NAME 0;1 POINTER TO PATIENT FILE (#2) (Required) INPUT TRANSFORM: S:$D(X) DINUM=X LAST EDITED: SEP 29, 1990 DESCRIPTION: This field points to the Patient file (#2) and has the same internal number as that file. Thus, the patient's name is the Patient file (#2) name. TECHNICAL DESCR: This field is populated in the VA when a new patient is added to the ^DPT file by the PX09 cross-reference on the Social Security Number (.09) field of ^DPT. Any merging of patients in ^DPT by a VAMC should include this PATIENT/IHS file in its merging process. SOURCE OF DATA: 011/PINAME NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMME R CROSS-REFERENCE: 9000001^B 1)= S ^AUPNPAT("B",$E(X,1,30),DA)="" 2)= K ^AUPNPAT("B",$E(X,1,30),DA) 9000001,1201 LOCATION OF HOME 12;0 WORD-PROCESSING #9000001.12 DESCRIPTION: This is the directions to get to the patients home. 9000001,4101 HEALTH RECORD NO. 41;0 POINTER Multiple #9000001.41 (Add New Entry without Asking) DESCRIPTION: This multiple contains the different health record identifiers by facility. IHS uses a 6 character identifier. The VA uses the social security number which may be up to 10 characters. TECHNICAL DESCR: This multiple is used for Multi-Facility Integration (MFI) processing at IHS facilities. IDENTIFIED BY: HEALTH RECORD NO.(#.02), 9000001.41,.01 HEALTH RECORD FAC 0;1 POINTER TO LOCATION FILE (#999 9999.06) INPUT TRANSFORM: S DINUM=X LAST EDITED: MAR 7, 1991 HELP-PROMPT: ENTER NAME OF FACILITY ASSOCIATED WITH THE HEALTH RECORD NUMBER YOU WISH TO ENTER. DESCRIPTION: This field is a pointer to the LOCATION file. The internal pointer is forced into the third subscript for the 9000001.41 subfile. This allows easy lookup by health record number for the logged on location (facility). The complete subscript for 9000001.41 will be (DFN,41,facility pointer,0). TECHNICAL DESCR: In the VA, the Kernel Site Parameters DEFAULT INSTITUTION field is used to populate this field. This was used instead of the users institution because of regional users ability to add patients to the VA. SOURCE OF DATA: 015/HRSUBR NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAM MER 9000001.41,.02 HEALTH RECORD NO. 0;2 FREE TEXT (Required) INPUT TRANSFORM: I $G(DUZ("AG"))="I" K:(X'?1.6N&(X'?1"T" 5N))!(X?1.6N&(X'=+X)) X LAST EDITED: MAY 24, 1988 HELP-PROMPT: ENTER TEXT FROM 1 TO 10 CHARACTERS. DESCRIPTION: This field is used to represent the health record number related to a facility. IHS uses a 6 character whole number. VA uses the patient SSN from the Patient File (2). TECHNICAL DESCR: In the VA, this field is populated by the PX09 cross-reference on the SSN (.09) field of the Patient File (2). SOURCE OF DATA: 015/HRNUMB NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAM MER CROSS-REFERENCE: 9000001^D 1)= S ^AUPNPAT("D",$E(X,1,30),DA(1),DA) ="" 2)= K ^AUPNPAT("D",$E(X,1,30),DA(1),DA) 9000001.41,.03 DATE INACTIVATED/DELETED 0;3 DATE INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X DESCRIPTION: This is date that the patients entry was inactivated. TECHNICAL DESCR: This is primarily used by IHS facilities for tracking patients. The VA currently is not maintaining this field. 9000001.41,.05 RECORD STATUS 0;5 SET 'D' FOR DELETED; 'I' FOR INACTIVATED; 'M' FOR MERGED; LAST EDITED: APR 19, 1990 HELP-PROMPT: Enter "D" if the record has been deleted. DESCRIPTION: This field is used by the IHS Multi-Facility Integration (MFI) package to determine whether to stop integrating data at a facility for a particular patient and location facility. 9000001.41,.06 STOP INTEGRATION 0;6 SET '0' FOR NO; '1' FOR YES; LAST EDITED: AUG 17, 1988 DESCRIPTION: This field is used by the Mult-Facility Integration (MFI) package, created by IHS, to indicate this patients data should no longer be integrated by MFI. FILES POINTED TO FIELDS LOCATION (#9999999.06) HEALTH RECORD NO.:HEALTH RECORD FAC (#.01) PATIENT (#2) NAME (#.01) =========================================================================== The following are two captures, one of the global map of the Patient File BEFORE VA changes, and the second is the Standard attribute list for the Health Record multiple. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GLOBAL MAP DATA DICTIONARY #9000001 -- PATIENT FILE 05/26/94 PAGE 1 STORED IN ^AUPNPAT( (1 ENTRY) SITE: SALT LAKE CITY UCI: PCC,PCC ------------------------------------------------------------------------- This file is the primary patient data file. The NAME (.01) field of this file is a backward pointer to the VA's patient file (#2). Fields in common between the two dictionaries actually exist only in the VA patient file and are referenced by the IHS patient file as computed fields. All other files containing patient data have backward pointers linking them to this file. The linkage is by patient name and the internal FileMan gener- ated number of the ancillary file is the same number used in this file. All applications developed for the RPMS which require patient data will point to this file. CROSS REFERENCED BY: CURRENT COMMUNITY(AC), CLASSIFICATION/BENEFICIARY(AD), DATE ESTABLISHED(ADTE), TRIBE OF MEMBERSHIP(AE), EMPLOYER NAME(AF), SPOUSE'S EMPLOYER NAME(AG), TRIBE QUANTUM(AZ1), INDIAN BLOOD QUANTUM(AZ2), PCIS ID NO.(AZZ), NAME(B), HEALTH RECORD NO.(D) ^AUPNPAT(D0,0)= (#.01) NAME [1P] ^ (#.02) DATE ESTABLISHED [2D] ^ ==>(#.03) DATE OF LAST REG. UPDATE [3D] ^ (#.04) OUTPT ==>MED/RR RELEASE DATE [4D] ^ (#.05) MED/RR RELEASE ==>REVOKED DATE [5D] ^ (#.06) PCIS ID NO. [6F] ^ (#.07) ==>TRIBAL ENROLLMENT NO. [7F] ^ (#.08) MFI MEDICAL [8S] ^ ==>(#.09) CHS TRIBAL AFFILIATION [9P] ^ ^ (#.11) ==>ESTABLISHING USER [11P] ^ (#.12) USER-LAST UPDATE [12P] ==>^ (#.13) BLOOD TYPE [13S] ^ (#.14) PRIMARY PROVIDER ==>[14P] ^ (#.15) CHS TX DATE [15D] ^ (#.16) DATE OF LAST ==>UPDATE [16D] ^ (#.17) ASSIGN BENEFITS OBTAINED DATE ==>[17D] ^ (#.18) ASSIGN BENEFITS EXPIRED DATE [18D] ^ ==>(#.19) EMPLOYER NAME [19P] ^ ^ (#.21) EMPLOYMENT ==>STATUS [21S] ^ (#.22) SPOUSE'S EMPLOYER NAME [22P] ^ ==>(#.23) SSN VERIFICATION STATUS [23P] ^ (#.24) REASON ==>FOR NO SSN [24S] ^ ^AUPNPAT(D0,3)= (#.31) PRINTABLE NAME [1F] ^ ^AUPNPAT(D0,11)= ^ ^ ^ ^ (#1105) BIRTH CERTIFICATE NO. [5F] ^ ^ ^ ==>(#1108) TRIBE OF MEMBERSHIP [8P] ^ (#1109) TRIBE ==>QUANTUM [9F] ^ (#1110) INDIAN BLOOD QUANTUM [10F] ^ ==>(#1111) CLASSIFICATION/BENEFICIARY [11P] ^ (#1112) ==>ELIGIBILITY STATUS [12S] ^ ^ (#1114) UNDERLYING CAUSE ==>OF DEATH [14P] ^ (#1115) STATE OF DEATH [15P] ^ ==>(#1116) DEATH CERTIFICATE NO. [16F] ^ ^ (#1118) ==>CURRENT COMMUNITY [18F] ^ (#1119) TRIBE MEMBERSHIP ==>VERIFIED FLAG [19S] ^ ^ (#1121) RESIDENCE VERIFIED ==>FLAG [21S] ^ (#1122) PREV HSDA RES (VER) FLAG [22S] ^ ==>(#1123) DATE ELIGIBILITY DETERMINED [23D] ^ (#1124) ==>BIC ELIGIBILITY STATUS [24P] ^ (#1125) ELIGIBILE MINOR ==>CHILD [25S] ^ (#1126) BIC PRINTED FLAG [26S] ^ (#1127) ==>PRE-BIC TRIBE [27P] ^ ^AUPNPAT(D0,12,0)=^9000001.12^^ (#1201) LOCATION OF HOME ^AUPNPAT(D0,12,D1,0)= (#.01) LOCATION OF HOME [1W] ^ ^AUPNPAT(D0,13,0)=^9000001.13^^ (#1301) ADDITIONAL REGISTRATION INFO ^AUPNPAT(D0,13,D1,0)= (#.01) ADDITIONAL REGISTRATION INFO [1W] ^ ^AUPNPAT(D0,14,0)=^9000001.14^^ (#1401) REMARKS ^AUPNPAT(D0,14,D1,0)= (#.01) REMARKS [1W] ^ ^AUPNPAT(D0,15,0)=^9000001.15^^ (#1501) ALERTS ^AUPNPAT(D0,15,D1,0)= (#.01) ALERTS [1W] ^ ^AUPNPAT(D0,26)= ^ (#2602) FATHER'S CITY OF BIRTH [2F] ^ (#2603) ==>FATHER'S STATE OF BIRTH [3P] ^ ^ (#2605) MOTHER'S ==>CITY OF BIRTH [5F] ^ (#2606) MOTHER'S STATE OF BIRTH ==>[6P] ^ ^AUPNPAT(D0,28)= ^ (#2802) NOK RELATIONSHIP [2P] ^ ^AUPNPAT(D0,31)= ^ (#3102) EC RELATIONSHIP [2P] ^ ^AUPNPAT(D0,41,0)=^9000001.41IP^^ (#4101) HEALTH RECORD NO. ^AUPNPAT(D0,41,D1,0)= (#.01) HEALTH RECORD FAC [1P] ^ (#.02) HEALTH ==>RECORD NO. [2F] ^ (#.03) DATE INACTIVATED/DELETED ==>[3D] ^ (#.04) RECORD DISPOSITION [4P] ^ (#.05) ==>RECORD STATUS [5S] ^ (#.06) STOP INTEGRATION [6S] ==>^ ^AUPNPAT(D0,43,0)=^9000001.43P^^ (#4301) OTHER TRIBE ^AUPNPAT(D0,43,D1,0)= (#.01) OTHER TRIBE [1P] ^ (#.02) QUANTUM [2F] ^ ^AUPNPAT(D0,51,0)=^9000001.51D^^ (#5101) PREVIOUS COMMUNITY ^AUPNPAT(D0,51,D1,0)= (#.01) DATE MOVED [1D] ^ (#.02) DATE ADDED TO ==>FILE [2D] ^ (#.03) COMMUNITY OF RESIDENCE [3P] ^ ^AUPNPAT(D0,61,0)=^9000001.61P^^ (#6101) MFI SITE ^AUPNPAT(D0,61,D1,0)= (#.01) MFI SITE [1P] ^ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The following is a standard list file attributes for the Health Record multiple BEFORE VA changes: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ STANDARD DATA DICTIONARY #9000001.41 -- HEALTH RECORD NO. SUB-FILE 05/26 /94 PAGE 1 STORED IN ^AUPNPAT( (1 ENTRY) SITE: SALT LAKE CITY UCI: PCC,PCC DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE ------------------------------------------------------------------------- IDENTIFIED BY: HEALTH RECORD NO. (#.02) 9000001.41,.01HEALTH RECORD FAC 0;1 POINTER TO LOCATION FILE (#99999 99.06) INPUT TRANSFORM: S DINUM=X LAST EDITED: MAR 7, 1991 HELP-PROMPT: ENTER NAME OF FACILITY ASSOCIATED WITH THE HEALTH RECORD NUMBER YOU WISH TO ENTER. DESCRIPTION: This field is a pointer to the FACILITY file. The internal pointer is forced into the third subscript for the 9000001.41 subfile. This allows easy lookup by health record number for the logged on facility. The complete subscript for 9000001.41 will be (DFN,41,facility pointer,0). SOURCE OF DATA: 015/HRSUBR NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMME 9000001.41,.02HEALTH RECORD NO. 0;2 FREE TEXT (Required) INPUT TRANSFORM: K:(X'?1.9N&(X'?1"T"5N))!(X?1.9N&(X'=+X)) X LAST EDITED: APR 6, 1994 HELP-PROMPT: ENTER A WHOLE NUMBER BETWEEN 1 AND 999999 SOURCE OF DATA: 015/HRNUMB NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMME CROSS-REFERENCE: 9000001^D 1)= S ^AUPNPAT("D",$E(X,1,30),DA(1),DA)=" " 2)= K ^AUPNPAT("D",$E(X,1,30),DA(1),DA) 9000001.41,.0299TERMINAL DIGITS ; COMPUTED MUMPS CODE: X ^DD(9000001.41,.0299,9.4) S X=$E(Y(9000 001.41,.0299,5),Y(9000001.41,.0299,6),X) S Y=+X,X=Y(9000001.41,.0299,4),X=X_Y 9.2 = S Y(9000001.41,.0299,1)=$S($D(^AUPN PAT(D0,41,D1,0)):^(0),1:"") S X=$P(Y(9000 001.41,.0299,1),U,2)+1000000,Y(9000001.41 ,.0299,2)=X S X=6 9.3 = X ^DD(9000001.41,.0299,9.2) S Y(900 0001.41,.0299,3)=X S X=7,X=$E(Y(9000001.4 1,.0299,2),Y(9000001.41,.0299,3),X)_"-",Y (9000001.41,.0299,4)=X 9.4 = X ^DD(9000001.41,.0299,9.3) S X=$P( Y(9000001.41,.0299,1),U,2)+1000000,Y(9000 001.41,.0299,5)=X S X=2,Y(9000001.41,.029 9,6)=X S X=7 9.5 = X ^DD(9000001.41,.0299,9.4) S Y(900 0001.41,.0299,7)=X S X=$P(Y(9000001.41,.0 299,3),U,2)+1000000,Y(9000001.41,.0299,8) =X S X=2,Y(9000001.41,.0299,9)=X S X=5 ALGORITHM: $E(#.02+1000000,6,7)_"-"_+$E(#.02+1000000 ,2,7) LAST EDITED: JUN 23, 1986 9000001.41,.03DATE INACTIVATED/DELETED 0;3 DATE INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X 9000001.41,.04RECORD DISPOSITION 0;4 POINTER TO PATIENT RECORD DISPOS ITION FILE (#9999999.02) LAST EDITED: DEC 10, 1985 9000001.41,.05RECORD STATUS 0;5 SET 'D' FOR DELETED; 'I' FOR INACTIVATED; 'M' FOR MERGED; LAST EDITED: APR 19, 1990 HELP-PROMPT: Enter "D" if the record has been deleted. 9000001.41,.06STOP INTEGRATION 0;6 SET '0' FOR NO; '1' FOR YES; LAST EDITED: AUG 17, 1988 FILES POINTED TO FIELDS LOCATION (#9999999.06) HEALTH RECORD FAC (#.01) PATIENT RECORD DISPOSITION (#9999999.02) RECORD DISPOSITION (#.04) ^AUPNPAT(D0,0) .01 NAME 0;1 Direct Global R/W & w/ ^AUPNPAT(D0,12,0) 1201 LOCATION OF HOME Both R/W w/Fileman ^AUPNPAT(D0,41,0) 4101 HEALTH RECORD NO. Direct Global R/W & w/ ^AUPNPAT(D0,41,D1,0) .01 HEALTH RECORD FAC 0;1 Direct Global R/W & w/ This is the institution using the Health Record No. in field .02. The DEFAULT INSTITUTION in the Kernel Site parameter file is forced into this field when a Patient is added to File 2. ROUTINE: ******************** 898 NAME: DBIA898 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER This DBIA agreement allows the Patient/IHS Subset to distribute the AUPNPAT routine in the VA. USAGE: Private ENTERED: SEP 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PCE Patient/IHS Subset package (namespaced PXPT) requests a DBIA with the Indian Health Service to distribute the AUPNPAT routine with the PXPT package. The PXPT package will distribute it as PXPTNPAT and use ZOSF to load and save the routine as AUPNPAT. There have been no coding changes to the AUPNPAT code by the VA. This is the same version that is at Tucson VAMC running as of September 4, 1994. This routine is defined in the POST-SELECTION ACTION field of the PATIENT/IHS file distributed with the PXPT package. AUPNPAT ; IHS/OHPRD/EDE - POST SELECTION SETS FOR PATIENT LOOKUP ; 24-MAY-1993 ;;93.2;IHS PATIENT DICTIONARIES.;;JUL 01, 1993 ; ; This routine sets standard patient variables ; START ; S:$D(X) AUPNPATX=X S AUPNPAT=+Y S AUPNSEX=$P(^DPT(AUPNPAT,0),U,2),AUPNDOB=$P(^(0),U,3),AUPNDOD="" S:$D(^(.35)) AUPNDOD=$P(^(.35),U,1) S X2=AUPNDOB,X1=$S('AUPNDOD:DT,AUPNDOD:AUPNDOD,1:DT) D ^%DTC S AUPNDAYS=X K X,X1,X2 S:$D(AUPNPATX) X=AUPNPATX K %T,%Y,AUPNPATX Q ; KILL ; KILL VARIABLES SET BY THIS ROUTINE K AUPNPAT,AUPNSEX,AUPNDOB,AUPNDOD,AUPNDAYS Q The following routine (PXPTNPAT) is a PXPT version of AUPNPAT that is being distributed to the field. When the ZOSF("SAVE") is completed, the AUPNPAT routine will appear as displayed above. PXPTNPAT ; SLC/DLT - Post selection sets for Patient Lookup EXPORT ;1/22/ 94 21:03 ;;1.0V1;PCE PATIENT/IHS SUBSET (PXPT);;Sept 7, 1994 AUPNPAT ; IHS/OHPRD/EDE - POST SELECTION SETS FOR PATIENT LOOKUP ; 24-MAY-1993 ;;93.2;IHS PATIENT DICTIONARIES.;;JUL 01, 1993 ; ; This routine sets standard patient variables ; START ; S:$D(X) AUPNPATX=X S AUPNPAT=+Y S AUPNSEX=$P(^DPT(AUPNPAT,0),U,2),AUPNDOB=$P(^(0),U,3),AUPNDOD="" S:$D(^(.35)) AUPNDOD=$P(^(.35),U,1) S X2=AUPNDOB,X1=$S('AUPNDOD:DT,AUPNDOD:AUPNDOD,1:DT) D ^%DTC S AUPNDAYS=X K X,X1,X2 S:$D(AUPNPATX) X=AUPNPATX K %T,%Y,AUPNPATX Q ; KILL ; KILL VARIABLES SET BY THIS ROUTINE K AUPNPAT,AUPNSEX,AUPNDOB,AUPNDOD,AUPNDAYS Q ROUTINE: AUPNPAT ******************** 900 NAME: PSIVACT CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: SURGERY USAGE: Controlled Subscri ENTERED: JUN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Provides the subscribing package the ability to discontinue all of a patient's IV orders. ROUTINE: PSIVACT COMPONENT: DCOR VARIABLES: DFN Type: Input Internal entry number of the patient in the PATIENT file (2) for which orders are to be discontinued. The variable is not killed by this entry point. Provides the subscribing package the ability to discontinue all of a patient's IV orders. ******************** 901 NAME: PSSJEEU CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING LAB SERVICE USAGE: Controlled Subscri ENTERED: JUN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a set of utilities that can be used to create, validate and process order timing schedules. ROUTINE: PSSJEEU COMPONENT: ENSE VARIABLES: PSJPP Type: Input This is the package prefix as found in the PACKAGE file (9.4). PSJSHLS Type: Input This is executable code that sets $T to be used to screen Hospital Locations when editing schedules and shifts. If PSJSHLS exists, DIC("S") is set to PSJSHLS. The scheduler will not try to validate PSJSHLS. Allows the editing of the ADMINISTRATION SCHEDULE file (51.1). COMPONENT: ENSHE VARIABLES: PSJPP Type: Input This is the package prefix as found in the PACKAGE file (9.4). PSJSHLS Type: Input This is executable code that sets $T to be used to screen Hospital Locations when editing schedules and shifts. If PSJSHLS exists, DIC("S") is set to PSJSHLS. The scheduler will not try to validate PSJSHLS. Allows the editing of the ADMINISTRATION SHIFT file (51.15). COMPONENT: ENSVI VARIABLES: PSJPP Type: Input This is the package prefix as found in the PACKAGE file (9.4). PSJX Type: Input This is the schdule to be viewed. If only the first few characters of the schedule name is entered, the user will be asked to select from all schedules in the ADMINISTRATION SCHEDULE file (51.1) beginning with these characters. If a valid schedule is selected, information pertaining to the schedule will be displayed. View standard schedule information. COMPONENT: ENSV VARIABLES: PSJX Type: Both This is the schdule to be validated. If only the first few characters of the schedule name is entered, the user will be asked to select from all schedules in the ADMINISTRATION SCHEDULE file (51.1) beginning with these characters. If a valid schedule is selected, it's name will will be returned in PSJX. If a valid schedule is not selected, PSJX will be killed. PSJPP Type: Input This is the package prefix as found in the PACKAGE file (9.4). PSJM Type: Output This is the frequency in minutes that the action is to be taken. This will be null if PSGX is invalid. PSJAT Type: Output These are the administration times or shifts that are associated with the selected schedule. This will be null if PSGX is invalid. PSJY Type: Output This is a pointer to the ADMINISTRATION SCHEDULE file (51.1) if PSJX is found in the file. This will be null if PSJX is invalid or not found. PSJTS Type: Output This is a code representing the type of schedule. This will be null if the schedule is invalid. PSJAX Type: Output This is the maximum days continuous orders last for the selected schedule, or null if not found. PSJW Type: Input This is a pointer to the HOSPITAL LOCATION file (44). This is an optional variable that may be used to determine the administration times or shifts by location. PSJNE Type: Input If this optional variable is defined, there is no dialogue with the user. Validates a schedule and gives the administration times or shifts and frequency (in minutes) of the schedule. COMPONENT: ENATV VARIABLES: X Type: Both This contains the administration times to be validated. X will be killed if the administration times are invalid. Validates administration times. This may be used in an input transform. COMPONENT: ENSHV VARIABLES: X Type: Both This should be set to the administration shift to be validated. If the administration shift passed in X is invalid, X will be killed. Validates shifts. If the shift passed in X is invalid X will be killed. COMPONENT: ENSPU VARIABLES: PSJSCH Type: Input This is the schedule to be processed. PSJM Type: Input This is the frequency (in minutes) that an action is to take place. Used for continuous and range schedules. PSJAT Type: Input This is either a set of administration times or shifts, depending on the type of schedule. If it is administration times, it will be similar to: PSJAT="04-08-12-16-20". If it is shifts, it will be similar to: PSJAT="M-E",PSJAT("M")="05-11",PSJAT("E")="1 8-22". PSJTS Type: Input This is a code representing the type of schedule defined in PSJSCH. The codes are: C - CONTINUE; D - DAY OF THE WEEK; DR - DAY OF THE WEEK-RANGE; O - ONE-TIME; R - RANGE; and S - SHIFT. PSJSD Type: Input This is the start date/time of the order. PSJFD Type: Input This is the stop date/time of the period where the action is to take place. PSJOSD Type: Input This is the start date/time of the order. If PSJOSD is not found, PSJSD is used. PSJOFD Type: Input This is the stop date/time of the order (action to take place). If PSJOFD is not found, PSJFD is used. PSJC Type: Output This is the number of times (and when) an action is to take place. Calculates the number of times (and when) an action is to take place. COMPONENT: ENDSD VARIABLES: PSJSCH Type: Input This is the name of the schedule to be used in determining the start date/time. PSJAT Type: Input This is either a set of administration times or shifts, depending on the type of schedule. If it is administration times, it will be similar to: PSJAT="04-08-12-16-20". If it is shifts, it will be similar to: PSJAT="M-E",PSJAT("M")="05-11",PSJAT("E")="1 8-22". PSJTS Type: Input This is a code representing the type of schedule defined in PSJSCH. The codes are: C - CONTINUE; D - DAY OF THE WEEK; DR - DAY OF THE WEEK-RANGE; O - ONE-TIME; R - RANGE; and S - SHIFT. PSJX Type: Output This will be returned as either a date/time in VA FileMan interal format, or null if the start date/time cannot be calculated. Provides a date/time that might be used as a default value for the start date of an order. ******************** 902 NAME: PSJSV0 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: USAGE: Controlled Subscri ENTERED: JUN 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This displays help text for use when validating a schedule. This may be used as the executable help for a field. ROUTINE: PSJSV0 COMPONENT: ENSVH VARIABLES: X Type: Input Set to 1 or more "?" for help. This is supplied by VA FileMan if used as executable help. Help text for use when validating a schedule. ******************** 905 NAME: DBIA905 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary routine GMTSALG requires access to several fields in PATIENT ALLERGIES FILE #120.8 that are not available from the allergy API's contained in ^GMRADPT. ORDER ENTRY/RESULTS REPORTING OE/RR requires access to several fields in the PATIENT ALLERGIES FILE #120.8 that are not available from the allergy API's contained in ^GMRADPT. DIQ API calls are used to get the data. NATIONAL DRUG FILE CLINICAL REMINDERS added Feb 29 2008 USAGE: Controlled Subscri ENTERED: JUL 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8, DESCRIPTION: TYPE: File This DBIA grants access to specific fields in the PATIENT ALLERGIES FILE (120.8). ^GMR(120.8,D0,0) 6 OBSERVED/HISTORICAL 0;6 Direct Global Read & w 4 ORIGINATION DATE/TIM 0;4 Direct Global Read & w 5 ORIGINATOR 0;5 Direct Global Read & w 26 COMMENTS 26;0 Direct Global Read & w This is a multiple. Health Summary will use the .01 field under subfile 120.8262, field number 2, location 2;0. Read w/Fileman 19 VERIFIED 0;16 Direct Global Read & w 21 VERIFIER 0;18 Direct Global Read & w .02 REACTANT 0;2 Read w/Fileman 3.1 ALLERGY TYPE 0;20 Read w/Fileman 20 VERIFICATION DATE/TI 0;17 Read w/Fileman 15 ORIGINATOR SIGN OFF 0;12 Read w/Fileman ^GMR(120.8,D0,26,D1,0) .01 DATE/TIME COMMENT EN 0;1 Read w/Fileman 1 USER ENTERING 0;2 Read w/Fileman 1.5 COMMENT TYPE 0;3 Read w/Fileman ^GMR(120.8,D0,26,D1,2,D2,0) .01 COMMENTS 0;1 Read w/Fileman ^GMR(120.8,"AODT", This x-ref may be used in a direct global read. ^GMR(120.8,"API", Direct global read access approved. ^GMR(120.8,"APC", Direct global read access approved. ROUTINE: ?" ******************** 907 NAME: AUPNVSIT CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS EMERGENCY DEPARTMENT ADDED 10/10/2008 WOMEN'S HEALTH USAGE: Controlled Subscri ENTERED: JUL 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Update dependent entry counter ------------------------------ Note: These calls are customarily done via a MUMPS cross reference on the pointer field. ROUTINE: AUPNVSIT COMPONENT: ADD VARIABLES: X Type: Input "X" equals the Internal Entry Number of the Visit. Increase the dependent entry count by one. COMPONENT: SUB VARIABLES: X Type: Input "X" equals the Internal Entry Number of the Visit. Decrease the dependent entry count by one. ******************** 909 NAME: DBIA909-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File The laboratory LMIP reports require that workload data be collected based on Facility Treating Specialty #45.7 and Specialty #42.4. We determine this information by looking at the ordering location. We are asking permission to read the these files to obtain .01 field and the field #6 CDR ACCOUNT field for certain reports. The logic uses the ^SC(X,42) to determine if the location is a ward. If it is the n use the Facility Treating specialty pointers to navigate to the data. See DBIA909-B & DBIA909-C ^DIC(45.7,N,0) .01 NAME 0;1 Direct Global Read & w Retrieve Facility Treating Specialty Name ROUTINE: ******************** 913 NAME: DBIA913 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: JUL 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 21 ROOT: DIC(21 DESCRIPTION: TYPE: File ^DIC(21, .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 915 NAME: DBIA915 CUSTODIAL PACKAGE: SOCIAL WORK SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: AUG 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Health Summary requests the ability to execute the ^SOWKHSUM routine. Health Summary will have a patient DFN defined as the variable DFN upon calling ^SOWKHSUM. ^SOWKHSUM will output the ^TMP("SOWK",$J,line number) array which will include the Source of Referral, Source of Information, the Social/Family Relationship segment, The Current Substance Problems segment and the Psycho-Social Assessment segment. These segments will be formated like their display in the Social Work Service Reports with the exception that they will not be prefaced with a Roman Numeral. Health Summary will export this routine in the GMTS name space and if it doesn't exist when Health Summary is installed, the routine will be renamed to the SOWK name space. ROUTINE: SOWKHSUM COMPONENT: SOWKHSUM VARIABLES: DFN Type: Input Patient DFN from the patient file. TMP("SOWK" Type: Output The global array ^TMP("SOWK",$J,Line #) will return the formated Social Work Service Data. ******************** 916 NAME: DBIA916 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE For duration of Lab Version 5.2: Blood Bank and Anatomic Pathology namespaced routines refer to ^DIC(FILE_NO.,0,"GL") to locate global nodes for data. INCOME VERIFICATION MATCH IVM stores a pointer to the FILE (#1) file in order to reference multiple files for storing data. We are requesting permission to make a direct reference to ^DIC(FILE_NO.,0,"GL") to find the global root for that file. NURSING SERVICE Nursing is granted READ access to ^DIC(file_number,0,"GL") in order to get the global root of a file. File_number is in the nursing package namespace. LEXICON UTILITY Read only access for ^DIC(FN,0,"GL"), where FN is a file number, to verify the value of DIC prior to initiating the lookup (GMPTA4). POLICE & SECURITY DICRW+5^ESPFM, the reference to ^DIC(+Y,0,"GL") ORDER ENTRY/RESULTS REPORTING CONSULT/REQUEST TRACKING Read only access for ^DIC(FN,0,"GL"), where FN is a file number, to determine the global root for a file. USAGE: Controlled Subscri ENTERED: JUL 25,1994 STATUS: Active EXPIRES: DURATION: VERSION: Fileman 20 FILE: ROOT: DIC( DESCRIPTION: TYPE: File The current packages subscribing to this IA are expected to migrate to use DID calls. NO NEW FUTURE SUBSCRIBERS WILL BE ADDED. ^DIC(FILE_NO.,0,"GL") 1 GLOBAL NAME Direct Global Read & w A direct global read is performed on this node to determine the global root for a file. ROUTINE: ******************** 918 NAME: DBIA918 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 26,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Read only access for the ^DPT( global to obtain Period of Service and POW information. Read ^DPT(dfn,.52) to obtain POW information. Read ^DPT(dfn,.32) to obtain Period of Service information. ^DPT( .525 POW STATUS INDICATED .52;5 Direct Global Read & w .526 POW CONFINEMENT LOCA .52;6 Direct Global Read & w .323 PERIOD OF SERVICE .32;3 Direct Global Read & w .32201 PERSIAN GULF SERVICE .322;10 Direct Global Read & w ROUTINE: ******************** 921 NAME: DBIA921 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 27,1994 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. Read only access for the ^PS(52.6,X,0) node. In routines LRBLPE1 and LRBLPH: ...I $D(^PS(52.6,X,0)...W !,"IV DRUG: ",$P(^(0),"^") ^PS(52.6,x,0) .01 PRINT NAME 0;1 Direct Global Read & w ROUTINE: ******************** 923 NAME: DBIA923 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7 DESCRIPTION: TYPE: File The following fields are accessed in a read-only manner: ^DIC( 40.7 STOP CODE file 1 AMIS REPORTING STOP CODE In routines LRCAPPH line LRCAPPH+8 SDC S SDC=$S($P(^("NITE"),U,3):$G(^DIC(40.7,+$P(^LAB(69.9,1,"NITE"), U,3),0)),1:"") S LRSDC=$S($P(SDC,U,2):+$P(SDC,U,2),1:108) LRSTOPC line LRSTOPC+3 S LRSDC=$S(+$P($G(^DIC(40.7,+$P($G(^LAB(69.9,1,"NITE")),U,3),0)),U,2): $P(^(0),U,2),1:108),CNT=0,LREND=0 Routine LRSTOPC manually records clinic stop codes for Lab. Routine LRCAPPH automatically records clinic stop codes for Lab. ROUTINE: ******************** 924 NAME: DBIA924 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 11 ROOT: DIC(11, DESCRIPTION: TYPE: File Read only access for the ^DIC(11, global. In routine LRMIHDR line LRMIHDR+22: I LRMARST S LRMARST=$S($D(^DIC(11,LRMARST,0)):$P(^(0),U),1:"") LAB SERVICE will also use MARITAL STATUS fields in Fileman sort and print templates. ^DIC(11,D0,0) .01 NAME 0;1 Direct Global Read & w .02 ABBREVIATION 0;2 Direct Global Read & w ROUTINE: ******************** 925 NAME: DBIA925 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 10 ROOT: DIC(10, DESCRIPTION: TYPE: File Read only access to the ^DIC(10, global. In routine LRMIHDR line LRMIHDR+21: I LRRACE S LRRACE=$S($D(^DIC(10,LRRACE,0)):$P(^(0),U),1:"") LAB SERVICE will use the NAME (#.01), HL7 VALUE (#3) and INACTIVE (#200) fields in sort and print templates. ^DIC(10,D0,0) .01 NAME 0;1 Direct Global Read & w 3 HL7 VALUE 0;3 Direct Global Read & w ^DIC(10,D0,.02) 200 INACTIVE .02;1 Direct Global Read & w ROUTINE: ******************** 927 NAME: LIST SURGICAL OPERATIONS SCHEDULED CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: AUG 1,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File Read only access for the ^SRF global. Routine LRBLPCSS, blood bank routine, pre-op component selection, checks for pending operations by looping through the "ADT" Date of Operation cross reference then lists operations scheduled. The date, operation procedure, and planned principal procedure code is listed. ^SRF('ADT',dfn,x,a) .09 DATE OF OPERATION 0;9 Direct Global Read & w Loop through this cross-reference to list operations scheduled. ^SRF(DO,'OP') Direct Read Access to print operation procedure and code. ROUTINE: ******************** 928 NAME: DBIA928 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES CLINICAL CASE REGISTRIES VA CERTIFIED COMPONENTS - DSSI ONCOLOGY IMAGING USAGE: Controlled Subscri ENTERED: AUG 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement is to post the routine GMPLUTL as a supported reference by controlled subscription. There are 3 entry points to return currently active problems, add a new problem, or update an existing problem. ROUTINE: GMPLUTL COMPONENT: ACTIVE(DFN,.PROBLEM) VARIABLES: DFN Type: Input IEN of patient in file #2 PROBLEM Type: Output Array which must be passed in by reference; returned with the following set: PROBLEM(0) = Total number of problems returned PROBLEM(#,0) = Problem file IEN PROBLEM(#,1) = internal^external values of problem description in the Lexicon Utility; note that external value may be a provider modification of the Lexicon Utility's text PROBLEM(#,2) = internal^external values of assigned ICD Diagnosis code PROBLEM(#,3) = internal^external values of Date of Onset PROBLEM(#,4) = abbreviated^full text of SC indicator, i.e. SC^SERVICE- CONNECTED, NSC^NOT SERVICE- CONNECTED, or null PROBLEM(#,5) = abbreviated^full text of Exposure indicator, i.e. AO^AGENT ORANGE, IR^RADIATION, EC^ENV CONTAMINANTS, HNC^HEAD AND/OR NECK CANCER, MST^MILITARY SEXUAL TRAUMA CV^COMBAT VET, SHD^SHAD, CLV^CAMP LEJEUNE or null where each # is a sequence number per problem to group the data elements. This entry point will return the specified patient's currently active problems. Two parameters are required to be passed in, the first being the IEN of the patient in file #2, and the second is the array (passed by reference) in which the problems will be returned. COMPONENT: CREATE(.PROBLEM,.RESULT) VARIABLES: PROBLEM Type: Input This array must be passed in by reference containing the following data elements to create a new problem entry: REQUIRED: PROBLEM("PATIENT") = IEN of patient in file #2 PROBLEM("NARRATIVE") = Text of the problem, as described by provider PROBLEM("PROVIDER") = IEN of provider in file #200 OPTIONAL: PROBLEM("DIAGNOSIS") = IEN of ICD Diagnosis code in file #80 PROBLEM("LEXICON") = IEN of problem description in the Lexicon Utility PROBLEM("STATUS") = Status of problem, either A (active) or I (inactive); problem is assumed to be active if not specified PROBLEM("ONSET") = Date of onset, in internal FileMan format PROBLEM("RECORDED") = Date problem was recorded, in internal FileMan format PROBLEM("RESOLVED") = Date problem was resolved, in internal FileMan format PROBLEM("COMMENT") = Up to 60 characters of additional text PROBLEM("LOCATION") = IEN of Hospital Location (clinic) in file #44 PROBLEM("SC") = 1 or 0, if problem is related to SC condition PROBLEM("AO") = 1 or 0, if problem is related to Agent Orange exp. PROBLEM("IR") = 1 or 0, if problem is related to Radiation exp. PROBLEM("EC") = 1 or 0, if problem is related to Environmental Contaminants (i.e. Persian Gulf) PROBLEM("HNC") = 1 or 0, if problem is related to Head and/or Neck Cancer PROBLEM("MST") = 1 or 0, if problem is related to Military Sexual Trauma PROBLEM("CV") = 1 or 0, if problem is related to Combat Veteran status PROBLEM("SHD") = 1 or 0, if problem is related to Shipboard Hazard and Defense (SHAD) PROBLEM("CLV") = 1 or 0, if problem is related to Camp Lejeune PROBLEM("DX_DATE_OF_INTEREST") = Date of the patient's encounter or current date if historical encounter or if none defined. RESULT Type: Output Array which must be passed in by reference; returned with the following set: RESULT = IEN of new problem entry in Problem file #9000011, or -1 if unsuccessful RESULT(0) = Error message if unsuccessful, otherwise null DUZ Type: Used The values in the DUZ array are referenced in this routine; if tasked, the variables DUZ, DUZ(2), and DUZ("AG") must be set into the ZTSAVE array. OUTPUT Type: This entry point will create a new problem entry based upon the values passed in the PROBLEM array. The RESULT array will be used to return the results of the call; if successful, RESULT will contain the new IEN, otherwise it will be set to -1 and RESULT(0) will contain an error message. COMPONENT: UPDATE(.PROBLEM,.RESULT) VARIABLES: PROBLEM Type: Input This array must be passed in by reference containing the following data elements to update an existing problem; only the items to be changed need to be set, as a null value will be assumed to mean "no change" and "@" to delete the current value: REQUIRED: PROBLEM("PROBLEM") = IEN of problem in file #9000011 PROBLEM("PROVIDER") = IEN of provider in file #200 OPTIONAL: PROBLEM("NARRATIVE") = Text of the problem, as described by provider PROBLEM("DIAGNOSIS") = IEN of ICD Diagnosis code in file #80 PROBLEM("LEXICON") = IEN of problem description in the Lexicon Utility PROBLEM("STATUS") = Status of problem, either A (active) or I (inactive) PROBLEM("ONSET") = Date of onset, in internal FileMan format PROBLEM("RECORDED") = Date problem was recorded, in internal FileMan format PROBLEM("RESOLVED") = Date problem was resolved, in internal FileMan format PROBLEM("COMMENT") = Up to 60 characters of additional text PROBLEM("LOCATION") = IEN of Hospital Location (clinic) in file #44 PROBLEM("SC") = 1 or 0, if problem is related to SC condition PROBLEM("AO") = 1 or 0, if problem is related to Agent Orange exp. PROBLEM("IR") = 1 or 0, if problem is related to Radiation exp. PROBLEM("EC") = 1 or 0, if problem is related to Environmental Contaminants (i.e. Persian Gulf) PROBLEM("HNC") = 1 or 0, if problem is related to Head and/or Neck Cancer PROBLEM("MST") = 1 or 0, if problem is related to Military Sexual Trauma PROBLEM("CV") = 1 or 0, if problem is related to Combat Veteran status PROBLEM("SHD") = 1 or 0, if problem is related to Shipboard Hazard and Defense (SHAD) PROBLEM("CLV") = 1 or 0, if problem is related to Camp Lejeune PROBLEM("DX_DATE_OF_INTEREST") = Date of the patient's encounter or current date if historical encounter or if none defined. PROBLEM("SCTC") = SNOMED CT Concept Code PROBLEM("SCTD") = SNOMED CT Designation Code PROBLEM("CODEDT") = Date of interest for the primary ICD Diagnosis PROBLEM("CODESYS") = Coding system of the primary ICD Diagnosis DUZ Type: Used The values in the DUZ array are referenced in this routine; if tasked, the variables DUZ, DUZ(2), and DUZ("AG") must be set into the ZTSAVE array. This entry point will update an existing problem based upon the values passed in the PROBLEM array. The RESULT array will be used to return the results of the call; if successful, RESULT will equal the IEN of the problem, otherwise it will be set to -1 and RESULT(0) will contain an error message. ******************** 930 NAME: DBIA930 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: SEP 20,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.2 FILE: 9.4 ROOT: DESCRIPTION: TYPE: File The Laboratory package requests agreement from the VA FileMan package to edit the Package file (9.4) during the init process for Laboratory Version 5.2. There are two sets of inits distributed with Lab V 5.2. The LR inits are the primary inits for the release. The LA inits are for the Automated Instruments part of the release. The LA inits are only run when the site is installing this version in a virgin account. There are directions in the installation guide telling the site NOT to run the inits if they overlaying version 5.2 over version 5.1. The Package file entry for Automated Instruments needs to be updated to version 5.2, but because the inits are not run, the Package file will not get updated. We request permission to use ^DIE and ^DICN to update the following fields in the AUTOMATED LAB INSTRUMENTS entry in the PACKAGE file. VERSION (field #22, add a multiple entry) VERSION (field #.01, sub field of #22) DATE DISTRIBUTED (field #1, sub field of #22) DATE INSTALLED AT THIS SITE (field #2, sub field of #22) CURRENT VERSION (field #13) This is a one-time request for this release of Laboratory Version 5.2. ROUTINE: ******************** 932 NAME: DBIA932 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2, DESCRIPTION: TYPE: File Permission to define a field in one of our files as a pointer to the Terminal File. ^%ZIS(2,D0,0) .01 NAME 0;1 Pointed to ROUTINE: ******************** 933 NAME: DBIA933 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: AUG 4,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: %ZISS1 COMPONENT: CHECK VARIABLES: X Type: Both Call CHECK^%ZISS1 from input transforms to check that what is being entered is a valid argument to a WRITE statement for printer control. ******************** 934 NAME: DBIA934 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: AUG 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is for Pharmacy 6.0 and greater. ROUTINE: PSOP COMPONENT: PSOP VARIABLES: PLS Type: Input DFN Type: Input Internal Entry Number of the patient. This entry point(and re-entry point) is the functional Pharmacy Patient profile. This tool is used for acquisition of display only data for use in Rheumatology reports. This supersedes DBIA191-A #191. ******************** 935 NAME: DBIA935 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: AUG 9,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 22 ROOT: DIC(22, DESCRIPTION: TYPE: File In Lab V 5.2 patient POW information is being obtained from inquiries to global locations. Routines LRAPPOW and LRAPDPT reference the global ^DIC(22, . ^DIC(22 .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 936 NAME: XUSESIG CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING ADP PLANNING ASISTS USAGE: Controlled Subscri ENTERED: AUG 11,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine, when called from the top, allows the user to setup a personal electronic signature code. It is used within application code to allow the user immediate 'on-the-fly' access to setup the electronic signature, rather than force the user to leave the application and enter a different option to do the same. ROUTINE: XUSESIG COMPONENT: XUSESIG VARIABLES: ******************** 937 NAME: SEARCH TEMPLATE RESULTS CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 12,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DIBT( DESCRIPTION: TYPE: File ^DIBT(SORT_TEMPLATE#,1,IEN)="" The 1 node indicates that the IEN list was created one of two ways: 1) The user was in FileMan INQUIRE mode, selected a number of records, and saved the list in a template. 2) The user ran the FileMan SEARCH, either through the interactive FileMan menu, or through the programmer entry point EN^DIS. In this case, the IEN list is the record numbers that met the search criteria. IEN - is the internal entry number of a record in the file indicated by the 4th piece of the 0 node of the template, ^DIBT(SORT_TEMPLATE#,0). Read, Write, Delete access allowed. ^DIBT(SORT_TEMPLATE#,1,IEN) ROUTINE: ******************** 938 NAME: DBIA938 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION NURSING SERVICE ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Entry points to use the Health Summary routine GMTSDVR to allow users to print a Health Summary. ROUTINE: GMTSDVR COMPONENT: ENX VARIABLES: DFN Type: Input Passes patient id. GMTSTYP Type: Input Defines the Health Summary report to be printed. GMTSPX2 Type: Input Optional internal FileMan date for beginning date range. GMTSPX1 Type: Input Optional internal FileMan date for ending date range. This entry point allows for direct printing of a Health Summary for a programmer-specified patient and device, without prompting for additional information. This entry point uses parameter passing. The format is ENX^GMTSDVR(DFN,GMTSTYP,GMTSPX2,GMTSPX1). GMTSPX2 and GMTSPX1 are optional date range variables. They allow the time limits to be overridden for components that use time limits. Thus, beginning and ending dates can be specified in order to get only data within that time range. COMPONENT: ENXQ VARIABLES: DFN Type: Input Patient ID. GMTSTYP Type: Input Defines Health Summary to print. GMTSPX1 Type: Input Optional internal FileMan date for ending date range. GMTSPX2 Type: Input Optional internal FileMan date for begining date range. This call is for Queueing the Health Summary. GMTSPX1 and GMTSPX2 are optional date range variables. Both are required if a date range is desired. COMPONENT: SELTYP VARIABLES: GMTYP(0) Type: Output Will be set to 1 if a type is selected and it contains components. GMTYP(1) Type: Output The 1st piece will be set to the internal value of the health summary type. The 2nd piece will be set to the name of the health summary type. This entry point allows for a Health Summary type to be selected from file 142. COMPONENT: MAIN VARIABLES: This entry may be called from an Option with only the usual system variables. ******************** 939 NAME: DBIA939 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION USAGE: Private ENTERED: AUG 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File Used to do a look-up to the Health Summary Type (#142) to select a template. This agreement is tied to DBIA938. ^GMT(142,D0,0) .01 NAME 0;1 Read w/Fileman ^GMT(142,D0) ROUTINE: ******************** 940 NAME: DBIA940 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 772 ROOT: HL(772, DESCRIPTION: TYPE: File The IVM package requests permission to use the HL7 TRANSMISSION (#772) file to find the mailman message number associated with an outgoing HL7 transmission. The purpose of this reference is to use that number to determine if the message is Awaiting Transmission. ^C x-ref The purpose of using the C cross-reference is to find the internal entry number of a specific HL7 outgoing transmission, by using the Message Control ID. The Message Control ID of that transmission is stored in an IVM file. ^HL(772,D0,0) .05 RELATED MAILMAN MESS 0;5 Direct Global Read & w Directly read the field RELATED MAILMAN MESSAGE. The purpose of accessing the associated Mailman message number for an outgoing HL7 transmission is to determine, using a function call to VA MailMan, if that message is Awaiting Transmission. ROUTINE: ******************** 941 NAME: DBIA941 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771.3 ROOT: HL(771.3, DESCRIPTION: TYPE: File The IVM package requests permission to store the pointer to an entry in the HL7 SEGMENT NAME (#771.3) file in an IVM file. Both the pointer and segment name will be stored, in the INCOMING SEGMENT (#.01) and SEGMENT NAME (#.02) fields of the QUERY TRANSMISSION DATE/TIME (#.05) multiple of the IVM PATIENT (#301.5) file, respectively. The pointer to the segment name will be determined using a DIC look-up call. The segment name will be extracted from an HL7 message segment. ROUTINE: ******************** 942 NAME: DBIA942 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The IVM requests permission to perform the following actions during the initialization process of IVM v2.0: 1. Add the following two new segments to the HL7 SEGMENT NAME (#771.3) file: A. ABBREVIATED NAME: ZIR FULL NAME: VA Specific Income Information VERSION: 2.1 B. ABBREVIATED NAME: ZIO FULL NAME: VA Spec. Patient Information VERSION: 2.1 2. Update the 'IVM' entry in the HL7 DHCP APPLICATION PARAMETER (#771) file with: A. New entries in the HL7 MESSAGE (#6) multiple B. New entries in the HL7 SEGMENT (#5) multiple ROUTINE: ******************** 943 NAME: DBIA943 CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IB requests an integration agreement with the IVM package to pass billing and collections information to the IVM package. ROUTINE: IVMUFNC3 COMPONENT: REV(REF,DFN,CLASS... VARIABLES: REF Type: Input Bill reference number from file #350, field #.01 DFN Type: Input Pointer to the patient in file #2 CLASS Type: Input Bill Classification [ 1-Inpt, 2-Opt ] TYPE Type: Input Bill Classification [ 1-Inpt, 2-Opt ] FROM Type: Input Bill From Date in FM format TO Type: Input Bill To Date in FM format AMOUNT Type: Input Amount Billed HOLD Type: Input Charge placed on hold? [ 1-Yes, 0-No ] This entry point is called by the Integrated Billing package. It is used to pass billing information to the IVM package for Means Test charges which were pending review and were passed to the Accounts Receivables module using the option Release Charges 'Pending Review.' COMPONENT: $$CHK(DFN) VARIABLES: DFN Type: Input Pointer to the patient in file #2 OUT Type: Output This function returns a 1 if IVM is monitoring this patient; otherwise a 0 is returned This function is used by the IB package to determine if a specific patient is being monitored for billing and collections activity by the IVM package. ******************** 944 NAME: DBIA944 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM files patient insurance information into DHCP which has been received from the IVM Center. This call is used to identify a group plan for the policy when the policy is being filed. ROUTINE: IBCNSU COMPONENT: $$HIP(I,G,NA,NU) VARIABLES: I Type: Input This variable is a pointer to an Insurance Company in file #36 that is the holder of the group plan. G Type: Input This variable contains a 1 if the plan is a group plan, or a 0 if the plan is an individual plan. NA Type: Input This variable contains the group name of the plan received by the IVM Center. NU Type: Input This variable contains the group number of the paln received by the IVM Center. POL Type: Output This function call returns this output, which is the pointer to a group plan from file #355.3. This pointed-to plan is either an existing plan which was located by the function, or a new plan which was created by the call if a plan could not be found. This call is used to return the pointer in file #355.3 for the group plan, if it exists, or the pointer of a new plan in #355.3 which is created by the call if the plan does not exist. ******************** 945 NAME: DBIA945 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM files patient insurance information into DHCP which has been received from the IVM Center. This call is used to reconcile the field COVERED BY HEALTH INSURANCE? in the PATIENT (#2) file with the information stored in the INSURANCE TYPE multiple after the new policy received from the IVM Center has been filed. ROUTINE: IBCNSM31 COMPONENT: $$COVERED(DFN,COVP) VARIABLES: DFN Type: Input This is a pointer to the patient in file #2. COVP Type: Input This is the value of the field COVERED BY HEALTH INSURANCE? in the PATIENT (#2) file prior to adding the new policy received from the IVM Center. This call is made to correctly set the field COVERED BY HEALTH INSURANCE? in the PATIENT (#2) file after a new policy has been filed through the IVM package. ******************** 946 NAME: DBIA946 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM files patient insurance information into DHCP which has been received from the IVM Center. This routine is used to invoke the IB Insurance Event Driver after a new patient policy which has been received from the IVM Center is filed. ROUTINE: IBCNSEVT COMPONENT: AFTER VARIABLES: IBCDFN Type: Input This variable points to an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTP0 Type: Input This variable contains the zeroth node of the previous value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTA0 Type: Output This variable contains the zeroth node of the new value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTA1 Type: Output This variable contains the 1 node of the new value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTACT Type: Output This variable, defined by IB, describes the action taken (Add/Edit Delete) on an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTA2 Type: Output This variable contains the 2 node of the new value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. This call is made to set up the necessary input variables before calling the IB Insurance Event Driver. COMPONENT: (TOP of routine) VARIABLES: DFN Type: Input Pointer to the patient in file #2. IBCDFN Type: Input (Defined above) IBEVTA0 Type: Input (Defined above) IBEVTA1 Type: Input (Defined above) IBEVTA2 Type: Input (Defined above) IBEVTP0 Type: Input (Defined above) IBEVTP1 Type: Input This variable contains the 1 node of the previous value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTP2 Type: Input This variable contains the 2 node of the previous value of an entry in the INSURANCE TYPE multiple in the PATIENT (#2) file. IBEVTACT Type: Input (Defined above) The call D ^IBCNSEVT is made to invoke the IB Insurance Event Driver after a new policy is filed in the IVM package. ******************** 947 NAME: DBIA947 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These routine calls are used by the IVM package to retrieve IVM-related billing and collections information from IB to transmit to the IVM Center. ROUTINE: IBAMTV4 COMPONENT: INS(ROOT) VARIABLES: ROOT Type: Input This variable is used to denote the array root for IB to store the billing/collections information. The actual array is the output from the call. This call is used to retrieve billing/collections information for patients stored in IB who have ever had an insurance policy identified by the IVM Center. The output array is defined as follows: @ROOT@(ref #)=1^2^3^4^5^6^7^8^9^10^11, where ref # - bill number or field #.01 to #350 1 - DFN 2 - Classification [1-Inpt,2-Opt,3-Refill,4-Pros] 3 - Type [1-Claim,2-Copay,3-Per Diem] 4 - Bill From Date 5 - Bill To Date 6 - Date Bill Created 7 - Amt Billed 8 - Amt Collected (Claims only) 9 - Date Bill Closed (Claims only) 10 - Cancelled? [0-No,1-Yes] 11 - On Hold? (Patient charges only) COMPONENT: ALL(DFN,ROOT,ST,END) VARIABLES: DFN Type: Input Pointer to the patient in file #2. ROOT Type: Input This variable is used to denote the array root for IB to store the billing/collections information. The actual array is the output from the call. ST Type: Input This variable tells IB the first date to begin to retrieve Means Test charges for a patient. END Type: Input This variable tells IB the last date to retrieve Means Test charges for a patient. This call is used to retrieve billing/collections information for patients who are being tracked by the IVM package. The output from this call is the same for the INS call, which was defined above. ******************** 948 NAME: DBIA948 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This agreement is to request approval to perform the following activities when installing IVM v2.0: 1. Export the PATIENT (#.02) and STATUS (#.05) fields of the INTEGRATED BILLING ACTION (#350) file with the release. 2. Export the options IB MT ON HOLD MENU and IB MT REV PEND CHARGES with the release. 3. Export the List Templates (in file #409.61) IB MT REVIEW INDIV CHARGES and IB MT REVIEW PATIENT with the release. 4. Export the following IB protocols with this release: - IBAMTV REV PASS CHARGE - IBAMTV REV CANC CHARGE - IBAMTV REV IND CHARGES - IBAMTV SEL PATIENT - IBAMTV REV PATIENT 5. Attach the IVM protocol IVM INSURANCE EVENT to the IB protocol IBCN NEW INSURANCE EVENTS. 6. Add the new entry HOLD - REVIEW to the IB ACTION STATUS (#350.21) file. ROUTINE: ******************** 949 NAME: DBIA949 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 36 ROOT: DIC(36, DESCRIPTION: TYPE: File IVM files patient insurance information into DHCP which has been received from the IVM Center. To file a complete policy, it may be necessary to add entries to the INSURANCE COMPANY (#36) file. ^DIC(36,D0,0) .01 NAME 0;1 Write w/Fileman It may be necessary to add a new insurance company when filing a new patient policy. ^DIC(36,D0,.11) .111 STREET ADDRESS [LINE .11;1 Write w/Fileman .112 STREET ADDRESS [LINE .11;2 Write w/Fileman .114 CITY .11;4 Write w/Fileman .115 STATE .11;5 Write w/Fileman .116 ZIP CODE .11;6 Write w/Fileman Update of the insurance company address. ^DIC(36,D0,.13) .131 PHONE NUMBER .13;1 Write w/Fileman Update of the insurance company phone number. ROUTINE: ******************** 950 NAME: DBIA950 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Controlled Subscri ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File IVM files patient insurance information into DHCP which has been received from the IVM Center. The patient policy is filed in the PATIENT (#2) file. Update: IB*2*497 increased the length of the SUBSCRIBER ID field and the NAME OF INSURED field to support the EDI New Standards and Operating Rules for VHA providers. This required length increase made it necessary to move the location of these 2 fields to new Data Dictionary nodes in the INSURANCE TYPE sub-file. To support this implementation, all subscribers to this ICR will need to make the necessary changes in their applications to reference the new fields and remove the references to the old fields. When all subscribers have implemented the use of the new fields, the old fields will be deleted with a IB*2*518. Old and new fields are noted in the field list detail of this ICR. ^DPT(D0,.31) .3192 COVERED BY HEALTH IN .31;11 Direct Global Read & w The value of this field is needed as input to the call COVERED^IBCNSM31, which then possibly updates this field. ^DPT(D0,.312,D1,0) .01 INSURANCE TYPE 0;1 Write w/Fileman This is the insurance company for the new policy. .18 GROUP PLAN 0;18 Write w/Fileman This a pointer to the group plan in file #355.3. 1 *SUBSCRIBER ID 0;2 Write w/Fileman This field identifies the patient to the insurance company. Note: IB*2*497 - replaced by SUBSCRIBER ID field (7.02) 3 INSURANCE EXPIRATION 0;4 Write w/Fileman This is the expiration date of the policy. 6 WHOSE INSURANCE 0;6 Write w/Fileman This field identifies who actually holds the policy. 8 EFFECTIVE DATE OF PO 0;8 Write w/Fileman This is the effective date of the policy. 17 *NAME OF INSURED 0;17 Write w/Fileman This field contains the name of the person to which the policy was issued. Note: IB*2*497 - replaced by NAME OF INSURED field (7.01) These are essential data elements which must be filed with the policy. ^DPT(D0,.312,D1,1) 1.05 DATE LAST EDITED 1;5 Write w/Fileman This is the date that the policy was last edited. 1.06 LAST EDITED BY 1;6 Write w/Fileman This is the user who last edited the policy. 1.09 SOURCE OF INFORMATIO 1;9 Write w/Fileman This is the source of the policy. This value will always be IVM. These are essential data elements which must be filed with the policy. ^DPT(D0,.312,D1,7) 7.01 NAME OF INSURED 7;1 Write w/Fileman This field contains the name of the person to which the policy was issued. 7.02 SUBSCRIBER ID 7;2 Write w/Fileman This field identifies the patient to the insurance company. ROUTINE: ******************** 951 NAME: DBIA951 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 355.1 ROOT: IBE(355.1 DESCRIPTION: TYPE: File IVM files patient insurance information into DHCP which has been received from the IVM Center. The type of plan is received from the IVM Center with the policy. This value points to the TYPE OF PLAN (#355.1) file and must be filed in the GROUP INSURANCE PLAN (#355.3) file. ^IBE(355.1,D0,0) .01 NAME 0;1 Direct Global Read & w The NAME of the type of plan is directly read and displayed to the user when the entire IVM policy is displayed to the user for review. ROUTINE: ******************** 952 NAME: DBIA952 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 355.3 ROOT: IBA(355.3, DESCRIPTION: TYPE: File IVM files patient insurance information into DHCP which has been received from the IVM Center. This involves potentially filing a new entry in the GROUP INSURANCE PLAN (#355.3) file. ^IBA(355.3,D0,0) .06 IS PRE-CERTIFICATION 0;6 Write w/Fileman When the group plan is either added or retrieved, this field of the record is updated. .09 TYPE OF PLAN 0;9 Write w/Fileman This field is a pointer to file #355.1. ROUTINE: ******************** 954 NAME: DBIA954 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: AR (ACCOUNTS RECEIVABLE) The Accounts Receivable package requires the use of cost centers in association with financial transactions. Cost centers linked with a given control point are stored on the Fund Control Point file (420) of the IFCAP package. IFCAP has provided a call to AR which returns all cost centers for a given control point. EVENT CAPTURE USAGE: Controlled Subscri ENTERED: AUG 19,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PRCSREC2 COMPONENT: $$COST(X,Y) VARIABLES: X Type: Input This is the 3 digit station number where the control point is entered. Y Type: Input This is the control point number. For a control point entered in Y, all cost centers are returned. If the control point is not found, null is returned. If no cost centers are found, null is returned. ******************** 955 NAME: DBIA955 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The IVM package requests permission to perform the following actions during the initialization of IVM v2.0: 1. Export the following fields/files: a. The SOCIAL SECURITY NUMBER (#.09) field of the INCOME PERSON (#408.13) file. b. The following fields in the ANNUAL MEANS TEST (#408.31) file: DATE/TIME COMPLETED (#.07) DATE VETERAN SIGNED TEST (#.24) HARDSHIP? (#.2) PRIMARY INCOME TEST FOR YEAR? (#2) SOURCE OF INCOME TEST (#.23) DATE IVM VERIFIED MT COMPLETED (#.25) REFUSED TO SIGN (#.26) c. The SOURCE OF INCOME TEST (#408.34) file, with data. d. The following fields of the MEANS TEST CHANGES (#408.41) file: OLD SOURCE OF INCOME TEST (#.08) NEW SOURCE OF INCOME TEST (#.09) 2. Export the input template DGMT UPDATE AUDIT. 3. Export the following PIMS routines: DGMTA DGMTAUD DGMTAUD1 DGMTCOU1 DGMTDD DGMTDD2 DGMTDEL DGMTE DGMTEO DGMTO1 DGMTOFA1 DGMTOPYT DGMTOREQ DGMTP4 DGMTSCC DGMTU DGMTU11 DGMTU2 DGMTU21 DGMTU22 DGMTU23 DGMTU3 DGMTUB DGMTV DGPTUTL1 DGRPU VAFHLFNC VAFHLZDP VAFHLZGD VAFHLZIR VAFHLZMT 4. Add the new entries 'MEANS TEST UPLOAD' and 'UPLOADED MEANS TEST DELETION' to the MEANS TEST CHANGES TYPE (#408.42) file. 5. Update the field SOURCE OF INCOME TEST (#.23) to 'VAMC' and the field PRIMARY INCOME TEST FOR YEAR? (#2) to 'YES' for every entry in the ANNUAL MEANS TEST (#408.31) file. ROUTINE: ******************** 956 NAME: DBIA956 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH SCHEDULING USAGE: Private ENTERED: AUG 22,1994 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package requests use of the function $$EN^VAFHLZIR to extract veteran income relation data to transmit to the IVM Center. The Ambulatory Care Database Project requests use of the function $$EN^VAFHLZIR to extract veteran income relation data to transmit to NPCDB. ROUTINE: VAFHLZIR COMPONENT: $$EN(IEN,FLDS,SETID) VARIABLES: IEN Type: Input IEN is the internal entry number for the entry in the INCOME RELATION (#408.22) file for which data is to be extracted. FLDS Type: Input FLDS contains a list of the fields in the HL7 ZIR segment, concatenated with commas, which should be extracted for the entry. SETID Type: Input SETID is used to specify the SET ID field in the HL7 ZIR segment. SEG Type: Output SEG is the HL7 ZIR segment string returned by the function. This function call is made to create the HL7 ZIR segment string. ******************** 957 NAME: DBIA957 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package files new entries in the ANNUAL MEANS TEST (#408.31) file. This call is used to create a stub entry in that file. ROUTINE: DGMTA COMPONENT: ADD VARIABLES: DFN Type: Input The variable DFN points to the patient in file #2. DGMTDT Type: Input The variable DGMTDT is the Date of Test (#.01 field) of the new Means Test being added. DGMTYPT Type: Input The variable DGMTYPT is the type of test (Means Test) being added. DGMTI Type: Output The variable DGMTI is returned from the call. It is the ien for the new entry in file #408.31. This call is made to add new entries to file #408.31. ******************** 958 NAME: DBIA958 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine After IVM adds a new Means Test to the PIMS database, the Means Test Event Driver must be invoked. These calls to DGMTEVT are used to invoke that event driver. ROUTINE: DGMTEVT COMPONENT: AFTER VARIABLES: DGMTACT Type: Input The variable DGMTACT specifies the 'action' that is taking place. The action will be 'UPL' to designate the Upload of a Means Test. DGMTI Type: Input The variable DGMTI is the ien for the entry in the ANNUAL MEANS TEST (#408.31) file which is being uploaded. DGMTA Type: Output The output variable DGMTA contains the zeroth node of the entry specified by DGMTI. This call is made to define one of the variables needed before invoking the Means Test Event Driver. COMPONENT: EN VARIABLES: DFN Type: Input The variable DFN points to the patient in file #2. DGMTACT Type: Input The variable DGMTACT specifies the action which is taking place (i.e., adding, editing, deleting the Means Test, etc.). DGMTI Type: Input The variable DGMTI is the ien for the Means Test in file #408.31 which has been acted upon. DGMTINF Type: Input The variable DGMTINF indicates whether the process is interactive or running in the background. DGMTP Type: Input The variable DGMTP is the zeroth node of the Means Test specified by DGMTI prior to the action which took place on the test. DGMTA Type: Input The variable DGMTA is the zeroth node of the Means Test specified by DGMTI after action was taken on the test. This call is made to invoke the Means Test Event Driver. ******************** 959 NAME: DBIA959 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package adds new Means Tests into the PIMS Means Test module. In order to calculate the correct category for these tests, a call to PAR^DGMTSCU is made to retrieve the Means Test threshold figures for the correct year. ROUTINE: DGMTSCU COMPONENT: PAR VARIABLES: DGLY Type: Input The variable DGLY is the year prior to the Means Test. DGMTPAR Type: Output The output variable DGMTPAR contains the zeroth node of MEANS TEST DATA (#250) multiple in the MAS PARAMETERS (#43) file for the appropriate Means Test year. DGMTPAR(PR Type: Output The output variable DGMTPAR("PREV") is defined if the appropriate MEANS TEST DATA multiple is not defined. This call is used to retrieve the Means Test threshold figures used to calculate the Means Test category. ******************** 960 NAME: DBIA960 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package adds Means Tests to the PIMS Means Test module. This call is used to calculate the Means Test category once a veteran's Means Test, income, and income relations information is filed. ROUTINE: DGMTSCU2 COMPONENT: SET VARIABLES: DFN Type: Input The variable DFN points to the patient in file #2. DGMTDT Type: Input The variable DGMTDT is the Date of Test of the Means Test. DGMTYPT Type: Input The variable DGMTYPT is the type (Means Test) of income test. DGMTI Type: Input The variable DGMTI is the ien of the Means Test in file #408.31. DGMTPAR Type: Input The variable DGMTPAR contains the appropriate Means Test thresholds. DGVIRI Type: Input The variable DGVIRI contains the ien for the income relation in file #408.22. DGVINI Type: Input The variable DGVINI contains the ien for the individual annual income record in file #408.21. DGCAT Type: Output The output variable DGCAT contains the computed Means Test category for the Means Test. This call is used to compute the Means Test category for a Means Test. ******************** 961 NAME: DBIA961 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package needs to extract Social Security numbers for a veteran's spouse. The function call $$DEM^DGMTU1 is used to retrieve the zeroth node of the PATIENT (#2) or INCOME PERSON (#408.13) for the spouse. ROUTINE: DGMTU1 COMPONENT: $$DEM(DGPRI) VARIABLES: DGPRI Type: Input DGPRI points to the Income relation in file #408.12. OUT Type: Output The output from this function is the zeroth node of the patient relation from either the PATIENT (#2) or INCOME PERSON (#408.13) files. This call is made to retrieve the appropriate zeroth node for the patient relation. The ssn is then extracted from that node. ******************** 963 NAME: DBIA963 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package files new Means Tests into the PIMS Means Test module. As such, income and income relations records must be filed in files #408.21 and #408.22, respectively. Two function calls to routine DGMTU2 are made to add stub entries to these files. ROUTINE: DGMTU2 COMPONENT: $$ADDIN(DFN,DGPRI,DGLY) VARIABLES: DFN Type: Input DFN points to the patient in file #2. DGPRI Type: Input DGPRI points to the patient relation in file #408.12. DGLY Type: Input DGLY is the year prior to the year of the Means Test. OUT Type: Output The ien for the new record in file #408.21 is output from this function. This function call is used to add entries to the INDIVIDUAL ANNUAL INCOME (#408.21) file. COMPONENT: $$ADDIR(DFN,DGINI) VARIABLES: DFN Type: Input DFN points to the patient in file #2. DGINI Type: Input DGINI points to the annual income record in file #408.21. This call is made to add entries to the INCOME RELATION (#408.22) file. ******************** 964 NAME: DBIA964 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH SURGERY ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 26,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File The IVM package requests direct access to the field NON-COUNT CLINIC? (#2502) in the HOSPITAL LOCATION (#44) file. The field is used to determine whether an outpatient encounter in a specific clinic is potentially billable for Means Test billing. ^SC(D0,0) 2502 NON-COUNT CLINIC? 0;17 Direct Global Read & w The field NON-COUNT CLINIC? is read directly from the zeroth node for a specific clinic. This direct global reference is made to determine if an encounter in a specific clinic may be billed the Means Test copayment. ROUTINE: ******************** 965 NAME: DBIA965 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM packages files new Means Tests in the PIMS Means Test module. Part of that process is to find income records for specific patient relations. The call to DGMTU3 is used to find the veteran's own income record. ROUTINE: DGMTU3 COMPONENT: $$IAI(DGPRI,DGLY) VARIABLES: DGPRI Type: Input DGPRI is the pointer to the patient relation in file #408.12. DGLY Type: Input DGLY is the year prior to the veteran's Means Test date. OUT Type: Output The output from this function call is the pointer to the relation's income record in file #408.21. This call is used to locate the ien for the veteran's income record in file #408.21 which is used to determine his Means Test category. ******************** 966 NAME: DBIA966 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH CLINICAL INFO RESOURCE NETWORK ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File The IVM package needs to determine the last date that a veteran was treated at a specific facility. The "ATID3" cross-reference in the PATIENT MOVEMENT (#405) file is used to determine the patient's last discharge date. ^DGPM('ATID3',DFN, .01 DATE/TIME Direct Global Read & w The command +$O(^DGPM("ATID3",DFN,"")) is used to find the veteran's most recent date of discharge. The "ATID3" cross-reference is used to find the veteran's most recent discharge date. ROUTINE: ******************** 967 NAME: DBIA967 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The IVM package requests permission to directly access and file various fields in the PATIENT (#2) file. ^DPT(D0,0) .02 SEX 0;2 Write w/Fileman This field is updated with information received from the IVM Center. .03 DATE OF BIRTH 0;3 Write w/Fileman This field is updated with information received from the IVM Center. The IVM Center may find updated demographics information for the veteran while verifying his Means Test. This information may be uploaded directly into DHCP with user confirmation. ^DPT(D0,.11) .111 STREET ADDRESS [LINE .11;1 Write w/Fileman This field is updated with information received from the IVM Center. .112 STREET ADDRESS [LINE .11;2 Write w/Fileman This field is updated with information received from the IVM Center. .114 CITY .11;4 Write w/Fileman This field is updated with information received from the IVM Center. .115 STATE .11;5 Write w/Fileman This field is updated with information received from the IVM Center. .1112 ZIP+4 .11;12 Write w/Fileman This field is updated with information received from the IVM Center. .117 COUNTY .11;7 Write w/Fileman This field is updated with information received from the IVM Center. The IVM Center may find updated demographics information for the veteran while verifying his Means Test. This information may be uploaded directly into DHCP with user confirmation. ^DPT(D0,.13) .131 PHONE NUMBER [RESIDE .13;1 Write w/Fileman This field is updated with information received from the IVM Center. The IVM Center may find updated demographics information for the veteran while verifying his Means Test. This information may be uploaded directly into DHCP with user confirmation. ^DPT(D0,.35) .351 DATE OF DEATH .35;1 Both R/W w/Fileman This field is updated with information received from the IVM Center. The IVM Center may find updated demographics information for the veteran while verifying his Means Test. This information may be uploaded directly into DHCP with user confirmation. ROUTINE: ******************** 968 NAME: DBIA968 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.31 ROOT: DGMT(408.31, DESCRIPTION: TYPE: File The IVM package files new Means Tests in the PIMS Means Test module. IVM requests permission to add new entries into the ANNUAL MEANS TEST (#408.31) file, and to update several fields in that file. Additionally, permission is requested to delete entries from that file (if the IVM Center mistakenly sends a Means Test to a facility). ^DGMT(408.31,D0,0) .01 DATE OF TEST 0;1 Write w/Fileman This field is part of the IVM verified Means Test. .19 TYPE OF TEST 0;19 Write w/Fileman This field is part of the IVM verified Means Test. .02 PATIENT 0;2 Write w/Fileman This field is part of the IVM verified Means Test. .03 STATUS 0;3 Both R/W w/Fileman This field is calculated as part of the IVM verified Means Test. .04 INCOME 0;4 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .05 NET WORTH 0;5 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .06 COMPLETED BY 0;6 Write w/Fileman This field is part of the IVM verified Means Test. .07 DATE/TIME COMPLETED 0;7 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .11 AGREE TO PAT DEDUCTI 0;11 Write w/Fileman This field is part of the IVM verified Means Test. .12 THRESHOLD A 0;12 Write w/Fileman This field is part of the IVM verified Means Test. .13 THRESHOLD B 0;13 Write w/Fileman This field is part of the IVM verified Means Test. .14 DECLINES TO GIVE INC 0;14 Write w/Fileman This field is part of the IVM verified Means Test. .15 DEDUCTIBLE EXPENSES 0;15 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .16 PREVIOUS YEARS THRES 0;16 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .18 TOTAL DEPENDENTS 0;18 Write w/Fileman This field is calculated as part of the IVM verified Means Test. .2 HARDSHIP? 0;20 Both R/W w/Fileman This field is part of the IVM verified Means Test. .23 SOURCE OF INCOME TES 0;23 Both R/W w/Fileman This field is part of the IVM verified Means Test. .24 DATE VETERAN SIGNED 0;24 Write w/Fileman This field is part of the IVM verified Means Test. .25 DATE IVM VERIFIED MT 0;25 Write w/Fileman This field is part of the IVM verified Means Test. .26 REFUSED TO SIGN 0;26 Write w/Fileman This field is part of the IVM verified Means Test. All of these fields are updated in file #408.31 while adding a new Means Test. ^DGMT(408.31,D0,'PRIM') 2 PRIMARY INCOME TEST PRIM;1 Both R/W w/Fileman This field is part of the IVM verified Means Test. This field is updated in file #408.31 when adding a new Means Test. ^DGMT(408.31,D0,'C',N,0) 50 COMMENT C;0 Read w/Fileman The word-processing comments for a Means Test are extracted from DHCP and transmitted to the IVM Center. The Means Test comments need to be extracted for transmission to the IVM Center. ROUTINE: ******************** 973 NAME: DBIA973 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: SEP 23,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Used to screen out inactive providers. Below is a listing of files and fields that will be referencing the inactive provider field in 200, indirectly. Routine DGPMDD references the data. The fields contain an extrensic function for screening, $$SCREEN^DGPMDD(ien,da,date) and a call to HELP^DGPMDD(da,date) for executable help. ===================================================================== File 405 - Patient Movement *Field .08 - PRIMARY CARE PHYSICIAN *Field .19 - ATTENDING PHYSICIAN File 2 - Patient Field .104 - PROVIDER Field .1041 - ATTENDING PHYSICIAN File 41.1 - Scheduled Admission Field 5 - PROVIDER File 45 - PTF (Subfile 45.02, 50) Field 24 - PROVIDER File 45.7 - FACILITY TREATING SPECIALTY (Subfile 45.701, 10) Field .01 - PROVIDERS ^VA(200,D0,'PS' 53.4 INACTIVE DATE PS;4 Direct Global Read & w ROUTINE: ******************** 974 NAME: DBIA974 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 23,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IVM requests permission to make the function call $$MTS^DGMTU in order to determine the Means Test status, given a pointer to the status in the MEANS TEST STATUS (#408.32) file. ROUTINE: DGMTU COMPONENT: $$MTS(DFN,MTS) VARIABLES: DFN Type: Input DFN points to the patient in file #2. MTS Type: Input MTS points to the Means Test Status in file #408.32. OUT Type: Output This function returns the Means Test Status Name and the Status Code concatenated by a caret ('^'). This call returns the Means Test Status Name for a given pointer to the Means Test Status (#408.32) file. ******************** 975 NAME: DBIA975 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LETTERMAN USAGE: Private ENTERED: AUG 29,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1.5 ROOT: DIW(1.5, DESCRIPTION: TYPE: File This integration agreement permits LetterMan to install and reference the WORD LIST file #1.5 stored in global ^DIW(1.5,. The WORD LIST file is used by the LetterMan spell checker. ROUTINE: ******************** 976 NAME: DBIA976 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LETTERMAN USAGE: Private ENTERED: AUG 29,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File This integration agreement permits LetterMan to distribute and add/edit data in the fields in the range of 8983 to 8984 in the NEW PERSON FILE #200. The following is a standard data dictionary listing of the fields: 200,8983.11 DISPLAY HELP AT ENTRY TO LM LM;1 SET 'y' FOR YES; 'n' FOR NO; LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter yes to display the help text before entering the editor. DESCRIPTION: If set to yes, a help text will be displayed before entering the editor. This is used primarily for new users. 200,8983.12 ASK TERMINAL TYPE AT LM ENTRY LM;2 SET 'y' FOR YES; 'n' FOR NO; HELP-PROMPT: Enter yes to ask the terminal type upon entry to the editor. DESCRIPTION: If set to yes, the terminal type will be asked upon entry to the editor. 200,8983.13 DEFAULT TERMINAL TYPE FOR LM LM;3 POINTER TO TERMINAL TYPE FILE ( #3.2) LAST EDITED: JAN 26, 1990 DESCRIPTION: This field stores the default terminal type for a user. 200,8983.14 DISPLAY LM COMMANDS LM;4 SET 'y' FOR YES; 'n' FOR NO; LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter yes to display the list of commands when entering the command mode. DESCRIPTION: If set to yes, the list of commands will be displayed at the bottom of the screen when entering the command mode. 200,8983.15 BRIGHT CHARS AT EXIT FROM LM LM;5 SET 'y' FOR YES; 'n' FOR NO; LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter yes to leave the terminal in high intensity after exiting LetterMan. DESCRIPTION: If set to yes, the terminal will be left in high intensity after exiting. 200,8983.16 DATE LAST ACCESSED LM WP LM;6 DATE INPUT TRANSFORM: S %DT="ETR" D ^%DT S X=Y K:Y<1 X LAST EDITED: JAN 28, 1990 DESCRIPTION: The date and time a user last accessed the LetterMan word processor document editor. 200,8983.17 TOTAL MINUTES USING LM WP LM;7 NUMBER INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X LAST EDITED: JAN 28, 1990 HELP-PROMPT: Enter the total minutes spent using the LetterMan Word Processor (Editor), from 0 to 999999999. DESCRIPTION: The total minutes a user has used the LetterMan word processor document editor. 200,8983.18 KEYSTROKES FROM LM WP LM;8 NUMBER INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X LAST EDITED: JAN 28, 1990 HELP-PROMPT: Enter the total number of keystrokes a user has typed from the word processor document editor, from 0 to 999999999. DESCRIPTION: This field stores the total number of keystrokes a user has typed from the word processor document editor. 200,8983.5 SPELLING EXCEPTION DICTIONARY LM1;0 Multiple #200.0089831 DESCRIPTION: This field stores the exception spelling dictionary for the user. 200.0089831,.01 WORD 0;1 FREE TEXT (Multiply asked) INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X I $D(X),X'?.L,X'["-" K X LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter the WORD which should be checked by the spelling checker, from 1 to 30 lower case characters including '-'. DESCRIPTION: This field stores words which will be checked when spell checking a document. NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER CROSS-REFERENCE: 200.0089831^B 1)= S ^VA(200,DA(1),"LM1","B",$E(X,1,30),DA)= "" 2)= K ^VA(200,DA(1),"LM1","B",$E(X,1,30),DA) 200.0089831,1 ITS A WORD ? 0;2 SET 'y' FOR YES; LAST EDITED: MAY 4, 1992 CROSS-REFERENCE: 200.0089831^AW^MUMPS 1)= S ^VA(200,DA(1),"LM1","AW",$P(^VA(200,DA( 1),"LM1",DA,0),"^"),DA)="" 2)= K ^VA(200,DA(1),"LM1","AW",$P(^VA(200,DA( 1),"LM1",DA,0),"^"),DA) This cross reference is used to identify the entry in the exception dictionary as a word. 200.0089831,2 ITS NOT A WORD ? 0;3 SET 'y' FOR YES; LAST EDITED: MAY 4, 1992 CROSS-REFERENCE: 200.0089831^AN^MUMPS 1)= S ^VA(200,DA(1),"LM1","AN",$P(^VA(200,DA( 1),"LM1",DA,0),"^"),DA)="" 2)= K ^VA(200,DA(1),"LM1","AN",$P(^VA(200,DA( 1),"LM1",DA,0),"^"),DA) This cross reference is used to identify the entry in the exception dictionary as a non-word. 200,8983.51 DEFINED FORMATS FOR LM LM2;0 Multiple #200.0089832 DESCRIPTION: This field is used to store predefined format lines which a user can select from during editing. 200.0089832,.01 NUMBER 0;1 NUMBER (Multiply asked) INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<1)!(X?.E1"."1N.N) X LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter the number of the predefined format line, from 1 to 9999999. DESCRIPTION: This is the reference number to the predefined format line. CROSS-REFERENCE: 200.0089832^B 1)= S ^VA(200,DA(1),"LM2","B",$E(X,1,30),DA)= "" 2)= K ^VA(200,DA(1),"LM2","B",$E(X,1,30),DA) 200.0089832,1 DEFAULT 0;2 SET 'y' FOR YES; 'n' FOR NO; LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter yes to use this format line when you enter the screen editor. DESCRIPTION: If set to yes, this format line will be used as the default format line when using the screen editor. If a document already has a format line defined, then the document format will be used. CROSS-REFERENCE: 200.0089832^AC 1)= S ^VA(200,DA(1),"LM2","AC",$E(X,1,30),DA) ="" 2)= K ^VA(200,DA(1),"LM2","AC",$E(X,1,30),DA) 200.0089832,2 FORMAT LINE 0;3 FREE TEXT INPUT TRANSFORM: K:$L(X)>79!($L(X)<1) X I $D(X) S %=X,X="WPSEF ORM" X ^%ZOSF("TEST") K X I $T S X=% D CHECK^ WPSEFORM LAST EDITED: MAR 23, 1992 HELP-PROMPT: The format line should contain dots '.' representing spaces or 'T' representing tab or indent markers followed by a '<' indicating the end of the right margin. DESCRIPTION: This field stores the predefined format lines of the user. NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER 200,8983.52 DEFINED PHRASES FOR LM LM3;0 Multiple #200.0089833 DESCRIPTION: This field stores predefined phrases which can be inserted into the document during editing. 200.0089833,.01 KEYWORD 0;1 FREE TEXT (Multiply asked) INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X LAST EDITED: JAN 26, 1990 HELP-PROMPT: Enter the keyword used to select this phrase, from 1 to 50 characters. DESCRIPTION: The predefined phrase 'keyword' used to select the phrase. CROSS-REFERENCE: 200.0089833^B 1)= S ^VA(200,DA(1),"LM3","B",$E(X,1,30),DA)= "" 2)= K ^VA(200,DA(1),"LM3","B",$E(X,1,30),DA) 200.0089833,1 PHRASE 1;0 WORD-PROCESSING #200.00898331 (NO WRAP) DESCRIPTION: The phrase to be inserted into the document. 200,8983.6 LM LIMIT WP FIELDS TO EDIT LM4;0 Multiple #200.0089834 DESCRIPTION: This field is used by the user to limit which word processing fields should be edited by LetterMan. 200.0089834,.01 LM LIMIT WP FIELDS TO EDIT 0;1 FREE TEXT (Multiply asked) Limited Word-Processing Fields to Edit INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>150!($L (X)<4) X I $D(X) S %=X,X="WPSEFM" X ^%ZOSF("T EST") K X I $T S X=% D SCREEN^WPSEFM LAST EDITED: DEC 12, 1990 HELP-PROMPT: Answer must be 4-150 characters in length. EXECUTABLE HELP: S X="WPSEHELP" X ^%ZOSF("TEST") I $T D FMHELP ^WPSEHELP NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER CROSS-REFERENCE: 200.0089834^B 1)= S ^VA(200,DA(1),"LM4","B",$E(X,1,30),DA)= "" 2)= K ^VA(200,DA(1),"LM4","B",$E(X,1,30),DA) ROUTINE: ******************** 978 NAME: DBIA978 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2, DESCRIPTION: TYPE: File This integration agreement allows IFCAP to lookup data in the TERMINAL TYPE File #3.5. The lookups are direct global references (^%ZIS(2,IOST(0),node)). The agreement is established since the routine %ZISS does not return the values for the fields above. In a future version of %ZISS, the fields 60 and 61 could be included since the bar code fields can be turned on/off by writing the value of the field (i.e. W ^%ZIS(2,IOST(0),"BAR1")). The routine %ZISS could also return the field values for opening and closing the printer port providing the field value returned is in its executable form (i.e. X ^%ZIS(2,IOST(0),10)). ^%ZIS(2,D0,10) 110 OPEN PRINTER PORT 10;1 Direct Global Read & w ^%ZIS(2,D0,11) 111 CLOSE PRINTER PORT 111;1 Direct Global Read & w ^%ZIS(2,D0,'BAR0') 61 BAR CODE OFF BAR0;1 Direct Global Read & w ^%ZIS(2,D0,'BAR1') 60 BAR CODE ON BAR1;1 Direct Global Read & w ROUTINE: ******************** 979 NAME: DBIA979 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LETTERMAN USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.1 FILE: 3.5 ROOT: %ZIS(2, DESCRIPTION: TYPE: File This integration agreement allows LetterMan to lookup terminal type attributes from the TERMINAL TYPE File #3.5 using direct global references. One option in LetterMan will automatically set up the terminal type to be used with LetterMan. In the next version of LetterMan, it will migrate to using the %ZISS routine to return the attributes. There are approximately 15 attributes used by LetterMan. Half of the attributes will be converted from executable code to writeable attributes (as returned by %ZISS). ROUTINE: ******************** 980 NAME: PSODISP CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To display help at the prescription selection prompt. ROUTINE: PSODISP COMPONENT: HELP VARIABLES: ******************** 981 NAME: PSOFUNC CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To determine the status of a prescription ROUTINE: PSOFUNC COMPONENT: PSOFUNC VARIABLES: J Type: Input Internal entry number from ^PSRX( RX0 Type: Input Zero node from ^PSRX( RX2 Type: Input 2 node from ^PSRX( ST Type: Output External form of status ******************** 982 NAME: PSOLSET CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To kill Outpatient variables. ROUTINE: PSOLSET COMPONENT: FINAL VARIABLES: ******************** 983 NAME: PSOCSRL CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To release prescriptions from a vault. ROUTINE: PSOCSRL COMPONENT: PSOCSRL VARIABLES: RXP Type: Input Internal entry number of prescription. XTYPE Type: Input Original = "", Refill = "1^#", Partial = "P^#" PSRH Type: Input DUZ of releasing pharmacist. ******************** 986 NAME: DBIA986 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: AUG 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52 ROOT: PSRX( DESCRIPTION: TYPE: File For the Controlled Substances/Outpatient interface, read access is required for several fields in the PRESCRIPTION file. ^PSRX( .01 RX # 0;1 Direct Global Read & w The "B" x-ref may also be read directly. 2 PATIENT 0;2 Direct Global Read & w 6 DRUG 0;6 Direct Global Read & w 7 QTY 0;7 Direct Global Read & w 100 STATUS STA;1 Direct Global Read & w 22 FILL DATE 2;2 Direct Global Read & w 31 RELEASED DATE/TIME 2;13 Direct Global Read & w 32.1 RETURNED TO STOCK 2;15 Direct Global Read & w ^PSRX(D0,1, .01 REFILL DATE 0;1 Direct Global Read & w 1 QTY 0;4 Direct Global Read & w 14 RETURNED TO STOCK 0;16 Direct Global Read & w 17 RELEASED DATE/TIME 0;18 Direct Global Read & w ^PSRX(D0,'P', .01 PARTIAL DATE 0;1 Direct Global Read & w .04 QTY 0;4 Direct Global Read & w 5 RETURNED TO STOCK 0;16 Direct Global Read & w 8 RELEASED DATE/TIME 0;19 Direct Global Read & w ^PSRX(D0,4,D1, 3 STATUS 0;4 Direct Global Read & w 2 RX INDICATOR 0;3 Direct Global Read & w ^PSRX(D0,'A', .01 ACTIVITY LOG 0;1 Direct Global Read & w .02 REASONS 0;2 Direct Global Read & w .03 INITIATOR OF ACTIVIT 0;3 Direct Global Read & w ^PSRX(D0,'L', .01 LABEL DATE/TIME 0;1 Direct Global Read & w 1 RX REFERENCE 0;2 Direct Global Read & w 4 WARNING LABEL TYPE 0;5 Direct Global Read & w ROUTINE: ******************** 987 NAME: DBIA987 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: SEP 26,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File The Laboratory package Version 5.2 requests agreement from the VA FileMan package to modify the B cross-references in the LABORATORY TEST FILE #60 and the WKLD CODE FILE #64 to be greater than 30 characters. The first 30 characters are quite frequently the same for more than one test or workload code. ^DD(60,.01,1,1,1)=S ^LAB(60,"B",$E(X,1,40),DA)="" ^DD(64,.01,1,1,1)=S ^LAM("B",$E(X,1,60),DA)="" ^DD(64.061,.01,1,1,1)=^LAB(64.061,"B",$E(X,1,50),DA) ROUTINE: ******************** 990 NAME: DBIA990-A CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IFCAP USAGE: Controlled Subscri ENTERED: SEP 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File ^SRF(D0,0) .01 PATIENT 0;1 Read w/Fileman Standard VA FileMan EN^DIQ lookup. .011 IN/OUT-PATIENT STATU 0;12 Read w/Fileman Standard VA FileMan EN^DIQ lookup. .02 OPERATING ROOM 0;2 Read w/Fileman Standard VA FileMan EN^DIQ lookup. .04 SURGERY SPECIALTY 0;4 Read w/Fileman Standard VA FileMan EN^DIQ lookup. .09 DATE OF OPERATION 0;9 Read w/Fileman Standard VA FileMan EN^DIQ lookup. .01 PATIENT 0;1 Pointed to Pointed to by field 130 SCHEDULED OPERATION in file 445.3 INTERNAL DISTRIBUTION ORDER. ^SRF(D0,.1) .14 SURGEON .1;4 Read w/Fileman Standard VA FileMan EN^DIQ lookup. ^SRF(D0,OP) 27 PRINCIPAL PROCEDURE OP;2 Read w/Fileman Standard VA FileMan EN^DIQ lookup. ^SRF(D0,5,I,0) .28 GENERAL COMMENTS 5;0 Direct Global Read & w Reads the GENERAL COMMENTS word-processing field. ROUTINE: ******************** 991 NAME: DBIA990-B CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IFCAP USAGE: Controlled Subscri ENTERED: SEP 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 137.45 ROOT: SRO(137.45, DESCRIPTION: TYPE: File ^SRO(137.45,D0,0) .01 NAME 0;1 Pointed to Pointed to by field 130.03 SURGICAL SPECIALTY in file 446.1 INVENTORY DISTRIBUTED PATIENT SUPPLIES. .01 NAME 0;1 Direct Global Read & w Direct global read from the routine PRCPRPC1. ROUTINE: ******************** 992 NAME: DBIA990-C CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IFCAP USAGE: Controlled Subscri ENTERED: SEP 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine: PRCPCSOR: 1. Call the routine ^SROPS to lookup the patient and scheduled operation. ROUTINE: SROPS COMPONENT: SROPS VARIABLES: PRCP("I") Type: Used After the release of patch SR*3*44, the variable PRCP("I"), which is an Inventory system variable, must be defined to bypass the future date checking function added to the lookup process by the patch. If this variable is not defined and a surgical case with a future date is selected, the user will be notified that the case selected has a future date and the user must then enter YES to continue. ******************** 994 NAME: DBIA993-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING INCOMPLETE RECORDS TRACKING CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: SEP 30,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.84 ROOT: DGP(45.84, DESCRIPTION: TYPE: File Used to check and make sure the PTF record has not been closed out. ^DGP(45.84, 2 CLOSE OUT DATE 0;2 Direct Global Read & w This field is used to determine the date that a PTF record in file #45 was closed out. .01 NAME 0;1 Direct Global Read & w Read access to the "AC" x-ref also allowed. 3 CLOSE OUT BY 0;3 Direct Global Read & w ROUTINE: ******************** 996 NAME: DBIA118-D CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION ICR - IMMUNOLOGY CASE REGISTRY NETWORK HEALTH EXCHANGE CLINICAL CASE REGISTRIES CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: AUG 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: Radiology 4 FILE: 72 ROOT: RA(72, DESCRIPTION: TYPE: File These look fine for the current field version (4.0) of Radiology. There are a few cautions for you when we release Radiology/Nuclear Medicine Version 4.5. These things may have no affect on you whatsoever, but you need to know so you can make your own judgement: a) Currently the exam statuses (file 72) each can be used for any exam regardless of imaging type. In Version 4.5, exam statuses will be specific to imaging type. We are adding the basic statuses (WAITING FOR EXAM, CALLED FOR EXAM, EXAMINED, CANCELLED, COMPLETE) to this file for each of the 8 imaging types. (i.e. there will be an EXAMINED status for General Radiology, an EXAMINED status for Nuclear Med, an EXAMINED status for Ultrasound , etc.. so that each imaging department can set up their exam status parameters differently.) b) Because of item a above, the 'B' cross-reference on file 72 becomes much less meaningful - there will now be 8 instances of each of the basis exam statuses. This may affect the proposed DBIA. Since the sites can add their own site-specific statuses, it's possible to have many instances of any status. So, the 'B' x-ref no longer represents a unique status name. ^RA(72,D0,0) .01 CURRENT EXAM STATUS 0;1 Read w/Fileman ^RA(72,'B',X,DA) .01 CURRENT EXAM STATUS Direct Global Read & w B cross-reference is used to determine STATUS. ^RA(72,'AA', Direct Global Read Access permitted. ROUTINE: ******************** 997 NAME: DBIA997 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY SPINAL CORD DYSFUNCTION CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: AUG 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4 DESCRIPTION: TYPE: File ^DIC(42.4,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 998 NAME: DBIA998 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL CASE REGISTRIES SPINAL CORD DYSFUNCTION PHARMACY BENEFITS MANAGEMENT USAGE: Controlled Subscri ENTERED: AUG 31,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,0) .01 NAME 0;1 Direct Global Read & w ^DPT(D0,'LR') 63 LABORATORY REFERENCE 63;1 Direct Global Read & w ROUTINE: ******************** 999 NAME: DBIA999 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE HEALTH SUMMARY INPATIENT MEDICATIONS OUTPATIENT PHARMACY MENTAL HEALTH ASISTS E CLAIMS MGMT ENGINE added Oct 2008 USAGE: Controlled Subscri ENTERED: SEP 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Read only access for the ^DD( Global. $O(^DD(FN,"GL",subscript,piece,0)) to get the field #. Read ^DD(FN,FLD,0), Custodial files only, where FN is a file # and FLD is a field #, to obtain the field name, the set of codes, or the input transform. ROUTINE: ******************** 1003 NAME: Scheduled Admission DBIA CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: SEP 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 41.1 ROOT: DGS(41.1, DESCRIPTION: TYPE: File The health summary package needs to set up a DBIA to access Registration data in the Scheduled Admission File. We need to have read only access on the cross reference ^DGS(41.1,"B",Patient DFN,Internal Entry # in File 41.1) to check if any scheduled admissions exist for a given patient and to find the record number in file 41.1. A call will then be issued to EN^DIQ1 after setting DA=Internal entry in file 41.1, DIC=41.1, and DR="2:6;8:10;13;17". We need read only data on the following fields in file 41.1: 2 - Reservation Date/Time 3 - Length of Stay Expected 4 - Admitting Diagnosis 5 - Provider 6 - Surgery 8 - Ward 9 - Treating Specialty 10 - Ward or Treating Specialty 13 - Date/Time Cancelled 17 - Admitted ^DGS(41.1,"B",DFN,DA) 2 Reservation Date/Tim 0;2 Read w/Fileman 3 Length of Stay Expec 0;3 Read w/Fileman 4 Admitting Diagnosis 0;4 Read w/Fileman 5 Provider 0;5 Read w/Fileman 6 Surgery 0;6 Read w/Fileman 8 Ward 0;8 Read w/Fileman 9 Treating Specialty 0;9 Read w/Fileman 10 Ward or Treating Spe 0;10 Read w/Fileman 13 Date/Time Cancelled 0;13 Read w/Fileman 17 Admitted 0;17 Read w/Fileman ROUTINE: ******************** 1004 NAME: DBIA1004 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER This DBIA allows PXPT to become the custodial package for the 9999999.06 file in the VA. USAGE: Private ENTERED: SEP 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.06 ROOT: AUTTLOC DESCRIPTION: TYPE: File The PCE Patient/IHS Subset Package (PXPT) requests a file DBIA to distribute a partial definition of the Indian Health Services Location File (9999999.06) in the VA. The PXPT Post Installation routine will populate this Location File with dinumed entries from the Institution File (4). The description for this file is very specific about going through the IHS DBA for any changes. The IHS DBA proposed that the VA should use the dinumed Institution entries, and not distribute required IHS fields. The following data dictionary definition represents the subset of the Location File to be distributed by PXPT: STANDARD DATA DICTIONARY #9999999.06 -- LOCATION FILE 09/6/94 PAGE 1 STORED IN ^AUTTLOC( (251 ENTRIES) SITE: SLC UCI: DVA,DEV DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE --------------------------------------------------------------------------- This file contains the IHS Standard Facilities and their Associated codes, CHS Vendors, pointers to their respective service units and areas, a 2-4 character abbreviation, and the highest medical record number assigned by that facility. Changes to this data dictionary should be coordinated thru the IHS DBA. This file reflects entries in the IHS Standard Code Book, section VIII-C Area - Service Unit - Facility. Local additions or modifications should not be made. Monthly updates (if required) are provided by the IHS DBA thru the patch module. DD ACCESS: @ DEL ACCESS: @ AUDIT ACCESS: @ IDENTIFIED BY: POINTED TO BY: DEFAULT INSTITUTION field (#.04) of the VISIT TRACKING PARAMETERS File (#150.9) HEALTH RECORD FAC field (#.01) of the HEALTH RECORD NO. sub-field (#9000001.41) of the PATIENT/IHS File (#9000001) LOC. OF ENCOUNTER field (#.06) of the VISIT File (#9000010) FACILITY field (#.06) of the PROBLEM File (#9000011) NOTE FACILITY field (#.01) of the NOTE FACILITY sub-field (#9000011.11) of the PROBLEM File (#9000011) SITE field (#.01) of the PCC MASTER CONTROL File (#9001000) LOCATION field (#.03) of the TAXONOMY File (#9002226) LOCATION OF ENCOUNTER field (#.18) of the TAXONOMY File (#9002226) CROSS REFERENCED BY: NAME(B) 9999999.06,.01NAME 0;1 POINTER TO INSTITUTION FILE (#4) (Required) INPUT TRANSFORM: S:$D(X) DINUM=X LAST EDITED: APR 2, 1986 DESCRIPTION: This field points to the Institution file (#4) and has the same internal number as that file. Thus, the location has the same name as the Institution file (#4). The location is also referred to as the Facility. NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER CROSS-REFERENCE: 9999999.06^B 1)= S ^AUTTLOC("B",$E(X,1,30),DA)="" 2)= K ^AUTTLOC("B",$E(X,1,30),DA) FILES POINTED TO FIELDS INSTITUTION (#4) NAME (#.01) INPUT TEMPLATE(S): PRINT TEMPLATE(S): SORT TEMPLATE(S): ROUTINE: ******************** 1005 NAME: DBIA1005 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER This DBIA allows the Patietn/IHS Subset (PXPT) to be the custodial package for distributing the file 9999999.27 in the VA. USAGE: Private ENTERED: SEP 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.27 ROOT: AUTNPOV DESCRIPTION: TYPE: File The PCE Patient/IHS Subset package (PXPT) requests a DBIA to distribute the Indian Health Services Provider Narrative File (9999999.27) in the VA. There have been two new fields added by the VA on the 757 node. These two fields are used for 1)documenting the clinical lexicon which could be used to represent the provider narrative, and 2) determining the context of the narrative when it was entered into the Provider Narrative File. The originating file will be populated by the VA Problem List and PCE. The clinical lexicon field will be populated in the future as provider narratives get mapped to clinical lexicon expressions. STANDARD DATA DICTIONARY #9999999.27 -- PROVIDER NARRATIVE FILE 09/14/94 PAGE 1 STORED IN ^AUTNPOV( (275 ENTRIES) SITE: SLC UCI: DVA,DEV (VERSION 93.2) DATA NAME GLOBAL DATA ELEMENT TITLE LOCATION TYPE -------------------------------------------------------------------------- This file contains each unique POV NARRATIVE QUALIFIER. DD ACCESS: @ DEL ACCESS: @ AUDIT ACCESS: @ POINTED TO BY: PROVIDER NARRATIVE field (#.04) of the V POV File (#9000010.07) PROVIDER NARRATIVE CATEGORY field (#80201) of the V POV File (#9000010.07) PROVIDER NARRATIVE field (#.04) of the V PROCEDURE File (#9000010.08) PROVIDER NARRATIVE field (#.06) of the V TREATMENT File (#9000010.15) PROVIDER NARRATIVE CATEGORY field (#80201) of the V TREATMENT File (#9000010.15) PROVIDER NARRATIVE field (#.04) of the V CPT File (#9000010.18) PROVIDER NARRATIVE CATEGORY field (#80201) of the V CPT File (#9000010.18) PROVIDER NARRATIVE field (#.05) of the PROBLEM File (#9000011) PROVIDER NARRATIVE field (#.04) of the PERSONAL HISTORY File (#9000013) PROVIDER NARRATIVE field (#.04) of the FAMILY HISTORY File (#9000014) CROSS REFERENCED BY: NARRATIVE(B), MNEMONIC(B) 9999999.27,.01NARRATIVE 0;1 FREE TEXT (Required) INPUT TRANSFORM: K:$L(X)>80!($L(X)<2)!'(X'?1P.E)!(X'?.ANP) X LAST EDITED: JUL 20, 1987 HELP-PROMPT: ANSWER MUST BE 2-80 CHARACTERS IN LENGTH DESCRIPTION: This is the Narrative that the provider has written out that is his description of what he treated the patient for. Enter a 2 to 80 character description. CROSS-REFERENCE: 9999999.27^B 1)= S ^AUTNPOV("B",$E(X,1,30),DA)="" 2)= K ^AUTNPOV("B",$E(X,1,30),DA) 9999999.27,8801MNEMONIC 88;1 FREE TEXT INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>2!($ LAST EDITED: DEC 16, 1985 HELP-PROMPT: ANSWER MUST BE 1-2 CHARACTERS IN LENGTH DESCRIPTION: This is a mnemonic that stands for this provider narrative. Enter a 1-2 character mnemonic. Enter a 1-2 character mnemonic. CROSS-REFERENCE: 9999999.27^B^MNEMONIC 1)= S ^AUTNPOV("B",$E(X,1,30),DA)=1 2)= K ^AUTNPOV("B",$E(X,1,30),DA) 9999999.27,75701CLINICAL LEXICON 757;1 POINTER TO EXPRESSIONS FILE (#757.01) LAST EDITED: MAY 25, 1994 DESCRIPTION: This is the clinical expression related to the provider narrative. TECHNICAL DESCR: This field will be primarily populated by the Problem List package. 9999999.27,75702ORIGINATING FILE 757;2 FREE TEXT INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X LAST EDITED: MAY 25, 1994 DESCRIPTION: This field is used in the VA to identify what file pointing to the provider narrative file created the entry in the Provider Narrative File. This may be useful as more packages create pointers to the Provider Narrative File to store the local capture of provider terminology. The Problem List package puts its free text file number in this field when it adds provider narratives to the Provider Narrative File. HELP FRAME: INPUT TEMPLATE(S): PRINT TEMPLATE(S): SORT TEMPLATE(S): ROUTINE: ******************** 1006 NAME: DBIA1006 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER This DBIA allows the Patient/IHS Subset (PXPT) to distribute the routine AUTNPOV for use in the VA. USAGE: Private ENTERED: SEP 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PCE Patient/IHS Subset package (namespaced PXPT) requests a DBIA with the Indian Health Service to distribute the AUTNPOV routine with the PXPT package. The PXPT package will distribute it as PXPTNPOV and use ZOSF to load and save the routine as AUTNPOV. There have been no coding changes to the AUTNPOV code by the VA. This is the same version that is at Tucson VAMC running as of September 4, 1994. This routine is called by the .01 Narrative field input transform on any lookup of the Provider Narrative File (9999999.27). The Provider Narrative File is distributed with the PXPT package and has a File type DBIA for distribution of the Provider Narrative File in the VA. The Provider Narrative file is used by the VA's Problem List Package and by the PCE package. AUTNPOV ; PROVIDER NARRATIVE TRUE INPUT TRANSFORM ;;92.1;IHS STANDARD DICTIONARIES;;NOV 13, 1991 ; START ; Q:'$D(APCDOVRR) I X="=",$D(APCDTNQP) S X=APCDTNQP Q:X?.E1C.E I $L(X)>30,$D(^AUTNPOV("B",X)) S X="`"_$O(^(X,0)) Q S AUTNPOVX=$E(X,1,30) F AUTNPOVY=0:0 S AUTNPOVY=$O(^AUTNPOV("B",AUTNPOVX, AUTNPOVY)) Q:'AUTNPOVY Q:$P(^AUTNPOV(AUTNPOVY,0),U,1)=X S X=$S(AUTNPOVY:"`"_AUTNPOVY,$E(X)="`":X,$E(X)="""":X,1:"""" _X_"""") K AUTNPOVX,AUTNPOVY Q The following routine (PXPTNPOV) is a PXPT version of AUTNPOV that is being distributed to the field. When the ZOSF("SAVE") is completed, the AUTNPOV routine will appear as displayed above. PXPTNPOV ; SLC/DLT - Provider Narrative True Input Transform for Export ;1/22/94 14:48 ;;1.0V1;PCE PATIENT/IHS SUBSET (PXPT);;Sept 7, 1994 AUTNPOV ; IHS/LB - PROVIDER NARRATIVE TRUE INPUT TRANSFORM ;;92.1;IHS STANDARD DICTIONARIES;;NOV 13, 1991 ; START ; Q:'$D(APCDOVRR) I X="=",$D(APCDTNQP) S X=APCDTNQP Q:X?.E1C.E I $L(X)>30,$D(^AUTNPOV("B",X)) S X="`"_$O(^(X,0)) Q S AUTNPOVX=$E(X,1,30) F AUTNPOVY=0:0 S AUTNPOVY=$O(^AUTNPOV("B",AUTNPOVX, AUTNPOVY)) Q:'AUTNPOVY Q:$P(^AUTNPOV(AUTNPOVY,0),U,1)=X S X=$S(AUTNPOVY:"`"_AUTNPOVY,$E(X)="`":X,$E(X)="""":X,1:"""" _X_"""") K AUTNPOVX,AUTNPOVY Q ROUTINE: AUTNPOV ******************** 1013 NAME: DOLRO LINE TAG IN ROUTINE %ZOSV CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: OCT 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine In the FileMan MUMPS OS file, we use code that does routine DOLRO^%ZOSV to save the local symbol table. This entry point is not documented. ROUTINE: %ZOSV COMPONENT: DOLRO VARIABLES: Save local symbol table. ******************** 1014 NAME: SET PIECE OF %ZOSF GLOBAL CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: OCT 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZOSF( DESCRIPTION: TYPE: File FileMan sets the second piece of ^%ZOSF("OS") equal to the record number selected from the FileMan MUMPS OS file during DINIT. This second piece acts like a pointer to the MUMPS OS file. ^%ZOSF('OS') ROUTINE: ******************** 1015 NAME: DBIA1015 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: APR 3,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing requests use of the function $$EXOE^SDCOU2. The purpose of the function is to determine whether the classification questions should be asked for a specific outpatient encounter. IB needs to know whether the classification questions were not asked of patients who have claimed exposures, so that a message may be sent to the Category C Billing mailgroup to alert MCCR personnel to manually review whether that particular encounter was actually related to the veteran's claimed exposures. ROUTINE: SDCOU2 COMPONENT: $$EXOE(X) VARIABLES: X Type: Input X is a pointer to the outpatient encounter in file #409.68 for which the classification decision is to be made Y Type: Output Y is the output of the function. The function returns a zero if the encounter is not exempt from asking the classification questions, or a one if the encounter is exempt from classification. This entry point is used to determine if an outpatient encounter in file #409.68 is exempt from classification. ******************** 1016 NAME: FIELD EDITOR - EN~DIR0() CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: OCT 17,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel needs to use the screen-oriented field editor for the character based GUI emulation module. ROUTINE: DIR0 COMPONENT: EN VARIABLES: ROW Type: Input The $Y position of the editing window. The default value is 0. COL Type: Input The $X position of the first column of the editing window. The default is 0. WIDTH Type: Input The width (number of characters) of the editing window. The default value is IOM-COL-1. HEIGHT Type: Input The height (number of lines) of the editing window. The default value is 1. If HEIGHT is greater than 1, the editing window will not scroll horizontally. DEF Type: Input The text to initially display in the editing window. The default value is null. MAX Type: Input The maximum number of characters that can be entered into the editing window. If HEIGHT is 1, the default value is 245 and the editing window can scroll horizontally. If HEIGHT is greater than 1, MAX can be no larger than WIDTH*HEIGHT-1. IP Type: Input The initial location of the cursor (the Insertion Point) within the default answer DEF. The default value is 1. MAP Type: Both This input array can be used to disable or override the default key sequences of the field editor, or to define customized key sequences with associated associated entry points. This array is passed by reference, and its contents are changed by the call. FLAGS Type: Input Control the way field editor operates. The values and effects are: K Keep screen handling variables. Makes subsequent calls more efficient. P Don't Paint the answer upon exit. T On exit, turn Terminators on and Echo off. W On exit, keep autoWrap mode off, type ahead on, and right margin at 0. r Right justify the answer upon exit. ANSWER Type: Both The text entered by the user. If a time-out occured, ANSWER is equal to the DEF input parameter. CODE Type: Both This variable consists of one or two up arrow (^)-pieces. The first ^-piece of CODE is a mnemonic code that indicates the key(s) the user pressed to terminate the field editor. The second ^-piece of CODE is 1 if the user made any modifications to the default value, even if the net result of series of modifications leaves the value effecitvely unchanged. If no modi- fications were made, the second ^-piece of CODE is 0. (This info corresponds to the MWAPI CHANGED element attribute.) Type: This procedure initiates a screen-oriented read. The editing window appears in reverse video. On exit, the field editor writes the final text in high intensity. COMPONENT: UPDATE VARIABLES: NEW_VALUE Type: Input The new value of the current answer. If this parameter is not passed in, then the current answer is unchanged. NEW_IP Type: Input The insertion point within NEW_VALUE. If NEW_IP is not passed in, then the insertion point is not changed. If NEW_IP is less than 1, then a value of 1 is assumed. If NEW_IP is greater than the length of NEW_VALUE plus 1, a NEW_IP value of $L(NEW_VALUE)+1 is assumed. This procedure can be called from within the entry points defined in the MAP input variable to EN^DIR0. It can be used to change the value of the current answer and the cursor position within the current answer. ******************** 1017 NAME: CALLS TO FILEMAN FOR KIDS CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: OCT 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROMSU Server routine. This call is used during the build and installation of a package. ROUTINE: DIFROMSU COMPONENT: FIA VARIABLES: FILE Type: Input File number INPUT ROOT Type: Input Closed array root which contains a list of field numbers to be exported. TARGET ROO Type: Input Closed array root which will be used to place entries into a FIA structure. ANSWERS Type: Input List of answers, delimited by "^" DD SCREEN Type: Input Screen logic that sets $T DATA SCREE Type: Input Screen logic that sets $T VERSION Type: Input Version number ******************** 1019 NAME: BULLETIN FILE CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: OCT 7,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 3.6 ROOT: XMB(3.6, DESCRIPTION: TYPE: File Kernel Installation and Distributions System needs to update the Bulletin file, 3.6. KIDS needs to extract data from this file during Package transportations. KIDS also needs to update this file during Package installation. ^XMB(3.6, ALL Direct Global R/W & w/ ROUTINE: ******************** 1020 NAME: PBM CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: OCT 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC DESCRIPTION: TYPE: File All the fields are read from the file using Fileman calls, except the P.O. DATE. The P.O. DATE's "AB" cross reference is used for sorting purposes. ^PRC(442,D0,0) 1 FCP 0;3 Read w/Fileman .01 PURCHASE ORDER NUMBE 0;1 Read w/Fileman 2 COST CENTER 0;5 Read w/Fileman ^PRC(442,D0,2,D1,0) 3 UNIT OF PURCHASE 0;3 Read w/Fileman 5 ACTUAL UNIT COST 0;9 Read w/Fileman 3.1 PACKAGING MULTIPLE 0;12 Read w/Fileman 9.5 NSN 0;13 Read w/Fileman 9.3 NATIONAL DRUG CODE 0;15 Read w/Fileman 40 ITEM 0 Read w/Fileman .01 LINE ITEM NUMBER 0;1 Read w/Fileman 1.5 ITEM MASTER FILE NO. 0;5 Read w/Fileman 9 VENDOR STOCK NUMBER 0;6 Read w/Fileman 10 2237 REFERENCE # 0;10 Read w/Fileman 2 Quantity 0;2 Read w/Fileman 3.5 BOC 0;4 Read w/Fileman 5.5 Est. Unit Cost 0;7 Read w/Fileman 3.2 Item Delivery Points 0;8 Read w/Fileman 3.6 Intermediate Product 0;11 Read w/Fileman 9.6 Maximum Order Qty 0;14 Read w/Fileman 9.4 SKU 0;16 Read w/Fileman 9.7 Unit Conversion Fact 0;17 Read w/Fileman ^PRC(442,D0,2,D1,1,D2,0) .01 DESCRIPTION 0;1 Read w/Fileman ^PRC(442,D0,2,D1,2) 11 QUANTITY PREVIOUSLY 0;8 Read w/Fileman ^PRC(442,D0,1) 5 VENDOR 1;1 Read w/Fileman .1 P.O.Date 1;15 Read w/Fileman ^PRC(442,D0,7) .5 SUPPLY STATUS 7;1 Read w/Fileman ROUTINE: ******************** 1021 NAME: D&PPM CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: JUN 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 445 ROOT: PRCP DESCRIPTION: TYPE: File ^PRCP(445,D0,1,D1,0) 50 DISPENSING UNIT 0;28 Read w/Fileman 51 DISPENSING UNIT CONV 0;29 Read w/Fileman ROUTINE: ******************** 1022 NAME: D&PPM CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: OCT 12,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.5 ROOT: PRCD DESCRIPTION: TYPE: File ^PRCD(420.5,D0,0) .01 UNIT OF PURCHASE 0;1 Read w/Fileman ROUTINE: ******************** 1023 NAME: HS Components-PDX Segments CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other As the Health Summary package adds new components to the HEALTH SUMMARY COMPONENT file (#142.1), it will also add those components to PDX's VAQ - DATA SEGMENT file (#394.71). At this time, Health Summary will only add those components that do not have selection items. Health Summary will use the entry point $$ADDSEG^VAQUTL50() to add it's components to the VAQ - DATA SEGMENT file. Health Summary will also use the entry point $$FIRSTUP^VAQUTL50() to check that the component name is in the uppercase/lowercase naming convention used by PDX. As new components are made available to the PDX users, those components will be added to DBIA297-E (816). ROUTINE: VAQUTL50 COMPONENT: $$FIRSTUP(TEXT) VARIABLES: INPUT : TEXT - Text string to convert OUTPUT : Text - Same text string with beginning of every word in uppercase and all other characters in lowercase COMPONENT: $$ADDSEG(HSPTR,MAXTIME,MAXOCCUR) VARIABLES: INPUT : HSPTR - Pointer to HEALTH SUMMARY COMPONENT file (#142.1) MAXTIME - Max time limit allowed for auto processing MAXOCCUR - Max occurrence limit allowed for auto processing OUTPUT : X - Pointer to VAQ - DATA SEGMENT file (#394.71) that was created -1^ErrorText - Entry not created NOTES : If time and/or occurrence limits do not apply to the component, MAXTIME and/or MAXOCCUR are not required. : If time and/or occurrence limits apply to the component, default values will be taken from the VAQ - PARAMETER file (#394.81). If parameter file does not contain these values, a default of 1 year and 10 occurrences will be used. : If a maximum limit is not valid, the default limit will be used. ******************** 1024 NAME: Health Summary to File 40.7 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: HEALTH SUMMARY In the Health Summary component, Clinic Past Visits (CVP), the Clinic Stop is displayed. BENEFICIARY TRAVEL USAGE: Controlled Subscri ENTERED: OCT 17,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File Health Summary accesses file ^DIC(40.7, to display the Name of the Clinic Stop in one of its components. ^DIC(40.7,DO,0) .01 NAME 0;1 Direct Global Read & w This file contains all Clinic Stops and their associated AMIS Stop Code. ROUTINE: ******************** 1027 NAME: DBIA1027 CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: NOV 2,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Health Summary will distribute the routine, VAQUTL50, under the routine GMTSPDXA. If the routine, VAQUTL50, is not on the system where the components are being loaded, Health Summary will load it's routine, GMTSPDXA and rename it to VAQUTL50. ROUTINE: ******************** 1030 NAME: DBIA1030-A CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: VENDOR - AUDIOFAX, INC. VENDOR - TECHPRO SYSTEMS INC USAGE: Controlled Subscri ENTERED: NOV 9,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These entry points can be used to batch process prescriptions received via telecommunications. ROUTINE: PSOBBC COMPONENT: ASK VARIABLES: PSOINST Type: Input This is the site number for the site running the Outpatient Pharmacy package. PSOBBC("QF Type: Both This flag is set equal to 0 as input and equal to 1 as output if an up-arrow is entered or timeout occurs at the Suspense, Inpatient, or Early Refill prompts. PSOBBC("DF Type: Both This flag is set equal to 0 as input and equal to 1 as output if an up-arrow, null, or erroneous data is entered or if timeout occurs at the Fill Date, Mail/Window, or Clerk prompts. PSOBBC("FR Type: Input This must be set equal to REFILL. Otherwise the telephone refills will not be processed. COMPONENT: PROCESSX VARIABLES: PSOBBC("QF Type: Input This flag, if set equal to 1, will result in this entry point being called to queue labels to print and clean up variables. COMPONENT: PT VARIABLES: PSODFN Type: Output This is the pointer to the Patient file for the patient. PSOBBC("DF Type: Both This flag is set equal to 0 as input and equal to 1 as output if the patient is either an Inpatient, Nursing Home Patient, or Deceased. COMPONENT: REFILL VARIABLES: PSOBBC("DO Type: Input This is the internal entry number of the prescription. PSOBBC("DF Type: Both This flag is set equal to 0 as input and to 1 as output if the refill is not successful. COMPONENT: PTC VARIABLES: PSODFN Type: Input This is the pointer to the Patient File for the patient. This value remains unchanged. PSOBBC(DFL Type: Output Upon return from PTC^PSOBBC, the variable PSOBBC("DFLG") will be equal to 1 if the prescription cannot be filled for any of the following 3 reasons. 1)The patient has died. 2)The patient is an inpatient, and inpatient fills are currently not allowed through this process. 3)The patient is in a Contract Nursing Home, and Contract Nursing Home fills are currently not allowed through this process. This entry point does some checks on the patient to see if a prescription can be refilled for this patient. ******************** 1031 NAME: DBIA1031 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: OCT 20,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PDX application is granted permission to use the function call $$LOADXMY^DGSEC() in order to place the mail group contained in the SENSITIVE REC ACCESSED GROUP field (#509) of the MAS PARAMETER file (#43) into the array XMY. Input: None Output: 0 = Successfully created XMY("G.MailGroup")="" where MailGroup is text value of mail group pointed to by field #509 of file #43 -1^ErrorText = Error ROUTINE: DGSEC COMPONENT: $$LOADXMY VARIABLES: ******************** 1032 NAME: DBIA1032 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: OCT 21,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PXPT - PCE Patient/IHS subset package requests persmission to include the routine DPTLK as the LOOK-UP PROGRAM for the Patient/IHS file that is being distributed in the VA for use by PCE. ROUTINE: DPTLK ******************** 1033 NAME: DBIA1033 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: OCT 18,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File Requesting permission to export the Visit File with the release of Visit Tracking V2.0. File Global Number ----- ------ -------- VISIT AUPNVSIT( 9000010 ROUTINE: ******************** 1034 NAME: FILEGRAMS use of MESSAGE file CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: OCT 18,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 21 FILE: 3.9 ROOT: XMB(3.9, DESCRIPTION: TYPE: File VA FileMan looks directly at the MESSAGE file in processing FILEGRAMS. FM is requesting the DBIA for FM Version 21. We will include the migration of the Filegram processor to use the SERVER protocol to our V22 to-do-list; it will then be prioritized along w/ the n number of things already planned for V22. ^XMB(3.9,D0,0) In ^DIFGO we display the subject online from the 0 node of message file ^XMB(3.9,D0,2,D) In ^DIFGO we $O through the text lines in the message at one place to display the text, and in another place to process the Filegram contents. ROUTINE: ******************** 1036 NAME: DBIA1036 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 17,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.8 ROOT: PSD(58.8 DESCRIPTION: TYPE: File Instead of collecting dispensing by looping through the "AL", "AJ", "AM", and "AN" x-refs in the outpatient ^PSRX( global, the dispensing data will be stored on a daily basis in ^XTMP("PSA",. If the Drug Acct. background job is not scheduled, the Outpatient routine will not update ^XTMP("PSA",. If it is scheduled and a Drug Acct. Location for that Outpatient Division is tracking the drug being released or returned to stock, a cumulative total will be updated in ^XTMP("PSA",DIVISION,DRUG,DT). The Drug Acct. background job is intended to be run nightly and will loop thru ^XTMP("PSA", updating Drug Acct. files and then killing off that node in ^XTMP("PSA",. When the job completes, ^XTMP("PSA",0) is updated. This file agreement supports Outpatient direct global reads to ^PSD(58.8, and direct writes to ^XTMP("PSA", in routines PSODISP* and PSORESK*. ^PSD(58.8,'AOP', 20 OUTPATIENT SITE 0;10 Direct Global Read & w ^PSD(58.8,D0,1,D1) 10 DRUG Direct Global Read & w ROUTINE: ******************** 1037 NAME: DBIA1037 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: OCT 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The PCE Patient/IHS Subset (PXPT) package request permission to directly access the zeroth node of the ^DPT global for the PATIENT MERGED TO field. This field is checked in screening logic on the PATIENT/IHS file. This field is used by IHS in their PATIENT MERGE application. By documenting this dependency on the PATIENT MERGE TO field by IHS, this agreement serves to show a current dependency based on Joint Sharing of the Patient File (2) and the Patient/IHS file (9000001). The Patient/IHS file is distributed in the VA by the PCE Patient/IHS Subset (PXPT) package. When the VA determines how it will use the PATIENT MERGE TO field, a modification to this agreement may be needed. ^DPT(D0,0) .082 PATIENT MERGED TO 0;19 Direct Global Read & w ROUTINE: ******************** 1038 NAME: DBIA1038-A CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: OCT 27,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.4 ROOT: PS(59.4, DESCRIPTION: TYPE: File Controlled Substances Version 2.0 exports field #31 from INPATIENT SITE file #59.4. Inpatient Medications will remain custodian of the file and will provide clean up of fields * for deletion in Version 5.0. At that time, Controlled Substances will become custodian of this File 59.4. ^PS(59.4,D0,0) 31 IS SITE SELECTABLE F 0;31 Direct Global R/W & w/ Should this site name be shown for use by the Controlled Substances module of the Pharmacy software? If you answer "YES", the software will display or allow you to pick this site name for Controlled Substances. If you answer "NO", the software will screen out the site name so that CS users will not see or be able to select the site name while in the CS package. ROUTINE: ******************** 1039 NAME: DBIA1039 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: OCT 24,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File The PCE Patient/IHS Subset (PXPT) package requests permission to directly access the Institution file. This direct access is needed to setup the IHS Location file (9999999.06), which is DINUMed to the Institution File. The Location file is distributed by the PXPT package to support the Visit file and Problem List files which are jointly shared files between the VA and IHS. The direct access is referencing the internal entry number, without actually looking at any fields in the Institution file. ^DIC(4,D0) ROUTINE: ******************** 1040 NAME: LIST INDEX OF MESSAGE RESPONSES CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 24,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API may be called in a roll and scroll mode to list the responses of a message. ROUTINE: XMAH COMPONENT: ENT8 VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file (#3.9) of the message for which the response index should be displayed. Display an index of the responses to a message. The index is either in forward or reverse order, depending on personal preference. The index includes the response number, the date of the response, the sender of the response, and the number of lines in the response. (The index is exactly what one would see in MailMan upon responding with "??" to the prompt: "Backup to which response?") Usage: S XMZ=Message IEN D ENT8^XMAH Example: S XMZ=100328 D ENT8^XMAH There are 3 responses. Response 0 is the original message. Response.....From...........Lines 3) 13 May 99 USER,TWO 6 2) 27 Apr 99 USER,ONE 3 1) 21 Apr 99 USER,TWO 3 0) 07 Apr 99 USER,ONE 1 ******************** 1043 NAME: DBIA1038-B CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: OCT 27,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.4 ROOT: PS(59.4, DESCRIPTION: TYPE: File Controlled Substances Version 2.0 utilizes INPATIENT SITE file #59.4 to distinguish which sites are flagged for CS use. Inpatient Medications will remain custodian of the file and will provide clean up of fields * for deletion in Version 5.0. At that time, Controlled Substances will become custodian of this File 59.4. ^PS(59.4,D0,0) .01 NAME 0;1 Direct Global Read & w 31 IS SITE SELECTABLE F 0;31 Direct Global Read & w ROUTINE: ******************** 1044 NAME: DBIA1044 CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: OCT 27,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Visit Tracking V2.0 request permission to export the AUPNVSIT routine. ROUTINE: AUPNVSIT ******************** 1045 NAME: DBIA1045 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION NAT'L DB USAGE: Private ENTERED: OCT 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 355.1 ROOT: IBE(355.1 DESCRIPTION: TYPE: File IVM Center software utilizes the Type of Plan File (#355.1) to correctly categorize insurance policies identified through the IVM verification process. The type of plan (derived from file 355.1) is transmitted from the IVM Center database via HL7 IN1 (Insurance) Segment to DHCP facilities for insurance policies identified for veterans. The Type of Plan file is pointed to by an IVM specific file (IVM Verified Insurance - #300.122) -- local entries are not added (file 355.1 is utilized for reference purposes only). ^IBE(355.1,D0,0) => 1st piece .01 NAME 0;1 Direct Global Read & w Standard types of plans that an insurance company may provide. ROUTINE: ******************** 1046 NAME: DBIA1046 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION NAT'L DB REGISTRATION BENEFICIARY TRAVEL Checking the last Means test or RX Copay Test is within the last 365 days and if so displaying the income on the Bene Travel screen. It is also used as one of the factors in whether or not the patients Bene Travel copay is waived. USAGE: Controlled Subscri ENTERED: OCT 28,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function returns the value of various VA pension rates. These values are date sensitive and vary depending upon the number of dependents that a veteran has. These pension values are compared with the veteran's income to determine the veteran's eligibility for the medication copayment. This function is used primarily as an internal utility for Integrated Billing during the process of determining a veteran's medication copayment exemption status, but is also accessible to a limited number of applications for the purpose of accessing and displaying these values as they would apply to a specific veteran. ROUTINE: IBARXEU1 COMPONENT: $$THRES(DATE,TYPE,DEPEND) VARIABLES: DATE Type: Input This variable contains the date, in internal FileMan format, on which the requested rate must be effective. TYPE Type: Input This variable describes the type of pension for which a value is requested. The value of this variable must equal one of the two following codes: 1 = Basic Pension 2 = Pension plus Aid & Attendance DEPEND Type: Input This variable contains the number of dependents that a veteran can claim. OUT Type: Output The output of this function is of the form 1^2^3, where: 1 = Pension Rate. This is the pension rate of the required type on the requested date, taking into account the number of dependents that the veteran has. This value will be null if a rate cannot be determined. 2 = Effective Date. This is the date on which the pension rate returned above initally became effective. 3 = Prior Year Date. This value is optionally returned. If the Effective Date of the pension rate is over one year in the past, this date is returned as the Prior Year Date to indicate that the pension rate has been effective for over a year and may no longer be the most current rate. This function is used to retrieve a specific type of VA pension value based upon an effective date and the number of dependents that the veteran can claim. ******************** 1049 NAME: PNs use of Security Key file (19.1) CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: NOV 4,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.5 FILE: 19.1 ROOT: DIC(19.1 DESCRIPTION: TYPE: File Progress Notes is adding field #.05 SECURITY KEY to the GENERIC PROGRESS NOTE TITLE file (121.2). This field will point to the SECURITY KEY file (19.1) This is being done to implement functionality requested in E3R 4858 and will be exported in patch GMRP*2.5*29. Many services use the Progress Notes package. Sites will now have the option to restrict entering of new Progress Notes to users that hold the key associated with a particular title. This is accomplished using DIC("S") when creating a new progress note. If a TITLE does not have a security key associated with it, no restriction will apply. This will be particularly useful for sites wanting to control access to the CWAD titles; Crisis Note, Clinical Warning, and Advance Directive. Any existing security key may be used to lock any title. It is entirely at the sites' discretion. This will not in any way impact the display or printing of any notes. The SECURITY KEY field (#.05) entry in GENERIC PROGRESS NOTE TITLE file (121.2) may be edited at any time. This can be accomplished by using the 'GMRPN TITLE MGMT MENU' option. The next version of Progress Notes will utilize the TIU (Text Integration Utility) which will inlude the ASU (Authorization/Subcription Utility). The use of the SECURITY FIELD will no longer be necessary at this time. ROUTINE: ******************** 1050 NAME: DBIA909-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE CONTROLLED SUBSTANCES USAGE: Private ENTERED: JUL 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File The laboratory LMIP reports require that workload data be collected based on Facility Treating Specialty #45.7 and Specialty #42.4. We determine this information by looking at the ordering location. We are asking permission to read the these files to obtain .01 field and the field #6 CDR ACCOUNT field for certain reports. The logic uses the ^SC(X,42) to determine if the location is a ward. If it is the n use the Facility Treating specialty pointers to navigate to the data. See DBIA909-A & DBIA909-C. The laboratory package also needs to access the ACTIVE status of the entries in the SPECIALTY file (#42.4). This will be done using direct access via the "ADATE" cross reference of the EFFECTIVE DATE multiple field and extracting the data from the 0-node of the EFFECTIVE DATE multiple. The call will be to ACTV^LRJSDX with the ien of the entry in file 42.4 and optionally an 'as of' date passed into it. ^DIC(42.4,D0,0) .01 NAME 0;1 Direct Global Read & w Obtain name or Specialty 3 SERVICE 0;3 Direct Global Read & w Obtain location's service designation. 5 BILLING RATE BEDSECT 0;5 Direct Global Read & w Obtain location's billing section designation 6 CDR ACCOUNT 0;6 Direct Global Read & w Obtain location's CRD ACCOUNT ^DIC(42.4,D1,'E',D0,0) .02 ACTIVE? 0;.02 Direct Global Read & w ^DIC(42.4,D1,'E','ADATE', 10 EFFECTIVE DATE E;0 Direct Global Read & w ROUTINE: ******************** 1051 NAME: DBIA909-C CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File The laboratory LMIP reports require that workload data be collected based on Facility Treating Specialty #45.7 and Specialty #42.4. We determine this information by looking at the ordering location. We are asking permission to read the these files to obtain .01 field and the field #6 CDR ACCOUNT field for certain reports. The logic uses the ^SC(X,42) to determine if the location is a ward. If it is the n use the Facility Treating specialty pointers to navigate to the data. See DBIA909-A & DBIA909-B. ^DIC(42,D0,0) Using the X-reference to determine if the ordering location is in the Ward Location File #42. ROUTINE: ******************** 1052 NAME: DBIA1052-A CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. ROUTINE: DIFROMS COMPONENT: DDOUT VARIABLES: TARGET ROO Type: Input Closed array reference where the data will be stored. COMPONENT: DDIN VARIABLES: FILE Type: Input File number SOURCE ROO Type: Input Closed array reference where the data will be stored. COMPONENT: DATAOUT VARIABLES: TARGET ROO Type: Input Closed array reference where the data will be stored. COMPONENT: DATAIN VARIABLES: FILE Type: Input File number SOURCE ROO Type: Input Closed array reference where the data will be stored. ******************** 1053 NAME: DBIA1052-B CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. ROUTINE: DIFROMSO COMPONENT: EDEOUT VARIABLES: FILE Type: Input File number IEN Type: Input Internal entry number to export PKGNAME Type: Input Package name ******************** 1054 NAME: DBIA1052-C CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. ROUTINE: DIFROMSI COMPONENT: FPRE VARIABLES: FILE Type: Input File number PKGNAME Type: Input Package name COMPONENT: EPRE VARIABLES: FILE Type: Input File number IEN Type: Input Interal entry number on target system PKGNAME Type: Input Package name OLDIEN Type: Input Internal entry number on source system COMPONENT: EPOST VARIABLES: FILE Type: Input File number IEN Type: Input Internal entry number on target system PKGNAME Type: Input Package name ******************** 1055 NAME: DBIA1052-D CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. The DIEZ routine is used to recompile input templates in non-interactive mode. ROUTINE: DIEZ COMPONENT: EN2 VARIABLES: IEN Type: Input Internal entry number on target system RTN Type: Input Routine name ******************** 1056 NAME: DBIA1052-E CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. The DIKZ routine is used to recompile a file's cross-references in non-interactive mode. ROUTINE: DIKZ COMPONENT: EN2 VARIABLES: IEN Type: Input Internal entry number on target system RTN Type: Input Routine name ******************** 1057 NAME: DBIA1052-F CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call the FileMan DIFROM Server routines and Compiler routines. These calls are used to update the Data Dictionaries, Templates, Forms, and Functions at a site during the installation of a package. The DIPZ routine is used to recompile print templates in non-interactive mode. ROUTINE: DIPZ COMPONENT: EN2 VARIABLES: IEN Type: Input Internal entry number on target system RTN Type: Input Routine name ******************** 1058 NAME: DBIA1052-G CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: NOV 7,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel Installation and Distribution System needs to call two undocumented ScreenMan entry points from the 7.5 node of .01 fields of multiples in the Build file. These entry points are used to inform ScreenMan of subrecords that have been added or deleted during the execution of the 7.5 node. ROUTINE: DDSUTL COMPONENT: MLOAD VARIABLES: SOURCE ROO Type: Input Closed root of array that contains the record numbers of subrecords that were added. COMPONENT: MDEL VARIABLES: SOURCE ROO Type: Input Closed root of array that contains the record numbers of subrecords that were deleted. ******************** 1059 NAME: FILE SECURITY CODE ACCESS CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: NOV 8,1994 STATUS: Active EXPIRES: JUN 1,1995 DURATION: Next Version VERSION: 5.3 FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File This integration agreement will allow the MAS package to release a patch to allow sites to review and update file security codes without having to install inits of all files. Due to problems reported in several recent NOIS mesages, we've had cause to review and update our recommended levels of access. We feel this is the best way to get the sites up-to-date. An informal message and a draft copy of the routines has already been submitted to FileMan development for review and concurrence. Our instructions will be that this is a one time only run. No options will be created for this patch. The patch is DG*5.3*49 and is currently under development. We are requesting the ability to view and edit the following nodes in the DIC global: ^DIC(filenum,0,"WR") file write access ^DIC(filenum,0,"DD") file DD access ^DIC(filenum,0,"RD") file read access ^DIC(filenum,0,"DEL") file delete access ^DIC(filenum,0,"LAYGO") file LAYGO access ROUTINE: ******************** 1061 NAME: PATIENT LOOK-UP CALL TO MPR CUSTODIAL PACKAGE: Missing Patient Register SUBSCRIBING PACKAGE: REGISTRATION ORDER ENTRY/RESULTS REPORTING Added OE/RR as subscriber to reflect usage of this ICR effective prior to CPRS v31b. Discovered during ICR review. USAGE: Private ENTERED: NOV 10,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine At the request of the MPR (Missing Patient Register) developer, we have added a call to MPRCHK from the security routine Q+2^DGSEC. ROUTINE: MPRCHK COMPONENT: EN(Y) VARIABLES: Y Type: Input Passed as IEN of PATIENT file. ******************** 1062 NAME: 1062 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: JAN 12,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Kernel Toolkit needs this agreement with Fileman to be able to use the variable D0 in DD definitions. Here are some examples of the use of variable D0. 15,99991 LOOKUP1 ; COMPUTED MUMPS CODE: S X="`"_+^VA(15,D0,0) ALGORITHM: S X="`"_+^VA(15,D0,0) DESCRIPTION: This field is used to navigate to the file pointed to by RECORD1. TECHNICAL DESCR: This field is used to navigate to the file pointed to by RECORD1. 15,99992 LOOKUP2 ; COMPUTED MUMPS CODE: S X="`"_+$P(^VA(15,D0,0),U,2) ALGORITHM: S X="`"_+$P(^VA(15,D0,0),U,2) DESCRIPTION: This field is used to navigate to the file pointed to by RECORD2. TECHNICAL DESCR: This field is used to navigate to the file pointed to by RECORD2. 15,99993 LOOKUP3 ; COMPUTED MUMPS CODE: S X="`"_D0 ALGORITHM: S X="`"_D0 LAST EDITED: AUG 08, 1989 DESCRIPTION: This computed field provides navigational capability to any file that points to this file and has a DINUM relationship. TECHNICAL DESCR: This computed field provides navigational capability to any file that points to this file and has a DINUM relationship. ROUTINE: COMPONENT: D0 VARIABLES: D0 Type: Used This variable is the internal entry number of the current record. ******************** 1064 NAME: DBIA1063-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY DRUG ACCOUNTABILITY USAGE: Controlled Subscri ENTERED: NOV 16,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19.2 ROOT: DIC(19.2 DESCRIPTION: TYPE: File The Drug Acct. background job, PSA IV ALL LOCATIONS is scheduled to run before updating ^XTMP("PSA". ^DIC(19.2,D0,0) 2 QUEUED TO RUN AT WHA 0;2 Direct Global Read & w ROUTINE: ******************** 1067 NAME: Pharmacy Benefits Management CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: NOV 17,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 552.5 ROOT: PSX DESCRIPTION: TYPE: File The Pharmacy Benefits Management package will extract statistical data on a monthly basis from "HOST" CMOP facilities' file ^PSX(552.5,D0,0) .01 FACILITY 0;1 Direct Global Read & w ^PSX(552.5,D0,1,D1,1,D2,1,D3,0) .01 DRUG ID# 0;1 Direct Global Read & w 1 TOTAL ORIGINAL FILLS 0;2 Direct Global Read & w 2 TOTAL REFILLS 0;3 Direct Global Read & w 3 TOTAL COST 0;4 Direct Global Read & w 4 TOTAL QUANTITY 0;5 Direct Global Read & w ROUTINE: ******************** 1069 NAME: DS needs WARD AT DISCHARGE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DISCHARGE SUMMARY USAGE: Private ENTERED: DEC 5,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM DESCRIPTION: TYPE: File Discharge Summary is using the computed field WARD AT DISCHARGE from the PATIENT MOVEMENT FILE in lieu of the location returned in VAIP(17,4) from ^VADPT. DS was having a problem with the value that is returned from VADPT being accurate when the pt was ASIH. The use of this field is being implemented in GMRD*1*2 in rtns GMRDLIBA and GMRDLIBF. ROUTINE: ******************** 1070 NAME: DBIA1070 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package files new Means Tests into the PIMS Means Test module. This routine contains utilities for Means Test processing. ROUTINE: DGMTSCU3 COMPONENT: MT(DGINR,DGMTI) VARIABLES: DGINR Type: Input DGINR is the INCOME RELATION IEN. DGMTI Type: Input DGMTI is the ANNUAL MEANS TEST IEN. This call is used to update the ANNUAL MEANS TEST field in 408.22 with the Means Test IEN. ******************** 1076 NAME: VAUQWK CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: DEC 9,1994 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Quick Lookup for Patient Data. ROUTINE: VAUQWK ******************** 1078 NAME: DBIA1078 CUSTODIAL PACKAGE: PROGRESS NOTES SUBSCRIBING PACKAGE: MENTAL HEALTH This agreement is needed just for the installation of Mental Health V. 5.01. USAGE: Controlled Subscri ENTERED: DEC 9,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.01 FILE: 121 ROOT: GMR DESCRIPTION: TYPE: File Mental Health V. 5.01 requests to change Generic Progress Notes file (#121) field DXLS (#30) variable pointer value to point to the new DSM file (#627.7), instead of the DSM-III-R file (#627.5). ^GMR(121, 30 DXLS GMR(121, Pointed to Diagnosis identified for length of stay Used in the Final Discharge Note Summary. ROUTINE: ******************** 1080 NAME: DBIA1079-B CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: DEC 13,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 55 ROOT: PS( DESCRIPTION: TYPE: File ^PS(55,PATDFN,'P','A',SRCHDT) Used to order through the "A" xref to find RX's ^PS(55,PATDFN,1 1 NARRATIVE Read w/Fileman ROUTINE: ******************** 1087 NAME: DBIA1087 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 13,1994 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.5 FILE: 200 ROOT: VA( DESCRIPTION: TYPE: File Agreement for the Notifications component of OE/RR 2.5 to directly access the global ^VA(200. This includes Read/Delete access to the global. ^VA(200,DUZ,'XQA' ALERT CONTENT/DATA ^VA(200,'AXQA' ALERT CROSS REFERENCE ^VA(200,'AXQAN' ALERT CROSS REFERENCE ROUTINE: ******************** 1088 NAME: DBIA1088 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: APR 4,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When running CMOP and NDF software, NDF has a hook into CMOP in the Rematch/Match Single Drug option. If a drug has been marked to transmit to CMOP through the CMOP package and an individual wants to rematch it, the software will display a message telling the user that it is matched and marked for CMOP. If the user chooses to rematch, the software will kill off the match, unmark it to transmit CMOP. The entry point is REMTCH^PSNHELP. This entry point sets the variable +Y equal to the variable DA. It then calls the CMOP routine PSXREF. This routine sets the proper information into a CMOP activity log multiple in file 50 (subfile 50.0214). In addition, when the software marks or unmarks a drug, it sets field 213 "CMOP DISPENSE" in 50 to a "1" for mark and a "0" for unmark. This field also belongs to CMOP. File 50 is a shared pharmacy file. Each module owns different fields and nodes in this file. ROUTINE: PSXREF COMPONENT: PSXREF VARIABLES: DA Type: Input ******************** 1089 NAME: Supported Option File Routines CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 9,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the entry points supported by the Generic Code Sheet package. For more information on using the supported references, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSCALL COMPONENT: CREATE VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Create a Code Sheet Use the OPTION file #19 ENTRY ACTION to call this option using the label 'CREATE' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D CREATE^GECSCALL COMPONENT: KEY VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Keypunch a code sheet Use the OPTION file #19 ENTRY ACTION to call this option using the label 'KEY' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D KEY^GECSCALL COMPONENT: EDITCOD VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Code Sheet Edit Use the OPTION file #19 ENTRY ACTION to call this option using the label 'EDITCOD' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D EDITCOD^GECSCALL COMPONENT: BATCH VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Batch Code Sheets Use the OPTION file #19 ENTRY ACTION to call this option using the label 'BATCH' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D BATCH^GECSCALL COMPONENT: EDITBAT VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Batch Edit Use the OPTION file #19 ENTRY ACTION to call this option using the label 'EDITBAT' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D EDITBAT^GECSCALL COMPONENT: DELCODE VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Delete Code Sheet Use the OPTION file #19 ENTRY ACTION to call this option using the label 'DELCODE' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D DELCODE^GECSCALL COMPONENT: RETRAN VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Mark Batch for Retransmission Use the OPTION file #19 ENTRY ACTION to call this option using the label 'RETRAN' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D RETRAN^GECSCALL COMPONENT: REBAT VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Mark code Sheet for Rebatching Use the OPTION file #19 ENTRY ACTION to call this option using the label 'REBAT' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D REBAT^GECSCALL COMPONENT: REVCODE VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Review Code Sheet Use the OPTION file #19 ENTRY ACTION to call this option using the label 'REVCODE' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D REVCODE^GECSCALL COMPONENT: TRANS VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Transmit Code Sheets Use the OPTION file #19 ENTRY ACTION to call this option using the label 'TRANS' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D TRANS^GECSCALL COMPONENT: RBATWA VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Batches Waiting to be Transmitted. Use the OPTION file #19 ENTRY ACTION to call this option using the label 'RBATWA' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D RBATWA^GECSCALL COMPONENT: RCODEBA VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Code Sheets Ready for Batching Use the OPTION file #19 ENTRY ACTION to call this option using the label 'RCODEBA' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D RCODEBA^GECSCALL COMPONENT: RSTATUS VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Status of all Batches Use the OPTION file #19 ENTRY ACTION to call this option using the label 'RSTATUS' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D RSTATUS^GECSCALL COMPONENT: PURGE VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Purge Transmission Records/Code Sheets Use the OPTION file #19 ENTRY ACTION to call this option using the label 'PURGE' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D PURGE^GECSCALL COMPONENT: STACRETR VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Retransmit Stack File Document Use the OPTION file #19 ENTRY ACTION to call this option using the label 'STACRETR' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D STACRETR^GECSCALL For Version 2.0, the only "batch name" which uses the stack file, and therefore this option is FINANCIAL MANAGEMENT. COMPONENT: STACSTAT VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. Stack Status Report Use the OPTION file #19 ENTRY ACTION to call this option using the label 'STACSTAT' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D STACSTAT^GECSCALL For Version 2.0, the only "batch name" which uses the stack file, and therefore this option is FINANCIAL MANAGEMENT. COMPONENT: COMMENT VARIABLES: GECSSYS Type: Input Set the GECSSYS variable to the name of the batch type from the GENERIC CODE SHEET BATCH TYPE file #2101.1. User Comments Use the OPTION file #19 ENTRY ACTION to call this option using the label 'COMMENT' in the 'GECSCALL' routine as follows: S GECSSYS="batch name" D COMMENT^GECSCALL For Version 2.0, the only "batch name" which uses the stack file, and therefore this option is FINANCIAL MANAGEMENT. ******************** 1090 NAME: DBIA1090 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: DEC 14,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Medicine developers and the Consult/Request Tracking developers have agreed to remove the GMRCACT NEW PATIENT protocol (child) as an item from the GMRCACTM MEDICINE PKG MENU protocol (parent) in the Consult/ Request Tracking package. The functionality provided in the GMRCACT NEW PATIENT protocol as an item in the GMRCACTM MED PKG MENU is not appropriate within the defined context of the Medicine package and removing this item will ensure that users are not prompted twice for selecting a patient. The routine MCFIXOEP, has been developed and will be included in the pre-installation process for Medicine V2.2 which will remove the protocol item. The Consult/Request Tracking developers will remove the GMRCACT NEW PATIENT protocol item from future versions of Consults. ROUTINE: ******************** 1091 NAME: DBIA316-C CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: JAN 5,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 7.3 FILE: ROOT: DESCRIPTION: TYPE: Other Multi Term Lookup (a component of TOOLKIT) requests the ability to read the "GL" node of ^DIC in order to retrieve a global root. This reference can be found in the routines XTLKEFOP, XTLKKWL, XTLKMGR, XTLKPRT and in the MUMPS X-REF of file 8984.3: CROSS-REFERENCE: 8984.3^AC^MUMPS 1)= I $D(^XT(8984.3,DA,0)),$P(^(0),U,2)'="" S J L=$P(^(0),U,2),JL=$P(^DIC(JL,0,"GL"),U,2),^XT(8 984.3,"AC",JL,$E(X,1,30),DA)="" K JL 2)= I $D(^XT(8984.3,DA,0)),$P(^(0),U,2)'="" S J L=$P(^(0),U,2),JL=$P(^DIC(JL,0,"GL"),U,2) K ^XT (8984.3,"AC",JL,$E(X,1,30),DA),JL Associates the synonym with the global root of the lookup file. ***** Amendment 1/23/95 ***** The above request should be modified to include both Multi-Term Lookup and the Duplicate Resolution modules of Toolkit. The 'GL' node is referenced for the same purpose in file 15.1, field .01, "AGL" x-reference. ROUTINE: ******************** 1092 NAME: Use of Spooler by Health Summary CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: HEALTH SUMMARY NETWORK HEALTH EXCHANGE PATIENT DATA EXCHANGE USAGE: Controlled Subscri ENTERED: DEC 20,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The API for PDX to request Health Summary data functions by Spooling Health Summary output into a SPOOL DOCUMENT and transfering the resulting data from ^XMBS(3.519, into an array (usually ^TMP) named by the calling application. This was necessary, given the current design of Health Summary, and the absence of HFS space on the 486 systems. To be portable, the most practical means of generating ASCII output to a MUMPS global was to use the Spooler. To that end, Health Summary requests permission to make direct reference to the SPOOL DOCUMENT (^XMB(3.51,) and SPOOL DATA (^XMBS(3.519,) files to evaluate the status of the Spool Document, and to transfer the resulting text to the target array respectively. We also call the entry points DSD^ZISPL and DSDOC^ZISPL to delete the SPOOL DATA and SPOOL DOCUMENT records once the transfer is successfully completed until otherwise specified. ROUTINE: ZISPL COMPONENT: DSDOC VARIABLES: Deletes Spool Document file entry following transfer of data, to minimize consumption of disk space. COMPONENT: DSD VARIABLES: Deletes Spool Data file entry following transfer of data, to minimize consumption of data. ******************** 1093 NAME: DBIA1093-A CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: DEC 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a request for an integration agreement between GECS and PIMS. With the changes made in GECS V2.0, the calls made from PIMS no longer were available. The call to GETMAP^GECSXMAP( ) will return variable GECSMAP( ) containing the fields in the GENERIC CODE SHEET file (#2100) that are associated with the code sheet selected. ROUTINE: GECSXMAP COMPONENT: GETMAP VARIABLES: GECSMAP Type: Used Contains the fields used in the associated code sheet, among other things. Returns GECSMAP containing the fields used in the associated code sheet, among other things. ******************** 1094 NAME: DBIA1093-B CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: DEC 22,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2100 ROOT: GECS DESCRIPTION: TYPE: File This is a request for an integration agreement between GECS and PIMS. PIMS will be making references to files in GECS and a print template. This integration agreement will formalize references that have been included in PIMS in the past, and modified to incorporate the changes in GECS V2.0. ^GECS(2100 7 TRANSACTION/TYPE SEG PIECE 8, Direct Global Read & w Type of code sheet 51 KEYPUNCH CODE SHEET "KEY", 0 Direct Global Read & w signals keypunch code sheet 9.1 AMIS MONTH/YEAR PIECE 9, Read w/Fileman AMIS month/year for code sheet Generic Code Sheet File. This file is used to store the fields and data which make up the actual codesheet. ^GECS(2101.2 #.5 EDIT TEMPLATE PIECE 3, Direct Global Read & w CONTAINS EDIT TEMPLATE, NEEDED FOR CALL TO GECS ROUTINE. .01 NAME PIECE 1, Direct Global Read & w "B" Cross reference of the name field. .5 Read w/Fileman GENERIC CODE SHEET TRANSACTION TYPE/SEGMENT FILE. This file stores the different types of code sheets used for each type of batch (in file 2101.1). ^DD(2100 Data dictionary of 2100 to access field names for display. ROUTINE: ******************** 1095 NAME: DBIA1095 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: DEC 29,1994 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Controlled Substances Version 2.0 utilizes three security keys exported by the Inpatient Medications software. The keys are used, within Inpatient Meds, to identify the user of the package. The same use is requested by Controlled Substances. The PSJ RPHARM key identifies a pharmacist, the PSJ RNURSE key identifies a nurse, and the PSJ PHARM TECH key identifies a pharmacy technician. These same identifications are used in the Controlled Substances package. ROUTINE: ******************** 1096 NAME: PATIENT MOVEMENT file cross reference CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE CLINICAL PROCEDURES ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS DIETETICS VA POINT OF SERVICE (KIOSKS) VPS 1*15, After Visit Summary (AVS) integration has a need to read the ATID1 cross reference of the Patient Movement field #405 to return the admission for an identified patient to AVS. VPS 1*15 AVS integration is planned for release in March 2015. USAGE: Controlled Subscri ENTERED: JAN 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Patient Movement file (#405) - The "ATID1" xref.of the Patient Movement file. This is to order through admissions in inverse date order. ^DGPM( The "ATID1" xref.of the Patient Movement file. This is to order through admissions in inverse date order. ROUTINE: ******************** 1097 NAME: Lookup on Facility Movement file CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JAN 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.1 ROOT: DG(405.1 DESCRIPTION: TYPE: File - A lookup on the FACILITY MOVEMENT TYPE file (#405.1) for discharge types with a screen that utilizes the "AM" Xref of the FACILITY MOVEMENT TYPE file (#405.1) and the fourth piece, the 'ACTIVE' field, on the zero node. The 'AM' cross reference will be $O through to search for active facility movement types. - Global read access to the FACILITY MOVEMENT TYPE file (#405.1) the second piece of the zero node the TRANSACTION TYPE field to identify discharge types. ^DG(405.1,0) .02 TRANSACTION TYPE 2 Read w/Fileman .03 MOVEMENT TYPE 3 Read w/Fileman Use of the "AM" cross reference on this field. ROUTINE: ******************** 1098 NAME: GENERAL LOOKUP CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JAN 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.2 ROOT: DG(405.2 DESCRIPTION: TYPE: File The AMIE software will perform a FM lookup on the MAS MOVEMENT file (#405.2) in order to create and display a list of movement types. No pointer values will be stored as part of the AMIE database. ROUTINE: ******************** 1099 NAME: LOOKUP on MAS MOVEMENT TRANSACTION TYPE file CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JAN 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.3 ROOT: DG(405.3 DESCRIPTION: TYPE: File The AMIE software will perform a FM lookup on the MAS MOVEMENT TRANSACTION TYPE file (#405.3) in oder to check for a specific transaction type and gather its internal file number. This value will be used for comparison during the processing of records. This value will not be stored as part of the AMIE database. ROUTINE: ******************** 1100 NAME: DISPOSITION NODE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: JAN 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Global read access to the "DIS" node of the PATIENT file, to look at the STATUS field. ^DPT(2,DFN,DIS .01 LOG IN DATE/TIME 0;1 Read w/Fileman ROUTINE: ******************** 1106 NAME: EEO/PAID - QAQ ADHOC REPORT CUSTODIAL PACKAGE: QUALITY ASSURANCE INTEGRATION SUBSCRIBING PACKAGE: EEO COMPLAINT TRACKING PAID USAGE: Controlled Subscri ENTERED: JAN 9,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Equal Employment Opportunity Complaint Tracking version 2.0 (EEO) will be referencing the routine ^QAQAHOC0 from within the routine ^EEOEAHOC. The neccessary QAQ* variables will be set for this call after establishing the existance of the routine ^QAQAHOC0. This reference will provide the EEO user with flexible report generation capabilities. PAID version 4.0 will be referencing the routine ^QAQAHOC0 from within routines PRSDAH1, PRSDAH2, PRSDAH3 and PRSDAH4. The neccessary QAQ* variables will be set for this call after establishing the existance of the routine ^QAQAHOC0. This reference will provide the PAID user with flexible report generation capabilities. ROUTINE: QAQAHOC0 COMPONENT: QAQAHOC0 VARIABLES: QA Type: Input Incremental variable. QAQDIC Type: Input File number of the file to print from. QAQFOUND Type: Input Variable set to determine if any data was found for the print. QAQMRTN Type: Input Entry point to setup the QAQMENU array (format TAG^ROUTINE). QAQORTN Type: Input Entry point to set up other VA FileMan EN1^DIP variables, i.e. DCOPIES, DHD , DHIT, DIOBEG, DIOEND, DIS(), IOP. QAQMHDR Type: Input Text to be used as a header at the top of sort/print menu screens. Maximum of 45 characters. QAQMENU Type: Input Array containing sort, menu text, field, and sort from/to range information. Type: QAQMMAX Type: Input Variable for determining maximum number of choices appearing on AD HOC menus only neccessary for older versions of QA Integration Module. Ad Hoc Report main driver routine. ******************** 1107 NAME: GECSENTR reference CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 10,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the GECSENTR reference supported by the Generic Code Sheet package. For more information on using the supported reference, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSENTR COMPONENT: GECSENTR VARIABLES: GECS(STRIN Type: Input This variable stores the data to be mapped into the input template. The data is delimited by the '^' (up-arrow). The GECSENTR routine will $Order through the GECS("STRING",i) array starting with i=. Therfore, when building this array, the value of 'i' must start with 0 and count up. This variable is required. GECS(TTF) Type: Input This variable must be set to the GENERIC CODE SHEET TRANSACTION TYPE/SEGMENT File (#2101.2) entry (.01 field). The GECSENTR routine will lookup on the 'B' cross-reference in file 2101.2 using the GECS("TTF") variable. This variable is required. GECS(SITEN Type: Input This variable GECS("SITENOASK") can be set to the station number which is generating the code sheet. This variable is optional. If it is not passed and there is more than one entry in the GENERIC CODE SHEET SITE File (#2101.7), the user will be prompted to select the station. GECSSYS Type: Input This variable must be set to the GENERIC CODE SHEET BATCH TYPE File (#2101.1) entry (.01 field). The GECSENTR routine will lookup on the "B" cross-reference in file 2101.1 using the GECSSYS variable. This variable is required. GECSAMIS Type: Input This variable can be set to the amis month year in the internal format YYYMM00. For example, December 1994 would be passed as 2941200. This variable is optional. GECSAUTO Type: Input This variable can be set to "BATCH" or "SAVE". If this variable is set to "BATCH", the GECSENTR routine will automatically mark the code sheet for batching without asking the user. If this variable is set to "SAVE", the GECSENTR routine will automatically save the code sheet for editing at a later time by the user. This variable is optional. If this variable is not passed or is set to a value different from "BATCH" and "SAVE", the user will be prompted to select the status of the code sheet. The routine GECSENTR can be called to automatically build a code sheet by stuffing the data into the GENERIC CODE SHEET File (#2100). It will take the data in the GECS("STRING",i) array and map it to the input template, thus building the code sheet. ******************** 1108 NAME: FMS code sheets CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP ACCOUNTS RECEIVABLE ENGINEERING USAGE: Controlled Subscri ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the routine used by IFCAP/AR and ENGINEERING to build and transmit the Financial Management System (FMS) code sheets. For more information regarding the use of this routine, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSUFMS COMPONENT: CONTROL VARIABLES: 1 Type: Input The system creating the FMS code sheet: A for accounts receivable; I for IFCAP; E for Engineering; C for manual create a code sheet. This variable is required and must be passed as the first parameter. 2 Type: Input The 3 digit station number. This variable is required and must be passed as the second parameter. 3 Type: Input The source document number creating the code sheet prefixed with the station number. This variable is required and must be passed as the third parameter. 4 Type: Input The transaction code, 2 alpha characters. This variable is required and must be passed as the fourth parameter. 5 Type: Input The security code, from 1 to 4 characters. This variable is required and must be passed as the fifth parameter. 6 Type: Input A flag to indicate if its a modification document. Pass a 1 for a modification document, 0 otherwise. This variable is required and must be passed as the sixth parameter. 7 Type: Input A flag to indicate if the FMS code sheet has already updated the IFCAP fund control point balance. Pass a Y if the transaction has updated the IFCAP fund control point balance. This variable is required and must be passed as the seventh parameter. 8 Type: Input The description of the calling program which created the code sheet. The description will be displayed to the user when printing the Stack Status Report. This variable is required and must be passed as the eighth parameter. GECSFMS(CT Type: Output The variable GECSFMS("CTL") will be returned as the control segment. GECSFMS(BA Type: Output The variable GECSFMS("BAT") will be returned as the modification segment. GECSFMS(DO Type: Output The variable GECSFMS("DOC") is returned as the document and 1 segment. GECSFMS(DA Type: Output The variable GECSFMS("DA") is returned as the internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry which was added. This entry point is provided for IFCAP to build the FMS control segments CTL, BAT, DOC, and 1 where is the transaction class segment. The entry point will format the segments and add the segments to the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: DO CONTROL^GECSUFMS(1,2,3,4,5,6,7,8) where the variables 1, 2, 3, 4, 5, 6, 7, 8 must be passed by the calling program. ******************** 1111 NAME: 1111 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: JAN 10,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Kernel Toolkit files have a number of fields whose screens, input transforms, and executable helps contain code that directly references ^DD. ^DD(15,.01,'V','B') This node is used in the input transform and in the screen of the DUPLICATE RESOLUTION FILE 15.1. It's used in a variable pointer type field to restrict the user to only those files which have been set up for the merge. ^DD(FILE,FIELD) These global references are used in displaying the fields that can be compared and assigned a matching value. The 0 node of the field is referenced in order to screen out 'computed' and 'multi-valued' fields from this display and comparison. One use of these references can be seen in the executable help of field .05, FIELD TO BE CHECKED. ^DD(FILE,FIELD,0) These global references are used in displaying the fields that can be compared and assigned a matching value. The 0 node of the field is referenced in order to screen out 'computed' and 'multi-valued' fields from this display and comparison. One use of these references can be seen in the executable help of field .05, FIELD TO BE CHECKED. ROUTINE: ******************** 1112 NAME: PATIENT TYPE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE SCHEDULING FEE BASIS CLAIMS SYSTEM ADDED 12/11/2008 USAGE: Controlled Subscri ENTERED: JAN 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 391 ROOT: DG( DESCRIPTION: TYPE: File Read access to the following global and cross reference is being requested. The file in question is Type of Patient (391) the zero node first piece, as well as the "B" cross reference. The AMIE package needs this information when transferring 2507 requests. Internal entry numbers are not used during the transfer, only external values. ^DG(391,,0) .01 NAME 0;1 Read w/Fileman This is the name field in this file. ROUTINE: ******************** 1113 NAME: 1113 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: JAN 10,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.4 ROOT: DIC( DESCRIPTION: TYPE: File Kernel Toolkit needs this agreement with Kernel to reference ^DIC(9.4 ^DIC(9.4,D0,20,D1,0) 3 NAME OF MERGE ROUTIN 0;3 Direct Global Read & w ^DIC(9.4,D0,20,D1,1) ^DIC(9.4,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 1114 NAME: FMS code sheets CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP AR (ACCOUNTS RECEIVABLE) ENGINEERING ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the routine used by IFCAP/AR and Engineering to build and transmit the Financial Management System (FMS) code sheets. For more information regarding the use of this routine, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSUFM1 COMPONENT: REBUILD VARIABLES: 1 Type: Input The internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry to be rebuilt. This variable is required and must be passed as the first parameter. 2 Type: Input The system creating the FMS code sheet; A for accounts receivable; I for IFCAP; E for Engineering; C for manual create a code sheet. This variable is required and must be passed as the second parameter. 3 Type: Input The security code, from 1 to 4 characters. This variable is required and must be passed as the third parameter. 4 Type: Input A flag to indicate if the FMS code sheet has already updated the IFCAP fund control point balance. Pass a Y if the transaction has updated the IFCAP fund control point balance. This variable is required and must be passed as the fourth parameter. 5 Type: Input The description of the calling program which created the code sheet. The description will be displayed to the user when printing the Stack Status Report. This variable is required and must be passed as the fifth parameter. GECSFMS(CT Type: Output The variable GECSFMS("CTL") will be returned as the rebuilt control segment. GECSFMS(BA Type: Output The variable GECSFMS("BAT") will be returned as the rebuilt modification segment. GECSFMS(DO Type: Output The variable GECSFMS("DOC") will be returned as the rebuild document and 1 segment. This entry point is provided for IFCAP to rebuild the FMS control segments CTL, BAT, DOC, and 1 where is the transaction class segment. The entry point will format the segments, remove the existing code sheet, and add the rebuilt segments to the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: DO REBUILD^GECSUFM1(1,2,3,4,5) where the variables 1, 2, 3, 4, 5 must be passed by the calling program. ******************** 1115 NAME: FMS code sheets CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP ACCOUNTS RECEIVABLE ENGINEERING USAGE: Controlled Subscri ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the routine used by IFCAP/AR and Engineering to build and transmit the Financial Management System (FMS) code sheets. For more information regarding the use of this routine, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSSTAA COMPONENT: SETCS VARIABLES: 1 Type: Input The internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry. This variable is required and must be passed as the first parameter. 2 Type: Input The data to be added to the code sheet. This variable is required and must be passed as the second parameter. This entry point is provided for IFCAP to store the FMS segments in the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: DO SETCS^GECSSTAA(1,2) where the variables 1, 2 must be passed by the calling program. COMPONENT: SETSTAT VARIABLES: 1 Type: Input The internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry. This variable is required and must be passed as the first parameter. 2 Type: Input The status of the entry. Select Q for queued for transmission; M for marked for transmission. If marked for transmission, transmission will be immediate. This variable is required and must be passed as the second parameter. This entry point is provided for IFCAP to set the status of the FMS code sheets in the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: DO SETSTAT^GECSSTAA(1,2) where the variables 1, 2 must be passed by the calling program. COMPONENT: SELECT VARIABLES: 1 Type: Input Optional screen on transaction types. Pass the selectable transaction types using the ^ delimiter, or null to select all transaction types. This variable is required and must be passed as the first parameter. 2 Type: Input Optional screen on the station number. Pass the selectable station number, or null to select all station numbers. This variable is required and must be passed as the second parameter. 3 Type: Input Optional screen on the status. Pass the selectable status using the ^ delimiter, or null to select all code sheets. This variable is required and must be passed as the third parameter. 4 Type: Input Optional screen which is M code executed when looking up the GENERIC CODE SHEET STACK File (#2100.1) entry. This variable is required and must be passed as the fourth parameter. 5 Type: Input Optional prompt displayed to the user. This variable is required and must be passed as the fifth parameter. Y Type: Output The call will return the internal entry number of the selected GENERIC CODE SHEET STACK File (#2100.1) entry followed by an ^ followed by the .01 stack name. If no selection is made, a zero will be returned. This entry point is provided for IFCAP to select a GENERIC CODE SHEET STACK File (#2100.1) entry. The entry point is called as follows: SET Y=$$SELECT^GECSSTAA(1,2,3,4,5) where the variables 1, 2, 3, 4, 5 must be passed by the calling program. ******************** 1116 NAME: FMS code sheets CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the routine used by IFCAP/AR to build and transmit the Financial Management System (FMS) code sheets. For more information regarding the use of this routine, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSSDCT COMPONENT: SETCODE VARIABLES: 1 Type: Input The internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry. This variable is required and must be passed as the first parameter. 2 Type: Input The M code label^routine which will be executed when processing the accept/reject server message. It should be in the form 'DO LABEL^ROUTINE'. When LABEL^ROUTINE is called, it will use parameter passing and pass the following variables: 1 The FMS document number which is the .01 entry in the GENERIC CODE SHEET STACK File (#2100.1); 2 A flag to indicate if the code sheet was accepted or rejected. Pass A for accepted, or R for rejected. Also, if the code sheet is rejected, the reject message will be stored in TMP($J,"GECSSDCT",linenumber,0). This entry point is provided for IFCAP to set the GENERIC CODE SHEET STACK File (#2100.1) M code which will be executed when the code sheet is accepted or rejected by FMS in Austin. The entry point is called as follows: DO SETCODE^GECSSDCT(1,2) where the variables 1, 2 must be passed by the calling program. COMPONENT: SETPARAM VARIABLES: 1 Type: Input The internal entry number of the GENERIC CODE SHEET STACK File (#2100.1) entry. This variable is required and must be passed as the first parameter. 2 Type: Input The parameters used when rebuilding the code sheet. This is free text from 1 to 200 characters. This variable is required and must be passed as the second parameter. This entry point is provided for IFCAP to set the parameters in the GENERIC CODE SHEET STACK File (#2100.1) which will be used when rebuilding the FMS code sheets. The entry point is called as follows: DO SETPARAM^GECSSDCT(1,2) where the variables 1, 2 must be passed by the calling program. COMPONENT: PROCESS VARIABLES: 1 Type: Input The stack entry name .01 field. This variable is required and must be passed as the first parameter. 2 Type: Input Pass A for accepted or R for rejected. This variable is required and must be passed as the second parameter. TMP Type: Input Pass the accept or reject mail message in the global ^TMP($J,"GECSSDCT",linenumber,0). The mail message will be sent to the users responsible for submitting the code sheet. This global is optional. This entry point is provided for IFCAP to process the document confirmation transaction (DCT) from the server. The entry point will update the GENERIC CODE SHEET STACK File (#2100.1) entry as accepted or rejected. If there is M code set by the entry point SETCODE^GECSSDCT, the M code will be executed after setting the GENERIC CODE SHEET STACK File (#2100.1) entry status. The entry point is called as follows: DO PROCESS^GECSSDCT(1,2) where the variables 1, 2 must be passed by the calling program. ******************** 1117 NAME: FMS code sheets CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP ACCOUNTS RECEIVABLE ENGINEERING USAGE: Controlled Subscri ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement contains the routine used by IFCAP/AR and Engineering to build and transmit the Financial Management System (FMS) code sheets. For more information regarding the use of this routine, please refer to the Generic Code Sheet Technical Manual. ROUTINE: GECSSGET COMPONENT: DATA VARIABLES: 1 Type: Input The stack entry name .01 field. This variable is required and must be passed as the first parameter. 2 Type: Input A flag to return the actual code sheet. Pass a 1 for the actual code sheet, otherwise 0. This variable is required and must be passed as the second parameter. GECSDATA Type: Output A standard VA FileMan DIQ array with external data only. This entry point is provided for IFCAP to retrieve data from the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: DO DATA^GECSSGET(1,2) where the variables 1, 2 must be passed by the calling program. COMPONENT: STATUS VARIABLES: 1 Type: Input The stack entry name .01 field. This variable is required and must be passed as the first parameter. Y Type: Output This variable is returned as the status of the code sheet. This entry point is provided for IFCAP to return the status of a code sheet from the GENERIC CODE SHEET STACK File (#2100.1). The entry point is called as follows: SET Y=$$STATUS^GECSSGET(1) where the variable 1 must be passed by the calling program. ******************** 1118 NAME: ICD Codes update in PTF CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DRG GROUPER USAGE: Private ENTERED: JAN 11,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.89 ROOT: DIC(45.89, DESCRIPTION: TYPE: File This is to enable the annual DRG Grouper ICD release to include updates to the PTF Expanded Code file (#45.89). New entries are added, updating fields .01, CATEGORY; and .02, DIAGNOSIS/PROCEDURE CODE. Several codes are inactivated, adding entries to their .03, INACTIVE DATE field. ROUTINE: ******************** 1120 NAME: GMRVUTL CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 18,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine User can extract the latest record for a desired vital type from the Vital/Measurement database for a particular patient by calling EN6^GMRVUTL. Input Variables: DFN = The internal entry number in the Patient file (#2) for the patient data that is to be retrieved. GMRVSTR = The abbreviation of the vital/measurement desired from the Vital Type file (#120.51). For example: S GMRVSTR="T",DFN=5 D EN6^GMRVUTL "T" is the abbreviation of temperature. GMRVSTR will be killed. Output Variable: X is set to the entire zeroth node for the entry in question in the Vital/Measurement file (#120.5), for example, ^GMR(120.5,IEN,0), where IEN is the subscript in the file that contains the data. The following shows the format of value containd in X. X=2920728.06^5^2^2920728.13482^42^2098^6^101.1 ROUTINE: GMRVUTL COMPONENT: EN6 VARIABLES: DFN Type: Input The internal entry number in the Patient file (#2). GMRVSTR Type: Input The abbreviation of the vital/measurement desired from the Vital Type file (#120.51). X Type: Output The entire zeroth node for the entry in question in the Vital/Measurement file (#120.5). User can extract the latest record for a desired vital type from the Vital/ Measurement database for a particular patient. ******************** 1123 NAME: Contrast Media Allergy CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: JAN 31,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Allergy package is providing extrinsic functions to support adding and entering in error Radiological contrast media allergy data for Radiology/Nuclear Medicine patients. ROUTINE: GMRARAD COMPONENT: RADD VARIABLES: DFN Type: Input Internal record number of Patient file #2 OH Type: Input "o" if reaction was 'observed' "h" if reaction was 'historical' "p" if user should be asked if reaction was observed or historical YN Type: Input "Y" means contrast reaction "N" means no contrast reaction "U" means contrast reaction unknown "" means contrast reaction deleted VER Type: Input (optional) "1" means data will be autoverified "0" means data will not be verified '$D means use Allergy package autoverification checks X Type: Output Internal record number of the newly added contrast allergy record, or -1 if no record was added. Adds contrast media allergy to Allergy package $$RADD^GMRARAD(DFN,OH,YN,VER) COMPONENT: RACHK VARIABLES: DFN Type: Input Internal record number of Patient file #2 YN Type: Input "N" if Rad/Nuc Med user enters 'NO' at the contrast media prompt. Lets user enter contrast media in error $$RACHK^GMRARAD(DFN,YN) This function will ask user the 'Are you sure ...' question if the Allergy package finds that there is an existing contrast media allergy record for the patient. If the patient answers 'Yes', the Allergy package will enter the record in error. ******************** 1124 NAME: References to Package File (9.4) CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: FEB 1,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.4 ROOT: DIC(9.4 DESCRIPTION: TYPE: File ^XTSUMBLD, %INDEX, and the XINDEX routines need to look at the Package file to find out what files are part of the package. For example, >>>>>XTSUMBLD+14 (FIELD: PREFIX) S X=$P(^DIC(9.4,+$P(Y(0),U,2),0),U,2) D NAME(X) G EXIT:'$D(XTRNAME) >>>>>XINDX10+11 (FIELD: FILE) F J=0:0 S J=$O(^DIC(9.4,DA,4,J)) Q:J'>0 I $D(^(J,0)) SINDFN=+^(0),INDRN="|dd"| _INDFN,(INDF,INDL)=0 D INSERT >>>>>XINDX11+22 (FIELD: PREFIX) NAMSP S INDXN=$P(^DIC(9.4,DA,0),"^",2),C9=0,INDXN(C9)="," F A=0:0 S A=$O(^DIC(9. 4,DA,"EX",A)) Q:A'>0 I $D(^(A,0))#2 S C9=C9+1,INDXN(C9)=$P(^(0),"^") >>>>>ZINDX10+4 (FIELD: FILE) F J=0:0 S J=$O(^DIC(9.4,DA,4,J)) Q:J'>0 I $D(^(J,0)) S INDFN=+^(0),INDRN="|dd"| _INDFN,(INDF,INDL)=0 D INSERT >>>>>ZINDX11+5 (FIELD: PREFIX) NAMSP S INDXN=$P(^DIC(9.4,DA,0),"^",2),C9=0,INDXN(C9)="," F A=0:0 S A=$O(^DIC(9. 4,DA,"EX",A)) Q:A'>0 I $D(^(A,0))#2 S C9=C9+1,INDXN(C9)=$P(^(0),"^") ^DIC(9.4,DA,0) 1 PREFIX 0;2 Direct Global Read & w ^DIC(9.4,DA,4) 6 *FILE 4;0 Direct Global Read & w ROUTINE: ******************** 1125 NAME: Index and BUILD file CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: FEB 1,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.6 ROOT: XPD(9.6 DESCRIPTION: TYPE: File Index reads the file list, option list, Function list, routine list to get the components of a build. The references are in XINDX10, XINDX11, XINDX51. ^XPD(9.6,D0,4 4 FILE Direct Global Read & w ^XPD(9.6,D0,'KRN', 6 BUILD COMPONENTS Direct Global Read & w ROUTINE: ******************** 1126 NAME: Index and the DD global. CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: FEB 1,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File ^DD( The VA Cross-Referencer utility in Toolkit needs to reference several ^DD nodes in order to cross-reference a package. Several of the referenced DD nodes contain M code. They are inspected to find items such as global/variables names and label /external references. Some of the referenced nodes are the "LAYGO", "DEL" nodes. A specific example of a DD reference follows: >>>>>%INDX10+25 S INDEL="" F G=0:0 S INDEL=$O(^DD(INDFN,INDF,"LAYGO",INDEL)) Q:INDEL="" I $D(^(INDEL,0))#2 S INDC=INDF_"LAYGO"_INDEL_" ; LAYGO CHECK CODE",INDX=^(0) D ADD The DD references are found in routines %INDX10, %INDX11, %INDX53. ROUTINE: ******************** 1128 NAME: Killing global DOPT CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LETTERMAN USAGE: Private ENTERED: FEB 3,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This integration agreement allows the LetterMan pre-init to remove the old version namespace entries in the global ^DOPT. The globals killed are: ^DOPT("WPSE") ^DOPT("WPSE1") ^DOPT("WPSE2") ^DOPT("WPSE3") ^DOPT("WPSE4") ROUTINE: ******************** 1129 NAME: DBIA1129-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: FEB 6,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: ZZSLOT( DESCRIPTION: TYPE: File Reference to ^ZZSLOT. Toolkit requests read access to this node to maintain the number of active slots in it's performance database. .S XUCMSLOT=+$G(^ZZSLOT(XUCMND,"ACTIVE")) ^ZZSLOT(nodename,'ACTIVE') # active slots on this node. ROUTINE: ******************** 1130 NAME: DBIA1129-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: FEB 6,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine References to ^%ZOSV* ROUTINE: %ZOSV2 COMPONENT: DB VARIABLES: XUCM() Type: Output Collect data on current database size COMPONENT: RTHSTOP VARIABLES: Stops the current RTHIST session, prepares data for filing by moving to the %ZRTL global, purges ^RTH global in MGR, begins a new RTHIST session. COMPONENT: $$TRNLNM VARIABLES: Translates a VMS logical name. COMPONENT: $$TI VARIABLES: Returns MSM cpu tic interval. COMPONENT: $$OS VARIABLES: Return current operating system and version level. COMPONENT: $$PRV VARIABLES: Return current user priv's on VMS systems. ******************** 1131 NAME: XMB('NETNAME') CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 9,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: XMB('NETNAME') DESCRIPTION: TYPE: File ^XMB("NETNAME") contains the human-readable form of the name of the local domain. It is a copy of the .01 field of the record in the DOMAIN file 4.2 pointed to by the .01 field of the only record in the MAILMAN SITE PARAMETERS file 4.3. You may reference this global in any routine. ROUTINE: ******************** 1132 NAME: TEST FORWARDING ADDRESS CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 21,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API sends a test message from the Postmaster to the forwarding address of a user. If the MAILMAN SITE PARAMETER field 7.01, FWD TEST MESSAGE TO POSTMASTER, is not set, the Postmaster is a recipient. The message will either be successful or a message will be returned to the Postmaster from the remote system identified in the forwarding address explaining that the message could not be delivered. This entry point is not normally used by application programmers. Usage: D ^XMUT7(Y), where Y is the DUZ of the user whose forwarding address is to be tested. ROUTINE: XMUT7 ******************** 1135 NAME: GMRAMCU0 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Supported ENTERED: FEB 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Patient Wristband software calls IDBAND^GMRAMCU0(DFN,DATE,USR) to update the ID BAND MARKED field in file 120.8 (PATIENT ALLERGIES). ROUTINE: GMRAMCU0 COMPONENT: IDBAND VARIABLES: DFN Type: Input IEN for a patient in file 2 (Required) DATE Type: Input Date of marking in File Manager format (optional- if undefined or null current date/time will be used) USR Type: Input User Marking the ID band (optional- if undefined null will be used indicating data automatically entered). IDBAND(DFN,DATE,USR) ; This program will mark all the ID Band fields for ; all reactions for a patient ******************** 1136 NAME: ENCODE/DECODE CARETS AND CTRL CHARS CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 21,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API contains the following functions: $$ENCODEUP^XMCU1(STRING) - convert all "^" to "~U~" $$DECODEUP^XMCU1(STRING) - convert all "~U~" to "^" $$STRAN^XMCU1(STRING) - convert all control characters to printables $$RTRAN^XMCU1(STRING) - undo the conversion by $$STRAN^XMCU1 ROUTINE: XMCU1 COMPONENT: $$ENCODEUP VARIABLES: STRING Type: Input Any string, usually with one or more "^" in it. Takes a string, converts any "^" to "~U~", and returns the result. This function is identical to $$ENCODEUP^XMXUTIL (DBIA 2734). This function is used when putting strings, which may contain "^", into fields in globals. Fields in globals are delimited by "^", so any "^" in a string would, in effect, create an unintended field. So, before we put such strings into fields, we convert any "^". MailMan uses this to convert any subjects with "^" before putting them in the .01 field in the MESSAGE file, 3.9. Usage: S X=$$ENCODEUP^XMCU1(string) COMPONENT: $$DECODEUP VARIABLES: STRING Type: Input A string with embedded "~U~". Takes a string, converts any "~U~" to "^", and returns the result. This function is identical to $$DECODEUP^XMXUTIL (DBIA 2734). Usage: S X=$$DECODEUP^XMCU1(STRING) COMPONENT: $$STRAN VARIABLES: STRING Type: Input A string with control characters in it. Takes a string, converts any control characters (and "~") to printable characters, and returns the result. The conversion may be undone by $$RTRAN^XMCU1. Usage: S X=$$STRAN^XMCU1(STRING) Note: "~" is replaced by "~>" $C(I) by $C(I+64) for I=0 to 31, for example $C(0) by "~@" $C(1) by "~A" $C(7) by "~G" (i.e. BELL) $C(13) by "~M" (i.e. CR = Carriage Return) $C(26) by "~Z" $C(31) by "~_" etc. COMPONENT: $$RTRAN VARIABLES: STRING Type: Input A string whose control characters have been converted by $$STRAN^XMCU1. Takes a string which had been converted by $$STRAN^XMCU1, undoes the conversion, and returns the result. ******************** 1137 NAME: DBIA1137 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IBQ Package requests use of the routines to derive date ranges. ROUTINE: IBOUTL COMPONENT: DATE VARIABLES: IBBDT Type: Output IBBDT is returned as the beginning date. IBEDT Type: Output IBEDT is returned as the ending date. Derive date ranges. ******************** 1138 NAME: DBIA1138 CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: FEB 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The health summary package needs to be able to retrieve Compensation and Pension data for a health summary C & P component. ROUTINE: DVBCHS0 COMPONENT: HSCP VARIABLES: PATPTR Type: Input Pointer to PATIENT file (#2) INVBEGDT Type: Input Beginning date in inverse FileMan Format Defaults to one year before today. INVENDDT Type: Input Ending date in inverse FileMan format. Defaults to today OUTCODE Type: Input Flag indicating which optional nodes to return. 0 = Do not return any optional nodes 1 = Node 1 should also be returned 2 = Node 2 should also be returned 3 = Node 1 and 2 should also be returned (default) ARRAY Type: Both Where to store output (full global reference). Defaults to ^TMP("DVBC",$J) ARRAY(InvE Type: Output Node contain the following data: Code ^ DATE OF EXAM [.06] ^ EXAM TYPE [.03] ^ EXAMINING PHYSICIAN [.07] ^ PRIORITY OF EXAM [396.3;9] ARRAY(InvE Type: Output Node contains the following data: ROUTING LOCATION [396.3;24] ^ OWNER DOMAIN [396.3;28] ^ TRANSFERRED OUT TO [62] ARRAY(InvE Type: Output Node contains the following data: REQUEST STATUS [396.3;17] ^ APPROVED BY [396.3;25] ^ APPROVAL DATE/TIME [396.3;26] ARRAY(InEx Type: Output Node contains the following data: Number of lines in EXAM RESULTS ARRAY(InEx Type: Output Node contain the following data: Line X of the EXAM RESULTS [70]. Type: The Health Summary application needs permission to use the entry point HSCP^DVBCHS0(PATPTR,INVBEGDT,INVENDDT,OUTCODE,ARRAY) in order to extract compensation and pension (C & P) information from the 2507 EXAM (#396.4) and 2507 REQUEST (#396.3) files. Entry Point ----------- HSCP^DVBCHS0(PATPTR,INVBEGDT,INVENDDT,OUTCODE,ARRAY) Input ----- PATPTR - Pointer to PATIENT file (#2) INVBEGDT - Beginning date in inverse FileMan format - Defaults to one year before today INVENDDT - Ending date in inverse FileMan format - Defaults to today OUTCODE - Flag indicating which optional nodes to return 0 = Do not return any optional nodes 1 = Node 1 should also be returned 2 = Node 2 should also be returned 3 = Nodes 1 & 2 should also be returned (default) ARRAY - Where to store output (full global reference) - Defaults to ^TMP("DVBC",$J) Ouptput ------- ARRAY(InvExDt,Type,0) = Code ^ DATE OF EXAM [.06] ^ EXAM TYPE [.03] ^ EXAMINING PHYSICIAN [.07] ^ PRIORITY OF EXAM [396.3;9] ARRAY(InvExDt,Type,1) = ROUTING LOCATION [396.3;24] <-- ^ OWNER DOMAIN [396.3;28] ^ TRANSFERRED OUT TO [62] ARRAY(InvExDt,Type,2) = REQUEST STATUS [396.3;17] <-- ^ APPROVED BY [396.3;25] ^ APPROVAL DATE/TIME [396.3;26] ARRAY(InvExDt,Type,"RES",0) = Number of lines in EXAM RESULTS ARRAY(InvExDt,Type,"RES",X) = Line X of EXAM RESULTS [70] Subscripts: InvExDt - Inverse FileMan date of DATE OF EXAM [.06] Type - Poiner value of EXAM TYPE [.03] Code used as follows: 1 = Exam was performed locally 2 = Exam was performed by another facility 3 = Exam was performed locally for another facility Dates will be in FileMan format, while all other information will be in external format With the exception of dates, N/A (not applicable) and UNKNOWN will be used when appropriate Optional nodes are marked by an arrow (<--) Notes ----- - Output array will be initialized (KILLed) - Information for an exam is only returned when: 1. The exam status is COMPLETED 2. The status of the request containing the exam is a) RELEASED TO RO, NOT PRINTED b) COMPLETED, PRINTED BY RO c) COMPLETED, TRANSFERRED OUT - The Priority of Exam codes and text that may be returned are: 'T' FOR TERMINAL 'P' FOR POW 'OS' FOR ORIGINAL SC 'ON' FOR ORIGINAL NSC 'I' FOR INCREASE 'R' FOR REVIEW 'OTR' FOR OTHER 'E' FOR INSUFFICIENT EXAM 'AO' FOR AGENT ORANGE 'BDD' FOR BEN DELIV AT DISCHG 'IDES' FOR DISABILITY EVAL SYS 'QS' FOR QUICK START ******************** 1139 NAME: Add HFS device for OE/RR CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING This is a one-time request to allow the OE/RR packag to add a HFS device to the DEVICE file. The entry will be named OR WORKSTATION. It will have a subtype of P-OTHER. This device is used by the listmanager and GUI portions of CPRS (OE/RR version 3.0) to generate DHCP reports into a list format. The following is the code used to create this device: ZIS ; -- Add OR WORKSTATION and resource devices N DA,DIC,DIE,DLAYGO,X,Y S DIC(0)="LQMZ",(DIC,DLAYGO)=3.5,X="OR WORKSTATION" D ^DIC I Y,$P(Y,"^",3) D ; if newly added . S DA=+Y,DIE=DIC . S DR=".02///^S X=""OR Workstation HFS Device"";1///^S X=""ORDEV.DAT""" . S DR=DR_";1.95////0;2///^S X=""HFS"";4////0;5////0;5.1////0;5.2////0" . S DR=DR_";3///^S X=""`""_"_$$SUBTYPE^ORCPOST() . D ^DIE Q ; SUBTYPE() ; get subtype for P-OTHER N DIC,X S DIC(0)="QMXZ",DIC="^%ZIS(2,",X="P-OTHER" D ^DIC Q +Y CLINICAL INFO RESOURCE NETWORK CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: OCT 12,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: 3.0 FILE: 3.5 ROOT: %ZIS(1 DESCRIPTION: TYPE: File ^%ZIS(1, .01 NAME 0;1 Both R/W w/Fileman 1 $I 0;2 Both R/W w/Fileman 2 TYPE TYPE;1 Both R/W w/Fileman 35 RESOURCE SLOTS 1;10 Both R/W w/Fileman ROUTINE: ******************** 1142 NAME: MESSAGE SUBJECT API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API contains the following functions: $$SUBCHK^XMGAPI0 - validate a proposed message subject $$SUBGET^XMGAPI0 - retrieve the subject of a message ROUTINE: XMGAPI0 COMPONENT: $$SUBGET VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file (3.9), of the message whose subject you wish to get. Given the message number, returns the subject of a message. Any ~U~ are automatically converted to up-arrow (^). If the message does not exist, returns null. Compare to ZSUBJ^XMXUTIL2 and SUBJ^XMXUTIL2 (DBIA 2736). Usage: S A=$$SUBGET^XMGAPI0(XMZ) Example: W $$SUBGET^XMGAPI0(51537) zzzzzz message subject zzzzz COMPONENT: $$SUBCHK VARIABLES: XMSUB Type: Input Proposed message subject. XMFLG Type: Input Should results of the check be written to the screen, too? Possible values are: 0 - no 1 - yes Checks a prospective message subject to see if it passes validity checks/input transform. If valid, it returns the subject. If not valid, it returns an error string explaining why it's not valid. Leading and trailing blanks are automatically removed. Up-arrows (^) are automatically converted to "~U~". Function can be set to be interactive (to display results of the check to the screen) or non-interactive. In interactive mode, control characters are removed, too. Compare to VSUBJ^XMXAPI (DBIA 2728). Usage: S A=$$SUBCHK^XMGAPI0(XMSUB,XMFLG) Parameters: XMSUB - string to be validated as a message subject XMFLG - interactive, and display results to the user, too? (0=no; 1=yes) Returns: If OK: ^ valid string If error: error number ^ string Possible results, in actual order: Subject is too long Non-interact: 3-Entered subject too long ^$E(,1,65) Interactive: "Entered subject too long "1^$E(,1,250) At this point, leading and trailing blanks are removed, and up-arrows (^) are converted to ~U~. Subject contains control characters Non-interact: 5-Subject cannot contain control characters.^ Interactive: "Control characters removed ( is Subject accepted)." (Control characters are removed and checking continues.) Subject is null Non-interact: Interactive: Subject is "?" Non-interact: 4-Enter a Message Subject, between 3 & 65 characters long or '^' to exit.^ Interactive: "Enter a Message Subject, between 3 & 65 characters long or '^' to exit." 1^ Subject is too short Non-interact: 1-SUBJECT must be at least 3 characters long.^ Interactive: "SUBJECT must be at least 3 characters long." 1^ Subject is reserved format Non-interact: 2-Subject names of this format (1""R""1.N) are RESERVED ^ Interactive: "Subject names of this format (1""R""1.N) are RESERVED" 1^ Subject is OK Non-interact: ^ Interactive: ^ ******************** 1143 NAME: MESSAGE HEADER API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API contains the following function: $$NET^XMRENT - Get message header information ROUTINE: XMRENT COMPONENT: $$NET VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file (3.9). This extrinsic function is used for getting message information. Given a message number, it returns an "^"-delimited string containing message header information. If there is no such message, it returns the null string. Compare to $$HDR^XMGAPI2 (DBIA 1144), and INMSG^XMXUTIL2 and other ^XMXUTIL2 APIs (DBIA 2736). Usage: S X=$$NET^XMRENT(XMZ) Returns: If the message is NOT defined, the null string. If the message is defined, a string with the following pieces, separated by "^": Piece Contents 1 Origination date. If remote, as sent. If local, in format MAY 25, 1999@08:16:00 2 Scramble hint, if any; otherwise null 3 From (external) 4 Message ID at originating site (XMZ@site, if local) 5 Message sender, usually surrogate (external); otherwise null 6 Subject 7 Message ID of original message, if this is a reply (XMZ@site, if local); otherwise null 8 Message type (piece 7 of message's zero node) Examples: W $$NET^XMRENT(51537) date@time^HINT^From^10576@MAILSYS^SurrogateDUZ^Subject^4321@si te^Type 1 2 3 4 5 6 7 8 ******************** 1144 NAME: MESSAGE INFO API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API contains the following function: $$HDR^XMGAPI2 - retrieve information about a message. ROUTINE: XMGAPI2 COMPONENT: $$HDR VARIABLES: DUZ Type: Input User's DUZ. The IEN of the user in the NEW PERSON file (200). XMDUZ Type: Used The user's DUZ. Default is DUZ. This is the user, in relation to whom, some of the message information will be obtained. XMZ Type: Input IEN of the message in the MESSAGE file (3.9) about which information is to be obtained. FLAG Type: Used Determines what information is obtained about the message. Possible values are: 0 - return basic information (default) 1 - return basic information + response and BLOB count information 91 - return flag 1 information + response IDs 92 - return flag 1 information + BLOB IDs 93 - return all of the above ARRAY Type: Output Array of information. If FLAG=0 or undefined: ("BROADCAST") = 1 if the message was broadcast; 0 otherwise ("BSKT") basket name (XMDUZ); null if not in basket ("BSKT IEN") basket IEN (XMDUZ); null if not in basket ("DATE") message date/time, in format MAY 25, 1999@08:16:00, if local, or as sent, if remote. ("DATE FM") message date/time (FileMan format); date only, if remote. ("LINES") number of lines in the original message ("NEW") = 1 if the message is new; 0 otherwise ("PXMZ") message number of original message; null if not a response ("SENDER") sender (from) (external format) ("SENDER DUZ") sender (from) DUZ; null if remote or fictitious ("SUBJ") subject (external format) ("SURROG") surrogate sender (external format) ("TYPE") message type (piece 7 of the message's zero node) ("XMZ") message IEN in message file If FLAG=1, returns value array as with flag 0, and additional value array as follows: ("RRED") responses read (XMDUZ); null if not applicable ("RRCV") responses received; null if not applicable ("BLOBCNT") (specific to Imaging pkg) number of non-textual body parts attached If FLAG=91, and if the message has responses, returns value array as with flag 1, and an array of response nodes and values as follows: ("RSP",i) (pointer to 3.9 file) array of responses, where i is the response number If FLAG=92, and if the message has BLOBs, returns value array as with flag 1, and an array of non-textual body parts as follows: ("BLOB",i) (specific to Imaging pkg) (pointer to 2005 file) array of BLOBS If FLAG=93, returns all of the above. This function retrieves message header information, as well as other information about a message. How much information is returned depends on the value of FLAG, one of the parameters. If successful, it sets up (in ARRAY, which must be passed by reference) an array of information about a message, and returns zero (0). If unsuccessful, returns one of the following: "1-Undefined message number" "1-No message number" "1-No such message" "2-User is not a sender of recipient." "4-Invalid user" Compare to $$NET^XMRENT (DBIA 1143), and INMSG^XMXUTIL2 and all other APIs in ^XMXUTIL2 (DBIA 2736). Usage: S X=$$HDR^XMGAPI2(XMZ,.ARRAY,FLAG) Examples: -------------------------------------------------------------- - Example of specifying an non-existent message: S X=$$HDR^XMGAPI2(999,.VAR,"") I +X>0 W !,X "1-No such message" Note that VAR is UNCHANGED from state prior to call if function value is greater than zero. -------------------------------------------------------------- USING A FLAG OF ZERO Example of a Message from a Local User: S DATA=$$HDR^XMGAPI2(123456,.VAR,0) Data will be returned as 0, if 123456 is a valid message. Array will be returned as: VAR("BROADCAST") = 0 VAR("BSKT") = "IN" VAR("BSKT IEN") = 1 VAR("DATE") = "SEPTEMBER 10, 1993@09:00:00" VAR("DATE FM") = 2930910.9 VAR("LINES") = 22 VAR("NEW") = 1 VAR("PXMZ") = "" VAR("SENDER") = "USER,JOE" VAR("SENDER DUZ")= 77 VAR("SUBJ") = "HELLO!" VAR("SURROG") = "" VAR("TYPE") = "P" VAR("XMZ") = 123456 Example of Message from a Remote User: S DATA=$$HDR^XMGAPI2(123457,.VAR,0) Data and the array information for message 123457 will be returned as above for message 123456. The remote user will be returned as a string. VAR("SENDER") = "JEAN247@domainname.FR" VAR("SENDER DUZ")= "" Example of a Response from a Local User: DATA=$$HDR^XMGAPI2(123458,.VAR,0) Data and the array information for message 123458 will be returned as above for message 123456. The value of the pointer to the message will be returned as below: VAR("PXMZ") = 123456 VAR("SUBJ") = "Re: HELLO!" VAR("XMZ") = 123458 Example of a Response from a Remote User: S DATA=$$HDR^XMGAPI2(123459,.VAR,0) Data and the array information for message 123459 will be returned as above for message 123458. The remote user will be returned as a string. VAR("PXMZ") = 123456 VAR("SENDER") = "JEAN247@domainname.FR" VAR("SENDER DUZ")= "" VAR("SUBJ") = "Re: HELLO!" VAR("XMZ") = 123459 -------------------------------------------------------------- -------- USING A FLAG OF 1 Example of Message from a Local User: S DATA=$$HDR^XMGAPI2(123456,.VAR,1) Data and the array information for message 123456 will be returned as above. In addition, the following will be returned in the VAR array: VAR("RRED") = 2 Responses Read VAR("RRCV") = 3 Responses Received VAR("BLOBCNT") = 0 Non-textual body parts attached. -------------------------------------------------------------- ------ USING A FLAG OF 91 Example of a Message from a Local User: S DATA=$$HDR^XMGAPI2(123456,.VAR,91) Data and the array information for message 123456 will be returned as above. In addition, the following will be returned in the VAR array. Each node is a response number and each value is a pointer to File #3.9. VAR("RSP",1)=123458 VAR("RSP",2)=123459 VAR("RSP",3)=123501 -------------------------------------------------------------- ------------ USING A FLAG OF 92 Example of a Message from a Local User: S DATA=$$HDR^XMGAPI2(123456,.VAR,92) Data and the array information for message 123456 will be returned as with Flag 1. In addition, the following will be returned the VAR array. (Each node is an image counter and each value is a pointer to the Object file (#2005), A Binary Large OBject - BLOB). VAR("BLOB",1)=100 VAR("BLOB",2)=3345 VAR("BLOB",3)=14445 -------------------------------------------------------------- ------------ USING A FLAG OF 93 Example of a Message from a Local User: S DATA=$$HDR^XMGAPI2(123456,.VAR,93) Data and the array information for message 123456 will be returned as with Flag 91. In addition, the array of image counter and values will be returned as above. ******************** 1145 NAME: REPLY TO / ANSWER A MESSAGE API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The APIs (functions) in this DBIA send non-interactive replies and answers. $$ENT^XMA2R - Send a reply to a message. Add a response to the response chain of original message. $$ENTA^XMA2R - Send an answer to a message. Create a new message (rather than adding a response to the response chain of original message). ROUTINE: XMA2R COMPONENT: $$ENT VARIABLES: XMZ Type: Input Message IEN in the MESSAGE FILE (#3.9) of the message being replied to. XMSUBJ Type: Input Subject of the reply. Must be 3-65 characters. XMTEXT Type: Input Text of the reply. Must be an array, passed by reference, and in a format acceptable as input to FileMan word-processing fields. XMSTRIP Type: Input (optional) String containing characters to be stripped from the text of the reply (XMTEXT). Default is none. XMDUZ Type: Used (optional) The DUZ of the user sending the answer. May also be free text. Default is DUZ. XMNET Type: Used (optional) If the sender of the original message is at a remote site, should the reply be sent to the sender, too? Possible values: 0=no (default) 1=yes This parameter is ignored if the message is from a local user. Send a reply to a message. Add a response to the response chain of original message, so that all local recipients of the message get the reply. If the message is from a remote site, you can indicate (with XMNET), whether the reply should be send to the author of the message, too. This function is non-interactive. Compare to REPLYMSG^XMXAPI (DBIA 2729). Usage: S variable=$$ENT^XMA2R(XMZ,XMSUBJ,.XMTEXT,XMSTRIP,XMDUZ,XMNET) If successful, function returns: Message IEN in file 3.9 of the reply. If failure, function returns: The letter "E", followed by a number, followed by an error message. e.g. "E3 Subject too long or short !" Examples: W $$ENT^XMA2R(51537,"test of XMA2R",.T,"",DUZ) E2 No message text ! S T(1)="test line 1" S X=$$ENT^XMA2R(51537,"test of XMA2R",.T,"",DUZ) W X 51541 COMPONENT: $$ENTA VARIABLES: XMZ Type: Input Message IEN in the MESSAGE FILE (#3.9) of the message being answered. XMSUBJ Type: Input Subject of the answer. Must be 3-65 characters. XMTEXT Type: Input Text of the answer. Must be an array, passed by reference, and in a format acceptable as input to FileMan word-processing fields. XMSTRIP Type: Used (optional) String containing characters to be stripped from the text of the answer (XMTEXT). Default is none. XMDUZ Type: Used (optional) The DUZ of the user sending the answer. It may also be free text. Default is DUZ. Send an answer to a message. Create a new message containing the response and send it only to the author of the original message. This function is non-interactive. Compare to ANSRMSG^XMXAPI (DBIA 2729). Usage: S variable=$$ENTA^XMA2R(XMZ,XMSUBJ,.XMTEXT,XMSTRIP,XMDUZ) If successful, function returns: Message IEN in file 3.9 of the answer. If failure, function returns: The letter "E", followed by a number, followed by an error message. e.g. "E1 No subject !" ******************** 1146 NAME: MAIL GROUP API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This mail group API contains the following entry points: $$DM^XMBGRP Delete local members from a mail group. $$MG^XMBGRP Create a new mail group or add local members to an existing mail group. ROUTINE: XMBGRP COMPONENT: $$MG VARIABLES: XMGROUP Type: Input Full Mail group name, exactly as it should appear in the .01 field of the MAIL GROUP file (3.8). Must be 3-30 characters. XMTYPE Type: Used (optional) Type of mail group. Used only for creating a mail group, otherwise it's ignored. Possible values are: 0 - public (default) 1 - private XMORG Type: Used (optional) DUZ of group organizer. Used only for creating a mail group, otherwise it's ignored. Default is DUZ of the user performing the API. If XMORG is less than 1, it is set to .5. XMSELF Type: Used (optional) Allow self enrollment? (0=no; 1=yes) Used only for creating a mail group, otherwise it's ignored. Default is 1 (yes). XMY Type: Used (optional for mail group creation; mandatory otherwise) Array of local members to add to the mail group. XMY(user duz)="" Note that only user DUZs are accepted. User names are not. Remote addresses, or anything else, are not. XMY is killed upon successful completion of this API. XMDESC Type: Used (optional) Array of text to put in the description field of the mail group. Used only for creating a mail group, otherwise it's ignored. The text array must be in a format acceptable to FileMan word-processing APIs. XMQUIET Type: Used (optional) Silent Flag. What should happen if there are any errors, or if (during mail group creation only) local members were successfully added to the mail group? 0 - Display it to the user. 1 - Sent it in a message to the Postmaster and the user (DUZ) performing the API. (Default) Create a mail group or add local members to an existing mail group. If the mail group does not exist, it will be created. Local members may be added. There is no way to add other kinds of members. XMTYPE, XMORG, XMSELF, and XMDESC are accepted. If the mail group exists, local members must be added to it. No other changes can be made. XMTYPE, XMORG, XMSELF, and XMDESC are ignored. There is no MailMan API to change any other mail group fields. Usage: S X=$$MG^XMBGRP(XMGROUP,XMTYPE,XMORG,XMSELF,.XMY,.XMDESC,XMQUIET ) This function returns the mail group IEN if successful; 0 if not. Parameters: XMGROUP mail group IEN or name XMTYPE mail group type (public or private) XMORG organizer DUZ XMSELF self enrollment allowed? .XMY array of local members .XMDESC array of text for the mail group description XMQUIET silent flag COMPONENT: $$DM VARIABLES: XMGROUP Type: Input Mail group IEN in the MAIL GROUP file (3.8), or the full mail group name, exactly as it appears in the .01 field. XMY Type: Input Array of local members to delete from the mail group. XMY(user duz)="" Note that only user DUZs are accepted. User names are not. XMQUIET Type: Used (optional) Silent Flag. Possible values: 0 - Any errors are displayed to the user. 1 - Any errors are sent in a message to the Postmaster and the user (DUZ) performing the API. (Default) Delete local members from a mail group. There is no MailMan API to delete other kinds of members. Usage: S X=$$DM^XMBGRP(XMGROUP,.XMY,XMQUIET) This function returns 1 if successful; 0 if not. Parameters: XMGROUP mail group IEN or full name .XMY array of local members to be deleted XMQUIET silent flag (1=Silent, 0=Interactive) ******************** 1147 NAME: LOOKUP / CREATE BASKET CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function looks up a mail basket name and returns its IEN. If the basket doesn't exist, the basket will be created and the IEN of the newly created basket will be returned. ROUTINE: XMAD2 COMPONENT: $$BSKT VARIABLES: XMKN Type: Input The name of the basket to be looked up or created. It must be the exact name. It must be 2-30 characters. XMDUZ Type: Input The DUZ of the user whose basket is being looked up or created. This function looks up a mail basket name and returns its IEN. Given a basket name and a user's DUZ, lookup the basket. If it doesn't exist, create it and return its IEN. If it does exist, return its IEN. If there's an error, return an error message. CRE8BSKT^XMXAPIB (DBIA 2723) can also be used to create a basket. Usage: S variable=$$BSKT^XMAD2(XMKN,XMDUZ) Where: XMKN=Basket-name XMDUZ=DUZ (user IEN) Examples: W $$BSKT^XMAD2("ZZZZZ",9999) 999 (The IEN is returned when there are no errors.) W $$BSKT^XMAD2(1,1) or W $$BSKT^XMAD2("A",1) An error message to the effect that Basket names contain 2 to 30 chars. W $$BSKT^XMAD2("zzzzzz",99999999) An error message to the effect that No such MailMan user as 99999999 is known. S B=$$BSKT^XMAD2(X,Y) I B<1 W !!,"MailMan found the following error: ",B MailMan found the following error: An error message to the effect that a certain error occurred. ******************** 1148 NAME: MAILMAN: Interactive control of a port CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Device and Line Checking GO^XMCTLK This routine allows one to interactively use a device and displays keyboard entry and data coming down the line. Usage: D GO^XMCTLK Note: DHCP programming environment is assumed (initialized through the execution of D ^XUP or sign-on through ^XUS). All I/O from the keyboard and device chosen are echoed on screen. It is good for testing devices, Network outgoing points, etc. What is displayed on the screen may be captured into a mail message. Type an "A" to communicate with TalkMan. ROUTINE: XMCTLK ******************** 1150 NAME: RESEQUENCE MESSAGES API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API resequences the messages in your basket. ROUTINE: XMA03 COMPONENT: $$REN VARIABLES: XMDUZ Type: Input DUZ of the user whose basket is to be resequenced. XMK Type: Input IEN of the basket to be resequenced in the user's mailbox. This function performs an integrity check on the user's basket and then resequences the messages in the basket. Only the user or a surrogate may use this API. If successful, returns the string: "Resequenced from 1 to n", where n is the number of messages in the basket. If unsuccessful, returns the null string. Compare to RSEQBSKT^XMXAPIB (DBIA 2723). Usage: S X=$$REN^XMA03(XMDUZ,XMK) ******************** 1151 NAME: MAILMAN: Server API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ^XMS1 contains the following application programmer functions: $$STATUS^XMS1(MSGIEN,RDUZ) which extracts the status from network messages only. $$SRVTIME(MSGIEN,RDUZ,Status) which sets status of recipients in a message. Appendix 1 -- Message Server Protocol Overview A server is an option which is invoked when a mail message that has been addressed to it has been delivered. As an option, many of the parameters associated with the servers are embedded in the definition of the option. Therefore, in order to understand servers completely, you should refer to the server documentation in Kernel 7.0 manuals. Options are listed in the Menu Management documentation. Servers may or may not receive data. The received data usually comes in the form of the text of the message being delivered to it, but the data may also be pointed to by the message, and exist in the system either because it was there in the beginning, or because it arrived independently. Servers may be addressed from a remote site. A server on ALTOONA.VA.GOV may receive a message addressed to it from WASHINGTON.VA.GOV. In fact, this is very common. There are security features as parameters of the option that has been designated as a server because of the fact. Please be aware of these security parameters. Messages addressed to servers will not be scheduled if security is not passed. Filegrams work through use of a server. Data is loaded into a mail message, addressed and when delivered, processed by the filegram server into the receiving database. Servers are always invoked through tasks that are set up when the message is delivered into the system locally or over the network. One of the options is to "Run Immediately". Then the task is scheduled to run "NOW". However, tasks may not need to be scheduled at all because the system manager has stated so in the entry for the server in the Option file or because of a problem. See the Menu Management documentation in the MailMan Technical Manual and Systems Management Guide for more information concerning this. Server Statuses Server recipients are recorded in the recipient chain of a message and appear similarly to other users. MailMan enters statuses on its own as stages in the server process are reached. First, the message is marked as "Awaiting Server". This indicates that the message has been received and the option is a valid one. At this point, a task has been created to actually invoke MenuMan to schedule or perform the service (option) required. The last status which MailMan sets is "Served", which means that MenuMan has been called successfully and MenuMan has either performed the task in the case of a server that runs immediately, or that some other action has been done. At this point, a task could be scheduled to invoke the server or simply a message could be sent to indicate that the task exists and needs to be scheduled, or some other action that was required was performed. MenuMan has its own statuses which will be used. $$SRVTIME^XMS1 This extrinsic function sets status of recipients in a message. Usage: S X=$$SRVTIME^XMS1(A,B,C) Where: A = XMZ (message number) B = A string representing the recipient name C = Status is free-text (String less than nine (9) characters in length) If successful, X = 0 ...or If unsuccessful, X will be a number followed by a human readable error Addressing a Server To address a server, precede the recipient name with "S." (e.g., S.XMECHO). This example sends a message to the Mail Man Echo Tester server. "S." must be followed by an option name from the Option file in the Target Domain. If not, a "Recipient not Found" error will occur. A "Recipient Ambiguous" error will occur, if there is more than one option whose name partially matches the name addressed. The District Registry server for admitting a new patient could be addressed as follows: S.DGDISTADMIT@SANFRANCISCO.VA.GOV The message is destined for the DGDISTADMIT option at San Francisco. Replies to this message would be from this same name. Writing a Server Program The server communicates with mail messages in specific ways. Code is used to interface the server to the message system. The code below returns the original message to the sender: ECHO ; K XMY S XMSUB=$E("Server echo of'"_XMBSUB_"`",1,65) S XMY(XMFROM)="",XMTXT="^XMB(3.9,"_XMZ_",2," D ^XMD Q In this example, the variable XMFROM contains the sender address and is supplied to the server when invoked. Other variables also exist upon invocation of the server. The XMF.1 example server program is supplied with MailMan. XMF1 uses some of the other variables supplied to the server. Execute variable XMREC to read a line of the message. XMER and XMRG are returned. XMER This variable returns the execution status of XMREC. XMER<0, if there is no more message text to read. The value of XMER will be zero (0), if XMRG is being returned as non-null. XMRG, in that case, will have as its value the text of the next line of the message. XMRG The value of XMRG will be the next line of message text. XMRG will always be defined, though it will be null when XMER<0. XMPOS This variable contains the current position of the text returned in the variable XMGR. It is initialized if it is undefined, but should be killed by the server when it is finished "Reading" the message. Here's another example of code, this time from XMF1: S XMA=0 A ; X XMREC ; Receive a line I $D(XMER) G Q;XMER<0 ; Check for end of message S XMA=XMA+1 ; Increment local line count S XMTEXT(XMA)=XMRG ; Set local array G A ; Go back for another line Double Serving Messages On occasion, the transmission/receive process is interrupted by a system back-up. It appears to result in the same message being served twice. The Audit Log for the Options file shows two messages with the same message number and subject, but with different Date/Times and Job Numbers. To avoid this, application servers should be written such that they check for and avoid processing of the same message being delivered to any particular server. MailMan transparently checks this and does not deliver twice to mail boxes. However, devices and servers do not have mail boxes to check against. Servers can have some understanding of special mail baskets in the Postmaster's mail box and can be written to check for duplicate deliveries (See reference XMAIC entry points in the Callable Routines section of the Technical Manual and System Manager's Guide). ROUTINE: XMS1 COMPONENT: STATUS VARIABLES: $$STATUS^XMS1 This extrinsic function extracts the status from network messages only. Usage: S X=$$STATUS^XMS1(A,B) Where: A = Message Number B = Recipient (pointer to File #200 or free-text Network Address) If successful, X=String ...or If unsuccessful X="" Examples: W $$STATUS^XMS1(51555,"NOSS,VER@VER.GOLD.VA.GOV") Awaiting transmission. COMPONENT: $$SRVTIME VARIABLES: $$SRVTIME^XMS1 This extrinsic function sets status of recipients in a message. Usage: S X=$$SRVTIME^XMS1(A,B,C) Where: A = XMZ (message number) B = A string representing the recipient name C = Status is free-text (String less than nine (9) characters in length) If successful, X = 0 ...or If unsuccessful, X will be a number followed by a human readable error ******************** 1152 NAME: VAM CUSTODIAL PACKAGE: MINIMAL PATIENT DATASET SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: FEB 23,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: VAMPAPI0 COMPONENT: MPD VARIABLES: IN Type: Input Full Global Reference to a global containing an array of SSNs OUT Type: Input Full Global Reference for location of where information will be returned to SCHM Type: Input Search scheme to use- Supported schemes: MPD**00001 - Return full information MPD**00002 - Return site information (for use with PPP) MPD**00003 - Return CD-ROM information CRIT Type: Input Input criteria - Full global reference to an array containing a list of sites to exclude. Global has the form: ^GLOBAL("500")="" ^GLOBAL("520")="" ^^^ ^^^-- | | |-Global |- Site number. Name So CRIT would look like: ^["TRN","KER"]GLOBAL WAIT Type: Input How long to wait for the server to acknowledge the request (else fail saying the server is busy) STARTAT Type: Input SSN to start searching at. The server will begin searching at that SSN in the input array. BUFFER Type: Input Sets the size of the output buffer. It is up to the client application to take SSNs out of the output array and clear it once the data has been read. MPD^VAMPAPI0(IN,OUT,SCHM,CRIT,BUFFER,WAIT,STARTAT) ******************** 1153 NAME: PACKAGE FILE REFERENCES CLEANUP CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: DRG GROUPER REGISTRATION CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: FEB 24,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 9.4 ROOT: DIC(9.4) DESCRIPTION: TYPE: File Loop through the "C" cross-reference on the PACKAGE file and delete any extra entries with the subscribing package namespace. Where necessary, the name of a package may be changed to make it unique. ROUTINE: ******************** 1154 NAME: DIC(45.7, CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 2,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File The integration agreement allows reading (with FileMan only) the SPECIALTY field (#1) of the FACILITY TREATING SPECIALTY file (#45.7). ^DIC(45.7,D0,0) 1 SPECIALTY 0;2 Read w/Fileman Pointer to Specialty File. ROUTINE: ******************** 1155 NAME: DBIA1155 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES A check on this file is made from the PN package: $D(^ORD(100.9,0)) LAB SERVICE A direct reference is made to this file to get data needed to delete old lab notifications. USAGE: Controlled Subscri ENTERED: MAR 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.9 ROOT: ORD(100.9 DESCRIPTION: TYPE: File This DBIA allows references to the OE/RR Notifications (#100.9) file. ^ORD(100.9,0) The Progress Notes package makes this reference. ^ORD(100.9,DA,0) .02 PACKAGE ID 0;2 Direct Global Read & w The Lab package makes this reference. ROUTINE: ******************** 1156 NAME: DBIA1156 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Progress Notes rtn ^GMRPNCW is checking $L($T(CS^GMTSCW)) to ascertain if the 'Advance Directive' component exported with GMTS*2.5*15 has been installed before proceeding with the enhanced CWAD display. ROUTINE: GMTSCW COMPONENT: CD VARIABLES: PNs ^GMRPNCW gets for its' existence. ******************** 1157 NAME: XPDMENU CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 8,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Extrinsic functions and API calls that can be used to manage Options in the Options file. The LKOPT function is used to lookup all options. The ADD and DELETE functions are used to add/delete menu items. The OUT, RENAME, LOCK, and RLOCK are APIs used to populate certain fields for a given option. ROUTINE: XPDMENU COMPONENT: ADD VARIABLES: MENU Type: Input MENU is the name of the Option you want to add a menu item to. OPT Type: Input OPT is the name of the option you want to add to the menu item of MENU. SYN Type: Input SYN is the value you want added to the SYNONYM field under the MENU field for OPT. ORD Type: Input ORD is the value you want added to the DISPLAY ORDER field under the MENU field for OPT. ADD(MENU,OPT,SYN,ORD) is used to add an option to the Menu of another option. Return 1 if the function succeeded, 0 if it failed. COMPONENT: DELETE VARIABLES: MENU Type: Input MENU is the name of the Option you want to delete a menu item from. OPT Type: Input OPT is the name of the option you want to delete from the menu item of MENU. DELETE(MENU,OPT) is used to delete an option from the Menu field of another option. Return 1 if the function succeeded, 0 if it failed. COMPONENT: RENAME VARIABLES: OLD Type: Input OLD is the current name of the option. NEW Type: Input NEW is the name the option is being renamed to. RENAME(OLD,NEW) is used to rename an option. COMPONENT: LKOPT VARIABLES: X Type: Input X is the name of the option. The Option File IEN is returned. LKOPT(X) is used to lookup options IEN using the "B" cross reference. COMPONENT: OUT VARIABLES: OPT Type: Input OPT is the name of the Option you want to place Out-of-Order. TXT Type: Input TXT is the text that will be placed in the Out-of-Order field. OUT(OPT,TXT) is used to place an option Out of Order, field #2. COMPONENT: LOCK VARIABLES: OPT Type: Input OPT is the name of the option you want to lock. TXT Type: Input TXT is the Key name used to lock the option. It must match an entry in the SECURITY KEY file #19.1 LOCK(OPT,TXT) is used to set the LOCK field #3, in the OPTION file #19 for the given option. COMPONENT: RLOCK VARIABLES: OPT Type: Input OPT is the name of the option you want to reverse lock. TXT Type: Input TXT is the Key name used to reverse lock the option. It must match an entry in the SECURITY KEY file #19.1 RLOCK(OPT,TXT) is used to set the REVERSE/NEGATIVE field #3.01, in the OPTION file #19 for a given option. ******************** 1159 NAME: DBIA1159 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package files new Means Tests into PIMS Means Test module. This routine contains utilities for audit changes to Means Tests. ROUTINE: DGMTAUD COMPONENT: SET VARIABLES: DFN Type: Input DFN points to the patient in file #2. DGMTI Type: Input DGMTI points to Means Test in file #408.31. DGMTYPT Type: Input DGMTYPT is 1 (Means Test). DGMTACT Type: Input DGMTACT is a code indicating type of demographic data. DGMTSOLD Type: Input DGMTSOLD is the old value (VAMC). DGMTSNEW Type: Input DGMTSNEW is the new value (IVM). DGDEPI Type: Input DGDEPI is the pointer to the dependent in file #408.13. DGMTP Type: Input DGMTP is the ANNUAL MEANS TEST 0th node prior to Means Test upload. 'DGMTA' Type: Input DGMTA is the ANNUAL MEANS TEST 0th node after Means Test upload. This call is used to update the MEANS TEST CHANGES file with demographic differences between the IVM and VAMC dependents. ******************** 1160 NAME: ONCOLOGY FILE NAME CLEAN-UP CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: MAR 14,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.11 FILE: 1 ROOT: DD(164.07,0,'NM' DESCRIPTION: TYPE: File Clean-up of old file names. ^DD(164.07,0,'NM','ICDO-1ENCODING') ^DD(164.07,0,'NM','ICDO-1ENDCODING') ROUTINE: ******************** 1162 NAME: DBIA1161-B CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MINIMAL PATIENT DATASET FEE BASIS CLAIMS SYSTEM ADDED 12/11/2008 USAGE: Controlled Subscri ENTERED: MAR 14,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43.4 ROOT: DIC(43.4, DESCRIPTION: TYPE: File Convert speciality code to its text equivalent ^DIC(43.4,AEDR,CODE, .01 NUMBER 0;1 Direct Global Read & w Admitting regulation number 1 NAME 0;1 Direct Global Read & w The name of the VA admitting regulation The file contains the recognized VA admitting regulations under which a patient may be admitted to a VA facility ROUTINE: ******************** 1163 NAME: DBIA1161-C CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: MINIMAL PATIENT DATASET USAGE: Private ENTERED: MAR 14,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File Convert Speciality code to its text equivalent ^DIC(40.7,C,CODE 1 AMIS REPORTING STOP 0;2 Direct Global Read & w This field contains the number related to the stop code that is used when generating the OPC file. .01 name 0;1 Direct Global Read & w Contains the name of the clinic stop code. This file contains all Clinic Stops and their associated AMIS stop codes. ROUTINE: ******************** 1164 NAME: DBIA1161-D CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MINIMAL PATIENT DATASET USAGE: Private ENTERED: MAR 14,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File Convert speciality code to text equivalent ^DIC(42.4,CODE, .01 NAME 0;1 Direct Global Read & w The field contains the name of the specialities allowable for selection through PTF. The file contains recognized PTF treating specialties. ROUTINE: ******************** 1166 NAME: DBIA1166 CUSTODIAL PACKAGE: PATIENT DATA EXCHANGE SUBSCRIBING PACKAGE: PHARMACY PRESCRIPTION PRACTICE USAGE: Private ENTERED: MAR 16,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 394.61 ROOT: VAT(394.61 DESCRIPTION: TYPE: File Used to verify and extract PDX transaction information ^VAT(394.61,TRANPTR, .01 Transaction Number 0;1 Direct Global Read & w ^VAT(394.61,TRANPTR,SEG,B, 80 Data Segment 0;1 Direct Global Read & w ^VAT(394.61,TRANPTR,ATHR1, 50 Date/Time of Reply ATHR1;1 Direct Global Read & w 51 Authorizer ATHR1;2 Direct Global Read & w ^VAT(394.61,TRANPTR,ATHR2, 60 Authorizing Site ATHR2;1 Direct Global Read & w 61 Authorizing Address ATHR2;2 Direct Global Read & w ^VAT(394.61,TRANPTR,QRY, 11 Patients SSN QRY;2 Direct Global Read & w ROUTINE: ******************** 1167 NAME: DBIA1167 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: APR 14,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.01 FILE: ROOT: DESCRIPTION: TYPE: Other When sites run Mental Health V. 5.01 inits and they have the DSM3 ^DIC(627, file that has the 2nd and 3rd pieces flipped the install gracefully aborts and tells the user that the DSM3 file is missing conversion node(s)!! The DSM conversion cannot continue and the correct versions of this file should have been installed during the Mental Health V. 5.01 initialization process. Permission from the FILEMAN community to do the following: 1. Hard KILL the node ^DIC(627,310.1) at END+1^YSD4PRE. 2. Reverse the values of the 2nd and third pieces on line Q+36^YSINI035. All routine changes will be sent out in patch YS*5.01*6. ROUTINE: YSINI02Q ******************** 1168 NAME: FILE 124.2 B CROSS-REFERENCE CHANGE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: GEN. MED. REC. - GENERATOR USAGE: Private ENTERED: MAR 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File Since the .01 field of the TG Term (124.6) file is 2-60 characters in length, and there is no need to add a second regular cross-reference, the Text Generator would request an exemption to modify the "B" cross- reference so that it uses 60 characters instead of 30. ^DD(124.6,.01,1,1,1) The modification here is to change: ^DD(124.6,.01,1,1,1)=S ^GMRD(124.6,"B",$E(X,1,30),DA)="" to: ^DD(124.6,.01,1,1,1)=S ^GMRD(124.6,"B",$E(X,1,60),DA)="" ^DD(124.6,.01,1,1,2) The modification here is to change: ^DD(124.6,.01,1,1,2)=K ^GMRD(124.6,"B",$E(X,1,30),DA) to: ^DD(124.6,.01,1,1,2)=K ^GMRD(124.6,"B",$E(X,1,60),DA) ROUTINE: ******************** 1169 NAME: DBIA1169-A CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: MINIMAL PATIENT DATASET LAB SERVICE USAGE: Controlled Subscri ENTERED: MAR 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771.5 ROOT: HL(771.5, DESCRIPTION: TYPE: File Check for existance of version 2.2 in 771.5. If missing add via Fileman ^NONE .01 VERSION NUMBER 0;1 Both R/W w/Fileman Add version 2.2 if it doesn't exit A list of HL7 versions supported by the DHCP site ROUTINE: ******************** 1170 NAME: DBIA1169-B CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: MINIMAL PATIENT DATASET LAB SERVICE SURGERY USAGE: Controlled Subscri ENTERED: JUL 29,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771.2 ROOT: HL(771.2, DESCRIPTION: TYPE: File Checks and adds "ADR" message type if it does not exist in HL7 MESSAGE TYPE file (#771.2). This DBIA is being revised for version 1.6 of HL7. Applications wishing to export interfaces may have the need to update specific HL7 reference files with entries relevant to the current HL7 standard or VA-specific 'Z' segments. Applications may read/update the following files using KIDS or documented VA Fileman calls following written notification and approval of an appropriate official in Technical Integration. 771.2 HL7 MESSAGE TYPE 771.1 HL7 FIELD 771.3 HL7 SEGMENT 771.5 HL7 VERSION 779.001 HL7 EVENT TYPE CODE ^NONE .01 ABBREVIATED NAME 0;1 Both R/W w/Fileman The three character HL7 message type abbreviation A list of HL7 messages supported by the DHCP site ROUTINE: ******************** 1171 NAME: DBIA1171 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAR 21,1995 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT DESCRIPTION: TYPE: File The Radiology Package will reserve field 2005 of file #74 to be used as a multiple for pointers to file #2005. This field will first be supported in Radiology/Nuclear Medicine Version 4.5. Imaging will write pointers to field 2005 of file #74. In addition, Imaging reads the 'NO PURGE' node to determine if images should be purged. If this node is set the Image Purge routine will not delete images associated to the case study (radiology case number). Direct global read is required due to the massive amount of image transactions acquired at sites. As of 12/05/2019 (MAG*3.0*231) radiology allows Imaging to read the zero ^RARPT(DA,0) global directly and with VA FileMan. ^RARPT(D0,2005, .01 IMAGE 0;1 Direct Global Read & w This field contains a pointer to File 2005 (IMAGE). ^RARPT( 45 NO PURGE INDICATOR NOPURGE; Direct Global Read & w This field is set when the corresponding field of the associated exam is set to 'NO PURGE'. 2 PATIENT NAME 0;2 Direct Global Read & w 4 CASE NUMBER 0;4 Direct Global Read & w ^RARPT(D0,2005,'B', Direct global read on the "B" x-ref. ^RARPT(DA,0) VistA Radiology allows Imaging to read the ^RARPT(DA,0) global directly and with VA FileMan. ROUTINE: ******************** 1172 NAME: DBIA1172 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING VistA Imaging DICOM component request reading the Radiology patient file to meet the following requirements: The reading of the Radiology Patient file is required to look-up an accession number for acquiring the corresponding patient and possible Radiology report pointer. (Imaging pointers are stored in the Radiology Report file (#74).) The look up of the accession number is performed on either the "AE", "ADC" or "ADC1" cross-references depending on what is sent (short or long accession number) from the entity (commercial PACS system, commercial gateway, or modality). After a valid entry is found, the matching process of the patient's name and social security is performed. If entries from the sending application match the Vista (main) hospital database, an image will be captured, the Image file is updated and the image pointer is stored in the corresponding Radiology report file. If entries from the sending application fail the matching process, then the entries are not processed but recorded in an Imaging file and will require user interaction to manually match the failed images with a corresponding Radiology exam order. All of these processes require reading the Radiology Patient file. Vista Imaging component VistARad request reading the Radiology patient file to meet the following requirements: VistARad software provides the Radiologist a paperless workstation functionality including Radiology exam worklists and on-line Radiology requisition and enables them to update the status and interpretation for the exam all on-line. USAGE: Private ENTERED: MAY 5,1995 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT DESCRIPTION: TYPE: File As of 12/05/2019 VistA Radiology gives Imaging permission to read file #70 ^RADPT(DA,0) directly and with VA FileMan. VistA Radiology grants permission to VistA Imaging (VI) to read cross- reference ^RADPT('AO'. ^RADPT('AE',CASENUMBER,DA(2),DA(1),DA Cross reference set by the EXAM STATUS field (#3) of the EXAMINATION sub-file (#70.03). Used to look-up exams that are active/incomplete. ^RADPT('ADC',CASENUMBER,DA(2),DA(1),DA) This is the date (MMDDYY) - CASE # cross reference set by the CASE NUMBER field of the EXAMINATION sub-file (#70.03) ^RADPT('AS',EXAM STATUS,DA(2),DA(1),DA Used to produce a list of active/incomplete exams. ^RADPT(DA(1),'DT',DA,0 3 HOSPITAL DIVISION 0;3 Direct Global Read & w Pointer to the RAD/NUC MED DIVISION file (79). 4 IMAGING LOCATION 0;4 Read w/Fileman Pointer to 'IMAGING LOCATIONS' file (#79.1), the location where the exam was performed. ^RADPT(DA(2),'DT',DA(1),'P',DA,0 2 PROCEDURE 0;2 Direct Global Read & w This field is a pointer to file 71, RAD/NUC MED PROCEDURES. 3 EXAM STATUS 0;3 Direct Global Read & w This field is a pointer to file 72, EXAMINATION STATUS. 11 IMAGING ORDER 0;11 Direct Global Read & w This field is a pointer to file 75.1, RAD/NUC MED ORDERS. 12 PRIMARY INTERPRETING 0;12 Direct Global Read & w This field is a pointer to file 200, NEW PERSON. 15 PRIMARY INTERPRETING 0;15 Direct Global Read & w This field is a pointer to file 200, NEW PERSON. 16 COMPLICATION 0;16 Direct Global Read & w This field is a pointer to file 78.1, COMPLICATION TYPES. 16.5 COMPLICATION TEXT COMP Direct Global Read & w This field is used to give a brief explanation (4-100 characters) to describe the exam complication. 17 REPORT TEXT 0;17 Direct Global Read & w This field is a pointer to file 74, RADIOLOGY REPORT. 22 REQUESTING LOCATION 0;22 Direct Global Read & w This field is a pointer to file 44, HOSPITAL LOCATION. .01 CASE NUMBER 0;1 Read w/Fileman The case number assigned to the exam study. 21 REQUESTED DATE 0;21 Read w/Fileman The date the exam was requested. 31 SITE ACCESSION NUMBE 0;31 Read w/Fileman This field consists of the site number, date/time and sequential case number separated by dashes. This field is generated by the VistA Radiology/Nuclear Medicine application. 500 NUCLEAR MED DATA 0;28 Direct Global Read & w If any radiopharmaceuticals were administered to the patient during this exam, they may be recorded here. Radiopharmaceutical data may be automatically entered, if it exists on the procedure file. It is also editable during case edit options and may be configured for editing during status tracking. ^RADPT(DA(3),'DT',DA(2),'P',DA(1),'M',DA, 125 PROCEDURE MODIFIERS 0;1 Direct Global Read & w Imaging modifier, pointer to file 71.2 (PROCEDURE MODIFIERS). Stores the imaging modifiers that are associated with the exam. ^RADPT('AO' Global is a cross reference on IMAGING ORDER field (70.03,#11). Used to link the Radiology/Nuclear Medicine Request Order file (#75.1) to the exam. ^RADPT(DA(3),'DT',DA(2),'P',DA(1),'RX' .01 MED ADMINISTERED 0;1 Direct Global Read & w If any medications were administered to the patient during this exam, they may be recorded here. If medications are associated with a procedure during system set-up, the system will enter them automatically when the procedure is registered. If any medications were administered to the patient during this exam, they may be recorded here. If medications are associated with a procedure during system set-up, the system will enter them automatically when the procedure is registered. ^RADPT('ADC1',DA(2),DA(1),DA This is the cross-reference for the SITE ACCESSION NUMBER field. (70.03;31). ^RADPT(DA,0) VistA Radiology grants VI permission to look at the entire zero node ^RADPT(DA,0) directly and with FileMan read. ROUTINE: ******************** 1174 NAME: DBIA1174 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging needs access to read the Modality subfile (71.0731) to build a modality worklist. In addition, during the automatic image acquisition on the DICOM gateway, the direct read of the CPT name and procedure is needed to store the information in the Image file. With MAG*3.0*231 VI is granted permission to read the entire zero node of the RAD/NUC MED PROCEDURES file directly and with VA FileMan. USAGE: Private ENTERED: MAY 5,1995 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71 DESCRIPTION: TYPE: File VistA Radiology gives permission to Imaging (VI) to read the entire zero node of the RAD/NUC MED PROCEDURES (#71) file directly and with VA FileMan. VistA Radiology gives permission to Imaging (VI) to read the MODALITY field (#.01) of the MODALITY sub-file (71.0731) directly and with VA FileMan. ^RAMIS(71,DA,'MDL' 731 MODALITY MDL,0;1 Direct Global Read & w Points to the RAD MODALITY DEFINED TERMS file (73.1). ^RAMIS(71,DA,0) With MAG*3.0*231 VI is granted permission to read the entire zero node of the RAD/NUC MED PROCEDURES file directly and with VA FileMan. ROUTINE: ******************** 1175 NAME: DBIA1175 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging needs to read the status field on a specified accession number. USAGE: Private ENTERED: AUG 12,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 72 ROOT: RA(72, DESCRIPTION: TYPE: File Radiology gives permission to Imaging to read file #72 (^RA). ^RA(72, .01 EXAM STATUS 0;1 Direct Global Read & w Exam status 3 ORDER 0;3 Direct Global Read & w The order of status progression for the exam entry. 7 TYPE OF IMAGING 0;7 Direct Global Read & w The Imaging type for the exam status entry. 9 VISTARAD CATEGORY 0;9 Direct Global Read & w ^RA(72,'AVC',VISTARAD CATEGORY,DA Direct global read access to the x-ref. ROUTINE: ******************** 1177 NAME: DBIA1177 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives permission to Imaging to call ^RARTR to display a radiology report. This will be called with RARPT set to the internal entry number for the report to be displayed. ROUTINE: RARTR ******************** 1178 NAME: DBIA1178 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives permission to Imaging to call CREATE^RARIC to write data to the ^RARPT global. This will be called after RA variables are set as done by RAPTLU (for example, RADTE, RACN, RADFN, RADTI, RACNI, etc). A report created through this call by the Imaging Package is a skeletal report that is there solely for the purpose of providing a place to store the Imaging pointer in Field 2005. This is necessary because images are very often captured prior to the report transcription. ROUTINE: RARIC COMPONENT: CREATE VARIABLES: RADTE Type: Input Date/Time of Radiology Exam (external format) RADFN Type: Input Patient's DFN RADTI Type: Input Radiology Case Date/Time (internal format, reverse chronological) RACN Type: Input Case Number, external format RACNI Type: Input Radiology Case Number, internal pointer to ^RADPT RARPT Type: Both Upon return of the call to CREATE^RARIC this is the internal number of the report record. If the report is not created this variable is null. ******************** 1179 NAME: DBIA1179 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives permission to Imaging to call PTR^RARIC to write data to the ^RARPT global. This is called with RARPT set to the internal entry number of the radiology report file and MAGGP set to the internal entry number for the image/object in File 2005. MAGGP will be set into file 74 as the pointer to the image/object. ROUTINE: RARIC COMPONENT: PTR VARIABLES: RARPT Type: Input Internal entry number of radiology report file to receive IMAGE pointer MAGGP Type: Input Internal entry number in File 2005 to be pointed to by report in File 74 Y Type: Output The internal entry of the image number in the Radiology sub file: ^RARPT(RARPT,2005, ******************** 1180 NAME: DBIA1180 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING When using an Imaging VistaRAD workstation the progression of the exam status changes. A new status of INTERPRETED is required to be added by the site to the EXAMINATION STATUS file. This allows the radiologist to move the exam status from EXAMINED to INTERPRETED and will record the Interpreting Radiologist (Primary Interpreting Resident, or Primary Interpreting Staff). Once the interpreter's name is recorded the VistaRad software will execute UP1^RAUTL1 to allow the case to move to the next assigned examination status defined in the EXAMINATION STATUS file for the Imaging location. The request is to allow Imaging VistaRad to execute UP1^RAUTL1. USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives Imaging permission to call UP1^RAUTL1 when updating the Interpreting Radiologist (Primary Interpreting Resident, or Primary Interpreting Staff) from the Imaging VistARad Workstation software. ROUTINE: RAUTL1 COMPONENT: UP1 VARIABLES: RADFN Type: Input Patient's internal entry number (DFN) RADTI Type: Input Internal reverse exam date/time RACNI Type: Input Internal case number ien RAONLINE Type: Input Variable used for a silent call ZTQUEUED Type: Input Variable used for a silent call RAMDV Type: Input Individual division's parameters used during various stages of exam and report processing and inquiring. Exam status updating and accompanying updates to status log, oe/rr ******************** 1181 NAME: DGPM MOVEMENT EVENT CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES The subscribing protocol is: PSD PAT ADT SCHEDULING The subscribing protocol is: SD APPT STATUS ORDER ENTRY/RESULTS REPORTING The subscribing protocols are: ORU AUTOLIST ORU PATIENT MOVMT OCX ORDER CHECK PATIENT MOVE ORU REVIEW DELAYED ORDERS OR GUA EVENT PROCESSOR NOTASK INTEGRATED BILLING The subscribing protocol is: IB CATEGORY C BILLING MENTAL HEALTH The subscribing protocol is: YS PATIENT MOVEMENT DIETETICS The subscribing protocol is: FHWMAS ADVERSE REACTION TRACKING The subscribing protocol is: GMRADGPM MARK CHART GEN. MED. REC. - VITALS The subscribing protocol is: GMRVOR DGPM HINQ The subscribing protocol is: DVB ADMISSION HINQ INPATIENT MEDICATIONS The subscribing protocol is: PSJ OR PAT ADT VISIT TRACKING The subscribing protocol is: VSIT PATIENT STATUS SPINAL CORD DYSFUNCTION The subscribing protocol is: SCD MOVEMENT EVENTS CLINICAL INFO RESOURCE NETWORK The subscribing protocol is: RG ADT INPATIENT ENCOUNTER DRIVER INCOMPLETE RECORDS TRACKING The subscribing protocol is: DGJ INCOMPLETE EVENTS CLINICAL CASE REGISTRIES The subscribing protocol is: ROR EVENT PTF ENROLLMENT APPLICATION SYSTEM The subscribing protocol is: EAS UE INP EVENT LAB SERVICE The subscribing protocol is: LR70 MOVEMENT EVENT VIRTUAL PATIENT RECORD VPR protocol is VPR DG UPDATES. The VPR protocol listeners will store the patient's DFN in an ^XTMP array; another process within HMP watches this global for patients to update and will re-pull a snapshot of the patient's demographics. HEALTH MANAGEMENT PLATFORM HMP v.2.0 attaches HMP INPT EVENTS protocol as an item to the DGPM MOVEMENT EVENTS protocol to trigger unsolicited patient updates from VistA to JDS when a patient movement action occurs. ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: MAR 23,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This is the event invoked by the registration, discharge, or transfer of a patient. Actions from any application area that are dependent on this event may be added to this event upon approval of the DBIC. The variable DGQUIET -MUST- be checked before doing writes to the screen. E.g., W:'$G(DGQUIET) !!,"Updating appointment status..." Please note: If a package has an installation which affects one of the protocols on DGPM MOVEMENT EVENTS, we strongly urge you to disable the following options during installation: Admit a Patient DG ADMIT PATIENT Transfer a Patient DG TRANSFER PATIENT Treating Specialty Transfer DG TREATING TRANSFER Check-in Lodger DGPM CHECK-IN Lodger Check-out DGPM CHECK-OUT Discharge a Patient DG DISCHARGE PATIENT Disposition and Application DG DISPOSITION APPLICATION Extended Bed Control DG BED CONTROL EXTENDED Load/Edit PTF Data DG PTF SCREEN Quick Load/Edit PTF Data DG PTF QUICK LOAD Enter/Edit an IRT DGJ IRT ENTER/EDIT ROUTINE: ******************** 1183 NAME: Health Summary extract routine for Problem List CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 28,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMPLHS COMPONENT: GETLIST(DFN,STATUS) VARIABLES: DFN Type: Input Patient's internal file number STATUS Type: Input A == Active problems I == Inactive problems ALL == All problems TMP('GMPLH Type: Output Problem List will output the following data from the Problem (# 9000011) file in the following global entries: ^TMP("GMPLHS",$J,STATUS,0)= # problems extracted ^ # problems that exist ^TMP("GMPLHS",$J,CNT,0)= Internal Diagnosis (.01) ^ Internal Date Last Modified (.03) ^ External Facility Name (.06) ^ Internal Date Entered (.08) ^ Internal Status (.12) ^ Date of Onset (.13) ^ Responsible Provider (1.05) ^ External Service Name (1.06) ^ Service Abbreviation ^ Internal Date Resolved (1.07) ^ External Clinic Name (1.08) ^ Date Recorded (1.09) ^ External Lexicon Problem Text (1.01) ^ Exposure String (AO/IR/EC/HNC/MST/CV/SHD/CL) ^TMP("GMPLHS",$J,CNT,"N")= External Provider Narrative (.06) ^TMP("GMPLHS",$J,CNT,"L")= Internal Lexicon Problem Text (1.01) ^ External Lexicon Problem Text (1.01) ^TMP("GMPLHS",$J,CNT,"C",Note Facility,Note Number,0)= Note Narrative (9000011.1111,.03) ^ Internal Date Note Added (9000011.1111,.05) ^ External Author Name (9000011.1111,.06) Problems will be ordered by CNT in the same order that Problem List displays them based on Problem List parameters. Only Active comments will be included. ******************** 1184 NAME: GMTSLTR CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 29,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Progress Notes uses the Health Summary package to print large letters between locations when batch prting PNs. I $L($T(^GMTSLTR)) S GMTSLTR=$P(^SC(GMRPCO,0),U,2) D ^GMTSLTR ROUTINE: GMTSLTR COMPONENT: GMTSLTR VARIABLES: ******************** 1185 NAME: DELETE OPTION QUEUING INFORMATION CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: JUN 1,1995 DURATION: Till Otherwise Agr VERSION: FILE: 19 ROOT: DIC(19 DESCRIPTION: TYPE: File We have been tasked with turning off the ODS software. As part of that, we would like to unschedule the nightly background job. The following code will be used in a one time clean-up routine: S DGVER=$$VERSION^XPDUTL("XU") S DIC="^DIC(19,",DIC(0)="QMZ",X="A1B2 BACKGROUND JOB" D ^DIC S (DGIEN,DA)=+Y I DA'>0 G ENQ ; background job not in option file I DGVER<8 S DR="200///@;201///@;202///@;203///@",DIE=DIC D ^DIE I DGVER'<8 S DIK="^DIC(19.2," F DA=0:0 S DA=$O(^DIC(19.2,"B",DGIEN,DA)) Q:'DA D ^DIK ROUTINE: DGYMODS ******************** 1186 NAME: OPTION SCHEDULING FILE ACCESS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: JUN 1,1995 DURATION: Till Otherwise Agr VERSION: FILE: 19.2 ROOT: DIC(19.2 DESCRIPTION: TYPE: File If a site is running KERNEL 8 or higher, we'd like to delete all entries in the SCHEDULED OPTIONS file for the ODS BACKGROUND JOB. Code is as follows: S DGVER=$$VERSION^XPDUTL("XU") S DIC="^DIC(19,",DIC(0)="QMZ",X="A1B2 BACKGROUND JOB" D ^DIC S (DGIEN,DA)=+Y I DA'>0 G ENQ ; background job not in option file I DGVER<8 S DR="200///@;201///@;202///@;203///@",DIE=DIC D ^DIE I DGVER'<8 S DIK="^DIC(19.2," F DA=0:0 S DA=$O(^DIC(19.2,"B",DGIEN,DA)) Q:'DA D ^DIK ROUTINE: ******************** 1187 NAME: DBIA1187 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.34 ROOT: DG(408.34, DESCRIPTION: TYPE: File The IVM package files new Means Tests in the PIMS Means Test module. IVM requests permission to read from the SOURCE OF INCOME TEST file. ^DG(408.34,D0,0 .01 NAME 0;1 Direct Global Read & w Check is done to see if source of Means Test is IVM or VAMC. ROUTINE: ******************** 1188 NAME: DBIA1188 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: MAR 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.41 ROOT: DGMT(408.41, DESCRIPTION: TYPE: File The IVM package files new Means Tests in the PIMS Means Test module. IVM requests permission to read from the Means Test CHANGES file. ^DGMT(408.41,'D', .03 MEANS TEST 0;3 Direct Global Read & w This cross-reference is used to find all records in this file associated with a specific Means Test. When all records for the specific Means Test are found, then a check of the income person field can be done. ^DGMT(408.41,D0,0, .1 INCOME PERSON 0;10 Direct Global Read & w This field will hold the pointer value of the dependent when a name, DOB, SSN or sex change is audited. When an IVM Means Test is deleted, any demographic entries in this file must be restored to 408.12 & 408.13. ROUTINE: ******************** 1189 NAME: DBIA1189-A CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: APR 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: File The purpose of this agreement is to provide access to the Medicine package (custodian) by the Imaging package (subscriber) for the purpose of creating a new Medicine package entry (stub:Pt ID, Date/time) as a holder of an Imaging pointer or set of Imaging pointers. The Imaging pointers are set in the field 2005, as descendants of the 0 subscript of node 2005 in each of the following files: Echo(691), Cardiac Cath(691.1), EKG(691.5), Hematology(694), Endoscopy(699), Generalized Procedure(699.5), and Rheumatology(701). In addition, the MEDICAL PATIENT field (location 0;2) is also permitted for Direct Global Read. The Imaging routines which perform this function are as follows: MAGMCPT* and MAGUFILR ROUTINE: ******************** 1190 NAME: DBIA1189-B CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: APR 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: File The purpose of this agreement is to provide access to the Medicine package (custodian) by the Imaging package (subscriber) for the purpose of editing (including deletion of) Medicine package Image entries. The Imaging pointers are set in the field 2005, as descendants of the 0 subscript of node 2005 on each of the following files: Echo(691), Cardiac Cath(691.1), EKG(691.5), Hematology(694), Endoscopy(699), Generalized Procedure(699.5), and Rheumatology(701). The Imaging routines which perform this function are as follows: MAGMCPT*, MAGUDEL* and MAGUFILR. ROUTINE: ******************** 1193 NAME: DBIA1193 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: APR 6,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This privately supported entry point allows the display the full Medicine report associated with the Imaging Workstation Display. The routine MCMAGDSP has an entry point of REPRT which, when passed the IEN and the Medicine package file number, will display the full report to the Workstation (only). This routine (MCMAGDSP) will be bundled in a patch to Medicine 2.2. It contains display functionality for the following types of Medicine procedures: Electrocardiograms (ECG), Echocardiography (ECHO), Cardiac Catheterization, Hematology (Bone Marrow biopsies and aspirates), Pulmonary Endoscopies, Gastrointestinal Endoscopies, Medicine Consults, Generic Procedures, and Rheumatology. This is the current extent of Medicine procedures that have Imaging pointer fields. This reporting functionality uses the Procedure/Subspecialty file in tandem with the result files to determine the type of procedure. This is necessary as many of the results files share a common structure to house data of different procedure types (as in different CPTs). The MCMAGDSP routine uses the same compiled print templates that Medicine uses and there are also calls to utilities of the common Medicine print driver. ROUTINE: MCMAGDSP COMPONENT: REPRT VARIABLES: MC_IEN Type: Input This is the internal entry number of the Medicine procedure being displayed. This variable is passed by value in the first position of the parameter list. MC_FILE Type: Input This variable is the Medicine package Fileman file number which contains the procedure data to be displayed. This variable is passed by value in the second position of the parameter list. ******************** 1196 NAME: IMAGING/SURGERY MAGSRIC CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: APR 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery Package is given permission to call IM^MAGSRIC to provide image capture capability to users of the operations options ROUTINE: MAGSRIC COMPONENT: IM VARIABLES: SRTN Type: Input Internal id number for this patient's procedure This entry point interacts with user allowing selection of capture mode, capture of image and descriptive text, and storage of image and text data. ******************** 1197 NAME: IFCAP FUND CONTROL POINT INFORMATION CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: APR 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows Generic Code Sheets (version 2.0) to call IFCAP routines from within distributed input templates. The calls will return fund control points and information pertaining to the fund control point which is used to build the FMS code sheets. ROUTINE: PRCSUTCP COMPONENT: $$CP VARIABLES: STATION Type: Input The 3 digit station number passed as parameter 1. PROMPT Type: Input The prompt which should be displayed to the user passed as parameter 2. LEVEL Type: Input The level of access. Pass 0 for none; 1 for official; 2 for clerk; or 3 for requestor as the 3rd parameter. SCREEN Type: Input Any additional VA FileMan screen should be passed as the 4th parameter. DEFAULT Type: Input Default is the optional VA FileMan default response displayed to the user. Default is the name of the control point displayed (not the internal entry number). It should be passed as the 5th paramater. This extrinsic function will return the internal entry number of a selected control point. ******************** 1198 NAME: IFCAP FUND CONTROL POINT INFORMATION CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: GENERIC CODE SHEET USAGE: Private ENTERED: APR 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows Generic Code Sheets (version 2.0) to call IFCAP routines from within distributed input templates. The calls will return fund control points and information pertaining to the fund control point which is used to build the FMS code sheets. ROUTINE: PRCSUT COMPONENT: FY VARIABLES: PRC(FY) Type: Output The variable PRC("FY") is returned as the selected fiscal year. This entry point allows the selection of the fiscal year. COMPONENT: $$BBFY VARIABLES: A Type: Input The 3 digit station number passed as parameter 1. B Type: Input The fiscal year passed as parameter 2. C Type: Input The control point passed as parameter number 3. PRCA Type: Input Pass 1 for no user interaction as parameter 4. This extrinsic function returns the beginning budget fiscal year for a control point. ******************** 1199 NAME: IFCAP FUND CONTROL POINT INFORMATION CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: APR 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows Generic Code Sheets (version 2.0) to call IFCAP routines from within distributed input templates. The calls will return fund control points and information pertaining to the fund control point which is used to build the FMS code sheets. ROUTINE: PRC0C COMPONENT: $$ACC VARIABLES: A Type: Input The 3 digit station number passed as parameter 1. B Type: Input Pass 'fund control point ^ year ^ beginning fiscal year' as parameter 2. This extrinsic function returns a fund control points fund table in the form: a/o code ^ program ^ fcp/prj code ^ object class ^ fund code ^ bfy beginning ^ bfy ending ^ fund trans allowed ^ file 420.14 record id ^ job ^ fill in years appropriation ^ gross/net COMPONENT: $$SEC1 VARIABLES: A Type: Input The 3 digit station number passed as parameter 1. This extrinsic function returns the FMS sec1 code. ******************** 1201 NAME: KERNEL transport MM routine CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: APR 20,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 8 FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel needs to transport MailMan routine XMGAPI4 to sites untill MailMan 7.2 is installed. KIDS will check and only install the routine if it doesn't already exist. ROUTINE: XMGAPI4 COMPONENT: NU VARIABLES: Return if the user has new mail in an array. Useage: N XUXM S %=$$NU^XMGAPI4(1,1,"XUXM") ******************** 1202 NAME: MAGING/SURGERY CLEANUP CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: APR 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery Package is given permission to call CLEAN^MAGSRIC to kill MAG namespaced local variables on exit from routine(s) using IM^MAGSRIC for image capture. ROUTINE: MAGSRIC COMPONENT: CLEAN VARIABLES: Entry point kills MAG namespaced local variables used during image capture. ******************** 1203 NAME: SURGERY/IMAGING REPORT DISPLAY CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IMAGING AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: APR 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Imaging Package is given permission to call SROPRPT to display surgery operation reports. ROUTINE: SROPRPT COMPONENT: SROPRPT VARIABLES: SRTN Type: Input The variable SRTN (which identifies the surgical case) may be defined before making the call. If the variable SRTN is not defined when the call is made, the user will be prompted to select a patient and operation. ******************** 1204 NAME: SURGERY/IMAGING FIELD 2005 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: APR 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File The Surgery Package will reserve field 2005 of File 130 for an IMAGE multiple pointing to File 2005. (The Surgery Package will be adding this field to its package as soon as feasible.) Imaging Package is given permission to set and delete pointers from Field 2005 of File 130. ^SRF(D0,2005, .01 IMAGE 0;1 Direct Global R/W & w/ Surgery Operation Report file. ^SRF( .01 PATIENT 0;1 Direct Global Read & w ROUTINE: ******************** 1205 NAME: KERNEL 8 transport of ORBUTL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: APR 21,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 8.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel 8.0 needs to transport the routine ORBUTL. This routine was modified in order to work with Kernel 8.0. The changes are not compatible with Kernel 7.1. This is a one time release. ROUTINE: ORBUTL ******************** 1206 NAME: DBIA1206 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: APR 28,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.0 FILE: ROOT: DD( DESCRIPTION: TYPE: File During the installation of IFCAP v. 5.0 (namespace PRC) and IFCAP's Generic Inventory Package v. 5.0 (namespace PRCP), direct MUMPS kills of erroneous ^DD nodes need to be done in the Pre-Init After User Commit and the Post-Init routines. The specific nodes are listed below: 1. IFCAP (namespace PRC): a. Field descriptions (node 21) for files and sub-files in the range from 410 to 443.99. The kills are done in the DESCRIP^PRC5INS1 module, which is called from PRC5A, the Pre-Init After User Commit routine. The clean up is necessary as the new description may have fewer lines than the previous description, and, with double question mark help, the left-over lines may appear. b. Erroneous Computed Field nodes for fields currently defined as Free-Text: ^DD(420.01,2,9.01), ^DD(420.01,2,9.1), ^DD(420.01,2,9.2) ^DD(420.01,3,9.01), ^DD(420.01,3,9.1), ^DD(420.01,3,9.2) The kills are done in routine PRC5A, the Pre-Init After User Commit routine. c. Erroneous "IX" node: ^DD(442.8,0,"IX","AE",442.8,.01) The kill is done in routine PRC5A. d. Erroneous "NM" node: ^DD(420.11,0,"NM","SUBACCOUNT") The kill is done in routine PRC5A. 2. Generic Inventory Package of IFCAP (namespace PRCP): a. Field descriptions (node 21) from files and sub-files in the range from 445 to 447. The kills are done in the DESCRIP^PRC5INS1 module, which is called from PRCP5PRE, the Pre-Init After User Commit routine. b. Erroneous "ID" node: ^DD(445.121,0,"ID","WRITE") The kill is done in routine PRCP5POS, the Post-Init routine. c. Erroneous "NM" node: ^DD(445.121,0,"NM","MEMBER OF SET/PACK") The kill is done in routine PRCP5POS. ROUTINE: ******************** 1207 NAME: DBIA1207 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Supported ENTERED: MAY 4,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine 1) Decision Support System (DSS) interface Functional description: This process provides a reporting mechanism to the DSS package. The subscriber passes a Starting date and ending date to the MCARDSS routine and the TMP global will store the result records in an arbitrary order. The results include the following required fields: Date and Time the record is released, Provider signing or signed for, CPT code, Patient identification Software components: Routines -- ^MCARDSS, ^MCBLD, ^MCPTF File(s) -- Procedure Term File: ^MCAR(694.8 Menu Options: None Technical overview: The DSS application makes a parameterized call to ^MCARDSS(Start_date,End_date) with dates in regular Fileman date/time format. Only results which have a valid signature, CPT code, date signed, and valid patient ID will be returned in the ^TMP($J,count) scratch global. The result is stored as follows: Provider ID(DUZ)^Patient ID(DFN)^Date/time signed(FM DATE/TIME)^CPT code for example -- ^TMP(1231231,3)=194^2323^295101010.1232^93005 ROUTINE: MCARDSS COMPONENT: START VARIABLES: The DSS application makes a parameterized call to ^MCARDSS(Start_date,End_date) with dates in regular Fileman date/time format. ******************** 1208 NAME: DBIA1208 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives permission to Imaging to call SET^RAPSET1. The purpose of this call is to set up some variables needed to do exam look-ups, etc. ROUTINE: RAPSET1 COMPONENT: SET VARIABLES: ******************** 1209 NAME: DBIA1209 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: MAY 5,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives permission to Imaging to call ^RACNLU look up a patient by radiology case number. SET^RAPSET1 must be called first to set variables. This is an interactive routine, so other input is provided by the user. ROUTINE: RACNLU ******************** 1210 NAME: PRINT 1010F WITH ENCOUNTER FORMS CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: APR 10,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Allow AICS to print 1010F's for patients who require a means test or thier means test will expire within a specified number of days. ROUTINE: DGMTP COMPONENT: START VARIABLES: DGMTI Type: Used the internal entry number of the means test/copay test, returned from $$LST^DGMTU. DGMTYPT Type: Used The type of test, 1 for Means Test, 2 for Copay test. DGMTDT Type: Used Date of Means Test, returned from $$LST^DGMTU DGOPT Type: Used Pretends called from registration so device not closed when print of 1010 is finished. Allows printing of a 1010F ******************** 1220 NAME: DBIA1220-A CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAY 9,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.6 ROOT: PSNDF( DESCRIPTION: TYPE: File The Consolidated Mail Outpatient Pharmacy package will extract informational data on a daily basis. ^PSNDF(D0,5,1,2) 5 VA PRINT NAME 2;1 Direct Global Read & w 6 VA PRODUCT IDENTIFIE 2;2 Direct Global Read & w 7 TRANSMIT TO CMOP 2;3 Direct Global Read & w 8 VA DISPENSE UNIT 2;4 Direct Global Read & w ROUTINE: ******************** 1223 NAME: DBIA1220-D CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAY 9,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 54 ROOT: DIC(54, DESCRIPTION: TYPE: File The Consolidated Mail Outpatient Pharmacy package modified the input transform for the .01 to prevent the editing of the first 21 entries after the CMOP installation. This will provide consistency in the drug warnings transmitted with drugs to be dispensed by the CMOP. ^DD(54,.01,0) ROUTINE: ******************** 1230 NAME: PRINT A MESSAGE API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 17,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry points in this API print messages: - PR2^XMA0 print a message with a header - HDR^XMA0 print a message without a header - ENTPRT^XMA0 interactive print a message ROUTINE: XMA0 COMPONENT: ENTPRT VARIABLES: DUZ Type: Input The IEN of the user in the NEW PERSON file. XMDUZ Type: Used (optional) The DUZ of the user. Default is DUZ. XMK Type: Input The IEN of the basket in the user's mailbox in which the message to be printed is located. XMZ Type: Input Message IEN in the Message file of the message to be printed. This interactive API lets the user print a message with a header. The message to print is pre-defined, but the user may choose the device to which to print, and which responses to print. COMPONENT: HDR VARIABLES: DUZ Type: Input The IEN of the user in the NEW PERSON file. XMDUZ Type: Used (optional) The DUZ of the user. Default is DUZ. XMK Type: Input The IEN of the basket in the user's mailbox in which the message to be printed is located. XMZ Type: Input Message IEN in the Message file of the message to be printed. IO Type: Input The device to which the message is to be printed. XMTYPE Type: Used (optional) Lets you determine from which response to start printing. If XMTYPE="^", then abort. If ";"-piece 6 is null or zero, or if '$D(XMTYPE), the message is printed in its entirety. If ";"-piece 6 is a number, the message will be printed from that response to the end. The other ";"-pieces are ignored. Headerless print a message. Compare to PRTMSG^XMXAPI (DBIA 2729). Usage: IO has been defined with a KERNEL device call. S XMK=basket IEN S XMZ=message IEN D HDR^XMA0 ; prints the message in its entirety - or - S $P(XMTYPE,";",6)=3 D HDR^XMA0 ; prints the message from response 3 to the end. COMPONENT: PR2 VARIABLES: DUZ Type: Input The IEN of the user in the NEW PERSON file. XMDUZ Type: Used (optional) The DUZ of the user. Default is DUZ. XMK Type: Input The IEN of the basket in the user's mailbox in which the message to be printed is located. XMZ Type: Input Message IEN in the Message file of the message to be printed. IO Type: Input The device to which the message is to be printed. XMTYPE Type: Used (optional) Lets you determine from which response to start printing. If XMTYPE="^", then abort. If ";"-piece 6 is null or zero, or if '$D(XMTYPE), the message is printed in its entirety. If ";"-piece 6 is a number, the message will be printed from that response to the end. The other ";"-pieces are ignored. Print a message with a header. Compare to PRTMSG^XMXAPI (DBIA 2729). Usage: IO has been defined with a KERNEL device call. S XMK=basket IEN S XMZ=message IEN D PR2^XMA0 ; prints the message in its entirety - or - S $P(XMTYPE,";",6)=3 D PR2^XMA0 ; prints the message from response 3 to the end. ******************** 1231 NAME: DBIA1231 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE USAGE: Controlled Subscri ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6 DESCRIPTION: TYPE: File This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 1232 NAME: INTERACTIVE REPLY TO A MESSAGE API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 23,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API lets the user interactively reply to a message in his mailbox. There are two ways to invoke it: D ^XMAH1 or D ENTA^XMAH1. ROUTINE: XMAH1 COMPONENT: ENTA VARIABLES: XMDUZ Type: Input DUZ of the user who is replying to the message. XMK Type: Input IEN of the basket in the user's mailbox where the message is located. XMZ Type: Input Message IEN in the Message file of the message to which the user is replying. XMDF Type: Used (optional) If $D(XMDF), then normal restrictions on message addressing are ignored: - Ignore 'domain closed' - Ignore 'keys required for domain' - Ignore 'message length restrictions to remote addressees' Interactive reply to a message in your mailbox. Inclusion of previous responses is not possible. All rules of replying to a message apply: If the user is a surrogate, read or send permission is required. If the message is in the WASTE basket, it will be moved to another basket. If the message is 'information only', you can't reply. Usage: S XMDUZ=user's DUZ, XMK=basket IEN, XMZ=message IEN D ENTA^XMAH1 or D ^XMAH1 ******************** 1233 NAME: INTERACTIVE ANSWER OR SEND A MESSAGE API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 24,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API lets the user answer a message or send a message. When you send an answer to a message, the original message is copied into the answer, the user edits the answer, the user's network signature is appended to the end of the answer, and the whole thing is automatically addressed to the sender of the original message. ROUTINE: XMA11A COMPONENT: WRITE VARIABLES: XMDUZ Type: Input DUZ of the user who is answering or sending a message. X Type: Used If $E(X)="A", then the user will answer a message. Otherwise, the user will send a message. XMZ Type: Used Message IEN in the Message file of the message being answered. Required if the user is answering a message. Not required (and ignored) if the user is sending a message. Interactive answer a message or send a message. Usage: To answer a message: S XMDUZ=User's DUZ S X="A" S XMZ=IEN of message being answered D WRITE^XMA11A To send a message: S XMDUZ=User's DUZ D WRITE^XMA11A ******************** 1234 NAME: DBIA1234 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM EQUIPMENT/TURN-IN REQUEST ORDER ENTRY/RESULTS REPORTING E CLAIMS MGMT ENGINE CLINICAL PROCEDURES ADVERSE REACTION TRACKING ADDED 10/14/2008 EMERGENCY DEPARTMENT MENTAL HEALTH BAR CODE MED ADMIN USAGE: Controlled Subscri ENTERED: MAY 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.1 ROOT: DIC(3.1 DESCRIPTION: TYPE: File ^DIC(3.1 .01 NAME 0;1 Direct Global Read & w Name field. Title File. ROUTINE: ******************** 1235 NAME: DBIA1235 CUSTODIAL PACKAGE: PROSTHETICS SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 662 ROOT: RMPR(662, DESCRIPTION: TYPE: File ROES V2.0 references the Pros Disability Code File to print and display a patient's rated disabilities. Access is read only for the ARABIC DISABILITY NAME (.01) field and the "B" cross-reference of the .01 field. ^RMPR(662,i,0) .01 ARABIC DISABILITY NA Read w/Fileman The .01 field contains the name of the prosthetic disability selected. PROS DISABILITY CODE ROUTINE: ******************** 1236 NAME: DBIA1236 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: JUN 16,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To support Medicine 2.2 with 4 new components the $$HL7^MCORMN(MESSNUM) entry point needs to be called. This interface will allow Health Summary to get patient data for a breif summary, a brief summary for only abnormal values, a full summary and a full captioned summary. It will also support the existing one line medicine summary. This interface is setup in an HL7 compliant manner. HS will need to have the Pateint DFN, Beginning Date, Ending Date, # of occurrences, and Type of Date (Full or Brief) set into a message via the ^XMD call. The $$HL7^MCORMN(MESSNUM) call will retrieve the available data based on the above specifications and using the message number returned from the ^XMD call. Data that will be returned via the message is DATE/TIME, PROCEDURE, SUMMARY, PROCEDURE SUMMARY, and the PROCEDURE REPORT. ROUTINE: MCORMN COMPONENT: $$HL7(MESSNUM) VARIABLES: MESSNUMB Type: Input Done with parameter passing. Type: This is an extrinsic function that returns the message number holding the returned information. ******************** 1237 NAME: DBIA1237 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REMOTE ORDER/ENTRY SYSTEM USAGE: Private ENTERED: MAY 31,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DD( DESCRIPTION: TYPE: File The pre-init routines for ROES V2.0 change several file names, clean up leftover DD nodes, and an obsolete cross-reference. These changes were suggested by the verifier to maintain consistency throughout the system. 1. The screen on the 'BATTERY TYPE FURNISHED' field is deleted with a Kill command. GLOBAL REFERENCE: ^DD(791810.0101,.02,12) ^DD(791810.0101,.02,12.1) 2. The old name of field 791810.0101 is cleaned up in ORDER^RMPFPOST. FileMan creates a duplicate NM node when a subfile name changes. GLOBAL REFERENCE: ^DD(791810.0101,0,"NM","TRANSACTION") 3. The 'AD' cross-reference on the .01 field of file number 791810 is killed with a direct kill in EXIT^RMPFPRE routines. The following is a capture of the code: EXIT F X=0:0 S X=$O(^DD(791810,.01,1,X)) Q:'X D .K:$G(^DD(791810,.01,1,X,0))="791810^AD^MUMPS" ^DD(791810,.01,1,X) K ^DD(791810,0,"IX","AD",791810,.01) GLOBAL REFERENCE: ^DD(791810,.01,X,0) ^DD(791810,0,"IX","AD",791810,.01) 4. The file names of files 791810, 791810.1, 791810.2, 791812 are changed using DIE like the following: S DIE=1,DA=701810,DR=".01////STATION ORDER" D ^DIE ROUTINE: ******************** 1238 NAME: DBIA1238 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY LAB SERVICE SPINAL CORD DYSFUNCTION ADDED JSHARVEY/ 20070122 as per Swesky's request. USAGE: Controlled Subscri ENTERED: MAY 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point VISIT^PXRHS01 to retrieve Visit, ICD-9, CPT, and Provider data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: VISIT(DFN,ENDDT,BEGDT,OCCLIM,CATCODE,EXTRCODE,TIMEORD) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum number of visits returned CATCODE - Pattern Match which controls visit data that is returned (Can include multiple codes) A = AMBULATORY H = HOSPITALIZATION I = IN HOSPITAL C = CHART REVIEW T = TELECOMMUNICATIONS N = NOT FOUND S = DAY SURGERY O = OBSERVATION E = EVENT (HISTORICAL) R = NURSING HOME D = DAILY HOSPITALIZATION DATA X = ANCILLARY PACKAGE DAILY DATA EXTRCODE - Pattern Match indicating which optional data is returned (Can be multiple) P = return PROVIDER data C = return CPT (procedure) data D = return ICD-9 (diagnosis) data TIMEORD - Order visits on same day are indexed Default is inverse cronological order 1 = Time order in regular cronological order OUTPUT : Data from VISIT (9000010) file except for hosp. loc. abbr. ^TMP("PXHSV",$J,InvExDt,COUNT,0) = VISIT/ADMIT DATE&TIME [I;.01] ^ TYPE [E;.03] ^ LOC. OF ENCOUNTER [E;.06] ^ SERVICE CATEGORY [E;.07] ^ CHECK OUT DATE&TIME [I;.18] ^ HOSPITAL LOCATION [E;.22] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ OUTSIDE LOCATION [E;2101] ^ CLINIC [E;.08] ^ WALK IN/APPT [E;.16] ^ LEVEL OF SERVICE [E;.17] ^ ELIGIBILITY [E;.21] Data from V CPT (9000010.18) file ^TMP("PXHSV",$J,InvExDt,COUNT,"C",X) = CPT [I;.01] ^ PROVIDER NARRATIVE [E;.04] ^TMP("PXHSV",$J,InvExDt,COUNT,"C",X, MODIFIER [E;1/.01]) = "" Data from V POV (9000010.07) file ^TMP("PXHSV",$J,InvExDt,COUNT,"D",X) = POV [I;.01] ^ MODIFIER [E;.06] ^ CAUSE OF DX [E;.07] ^ PLACE OF ACCIDENT [E;.11] ^ PRIMARY/SECONDARY [E;.12] ^TMP("PXHSV",$J,InvExDt,COUNT,"D",X,"N") = PROVIDER NARRATIVE [E;.04] Data from V PROVIDER (9000010.06) file ^TMP("PXHSV",$J,InvExDt,COUNT,"P",X) = PROVIDER [E;.01] ^ PRIMARY/SECONDARY [E;.04] Data from V HOSPITALIZATION (9000010.02) file (If Service Category is for hospitalization) ^TMP("PXHSV",$J,InvExDt,COUNT,"H",X) = DATE OF DISCHARGE [I;.01] ^ ADMITTING DX [E;.12] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: InvExDt - Inverse FileMan date of DATE OF visit [.01] Count - # of entry ROUTINE: PXRHS01 COMPONENT: VISIT VARIABLES: ******************** 1239 NAME: DBIA1239 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING VA CERTIFIED COMPONENTS - DSSI CLINICAL PROCEDURES NATIONAL HEALTH INFO NETWORK USAGE: Controlled Subscri ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point IMMUN^PXRHS03 to retrieve immunization data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: IMMUN(DFN,PXFG,PXFILTER) INPUT : DFN - Pointer to PATIENT file (#2) PXFG - Primary sort order (Optional; defaults to "S") "S": Alphabetical by Immunization Short Name, or Name (if Short Name is null). (Since Short Name is not standardized and is null for newer immunization (post- PX*1*201), the "S" argument has been deprecated, and is only supported for backward compatibility purposes). "A": Alphabetical by Immunization Name "C": Chronological "R": Reverse Chronological PXFILTER - (Optional) Allows filtering based off Vaccine Group Name, IEN, or CVX. "G:XXX": Only include immunizations for Vaccine Group Name XXX. "I:XXX": Only include immunizations for Immunization IEN XXX. "C:XXX": Only include immunizations for CVX code XXX. OUTPUT : Data from V Immunization (9000010.11) file ^TMP("PXI",$J,Sort,Sort2,IFN,0) = IMMUNIZATION [E; .01] ^ IMMUNIZATION SHORT NAME [E;9999999.14,.02] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ SERIES CODE [I;.04] ^ SERIES [E;.04] ^ REACTION [E;.06] ^ CONTRAINDICATED [I;.07] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXI",$J,Sort,Sort2,IFN,1) = HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXI",$J,Sort,Sort2,IFN,2) = ROUTE OF ADMIN [E;1302] ^ SITE OF ADMIN [E;1303] ^ DOSAGE [E;1312.5] ^ DOCUMENTER [E;1206] ^TMP("PXI",$J,Sort,Sort2,IFN,3) = LOT [E;.05] ^ MANUF [E;9999999.41;.02] ^ EXP DATE [I;9999999.41;.09] ^TMP("PXI",$J,Sort,Sort2,IFN,4)= RESULTS [E;1401] ^ READING [E;1402] ^ DATE/TIME READ [I;1403] ^ READER [E;1404] ^ READING RECORDED [I;1405] ^ HOURS READ [E;1406] ^TMP("PXI",$J,Sort,Sort2,IFN,"RCOM")= READING COMMENT [E;1501] ^TMP("PXI",$J,Sort,Sort2,IFN,"FN") = CDC FULL VACCINE NAME [E;9999999.14;2] ^TMP("PXI",$J,Sort,Sort2,IFN,"R",CNT) = REMARKS [E;1101] ^TMP("PXI",$J,Sort,Sort2,IFN,"S") = DATA SOURCE [E;80102] ^TMP("PXI",$J,Sort,Sort2,IFN,"VIS",CNT) = VIS OFFERED TO PATIENT [E;2] ^ EDITION DATE [I;920;.02] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: If PXFG Equals: Then subscript will be: ======= =========================== Sort - S Immunization short name, or Name truncated to 10 characters (if short name is null) A Immunization Name C FileMan date of Date of Event or Visit R Inverse FileMan date of Date of Event or Visit Sort2 - C or R Immunization name A or S Inverse FileMan date of Date of Event or Visit IFN - Internal Record # ROUTINE: PXRHS03 COMPONENT: IMMUN VARIABLES: ******************** 1240 NAME: DBIA1240 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY CLINICAL PROCEDURES USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point SKIN^PXRHS04 to retrieve skin test data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: SKIN(DFN) INPUT : DFN - Pointer to PATIENT file (#2) OUTPUT : Data from V SKIN TEST (9000010.12) file ^TMP("PXS,$J,SKIN,InvDt,IFN,0) = SKIN TEST [E;.01] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ RESULTS CODE [I;.04] ^ RESULTS [E;.04] ^ READING [E;.05] ^ DATE READ [I;.06] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXS",$J,SKIN,InvDt,IFN,1) = ^ HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [ E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXS",$J,SKIN,InvDt,IFN,"S") = DATA SOURCE [E;80102] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: SKIN - Skin Test name InvDt - Inverse FileMan date of DATE OF event or visit IFN - Internal Record # ****** ROUTINE: PXRHS04 COMPONENT: SKIN VARIABLES: ******************** 1241 NAME: DBIA1241 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point EXAM^PXRHS05 to retrieve Exam data.Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: EXAM(DFN,ENDDT,BEGDT,OCCLIM) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum # of each type of exam returned OUTPUT : Data from V EXAM (9000010.13) file ^TMP("PXE,$J,EXAM,InvDt,IFN,0) = EXAM [E;.01] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ RESULTS CODE [I;.04] ^ RESULTS [E;.04] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^ ^TMP("PXE",$J,EXAM,InvDt,IFN,1) = HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXE",$J,EXAM,InvDt,IFN,"S") = DATA SOURCE [E;80102] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: EXAM - EXAM name InvDt - Inverse FileMan date of DATE OF event or visit IFN - Internal Record # ROUTINE: PXRHS05 COMPONENT: EXAM VARIABLES: ******************** 1242 NAME: DBIA1242 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point TREAT^PXRHS06 to retrieve Treatment data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: TREAT(DFN,ENDDT,BEGDT,OCCLIM,CATCODE) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum number of days for which data is returned (If multiple visits on a given day, all data for these visit will be returned) or an "R" for only the most recent occurrence of each topic Note: If event date is used, it may appear that too many occurrences are retrieved but it is based on visit date not event date. returned (Can include multiple codes) CATCODE - Pattern Match which controls visit data that is A = AMBULATORY H = HOSPITALIZATION I = IN HOSPITAL C = CHART REVIEW T = TELECOMMUNICATIONS N = NOT FOUND S = DAY SURGERY O = OBSERVATION E = EVENT (HISTORICAL) R = NURSING HOME D = DAILY HOSPITALIZATION DATA X = ANCILLARY PACKAGE DAILY DATA OUTPUT : Data from V TREATMENT (9000010.15) file ^TMP("PXT,$J,InvDt,TREAT,IFN,0) = TREATMENT [E;.01] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ HOW MANY [I;.04] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXT",$J,InvDt,TREAT,IFN,1) = HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXT",$J,InvDt,TREAT,IFN,"S") = DATA SOURCE [E;80102] ^TMP("PXT",$J,InvDt,TREAT,IFN,"P") = PROVIDER NARRATIVE [E;.06] ^TMP("PXT",$J,InvDt,TREAT,IFN,"PNC") = PROVIDER NARR. CATEGORY [E;80201] [] = [I(nternal)/E(xternal); Optional file # ; Record #] Subscripts: InvDt - Inverse FileMan date of DATE OF event or visit minus time TREAT - TREATMENT PROVIDED IFN - Internal Record # ROUTINE: PXRHS06 COMPONENT: TREAT VARIABLES: ******************** 1243 NAME: DBIA1243 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point HF^PXRHS07 to retrieve Health Factor data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: HF(DFN,ENDDT,BEGDT,OCCLIM,ITEMS) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum number of days for which data is returned for each Health Factors item. If multiple visits on a given day, all data for these visit will be returned. Note: If event date is used, it may appear that too many occurrences are retrieved but it is it is based on visit date not event date. ITEMS - Optional array containing a selected list of HF Categories. If not used will get all catergories of health factors. OUTPUT : Data from V HEALTH FACTORS (9000010.23) file ^TMP("PXF,$J,HFC,HF,InvDt,IFN,0) = Health Factor [E;.01] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ SHORT NAME [E;9999999.64;.04] ^ LEVEL/SEVERITY [E;.04] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXF",$J,HFC,HF,InvDt,IFN,1) = HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXF",$J,HFC,HF,InvDt,IFN,"S") = DATA SOURCE [E;80102] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: HFC - Health Factor Category name HF - Health Factor name InvDt - Inverse FileMan date of DATE OF event or visit IFN - Internal Record # ROUTINE: PXRHS07 COMPONENT: HF VARIABLES: ******************** 1244 NAME: DBIA1244 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point MEAS^PXRHS09 to retrieve Measurement data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: MEAS(DFN,ENDDT,BEGDT,OCCLIM) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum number of days for which data is returned (If multiple visits on a given day, all data for these visit will be returned) Note: If event date is used, it may appear that too many occurrences are retrieved but it is based on visit date not event date. OUTPUT : Data from V MEASUREMENT (9000010.01) file ^TMP("PXM",$J,TYPE,InvDt,IFN,0) = TYPE [E;.01] ^ MEASUREMENT TYPE DESCRIPTION [E;9999999;.02] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ VALUE [E;.04] ^ ORDERING PROVIDER [E;1202] ^ CLINIC [3;1203] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXM",$J,TYPE,InvDt,IFN,1) = HOSPITAL LOCATION [E;1205] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXM",$J,TYPE,InvDt,IFN,"S") = DATA SOURCE [E;80102] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: TYPE - Measurement Type InvDt - Inverse FileMan date of DATE OF event or visit IFN - Internal Record # ROUTINE: PXRHS09 COMPONENT: MEAS VARIABLES: ******************** 1245 NAME: ENGINEERING XREF CLEAN UP CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: JUL 20,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 7.0 FILE: 6914 ROOT: DD(6914 DESCRIPTION: TYPE: File Engineering exported a series of cross references in the Equipment Inv (#6914) file to support the upload of equipment data to the ISMS system. These mumps cross references were never activated because the ISMS system was not brought on line. These cross references are now obsolete and should be removed from the Equipment Inv file. The following cross references will be deleted with patch EN*7*25 using code in a PRE-INIT AFTER USER COMMIT routine. CROSS-REFERENCE FIELD # FIELD NAME --------------- ------- ---------------------- AI1 1 MANUFACTURER AI2 2 PARENT SYSTEM AI27 4 MODEL AI3 5 SERIAL # AI0 7 TYPE OF ENTRY AI5 10 VENDOR POINTER AI6 11 PURCHASE ORDER # AI7 12 ACQUISITION VALUE AI8 12.5 LEASE COST AI9 13 ACQUISITION DATE AI10 13.5 ACQUISITION SOURCE AI11 15 LIFE EXPECTANCY AI12 16 REPLACEMENT DATE AI13 18 CATEGORY STOCK NUMBER AI26 19 CMR AI14 20 USE STATUS AI15 20.1 OWNERSHIP AI16 20.5 TURN-IN DATE AI17 22 DISPOSITION DATE AI18 23 PHYSICAL INVENTORY DATE AI19 31 DISPOSITION METHOD AI20 32 DISPOSITION VALUE AI21 33 CONTROLLED ITEM? AI22 34 CAPITALIZED? AI23 36 COST CENTER AI24 38 GENERAL LEDGER ACCOUNT AI25 39 YALD CODE AI28 51 REPLACING (ENTRY NUMBER) Code similar to the following will be used in the pre-init to delete the cross references from the data dictionary. ENXGIPR ;WIRMFO/SAB-PRE INIT ;7/21/95 ;;7.0;ENGINEERING;**25**;Aug 17, 1993 N ENFX Q:'$D(DIFROM) W !,"Performing Pre-Init...",! XREF ; delete any obsolete ISMS cross references W !,"Deleting obsolete xrefs from Equipment Inv (#6914) file..." F ENFX="1^AI1","2^AI2","4^AI27","5^AI3","7^AI0","10^AI5", "11^AI6","12^AI 7","12.5^AI8","13^AI9","13.5^AI10" D DELXREF ($P(ENFX,U),$P(ENFX,U,2)) F ENFX="15^AI11","16^AI12","18^AI13","19^AI26","20^AI14" ,"20.1^AI15","20.5^AI16","22^AI17" D DELXREF($P(ENFX,U),$P(ENFX,U,2)) F ENFX="23^AI18","31^AI19","32^AI20","33^AI21","34^AI22", "36^AI23","38^AI24","39^AI25","51^AI28" D DELXREF($P(ENFX,U),$P(ENFX,U,2)) XREFEND ; end of delete obsolete ISMS cross references EXIT ; W !,"Completed Pre-Init",! Q DELXREF(ENF,ENX) ; for field number ENF delete xref ENX N ENI Q:'$D(^DD(6914,0,"IX",ENX,6914,ENF)) ; already deleted S ENI=0 F S ENI=$O(^DD(6914,ENF,1,ENI)) Q:'ENI D .K:$G(^DD(6914,ENF,1,ENI,0))=("6914^"_ENX_"^MUMPS") ^DD(6914,ENF,1,ENI) K ^DD(6914,0,"IX",ENX,6914,ENF) K:'$O(^DD(6914,ENF,1,0)) ^DD(6914,"IX",ENF) ; no xrefs left on field W !," ",ENX," xref deleted from field ",ENF Q The following DD nodes may be deleted ^DD(6914,field number,1,ien for xref) ^DD(6914,0,"IX",xref,6914,field number) ^DD(6914,"IX",field number) This will only be done if there are no cross references left on the field. (i.e. '$O(^DD(6914,field number,1,0)) is true). ROUTINE: ******************** 1246 NAME: DGPMDDCF CALLS CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows other packages to call the following tags in the routine DGPMDDCF: WIN, RIN, BOS, AUTH, and OPER. These calls return info on whether wards and beds are in service and the number of beds in service, authorized, and operating for a given ward. ROUTINE: DGPMDDCF COMPONENT: WIN VARIABLES: D0 Type: Input IEN of WARD LOCATION file. DGPMOS Type: Input Date to determine if ward is out of service as of. X Type: Output 1 if ward out of service, 0 if in service, or -1 if input variables not defined properly. Requires D0 to be passed as the IEN of the WARD LOCATION (file #42) which you'd like to know is active or not. DGPMOS can be passed as a date to compute whether the ward is in service (it assumes DT if not defined). Returns a 1 if ward is inactive as of date or 0 if it's active. -1 returned if D0 not defined or date not valid. COMPONENT: RIN VARIABLES: D0 Type: Input IEN of ROOM-BED file DGPMOS Type: Input Date for which you'd like to know if room-bed is in service. Optional: assumes DT if left undefined. X Type: Output Returned as 1 if bed is out of service, 0 if it's in service, or -1 if the input variables are not defined properly. Requires D0 to be passed as the IEN of the ROOM-BED (file #405.4) which you'd like to know is active or not. DGPMOS can be passed as a date to compute whether the bed is in service (it assumes DT if not defined). Returns a 1 if bed is inactive as of date or 0 if it's active. -1 returned if D0 not defined or date not valid. COMPONENT: BOS VARIABLES: D0 Type: Input IEN of WARD LOCATION file DGPMOS Type: Input Date for which to return calculation. Assumes DT if undefined. X Type: Output Number of beds out of service on ward as of date in question. Computes number of beds out of service for a given ward. D0 defines the WARD LOCATION IEN and DGPMOS can be passed as the date on which to make the computation (assumes DT if undefined). COMPONENT: AUTH VARIABLES: D0 Type: Input IEN of WARD LOCATION file DGPMOS Type: Input Optional variable defining date for which to return calculation. Assumes DT if left undefined. X Type: Output Number of authorized beds for ward requested as of date selected. Returns number of authorized beds for WARD LOCATION defined by D0 as of date defined in DGPMOS (assumes DT if not defined). COMPONENT: OPER VARIABLES: D0 Type: Input IEN of WARD LOCATION file DGPMOS Type: Input Optional variable to define date for which you'd like number of operating beds returned. Assumes DT if left undefined. X Type: Output Number of operating beds for ward requested on date input. Computes the number of operating beds for a WARD LOCATION defined in the variable D0 on a date defined by DGPMOS (assumes DT if left undefined). ******************** 1247 NAME: DBIA1247 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY LAB SERVICE USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point VISIT^PXRHS12 to retrieve Hospitalization Visit, ICD-9, CPT, and Provider data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: VISIT(DFN,ENDDT,BEGDT,OCCLIM) INPUT : DFN - Pointer to PATIENT file (#2) ENDDT - Ending date/time in internal FileMan format - Defaults to today's date at 11:59 pm BEGDT - Beginning date/time in internal FileMan format - Defaults to one year prior to today's date OCCLIM - Maximum number of visits returned OUTPUT : Data from VISIT (9000010) file except for hosp. loc. abbr. ^TMP("PXHSV",$J,InvExDt,COUNT,0) = VISIT/ADMIT DATE&TIME [I;.01] ^ TYPE [E;.03] ^ LOC. OF ENCOUNTER [E;.06] ^ SERVICE CATEGORY [E;.07] ^ CHECK OUT DATE&TIME [I;.18] ^ HOSPITAL LOCATION [E;.22] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ OUTSIDE LOCATION [E;2101] ^ CLINIC [E;.08] ^ WALK IN/APPT [E;.16] ^ LEVEL OF SERVICE [E;.17] ^ ELIGIBILITY [E;.21] Data from V CPT (9000010.18) file ^TMP("PXHSV",$J,InvExDt,COUNT,"C",X) = CPT [I;.01] ^ PROVIDER NARRATIVE [E;.04] ^TMP("PXHSV",$J,InvExDt,COUNT,"C",X,MODIFIER [E;1/.01]) = "" Data from V POV (9000010.07) file ^TMP("PXHSV",$J,InvExDt,COUNT,"D",X) = POV [I;.01] ^ MODIFIER [E;.06] ^ CAUSE OF DX [E;.07] ^ PLACE OF ACCIDENT [E;.11] ^ PRIMARY/SECONDARY [E;.12] ^TMP("PXHSV",$J,InvExDt,COUNT,"D",X,"N") = PROVIDER NARRATIVE [E;.04] Data from V PROVIDER (9000010.06) file ^TMP("PXHSV",$J,InvExDt,COUNT,"P",X) = PROVIDER [E;.01] ^ PRIMARY/SECONDARY [E;.04] Data from V HOSPITALIZATION (9000010.02) file (If Service Category is for hospitalization) ^TMP("PXHSV",$J,InvExDt,COUNT,"H",X) = DATE OF DISCHARGE [I;.01] ^ ADMITTING DX [E;.12] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: InvExDt - Inverse FileMan date of DATE OF visit [.01] Count - # of entry ROUTINE: PXRHS12 COMPONENT: VISIT VARIABLES: ******************** 1248 NAME: DBIA1248 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to call the entry point MEAS^PXRHS20 to retrieve Measurement data. Input data will be done via parameter passing and output data will be placed in the ^TMP global in the specified format that is described in this agreement. Entry point: MEAS(DFN,PATDOB,SEX,ENDDT,BEGDT,OCCLIM,MSRPANEL) INPUT: DFN - Pointer to PATIENT file (#2) PATDOB - Patient's Date of Birth in MM/DD/YY Format SEX - Patient's Sex ("M" for Male and "F" for Female) OCCLIM - Maximum number of days for which data is returned (If multiple visits on a given day, all data for these visit will be returned) Note: If event date is used, it may appear that too many occurrences are retrieved but it is based on visit date not event date. MSRPANEL - Pointer to Health Summary Meas Panel (9001017) file OUTPUT: Data from V MEASUREMENT (9000010.01) file ^TMP("PXM",$J,InvDt,ORDER,IFN) = VALUE [E;.04] ^ Optional error note for BMI and RW values If a transform exists in file 9001017 for this panel item, it will be applied to VALUE. Data from HEALTH SUMMARY MEAS PANEL (9001017) file ^TMP("PXF",$J,PNAME,ORDER)= PANEL COMPONENT [E;9001017.01;1] ^ FIELD WIDTH [E;9001017.01;2] ^ LABEL [E;9001017.01;3] ^ NOTE TO DISPLAY [E;9001017.01;5] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: InvDt - Inverse FileMan date of DATE OF event or visitr visit TYPE - Measurement Type IFN - Internal Record # ORDER - Order in Panel PNAME - Measurement Panel Name ROUTINE: PXRHS20 COMPONENT: MEAS VARIABLES: ******************** 1249 NAME: DIC(10, CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAY 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 10 ROOT: DIC(10, DESCRIPTION: TYPE: File The integration agreement allows reading (with FileMan only) the ABBREVIATION field (#2) of the RACE file (#10). ^DIC(10,D0,0) 2 ABBREVIATION 0;2 Read w/Fileman This field contains the abbreviation for this race entry. ROUTINE: ******************** 1251 NAME: DBIA 1251 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 150.9 ROOT: DIC(150.9, DESCRIPTION: TYPE: File PCE debugging utility calls Fileman to display the entry number 1 to the user so that they can review it. ^DIC(150.9,1,4) 402 SITE PART OF VISIT I 4;2 Direct Global Read & w This is check by the PCE debugging utility to see if it has been set. ROUTINE: ******************** 1252 NAME: PRIMARY CARE INPUT AND OUTPUT API CALLS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine SDUTL3 contains 2 input APIs and 3 output APIs which allow enter of/return of the CURRENT PC PRACTITIONER and CURRENT PC TEAM. The three output APIs will continue to be supported. The two input APIs will be supported as long as the two fields exist in the patient file. The approximate time for deletion of these fields is March 1 2000. ROUTINE: SDUTL3 COMPONENT: $$OUTPTPR(DFN[,SCDATE][,SCPCROLE]) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2) SCDATE Type: Input Relevant Date (Default=DT) SCPCROLE Type: Input Type of PC Role (Default =1 (PC Practitioner),2=Attending) Function: $$OUTPTPR^SDUTL3(DFN) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. Output: CURRENT PC PRACTITIONER in Internal^External format Internal- If there is a successful lookup for the CURRENT PC PRACTITIONER, this is a pointer to the NEW PERSON file (#200). If it is not successful, a 0 is returned. External- If there is a successful lookup, this is the practitioner's name, as entered in the NAME field (#.01) of file #200. If there is not a successful lookup, this is null. COMPONENT: $$OUTPTTM(DFN[,SCDATE][,ASSTYPE]) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2) ASSTYPE Type: Input Assignment Type (Default=1: PC Team) SCDATE Type: Input Date of interest (Default=DT) Output API for CURRENT PC TEAM field: ===================================== Function: $$OUTPTTM^SDUTL3(DFN) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. Output: CURRENT PC TEAM in Internal^External format Internal- If there is a successful lookup for the CURRENT PC TEAM, this is a pointer to the TEAM file (#404.51), which is distributed with this patch. If the lookup is not successful, a 0 is returned. External- If there is a successful lookup, this is the team's name, as entered in the NAME field (#.01) of file #404.51. If there is not a successful lookup, this is null. COMPONENT: INPTPR(DFN,PRACT) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2) PRACT Type: Input Internal entry number of the NEW PERSON file (#200) denoting the practitioner assigned to the patient. SDOKS Type: Output 1 if addition was successful or 0 if it was not. Subroutine: INPTPR^SDUTL3(DFN,PRACT) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. PRACT- This is a required parameter that is a pointer to file #200 associated with the patient's primary care practitioner. Output: SDOKS- This is 1 if the data is stored successfully, 0 otherwise. COMPONENT: INPTTM(DFN,TEAM) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2) TEAM Type: Input Then internal entry number of the TEAM file associated with the patient. SDOKS Type: Output 1 if addition was successful or 0 if it was not. Subroutine: INPTTM^SDUTL3(DFN,TEAM) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. TEAM - This is a required parameter that is a pointer to the TEAM file, which associate with this patient's primary care team. Output: SDOKS- This is 1 if the data is stored successfully, 0 otherwise. COMPONENT: $$OUTPTAP(DFN[,SCDATE]) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2) SCDATE Type: Input Relevant Date (Default=DT) Function: $$OUTPTAP^SDUTL3(DFN) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. Output: CURRENT PC ASSOCIATE PROVIDER in Internal^External format. Internal - If there is a successfule lookup for the CURRENT PC ASSOCIATE PROVIDER, this is a pointer to the PERSON file (#200). If it is not successful, a 0 is returned. External - If there is a successfule lookup, this is the provider's name as entered in the field (#.01) of file #200. If there is not a successfule lookup, this is null. ******************** 1253 NAME: DBIA1253 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: HEALTH SUMMARY CLINICAL REMINDERS Added 11/21/18, effective with PXRM*2*44. USAGE: Controlled Subscri ENTERED: MAY 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File The Health Summary Package desires to set up an integration agreement with the Problem List Package to access the Problem (#900011) file. Health Summary needs to check if the Problem List file contains a specific ICD9 code (diagnosis) for a given patient. The "AC" cross reference is checked to get problem entries for a patient. DFN is the internal patient record number. The Diagnosis pointer (1st piece of the 0 node) and Date Entered (8th piece of the 0 node) are retrieved for each record found. This is done in the following manner: S GMTSHRFE="" F S GMTSHRFE=$O(^AUPNPROB("AC",DFN,GMTSHRFE)) Q:'GMTSHRFE S Y=$P(^AUPNPROB(GMTSHRFE,0),U),GMTSHRID=$P(^(0),U,8), GMTSHRIC=$P(^ICD9(Y,0),U)_" " ^AUPNPROB('AC',DFN,REC # ^AUPNPROB(REC #,0) .01 DIAGNOSIS Direct Global Read & w .08 date entered Direct Global Read & w ROUTINE: ******************** 1254 NAME: DBIA1254 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000001 ROOT: AUPNPAT( DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to access the ^PXRHS13 routine to get a patient's location of home. ^AUPNPAT(DFN,12,REC #, 1201 LOCATION OF HOME Direct Global Read & w ROUTINE: PXRHS13 COMPONENT: LOC VARIABLES: DFN Type: Input Patient's internal record number. This entry point returns a Patient's Location of Home from the Patient/IHS (#9000001) file. This routine will return the data in the ^TMP global in the following format: ^TMP("PXLOC",$J,LINE NUMBER) = LOCATION OF HOME (#1201) WORD PROCESSING FIELD. ******************** 1255 NAME: DBIA1255 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: AUG 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package files new Means Tests into the PIMS Means Test module. This routine contains utilities for Means Test processing. ROUTINE: DGMTSCU2 COMPONENT: STA VARIABLES: DGCAT Type: Input The variable DGCAT is the Means Test category code. DGMTYPT Type: Input The variable DGMTYPT is 1 for type of test (Means Test). DGMTS Type: Output The variable DGMTS points to the Means Test status in the MEANS TEST STATUS file (#408.32). DGTYC Type: Output The variable DGTYC is the code for the type of care the Means Test status is associated with. This call is used to determine Means Test status and type of care. ******************** 1256 NAME: DBIA1256 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: HEALTH SUMMARY AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING LAB SERVICE USAGE: Controlled Subscri ENTERED: AUG 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 811.9 ROOT: PXD(811.9 DESCRIPTION: TYPE: File This IA is for packages needing to point to the Reminder Definition (#811.9) file. The Selection Item (.01) field in the Structure Multiple (field 1) of the Health Summary Type (#142) file points to the file #811.9. The Selection File (.01) field in the Selection File Multiple (Field 7) of the Health Summary Component (#142.1) file points to the file #811.9. Health Summary also requires the ability to add the application group "GMTS" ^DIC(811.9) when the Reminder Definition file exists. This is done with a VA Fileman call in the Health Summary Preinit Routine. ^PXD(811.9,D0,0) .01 NAME 0;1 Pointed to ROUTINE: ******************** 1257 NAME: DBIA1257 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH The IVM package files new Means Tests into the PIMS Means Test module. The variable DGMTYPT1 is 3 for type of test (Means Test or Copay). BENEFICIARY TRAVEL Beneficiary Travel use $$LST^DGMTCOU1 to return the last Means Test or RX Copay IEN in a single pass by passing the variable DGMTYPT1 = 3. The information returned is then used to determine what is displayed on the Bene Travel information screen 1 for Income, Source of Income and MT Status. It is also used as one of the requirements to determine if an auto waiver is granted for the Bene Travel deductible. The Bene Travel application reads Means Test/Copay data. It does NOT update the Means Test and/or RX-Copay test. USAGE: Private ENTERED: AUG 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine contains utilities for Means Tests/Copay processing. ROUTINE: DGMTCOU1 COMPONENT: $$LST(DFN,DGDT,DGMTYPT1) VARIABLES: DFN Type: Input The variable DFN points to the patient in the PATIENT file (#2). DGDT Type: Input The variable DGDT is the date/time used for determining the last test for the patient. DGMTYPT1 Type: Input The variable DGMTYPT1 is for type of test (Means Test or Copay). 1-Means Test, 2-Copay, 3-Either Means Test or Copay (Default) OUT Type: Output The output from this function is the last Means Test or Copay for the patient. This call is used to determine last Means Test or Copay for a patient. ******************** 1259 NAME: DBIA1259 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 30,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9001017 ROOT: APCHSMPN( DESCRIPTION: TYPE: File The Health Summary Package desires to set up an integration agreement with the PCE Package to point to the Health Summary MEAS Panel (#9001017) file. The Selection Item (.01) field in the Structure Multiple (field 1) of the Health Summary Type (#142) file points to this file. The Selection File (.01) field in the Selection File multiple (field 7) of the Health Summary Component (#142.1) file points to this file. Health Summary also requries the ability to add the application group "GMTS" to ^DIC(9001017) when the Health Summary MEAS Panel file exists. This is done with a fileman call. ^APCHSMPN(REC #,0) .01 NAME 0;1 Pointed to ROUTINE: ******************** 1261 NAME: DBIA1261 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 9,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File The Patient Care Encounter Package would like to do a direct global read on a Problem List node. ^AUPNPROB(IEN,0) .02 PATIENT NAME 0;2 Direct Global Read & w This is the patient for whom this problem has been observed and recorded. This file contains patient specific problems entered by the various providers of service ROUTINE: ******************** 1265 NAME: OE/RR conversion needs sched admissions CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 20,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3.0 FILE: 41.1 ROOT: DGS(41.1 DESCRIPTION: TYPE: File The OE/RR version 3 conversion would like permission to loop through the "C" index of the scheduled admission file. It will then access the 0 node to get the PATIENT pointer. ^DGS(41.1,C Uses C cross-reference to get future scheduled admissions. ^DGS(41.1,DA,0) .01 PATIENT 0;1 Direct Global Read & w Retrieves PATIENT file pointer for use to determine OE/RR record to convert. ROUTINE: ******************** 1268 NAME: DBIA1268 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 31,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.64 ROOT: AUTTHF( DESCRIPTION: TYPE: File The Health Summary Package desires to set up an integration agreement with the PCE Package to point to the Health Factors (#9999999.64) file. The Selection Item (.01) field in the Structure Multiple (field 1) of the Health Summary Type (#142) file points to the Health Factors file. The Selection File (.01) field in the Selection File multiple (field 7) of the Health Summary Component (#142.1) file points to the Health Factors file. Health Summary also requires the ability to add the application group "GMTS" ^DIC(9999999.64) when the Health Factors files exists. This is done with a Fileman Call. ^AUTTHF(REC #,0) .01 FACTOR Pointed to ROUTINE: ******************** 1273 NAME: DBIA1273 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: AUG 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: Routine The Health Summary Package desires to set up an integration agreement with the PCE Package to access the described API to the Visit (#900010) file. VISIT^PXRHS14(DFN,FROM,RECNO,OCCLIM,CATCODE,PSTAT) INPUT: DFN - Pointer to PATIENT file (#2). FROM - Index entry from which to begin the list. Passed by reference. RECNO - Record number. Passed by reference. OCCLIM - Maximum number of visits to return. CATCODE - Pattern Match which controls visit data that is returned (Can include multiple codes). A = AMBULATORY H = HOSPITALIZATION I = IN HOSPITAL C = CHART REVIEW T = TELECOMMUNICATIONS N = NOT FOUGERY O = OBSERVATION E = EVENT (HISTORICAL) R = NURSING HOME D = DAILY HOSPITALIZATION DATA X = ANCILLARY PACKAGE DAILY DATA PSTAT - Patient Status. 1 = Inpatient 0 or NULL = Outpatient OUTPUT: Data fro0) file except for hosp. loc. abbr. ^TMP("PXV",$J,InvExDt,RecNo,0) = VISIT/ADMIT DATE&TIME [I;.01] ^ LOC. OF ENCOUNTER [E;.06] ^ SERVICE CATEGORY [E;.07] ^ CLINIC [E;.08] ^ WALK IN/APPT [E;.16] ^ EVALUATION AND MANAGEMENT CODE [E;.17] ^ HOSPITAL LOCATION [E;.22] [] = [I(nternal)/E(xternal); Field #] Subscripts: InvExDt - Inverted Visit Date from "AA" x-ref RecNo - Record Number NOTE: Calling routine is required to delete ^TMP("PXV",$J). It can be deleted between multiple calls to this entry point or after the calling routine makes the last call depending on how the data needs to be accumulated. ^AUPNVSIT(0) ^AUPNVSIT('AA',DFN,VISIT,REC #) ^AUPNVSIT(REC #,0) .01 VISIT/ADMIT DATE&TIM Direct Global Read & w .08 CLINIC Direct Global Read & w ROUTINE: PXRHS14 COMPONENT: VISIT(DFN,FROM,RECNO,OCCLIM,CATCODE,PSTAT) VARIABLES: ******************** 1277 NAME: DBIA1277 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUN 1,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These routine calls are used by Integrated Billing to determine (1) How a user may be allowed to delete an Insurance Company from the INSURANCE COMPANY (#36) file, and (2) To cause the Accounts Receivable module to re-point the debtor (which corresponds to the Insurance Company being deleted) of all applicable AR records to a new debtor. ROUTINE: RCAMINS COMPONENT: DEL(INS) VARIABLES: INS Type: Input This is a pointer to an insurance company in file #36. Y Type: Output This extrinsic function returns the following values: 0 - Either a valid pointer to file #36 was not passed into the function, or the company is not established as a debtor in Accounts Receivable. 1 - The company is established as a debtor in AR, but there are no receivables where the debtor is the primary payor. 2 - The company is established as a debtor in AR and there are receivables where the debtor is the primary payor. This call is used to determine whether an insurance company may be outright deleted in Integrated Billing, or whether a second insurance company must be specified in order to merge all billing/receivables information from the company to be deleted into the second company. COMPONENT: EN(INS,INS1,INS2,ERROR) VARIABLES: INS Type: Input This is a pointer to the insurance company in file #36 which is to be deleted. INS1 Type: Input This is a pointer to the insurance company in file #36 into which all applicable AR records will be merged. ERROR Type: Both This variable is passed into this routine by reference. If the input passed into this entry point is not valid, this variable will contain an error message. Otherwise, the variable is set to null. INS2 Type: Input This variable is a flag which is set to 1 when a second insurance carrier into which the AR data should be merged is NOT specified. The flag indicates that AR should only conduct a search for the insurance carrier being deleted in IB in all the receivables stored in the ACCOUNTS RECEIVABLE (#430) file. Any pointers to this company in the SECONDARY INSURANCE CARRIER (#19) or TERTIARY INSURANCE CARRIER (#19.1) fields of this file should be deleted. This call is used to re-point the debtor for all applicable Accounts Receivable records from the insurance company to be deleted to a second insurance company. COMPONENT: INS2(ROOT,COUNT) VARIABLES: ROOT Type: Input A global array is passed as input to this entry point. The variable ROOT is a string which is the root of that global array. The array elements themselves are then referenced through indirection. COUNT Type: Both COUNT is passed by reference to this entry point. It is updated each time a secondary or tertiary carrier is updated in file #430. The updated value is passed back to IB and reported to the user. This entry point is called by Integrated Billing during a clean-up job which is queued after the user deletes an insurance company. An array containing one or more deleted companies is passed to AR, and a search is conducted through file #430 for all secondary and tertiary insurance carriers which must either be merged or deleted. ******************** 1278 NAME: DBIA1278 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JUN 1,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The ACCOUNTS RECEIVABLE package will call the entry point BILL in the routine IBCNSCD1 to allow the IB package to merge or delete the Primary Insurance Carrier on corresponding bills in IB. ROUTINE: IBCNSCD1 COMPONENT: BILL VARIABLES: BILL Type: Input .01 value in file #399 INS Type: Input internal entry number in file #36 INS1 Type: Input internal entry number in file #36 The call will parameter pass as follows: BILL^IBCNSCD1(parameter1,parameter2,parameter3) where parameter1 = the .01 field value in file #399 parameter2 = the internal pointer value in file #36 of the original Primary Carrier on the bill parameter3 = the internal pointer value in file #36 of the Insurance company which will replace the original Primary Insurance Carrier on the bill This may a null value indicating a deletion. ******************** 1279 NAME: DBIA1279 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUN 5,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Integrated Billing plans to release the enhancement patch IB*2*28 within 4-6 weeks. We need to update the zeroth node of an entry in the ITEM (#10) multiple in one of our menu protocol (file #101) entries. The easiest way we have found to effect that change is to delete the item from the menu protocol, and have the onits re-add the item, with the new zero node in the multiple, back into the menu protocol. We are formally requesting permission to delete the item which points to the protocol IBCNS QUIT from the menu protocol IBCNSC INSURANCE CO in the post-init of patch IB*2*28. The item would immediately be re-added by invoking the onit right after the deletion. ROUTINE: ******************** 1281 NAME: DBIA183 - A CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING REGISTRATION AUTOMATED INFO COLLECTION SYS USAGE: Controlled Subscri ENTERED: JUN 6,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PSOSD1 COMPONENT: DFN VARIABLES: PSONOPG Type: Input Variable to indicated that the Action Profiles shouldn't close the device. = "" or 1, indicates that the Action Profiles shouldn't close the device. = 2, indicates that the Action Profiles shouldn't close the device & not to throw a page at the beginning. PSOPAR Type: Input Indicates if Bar codes should be printed with Action Profies. PSOINST Type: Input Variable that contains site name information. DFN Type: Input Internal entry number for the Patient File [Required] PSDAYS Type: Input The number of days which will cut canceled and expired Rx's from the profile. If this variable is not defined, a default of 45 will be used. PSTYPE Type: Input 1 for Action Profile, 0, null, or undefined for Informational This entry point returns a Outpatient Pharmacy Action Profile. ******************** 1282 NAME: OPTION FILE ENTRY/EXIT FIELDS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: GENERIC CODE SHEET USAGE: Private ENTERED: JUN 26,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2 FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File This integration agreement allows the Generic Code Sheet package version 2.0 to update the OPTION file's (#19) ENTRY and EXIT ACTION fields (#20 and #15) in the routine GECXPOST. The routine GECXPOST is distributed with patch GEC*2*2. The routine GECXPOST will change the ENTRY ACTION field from calling an unsupported Generic Code Sheet entry point to a supported entry point (as defined in integration agreement #1089). It will also change the EXIT ACTION field from null to 'K GECSSYS' where GECSSYS is a supported Generic Code Sheet variable. The options defined as ' GECS*' will have the ENTRY and EXIT ACTION changed. is defined as the namespace as follows: ABSV BLD CHAP DENT DG ESP FB FH GMRC LBRC LR MC NURS PLAY PRCC PRSP PRSP PS RA RMPR SR SOWK VOLU YS ^DIC(19,DA,20) 20 ENTRY ACTION 20;E1,24 Direct Global R/W & w/ The ENTRY ACTION will be changed to call a supported Generic Code Sheet reference. An example of the change for the option FH GECS CODE EDIT: Before: S GECSSYS="DIETETICS" D EDIT^GECSE1 After : S GECSSYS="DIETETICS" D EDIT^GECSCALL where EDIT^GECSCALL is the supported Generic Code Sheet entry point. ^DIC(19,DA,15) 15 EXIT ACTION 15;E1,24 Direct Global R/W & w/ The EXIT ACTION will be changed to kill the variable GECSSYS which is set in the ENTRY ACTION of the menu option. ROUTINE: ******************** 1283 NAME: MAILMAN - Access 'as if' a server CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 28,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Invoking GET^XML with XMCHAN="SERVER" (or any other appropriate channel) sets up the variables available to servers (that channel) invoked during normal delivery. Note that before XMREC is executed, XMZ must be defined; XMER and XMRG are defined by executing XMREC. XMPOS can be changed by the user if appropriate. ========================================================================== Execute variable XMREC to read a line of the message. XMER and XMRG are returned. XMER This variable returns the execution status of XMREC. XMER<0, if there is no more message text to read. The value of XMER will be zero (0), if XMRG is being returned. XMRG, in that case, will have as its value the text of the next line of the message. (Note: which may be null, i.e. a blank line; you cannot test it for being done!) XMRG The value of XMRG will be the next line of message text. XMRG will always be defined, though it will be null when XMER<0. XMPOS This variable contains the current position of the text returned in the variable XMGR. It is initialized if it is undefined and should be killed by the server when it is finished "Reading" the message. Prototype Message Body Reader S XMCHAN="SERVER" GET^XML N A,TEXT ; N MIRROR S A=0 A ; X XMREC ; Receive a line I $D(XMER) G Q:XMER<0 ; Check for end of message S A=A+1 ; Increment local line count S TEXT(A)=XMRG ; Set local array ; S MIRROR(XMPOS)=XMRG ; MIRROR will have the same subscripts ; as the original message G A ; Go back for another line VARIABLES: XMZ Input The internal number of the message to be processed. XMPOS Input The number of the last line read (or null). XMPOS Output The number of the "next" line in the message; if no further lines, XMPOS="" XMER Output 0 unless no lines greater than XMPOS, then -1 XMRG Output line XMPOS of message XMZ ROUTINE: XML COMPONENT: GET VARIABLES: Invoking GET^XML with XMCHAN="SERVER" sets up the variables available to servers invoked during normal delivery. In particular XMREC is defined and can be used the manner documented fully in DBIA 1151 (and partially above). ******************** 1284 NAME: INTERACTIVE READ/MANAGE MESSAGES OPTION CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 5,1995 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API lets the user read and manage the messages in his mailbox. ROUTINE: XMA COMPONENT: REC VARIABLES: DUZ Type: Input User's IEN in the NEW PERSON file. This entry lets the user read and manage the messages in his mailbox. It is the same as the XMREAD option under the XMUSER menu. Compare this to READ^XMXAPIU (DBIA 2774). It may be placed in a menu option as follows: Entry action: S XMMENU(0)= Routine: REC^XMA Exit action: K XMMENU D CHECKOUT^XM ******************** 1296 NAME: DBIA 1296 GETLST~IBDF18A CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER TEXT INTEGRATION UTILITIES ORDER ENTRY/RESULTS REPORTING CLINICAL PROCEDURES VISTA INTEGRATION ADAPTOR Used for Patient Service-getVisitTypeCptByClinic. USAGE: Controlled Subscri ENTERED: AUG 15,1995 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PCE team requests an agreement to call the following API. ROUTINE: IBDF18A COMPONENT: GETLST VARIABLES: GETLST^IBDF18A(CLINIC,INTRFACE,ARY,FILTER,COUNT,MODIFIER,ENCDA TE) --returns any specified selection list for a clinic --input CLINIC= Pointer to hospital location file for a clinic. INTRFACE= name of selection list in package interface file. Note: the ICD-10 patch IBD*3.0*63 introduces the new additional value "DG SELECT ICD DIAGNOSIS CODES" that can be passed as a parameter, which is introduced to return either ICD-9 or ICD-10 codes depends on the encounter date passed in ENCDATE parameter. This new parameter value works exactly the same as the existing "DG SELECT ICD-9 DIAGNOSIS CODES" item from the package interface file to provide backward compatibility. ARY= name of array to return list in FILTER= predefined filters (optional,defalut=1) 1= must be selection list 2= only visit cpts on list COUNT= number of items already in the ARY MODIFIER= if modifiers are to be passed, 1=yes send modifiers ENCDATE = encounter date --output The format of the returned array is as follows @ARY@(0)=count of array element (0 if nothing found) @ARY@(1)=^group header @ARY@(2) = P1 := cpt or icd code / ien of other items P2 := user defined text P3 := quantity (number of occurrences) P6 := user defined expanded text to send to PCE P7 := second code or item defined for line item P8 := third code or item defined for line item P9 := associated clinical lexicon term @ARY@(2,"MODIFIER",0)=count of CPT Modifiers for entry @ARY@(2,"MODIFIER",1)=2 character CPT Modifier value @ARY@(2,"MODIFIER",2)=2 character CPT Modifier value @ARY@(2,"MODIFIER",k+1)=2 character CPT Modifier value @ARY@(k)=^next group header @ARY@(k+1)=problem ien or cpt or icd code^user defined text Narrative to Send to PCE (instead of printed text) field (2.01) in file 357.3, added as piece 6 of @ARY@(n). If additional codes for an item (diagnosis) are added to item, they are added as pieces 7 and/or 8 of @ARY@(n). If a type of visit code is requested and none found, will automatically look first for blocks named type of visit and second for filtered codes using regular cpt blocks. If a diagnosis block it requested and none found will automatically look for Clinic Common Problem List and then convert it to look like a diagnosis list. ******************** 1297 NAME: OE/RR conversion needs wait list file CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 20,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3.0 FILE: 42.5 ROOT: DGWAIT( DESCRIPTION: TYPE: File The OE/RR version 3.0 orders conversion would like permission to loop through the WAIT LIST file to get current/pending waiting list entries. We use this to determine records to convert early in the process. ^DGWAIT(C,DFN,DIV,DA Uses C index to loop through WAIT LIST file by patient, division, and IEN ^DGWAIT(DIV,P,IEN,ADM) 13 DATE ADMITTED ADM;1 Direct Global Read & w Uses DATE ADMITTED field to determine if the patient has already been admitted (patient no longer waiting for admission) ROUTINE: ******************** 1298 NAME: PXK VISIT DATA EVENT CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL REMINDERS LAB SERVICE CLINICAL CASE REGISTRIES ENROLLMENT APPLICATION SYSTEM The subscribing protocol is: - EAS UE PCE EVENT HEALTH MANAGEMENT PLATFORM HMP PCE EVENTS protocol ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: AUG 16,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Scheduling Developers are requesting permission to hook the the protocol named SDAM PCE EVENT to the ITEM multiple of the protocol named PXK VISIT DATA EVENT. This protocol event point was developed to publish data collected by PCE during an encounter via manual data entry or scanned encounter forms. The data represents elements that are stored in the Visit file (9000010) and other PCE V-Files. The data is stored in a ^TMP global array with subscripts denoting the category of published data. An AFTER and BEFORE subscript are included to distinguish changes made to data elements during the encounter session. The data published in the ^TMP global represents data from one encounter. The structure of the ^TMP global that is published is: ^TMP("PXKCO",$J,VISIT,"V FILE STRING",V FILE RECORD,DD SUBSCRIPT, "AFTER/BEFORE")=DATA In cases where there is a CPT modifier, the following structure will be used, this will capture multiple entries for the sub-file. ^TMP("PXKCO",$J,VISIT,"V FILE STRING",V FILE RECORD,DD SUBSCRIPT, "AFTER/BEFORE",DATA)="" In cases where there is an Immunization VIS, Other Diagnosis, or Remarks, the following structure will be used, this will capture multiple entries for the sub-file. ^TMP("PXKCO",$J,VISIT,"V FILE STRING",V FILE RECORD,DD SUBSCRIPT, "AFTER/BEFORE",V SUBFILE RECORD)=DATA Temporary global file root: ^TMP Subscript Piece: 1 Description: String notation representing Package Contents: "PXKCO" Subscript Piece: 2 Description: Job Number Contents: $J Subscript Piece: 3 Description: Internal Entry Number of the Visit (IEN) Contents: Number Subscript Piece: 4 Description: String representing the Visit or V file data category. The "SOR" string refers to the PCE Data Source file (839.7) which is not a V-File. Contents: "CPT" = V CPT (procedure) 9000010.18 "HF" = V Health Factors 9000010.23 "ICR" = V Imm Contra/Refusal Events 9000010.707 "IMM" = V Immunization 9000010.11 "PED" = V Patient Ed 9000010.16 "POV" = V POV (diagnosis) 9000010.07 "PRV" = V Provider 9000010.06 "SK" = V Skin Test 9000010.12 "SOR" = PCE Data Source 839.7 "TRT" = V Treatment 9000010.15 "VST" = Visit file 9000010 "XAM" = V Exam 9000010.13 "CSTP" = Visit file 9000010 This subscript contains child visits used to store additional Stop Codes. Subscript Piece: 5 Description: Internal entry number of the entry in the file represented in subscript #4 Contents: Number Subscript Piece: 6 Description: Subscript or DD node on which the data is stored. Every DD node is published whether or not there is any data for that node. The exception to this is when an entry is deleted from the file, only the 0 node is posted. "ELAP" is the exception. There is no DD subscript in the Visit file that corresponds to this string. "ELAP" represents the patient's eligibility and appointment type for the encounter and has the following structure: ^TMP("PXKCO",$J,VISIT,"VST",VISIT,"ELAP","BEFORE") or ^TMP("PXKCO",$J,VISIT,"VST",VISIT,"ELAP","AFTER") Contents: 0 800 811 or "ELAP" Subscript Piece: 7 Description: String designating whether or not the data is an "AFTER" or "BEFORE" reflection of the data. * If all the "BEFORE"s are blank, then the data represents a new entry. * If a node was edited, the "BEFORE" is the value before it was edited, and the "AFTER" is the value after is was edited. * If the file entry was deleted, only the 0 node is returned; the "AFTER" is blank, and the "BEFORE" is the 0 node as it appeared before it was deleted. Contents: "AFTER" "BEFORE" Subscript Piece: 8 Description: For Immunizations that contain VIS, Other Diagnosis, or Remarks, this subscript will contain the Internal Entry Number (IEN) of the multiple for this sub-file entry. DATA: The DATA that exists to the right of the global node is a reflection of data as it appears in the global node of the IEN of the file (noted in subscript #5) and the NODE of that IEN (described in subscript #6). Refer to the Data Dictionary for the Visit and V-Files for the format of the data. The data stored on the "ELAP" node is the only exception to this. "ELAP" does not represent a Data Dictionary node and does not have a corresponding DD definition. The data stored on this node has the following structure: ELIG PTR^ELIG TEXT^APPT PTR^APPT TEXT ROUTINE: COMPONENT: PXK VISIT DATA EVENT VARIABLES: ******************** 1299 NAME: DBIA1299 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 15,1997 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. A direct reference to the Drug file is requested for the Price Per Dispense Unit field so the VA Cost of a drug can be calculated and billed. ^PSDRUG(D0,660) 16 PRICE PER DISPENSE U 660;6 Direct Global Read & w ROUTINE: ******************** 1300 NAME: DBIA1300-A SDCO21 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: JUL 19,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Patient Care Encounter Developers would like to request private permission to call the following entry points in routine SDCO21 with the purpose of obtaining outpatient classification requirements. IA #1301 is also associated with this request. ROUTINE: SDCO21 COMPONENT: CLOE VARIABLES: CLOE^SDCO21(SDOE,SDCLOEY) INPUT -- SDOE Outpatient Encounter file IEN. OUTPUT -- SDCLOEY Classification Array Set for Outpatient Encounter Subscripted by Class Type file IEN.Null or 409.42 IEN^ INTERNAL VALUE^1=n/A^=unedt COMPONENT: CL VARIABLES: CL~SDCO21(DFN,SDDT,SDOE,SDCLY) INPUT -- DFN Patient IEN SDDT Date/Time SDOE Outpatient Encounter file IEN [optional] OUTPUT -- SDCLY Classification array subscripted by class. Type file (#409.41) IEN. COMPONENT: $$SEQ() VARIABLES: X Type: Output String containing Classification Type Sequence by IEN, "3,7,1,2,4,8,5,6,9" corresponding to SC,CV,AO,IR,EC,SHAD,MST,HNC,CLV. Classification Type Sequence by IEN ******************** 1301 NAME: DBIA1300-B PATIENT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: AUG 17,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Patient Care Encounter would like to request to directly read the following fields in the PATIENT file (# 2). Our goal is to reach the pointer value of the OUTPATIENT ENCOUNTER file (# 409.68) ^DPT(D0,S,D1,0) .001 APPOINTMENT DATE/TIM Direct Global Read & w Appointment DATE/TIME .01 CLINIC 0;1 Direct Global Read & w Pointer to the clinic from the Hospital Location file 21 OUTPATIENT ENCOUNTER 0;20 Direct Global Read & w Pointer to the Outpatient Encounter file (# 409.68) 3 STATUS 0;2 Direct Global Read & w current status of the patient's appointment 9 PURPOSE OF VISIT 0;7 Direct Global Read & w reason this patient has this clinic appointment ROUTINE: ******************** 1302 NAME: OE/RR conversion needs discharges CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 20,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3.0 FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File OE/RR version 3.0 orders conversion would like permission to loop through discharges within 30 days of the OE/RR version 3.0 installation date. This is done to ensure that orders for recently discharged patients are converted early in the process. ^DGPM('AMV3',discharge date,dfn loops through AMV3 x-refs to get discharges by date and by patient. Uses the patient pointer to call OE/RR conversion. ROUTINE: ******************** 1306 NAME: V PROVIDER FILE CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.06 ROOT: AUPNVPRV( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1307 NAME: V POV FILE CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.07 ROOT: AUPNVPOV( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1308 NAME: V IMMUNIZATION FILE CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.11 ROOT: AUPNVIMM( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1309 NAME: V SKIN TEST CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1310 NAME: V EXAM CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.13 ROOT: AUPNVXAM( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1311 NAME: V TREATMENT CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.15 ROOT: AUPNVTRT( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1312 NAME: V PATIENT EDUCATION CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.16 ROOT: AUPNVPED DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1313 NAME: V CPT CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.18 ROOT: AUPNVCPT( DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1314 NAME: V HEALTH FACTORS CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF DESCRIPTION: TYPE: File The Patient Care Encounter Package requests permission to READ,WRITE,EDIT and DELETE data to and from this file DIRECTLY and with VA FILEMAN. ROUTINE: ******************** 1315 NAME: IHS FILES CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Patient Care Encounter Package requests a DBIA to distribute the following Indian Health Service files in the VA. ---Visit Related Files-- V PROVIDER 9000010.06 AUPNVPRV( V POV 9000010.07 AUPNVPOV( V IMMUNIZATION 9000010.11 AUPNVIMM( V SKIN TEST 9000010.12 AUPNVSK( V EXAM 9000010.13 AUPNVXAM( V TREATMENT 9000010.15 AUPNVTRT( V PATIENT EDUCATION 9000010.16 AUPNVPED( V CPT 9000010.18 AUPNVCPT( V HEALTH FACTORS 9000010.23 AUPNVHF( ---Supporting files EDUCATION TOPIC 9999999.09 AUTTEDT( IMMUNIZATION 9999999.14 AUTTIMM( EXAM 9999999.15 AUTTXAM( TREATMENT 9999999.17 AUTTTRT( SKIN TEST 9999999.28 AUTTSK( HEALTH FACTORS 9999999.64 AUTTHF( ROUTINE: ******************** 1320 NAME: SDAM APPOINTMENT EVENTS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER The subscribing protocol is: PXK SDAM TO V-FILES INTEGRATED BILLING The subscribing protocol is: IBACM OP LINK ORDER ENTRY/RESULTS REPORTING The subscribing protocol is: ORU PATIENT MOVMT REGISTRATION The subscribing protocols are: - DG MEANS TEST REQUIRED - VAFED EDR OUTPATIENT CAPTURE - DGEN PATIENT ENROLLMENT - DGEN ENROLLED VETERANS REPORT PROSTHETICS The subscribing protocol is: RMPR SCH EVENT CLINICAL INFO RESOURCE NETWORK The subscribing protocol is: RG ADT OUTPATIENT ENCOUNTER DRIVER ENROLLMENT APPLICATION SYSTEM The subscribing protocol is: - EAS UE SCHED EVENT OUTPATIENT PHARMACY IMAGING The subscribing Protocol is: SDAM APPOINTMENT EVENTS Added 10/23/2006 at the request of Zach Fain/Scheduling and Peter Kuzmak/Imaging. SURGERY 7/10/12-Surgery protocol is SRQ APPOINTMENT EVENT SUBSCRIBER distributed in SR*3.0*180. VIRTUAL PATIENT RECORD VPR*1*3 patch will be adding the capability to keep the VPR data cache up-to-date, so this ICR is for subscribing to SDAM APPOINTMENT EVENTS protocol events with listener VPR APPT EVENTS. BAR CODE EXPANSION Added BCE 10/9/14. The Bar Code Enhancement - Transfusion Verification project, new package MJCF*1.0.KID (no patch) will hang MJCF OUTPATIENT EVENT MONITOR on the SDAM APPPOINTMENT EVENTS protocol in order to receive information as to when a patient is admitted (checked-in) to a clinic. This is necessary to insure that people receiving blood transfusions are an admitted patient for the Positive Patient identification project. VA POINT OF SERVICE (KIOSKS) VA Point of Service (Kiosks) needs to provide real-time patient appointment status changes to the VetLink staff-facing module. VPS requests to add the subscribing protocol VPS SEND APPT to SDAM APPOINTMENT EVENTS protocol. The VPS SEND APPT protocol will be invoked in response to SDAM appointment trigger events to send and HL7 message with a patients new or changed appointment status. INPATIENT MEDICATIONS 3/2/16-Inpatient Meds has been added as a subscriber to ICR #1320 for the Pharmacy Interface Automation Project (PSJ*5*317). Inpatient Meds is not directly calling SDAM APPOINTMENT EVENTS. The PIA software is subscribing to the event driver through VAFC HL7 OUTPATIENT CAPTURE by adding PSJ SIU-SDAM ROUTER protocol as a subscriber to VAFC ADT-A08-SDAM SERVER. HEALTH MANAGEMENT PLATFORM HMP v.2.0 adds HMP APPT EVENTS protocol as an item to the SDAM APPOINTMENT EVENTS protocol to trigger unsolicited updates from VistA to JDS when appointment actions and/or activities occur. ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: JAN 8,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This is the event that is invoked when an action is taken upon an appointment, such as check in. ^TMP("SDEVT",$J,SDHDL,SDPROC,"SDOE",SDOE,0,"AFTER") = Zero node of encounter after change SDHDL = Handle (can get more than one at a time) SDPROC = Originating process 1 = Appointment 2 = Add/Edit 3 = Disposition 4 = Credit Stop (ignore these) SDOE = Pointer to encounter ^TMP('SDEVT',$J, ^TMP("SDEVT",$J,SDHDL,SDPROC,"SDOE",SDOE,0,"AFTER") = Zero node of encounter after change SDHDL = Handle (can get more than one at a time) SDPROC = Originating process 1 = Appointment 2 = Add/Edit 3 = Disposition 4 = Credit Stop (ignore these) SDOE = Pointer to encounter ROUTINE: ******************** 1324 NAME: DBIA1324-A CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2005 ROOT: MAG(2005 DESCRIPTION: TYPE: File This DBIA documents Radiology/Nuclear Medicine's use of a global node belonging to the Imaging package to determine whether the Imaging package has been installed at a given facility. ^MAG(2005,0) The Radiology/Nuclear Medicine package performs the following test to determine if the Image File #2005 is populated: I $O(^MAG(2005,0)) ROUTINE: ******************** 1325 NAME: DBIA1324-B CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2005 ROOT: MAG(2006.1 DESCRIPTION: TYPE: File This DBIA documents Radiology/Nuclear Medicine's use of a global node owned by the Imaging package to determine if images are scanned in before a reports are entered. ^MAG(2006.1,AXSCN) The global node ^MAG(2006.1,"AXSCN") is present if images are scanned before reports are entered. ROUTINE: ******************** 1326 NAME: DBIA1324-C CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents a line label reference within the Radiology/Nuclear Medicine package to a routine in the Imaging package. ROUTINE: MAGSET3 COMPONENT: MED VARIABLES: This routine is called to set the mode on the workstation screen used to display abstracts and images during case and report look-up within the Radiology package. COMPONENT: ERASE VARIABLES: This routine call erases the imaging workstation screen in preparation for displaying an abstract or report during case or report lookup through the Radiology/Nuclear Medicine Package. ******************** 1327 NAME: DBIA1327 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IBQ Package requests use of the function $$VNDT^IBTRV to extract Review date. ROUTINE: IBTRV COMPONENT: $$VNDT VARIABLES: IBTRV Type: Input Is the IEN for the entry in the HOSPITAL REVIEW File (#356.1) for which the data is to be extracted. Y Type: Output Y is the date of Review from the HOSPITAL REVIEW File (#356.1). Called to retrieve inpatient information. ******************** 1328 NAME: DBIA1324-E CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents a Radiology/Nuclear Medicine package reference to a line label within the Imaging package. ROUTINE: MAGRIC COMPONENT: DISPA VARIABLES: RARPT Type: Input Report IEN in File #73, Rad/Nuc Med Reports. This routine is called from the Radiology/Nuclear Med package during case nubmer look-up and report look-up to display the associated abstract or image(s) for the exam. COMPONENT: DISPF VARIABLES: RARPT Type: Input IEN of the Rad/Nuc Med Reports file #74. This entry is called during Radiology/Nuclear Medicine report printing to display thge image(s) associated with the report. ******************** 1329 NAME: DBIA1329 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The IBQ package requests permission to perform the following actions during the initialization of IBQ 1.0. 1. Export the following fields/files: a. Claims Tracking File (#356) - add new field (#1.09) ACUTE CARE DISCHARGE DATE and add new cross-reference 'ADIS'. b. Hospital Review File (#356.1) - add trigger to existing field (#1.17) ACUTE CARE DISCHARGE DATE to update field (#1.09) ACUTE CARE DISCHARGE DATE of File (#356). 2. Post init call ENALL^DIK to index existing entries of field (#1.17) ACUTE CARE DISCHARGE DATE of File (#356.1). ROUTINE: ******************** 1332 NAME: Rad/Nuc Med flds in File 200 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 31,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200 DESCRIPTION: TYPE: File This DBIA documents the fields in File 200 that are created by the Radiology/Nuclear Medicine package developers, and are used specifically by the Radiology/Nuclear Medicine package. These fields are to be distributed in a patch by the Kernel developers. The patch will be prepared by the Radiology/Nuclear Medicine developers and will contain an environment check to make sure Version 4.5 of Radiology/Nuclear Medicine is installed before installing these fields on file 200. These fields will also be distributed along with Radiology/Nuclear Medicine 4.5. ^All 70-series fields 70 STAFF REVIEW REQUIRE RA;1 Both R/W w/Fileman Used to determine whether an interpreting physician can verify reports along, or if staff review is required. 71 ALLOW VERIFYING OF O RA;2 Both R/W w/Fileman Used to determine if an interpreting physician has the privilege of verifying reports written by another interpreting physician. 72 CLASSIFICATION RAC;0 Both R/W w/Fileman Used to determine if the user is a valid Rad/Nuc Med tech, interpreting physician, interpreting resident, or clerk. 73 RADIOLOGY INACTIVE D RA;3 Both R/W w/Fileman Used to determine if a Rad/Nuc Med user has been inactivated. This is necessary to shut out various users from being selected as techs, residents, or staff during case and report entry. 74 RAD/NUC MED LOCATION RAL;0 Both R/W w/Fileman This is a multiple field used to determine which imaging locations within the facility may be accessed by the user. This is used to screen data so that the user only sees the data relevant to the imaging areas in which s/he works. This field is new with version 4.5. These fields reside in the New Person File #200. The Radiology/Nuclear Medicine reads and writes these fields using FileMan callable routines. There are direct global reads of the cross-references on these fields. There are also some direct global reads of the fields themselves. ROUTINE: ******************** 1333 NAME: DBIA1333 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: SEP 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Dietetics V5.0 will include Allergy Tracking Systems option Enter/Edit Patient Reaction Data on Diet Order Management menu. ROUTINE: COMPONENT: OPTION GMRA PATIENT A/AR EDIT VARIABLES: Enter/Edit Patient Reaction Data menu option. ******************** 1336 NAME: DBIA1030-C CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: VENDOR - AUDIOFAX, INC. VENDOR - TECHPRO SYSTEMS INC USAGE: Controlled Subscri ENTERED: SEP 12,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point is used to build an Outpatient prescription profile for a patient. This profile is in the form of an array, names PSOSD. ROUTINE: PSORX COMPONENT: PROFILE VARIABLES: PSODFN Type: Input This is the internal entry number of the patient. This variable will be unchanged in this component. PSOSD Type: Output This is an array which contains the patients current prescriptions. The variable PSOSD is equal to the number of prescriptions in the list, or it will be equal to null or undefined if there are no prescriptions in the list. The pieces in the array are described after the following example. PSOSD=3 PSOSD("ACTIVE","AMITRIPTYLINE HCL 10MG TAB")=2001317^0^^^CN601^11^132A2^30 PSOSD("ACTIVE","CYTARABINE 100MG INJ")=2001313^0^^^AN300^11^402A1^30 PSOSD("SUSPENDED","EPINEPHRINE 1:1000 INJ VIAL")=2001318^5^^Z^AU100^11^361A1^30 Piece 1) Internal prescription number from the Prescription File (#52) Piece 2) The status of the prescripion from the Status field of the Prescription File (#52) Piece 3) Free text set of characters used for different classifications of the drug (not applicable to the functions of this agreement) Piece 4) Free text set of characters used to identify site parameters and drug characteristics. Piece 5) The VA Classification of the drug Piece 6) The number of refills remaining for the prescription Piece 7) National Drug File information for the drug, in the form of: National Drug File entry_"A"_VA Product Name entry (This piece will be null if the drug is not matched to an entry in the National Drug File) Piece 8) The days supply of the prescription ******************** 1337 NAME: DBIA1337 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE QUASAR DSS - DECISION SUPPORT SYSTEM EX DSS EXTRACTS reads only the NAME field (#.01) and the SERVICE field (#3) using FileMan (EN^DIQ1). USAGE: Controlled Subscri ENTERED: SEP 12,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File This DBIA documents Radiology/Nuclear Medicine package references to the Specialty file #42.4. Rad/Nuc Med contains a field that points to file 42.4, and there are global reads on the zeroeth node. Direct read of the 'B' Cross Reference is also permitted. ^DIC(42.4,0) .01 NAME 0;1 Direct Global Read & w The NAME field contents are displayed during radiology exam registration under the caption 'Bedsection:' 6 CDR ACCOUNT 0;6 Direct Global Read & w The contents of the CDR ACCOUNT field are displayed on the Radiology Cost Distribution Report. 3 SERVICE 0;3 Direct Global Read & w This field contains the name of the service that this specialty is related to. This file contains recognized PTF treating specialties. ROUTINE: ******************** 1338 NAME: DBIA1338 CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: SEP 12,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This DBIA documents that Radiology/Nuclear Medicine kills two ^TMP( nodes for the Imaging package. The global nodes are: ^TMP("MAG",$J,"ROW") ^TMP("MAG",$J,"COL") This is necessary to reset the abstract display screen so the next abstract display will begin in the upper left hand corner of the screen. Only the Radiology/Nuclear Medicine package knows when the current case processing is finished, which is the point where these nodes must be killed. ROUTINE: ******************** 1339 NAME: DBIA1339 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: SEP 13,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.5 FILE: 772 ROOT: HL(772, DESCRIPTION: TYPE: File This DBIA documents a Radiology/Nuclear Medicine package reference to the HL7 package file #772. This is only applicable when Health Level Seven Version 1.5 is the version currently installed at a site. ^HL(772,B,date_time) .01 DATE/TIME ENTERED Direct Global Read & w Radiology/Nuclear Medicine is checking for the existence of a given date/time in the "B" cross-reference of this file. This cross-reference is on the .01 field. Only the "B" cross-ref is accessed. ROUTINE: ******************** 1340 NAME: DBIA1340 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 14,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19.1 ROOT: DIC(19.1, DESCRIPTION: TYPE: File The Security Key file (#19.1) Name field (.01) can be pointed to. Standard utilities should be used for look-up. ^DIC(19.1,ifn,0) .01 NAME 0;1 Pointed to The .01 NAME field contains the security key name. ROUTINE: ******************** 1341 NAME: DBIA1341-A CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Version 1.0 of the Non-Expendable Equipment/Turn-In Request Module will call the Engineering Work Order Module in order to create a work order for equipment that must be disconnected before final turn-in can occur. ROUTINE: ENWONEW2 COMPONENT: TRNIN VARIABLES: DUZ Type: Input Person requesting the work order. WODATA Type: Input The equipment ID and location of the requested item to be turned in. data (2 pieces delimited by '^') piece 1 = equipment ID piece 2 = (optional) location of the item to be turned in PRCNSRV Type: Input The service that entered the turn-in request. (optional pointer value from Service file) ENDA Type: Output The internal number of the work order. ENWO Type: Output Work Order number. ******************** 1342 NAME: DBIA1341-B CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6914 ROOT: ENG(6914 DESCRIPTION: TYPE: File The Non-expendable Equipment/Turn-In Request Module requests permission to point to file 6914. ^ENG(6914,D0,0) .01 ENTRY NUMBER 0;1 Pointed to This is an entry in the Equipment Inventory file that is being requested either to be turned in or replaced. 3 MFGR. EQUIPMENT NAME 0;2 Read w/Fileman This is a brief narrative description of item in file. ^ENG(6914,D0,1) 1 MANUFACTURER 1;4 Read w/Fileman Firm who manufactured item, not necessary from whom it was purchased. 4 MODEL 1;2 Read w/Fileman Model number normally assigned by manufacturer. 5 SERIAL # 1;3 Read w/Fileman Serial number assigned by manufacturer. ^ENG(6914,D0,2) 12 TOTAL ASSET VALUE 2;3 Read w/Fileman Cost of the item at the time of purchase. 18 CATEGORY STOCK NUMBE 2;8 Read w/Fileman The designated category stock number of a item. 19 CMR 2;9 Read w/Fileman The Consolidated Memorandum of Receipt for this item's accountability. ^ENG(6914,D0,3) 20 USE STATUS 3;1 Read w/Fileman Tells user is item is currently in active use. 20.1 ACQUISITION METHOD 3;4 Read w/Fileman Establishes whether the facility owns the item. 20.5 TURN-IN DATE 3;3 Both R/W w/Fileman Date on which item is turned over to A&MM for disposition. It should then be removed from the using service CMR. 22 DISPOSITION DATE 3;11 Both R/W w/Fileman Date on which item is physically disposed of by Materiel Management. Should be removed from asset account. 24 LOCATION 3;5 Read w/Fileman Physical location of this item at the facility. 31 DISPOSITION METHOD 3;12 Both R/W w/Fileman Means by which Materiel Management disposed of item that has been 'turned in'. 32 DISPOSITION VALUE 3;13 Both R/W w/Fileman Monetary value of item turned in. ^ENG(6914,D0,6,D1,0) 4 LABOR $ 0;5 Read w/Fileman Amount of labor money spent on repairs of item. 5 MATERIAL $ 0;6 Read w/Fileman Amount of material money spent on repairs of item. 6 VENDOR $ 0;7 Read w/Fileman Amount of vendor money spent on repairs of item. ^ENG(6914,D0,8) 38 STANDARD GENERAL LED 8;6 Both R/W w/Fileman The General Ledger Account appropriate to the non-expendable item. May be affected when item is 'turned in'. ^ENG(6914,D0,9) 60 STATION NUMBER 9;5 Read w/Fileman Station number of the facility that owns the item. ROUTINE: ******************** 1343 NAME: DBIA1341-C CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: SEP 19,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6914.1 ROOT: ENG(6914.1 DESCRIPTION: TYPE: File The Non-expendable Equipment/Turn-in Request Module requests permission to point the CMR file, 6914.1. ^ENG(6914.1,D0,0) .5 SERVICE 0;5 Read w/Fileman Service to which the CMR is assigned 1 RESPONSIBLE OFFICIAL 0;2 Read w/Fileman This field is the CMR who is currently responsible for the equipment to be turned in. .01 NAME 0;1 Read w/Fileman CMR name 5 STATION NUMBER 0;7 Read w/Fileman Station number of facility that owns the asset in the CMR. 2 PHONE (RESP OFFICIAL 0;3 Read w/Fileman Phone number of the responsible official. ^ENG(6914.1,D0,20) 20 ALTERNATE RESPONSIBL 20;1 Read w/Fileman Person authorized to act as a surrogate for the CMR Responsible Official. ROUTINE: ******************** 1344 NAME: DBIA1341-D CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: MAR 21,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6920 ROOT: ENG(6920 DESCRIPTION: TYPE: File This reference is to the WORK ORDER # file in Engineering for items which must have a work order created in order to remove or disconnect the item by the Engineering department. ^ENG(6920,D0,0) .01 WORK ORDER # 0;1 Pointed to The work order number for the Engineering department for items that are being turned in. Equipment/Turn-In Request packages checks for each WORK ORDER # generated for a item to be turned in, if the status is COMPLETED. ^ENG(6920,D0,5) 36 DATE COMPLETE (or cl 5;2 Read w/Fileman Date that work order was completed. ROUTINE: ******************** 1345 NAME: DBIA1341-E CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6910 ROOT: DIC(6910 DESCRIPTION: TYPE: File The ENG INIT PARAMETERS file is checked for the entry of the EQUIPMENT TURN-IN SECTION field. ^DIC(6910,D0,20) 20 EQUIPMENT TURN-IN SE 20;1 Direct Global Read & w This is the appropriate work order section for equipment turn-ins when a work order should be generated. ^DIC(6910,D0,0) 1 STATION NUMBER 0;2 Read w/Fileman Facility identifier ROUTINE: ******************** 1346 NAME: DBIA1341-F CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: MAR 21,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine FMS requires FA code sheets on capitalized equipment and FD code sheets when dispositioned. Turn-In items must be sure that the appropriate FA and FD code sheets have been done before finalizing the turn-in. ROUTINE: ENFAUTL COMPONENT: $$CHKFA VARIABLES: DA Type: Input The internal number of the equipment item from 6914. (returns) Type: Output Returns output data from function (4 pieces delimited by '^'): Piece 1 = flag (0 or 1) which indicates if equipment item if currently established in Fixed Assets 1 = if currently established 0 = if not currently established. Piece 2 = the date/time of last FA Doc. for item Piece 3 = the date/time of last FD Doc. for item Piece 4 = the IEN of last FA Doc. for item Checks to see if item has been capitalized or not. ******************** 1348 NAME: DBIA1341-H CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6925 ROOT: ENG('PROJ', DESCRIPTION: TYPE: File The Equipment/Turn-In module asks permission to display projects, their description and to pull the Chief Engineer Name if exists for inclusion in Equipment Request if necessary. ^ENG('PROJ',D0,0) .01 PROJECT NUMBER 6925 Direct Global Read & w Displays list of possible project numbers when user enters '?'. 2 PROJECT TITLE 6925 Direct Global Read & w Displays with list of possible project numbers when user enters '?'. Is for display only, special help. ^ENG('PROJ',D0,33) 245 CHIEF ENGINEER NAME 6925 Direct Global Read & w If user enters a project number which currently exists in the fiel 6925, then the Chief Engineer Name will be directly read but then Write w/FileMan into file 413. Display only but can pull Chief Engineer over into 413 from 6925. ROUTINE: ******************** 1349 NAME: DBIA1341-I CUSTODIAL PACKAGE: ENGINEERING SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 6928 ROOT: ENG('SP', DESCRIPTION: TYPE: File Equipment/Turn-In module asks permission to access the Location file (#6928) to identify where new equipment may be located and where equipment will need to be picked up from when being turned in. ^ENG('SP',D0,0) .01 ROOM NUMBER 6928 Pointed to Points to the location file if user enters location that currently exists, otherwise will place free text location entered in another field. Also, program PRCNUTL1 contains a 'special help' list if user enters a '?' which is a direct global read. This field is to ensure that sufficient space and location exists for purchase of additional equipment. ROUTINE: ******************** 1351 NAME: DBIA1351 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 356.1 ROOT: IBT(356.1 DESCRIPTION: TYPE: File The IBQ package needs to retrieve Hospital Review information out of the HOSPITAL REVIEW File (#356.1) for use in the rollup to the National Database. The 'C' x-ref is used for the gathering of review information, given the Claims Tracking entry number from the Claims Tracking File (#356). Refer to IA-1350 for the Claims Tracking IEN that is retrieved from the 'ADIS' x-ref. ^IBT(356.1,'C',IBTRN, .03 DAY OF REVIEW 0;3 Direct Global Read & w This field is used for the Day of Review in the IBQ package. .04 SEVERITY OF ILLNESS 0;4 Direct Global Read & w This field is used for Severity of Illness in the IBQ package. .05 INTENSITY OF SERVICE 0;5 Direct Global Read & w This field is used for Intensity of Service in the IBQ package. .06 CRITERIA MET IN 24 H 0;6 Direct Global Read & w This field is used for Acute Admission(Y/N)? in the IBQ package. .07 SPECIALTY FOR REVIEW 0;7 Direct Global Read & w This field will be used to retrieve a pointer to the FACILITY TREATING SPECIALTY (#45.7) file, which will in turn be used to determine the Service from the SPECIALTY (#42.4) file. .08 SPECIALIZED UNIT SI 0;8 Direct Global Read & w This field is used for Severity of Illness in the IBQ package. .09 SPECIALIZED UNIT IS 0;9 Direct Global Read & w This field is used for Intensity of Service in the IBQ package. .1 PROVIDER INTERVIEWED 0;10 Direct Global Read & w This field is used for Provider Interviewed(Y/N) in the IBQ package. .11 ADMISSION DECISION I 0;11 Direct Global Read & w This field is used for Admission Influenced(Y/N) in the IBQ package. .12 D/C SCREEN MET 0;12 Direct Global Read & w This field is used for D/C From Continued Stay in the IBQ package. .19 ACTIVE 0;19 Direct Global Read & w This field is used to check the validity of a review. .21 REVIEW STATUS 0;21 Direct Global Read & w This field is used to check the validity of a review. 356.112, REASONS FOR NON-ACUT 0;1 Direct Global Read & w This multiple field of reason codes is used for Reasons for Non-Acute Admission in the IBQ package. 356.113, REASONS FOR NON-ACUT 0;1 Direct Global Read & w This multiple field of reason codes is used for Reasons from Continued Stay in the IBQ package. The 'C' x-ref is used to retrieve information on the days of review, given it's parent Claims Tracking number. ROUTINE: ******************** 1353 NAME: DBIA1353 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .402 ROOT: DIE( DESCRIPTION: TYPE: File This DBIA documents a Radiology/Nuclear Medicine package look-up on FileMan's Edit template file. The look-up is done within an IRM option so that IRM can select one, many, or all Radiology/ Nuclear Med compiled templates for re-compiling. The look-up must be done through a Radiology program which calls DIC in order to provide the "one-many-all" look-up functionality. ROUTINE: ******************** 1354 NAME: DBIA1354 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 356.9 ROOT: IBT(356.9 DESCRIPTION: TYPE: File The IBQ package needs to retrieve diagnosis data related to the patient's admission. The 'ADG' x-ref in the INPATIENT DIAGNOSIS File (#356.9) is used to return the patient's diagnosis, given the PATIENT MOVEMENT number. The PATINT MOVEMENT number retrieved in IA-1350 from ADMISSION in the Claims Tracking File (#356). ^IBT(356.9,'ADG',DGPM, .01 DIAGNOSIS 0;1 Direct Global Read & w This field will return the diagnosis reference which will return the Diagnosis Code from the ICD 9 File for use in the IBQ Package. The 'ADG' x-ref is used to return the patients diagnosis. ROUTINE: ******************** 1355 NAME: DBIA1355 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .4 ROOT: DIPT( DESCRIPTION: TYPE: File This DBIA documents a Radiology/Nuclear Medicine package look-up on FileMan's Print template file. The look-up is done within an IRM option so that IRM can select one, many, or all Radiology/Nuclear Med compiled tempaltes for re-compiling. the look-up must be done through a Radiology program which calls DIC in order to provide the "one-many-all" look-up functionality. ROUTINE: ******************** 1358 NAME: DBIA1358 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File The IBQ package requests permission to directly access the MOVEMENT DATE/TIME field in the PATIENT MOVEMENT File (#405) for use in the IBQ package. Reference to the PATIENT MOVEMENT File is by the ADMISSION filed in the CLAIMS TRACKING File (#356). Refer to IA-1350 for use of the ADMISSION field in the IBQ package. ^DGPM(DGPM,0) .01 MOVEMENT DATE/TIME 0;1 Direct Global Read & w This field is used to retrieve the Admission Date/Time for use as the Acute Care Admission Date in the IBQ package. ROUTINE: ******************** 1359 NAME: DBIA1359 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP INCOMPLETE RECORDS TRACKING VISTA INTEGRATION ADAPTOR VIA will be referencing the Name (#.01) field in the Facility Treating Specialty (#45.7) file in VIAB BMS RPC. USAGE: Controlled Subscri ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7 DESCRIPTION: TYPE: File The IBQ package requests permission to directly access the FACILITY TREATING SPECILTY File (#45.7) in order to retrieve the NAME Field. The SPECIALTY FOR REVIEW Field from the HOSPITAL REVIEW File (#356.1) will be used as the IEN to the FACILITY TREATING SPECIALTY File. Refer to IA-1351 for use of the SPECIALTY FOR REVIEW field in the IBQ package. ^DIC(45.7,IEN,0) .01 NAME 0;1 Direct Global Read & w This field is used for the Treating Specialty in the IBQ package. ROUTINE: ******************** 1360 NAME: DBIA1360 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: UTILIZATION MANAGEMENT ROLLUP USAGE: Private ENTERED: SEP 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4 DESCRIPTION: TYPE: File The IBQ package requests permission to directly access the SPECILTY File (#42.4) to retrieve the SERVICE field (#.03). ^DIC(42.4,IEN,0) .03 SERVICE 0;3 Direct Global Read & w This field is used as for the Service field in the IBQ package. ROUTINE: ******************** 1361 NAME: DBIA1361-A CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: SEP 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents a Radiology/Nuclear Medicine call to an OE/RR routine for the purpose of first-time population of the OE/RR v.3 orderable items file. This DBIA shall take effect with Version 3 of OE/RR. ROUTINE: ORMFN COMPONENT: EN VARIABLES: MSG Type: Input Message array or global root. This entry point is called if the Radiology/Nuclear Medicine package is installed at a site after OE/RR v.3 is installed. The input parameter tells the routine where to look for the HL7 messages containing all data necessary to order Radiology/Nuclear Medicine procedures. ******************** 1362 NAME: DBIA1361-B CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE This DBIA documents a Radiology/Nuclear Medicine call to OE/RR v.3 notification processing routine that handles notifications that must be generated for Radiology/Nuclear Medicine outside of HL7 messages processed through protocols. This DBIA will take effect when OE/RR v.3 is released. CONSULT/REQUEST TRACKING WOMEN'S HEALTH LAB SERVICE added 7/22/09 CLINICAL REMINDERS GEN. MED. REC. - VITALS Added 3/10/20: Vitals patch GMRV*5*40 needs to generate a new alert. USAGE: Controlled Subscri ENTERED: SEP 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents a call to EN^ORB3 which handles processing of notifications via CPRS. This call is made by packages which must generate CPRS alerts through their own package code. ROUTINE: ORB3 COMPONENT: EN VARIABLES: ORN Type: Input Notification ID (ifn from OE/RR Notifications file #100.9) ORBDFN Type: Input Patient DFN from Patient file #2 ORNUM Type: Input Order ifn from Order file #100. ORBADUZ Type: Input Array of notification recipients requested by the calling package. ORBPMSG Type: Input Message text ORBPDATA Type: Input This is an identifier of the package entry which the notification is based on. For radiology: Rad/Nuc Med exam/case ifn's (format: exam_ifn;case_ifn) For consults: the IEN of the consult in file 123 This routine is called to process a notification regarding an order. The routine determines who is supposed to receive the notification in addition to recipients defined in input parameters. ******************** 1363 NAME: KERNEL 8 transport of ORBSTAT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: SEP 22,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 8.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel 8.0 needs to transport the routine ORBSTAT. This routine was modified in order to work with Kernel 8.0. The changes are not compatible with Kernel 7.1. This is a one time release. ROUTINE: ORBSTAT ******************** 1364 NAME: KERNEL 8 transport of ORF2 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: KERNEL USAGE: Private ENTERED: SEP 22,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 8.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel 8.0 needs to transport the routine ORF2. This routine was modified in order to work with Kernel 8.0. The changes are not compatible with Kernel 7.1. This is a one time release. ROUTINE: ORF2 ******************** 1365 NAME: DBIA1365 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA will be referencing the DSELECT^GMPLENFM API in VIAB ACTPROB RPC. USAGE: Controlled Subscri ENTERED: SEP 25,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMPLENFM COMPONENT: ACTIVE VARIABLES: DFN Type: Input ien of patient in File #2 Permission to call ACTIVE^GMPLENFM for the purpose of obtaining a list of the patient's active problems. INPUTS: DFN = ien of patient in File #2 OUTPUTS: Returns the data in the ^TMP global as follows: ^TMP("IB",$J,"INTERFACES",DFN,"GMP PATIENT ACTIVE PROBLEMS",#) = Piece 1: Text of problem 2: ICD code of problem 3: Date of Onset in 00/00/00 format 4: "SC" or "NSC" or "", if problem is [not] related to a SC Cond. 5: "Y" or "N" or "", if problem is [not] related to a SC Condition (Pieces 4 and 5 give the same data, just in different formats.) 6: "A" or "I" or "P" or "H" or "M" or "C" or "S" or "L" or "", if problem is related to exposure to Agent Orange, Ionization, Persian Gulf, Head and/or Neck Cancer, Military Sexual Trauma, Combat Vet, SHAD, Camp Lejeune or null respectively 7: Full text of the special exposure indicated in piece 6, if any where each # is a different problem, 1 - n with n being the total number of active problems; the 0-node is also set to the total (n). COMPONENT: SELECT VARIABLES: Permission to call SELECT^GMPLENFM for the purpose of allowing users access to the EXPRESSIONS file to create lists of Clinic Common Problems. SELECT^GMPLENFM is used for the lookup rather than a simple ^DIC call in order to setup the Problem List context for searching the Lexicon. INPUTS: Requires no input values. OUTPUTS:Returns the entry in the Lexicon Utility selected to add to a form as a commonly selected problem in the ^TMP global as follows: ^TMP("IB",$J,"INTERFACES","GMP SELECT CLINIC COMMON PROBLEMS") = Piece 1: IEN of problem in the Lexicon Utility Expressions file (#757.01) 2: Text of problem 3: ICD Code of problem, if known COMPONENT: DSELECT VARIABLES: DFN Type: Output ien of patient in File #2 Permission to call DSELECT^GMPLENFM for the purpose of obtaining a list of the patient's active problems. INPUTS: Requires DFN = ien of patient in File #2 OUTPUTS: Returns the data in the ^TMP global as follows: ^TMP("IB",$J,"INTERFACES","GMP SELECT PATIENT ACTIVE PROBLEMS",#) = Piece 1: ien of problem 2: Text of problem 3: ICD code of problem 4: Date of Onset in 00/00/00 format 5: "SC" or "NSC" or "", if problem is [not] related to a SC Cond. 6: "Y" or "N" or "", if problem is [not] related to a SC Condition (Pieces 4 and 5 give the same data, just in different formats.) 7: "A" or "I" or "P" or "H" or "M" or "C" or "S" or "L" or "", if problem is related to exposure to Agent Orange, Ionization, Persian Gulf Head and/or Neck Cancer, Military Sexual Trauma, Combat Vet, SHAD, Camp Lejeune or null respectively 8: Full text of the special exposure indicated in piece 6, if any where each # is a different problem, 1 - n with n being the total number of active problems; the 0-node is also set to the total (n). ******************** 1366 NAME: DBIA1366 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: HEALTH LEVEL SEVEN USAGE: Private ENTERED: SEP 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Version 1.6 of the HL7 package includes support for sending security codes (access and signature) in an HL7 message. As a result the HL7 package needs to directly access the new person file to validate the security codes. ^VA(200,'A',AC,0) A xref t Direct Global Read & w The A xref is used to obtain the user's DUZ from the Access Code. ^VA(200,DUZ,.1) .1 Direct Global Read & w The existence of the node is checked to ensure that the access code exist. ^VA(200,DUZ,20) 20.2 SIGNATURE BLOCK PRIN 20;2 Direct Global Read & w 20.4 ELECTRONIC SIGNATURE 20;4 Direct Global Read & w The second and forth piece are used to validate the signature code. ROUTINE: ******************** 1367 NAME: XPDKEY CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 26,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Extrinsic functions that can be used to control the Security Key File. ROUTINE: XPDKEY COMPONENT: $$RENAME VARIABLES: oldname Type: Input Name of security key to be renamed. newname Type: Input New name for security key. value Type: Output return 1 if operation successful, 0 if operation failed. Usage: S value=$$RENAME^XPDKEY(oldname,newname) Use this entry point to rename a security key. All necessary indexing is performed to maintain the ^XUSEC global. The return value is 1 for OK, or 0 for failure. COMPONENT: $$LKUP VARIABLES: Usage: S value=$$LKUP^XPDKEY(key_value) This extrinsic function will lookup a Security Key by name or by IEN value. If called with a number it returns the name of the KEY. If called with a name it returns the IEN number of the KEY. COMPONENT: DEL VARIABLES: key_name Type: Input The name of the Security Key to delete. Usage: D DEL^XPDKEY(key_name) This call will delete a Security Key from the Security Key File. All necessary indexing is performed to maintain the ^XUSEC global. The KEY is removed from all holders in the NEW PERSON file. ******************** 1369 NAME: Get Clinic Appointments CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING MENTAL HEALTH AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: OCT 2,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(DFN,"DE" for current clinics ^DPT(D0,'DE', Get Clinic appointments ROUTINE: ******************** 1370 NAME: DDBRZIS/DDBDMSG CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES MAILMAN RADIOLOGY/NUCLEAR MEDICINE USAGE: Controlled Subscri ENTERED: OCT 3,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Progress Notes will check $G(DDBRZIS). If so, the variable DDBDMSG will be set equal to "Progress Notes". This will enable "Progress Notes" to display as the title if the BROWSER device has been selected. ROUTINE: ******************** 1371 NAME: DBIA1371 CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: OCT 4,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2101.2 ROOT: GECS DESCRIPTION: TYPE: File This is a request for an integration agreement between GECS and PIMS. PIMS will be making reference to file ^GECS(2101.2, GENERIC CODE SHEET TRANSACTION TYPE/SEGMENT file, the zero node, 5th piece, to look at the ACTIVE CODE SHEET (#1) field. ^GECS(2101.2 1 ACTIVE CODE SHEET 0;5 Direct Global Read & w This field indicates if the code sheet is active or not. This file stores the different typs of code sheets used for each type of batch (in file 2101.1). ROUTINE: ******************** 1372 NAME: PTF file access CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY LAB SERVICE PCE PATIENT CARE ENCOUNTER CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: OCT 6,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File The health summary packages needs the ability to access PTF data to display in several of the health summary components. NOTE: Existing subscribers to this ICR are grandfathered in for accessing PTF (#45) Diagnosis, Procedure code, and Surgical code data fields. However, current subscribers are encouraged to use ICR 6130 in the future. ICR 6130 supports the use of PTF Utility API's to access PTF (#45) Diagnosis, Present on Admission (POA) indicators, Procedure code, and Surgical code fields, instead of accessing fields directly or using Fileman. New subscribers should not be added to this ICR if PTF (#45) file data fields may be obtained using the PTF Utility API's supported by ICR 6130. ^DGPT(D0,70) 70 DISCHARGE DATE 70;1 Direct Global Read & w 71 DISCHARGE SPECIALTY 70;2 Direct Global Read & w 72 TYPE OF DISPOSITION 70;3 Direct Global Read & w 73 OUTPATIENT TREATMENT 70;4 Direct Global Read & w 75 PLACE OF DISPOSITION 70;6 Direct Global Read & w 79 PRINCIPAL DX 70;10 Direct Global Read & w 80 PRINCIPAL DX PRE 198 70;11 Direct Global Read & w 79.16 SECONDARY DX 1 70;16 Direct Global Read & w 79.17 SECONDARY DX 2 70;17 Direct Global Read & w 79.18 SECONDARY DX 3 70;18 Direct Global Read & w 79.19 SECONDARY DX 4 70;19 Direct Global Read & w 79.201 SECONDARY DX 5 70;20 Direct Global Read & w 79.21 SECONDARY DX 6 70;21 Direct Global Read & w 79.22 SECONDARY DX 7 70;22 Direct Global Read & w 79.23 SECONDARY DX 8 70;23 Direct Global Read & w 79.24 SECONDARY DX 9 70;24 Direct Global Read & w ^DGPT(D0,P,0) 60 601 P;0 Direct Global Read & w ^DGPT(D0,P,D1,0) .01 PROCEDURE DATE 0;1 Direct Global Read & w 4 PROCEDURE CODE 1 0;5 Direct Global Read & w 5 PROCEDURE CODE 2 0;6 Direct Global Read & w 6 PROCEDURE CODE 3 0;7 Direct Global Read & w 7 PROCEDURE CODE 4 0;8 Direct Global Read & w 8 PROCEDURE CODE 5 0;9 Direct Global Read & w 9 PROCEDURE CODE 6 0;10 Direct Global Read & w 10 PROCEDURE CODE 7 0;11 Direct Global Read & w 11 PROCEDURE CODE 8 0;12 Direct Global Read & w 12 PROCEDURE CODE 9 0;13 Direct Global Read & w 13 PROCEDURE CODE 10 0;14 Direct Global Read & w 14 PROCEDURE CODE 11 0;15 Direct Global Read & w 15 PROCEDURE CODE 12 0;16 Direct Global Read & w 16 PROCEDURE CODE 13 0;17 Direct Global Read & w 17 PROCEDURE CODE 14 0;18 Direct Global Read & w 18 PROCEDURE CODE 15 0;19 Direct Global Read & w 19 PROCEDURE CODE 16 0;20 Direct Global Read & w 20 PROCEDURE CODE 17 0;21 Direct Global Read & w 21 PROCEDURE CODE 18 0;22 Direct Global Read & w 22 PROCEDURE CODE 19 0;23 Direct Global Read & w 23 PROCEDURE CODE 20 0;24 Direct Global Read & w ^DGPT(D0,S,0) 40 401 S;0 Direct Global Read & w ^DGPT(D0,S,D1,0) .01 SURGERY/PROCEDURE DA 0;1 Direct Global Read & w 8 OPERATION CODE 1 0;8 Direct Global Read & w 9 OPERATION CODE 2 0;9 Direct Global Read & w 10 OPERATION CODE 3 0;10 Direct Global Read & w 11 OPERATION CODE 4 0;11 Direct Global Read & w 12 OPERATION CODE 5 0;12 Direct Global Read & w 13 OPERATION CODE 6 0;13 Direct Global Read & w 14 OPERATION CODE 7 0;14 Direct Global Read & w 15 OPERATION CODE 8 0;15 Direct Global Read & w 16 OPERATION CODE 9 0;16 Direct Global Read & w 17 OPERATION CODE 10 0;17 Direct Global Read & w 18 OPERATION CODE 11 0;18 Direct Global Read & w 19 OPERATION CODE 12 0;19 Direct Global Read & w 20 OPERATION CODE 13 0;20 Direct Global Read & w 21 OPERATION CODE 14 0;21 Direct Global Read & w 22 OPERATION CODE 15 0;22 Direct Global Read & w 23 OPERATION CODE 16 0;23 Direct Global Read & w 24 OPERATION CODE 17 0;24 Direct Global Read & w 25 OPERATION CODE 18 0;25 Direct Global Read & w 26 OPERATION CODE 19 0;26 Direct Global Read & w 27 OPERATION CODE 20 0;27 Direct Global Read & w ^DGPT('B',DFN,PTF) DIRECT GLOBAL READ ^DGPT(D0,71) 79.241 SECONDARY DX 10 71;1 Direct Global Read & w 79.242 SECONDARY DX 11 71;2 Direct Global Read & w 79.243 SECONDARY DX 12 71;3 Direct Global Read & w 79.244 SECONDARY DX 13 71;4 Direct Global Read & w 79.245 SECONDARY DX 14 71;5 Direct Global Read & w 79.246 SECONDARY DX 15 71;6 Direct Global Read & w 79.247 SECONDARY DX 16 71;7 Direct Global Read & w 79.248 SECONDARY DX 17 71;8 Direct Global Read & w 79.249 SECONDARY DX 18 71;9 Direct Global Read & w 79.2491 SECONDARY DX 19 71;10 Direct Global Read & w 79.24911 SECONDARY DX 20 71;11 Direct Global Read & w 79.24912 SECONDARY DX 21 71;12 Direct Global Read & w 79.24913 SECONDARY DX 22 71;13 Direct Global Read & w 79.24914 SECONDARY DX 23 71;14 Direct Global Read & w 79.24915 SECONDARY DX 24 71;15 Direct Global Read & w ^DGPT(D0,'P',D1,1) 24 PROCEDURE CODE 21 1;1 Direct Global Read & w 25 PROCEDURE CODE 22 1;2 Direct Global Read & w 26 PROCEDURE CODE 23 1;3 Direct Global Read & w 27 PROCEDURE CODE 24 1;4 Direct Global Read & w 28 PROCEDURE CODE 25 1;5 Direct Global Read & w ^DGPT(D0,'S',D1,1) 28 OPERATION CODE 21 1;1 Direct Global Read & w 29 OPERATION CODE 22 1;2 Direct Global Read & w 30 OPERATION CODE 23 1;3 Direct Global Read & w 31 OPERATION CODE 24 1;4 Direct Global Read & w 32 OPERATION CODE 25 1;5 Direct Global Read & w ROUTINE: ******************** 1373 NAME: DBIA1373 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: HEALTH LEVEL SEVEN VDEF IMAGING Only using SUBSCRIBERS field 775 ENROLLMENT APPLICATION SYSTEM Enrollment maintains a list of HEC protocols within the RPC routines and only modifies protocols in the list. The protocols Enrollment has permission The File #101 namespaces involved are: EAS ESR* New Vista to ESR protocols VAMC* Existing Vista to HEC protocols By inclusion as a named subscriber in this ICR, Enrollment has permission to modify the above protocols. MYHEALTHEVET added 12/21/2007 LAB SERVICE ADDED 9/13/2007 CLINICAL PROCEDURES ADDED 8/3/2007 USAGE: Controlled Subscri ENTERED: OCT 12,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101 ROOT: ORD(101 DESCRIPTION: TYPE: File Version 1.6 of the HL7 package uses the Protocol file (#101) to store event related information concerning HL7 messages being exchanged by applications. As a result, it was necessary to add values to the Type field (#4) and to add a number of messaging specific fields and cross references to the file. The following Input Template was added to the Protocol file (#101): 'HL MESSAGING PROTOCOL EDIT' This template allow for editing of the fields described in this Integration Agreement. ^ORD(101, .01 NAME 0;1 Direct Global R/W & w/ 1 ITEM TEXT 0;2 Direct Global R/W & w/ 3.5 DESCRIPTION 1;0 Direct Global R/W & w/ 4 TYPE 0;4 Direct Global R/W & w/ 10 ITEM 10;0 Direct Global R/W & w/ 12 PACKAGE 0;12 Direct Global R/W & w/ 15 EXIT ACTION 15;E1,24 Direct Global R/W & w/ 20 ENTRY ACTION 20;E1,24 Direct Global R/W & w/ 770.1 SENDING APPLICATION 770;1 Direct Global R/W & w/ 770.2 RECEIVING APPLICATIO 770;2 Direct Global R/W & w/ 770.3 TRANSACTION MESSAGE 770;3 Direct Global R/W & w/ 770.4 EVENT TYPE 770;4 Direct Global R/W & w/ 770.5 MESSAGE STRUCTURE 770;5 Direct Global R/W & w/ 770.6 PROCESSING ID 770;6 Direct Global R/W & w/ 770.7 LOGICAL LINK 770;7 Direct Global R/W & w/ 770.8 ACCEPT ACK CODE 770;8 Direct Global R/W & w/ 770.9 APPLICATION ACK TYPE 770;9 Direct Global R/W & w/ 770.95 VERSION ID 770;10 Direct Global R/W & w/ 771 PROCESSING ROUTINE 771;E1,2 Direct Global R/W & w/ 772 RESPONSE PROCESSING 772;E1,2 Direct Global R/W & w/ 773.1 SENDING FACILITY REQ 773;1 Direct Global R/W & w/ 773.2 RECEIVING FACILITY R 773;2 Direct Global R/W & w/ 773.3 SECURITY REQUIRED? 773;3 Direct Global R/W & w/ 773.4 DATE/TIME OF MESSAGE 773;4 Direct Global R/W & w/ ^ORD(101,'AHL2',CLIENT,DA) This cross reference is needed to provide a list of Client (Subscriber) protocols. ^ORD(101,'AHL1',SERVER,MESSAGE TYPE,EVENT This cross reference is used to look up the protocol related to an incoming message at the time the incoming message is received. This cross reference is composed of values from the Server Application, Message Type and Event Type fields. This cross reference works in conjuction with the 'AHL1A' cross reference on the Message Type Received field (770.3) and the 'AHL1B' cross reference on the Event Type field (770.4). ^ORD(101,'B', Global read access. ^ORD(101,D0,775, .01 SUBSCRIBERS 0;1 Direct Global Read & w $O access across ^ORD(101,D0,775,D1) ROUTINE: ******************** 1376 NAME: NEW PERSON CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File Nursing can access the New Person file as described in this DBIA. ^VA(200,D0,0) .01 NAME 0;1 Write w/Fileman Also LAYGO with FileMan and pointed to from Nurs Staff (210) file. This LAYGO access can be turned off by a site parameter in the Nursing software. Nursing also points to this file from the Employee Name (.01) field of the Nurs Staff (210) file. This pointer uses a DINUM relationship. ^VA(200,D0,1) 4 SEX 1;2 Write w/Fileman 5 DOB 1;3 Write w/Fileman 9 SSN 1;9 Write w/Fileman ^VA(200,D0,.11) .111 STREET ADDRESS 1 .11;1 Write w/Fileman .112 STREET ADDRESS 2 .11;2 Write w/Fileman .113 STREET ADDRESS 3 .11;3 Write w/Fileman .114 CITY .11;4 Write w/Fileman .115 STATE .11;5 Write w/Fileman .116 ZIP CODE .11;6 Write w/Fileman ROUTINE: ******************** 1377 NAME: WARD LOCATION CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS INPATIENT MEDICATIONS BAR CODE MED ADMIN SCHEDULING CLINICAL REMINDERS added 5/14/09 LAB SERVICE ADDED 5/3/2011 USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File Controlled access to the Ward Location (42) file fields/cross-references as described in this DBIA. ^DIC(42,D0, .03 SERVICE 0;3 Direct Global Read & w .015 DIVISION 0;11 Direct Global Read & w Direct global access on the "B" cross-reference of the Ward Location (42) file is supported by this DBIA. ROUTINE: ******************** 1378 NAME: DGPM CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS ONCOLOGY Onc added 1/30/2009 CLINICAL REMINDERS added 12/16/09 LAB SERVICE LR ADDED 3/21/11 USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Nursing directly references the ^DGPM global. We would like permissionto reference the following fields/cross-references using direct global reads: .01 DATE/TIME .02 TRANSACTION .03 PATIENT .06 WARD LOCATION .14 ADMISSION/CHECK-IN MOVEMENT "AMV3" cross-reference "APMV" cross-reference "ATID1" cross-reference "ATID2" cross-reference "ATID3" cross-reference "CN" cross reference ^DGPM(D0,0) .01 DATE/TIME 0;1 Direct Global Read & w .02 TRANSACTION 0;2 Direct Global Read & w .03 PATIENT 0;3 Direct Global Read & w .06 WARD LOCATION 0;6 Direct Global Read & w .14 ADMISSION/CHECK-IN M 0;14 Direct Global Read & w ^DGPM('AMV3', Direct global read to the "AMV3" cross-reference. ^DGPM('APMV', Direct global read to the "APMV" cross-reference. ^DGPM('ATID1', Direct global read to the "ATID1" cross-reference. ^DGPM('ATID2', Direct global read to the "ATID2" cross-reference. ^DGPM('ATID3', Direct global read to the "ATID3" cross-reference. ^DGPM('CN', Direct global read to the "CN" cross-reference. ROUTINE: ******************** 1380 NAME: ROOM-BED CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS INTAKE/OUTPUT SPINAL CORD DYSFUNCTION DIETETICS added 6/29/09 LAB SERVICE AUTOMATED LAB INSTRUMENTS INPATIENT MEDICATIONS Inpatient Meds added for the PharmacyInterface Automation (PIA) project and patch PSJ*5*317. The project involves sending Inpatient order information to Pharmacy Automated Dispensing Equipment (PADE) cabinets placed in wards. The setup allows to assign room beds under a group and the location (send area) of the PADE cabinets that holds the medications where the orders needs to be sent for those patients. Within our setup, we store the IENs of these room beds and we scan the B x-ref of 405.4 to ensure they exist when we send the orders to the respective PADE cabinets. USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.4 ROOT: DG(405.4, DESCRIPTION: TYPE: File Nursing, Vitals/Measurements and Intake/Output have permission to access the following elements in the Room-Bed (405.4) file. ^DG(405.4,0) to test for existence of file. "W" cross-reference Direct global read of the NAME (.01) field. ^DG(405.4,0) Direct global reference of this node to check for existence of Room-Bed (405.4) file. ^DG(405.4,D0,0) .01 NAME 0;1 Direct Global Read & w ^DG(405.4,'W', Direct global read on the "W" cross-reference. ROUTINE: ******************** 1381 NAME: GMRV VITAL MEASUREMENT CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE Nursing references fields .01, 2.1 and 2. It also uses the 'AA' x-ref. ORDER ENTRY/RESULTS REPORTING OE/RR references fields #.01, 2.1, 2, .03, .05, and .06. In addition, it utilizes the 'AA' x-ref. PHARMACY BENEFITS MANAGEMENT SPINAL CORD DYSFUNCTION HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.5 ROOT: GMR(120.5, DESCRIPTION: TYPE: File This DBIA authorizes access to the following fields in the GMRV Vital Measurement (120.5) file. ^GMR(120.5,D0,0) .01 DATE/TIME VITALS TAK 0;1 Direct Global Read & w .03 VITAL TYPE O;3 Direct Global Read & w .05 HOSPITAL LOCATION 0;5 Direct Global Read & w .06 ENTERED BY 0;6 Direct Global Read & w 1.2 RATE 0;8 Direct Global Read & w ^GMR(120.5,D0,2) 2 ENTERED IN ERROR 2;1 Direct Global Read & w ^GMR(120.5,'AA', Direct global read on the "AA" cross-reference. ^GMR(120.5,5, .01 QUALIFIER 0;1 Direct Global Read & w ROUTINE: ******************** 1382 NAME: GMRV VITAL TYPE CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE PHARMACY BENEFITS MANAGEMENT SPINAL CORD DYSFUNCTION PCE PATIENT CARE ENCOUNTER added 10/10/08 USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.51 ROOT: GMRD(120.51, DESCRIPTION: TYPE: File Nursing has permission to access the GMRV Vital Type (120.51) file. ^GMRD(120.51,D0,0) .01 NAME 0;1 Direct Global Read & w ^GMRD(120.51,'C', Direct global read on the "C" cross-reference. ROUTINE: ******************** 1385 NAME: BRANCH OF SERVICE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 23 ROOT: DIC(23, DESCRIPTION: TYPE: File Nursing has permission to access the Branch of Service (23) file as described in this DBIA. ^DIC(23,D0,0) .01 NAME 0;1 Direct Global Read & w Nursing also has permission to point to this file from the Military Status multiple in the Nurs Staff (210) file. ROUTINE: ******************** 1386 NAME: GMRG PARAMETERS CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 124.1 ROOT: GMRD(124.1, DESCRIPTION: TYPE: File Nursing has permission to access the GMRG Parameters (124.1) file fields described in this DBIA. ^GMRD(124.1,D0,1,D1,0) .01 PACKAGE PARAMETERS 0;1 Direct Global Read & w 2 HIGHLIGHTING OFF 0;2 Direct Global Read & w ^GMRD(124.1,D0,1,D1,'P') 1 PRINT ROUTINE P;E1,245 Direct Global Read & w ^GMRD(124.1,D0,1,'B', Direct global read to "B" cross-reference on Package Parameters sub-file. ROUTINE: ******************** 1387 NAME: AGGREGATE TERM CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 124.2 ROOT: GMRD(124.2, DESCRIPTION: TYPE: File Nursing has permission to access the Aggregate Term (124.2) file fields described in this DBIA. ^GMRD(124.2,D0,0) .01 NAME 0;1 Write w/Fileman Also direct global read is supported. .02 TYPE OF TERM 0;2 Write w/Fileman .03 PACKAGE 0;3 Write w/Fileman .04 CLASSIFICATION 0;4 Write w/Fileman Direct global read is supported as well. .05 NODE IDENTIFICATION 0;5 Write w/Fileman ^GMRD(124.2,D0,1,D1,0) .01 CHILD 0;1 Direct Global Read & w 1 CHILD TEXT 0;2 Direct Global Read & w ^GMRD(124.2,D0,1,'AC', Direct global read on the "AC" cross-reference of the Children sub-file. ^GMRD(124.2,D0,1,'B', Direct global read on the "B" cross-reference of the Children sub-file. ^GMRD(124.2,'AA', Direct global read on the "AA" cross-reference of the Aggregate Term (124.2) file. ^GMRD(124.2,'AKID', Direct global reference on the "AKID" cross-reference of the Aggregate Term (124.2) file. ROUTINE: ******************** 1388 NAME: TERM CLASSIFICATION CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 124.25 ROOT: GMRD(124.25, DESCRIPTION: TYPE: File Nursing has permission to access the Term Classification (124.25) file fields described in this DBIA. ^GMRD(124.25,'AA', Direct global reference on the "AA" cross-reference of the Term Classification file. ^GMRD(124.25,'B', Direct global reference on the "B" cross-reference of the Term Classification file. ^GMRD(124.25,DA,0) .01 NAME 0;1 Direct Global Read & w Check for the existence of the zero node and do a direct global read of the first piece. ROUTINE: ******************** 1389 NAME: GMR TEXT CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 124.3 ROOT: GMR(124.3, DESCRIPTION: TYPE: File Nursing has permission to access the GMR Text (124.3) file fields described in this DBIA. ^GMR(124.3,D0, .01 TEXT BLOCK 0;1 Direct Global Read & w .03 DATE CREATED 0;3 Direct Global Read & w 3 AUTHOR 0;5 Direct Global Read & w 5 ENTERED IN ERROR 5;1 Direct Global Read & w 5.1 DATE ENTERED IN ERRO 5;2 Direct Global Read & w 5.2 USER ENTERING IN ERR 5;3 Direct Global Read & w Nursing can point to this file from the Nurs Care Plan (216.8) file. Nursing can access the ^GMR(124.3,D0,0) node to lock/unlock a record in the GMR Text (124.3) file. Nursing can access the "AA" cross-reference on the GMR Text file using direct global reads. ^GMR(124.3,D0,1,D1, .01 SELECTION 0;1 Direct Global Read & w 1 APPENDED/INTERNAL TE 0;2 Direct Global Read & w 2 ADDITIONAL TEXT ADD;1 Direct Global Read & w Also direct global reads are supported for the "ALIST" and "B" cross-references of the Selection sub-file are supported. ^GMR(124.3,D0,1,D1,2,D2, .01 AUDIT TRAIL DATE/TIM 0;1 Direct Global Read & w 1 MODIFICATION 0;2 Direct Global Read & w 2 USER WHO MODIFIED 0;3 Direct Global Read & w Also a direct global read to the "AA" cross-reference of the Audit Trail sub-file is supported. ROUTINE: ******************** 1390 NAME: GMRY PATIENT I/O FILE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126 ROOT: GMR(126, DESCRIPTION: TYPE: File Nursing has permission to access the GMRY Patient I/O File (126) file fields described in this DBIA. ^GMR(126,D0, Direct global read on "B" cross-reference of GMRY Patient I/O File is supported. LAYGO is allowed to this file using a ^DIC lookup. ^GMR(126,D0,'IVM',D1, Direct global reference on the "B" cross-reference of the IV Maintenance sub-file is supported. ^GMR(126,D0,'IVM',D1,1,D2, .01 MAINTENANCE DATE/TIM 0;1 Direct Global Read & w 1 SITE DESCRIPTION 0;2 Direct Global Read & w 2 TUBING CHANGED 0;3 Direct Global Read & w 3 DRESSING CHANGED 0;4 Direct Global Read & w 4 ENTERED BY 0;5 Direct Global Read & w 5 SITE DC'ED 0;6 Direct Global Read & w Direct global reads of the "B" and "C" cross-references of the Maintenance sub-file are also supported. ^GMR(126,0) Direct global read to test for existence of the file is supported and permission to set it if it does not exist. ^GMR(126,D0,'IV',D1,3) 17 PORT 0;1 Direct Global Read & w Direct global read to check for its existence and to get the first piece. Direct global read to check for its existence and to get the first piece. ROUTINE: ******************** 1391 NAME: GMRY NUR SHIFT/OTHER CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.95 ROOT: GMRD(126.95, DESCRIPTION: TYPE: File Nursing and Vitals/Measurements have permission to access the GMRY NUR Shift/Other file fields described in this DBIA. ^GMRD(126.95,D0, 1 NIGHT 1;1 Direct Global Read & w 2 DAY 1;2 Direct Global Read & w 3 EVENING 1;3 Direct Global Read & w ROUTINE: ******************** 1392 NAME: GMRY INPUT TYPE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.56 ROOT: GMRD(126.56, DESCRIPTION: TYPE: File Vitals/Measurments has permission to access the GMRY Input Type file as described in this DBIA. ^GMRD(126.56,D0, .01 NAME 0;1 Direct Global Read & w Direct global read of the "C" cross-reference of the GMRY Input Type file is also supported. ROUTINE: ******************** 1393 NAME: GMRY OUTPUT TYPE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.58 ROOT: GMRD(126.58, DESCRIPTION: TYPE: File Vitals/Measurements has permission to access the GMRY Output Type (126.58) file as described in this DBIA. ^GMRD(126.58,D0, .01 OUTPUT TYPE 0;1 Direct Global Read & w Direct global read of the "C" cross-reference of the GMRY Output Type file is also supported. ROUTINE: ******************** 1394 NAME: GMRGED0 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to access the GMRGED0 routines as described in this DBIA. ROUTINE: GMRGED0 COMPONENT: EN3 VARIABLES: DFN Type: Input Patient file IEN. GMRGPDA Type: Input Entry in GMR Text (124.3) file of data to be edited. GMRGRT Type: Input A two piece variable in format A^B, where A is the Aggregate Term (124.2) file IEN for prime document to be edited, i.e., Nursing Care Plan, and B is the text representation of the prime document. GMRGOUT Type: Output A flag indicating whether the user abnormally exited the input process, i.e., time-out or ^-out. 0 indicates normal processing, 1 indicates abnormal exit. This entry point allows the user to edit a Nursing Care Plan for a specified patient. COMPONENT: Q3 VARIABLES: This entry cleans up variables used by the enter/edit patient data process of the Text Generator. ******************** 1395 NAME: GMRYED1 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to access the entry points described in this DBIA for the GMRYED1 routine. ROUTINE: GMRYED1 COMPONENT: INPUT VARIABLES: DFN Type: Input Patient IEN. GNUROP Type: Input Type of Input/Output/IV. GMRHLOC Type: Input Hospital Location file pointer. GMROUT Type: Both Switch that is set to 0 and returned if abnormal user exit. Allows user to enter/edit patient intake. COMPONENT: OUTPUT VARIABLES: DFN Type: Input Patient IEN. GNUROP Type: Input Type of data Input/Output/IV. GMRHLOC Type: Input Hospital Location (44) pointer. GMROUT Type: Both Switch to determine if user abnormally exits. Passed in with value of 0. Allows user to enter/edit patient Output. ******************** 1396 NAME: GMRYRP0 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to access the following entry points in the GMRYRP0 routine. ROUTINE: GMRYRP0 COMPONENT: EN1 VARIABLES: GMRNUR Type: Input This variable is set to one to indicate that this routine was called from an external package. This entry point prints an I/O Summary by Patient (by Shift & Day(s)). COMPONENT: EN4 VARIABLES: GMRNUR Type: Input This variable is set to one to indicate that this routine was called from an external package. This entry point prints an I/O Summary (Midnight to Present). COMPONENT: EN5 VARIABLES: GMRNUR Type: Input This variable is set to one to indicate that this routine was called from an external package. This entry point prints an I/O Summary (48 hours). COMPONENT: EN2 VARIABLES: GMRNUR Type: Input This variable is set to one to indicate that this routine was called from an external package. This entry point prints the Patient I/O Summary Report for the previous day. COMPONENT: Q VARIABLES: This entry point cleans up variables used by GMRYRP0 calls. ******************** 1397 NAME: GMRYED3 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry points described in this DBIA for the GMRYED3 routine. ROUTINE: GMRYED3 COMPONENT: LIST VARIABLES: DFN Type: Input Patient IEN. GNUROP Type: Input Type of Input/Output/IV. GMRHLOC Type: Input Hospital Location file (44) pointer. GMROUT Type: Both This variable indicates whether the user abnormally exited the input process. It is passed in with a value of 0. This entry point allows user to start/add/DC IV and maintenance. ******************** 1401 NAME: PRSE PARAMETERS CUSTODIAL PACKAGE: EDUCATION TRACKING SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 452.7 ROOT: PRSE(452.7, DESCRIPTION: TYPE: File Nursing has permission to access the PRSE Parameters (452.7) file fields as described in this DBIA. ^PRSE(452.7,D0, 1 PRSE OFFLINE/ON-LINE OFF;1 Direct Global Read & w ROUTINE: ******************** 1403 NAME: PAID CODE FILES CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 454 ROOT: PRSP(454, DESCRIPTION: TYPE: File Nursing has permission to access the PAID Code Files file fields as described in this DBIA. ^PRSP(454,D0,'ORG',D1, .01 CODE 0;1 Direct Global Read & w 1 DESCRIPTION 0;2 Direct Global Read & w Also included here are direct global reads of the "B" and "C" cross-references of the Cost Center/Organization sub-file. ROUTINE: ******************** 1404 NAME: PAID COST CENTER/ORGANIZATION CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 454.1 ROOT: PRSP(454.1, DESCRIPTION: TYPE: File Nursing has permission to access the "B" cross-reference of the PAID Cost Center/Organization (454.1) file using direct global reads. ROUTINE: ******************** 1407 NAME: FHWHEA CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: NURSING SERVICE HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to call the ^FHWHEA routine as described in this DBIA. ROUTINE: FHWHEA COMPONENT: FHWHEA VARIABLES: GMTS1 Type: Input 9999999-(End_Date_for_Order_Search) GMTS2 Type: Input 9999999-(Start_Date_for_Order_Search) GMTSNDM Type: Input Number of diets orders to be returned. Nursing sets this variable to 1. UTILITY($J Type: Output Only two nodes from the ^UTILITY($J are used by Nursing and are documented here. ^UTILITY($J,"DI",9999999-(Order_Start_Date), 0)=ST^EN^DIET^COM^TYPE where ST=Order Start Date (FM format) EN=Order End Date (FM format) DIET=Patient's diet (free text) COM=Comments about diet (free text) TYPE=Type of Service for diet (Tray, Cafeteria, Dining Room) ^UTILITY($J,"TF",9999999-(D/T_of_Tubefeeding ),0)=TF^CD^PR^ST^QT^CC^KC^COM where TF=Date/time of tubefeeding (FM format) CD=Cancel date/time of tubefeeding (FM format) PR=Product used in tubefeeding (free text) ST=Strength of product used (1/4, 1/2, 3/4, FULL) QT=Quantity of product used (free text) CC=Total CC's of tubefeeding (numeric) KC=Total KCal's of tubefeeding (numeric) COM=Comments about tubefeeding (free text) This entry point returns information about Dietetics orders for a particular patient. ******************** 1409 NAME: NURS LOCATION CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: GEN. MED. REC. - I/O DSS - DECISION SUPPORT SYSTEM EX BAR CODE MED ADMIN USAGE: Private ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 211.4 ROOT: NURSF(211.4, DESCRIPTION: TYPE: File Intake/Output can access the Nurs Location (211.4) file entry as described in this DBIA. Direct read of the 'B' Cross Reference in the NURS LOCATION file (#211.4) is also permitted. Direct global read of the "C" cross-reference of the NURS LOCATION file (#211.4) is also permitted. ^NURSF(211.4, .01 NAME 0;1 Direct Global Read & w 1 PATIENT CARE FLAG 1;1 Direct Global Read & w 1.5 INACTIVE FLAG I;1 Read w/Fileman Direct global read of ^NURSF(211.4) is supported to check if the file exists. Direct global read of the "D" cross-reference of the NURS Location (211.4) file is supported. ^NURSF(211.4,D0,3, .01 MAS WARD 0;1 Direct Global Read & w Direct global read of ^NURSF(211.4,D0,3,D1) to $Order through the multiple is supported. ROUTINE: ******************** 1410 NAME: NURS POSITION CONTROL CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: GEN. MED. REC. - I/O USAGE: Private ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 211.8 ROOT: NURSF(211.8, DESCRIPTION: TYPE: File Intake/Output has permission to access the NURS Position Control (211.8) file as indicated in this DBIA. ^NURSF(211.8,D0, .02 SERVICE CATEGORY 0;2 Direct Global Read & w Also direct global read access of the "D" cross-reference of file 211.8 is supported. ROUTINE: ******************** 1411 NAME: NURS PATIENT CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: GEN. MED. REC. - I/O USAGE: Private ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 214 ROOT: NURSF(214, DESCRIPTION: TYPE: File Intake/Output can access the NURS Patient (214) file as described in this DBIA. ^NURSF(214,D0, 2 NURS LOCATION 0;3 Direct Global Read & w Direct global read of the "AF" and "E" cross-references of the NURS Patient (214) file is supported. Direct global read of the ^NURSF(214,D0,0) node is also supported. ROUTINE: ******************** 1412 NAME: DD GLOBAL CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - GENERATOR GEN. MED. REC. - VITALS CONSULT/REQUEST TRACKING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File The Nursing, Vitals/Measurements, and Text Generator packages have been granted permission to access the DD global as defined in this DBIA. ^DD(124.2,0,'DIK') Nursing and Text Generator have permission to kill this node to uncompile cross-references on the Aggregate Term (124.2) file. ^DD(file,field, .01 LABEL 0;1 Direct Global Read & w Nursing can direct global read the name of a field, and direct global read to loop through the ^DD global to get all of the fields for a particular Nursing file. file is in the range of the Nursing file number space assigned by the DBA, and field is a valid field number in file. .3 POINTER 0;3 Direct Global Read & w Nursing can access this field to decode a set of codes to its external format. file is in the range of the Nursing file number space assigned by the DBA, and field is a valid field number in file. .5 INPUT TRANSFORM 0;5,99 Direct Global Read & w Nursing can execute the input transform directly for its files/fields. file is in the range of the Nursing file number space assigned by the DBA, and field is a valid field number in file. 3 'HELP'-PROMPT 3;E1,245 Direct Global Read & w Nursing can read the 'Help'-Prompt field for its files/fields. file is in the range of the Nursing file number space assigned by the DBA, and field is a valid field number in file. 4 XECUTABLE 'HELP' 4;E1,245 Direct Global Read & w Nursing can read the Xecutable 'Help' for its files/fields. file is in the range of the Nursing file number space assigned by the DBA, and field is a valid field number in file. 8 READ ACCESS (OPTIONA 8;E1,245 Direct Global Write & The Text Generator and Vitals/Measurements can write the Read Access (Optional) for its files/fields. file is in the appropriate package numberspace as assigned by the DBA, and field is a valid field number for file. 9 WRITE ACCESS (OPTION 9;E1,245 Direct Global Write & The Text Generator and Vitals/Measurements can write the Write Access (Optional) for its files/fields. file is in the appropriate numberspace as assigned by the DBA, and field is a valid field number of file. 21 DESCRIPTION 21;0 Direct Global Read & w Nursing is allowed direct global read access to the Descriptions for fields to print them out. Also included here are the direct global read references to the ^DD(file,field,21, subtree that would be necessary to read this WP field. file is a valid number in the Nursing numbers space as assigned by the DBA, and field is a valid field number for file. ^DD(file,field,1,xref_ien, 1 SET STATEMENT 1;E1,245 Direct Global Read & w Nursing and the Text Generator are allowed to directly read the Cross-reference Set Statements for their package so they can be executed. file is a valid number in the appropriate number space as assigned by the DBA, field is a valid field number of file, and xref_ien is the cross-reference ien being used. 2 KILL STATEMENT 2;E1,245 Direct Global Read & w Nursing and the Text Generator are allowed to directly read the Cross-reference Kill Statements for their package so they can be executed. file is a valid number in the appropriate number space as assigned by the DBA, field is a valid field number of file, and xref_ien is the cross-reference ien being used. Nursing and the Text Generator are allowed direct global read access to ^DD(file,field,1,xref_ien) in order to loop through the cross-reference multiple for their files, where file is in the package numberspace assigned by the DBA, field is a valid field in file, and xref_ien is the ien of the cross-reference for field in file. ^DD(file,'SB', Nursing can direct global read the ^DD(file,"SB") cross-reference to determine the sub-files for a particular file/sub-file. file is a valid number in the Nursing numberspace as assigned by the DBA. ^DD(124.21,0,'DIK') Vitals, Nursing & Text Generator have permission to kill off this node. ^DD(124.2,0,'DIKOLD') Vitals, Nursing & Text Generator have permission to kill off this node. ^DD(2,0,'IX','ANURS',2,.1) Nursing has permission to direct global kill/write this node when setting up the "ANURS" cross-reference in the Patient file. MAS has already approved this, see MailMessage #18109934. ^DD(2,.1,1, Nursing can direct global write the following nodes: ^DD(2,.1,1,xref_ien,0)="2^ANURS^MUMPS", ^DD(2,.1,1,xref_ien,1)="S %X=X,X=""NURSCPL"" X ^%ZOSF(""TEST"") S X=%X D:$T EN1^NURSCPL", ^DD(2,.1,1,xref_ien,2)="S %X=X,X=""NURSCPL"" X ^%ZOSF(""TEST"") S X=%X D:$T EN2^NURSCPL". xref_ien is the next available cross-reference ien for field .1. A direct global read is allowed on ^DD(2,.1,1,xref_ien) to loop through the xrefs of field .1. Nursing can direct global kill the ANURS cross-reference via a direct global kill of the ^DD(2,.1,1,xref_ien) node. xref_ien is ien of the ANURS xref (where $P(^DD(2,.1,xref_ien,0),"^",2)="ANURS"). MAS has already approved this use of their file, ref. msg #18109934. ROUTINE: ******************** 1413 NAME: MARITAL STATUS CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE ACCOUNTS RECEIVABLE CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 11 ROOT: DIC(11, DESCRIPTION: TYPE: File Nursing has permission to access the Marital Status (11) file as described in this DBIA. ^DIC(11,D0, 2 MARITAL STATUS CODE 0;3 Direct Global Read & w ROUTINE: ******************** 1414 NAME: RELIGION CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NURSING SERVICE LAB SERVICE USAGE: Private ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 13 ROOT: DIC(13, DESCRIPTION: TYPE: File Nursing has permission to access the Religion (13) file as described in this DBIA. LAB SERVICE will use the NAME (#.01) and CODE (#3) fields in sort and print templates. ^DIC(13,D0, .01 NAME 0;1 Direct Global Read & w 3 CODE 0;4 Direct Global Read & w ROUTINE: ******************** 1415 NAME: GMRYFLW0 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 8,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to access the following entry point in the GMRYFLW0 routine. ROUTINE: GMRYFLW0 COMPONENT: EN1 VARIABLES: GMRNUR Type: Input This variable is passed in with a value of 1 to indicate that the report is requested by the Nursing service. This entry point allows user to print the Intravenous Infusion Flow Sheet for a selected time range. ******************** 1417 NAME: LOCATION TYPE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JUN 24,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.9 ROOT: DIC(40.9, DESCRIPTION: TYPE: File Nursing can access the Location Type (40.9) file as described in this DBIA. ^DIC(40.9,0) 1 DESIGNATION 0;2 Direct Global Read & w Also allowed is direct global read access to the "C" cross-reference of the Designation field on the Location Type file. ROUTINE: ******************** 1418 NAME: GMRGED1 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can reference the GMRGED1 routine as described in this DBIA. ROUTINE: GMRGED1 COMPONENT: EN1 VARIABLES: DFN Type: Input Patient's IEN. GMRGPDA Type: Input Entry in GMR Text file for document where part will be edited. GMRGRT Type: Input Two piece variable indicating prime document for this GMR Text (124.3) file entry. The first piece is the Aggregate Term file pointer of the prime document, the second piece is the text representation of the prime document. GMRGTERM Type: Input Term in which user will start editing patient data. This is starting point of the edit. The data for this variable is two-piece, where the first piece is the Aggregate Term file pointer of the term, and the second piece is the text representation of the term. GMRGVNAM Type: Input Free text patient name. GMRGVSSN Type: Input Patient SSN. GMRGVDOB Type: Input Paitent DOB. GMRGVAGE Type: Input Patient age. GMRGVAMV Type: Input IEN in Patient Movement file for current patient admission information, or null if patient not current inpatient. GMRGVPRV Type: Input Patient provider for current patient admission information, or null if patient not current inpatient. GMRGVWRD Type: Input Inpatient ward for current patient admission information, or null if patient not current inpatient. GMRGVRBD Type: Input Patient room/bed for current patient admission information, or null if patient not current inpatient. GMRGVADT Type: Input Admission date/time for current patient admission information, or null if patient not current inpatient. GMRGVDX Type: Input Patient admitting diagnosis for current patient admission information, or null if patient not current inpatient. GMRGTOP(0) Type: Input This is the current prime document for the level that has been jumped to. For this usage it is just +GMRGRT. GMRGTOP Type: Input GMRGTOP represents how many levels the user has jumped to. In this case Nursing just passes in 1. GMRGLVL Type: Input Current jump level being edited. In this case the value 1 is passed in. GMRGLVL( Type: Input GMRGLVL(GMRGLVL)=Tree level for this jump-level. GMRGLVL(GMRGLVL,GMRGTLVL)=Stack level for this tree level for this jump-level. The GMRGLVL array can be used to address the ^TMP($J,"GMRGLVL", global. This application is passing in GMRGLVL(1)=1, and GMRGLVL(1,1)=1. GMRGTLVL Type: Input Current tree level being processed. This application will pass in the value of 1. GMRGSLVL Type: Input The current stack level being processed. This application passes in 1. TMP($J,'GM Type: Input This global maps the selections and how they were picked. Using GMRGLVL, GMRGTLVL, GMRGSLVL, and GMRGLVL( the order of items selected by the user, or what the user typed at each prompt can be determined. ^TMP($J,"GMRGLVL",GMRGLVL,GMRGTLVL,GMRGSLVL) =A^B^C, where A is the Aggregate Term file entry of term processed, B is action to be performed (add, delete, edit internal text, etc.), and C is a flag whether to redisplay the frame (0) or not (1). ^TMP($J,"GMRGLVL",GMRGLVL,GMRGTLVL,GMRGSLVL) =D^E^F, where D is the free text of the aggregate term being edited, E is the IEN in the Selection multiple of the GMR Text file that represents this term, and F is the appended/internal text currently entered for this term. GMRGPRC Type: Input This variable in represents what the user typed in. This variable has 3 pieces, A^B^C, where A is the IEN of the Aggregate Term the user selected, B is the action the user wants to take (add, delete, edit internal text, etc.), and C is whether the user indicated to redisplay the screen for this term or not. GMRGPRC(0) Type: Input This variable contains three pieces, A^B^C, which contain data about the selection the user made. A is the free text of the Aggregate Term selected, B is the entry number of this term in the Selection multiple of the GMR Text file, and C is the appended/internal text stored for this selection. GMRGTERM(0 Type: Input Zeroth node of the Aggregate Term file for the Aggregate Term used as a starting point. GMRGSCRP Type: Input Current script being executed. This is passed in with a value of 0. GMRGSITE Type: Input The IEN in Package Parameters multiple of GMRG Parameters (124.1) file for the type of prime document being edited. In this case it would be the IEN for the NURSC entry. GMRGSITE(0 Type: Input The zeroth node of the GMRGSITE entry in the Package Parameters multiple of the GMRG Parameters file. GMRGSITE(' Type: Input The "P"-node for the GMRGSITE entry in the Package Parameters multiple of the GMRG Parameters file. GMRGSTAT Type: Input Information about the last audit trail entry for the Aggregate Term being edited. This is a three piece variable set by STAT^GMRGRUT0 utility. GMRGIO('RV Type: Input Reverse video off executable code for the current terminal used, if it exists. GMRGIO('RV Type: Input Reverse video on executable code for the current terminal used, if it exists. GMRGIO('S' Type: Input This is a flag indicating whether the current terminal supports reverse video on/off (1), or not (0). GMRGLIN('- Type: Input A string of "-"'s with lenght IOM. GMRGLIN('* Type: Input A string of "*"'s with lenght IOM. GMRGUP Type: Both This variable indicates whether the user hit to bypass last level (1), or not (0). It is passed in with value of 0. GMRGNORD Type: Both This variable indicates whether the user wishes to view this screen upon reentry (0), or not (1). It is passed in as 0. GMRGOUT Type: Both This variable indicates whether the user abnormally exited input (1), or not (0). The variable is passed in with value of 0. GMRGSEL( Type: Output This entry also returns the current list of selections for the frame passed in by GMRGTERM. GMRGSEL(A)=B, where A is the selection number from the screen, and B is a three piece variable where the first piece is the Aggregate Term file IEN for the term represented by this selection, the second piece is the printable text of that Aggregate Term, and the third piece is a flag indicating whether the selection is currently active (1), or not (0). This entry point allows the user to edit only part of the prime document for a patient, and not the whole document. ******************** 1419 NAME: GMRGED2 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGED2 routine as described in this DBIA. ROUTINE: GMRGED2 COMPONENT: QP VARIABLES: GMRGTERM Type: Input This variable represents the Aggregate Term of the frame being processed and has format A^B^C, where A is the Aggregate Term file IEN, B is the free text representation of this Aggregate Term, and C is the Selection mulitple IEN in the GMR Text file for this entry. GMRGPDA Type: Input This is the GMR Text file entry for this frame. GMRGSEL( Type: Input This is the current list of selections for the frame represented by GMRGTERM. GMRGSEL(A)=B, where A is the selection number from the screen, and B is a three piece variable where the first piece is the Aggregate Term file IEN for the term represented by this selection, the second piece is the printable text of that Aggregate Term, and the third piece is a flag indicating whether the selection is currently active (1), or not (0). GMRGTERM(0 Type: Input The zeroth node of the Aggregate Term represeted in GMRGTERM. GMRGOUT Type: Input Represents whether user abnormally exited processing of this frame (1), or not (0). This entry point will finish processing for a selection edited. ******************** 1420 NAME: GMRGEDB CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGEDB routine as described in this DBIA. ROUTINE: GMRGEDB COMPONENT: ADSEL VARIABLES: GMRGPDA Type: Input GMR Text (124.3) file entry. GMRGPRC Type: Input This is a three piece variable representing the Aggregate Term file entry. The first piece is the Aggreage Term file IEN, the second piece is the action the user wishes to perform on this aggregate term, and the final piece indicates whether the user wishes to redisplay this frame after processing it. This entry point will add a Selection multiple entry in the GMR Text file for an aggregate term if it does not exist already and then updates the Selection multiple to activate the selection. ******************** 1421 NAME: GMRGPNBL CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGPNBL routine as described in this DBIA. ROUTINE: GMRGPNBL COMPONENT: EN1 VARIABLES: GMRGPDT Type: Input Date/time that view of data should be taken from. GMRGPDA Type: Input GMR Text file IEN. GMRGPAR Type: Input Aggregate Term file IEN from where to begin data display. GMRGPAR(0) Type: Input A four piece variable A^B^C^D, where A indicates whether to show active plan data only (1), or to show both active/inactive data (0), B is the number of spaces to leave from right margin, C is the number of spaces to leave from left margin, and D is the subscript to be used by the package making the call in the return array. TMP($J,'GM Type: Output The ^TMP($J,"GMRGNAR", array is returned in the following format: ^TMP($J,"GMRGNAR",A,B,0)=^N, and ^TMP($J,"GMRGNAR",A,B,C)=D, where N is the number of lines of printable text, A is the package subscript passed in the GMRGPAR(0) parameter, B is the Aggregate Term IEN passed in the GMRGPAR parameter, C is a number between 1 and N, and D is a printable line of text. This entry point will return the printable text for an aggregate term and a particular GMR Text entry. ******************** 1422 NAME: GMRGRUT0 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can use the GMRGRUT0 routine as described in this DBIA. ROUTINE: GMRGRUT0 COMPONENT: STAT VARIABLES: GMRGST Type: Input IEN of Selection multiple of GMR Text file. GMRGST(1) Type: Input GMR Text file IEN. GMRGSTAT Type: Output This is a three piece variable, A^B^C, where A is the IEN of the Audit Trail entry in the Audit Trail sub-file of the Selection sub-file of the GMR Text file, B is the date/time of the audit trail entry, and C is the modification done in this audit trail entry. Get the last audit trail entry for this Selection in the GMR Text file. ******************** 1423 NAME: GMRGRUT1 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to use the GMRGRUT1 routine as described in this DBIA. ROUTINE: GMRGRUT1 COMPONENT: FITLINE VARIABLES: GMRGPLN Type: Input Text to be printed. GMRGLEN Type: Input Length of line to fit text into. GMRGPLN(0) Type: Output The line of text that fits into the specified length. GMRGPLN(1) Type: Output The remainder of the text that did not fit on the line. This entry point takes text and a length of a line and returns the part of the text that will print in the line, broken at the last word, and the rest of the text not printed. ******************** 1424 NAME: GMRGRUT2 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGRUT2 routine as described in this DBIA. ROUTINE: GMRGRUT2 COMPONENT: EN1 VARIABLES: GMRGXPRT Type: Both Aggregate Term file IEN of term to be printed is passed in. If the GMRGXPRT(1) variable indicates to return text in GMRGXPRT, then GMRGXPRT will contain the printable text. GMRGXPRT(0 Type: Input Appended/Internal text to be printed with this aggregate term. GMRGXPRT(1 Type: Input Parameters customizing the print. This is a six piece variable, A^B^C^D^E^F, where A is the number of spaces to indent from left margin, B is the length of the line, C indicates whether to include the brackets for internal text (1) or not (0), D indicates whether to highlight this term (1) or not (0), E indicates whether to print the result (0), or return result in GMRGXPRT variable (1), and F indicates whether to hide text in <> bracktes (1) or not (0). This entry point will take an aggregate term and return/print the printable version of it. ******************** 1425 NAME: GMRGRUT3 CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGRUT3 routine as indicated in this DBIA. ROUTINE: GMRGRUT3 COMPONENT: EN1 VARIABLES: GMRGRT Type: Input This variable represents the prime document to be screened for. This is a two-piece variable, A^B, where A is the Aggregate Term file IEN for the prime document, and B is the free text representation of the prime document. DFN Type: Input Patient file IEN. GMRGXPRT Type: Input Parameters to customize lookup. This variable has three pieces, A^B^C, where A indicates whether to look at all (1) or only active (0) data, B indicates whether an entry can be added (1) or not (0), and C indicates whether an entry can be entered in error (1) or not (0). GMRGPDA Type: Output GMR Text file IEN. GMRGOUT Type: Output Flag indicating whether user abnormally exited lookup (1) or not (0). This entry point will select an entry from the GMR Text file. ******************** 1426 NAME: GMRGTGIF CUSTODIAL PACKAGE: GEN. MED. REC. - GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 13,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRGTGIF routine as described in this DBIA. ROUTINE: GMRGTGIF COMPONENT: EN4 VARIABLES: GMRGRT Type: Input This variable represents the prime document to be screened for. This is a two-piece variable, A^B, where A is the Aggregate Term file IEN for the prime document, and B is the free text representation of the prime document. GMRGPK Type: Input Package reference to indicate which prime document is to be edited. NURSC represents Nursing Care Plan. GMRGOUT Type: Output Flag indicating whether user abnormally exited lookup (1) or not (0). This entry point allows the user to enter/edit data in the Aggregate Term file. ******************** 1430 NAME: GMRYRP1 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing has permission to access the NEXT entry point for the GMRYRP1 routine. Vitals/Measurements is allowed to use the entry STARTD for the GMRYRP1 routine. ROUTINE: GMRYRP1 COMPONENT: NEXT VARIABLES: GMRFIN Type: Input Date/time the current nursing shift ends. GLASTDT Type: Output Date the day before the date stored in GMRFIN. GDTSTRT Type: Output Date the nursing shift starts. GNXTDT Type: Output Date the day after the date stored in GDTSTRT. GMRNIT Type: Output Time the nursing night shift starts. GDTFIN Type: Output Date the nursing shift ends. This entry point is called to initialize variables required for the SETSIFT^GMRYRP2 call. COMPONENT: STARTD VARIABLES: DFN Type: Input Patient IEN. GMRSTRT Type: Both Input: Start date of information extract. Output: Start date_night shift start hour. GMRFIN Type: Both Input: End date of information extract. Output: End date_evening shift end hour. GMROUT Type: Both Passed in with a value of 0. Returned a value of 1 if exited abnormally. GRPT Type: Input Set to 5 to indicate that the data are requested the V/M Graphic Reports. GMRNIT Type: Input Nursing night shift start hour defined in the GMRY NUR Shift/Other file (126.95). GMRDAY Type: Input Nursing day shift start hour defined in the GMRY NUR Shift/Other file (126.95). GMREVE Type: Input Nursing evening shift start hour defined in the GMRY NUR Shift/Other file (126.95). This entry is called to set up the start date/time and end date/time of information extract according to the nursing shift starting hours defined in the GMRY NUR Shift/Other file (126.95). ******************** 1431 NAME: GMRVDS0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the GMRVDS0 routine as described in this DBIA. ROUTINE: GMRVDS0 COMPONENT: EN2 VARIABLES: This entry point allows user to print latest vital signs for a patient if the patient IEN is unknown. ******************** 1432 NAME: GMRYUT0 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Vitals/Measurements can access the GMTRYUT0 routine as described in this DBIA. ROUTINE: GMRYUT0 COMPONENT: PT VARIABLES: DFN Type: Input Patient IEN. GMRAGE Type: Output Age of patient. GMRBED Type: Output Room-bed for patient. GMRSEX Type: Output Patient sex. GMRVADM Type: Output Patient admission date. GMRWARD Type: Output Pointer to Ward Location (42) file denoting patient's location. GMRWARD(1) Type: Output Free text of patient's location. This entry is used to call 1^VADPT to set up VAIN and VADM local variables. ******************** 1433 NAME: GMRYUT2 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point in the GMRYUT2 routine. ROUTINE: GMRYUT2 COMPONENT: SELSITE VARIABLES: DFN Type: Input Patient IEN. GMRX Type: Output Local global containing the intravenous infusion site information. This entry point is called to extract all current intravenous infusion sites and the sites discontinued within the last 24 hours for the selected patient. ******************** 1434 NAME: GMRYUT9 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Vitals/Measurements can access the GMRYUT9 routine as described in this DBIA. ROUTINE: GMRYUT9 COMPONENT: PATIENT VARIABLES: DFN Type: Input Patient IEN. GMRNUR Type: Input This is set to 1 to indicate return data from Nurs Patient file. SSN Type: Output Patient SSN. GMRAGE Type: Output Patient's age. GMRSEX Type: Output Patient's sex. GMRBED Type: Output Patient's room-bed. GMRVADM Type: Output Patient admission date/time. GMRWARD Type: Output Pointer to Ward Location (42) file denoting patient's location. GMRWARD(1) Type: Output Free text version of patient location. This entry point extracts information from Nurs Patient (214) file. ******************** 1435 NAME: GMRYRP2 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing and Vitals/Measurements can access the following entry points in the GMRYRP2 routine. ROUTINE: GMRYRP2 COMPONENT: SAVE VARIABLES: DA(1) Type: Input Pointer to the GMRY Patient I/O file (126). II Type: Input Passed in with a value of "IN" or "OUT" subscript of the GMRY Patient I/O file (126). GMRSTRT Type: Input Date/time the current nursing shift starts. GMRFIN Type: Input Date/time the current nursing shift ends. TMP Type: Output ^TMP($J,"GMRY") global contains intake and output information for a selected patient. This entry call extracts the intake and output information and stores the data in ^TMP($J,"GMRY") for a selected patient. COMPONENT: SAVEIV VARIABLES: DA(1) Type: Input Pointer to the Patient I/O file (126). GMRSTRT Type: Input Date/time the current nursing shift starts. GMRFIN Type: Input Date/time the current nursing shift ends. TMP Type: Output ^TMP($J,"GMRY") global contains the patient intravenous infusion information. This entry call extracts patient intravenous infusion information and stores the data in ^TMP($J,"GMRY") global. COMPONENT: SETSIFT VARIABLES: GMRINDT Type: Input Date/time the I/O data was entered. GDTSTRT Type: Input Date the nursing shift starts. GDTFIN Type: Input Date the nursing shift ends. GLASTDT Type: Input Date the day before the current nursing shift ends. GSHIFT Type: Output Value = "SH-1" night shift, = "SH-2" day shift, = "SH-3" evening shift. This entry is called to assign the nursing shift (night, day or evening) according to the date/time the I/O data was entered. COMPONENT: GMRYRP2 VARIABLES: DFN Type: Input Patient IEN. GMRSTRT Type: Input Start date for the information extract. GMRFIN Type: Input End date for the information extract. This routine is called by the Vitals/Measurements to extract patient intake and output information entered within a selected date range. ******************** 1436 NAME: GMRYRP3 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - VITALS USAGE: Private ENTERED: NOV 20,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing and Vitals/Measurements can access the following entry point in the routine GMRYRP3. ROUTINE: GMRYRP3 COMPONENT: REPORT1 VARIABLES: GRPT Type: Input Type of intake/output report. Set GRPT = 10 for the Nursing End of Shift Report. Set GRPT = 5 for the V/M Graphic Reports. GQ Type: Input Passed in with a value of 0, required by the GMRYRP3 routine. GQT Type: Input Passed in with a value of 0, required by the GMRYRP3 routine. GMROUT Type: Both This variable indicates whether the user abnormally exited the process. It is passed in with a value of 0. TMP Type: Both ^TMP($J,"GMRY") contains the intake, output and intravenous infusion data for a patient. If the data is requested by the Vitals/Measurements, ^TMP($J,"GMR") is also used to store the aggregated information. GTOTLI Type: Output Intake grand total. GTOTLO Type: Output Output grand total. GN(1) Type: Output Number of intake types listed in the GMRY Input Type file (126.56). GN(2) Type: Output Number of output types listed in the GMRY Output Type file (126.58). GIN Type: Output Intake nursing shift total. GOUT Type: Output Output nursing shift total. GTOTIN Type: Output Intake day total. GTOTOUT Type: Output Output day total. The Nursing End of Shift Report calls this entry point to aggregate the data obtained from the execution of SAVE^GMRYRP2 and ^GMRYRP2. The V/M Graphic Reports call this entry point to aggregate data obtained from the execution of STARTD^GMRYRP1, PT^GMRYUT0 and ^GMRYRP2. ******************** 1437 NAME: GMRYSE0 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point in the GMRYSE0 routine. ROUTINE: GMRYSE0 COMPONENT: EN1 VARIABLES: GMRNUR Type: Input This variable is passed in with a value of 1 to indicate that the report is requested by the Nursing Service. This entry point allows user to print the Patient Intake/Output 24 Hours Itemized Shift Report for a time range. ******************** 1438 NAME: GMRYSE3 CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point in the GMRYSE3 routine. ROUTINE: GMRYSE3 COMPONENT: FITLINE VARIABLES: GMRLEN Type: Input Number of characters for a line of text. GTXT(0) Type: Output The first n-words of the input text in the GTXT(1) that will fit in length GMRLEN. GTXT(1) Type: Both The rest of the text. This utility breaks a line of text into lines. The length of the new line is defined by user. ******************** 1439 NAME: GMRVDS1 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 21,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point in the GMRVDS1 routine as described in this DBIA. ROUTINE: GMRVDS1 COMPONENT: EN3 VARIABLES: DFN Type: Input Patient IEN. TMP Type: Input ^TMP($J,patient room-bed,patient name,DFN) global contains the patients for the report. GMRVWLO Type: Input Free text version of Nursing ward location. This entry point allows user to print the latest vital signs by a Nursing location. ******************** 1440 NAME: GMRVED0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry points described in this DBIA for the GMRVED0 routine. ROUTINE: GMRVED0 COMPONENT: EN3 VARIABLES: DFN Type: Input Patient IEN. GMROUT Type: Both This variable indicates whether the user abnormally exited the input process. It is passed in with a value of 0. GNUROP Type: Input This variable is passed in with a value of 1 to indicates that the edit process is requested by the Nursing Service. GMRVIDT Type: Input The date/time the vitals/measurements were taken. GMRVHLOC Type: Input Hospital Location file (44) pointer. GMRENTY Type: Input The type of vitals/measurements to edit. GMRSTR Type: Input The string of which vitals/measurements to edit, for example, "T;P;R;BP;WT;". This entry point allows user to enter vitals/measurements for a patient. COMPONENT: Q VARIABLES: This entry point is called to clean up the variables used by the GMRVED0. ******************** 1441 NAME: GMRVEE0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point described in this DBIA for the GMRVEE0 routine. ROUTINE: GMRVEE0 COMPONENT: EN2 VARIABLES: DFN Type: Input Patient IEN. This entry point allows user to edit a vital/measurement entered in error. ******************** 1442 NAME: GMRVER0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point described in this DBIA for the GMRVER0 routine. ROUTINE: GMRVER0 COMPONENT: EN1 VARIABLES: This entry point allows user to print vitals/measurements entered in error for a patient. ******************** 1443 NAME: GMRVSAS0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE BAR CODE MED ADMIN USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point described in this DBIA for the GMRVSAS0 routine. ROUTINE: GMRVSAS0 COMPONENT: EN1 VARIABLES: GMRVX Type: Input This variable is passed in with a value of "T", "P", "R", "B" or "BP" as vital type code. GMRVX(0) Type: Input This variable contains vital data for the screening. GMRVX(1) Type: Output If the output value equals 0 - vital data within normal range. If the output value equals 1 - abnormal value defined in the GMRV Vitals Parameters file (125.57). This entry point is called for checking the abnormal vital/measurement. ******************** 1444 NAME: GMRVSC0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE BAR CODE MED ADMIN USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry points described in this DBIA for the GMRVSC0 routine. 12/17/2003: Modified this IA to add the EN3 entry point. ROUTINE: GMRVSC0 COMPONENT: DATE VARIABLES: GMROUT Type: Both This variable indicates whether the user abnormally exited the call. It is passed in with a value of 0. GMRVSDT Type: Output Start date/time of the date range. GMRVFDT Type: Output End date/time of the date range. This entry point allows user to define start date/time and end date/time for a date range. COMPONENT: EN5 VARIABLES: DFN Type: Input Patient IEN. GMRX Type: Input Patient admission date/time. GMROUT Type: Both This variable indicates whether the user abnormally exited the report process. It is passed in with a value of 0. GMRVSDT Type: Input Start date/time of the date range. GMRVFDT Type: Input End date/time of the date range. GMRPG Type: Input This report page count is initialized with a value of 0. This entry point allows user to print cumulative vitals/measurements for a patient over a given date range. COMPONENT: EN3 VARIABLES: DFN Type: Input Patient internal entry number (FILE 2). (Required) GMRVSDT Type: Input Start date/time of the date range in FileMan internal format. (Required) GMRVFDT Type: Input End date/time of the date range in FileMan internal format. (Required) This entry point displays the patient cumulative report to the current output device. D EN3^GMRVSC0(DFN,GMRVSDT,GMRVFDT) ******************** 1445 NAME: GMRVSR0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry points described in this DBIA for the GMRVSR0 routine. ROUTINE: GMRVSR0 COMPONENT: EN5 VARIABLES: DFN Type: Input Patient IEN. GFLAG Type: Input This variable is passed in with a value of 0 to indicate that the report is requested by the Nursing Service. GMRDATE Type: Input This variable is passed in with a value of "start date/time^end date/time^type of graph". GMRVWLO Type: Input Nursing location free text. User can use this entry point to print V/M Graphic Reports, Vital Signs Record, B/P Plotting Chart or Weight Chart. COMPONENT: Q2 VARIABLES: This entry point is called to clean up the variables used for the graphic reports. ******************** 1446 NAME: GMRVUT0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES PCE PATIENT CARE ENCOUNTER CLINICAL REMINDERS MYHEALTHEVET LAB SERVICE CARE MANAGEMENT BAR CODE MED ADMIN CLINICAL CASE REGISTRIES SURGERY added 12/15/08 NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: NOV 28,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine will return vital/measurement for a patient over a given date/time range. ROUTINE: GMRVUT0 COMPONENT: EN1 VARIABLES: DFN Type: Input Patient IEN. GMRVSTR Type: Input Types of vitals/measurements desired. Use the abbreviations found in the GMRV Vital Type file (120.51). For multiple vitals, use the ; as a delimiter, for example, "T;P;R;BP;". GMRVSTR(0) Type: Input This variable specifies which vital/measurement data will be returned. The variable has four pieces, A^B^C^D, where: A=Start date/time (FM format) of vital/measurment data to be returned. B=End date/time (FM format) of vital/measurement data to be returned. C=Number of occurences (numeric) of vital/measurement data to be returned. D=Parameter to govern sort order of return array. The value of this piece can either be 0 or 1. If it is 0, the return data will be sorted by type, then by date/time entered. If it is 1, the return data will be sorted by date/time entered, then by type. See output variable ^UTILITY for more information. UTILITY Type: Output The output array is ^UTILITY($J,"GMRVD"). The subscripts of this array are governed by the 4th piece of the input variable GMRVSTR(0). If $P(GMRVSTR(0),"^",4) is true, the return array will be ^UTILITY($J,"GMRVD",RDT,TYP,IEN)=DATA If $P(GMRVSTR(0),"^",4) is false, the return array will be: ^UTILITY($J,"GMRVD",TYP,RDT,IEN)=DATA In the above, the following abbreviations translate as follows: RDT = Reverse date/time vital/measurement was taken in format 9999999-(Date/time taken). TYP = Abbreviation of vital/measurement type from GMRVSTR variable. IEN = Entry in GMRV Vital/Measurement (120.5) file of this data. DATA = Data about this vital/measurement with the following format, VDT^DFN^ITYP^EDT^LOC^USER^ISITE^RATE^IQUAL^S ITE^QUAL^ABN^UNIT^ BMI^LO2^PO2^AQUAL where: VDT = Date/time vital/measurement taken (FM format) DFN = IEN for patient in Patient file. ITYP = IEN for vital type in GMRV Vital Type file. EDT = Date/time vital/measurement entered (FM format) LOC = IEN for patient location in Hospital Location file. USER = User who entered data; IEN in New Person file. ISITE = IEN for site in GMRV Vital Site file. RATE = Rate for this vital/measurement (alphanumeric). IQUAL = IEN for quality in GMRV Vital Quality file. SITE = Site of vital/measurement (free text). QUAL = Quality of vital/measurement (free text). ABN = Flag indicating whether vital/measurement is abnormal. * indicates abnormal, null indicates normal. UNIT = Units of measurement for rate when appropriate, e.g. Centigrade for temperature, Kg for weight and centimeter for height. BMI = Body Mass Index (numeric);value calculated from height; (Applies only to the vital type WT (Weight)) LO2 = Liters/Minute of supplemental O2 (numeric). (Applies only to the vital type PO2 (Pulse Oximetry)). PO2 = % of supplemental O2 (numeric). (Applies only to the vital type PO2 (Pulse Oximetry)). AQUAL = All qualifiers (free text); Each qualifier is separated by a ;. GMRVSTR('L Type: Input This is an optional variable. It will be set to an ^ delimited list of Hospital Location Types, see Type (2) field of Hospital Location (44) file for a list of types. The first piece and last piece of the list must be null, i.e., ^C^M^. User can use this entry to gather patient vital/measurement data. ******************** 1447 NAME: GMRVUT2 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point described in this DBIA for the GMRVUT2 routine. ROUTINE: GMRVUT2 COMPONENT: SETU2 VARIABLES: DFN Type: Input Patient IEN. GMRVSTR Type: Input GMRVSTR(0) is passed in with a value of "^^1^1". GMRVSTR("T") is passed in with the abbreviation "WT" found in the GMRV Vital Type file (120.51). GMRVSTR("IEN") is passed in with a GMRV Vital Measurement file (120.5) pointer. GMRVSTR("R") is passed in with the date/time the weight was measured. UTILITY Type: Output The output array ^UTILITY($J,"GMRD") contains the desired patient weight. This entry is used to extract the last weight measurement for a patient. ******************** 1448 NAME: GMRVVS0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: NOV 22,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry points described in this DBIA for the GMRVVS0 routine. ROUTINE: GMRVVS0 COMPONENT: EN1 VARIABLES: DFN Type: Input Patient IEN. GFLAG Type: Input This variable is passed in with a value of 0 to indicate that the report is requested by the Nursing Service. GMROUT Type: Both This variable indicates whether the user abnormally exited the report process. It is passed in with a value of 0. GMRNUR Type: Input This variable is set to a value of 0 to indicate that the proces is requested by the Nursing Service. GMRSTRT Type: Input Start date/time for the report. GMRFIN Type: Input End date/time for the report. This entry point is used to print the Expanded SF 511 Report (Itemized I/O). COMPONENT: DATE VARIABLES: GMROUT Type: Both This variable indicates whether the user abnormally exited the process. It is passed in with a value of 0. GMRSTRT Type: Output Start date/time user entered. GMRFIN Type: Output End date/time user entered. User can use this entry to set up start date/time and end date/time for the report desired. COMPONENT: Q2 VARIABLES: This entry point is called to clean up the variables used by the GMRVVS0 routine. ******************** 1449 NAME: CHANGE PACKAGE FILE ENTRY CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: DEC 7,1995 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: 4 FILE: ROOT: DESCRIPTION: TYPE: Other The Allergy Tracking System package is changing its name to Adverse Reaction Tracking when the next version (4.0) is released. The Expert Panel feels this is a more accurate name for what the package does. When Version 4.0 is installed, the environmental check routine will do a look-up (using a DBS call) on the 'C' cross-reference of the PACKAGE file (#9.4) to find the appropriate entry and change the .01 field value to 'ADVERSE REACTION TRACKING'. The package's namespace is GMRA. Also, the PACKAGE file entry contains the old name and version number as data in the SHORT DESCRIPTION (#2) and DESCRIPTION (#3) fields. Leaving that data in the File 9.4 entry would confuse IRM support personnel. We request permission to edit these two fields, via FileMan, in the environment check routine at the time of installation. ROUTINE: ******************** 1450 NAME: DELETE X-REF ON .01 FIELD OF FILE 120.8 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: DEC 13,1995 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 4.0 FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File With the release of Adverse Reaction Tracking v4.0, we would like to directly kill the "ANKA01" cross-reference on the .01 field of File 120.8. In our installation process, we will do the following: ^DD(120.8,.01,1,D0 Direct global read/kill to loop through the cross-reference multiple of the .01 field of File 120.8 to find and kill the ANKA01 cross-reference. D0 is the cross-reference internal entry number. ^DD(120.8,.01,1,D0,0) Direct global read of the second piece of the zero node to determine the cross-reference name. D0 is the internal entry number of the cross-reference. ^DD(120.8,0,'IX','ANKA01',120.8,.01) Direct kill of this node. ROUTINE: ******************** 1451 NAME: DBIA1451 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JAN 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The following calls are made to routine RCJIBFN1 and are used to display bill transaction information. Each call returns data on a specific entry in the AR TRANSACTION FILE (#433). All data is returned in internal/unformated form unless otherwise stated. ROUTINE: RCJIBFN1 COMPONENT: $$N0(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: Transaction Number $p2: Date Calm Done $p3: Processed By (pointer to file #200) $p4: Text message indicating if transaction is 'INCOMPLETE' Returns null if no transaction found. COMPONENT: $$N1(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: Transaction Date $p2: Transaction Type (pointer to file #430.3) $p3: Receipt # $p4: Adjustment Number $p5: Transaction Amount $p6: Termination Reason (external form) $p7: Date Entered Returns null if no transaction found. COMPONENT: $$N2(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: IRS Loc. Cost $p2: Credit Rep Cost $p3: DMV Loc. Cost $p4: Consumer Rep. Agency Cost $p5: Marshal Fee $p6: Court Cost $p7: Interest Cost $p8: Administrative Cost Returns null if no transaction found. COMPONENT: $$N3(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: Principal Collected $p2: Interest Collected $p3: Admin. Collected $p4: Marshal Fee Collected $p5: Court Cost Collected $p6: Total collected for this transaction Returns null if no transaction found. COMPONENT: N4(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. STRG Type: Output Defined with a null value only if no data or transaction was found. STRG(I) Type: Output Array containing an entry for each fiscal year associated with the bill, where (I) is a simple 1:1 counter. $p1: Fiscal Year $p2: Principal Amount $p3: Pat Reference # $p4: Transaction Amount Defined on exit only if data was found. COMPONENT: $$N5(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: Brief Comment $p2: Follow-up Date Returns null if no transaction found. COMPONENT: N7(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. COM(I) Type: Output Array containing the transaction Comments, where (I) is a simple 1:1 counter. Defined on exit only if data was found. COMPONENT: $$N8(X) VARIABLES: X Type: Input Internal File Number of a transaction in file #433. Returns a string of information about the transaction requested: $p1: Principle Balance $p2: Interest Balance $p3: Admin Balance $p4: Marshal Fee $p5: Court Cost $p6: Total account balance after transaction is applied $p7: Transaction Comments Returns null if no transaction found. ******************** 1452 NAME: DBIA1452 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JAN 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The following calls are made to routine RCJIBFN2. The AR specific information returned for a bill/claim is displayed in Third Party Joint Inquiry. ROUTINE: RCJIBFN2 COMPONENT: $$TRAN(X) VARIABLES: X Type: Input Pointer to a transaction type in the ACCOUNTS RECEIVABLE TRANS.TYPE file (#430.3). Returns the AR Transaction Type Name. COMPONENT: $$STNO(X) VARIABLES: X Type: Input Pointer to a transaction type in the ACCOUNTS RECEIVABLE TRANS.TYPE file (#430.3). Returns a string of information about the transaction type requested: $p1: Name $p2: Abbreviation $p3: Status Number COMPONENT: $$STAT(X) VARIABLES: X Type: Input Pointer to a bill in the ACCOUNTS RECEIVABLE file (#430). Returns Current Status of the bill in AR. This is a pointer to a transaction type in the ACCOUNTS RECEIVABLE TRANS.TYPE file (#430.3). COMPONENT: TRN(X) VARIABLES: X Type: Input Pointer to a bill in the ACCOUNTS RECEIVABLE file (#430). Returns a string of information on each transaction asscociated with the bill passed in. The output is passed in ^TMP("RCJIB",$J,Y), hwere Y is a pointer to the transaction in the AR TRANSACTION file (#433). $p1: Transaction Number $p2: Transaction Date $p3: Transaction Type (pointer to file #430.3) $p4: Transaction Amount $p5: Amount Due for bill after transaction is applied $p6: Transaction Comments COMPONENT: $$BILL(X) VARIABLES: X Type: Input Pointer to a bill in the ACCOUNTS RECEIVABLE file (#430). Returns a string of information about the bill requested: $p1: Original Amount of bill $p2: Current Status (pointer to file #430.3) $p3: Current Balance $p4: Total Collected $p5: % Collected Returns null if no data or bill found. COMPONENT: BCOM(X) VARIABLES: X Type: Input Pointer to a bill in the ACCOUNTS RECEIVABLE file (#430). COM Type: Output String containing the following if data was found: $p1: Approved By (Fiscal) (pointer to file #200) $p2: AR Date Signed String will be null if no data found. COM(I) Type: Output Array containing the bill's Comments, where (I) is a simple 1:1 counter. Will only be defined if bill has comments. COMPONENT: DIQ(X1,X2,.X3) VARIABLES: X1 Type: Input Internal entry number of File 399 and DINUMED File 430. X2 Type: Input String of File 430 field numbers in the DR format used by Fileman's EN^DIQ1 call. X3 Type: Input Array name to be used to return the internal and external value of the fields sent in X2. X3 Type: Output The array name in X3 will contain the value of the fields sent in X2 as returned by EN^DIQ1. i.e. if X3="ARRAY" ARRAY(430,IEN,Field#,"I")=internal value ARRAY(430,IEN,Field#,"E")=external value This call is needed to return internal and external field values from the Accounts Receivable File 430. The format of the fields will be the output of Fileman's EN^DIQ1 call. ******************** 1453 NAME: DBIA1453 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JAN 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is used by the Third Party Joint Inquiry to allow the person viewing a bill to add a comment transaction to the AR bill record. ROUTINE: RCJIBFN3 COMPONENT: ADJUST(X) VARIABLES: X Type: Input Pointer to a bill in the ACCOUNTS RECEIVABLE file (#430). Allows addition of a comment transaction to an AR account. ******************** 1457 NAME: DBIA1457 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JAN 12,1996 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Third Party Joint Inquiry Menu [IBJ THIRD PARTY JOINT INQUIRY] will be added to the Agent Cashier [PRCAY MASTER] and Clerk's AR Menu [PRCA CLERK MENU]. This will be done by running the PRYQINIT init routine in patch PRCA*4.5*15. ROUTINE: COMPONENT: N/A VARIABLES: N/A Type: ******************** 1458 NAME: GMRY IV DC'ED REASON CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.76 ROOT: GMRD(126.76, DESCRIPTION: TYPE: File Nursing has permission to access the following field in the GMRY IV DC'ed Reason (126.76) file. ^GMRD(126.76,D0,0) .01 NAME 0;1 Both R/W w/Fileman Nursing is allowed to LAYGO entries into the file using FileMan. ROUTINE: ******************** 1459 NAME: GMRY OUTPUT SUBTYPE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.6 ROOT: GMRD(126.6, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the GMRY Output Subtype (126.6) file. ^GMRD(126.6,D0,0) .01 OUTPUT SUBTYPE 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. 1 OUTPUT TYPE 0;2 Both R/W w/Fileman ROUTINE: ******************** 1460 NAME: GMRY INTAKE ITEMS CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.8 ROOT: GMRD(126.8, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the GMRY Intake Items (126.8) file. ^GMRD(126.8,D0,0) .01 NAME 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. 1 VOLUME 0;2 Both R/W w/Fileman 2 INPUT TYPE 1;0 Both R/W w/Fileman Also Nursing is allowed to LAYGO into multiple using FileMan. ^GMRD(126.8,D0,1,D1,0) .01 INPUT TYPE 0;1 Both R/W w/Fileman ROUTINE: ******************** 1461 NAME: GMRY IV SITE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.7 ROOT: GMRD(126.7, DESCRIPTION: TYPE: File Nursing has permission to access the following field in the GMRY IV Site (126.7) file. ^GMRD(126.7,D0,0) .01 IV SITE 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. ROUTINE: ******************** 1462 NAME: GMRY NUR IV SOLUTION CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.9 ROOT: GMRD(126.9, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the GMRY NUR IV Solution (126.9) file. ^GMRD(126.9,D0,0) .01 NAME 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. 1 TYPE 0;2 Both R/W w/Fileman 2 VOLUME 0;3 Both R/W w/Fileman ROUTINE: ******************** 1463 NAME: GMRY INPUT TYPE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.56 ROOT: GMRD(126.56, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the GMRY Input Type (126.56) file. ^GMRD(126.56,D0,0) .01 NAME 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. 1 ORDER 0;2 Both R/W w/Fileman ROUTINE: ******************** 1464 NAME: GMRY IV SITE DESCRIPTION CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.72 ROOT: GMRD(126.72, DESCRIPTION: TYPE: File Nursing has permission to access the following field in the GMRY IV Site Description (126.72) file. ^GMRD(126.72,D0,0) .01 DESCRIPTION 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. ROUTINE: ******************** 1465 NAME: GMRY IV CATHETER CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.74 ROOT: GMRD(126.74, DESCRIPTION: TYPE: File Nursing has permission to access the following field in the GMRY IV Catheter (126.74) file. ^GMRD(126.74,D0,0) .01 IV CATHETER TYPE/SIZ 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. ROUTINE: ******************** 1466 NAME: GMRY OUTPUT TYPE CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 126.58 ROOT: GMRD(126.58, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the GMRY Output Type (126.58) file. ^GMRD(126.58,D0,0) .01 OUTPUT TYPE 0;1 Both R/W w/Fileman Also Nursing is allowed to LAYGO entries into the file using FileMan. 1 ORDER 0;2 Both R/W w/Fileman ROUTINE: ******************** 1467 NAME: GMRA ENTERED IN ERROR PROTOCOL CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: DIETETICS SURGERY The Surgery Quality & Workflow Manager (SQWM) module of the VistA Surgery package is requesting that the Surgery package become listed as a subscriber to ICR 1467 and the ICR changed to an Active status, for the purpose of adding a Surgery action protocol to the GMRA ENTERED IN ERROR extended action Protocol. Patch SR*3.0*180 is the primary SQWM patch being released under the VistA Surgery package. The Surgery software invoked by this Protocol will generate an HL7 message used to update the COTS SQWM system with current patient Adverse Reactions for the purpose of maintaining consistency with VistA for patient allergies verified through CPRS. VIRTUAL PATIENT RECORD Added RPC as a listener: VPR GMRA EVENTS HEALTH MANAGEMENT PLATFORM HMP GMRA EVENTS protocol ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: JAN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This extended action protocol is created with v4.0 and is invoked whenever an allergy/adverse reaction for a patient is marked as 'entered-in-error'. Action protocols from other applications may be added to this event upon approval of the DBIC. Listed below are the variables that will be defined for that reaction. Variables: GMRAPA = The Internal Entry Number of the reaction in File 120.8 (PATIENT ALLERGIES) GMRAPA(0) = The zero node of the entry in File 120.8. Below is a description of the data for that node. $P Field name Field type ----------------------------------------------------------- 1 PATIENT Pointer to File 2 (PATIENT) 2 REACTANT Free Text of Reaction 3 GMR ALLERGY Variable Pointer * 4 ORIGINATION DATE/TIME Date/Time (FM format) 5 ORIGINATOR Pointer to File 200 (NEW PERSON) 6 OBSERVED/HISTORICAL Set of Codes (o=Observed,h=Historical) 12 ORIGINATOR SIGN OFF Set of Codes (1=Signed,(Zero or Null)=Unsigned) 14 MECHANISM Set of Codes (U=Unknown, P=Pharmacologic,A=Allergy) 16 VERIFIED Set of Codes (1=Verified,(0 or Null)=Not Verified) 17 VERIFICATION DATE/TIME Date/Time (FM format) 18 VERIFIER Pointer to File 200 20 ALLERGY TYPE Free Text/Set of Codes 1 to 3 characters long (Where "D" = Drug, "F" = Food, "O" = Other) *The GMR ALLERGY field is a variable pointer which points to one of five possible files. They are: File Name File Reference --------- -------------- GMR ALLERGIES GMR(120.8, (e.g., 212;GMR(120.8,) NATIONAL DRUG PSNDF( DRUG PSDRUG( DRUG INGREDIENTS PS(50.416, VA DRUG CLASS PS(50.605, ROUTINE: ******************** 1469 NAME: GMRA SIGN-OFF ON DATA PROTOCOL CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: DIETETICS SURGERY The Surgery Quality & Workflow Manager (SQWM) module of the VistA Surgery package is requesting that the Surgery package become listed as a subscriber to ICR 1467 and the ICR changed to an Active status, for the purpose of adding a Surgery action protocol to the GMRA SIGN-OFF ON DATA PROTOCOL extended action Protocol. Patch SR*3.0*180 is the primary SQWM patch being released under the VistA Surgery package. The Surgery software invoked by this Protocol will generate an HL7 message used to update the COTS SQWM system with current patient Adverse Reactions for the purpose of maintaining consistency with VistA for patient allergies verified through CPRS. VIRTUAL PATIENT RECORD Added RPC as a listener: VPR GMRA EVENTS HEALTH MANAGEMENT PLATFORM HMP GMRA SIGN-OFF ON DATA protocol ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: JAN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This extended action protocol is created with v4.0 and is invoked whenever an allergy/adverse reaction tracking incident is signed-off on a patient. Action protocols from other applications may be added to this event upon approval of the DBIC. Listed below are the variables that will be defined for that reaction. Variables: GMRAPA = The Internal Entry Number of the reaction in File 120.8 (PATIENT ALLERGIES) GMRAPA(0) = The zero node of the entry in File 120.8. Below is a description of the data for that node. $P Field name Field type ----------------------------------------------------------- 1 PATIENT Pointer to File 2 (PATIENT) 2 REACTANT Free Text of Reaction 3 GMR ALLERGY Variable Pointer * 4 ORIGINATION DATE/TIME Date/Time 5 ORIGINATOR Pointer to File 200 (NEW PERSON) 6 OBSERVED/HISTORICAL Set of Codes (o=Observed,h=Historical) 12 ORIGINATOR SIGN OFF Set of Codes (1=Signed,(Zero or Null)= Unsigned) 14 MECHANISM Set of Codes (U=Unknown, P=Pharmacologic,A=Allergy) 16 VERIFIED Set of Codes (1=Verified,(0 or Null)=Not Verified) 17 VERIFICATION DATE/TIME Date/Time 18 VERIFIER Pointer to File 200 20 ALLERGY TYPE Free Text/Set of Codes 1 to 3 characters long (Where "D" = Drug, "F" = Food, "O" = Other) *The GMR ALLERGY field is a variable pointer which points to one of five possible files. They are: File Name File Reference --------- -------------- GMR ALLERGIES GMR(120.8, (e.g., 212;GMR(120.8,) NATIONAL DRUG PSNDF( DRUG PSDRUG( DRUG INGREDIENTS PS(50.416, VA DRUG CLASS PS(50.605, ROUTINE: ******************** 1472 NAME: XUTMOPT Option scheduling interface CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 23,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine holds several supported calls for access to the option scheduling file. ROUTINE: XUTMOPT COMPONENT: EDIT VARIABLES: option_nam Type: Input The name of the option from the option file that the user is to be allowed to edit. This entry point allows users to edit an option's scheduling in the OPTION SCHEDULING file (#19.2). Usage D EDIT^XUTMOPT(option_name) COMPONENT: DISP VARIABLES: option_nam Type: Input The name of the option from the option file that the taskman schedule is to be displayed. This entry point is used to display the schedule for an option. Usage D DISP^XUTMOPT(option_name) COMPONENT: RESCH VARIABLES: option_nam Type: Input Name of the option to be rescheduled. when_to_ru Type: Input (optional) The new scheduled time for the option to run. device_to_ Type: Input (optional) The device to use for the rescheduled option. re-schedul Type: Input (optional) The frequency to run the rescheduled option. flags Type: Input (optional) If the flag is set to an 'L' LAYGO a new entry if needed. error_arra Type: Both (optional) Pass by reference. Will be set to -1 if the option was not found. This entry point allows an application to set-up the schedule for an option. Usage D RESCH^XUTMOPT(option_name,when_to_run,device_to_use, re-schedule_freq,flags,error_array) COMPONENT: OPTSTAT VARIABLES: optionname Type: Input This is the name of the OPTION (.01 field of file 19) to return data on. ROOT Type: Both This variable is passed by reference and returns an array of data about the OPTION in question. Example: D OPTSTAT^XUTMOPT("OPTION NAME",.ROOT) Returns an array of data in ROOT (pass by ref) in the form. ROOT=count ROOT(1)=task number^scheduled time^reschedule freq^special queueing flag This is an array because the same task can be scheduled more that once. This entry point allows an application to find out when a option is scheduled and get other data. ******************** 1473 NAME: DBIA1473 CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: QUASAR USAGE: Private ENTERED: FEB 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Quality: Audiology and Speech Pathology Audit and Review (QUASAR), will make calls to AMIE routines EN1^DVBCTRN and EN2^DVBCTRN. This is done to acquire the soft link information, verify the availability of the soft link's request, and to download information to AMIE for the purpose of transmitting audiology C&P exam data. ROUTINE: DVBCTRN COMPONENT: EN1 VARIABLES: EN1^DVBCTRN receives parameters: #1 - Patient's DFN #2 - Name of exam needing softlink #3 - Softlink returns: Either new softlink or validity of existing softlink COMPONENT: EN2 VARIABLES: EN2^DVBCTRN receives parameters: #1 - Global or Local root of information to be loaded into AMIE #2 - Package name calling AMIE #3 - Softlink information #4 - Pointer to New Person file (indicating examining physician) #5 - Date the examination was performed (in FM format) returns: Indication of success/failure of download ******************** 1475 NAME: Global Read of S node in File 2 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: FEB 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The Adverse Reaction Tracking package requests permission to do a direct global read of the "S" nodes in the Patient file in order to get the STATUS field (#3) value for an APPOINTMENT (#1900) entry. ^DPT(D0,'S',D1,0) 3 STATUS 0;2 Direct Global Read & w ^DPT(D0,'S',0) 1900 APPOINTMENT Direct Global Read & w ROUTINE: ******************** 1476 NAME: DBIA1476 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: QUASAR OUTPATIENT PHARMACY On the Listman Patient Information screen in Outpatient Pharmacy, the Rated Disabilities along with Disability % and Service Connected indicator are displayed. This information is retrieved by looping through the .372 node (Rated Disabilities subfile #2.04) of the PATIENT File (#2). We then set a variable to the zero node, and get the data for fields #01, #2, and #3 from the variable for display. SCHEDULING USAGE: Controlled Subscri ENTERED: FEB 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Quality: Audiology and Speech Pathology Audit and Review (QUASAR) will reference the following fields from the PATIENT file. From node .372 of the PATIENT file (#2), fields .01, RATED DISABILITIES (VA), 2 DISABILITY %, and 3 SERVICE CONNECTED. From node .36 of the PATIENT file (#2), field .361 PRIMARY ELIGIBILITY CODE. ^DPT(D0,.36) .361 PRIMARY ELIGIBILITY .36;1 Direct Global Read & w ^DPT(D0,.372,D1,0) .01 RATED DISABILITIES ( 0;1 Direct Global Read & w 2 DISABILITY % 0;2 Direct Global Read & w 3 SERVICE CONNECTED 0;3 Direct Global Read & w ROUTINE: ******************** 1479 NAME: Delete PACKAGE file entry CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: MAR 1,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Allergy package is changing its name to ADVERSE REACTION TRACKING with version 4. The package's namespace is GMRA. Some sites have two entries in their PACKAGE file that have GMRA as the namespace. They are ALLERGY TRACKING SYSTEM and GEN. MED. REC. - ALLERGIES. The former is version 2.2 and the latter is version 3. Both are previous versions of the ADVERSE REACTION TRACKING package. The GEN. MED. REC. - ALLERGIES entry will be changed to ADVERSE REACTION TRACKING in the PACKAGE file (DBIA #1449). This DBIA allows the version 4 environment check routine to delete any other PACKAGE file entries that have the GMRA namespace. When the unwanted entry has a lower internal entry number in the PACKAGE file it confuses the $$VERSION^XPDUTL utility which looks at the namespace cross-reference. For example: W $$VERSION^XPDUTL("GMRA") can return the value 2.2 when it should return 4. ROUTINE: ******************** 1481 NAME: Check Out-Of-Service nodes on File 42 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: FEB 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File The Adverse Reaction Tracking package requests permission to do a direct global read of the "OOS" nodes (OUT-OF-SERVICE DATE) in the WARD LOCATION file (#42) in order to determine if a ward is out-of-service during a particular date/time range. ^DIC(42,D0,'OOS',D1,0) .06 IS ENTIRE WARD OUT O 0;6 Direct Global Read & w .04 RETURN TO SERVICE DA 0;4 Direct Global Read & w ^DIC(42,D0,'OOS','AINV',D1,D2) This global reference is for the AINV cross reference which is set by the OUT-OF-SERVICE DATE(S) field. In this global reference: D0 = ward location internal entry number (ien) D1 = inverse value of the date being checked D2 = the ien of the OUT-OF-SERVICE DATE(S) multiple ROUTINE: ******************** 1483 NAME: DBIA1483 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.8 ROOT: PRCD(420.8 DESCRIPTION: TYPE: File Engineering Package is given permission to point to File #420.8 SOURCE CODE. ^PRCD(420.8,D0,0) .01 CODE 0;1 Pointed to This is the code identifying the procurement source for goods. ROUTINE: ******************** 1484 NAME: DBIA1484 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.1 ROOT: PRCD(420.1 DESCRIPTION: TYPE: File The Engineering Package is given permission to point to File 420.1. (COST CENTER). ^PRCD(420.1,D0,0) .01 NAME 0;1 Pointed to This is the 6 digit cost center number, a space, and the cost center name. ROUTINE: ******************** 1485 NAME: DBIA1485 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 441.2 ROOT: PRC(441.2 DESCRIPTION: TYPE: File The Engineering Package is given permission to point to File 441.2. (FEDERAL SUPPLY CLASSIFICATION) ^PRC(441.2,D0,0) .01 NUMBER 0;1 Pointed to Four digit Federal Supply Classification number. ROUTINE: ******************** 1489 NAME: Look at File 100.21 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: FEB 14,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.5 FILE: 100.21 ROOT: OR(100.21, DESCRIPTION: TYPE: File The Adverse Reaction Tracking (ART) package requests permission to do direct global reads in the OE/RR TEAM FILE (#100.21) through version 2.5 of CPRS (OE/RR). The ART package sends bulletins to the team members associated with a patient. ^OR(100.21,D0,1,D1) Direct global read access to determine the existence of a team member entry. ^OR(100.21,D0,0) Direct global read access to determine the existence of a team entry. ^OR(100.21,'AB',D0,D1) Direct global read access of the AB cross reference to find the teams associated with a patient. ROUTINE: ******************** 1490 NAME: DEMOGRAPHIC REFERENCE FILE CUSTODIAL PACKAGE: SURVEY GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 22,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 748.2 ROOT: QA(748.2, DESCRIPTION: TYPE: File Nursing has permission to access the following field in the Demographic Reference File (748.2). ^QA(748.2,D0,0) .01 FILE NAME 0;1 Read w/Fileman Nursing has permission to Read this field with FileMan. Also, in a pre-init routine, Nursing has permission to LAYGO an entry into this file to set up the NURS Location (211.4) file entry. ROUTINE: ******************** 1491 NAME: SURVEY CUSTODIAL PACKAGE: SURVEY GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 16,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 748 ROOT: QA(748, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the Survey (748) file. ^QA(748,D0,0) .01 NAME 0;1 Read w/Fileman ^QA(748,D0,1,D1,0) 2 FILE 0;3 Read w/Fileman ROUTINE: ******************** 1492 NAME: SURVEY QUESTIONS CUSTODIAL PACKAGE: SURVEY GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 16,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 748.25 ROOT: QA(748.25, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the Survey Questions (748.25) file. ^QA(748.25,D0,1,D1,0) .01 QUESTION 0;1 Read w/Fileman .015 QUESTION NUMBER 0;2 Read w/Fileman .025 MULTIPLE CHOICE TYPE 0;3 Read w/Fileman .027 NUMBER OF GRADIENTS 0;4 Read w/Fileman 1 LEFT LIKERT LABEL 0;5 Read w/Fileman 2 RIGHT LIKERT LABEL 0;6 Read w/Fileman 3 LIKERT NUMBERIC DISP 0;7 Read w/Fileman .05 QUESTION TEXT 2;0 Read w/Fileman ^QA(748.25,D0,1,D1,3,D2,0) .01 ANSWER 0;1 Read w/Fileman ROUTINE: ******************** 1493 NAME: SURVEY RESPONSE DATA CUSTODIAL PACKAGE: SURVEY GENERATOR SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 16,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 748.3 ROOT: QA(748.3, DESCRIPTION: TYPE: File Nursing has permission to access the following fields in the Survey Response Data (748.3) file. ^QA(748.3,D0,0) 3 SURVEY COMPLETION ST 0;3 Read w/Fileman .01 SURVEY 0;1 Read w/Fileman ^QA(748.3,D0,1,D1,0) .01 QUESTION NUMBER 0;1 Read w/Fileman 1 ANSWER 0;2 Read w/Fileman 2 RESPONSE 1;0 Read w/Fileman Read with Fileman. ^QA(748.3,D0,2,D1,0) 1 RESPONSE DATA 0;2 Read w/Fileman ROUTINE: ******************** 1494 NAME: SENSITIVE PATIENT BULLETIN NAME CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: NETWORK HEALTH EXCHANGE ORDER ENTRY/RESULTS REPORTING IMAGING USAGE: Controlled Subscri ENTERED: FEB 21,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.1 FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File NETWORK HEALTH EXCHANGE (NHE) is requesting permission to access the following element in the MAS PARAMETERS file (^DG(43,). A direct global read will collect the pointer value for the mail group specified to receive sensitive patient accessed bulletins at the site and then look up the mail group name in ^XMB(3.8) in order to trigger a bulletin at the target site when patient data is requested from another NHE site for a Sensitive patient. ^DG(43,D0,NOT) 509 SENSITIVE REC ACCESS NOT;6 Direct Global Read & w ROUTINE: ******************** 1495 NAME: DBIA1495-A CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES LAB SERVICE USAGE: Controlled Subscri ENTERED: FEB 22,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 869.2 ROOT: HLCS(869.2, DESCRIPTION: TYPE: File Controlled Substances Version 3.0 needs write access to the HL LOWER LEVEL PROTOCOL PARAMETER file to allow a post-init to populate necessary parameters for an interface to narcotic dispensing equipment systems. ^HLCS(869.2,D0,0) .01 NAME 0;1 Write w/Fileman .02 LLP TYPE 0;2 Write w/Fileman ^HLCS(869.2,D0,200) 200.01 HLLP DEVICE 200;1 Write w/Fileman 200.08 PROTOCOL ID VERSION 200;8 Write w/Fileman ^HLCS(869.2,D0,300) 300.01 X3.28 DEVICE 300;1 Write w/Fileman ROUTINE: ******************** 1496 NAME: DBIA1495-B CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES LAB SERVICE SURGERY SCHEDULING OUTPATIENT PHARMACY Only uses Read w/Fileman on the .01 field. KERNEL CLINICAL PROCEDURES INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: FEB 22,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 870 ROOT: HLCS(870, DESCRIPTION: TYPE: File Write access permitted to the HL LOGICAL LINK file to allow installation to populate necessary fields to support interfaces. ^HLCS(870, .01 NODE 0;1 Write w/Fileman 2 LLP TYPE 0;3 Write w/Fileman 14 SHUTDOWN LLP ? 0;15 Write w/Fileman ROUTINE: ******************** 1497 NAME: DBIA1497 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.2 ROOT: PRCD(420.2 DESCRIPTION: TYPE: File The Engineering Package is given permission to point to File 420.2. (BUDGET OBJECT CODE). ^PRCD(420.2,D0,0) .01 NAME 0;1 Pointed to The budget object code, a space, and the budget object code name. ROUTINE: ******************** 1498 NAME: DBIA1498 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 440 ROOT: PRC(440 DESCRIPTION: TYPE: File The Engineering Package is given permission to point to File 440 (Vendor). ^PRC(440,D0,0) .01 NAME 0;1 Pointed to The vendor name. ROUTINE: ******************** 1499 NAME: DBIA1499 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 442 ROOT: PRC(442, DESCRIPTION: TYPE: File The Engineering package is given permission to read data from the following fields in file #442 (PROCUREMENT AND ACCOUNTING TRANSACTIONS) using FileMan utilities and to loop through the global nodes of the ITEM and BOC multiples to obtain the internal entry number of the multiple for use in FileMan calls. ^PRC(442,D0,0) .01 PURCHASE ORDER NUMBE 0;1 Read w/Fileman This is the purchase order number. 1 FCP 0;3 Read w/Fileman This is the valid Fund Control Point. 2 COST CENTER 0;5 Read w/Fileman This is the cost center. ^PRC(442,D0,1) .1 P.O. DATE 1;15 Read w/Fileman This is the purchase order date. 5 VENDOR 1;1 Read w/Fileman This is the name of the vendor. 5.2 REQUESTING SERVICE 1;2 Read w/Fileman This is the requesting service. 8 SOURCE CODE 1;7 Read w/Fileman This is the source code for this order. ^PRC(442,D0,23) 26 BBFY 23;2 Read w/Fileman This is the beginning budget fiscal year. ^PRC(442,D0,2,D1,0) .01 LINE ITEM NUMBER 0;1 Read w/Fileman This is the line item number. 3.5 BOC 0;4 Read w/Fileman This is the budget object code ofor the item. Part of Item (#40) multiple. ^PRC(442,D0,2,D1,2) 8 FEDERAL SUPPLY CLASS 2;3 Read w/Fileman This is the Federal Supply Classification for the item. Part of Item (#40) multiple. ^PRC(442,D0,22,D1,0) .01 SUBACCOUNT 0;1 Read w/Fileman This is a BOC for one or more LINE ITEM NUMBERs within this record. 1 SUBAMOUNT 0;2 Read w/Fileman This is the dollar amount reported to FMS for this BOC. part of BOC (#41) multiple. ROUTINE: ******************** 1500 NAME: Returns Accounting Data CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: FEB 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Engineering Package is given permission to call $$ACC^PRC0C. ROUTINE: PRC0C COMPONENT: $$ACC(A,B) VARIABLES: A Type: Input Station Number. B Type: Input Data (3 pieces delimited by ^) ^1=fund control point code ^2=(document) fiscal 2-digit year ^3=beginning budget fiscal year (4-digit) $$ACC Type: Output value (12 pieces delimited by ^) ^1=a/o code ^2=program ^3=fcp/prj code ^4=object class ^5=fund code ^6=bfy beginning ^7=bfy end ^8=fund trans allowed ^9=file 420.14 record id ^10=job ^11=fill-in-year(s) appropriation ^12=gross/net Returns accounting information for a station and fund control point. ******************** 1511 NAME: USE OF ICDONE CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: MAR 8,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Automated Information Collection System has the ability to print lists of terms based on the Clinical Lexicon on Encounter Forms. When the forms are scanned and data is passed the PCE, the ICD9 diagnosis code associated with the term is required to populate the Purpose of Visit. This agreement is to allow AICS to use the call ICDONE^GMPTU (and its successor) ICDONE^LEXU to determine the correct, or best ICD9 Diagnosis code associated with the selected term. Input variable is the pointer to the clinical lexicon entry in file 757.01. Output is the ICD9 code, or null if none is found. This will be coded in such a way as when Clinical Lexicon converts to the LEX namespace that no changes will be required. ROUTINE: GMPTU COMPONENT: ICDONE VARIABLES: INPUT Type: Input The input to this function is the pointer to the Clinical Lexicon file (757.01) as the only parameter. This value is retrieved for other call to the clinical lexicon. OUTPUT Type: Output The function returns the ICD9 Diagnosis most appropriate for the term, or null if none exisits. Returns the best ICD9 code to associate with a clinical lexicon entry. ******************** 1515 NAME: Set File Security for ART files CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING USAGE: Private ENTERED: MAR 12,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: File The Adverse Reaction Tracking (ART) package uses the KIDS utility to export the package software. ART exports the file level security codes for its data dictionaries. Currently, KIDS will not change the file level security codes on the target system if they already exist. This DBIA allows ART to check the file level security nodes on the package's data dictionaries and change the target system's file level security to match the ones being exported. They are: ^DIC(120.8,0,"AUDIT") = @ ^DIC(120.8,0,"DD") = @ ^DIC(120.8,0,"DEL") = @ ^DIC(120.8,0,"LAYGO") = @ ^DIC(120.8,0,"WR") = @ ^DIC(120.82,0,"AUDIT") = @ ^DIC(120.82,0,"DD") = @ ^DIC(120.82,0,"DEL") = @ ^DIC(120.83,0,"AUDIT") = @ ^DIC(120.83,0,"DD") = @ ^DIC(120.83,0,"DEL") = @ ^DIC(120.84,0,"AUDIT") = @ ^DIC(120.84,0,"DD") = @ ^DIC(120.84,0,"DEL") = @ ^DIC(120.84,0,"LAYGO") = @ ^DIC(120.84,0,"RD") = @ ^DIC(120.84,0,"WR") = @ ^DIC(120.85,0,"AUDIT") = @ ^DIC(120.85,0,"DD") = @ ^DIC(120.85,0,"DEL") = @ ^DIC(120.85,0,"LAYGO") = @ ^DIC(120.85,0,"WR") = @ ^DIC(120.86,0,"AUDIT") = @ ^DIC(120.86,0,"DD") = @ ^DIC(120.86,0,"DEL") = @ ^DIC(120.86,0,"LAYGO") = @ ^DIC(120.86,0,"RD") = @ ^DIC(120.86,0,"WR") = @ ^DIC(120.87,0,"AUDIT") = @ ^DIC(120.87,0,"DD") = @ ^DIC(120.87,0,"DEL") = @ ^DIC(120.87,0,"LAYGO") = @ ^DIC(120.87,0,"WR") = @ ^DIC( ROUTINE: ******************** 1516 NAME: Add SCD component CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: Spinal Cord Injury USAGE: Private ENTERED: MAR 19,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.7 FILE: ROOT: DESCRIPTION: TYPE: Routine Spinal Cord Dysfunction requests permission to add a new SCD component to the Health Summary Component (#142.1) file which presents SCD information while respecting Time and Occurrence limits. This component will be added by the SCD post-init as record number 74. The post-init also adds this component to the GMTS HS ADHOC OPTION Health Summary Type by calling the subroutine ENPOST^GMTSLOAD, installs the routine SPNHS1 as GMTSSCD (This is the driver/print routine for the component), and will installs SCD into PDX data segment file (refer to DBIA #1023). ROUTINE: GMTSLOAD COMPONENT: ENPOST VARIABLES: ******************** 1517 NAME: SCD API CUSTODIAL PACKAGE: SPINAL CORD DYSFUNCTION SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Supported ENTERED: MAR 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Permission to call the routine EN^SPNHS0(SPNDFN,SPNBEG,SPNEND,SPNMAX) to get Spinal Cord Dysfunction data. Parameter passing is being used for Input variables and data will be returned in ^TMP array. ROUTINE: SPNHS0 COMPONENT: EN VARIABLES: SPNDFN Type: Input Patient file pointer SPNBEG Type: Input Beginning date in internal fileman format SPNEND Type: Input Ending date in internal fileman format SPNMAX Type: Input Maximum number of occurrences (optional) TMP("SPN", Type: Output ^TMP("SPN",$J,154,0)= REGISTRATION STATUS^HIGHEST LEVEL OF INJURY^INFORMATION SOURCE FOR SCD ^COMPLETENESS OF INJURY^EXTENT OF PARALYSIS^PRIMARY CARE PROVIDER^SCI/SCD COORDINATOR ^TMP("SPN",$J,154,INVERSE ONSET DATE)= ONSET DATE (internal FM format)^ETIOLOGY^ONSET OF SCD CAUSED BY TRAUMA ^TMP("SPN",$J,154.1,INVERSE DATE RECORDED, IEN)= DATE RECORDED (internal FM format)^MOTOR SCORE^COGNITIVE SCORE^ TOTAL SCORE ^RECORD TYPE Type: API to allow retrieval of SCD data for a patient for a date range and set number of occurrences. ******************** 1519 NAME: XUTMDEVQ CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 29,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs allow you to run jobs directly or queue them, whether printing to a device or not, and enable varying degrees of user interaction. See the TaskMan: Developer Tools section of the Kernel Developer's Guide for further information. EN^XUTMDEVQ: Use this to allow the user to decide whether to run the job directly or queue it. The user may select the device and the start time. If a task is long-running, and has an output device, it will tie up the output device for the whole time. That's not desirable. We've created a way for you to split the job into two tasks: gather and print. The user may select the device and the start time. $$QQ^XUTMDEVQ(): Double Queue- This API creates the Gather and Print tasks. The gather task is scheduled to run, while the print task is not scheduled. The gather task collects data and stores it, perhaps in ^XTMP. When the gather task is finished, the gather task can schedule the print task. $$REQQ^XUTMDEVQ(): Schedule the Print task that was created by $$QQ^XUTMDEVQ. The print task prints the data that was stored by the gather task. This API should be invoked at the end of the Gather task to print the results. $$DEV^XUTMDEVQ(): Use this to force the user to queue a job. The user may select the device and start time. $$NODEV^XUTMDEVQ(): Use this to force the user to queue a job which doesn't need any device. The user may select the start time. ROUTINE: XUTMDEVQ COMPONENT: EN VARIABLES: ztrtn Type: Input ztdesc Type: Input ztsave Type: Input %zis Type: Input retztsk Type: Input ZTSK Type: Output EN^XUTMDEVQ(ztrtn, ztdesc, ztsave [, %zis] [, retztsk]) Input Parameters: ztrtn - The entry point EN^XUTMDEVQ will DO to start the job. Specify it as "LABEL^ROUTINE" or "^ROUTINE" or "ROUTINE" ztdesc - Task description, up to 200 characters describing the task, with the package name at the front. ztsave - This parameter is passed by reference. Set up this array in the same format as the ZTSAVE input array is set up for a ^%ZTLOAD TaskMan entry point. %zis - (optional) Pass by reference or value. Any parts of the %ZIS variable that is to be used in the ^%ZIS device call. retztsk - (optional) If the job is tasked, and you want to know the task number ZTSK, then set this parameter such that $G(retztsk). Output: ZTSK - (optional output) If $G(retztsk), and the job is tasked, ZTSK will hold the task number upon exit from this API. COMPONENT: $$QQ VARIABLES: $$QQ Type: Output %rtn1 Type: Input %desc1 Type: Input %var1 Type: Input %voth1 Type: Input %zis Type: Input iop Type: Input %wr Type: Input %rtn2 Type: Input %desc2 Type: Input %var2 Type: Input %voth2 Type: Input $$QQ^XUTMDEVQ(%rtn1 [, %desc1] [, %var1] [, %voth1] [, %zis] [, iop] [, %wr] %rtn2 [, %desc2] [, %var2] [, %voth2]) Double Queue- This API creates the Gather and Print tasks. The gather task is scheduled to run, while the print task is not scheduled. The gather task collects data and stores it, perhaps in ^XTMP. When the gather task is finished, the gather task must schedule the print task using $$REQQ^XUTMDEVQ. The ^XTMP location used in the gather task can be passed to the print task in a parameter in $$REQQ^XUTMDEVQ. Input Parameters: %rtn1 - (required) 1st task that TaskMan will run, usually a search-and-build-sorted-data type process. May be specified as "LABEL^ROUTINE" or "^ROUTINE" or "ROUTINE". %desc1 - (optional) Description (up to 200 chars) of 1st task. Default is %rtn1, with ~ substituted for ^. %var1 - (optional) ZTSAVE values for 1st task. Single value or passed by reference, this will be used to SET ZTSAVE(). It may be a string of variable names separated by ";". Each ;-piece will be used as a subscript in ZTSAVE. See the ^%ZTLOAD TaskMan API documentation for a description of the ZTSAVE variable. %voth1 - (optional) Other parameters for 1st task. Passed by reference, %voth1(sub)="" or explicit value sub - this is any other ^%ZTLOAD API variable besides ZTRTN, ZTDESC, ZTIO or ZTSAVE. For example, S %VOTH1("ZTDTH")=$H. %zis - (optional) Passed by reference, this is the standard %ZIS variable array for calling the Device Handler ^%ZIS. The 2nd task of the job will be tasked to this device. Exception: - If %D(%ZIS)=0 then the default value is "MQ", and call the Device Handler. - If $D(%ZIS)=1,%ZIS="" then queue the 2nd task also with ZTIO="" (i.e. Do not call the Device Handler.) iop - (optional) The IOP variable as defined in Kernel's Device Handler ^%ZIS. Default value is "Q". If IOP is passed, but does not include "Q", then "Q" is added. %wr - (optional) If %wr>0 then write text to the screen as to whether or not the queueing was successful. %rtn2 - (required) 2nd task that TaskMan will run, usually a print process. May be specified as "LABEL^ROUTINE" or "^ROUTINE" or "ROUTINE". %desc2 - (optional) Description (up to 200 chars) of 2nd task. Default is %rtn1, with ~ substituted for ^. %var2 - (optional) ZTSAVE values for 2nd task. Single value or passed by reference, this will be used to SET ZTSAVE(). It may be a string of variable names separated by ";". Each ;-piece will be used as a subscript in ZTSAVE. If %var2 is not passed, but %var1 is, then %var1 is merged into %var2 by default. %voth2 - (optional) Other parameters for 2nd task. Passed by reference, %voth2(sub)="" or explicit value sub - this is any other ^%ZTLOAD API variable besides ZTRTN, ZTDESC, ZTIO or ZTSAVE. However, if %voth2("ZTDTH")=$H, that setting is ignored, because the 2nd task is not scheduled. Output: If successful, Function returns ztsk1^ztsk2 (ZTSK values of the 1st and 2nd tasks. If unsuccessful, it returns -1. COMPONENT: $$REQQ VARIABLES: xutsk Type: Input xudth Type: Input %var Type: Input $$REQQ Type: Output $$REQQ^XUTMDEVQ(xutsk, xudth [,[.]%var]) Schedule the Print task that was created by $$QQ^XUTMDEVQ. The print task prints the data that was stored by the gather task. This API should be invoked at the end of the Gather (1st) task to print the results. Input Parameters: xutsk - (required) This is the task number of the 2nd task which was created by $$QQ^XUTMDEVQ, but not scheduled. The task number is found in the variable XUTMQQ. xudth - (required) This is the date/time to run the task. To start it right away, use $H. [.]%var - (optional) ZTSAVE values for 2nd task. Single value or passed by reference, this will be used to SET ZTSAVE(). It may be a string of variable names separated by ";". Each ;-piece will be used as a subscript in ZTSAVE. See the ^%ZTLOAD TaskMan API documentation for a description of the ZTSAVE variable. Use this parameter to pass the ^XTMP node location under which all the data from the gather task has been saved. Output: Function returns 1 if successful; 0 if not. COMPONENT: $$DEV VARIABLES: ztrtn Type: Input ztdesc Type: Input %var Type: Input %voth Type: Input %zis Type: Input iop Type: Input %wr Type: Input $$DEV Type: Output $$DEV^XUTMDEVQ(ztrtn [,ztdesc] [,%var] [,%voth] [,%zis] [,iop] [,%wr]) Use this to force the user to queue a job. The user may select the device and start time. Input Parameters: ztrtn - (required) Routine that TaskMan will run. May be specified as "LABEL^ROUTINE" or "^ROUTINE" or "ROUTINE". ztdesc - (optional) Task description (up to 200 chars). Default is ztrtn, with ~ substituted for ^. %var - (optional) ZTSAVE values for task. Single value or passed by reference, this will be used to SET ZTSAVE(). It may be a string of variable names separated by ";". Each ;-piece will be used as a subscript in ZTSAVE. See the ^%ZTLOAD TaskMan API documentation for a description of the ZTSAVE variable. %voth - (optional) Other parameters for task. Passed by reference, %voth1(sub)="" or explicit value sub - this is any other ^%ZTLOAD API variable besides ZTRTN, ZTDESC, ZTIO or ZTSAVE. For example, S %VOTH1("ZTDTH")=$H. %zis - (optional) Passed by reference, this is the standard %ZIS variable array for calling the Device Handler ^%ZIS. If it doesn't contain "Q", "Q" will be added to it. The default value is "MQ". iop - (optional) The IOP variable as defined in Kernel's Device Handler ^%ZIS. Default value is "Q". %wr - (optional) If %wr>0 then write text to the screen as to whether or not the queueing was successful. Output: Function returns 0 if run ztrtn without queueing; -1 if unsuccessful. COMPONENT: $$NODEV VARIABLES: ztrtn Type: Input ztdesc Type: Input %var Type: Input %voth Type: Input %wr Type: Input $$NODEV Type: Output $$NODEV^XUTMDEVQ(ztrtn [,ztdesc] [,%var] [,%voth] [,%wr]) Use this function to force the user to queue a job which doesn't need any device. The user may select the start time. Input Parameters: ztrtn - (required) Routine that TaskMan will run. May be specified as "LABEL^ROUTINE" or "^ROUTINE" or "ROUTINE". ztdesc - (optional) Task description (up to 200 chars). Default is ztrtn, with ~ substituted for ^. %var - (optional) ZTSAVE values for task. Single value or passed by reference, this will be used to SET ZTSAVE(). It may be a string of variable names separated by ";". Each ;-piece will be used as a subscript in ZTSAVE. See the ^%ZTLOAD TaskMan API documentation for a description of the ZTSAVE variable. %voth - (optional) Other parameters for task. Passed by reference, %voth1(sub)="" or explicit value sub - this is any other ^%ZTLOAD API variable besides ZTRTN, ZTDESC, ZTIO or ZTSAVE. For example, S %VOTH1("ZTDTH")=$H. %wr - (optional) If %wr>0 then write text to the screen as to whether or not the queueing was successful. Output: Function returns 1 if scheduling is successful; 0 if not. ******************** 1520 NAME: DBIA1520-A CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The NX Module (Equipment/Turn-In) requests permission to use IFCAP program PRCFSITE to set special IFCAP variables used in the package. ROUTINE: PRCFSITE COMPONENT: DIVFY VARIABLES: PRCF('X') Type: Input Set to "S" which defines which local values to return. PRC('FY') Type: Output Returns the current fiscal year. PRC('PARAM Type: Output Returns the zero node of the parameter file. PRC('PER') Type: Output Returns information about the user. PRC('QTR') Type: Output Returns the current fiscal quarter. PRC('SITE' Type: Output Returns the site/station number. Beginning of program PRCFSITE ******************** 1521 NAME: DBIA1520-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The NX module (Equipment/Turn-In) requests permission to reference program PRCSEB when creating 2237s. ROUTINE: PRCSEB COMPONENT: W61 VARIABLES: DUZ Type: Input Person creating the 2237 PRC('SITE' Type: Input The site/station number PRC('CP') Type: Input The control point DA Type: Input Internal number of the 2237. This portion of creating 2237 checks the fund control point and makes sure enough funds are there before approving the 2237. ******************** 1522 NAME: DBIA1520-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement will allow the NX (Equipment/Turn-In) module to call IFCAP routines from within a distributed input template, used to create 2237s. The calls will return fund control points and information pertaining to the fund control point used to create the 2237. ROUTINE: PRCSUT COMPONENT: EN VARIABLES: PRC('CP') Type: Output Returns the fund control point Retrieves site/station number, fiscal year, quarter and control point if not already set. COMPONENT: LOCK VARIABLES: DIC Type: Input Global reference DA Type: Input Record number Locks the global and record being referenced. ******************** 1523 NAME: DBIA1520-D CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement will allow the NX (Equipment/Turn-In) module to call the IFCAP transaction utility program when creating 2237s which will create the record in file 410 and process all checks on creating a 2237. ROUTINE: PRCSUT3 COMPONENT: EN1 VARIABLES: PRCS('TYPE Type: Input Type of 2237 (non-repetitive, etc.) X Type: Input The transaction number series (Station Number-Fiscal Year-Control Point). Used to get the next sequential number. This gets the 2237 transaction number. COMPONENT: EN2 VARIABLES: Adds the record to file 410. ******************** 1524 NAME: DBIA1520-E CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410 ROOT: PRCS(410, DESCRIPTION: TYPE: File The NX (Equipment/Turn-In) module requests permission to reference file 410 to create/edit 2237s which are the end product of this module. Includes addition of two templates to file 410, PRCN2237 and PRCN2237E. ^PRCS(410,D0 .01 TRANSACTION NUMBER 410 Both R/W w/Fileman 2237 Transaction number 1 TRANSACTION TYPE 410 Both R/W w/Fileman Transaction type is set to 'O' (obligation) for new 2237s. 2 TEMPORARY TRANSACTIO 410 Both R/W w/Fileman Temporary transaction number is the Equipment Request transaction number placed into 410. 3 FORM TYPE 410 Both R/W w/Fileman Form type generally for Equipment Request 2237s should be REPETITIVE AND NON-REP ORDER. 53 ORIGINATOR OF TEMP # 410 Write w/Fileman The REQUESTOR of the Equipment Request is placed in this field. 8 CLASSIFICATION OF RE 410 Both R/W w/Fileman If entered in the Equipment Request, it will be placed in this field. 49 SORT GROUP 410 Both R/W w/Fileman If entered in the Equipment Request, it will be placed in this field. 5 DATE OF REQUEST 410 Both R/W w/Fileman It will place 'TODAY' automatically when creating new 2237. 6.3 REQUESTING SERVICE 410 Both R/W w/Fileman This will be moved from the Equipment Request and placed in this field. 7 DATE REQUIRED 410 Both R/W w/Fileman It will be moved from the Equipment Request and placed in this field. 7.5 PRIORITY OF REQUEST 410 Both R/W w/Fileman Will be set to 'STANDARD' if new 2237. 9 SPECIAL REMARKS Both R/W w/Fileman Allows user to enter any special remarks when creating the 2237. 15 CONTROL POINT 410 Both R/W w/Fileman Control point is set after calls to program PRCSUT3. 28.5 BBFY 410 Write w/Fileman BBFY is set after calls to program PRCSUT3. 40 REQUESTOR 410 Both R/W w/Fileman Is set to the CMR Responsible Official from the Equipment Request. 15.5 COST CENTER 410 Both R/W w/Fileman Enter the appropriate cost center for the 2237. 56 REQUEST STATUS 410 Write w/Fileman Set the 2237 status as 'Pending Accountable Officer Signature' if 2237 passes all checks. 10 ITEM 410 Both R/W w/Fileman Line item information is moved from Equipment Request into 410 and includes the following sub-fields (since it is multiple): 1 DESCRIPTION 2 QUANTITY 3 UNIT OF PURCHASE 4 BOC 6 STOCK NUMBER 11 VENDOR 410 Both R/W w/Fileman Will pull over vendor from Equipment Request if exists. Includes the other vendor fields: 11.1 VENDOR ADDRESS1 11.2 VENDOR ADDRESS2 11.3 VENDOR ADDRESS3 11.4 VENDOR ADDRESS4 11.5 VENDOR CITY 11.6 VENDOR STATE 11.7 VENDOR ZIP CODE 11.8 VENDOR CONTACT 11.9 VENDOR PHONE NO. 13 VENDOR CONTRACT NUMBER Moves data from Equipment Request (file 413) into the 2237 (file 410) if creating a new 2237, otherwise allows user to edit already created 2237 (but only those 2237s created from the Equipment/Turn-In module). ROUTINE: ******************** 1525 NAME: DBIA1520-F CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: APR 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 440 ROOT: PRC(440, DESCRIPTION: TYPE: File This agreement requests permission for the NX (Equipment/Turn-In) module to point, with read access only, to the Vendor file (440). ^PRC(440,D0,0) .01 NAME 0;1 Pointed to This is the possible vendor that the requested line item could be purchased from. File 413 is the file that contains the non-expendable equipment requests. It is a front-end to the purchasing of equipment. ROUTINE: ******************** 1527 NAME: DBIA1527 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: APR 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Inpatient Medications would like to include the PSO INTERVENTION MENU andrelated options as a component. This would allow pharmacists to have thesame functionality for interventions in Inpatient Medications that existsin Outpatient Pharmacy. The options included on this menu are: PSO INTERVENTION NEW ENTRY PSO INTERVENTION EDIT PSO INTERVENTION PRINTOUT PSO INTERVENTION DELETE PSO INTERVENTION VIEW ROUTINE: ******************** 1528 NAME: Homeless Indicator CUSTODIAL PACKAGE: SOCIAL WORK SUBSCRIBING PACKAGE: SCHEDULING LAB SERVICE USAGE: Controlled Subscri ENTERED: APR 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement is in reference to an API to return homeless information on a patient. ROUTINE: SOWKHIRM COMPONENT: $$HOMELESS(DFN) VARIABLES: DFN Type: Input This is the Internal entry number for the patient in question. This is a function call that will return a value of 1 if the patient is homeless or zero in not. ******************** 1529 NAME: DBIA1529 CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES BAR CODE MED ADMIN Patch PSB*3.0*103 (with the project Existing Product Intake Program, (EPIP) needs to access the NURS LOCATION file (#211.4) to determine active Nursing wards with patients receiving care. USAGE: Private ENTERED: APR 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 211.4 ROOT: NURSF(211.4, DESCRIPTION: TYPE: File This agreement will allow Controlled Substances Version 3.0 to use VA Fileman read access to the NURS LOCATION FILE (#211.4). ^NURSF(211.4,D0,0) .01 NAME 0;1 Read w/Fileman ^NURSF(211.4,D0,3,D1,0) .01 MAS WARD 0;1 Read w/Fileman ROUTINE: ******************** 1530 NAME: VENDOR SCREEN CNH CUSTODIAL PACKAGE: FEE BASIS SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: APR 29,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 161.2 ROOT: FBAAV DESCRIPTION: TYPE: File PIMS would like to have a variable pointer to the FEE BASIS VENDOR file (#161.2) and a screen (DIC("S")) that will make only contract nursing home vendors a valid choice. Revisions are being made to the RUG-II software that will allow the entry of CNH patient assessments. Looking at the 9th piece of the zero node and the first piece of the "ADEL" node, would allow us to see if the vendor is a CNH and still active in Austin. The 9th piece of the zero node in the PART CODE (field #7). When this field equals 5, the vendor is a contract nursing home. The 1st piece of the "ADEL" node is AUSTIN DELETED. When this field is defined, set to yes, the vendor is no longer active in the eyes of Austin. ^$P(FBAAV(0),U,9) 7 PART CODE 0;9 Direct Global Read & w A DIC("S") screen that will look at the 9th piece of the zero node to see if it equals 5. Indicating a cnh vendor. ^$P(FBAAV('ADEL'),U) 9 AUSTIN DELETED ADEL;1 Direct Global Read & w A DIC("S") screen that will look at the 1st piece of the "ADEL" node to see if it not equal to "Y". Indicating not deleted from Austin's master record. ^FBAAV A variable pointer from PIMS file PAF (#45.9), field LOCATION (#70) with a DIC("S") screen that will only allow CNH vendors that have not been deleted by Austin. ROUTINE: ******************** 1531 NAME: DBIA1531 CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: MAY 1,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 727.815 ROOT: ECX(727.815, DESCRIPTION: TYPE: File Event Capture will export the EVENT CAPTURE LOCAL EXTRACT file (#727.815). The global root of this file is ^ECX(727.815,. Event Capture will not populate this file but the procedure data format will change with the release of Version 2.0. The DSS Extracts software routine ^ECXEC populates this file. ROUTINE: ******************** 1533 NAME: DBIA1533 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: MAY 7,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 725 ROOT: EC(725, DESCRIPTION: TYPE: File Event Capture requests to modify the "B" cross reference for the EC NATIONAL PROCEDURE file (#725) to be 63 characters rather than the standard 30 characters. As part of this agreement Event Capture will provide the following: 1. Add a description to the "B" cross reference indicating that it was modified and that ^DIC lookups into this file with DIC(0)["X" will not find exact matches greater than 30 characters in length. 2. Create a post-install routine that kills the "B" index of the file and then calls ENALL^DIK with DIK(1)=".01^B" to rebuild it. ROUTINE: ******************** 1534 NAME: NURS CARE PLAN CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: GEN. MED. REC. - GENERATOR USAGE: Private ENTERED: MAY 14,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3 FILE: 216.8 ROOT: NURSC(216.8, DESCRIPTION: TYPE: File The Text Generator V3 has permission to delete entries in the NURS Care Plan (216.8) file. ^NURSC(216.8,D0,0 Text Generator can delete entries in the NURS Care Plan (216.8) file using FileMan ^DIK. ROUTINE: ******************** 1535 NAME: 'DEL' node modification CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: MAY 17,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.7 FILE: 0 ROOT: DD(142.1,.01,'DEL', DESCRIPTION: TYPE: File The health summary package needs permission to change the "DEL" node in the DD structure for file 142.1. This will be done with the SET command and will be done with patch 7. Here is the code to reset the "DEL" node: S ^DD(142.1,.01,"DEL",1,0)="I $S(+$G(DUZ(2))'>0:1,DUZ(2)=5000:0,(DA'<100 001)&(DA'>9999999):0,1:1) N GMZ S GMZ=$S(+$G(DUZ(2)):""ONLY Components Created a t your site can be deleted"",1:""DUZ(2) MUST equal your DIVISION"") D EN^DDIOL(GMZ)" S ^DD(142.1,.01,"DEL",2,0)="I '$D(GMCMP) D EN^DDIOL(""You may only delet e COMPONENTS using the GMTS IRM/ADPAC COMP EDIT option."","""",""!!"")" ROUTINE: ******************** 1540 NAME: Setting ID entries CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: JUN 13,1996 STATUS: Active EXPIRES: SEP 1998 DURATION: Next Version VERSION: 5 FILE: 0 ROOT: DD(440 DESCRIPTION: TYPE: File Since KIDS cannot presently support changing the ID entries for a file without also shipping all fields in the file, IFCAP wants to send a post-INIT to remove the old ID nodes and set a new ID node. This will change the ID display to alow 5 different entries (vendors) to be seen on a 24 line display without any entries scrolling off the top. This change will be used in patch PRC*5*69 only. ROUTINE: ******************** 1541 NAME: DBIA1541 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING This DBIA was initially created for the ACRP Interface Toolkit (AIT) to allow retrieval and modification of specific PCE data. The AIT was initially distributed in patch SD*5.3*131. LAB SERVICE TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: FEB 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement permits read access to procedure, diagnosis and provider information associated with a visit using API tags in routine PXAPIOE. Using appropriate API tags, this DBIA also allows the following: 1) Setting of the PERSON CLASS (#.06) field of the V PROVIDER (#9000010.06) file 2) Setting the PRIMARY/SECONDARY (#.12) field in the V POV (#9000010.07) file to 'primary' ROUTINE: PXAPIOE COMPONENT: GETDX VARIABLES: List of diagnoses associated with a visit. COMPONENT: $$CPT VARIABLES: Boolean indicating whether at least one procedure is associated with a visit. COMPONENT: GETCPT VARIABLES: List of procedures associated with a visit. Returns the "0" nodes of the corresponding VCPT entries. New development should use the CPTARR component instead (see below). COMPONENT: $$PRV VARIABLES: Boolean indicating whether at least one provider is associated with a visit. COMPONENT: GETPRV VARIABLES: List of providers associated with a visit. The "zero" node of each V PROVIDER entry is returned. COMPONENT: $$DX VARIABLES: Boolean indicating whether at least one diagnosis is associated with a visit. COMPONENT: $$VALVST VARIABLES: Boolean that validates whether a visit exits for a passed internal entry number. COMPONENT: PDX VARIABLES: Flag the diagnosis as 'primary' for a V POV entry. COMPONENT: PLASS VARIABLES: Set the provider class for a V PROVIDER entry. COMPONENT: CPTARR VARIABLES: List of procedures associated with a visit. For each of the corresponding V CPT entries, a sub-tree is returned that corresponds to the V CPT file's DD structure. ******************** 1543 NAME: CHECK FOR DI*21*17 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUN 18,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: SD*5.3*41 FILE: ROOT: DESCRIPTION: TYPE: Routine The Scheduling Developers would like the following one-time integration agreement with the FileMan Developers: For PCMM (SD*5.3*41), as part of the installation environment checker, SCMCENV, we check the second line of the following routine using $TEXT: ^DICA This is the part of VA FileMan's Updater engine. Patch #17 of Version 21.0 was specifically listed as necessary for proper functioning of the RPC Broker (which PCMM depends on). As such, we require that either: o The package version is 22 or higher o The package version is 21 and DICA has patch #17 indicated in its second line. ROUTINE: DICA ******************** 1544 NAME: USRLM CALLS CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: SCHEDULING MAILMAN ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES Added 12/20/2007 VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: JUN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Scheduling Developers would like the following on-going integration agreement with the Authorization/Subscription Developers: Use of the following USRLM calls: $$ISA(USER,CLASS,ERR) - Boolean - Is USER a Member of CLASS? $$SUBCLASS(DA,CLASS) - Evaluate whether a given USER CLASS is a DESCENDENT of another class $$CLNAME(CLASS) - Given a class, return the Display Name $$WHOIS2(MEMBER,CLASS)- Given a Class, return list of CURRENT members Parameters: USER - Pointer to File #200 CLASS - Pointer to File #8930 DA - Pointer to File #8930 ERR - [Optional] Error Variable to contain error message MEMBER is name of array (local or global) in which members are returned in alphabetical order by name - indexed by number i.e. @MEMBER@(1 ...n) @member@(0) = ien of8930^usr class name^count of members @member@(1..n)= 1 2 3 4 5 6 7 8 p200^p8930.3^classname^effectdate^inactdate^username^title^mailcode Note: For pieces 2,4 & 5 - Only one of potentially many is returned These calls are part of the User Class Membership functions that PCMM uses for sites that choose to use the user class functionality. ROUTINE: USRLM COMPONENT: $$ISA VARIABLES: COMPONENT: $$SUBCLASS VARIABLES: DA Type: Input CLASS Type: Input COMPONENT: $$CLNAME VARIABLES: CLASS Type: Input COMPONENT: $$WHOIS2 VARIABLES: MEMBER Type: Output CLASS Type: Input COMPONENT: $$ISA VARIABLES: USER Type: Input CLASS Type: Input ERR Type: Output ******************** 1546 NAME: READ OF USR(8930.3 CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUN 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.3 ROOT: USR(8930.3, DESCRIPTION: TYPE: File The Scheduling Developers would like the following on-going integration agreement with the Authorization/Subscription Developers: Read access to the following global: ^USR(8930.3 (The USR CLASS MEMBERSHIP File (#8930.3) We do the following operations: o $DATA check of ^USR(8930.3,"B",Y) as a screen for the PRACTITIONER Field (#.03) of the POSITION ASSIGNMENT HISTORY File (#404.52). o $DATA check of ^USR(8930.3) as part of our post-init routine, SCMCPST, which sets the USE USER CLASS FUNCTIONALITY Field (#801) to 'YES', if this global exists (and other conditions are true). ^USR(8930.3 ^USR(8930.3,'B',Y ROUTINE: ******************** 1549 NAME: DBIA1548-B CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: JUN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 411 ROOT: PRC(411, DESCRIPTION: TYPE: File The Equipment/Turn-In Request package would like access to IFCAP's file ADMIN. ACITIVITY SITE PARAMETER (#411) to identify a station for requests and 2237s. ^PRC(411,DA,0) .01 STATION NUMBER 0;1 Pointed to The valid station number identifying the primary station as well as substations for integrated systems. ROUTINE: ******************** 1550 NAME: DBIA1548-C CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: JUN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410.2 ROOT: PRCS(410.2 DESCRIPTION: TYPE: File A CLASSIFICATION OF REQUEST may be assigned to a 2237. The Equipment/Turn-In Request package would like to be able to assign this field early in the request package and transfer it to the 2237. ^PRCS(410.2,DA,0) .01 NAME 0;1 Pointed to Identifies the type of request. ROUTINE: ******************** 1551 NAME: DBIA1548-D CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: JUN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410.7 ROOT: PRCS(410.7 DESCRIPTION: TYPE: File The SORT GROUP file (#410.7) is used as a sorting mechanism of requests to categorize their particular cost distribution for 2237s. The Equipment/Turn-In Request package would like to prompt for this information early in the request and then pass it on to the 2237. ^PRCS(410.7,DA,0) .01 NAME 0;1 Pointed to Definition in file is that this is the name of the sub-control point. ROUTINE: ******************** 1552 NAME: DBIA1548-E CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: JUN 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Equipment/Turn-In Request package would like permission to use PRCUSESIG to check for the electronic signature code. ROUTINE: PRCUESIG COMPONENT: ESIG VARIABLES: DUZ Type: Input The user who is entering their electronic signature FAIL Type: Output The status returned on whether signature entered correctly or not. Asks user for electronic signature code ******************** 1553 NAME: DBIA1553 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUN 24,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This request is to allow Integrated Billing to hard-set an identifier node in the Procedures (#304) sub-file of the Bill/Claims (#399) file. File #399 is a very large file which we would prefer not to distribute just to update the modifier of one of its sub-files. The post-init to patch IB*2*62 will set this identifier. The following code will be executed: S ^DD(399.0304,0,"ID","WRITE")="D DISPID^IBCSC4D" ROUTINE: ******************** 1554 NAME: DBIA1554 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: INTEGRATED BILLING CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: JUN 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A call is made to POV^PXAPIIB to retrieve all diagnosis (Purpose of Visit) for a visit so they can be added to a claim. ROUTINE: PXAPIIB COMPONENT: POV(VISIT,ARRAY) VARIABLES: VISIT Type: Input Pointer to Visit file (9000010) entry of the visit the diagnosis is being requested for. ARRAY Type: Input A pass by reference variable name of the array that should contain all diagnosis for the visit on exit. I Type: Output Internal entry number of the diagnosis in the V POV file (9000010.07). string Type: Output The 0 node of the V POV file (9000010.07) entry for the diagnosis. Returns an array with a string of information on each diagnosis (POV) found for the requested visit. Output is passed in ARRAY(I)=string. ******************** 1555 NAME: PCMM Needs DBIA For .01 Field Pointing to File #200 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUN 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200 DESCRIPTION: TYPE: File The SCHEDULING USER PREFERENCE File (#403.35) has a .01 field (SCHEDULING USER) that points to and is DINUMed to the NEW PERSON File (#200). .01 fields are specifically excluded from the normal permission for fields to point to File #200. ROUTINE: ******************** 1556 NAME: SCHEDULING REPORTS Field Points to File #1 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File The Scheduling Developers would like the following integration agreement with the FileMan Developers: With PCMM (SD*5.3*41), in the SCHEDULING REPORT File (#404.92), in the FILES multiple (#40), there is a FILE field (#.01) which points to the FILE file. This field contains the name of the file from which selections are made. ROUTINE: ******************** 1557 NAME: E-SIG API'S CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is the list of supported references to the E-SIG facility. ROUTINE: XUSESIG1 COMPONENT: CHKSUM VARIABLES: name_value Type: Input This is a global root as would be returned from $NAME. flag Type: Input Not used at this time. $$CHKSUM^XUSESIG1($name_value,flag) This would take a root ($name_value) and build a checksum for all data in the root. (Not used now, flag would be used when there is more that one checksum algorithm.) COMPONENT: ESBLOCK VARIABLES: ien Type: Input Optional. The default is to use the DUZ of the current user. This is the IEN of the new person file entry to return data for. $$ESBLOCK^XUSESIG1(ien) This extrinsic function would return the set of fields from the new person file that are need as part of the hash for a acceptable E-Sig. If IEN is not passed in then DUZ is used. (E-Sig block, E-Sig title, Degree, Current Date/Time) COMPONENT: EN VARIABLES: checksum Type: Input A number that will reveil if the data in the root has been changed. esblock Type: Input Optional. This should be the data returned from the $$ESBLOCK^XUSESIG1 call. $$EN^XUSESIG1(checksum,esblock) If the ESBLOCK is not passed then the function would get the ESBLOCK. In either case it would encode the ESBLOCK using the checksum as the KEY. Return a encoded string. COMPONENT: CMP VARIABLES: checksum Type: Input The output from the $$CHKSUM^XUSESIG1 call. name_value Type: Input This is a global root as would be returned from $NAME. $$CMP^XUSESIG1(checksum,$name_value) The extrinsic function would compare the checksum passed in to the calculated value from the $NAME_VALUE. Return 1 for match, 0 for no match. COMPONENT: DE VARIABLES: checksum Type: Input The output from the $$CHKSUM^XUSESIG1 call. encoded_st Type: Input The output from the $$EN^XUSESIG1 call. $$DE^XUSESIG1(checksum,encoded_string) This extrinsic function would decode the string using the checksum as the key. Return a decoded string. ******************** 1558 NAME: A&SP Clinic Visit File CUSTODIAL PACKAGE: QUASAR SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SPINAL CORD DYSFUNCTION USAGE: Controlled Subscri ENTERED: JUL 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 509850.6 ROOT: ACK(509850.6, DESCRIPTION: TYPE: File DSS Extracts will reference QUASAR data from the A&SP CLINIC VISIT file (#509850.6). ^ACK(509850.6,D0,0) .01 DATE 0;1 Direct Global Read & w 1 PATIENT NAME 0;2 Direct Global Read & w 2.6 CLINIC LOCATION 0;6 Direct Global Read & w ^ACK(509850.6,D0,2) 4 CLINIC STOP CODE 2;1 Direct Global Read & w .27 LEAD ROLE 2;7 Direct Global Read & w ^ACK(509850.6,D0,3,D1,0) .01 PROCEDURE CODE 0;1 Direct Global Read & w .03 VOLUME 0;3 Direct Global Read & w PROCEDURE CODE sub-file (#509850.61). ^ACK(509850.6,D0,1,D1,0) .01 DIAGNOSTIC CODE 0;1 Direct Global Read & w ^ACK(509850.6,D0,3,D1,1,D2,0) .04 CPT MODIFIER 0;1 Direct Global Read & w ^ACK(509850.6,C,DFN,DO) ROUTINE: ******************** 1559 NAME: DBIA1559 CUSTODIAL PACKAGE: QUASAR SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: JUL 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 509850.8 ROOT: ACK(509850.8, DESCRIPTION: TYPE: File DSS Extracts will reference QUASAR data from the A&SP SITE PARAMETER file (#509850.8). ^ACK(509850.8, 727.8251 AUDIOLOGY DSS UNIT L DSS;1 Direct Global Read & w 727.8252 SPEECH PATHOLOGY DSS DSS;2 Direct Global Read & w .01 SITE NAME 0;1 Direct Global Read & w ^ACK(509850.8,D0,2,D1,2, .01 PROCEDURE CODE YEAR 0;1 Direct Global Read & w 2 USE EVENT CAPTURE CO 0;2 Direct Global Read & w ROUTINE: ******************** 1560 NAME: DBIA1560 CUSTODIAL PACKAGE: QUASAR SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: JUL 17,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 509850.4 ROOT: ACK(509850.4, DESCRIPTION: TYPE: File DSS Extracts will reference QUASAR data from the A&SP PROCEDURE CODE file (#509850.4). ^ACK(509850.4,D0,0) .01 CODE 0;1 Direct Global Read & w ROUTINE: ******************** 1561 NAME: DSS UNIT file 724 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX QUASAR USAGE: Private ENTERED: JUL 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 724 ROOT: ECD( DESCRIPTION: TYPE: File DSS Extracts and QUASAR will reference Event Capture data from the DSS UNIT file (#724). ^ECD(D0,0) .01 NAME 0;1 Direct Global Read & w 2 MEDICAL SPECIALTY 0;3 Direct Global Read & w 3 COST CENTER 0;4 Direct Global Read & w 4 UNIT NUMBER 0;5 Direct Global Read & w This field contains a number that is used locally to identify and classify DSS units. This file contains all DSS units defined for use in the Event Capture software. Entries cannot be deleted but may be inactivated using the Event Capture software. The fields representing service, medical specialty and cost center are required for each DSS unit. These fields can be edited using options on the Event Capture Management Menu but cannot be deleted. This file should NOT be modified directly using VA FileMan. The Event Capture Management Menu provides the options necessary to create, edit, and inactivate all DSS units. ROUTINE: ******************** 1563 NAME: DBIA1563 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.8 ROOT: XMB(3.8, DESCRIPTION: TYPE: File As part of the installation process, the Ambulatory Care Reporting Project is granted permission to add 'XXX@Q-ACS.MED.VA.GOV' to the REMOTE MEMBER multiple (#12) of the 'SCDX AMBCARE TO NPCDB' entry in the MAIL GROUP file (#3.8). ^XMB(3.8,D0,6,D1,0) 12 MEMBERS - REMOTE 6;0 Write w/Fileman ROUTINE: ******************** 1564 NAME: DBIA1564 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.6 ROOT: XMB(3.6, DESCRIPTION: TYPE: File As part of the installation process, the Ambulatory Care Reporting Project is granted permission to add the mail group contained in the OPC GENERATE MAIL GROUP field (#216) of the MAS PARAMETER file (#43) to the MAIL GROUP multiple (#4) of the 'SCDX AMBCARE TO NPCDB SUMMARY' entry in the BULLETIN file (#3.6). ^XMB(3.6,D0,2,D1,0) 4 MAIL GROUP 2;0 Write w/Fileman ROUTINE: ******************** 1565 NAME: DBIA1565 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 779.001 ROOT: HL(779.001, DESCRIPTION: TYPE: File As part of the installation process, the Ambulatory Care Reporting Project is granted permission to create the following entry in the HL7 EVENT TYPE CODE file (#779.001) CODE (#.01): Z00 DESCRIPTION (#2): Ambulatory Care transmission to/from NPCDB VERSION (#100): 2.2 ^HL(779.001,D0,0) .01 CODE 0;1 Write w/Fileman 2 DESCRIPTION 0;2 Write w/Fileman ^HL(779.001,D0,1,D1,0) 100 VERSION 1;0 Write w/Fileman ROUTINE: ******************** 1566 NAME: DBIA1566 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 869.2 ROOT: HLCS(869.2, DESCRIPTION: TYPE: File As part of the installation process, the Ambulatory Care Reporting Project is granted permission to create the following entry in the HL LOWER LEVEL PROTOCOL PARAMETER file (#869.2) NAME (#.01): AMB-CARE LLP TYPE (#.02): MAILMAN MAIL GROUP (#100): SCDX AMBCARE TO NPCDB ^HLCS(869.2,D0,0) .01 NAME 0;1 Write w/Fileman .02 LLP TYPE 0;2 Write w/Fileman ^HLCS(869.2,D0,100) 100 MAIL GROUP 100;1 Write w/Fileman ROUTINE: ******************** 1568 NAME: Set File Security for Medicine Files CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: JUL 30,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File The Medicine package uses the KIDS utility to export the package software. Medicine exports file level security codes for its data dictionaries. Currently, KIDS will not change the file level security codes on the target system if they already exist. This DBIA allows Medicine to check the file level security nodes on the package's data dictionaries and change the target system's file level security to match the ones being exported. The nodes changed are: ^DIC(File,0,"DD")="@" and ^DIC(File,0,"AUDIT")="@" Where 'File' has the following values: 690 690.1 690.2 690.5 690.97 690.99 691 691.1 691.5 691.6 691.7 691.8 691.9 692 693 693.2 693.3 693.5 693.6 694 694.1 694.5 694.8 695 695.1 695.3 695.4 695.5 695.6 695.8 695.9 696 696.1 696.2 696.3 696.4 696.5 696.7 696.9 697 697.1 697.2 697.3 697.5 698 698.1 698.2 698.3 698.4 698.6 698.9 699 699.48 699.5 699.55 699.57 699.6 699.7 699.81 699.82 699.83 699.84 699.85 699.86 699.88 700 700.1 700.2 700.5 701 ROUTINE: ******************** 1569 NAME: TEXT INTEGRATION UTILITIES CUSTODIAL PACKAGE: LIST MANAGER SUBSCRIBING PACKAGE: USAGE: Private ENTERED: AUG 1,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine TIU is using List Manager. For one of our LM displays, we need to display at the beginning of the screen a 60 character name, then 4 or 5 short fields, then a different 60 character name. Sites don't want either 60 character name truncated. Since the screen is only 80 characters wide, we need to set one scroll lock long enough to display a meaningful part of the name and still show our short fields, and then to set a second, very short scroll lock so we can display the whole second 60 character name with enough scroll locked to identify the entry. I have found that if I set VALM("FIXED") and VALMLFT, I can essentially set two different scroll locks, enabling me to display both 60 character names meaningfully. This also enables me to code a PRINT LIST Action which prints columns beyond page width on a separate page rather than wrapping them. Since we are using many columns beyond 80 characters, this is important to our users. For the sake of clarity, this was NOT a simple matter of setting those two variables: I also had to rewrite for TIU the Scroll Right/Left actions and the Print List Action rather than use the actions LM exports. TIU requests a private Integration Agreement with List Manager to read and set the variables VALMLFT and VALM("FIXED"). We understand that if/when LM adds functionality affecting these variables, we would need to rewrite portions of our code. ROUTINE: VALM COMPONENT: EN VARIABLES: VALM Type: Both This agreement is for the subscripted variable VALM("FIXED"). VALM("FIXED") is the next column to the right AFTER the columns occupied by the Caption field which is scroll locked. It functions as the rightmost column of screen which remains fixed when a user scrolls to the right. VALMLFT Type: Both For a given horizontal scroll setting, VALMLFT is the character position in the List Manager list array string of the character displayed in the leftmost nonfixed column of the screen. EN^VALM is the main entry point for List Manager, called with the name of a List Manager Template. ******************** 1571 NAME: LEXICON UTILITY EXPRESSIONS CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 7,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 757.01 ROOT: LEX(757.01, DESCRIPTION: TYPE: File The Lexicon Utility (version 2.0 and greater) will maintain static internal entry numbers (IENs) for the Expression file (#757.01). As a result, this file may be pointed to to retrieve the Display Text (.01) for both current Expressions and deactivated Expressions (Deactivation Flag 757.01;9 1;5 set to 1). This agreement is a follow-on to DBIA 457 (version 1.0) and is re-issued to include the package name, namespace and global root changes occurring in version 2.0. This is not an amendment to 457. Version 1.0 Version 2.0 Package name Clinical Lexicon Utility Lexicon Utility Namespace GMPT LEX Expression File Global Root ^GMP(757.01, ^LEX(757.01, ^LEX(757.01,D0,0) .01 Display Text 0;1 Direct Global Read & w This Display Text contained in the Lexicon Utility is the text which will be used in all display/print routines. ROUTINE: ******************** 1573 NAME: LEXU CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 7,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine LEXU is a utility routine for the Lexicon Utility which contains functions useful in retrieving classification code(s) for a term. This agreement is a follow-on to DBIA 10148 (version 1.0) and is re-issued to include the package name, namespace, routine name and global root changes occurring in version 2.0. This is not an amendment to 10148. ROUTINE: LEXU COMPONENT: $$ICDONE(IEN,DATE) VARIABLES: IEN Type: Input Internal Entry Number in the Expression file ^LEX(757.01). DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Returns either a single active ICD-9 code linked to the Lexicon expression or Null if no ICD-9 code is found. COMPONENT: $$ICD(IEN,DATE) VARIABLES: IEN Type: Input Internal Entry Number in the Expression file ^LEX(757.01). DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Returns either a string of active ICD-9 codes linked to an expression (separated by semicolon, i.e., ICD;ICD;ICD) or Null if no ICD-9 codes are found. COMPONENT: $$CPTONE(IEN,DATE) VARIABLES: IEN Type: Input Internal Entry Number in the Expression file ^LEX(757.01). DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Returns either a single active CPT-4 code linked to the Lexicon expression or Null if no CPT-4 code is found. COMPONENT: $$DSMONE(IEN) VARIABLES: IEN Type: Input Internal Entry Number in the Expression file ^LEX(757.01). Returns either a single DSM-IV code linked to the Lexicon expression or Null if no DSM-IV code is found. COMPONENT: $$CPCONE(IEN,DATE) VARIABLES: IEN Type: Input Internal Entry Number in the Expressions file ^LEX(757.01). DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Returns either a single active HCPCS code linked to the Lexicon expression or Null if no HCPCS codes exist. HCPCS stands for Healthcare Financing Administration (HCFA) Common Procedure Coding System. ******************** 1574 NAME: DBIA1574 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Controlled Subscri ENTERED: AUG 7,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43 DESCRIPTION: TYPE: File AICS is requesting direct global access to the following fields within file 43 (MAS Parameters): 48 DEFAULT EF PRINTER 0;48 <-- Read 11 MULTIDIVISION MEDICAL CENTER "GL";2 <-- Read During the Registration process, an Encounter Form may be printed. It is necessary to determine if the site has defined a default EF printer to print the EF on. Access to piece 48 of the 0th node would allow this. Additionally, throughout the AICS package, it is necessary to determine if the facility is Multidivisional. Access to the 2nd piece of the GL node would provide us with this information. ^DG(43,D0,0) 48 DEFAULT EF PRINTER 0;48 Read w/Fileman Printer to be used when printing Encounter Forms from the Registration process. ^DG(43,D0,GL) 11 MULTIDIVISION MED CE GL;2 Read w/Fileman Field indicates whether the Medical Center is multidivisional. ROUTINE: ******************** 1575 NAME: AMBCARE DATE CALLS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER LAB SERVICE REGISTRATION USAGE: Private ENTERED: AUG 7,1996 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The calls in this agreement are to be used in conjunction with the installation and running of the Ambulatory Care Report Project Patch SD*53*44. ROUTINE: SCDXUTL COMPONENT: $$DATE() VARIABLES: date Type: Input This is a date that is to be compared to the 10/1 date. If the input date is before the 10/1 date than a zero will be returned. This indicates that the old limitation structure should be used. If the input date is after the 10/1 date than a one will be returned. This indicates that the new limitation structure should be used. This function call accepts a date and will return whether the new or old Scheduling visit file limitations are to be used. Based upon a date input returns whether this date is older than the date in the corresponding parameter. COMPONENT: $$FMDATE() VARIABLES: DATE Type: Output This function call accepts no inputs. It will return the date the new limitation structure is to take place in a FM format. This function returns the date at which the new limitation structure is to take place. COMPONENT: $$CLOSEFM() VARIABLES: This entry point accepts no inputs. It will return what the close out date is in FM format. COMPONENT: $$CLOSED() VARIABLES: DATE Type: Input This is a date to be compared to the close out date. It is in FM formatt. CLOSED(DATE) This entry point accepts a date in FM format to compare to the close out date. It will return a 1 if the close out period is over or a zero if close out can still occur. COMPONENT: $$INPATENC(PTR,PTR2) VARIABLES: PTR Type: Input This is a pointer (internal entry number) from one of the following files:- - TRANSMITTED OUTPATIENT ENCOUNTER file (#409.73) - OUTPATIENT ENCOUNTER file (#409.68) - DELETED OUTPATIENT ENCOUNTER file (#409.74) PTR2 Type: Input This value denotes the file being pointed to - 0 - TRANSMITTED OUTPATIENT ENCOUNTER file (Default) 1 - OUTPATIENT ENCOUNTER file 2 - DELETED OUTPATIENT ENCOUNTER file $$INPATENC Type: Output 1 - Encounter is an inpatient appointment. 0 - Encounter is not an inpatient appointment A value of 0 is returned if a valid pointer is not passed or the entry in the TRANSMITTED OUTPATIENT ENCOUNTER file does not point to a valid entry in the OUTPATIENT ENCOUNTER file or DELETED OUTPATIENT ENCOUNTER file. This function call will determine whether an outpatient encounter is for an inpatient appointment. ******************** 1579 NAME: SCHEDULING CLASSIFICATION CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS PCE PATIENT CARE ENCOUNTER EVENT CAPTURE OUTPATIENT PHARMACY REGISTRATION ADDED 3/19/09 USAGE: Controlled Subscri ENTERED: JUN 30,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA is for the purpose of calling into routine ^SDCO22 to ask the classification questions such as Service Connected, Agent Orange, Ionizing Radiation and Environmental Contaminants. ROUTINE: SDCO22 COMPONENT: AO VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Agent Orange Exposure Classification COMPONENT: EC VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Environmental Contaminant Exposure Classification COMPONENT: IR VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Ionizing Radiation Exposure Classification COMPONENT: SC VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Service Connected Condition Classification COMPONENT: MST VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Military Sexual Trauma Classification COMPONENT: HNC VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Head and Neck Classification COMPONENT: CV VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) SDDT Type: Input Date (optional - SDOE overrides) Ask Combat Veteran Classification COMPONENT: SHAD VARIABLES: DFN Type: Input Patient file IEN Ask Project 112/SHAD Classification COMPONENT: CLV VARIABLES: DFN Type: Input Patient file IEN SDOE Type: Input Outpatient Encounter file IEN (optional) Ask Camp Lejeune Classification ******************** 1585 NAME: PRINT MGR CLINIC SETUP CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS AICS requires the ability to retrieve the current print manager clinic setup to determine encounter forms defined for a clinic. USAGE: Controlled Subscri ENTERED: AUG 8,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.95 ROOT: SD(409.95, DESCRIPTION: TYPE: File The purpose of this IA is to retrieve the current print manager clinic setup. ^SD(409.95, ROUTINE: ******************** 1587 NAME: CPT CATEGORY file 81.1 CUSTODIAL PACKAGE: CPT/HCPCS CODES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 8,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 81.1 ROOT: DIC(81.1 DESCRIPTION: TYPE: File This will enable the display of the CPT Category. Both a direct global read and a FileMan read are acceptable. ^DIC(81.1,D0,0) .01 CATEGORY NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1589 NAME: GMRVPCE0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS Only are requesting use of RATECHK and HELP entry points. PCE PATIENT CARE ENCOUNTER Only are requesting use of STORE and VALIDATE entry points. ORDER ENTRY/RESULTS REPORTING BAR CODE MED ADMIN SURGERY USAGE: Controlled Subscri ENTERED: AUG 8,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The GMRVPCE0 routine can be used to enter data into the Vitals/Measurements package (using PCE Device Interface Specification), validate measurement data (which uses PCE Device Interface Specification), print help for a particular measurement, or validate a particular measurement. ROUTINE: GMRVPCE0 COMPONENT: VALIDATE(PXCA) VARIABLES: PXCA Type: Both PXCA is the the array which contains measurement data to be validated. The array is defined in the PCE Device Interface Specification and must be passed by reference, i.e., .PXCA. The nodes in the array that are used are described below, but their definitions can be found in the PCE Device Interface Specification. PXCA("ENCOUNTER"), PXCA("VITALS") and PXCA("SOURCE") are used by VALIDATE and are input variables. PXCA("ERROR") or PXCA("WARNING") may be returned if data is invalid or duplicate. Validate measurement data which is in format described in PCE Device Interface Specification. Returns PXCA("ERROR") if data not valid. COMPONENT: STORE(PXCA) VARIABLES: PXCA Type: Both PXCA is the the array which contains measurement data to be validated. The array is defined in the PCE Device Interface Specification and must be passed by reference, i.e., .PXCA. The nodes in the array that are used are described below, but their definitions can be found in the PCE Device Interface Specification. PXCA("ENCOUNTER"), PXCA("VITALS") and PXCA("SOURCE") are used by STORE and are input variables. PXCA("ERROR") or PXCA("WARNING") may be returned if data is invalid or duplicate. This component will validate and store data in the Vitals/Measurements database which is in the format described in the PCE Device Interface Specification. It will return PXCA("ERROR") if there was a problem with the data. COMPONENT: HELP(TYPE,HLPARRAY) VARIABLES: TYPE Type: Input Type of measurement. This is a required variable and is the abbreviation for the measurement type found in the PCE Device Interface Specification. HLPARRAY Type: Input This is an optional variable describing location where the help will be found after the procedure call. This is a closed array reference, and if not specified, data will be returned in ^TMP($J,"GMRVHELP"). TMP($J,'GM Type: Output Either this variable or the array defined by HLPARRAY will contain the help for this measurement type. The format is ^TMP($J,"GMRVHELP",X) where X is a number between 1 and the number of lines of help text. This procedure will return help for a particular measurement type. COMPONENT: $$RATECHK(TYPE,RATE,UNIT) VARIABLES: TYPE Type: Input Type of measurement. This is a required variable and is the abbreviation for the measurement type found in the PCE Device Interface Specification. RATE Type: Input The rate to be validated for this measurement type. This variable is required. UNIT Type: Input This is an optional variable which will contain the units of measurement for RATE. $$RATECHK Type: Output The function value will either be 1, rate is valid, or 0 rate is not valid. This function will validate a rate for a particular measurement type. COMPONENT: $$VMTYPES(TYPE) VARIABLES: TYPES Type: Input Input as the type of vital. RESULT Type: Output Result of extrinsic function ($$VMTYPES(TYPE)) is set to 1 if valid or 0 otherwise. Returns a 1 if the type of vital is valid and 0 otherwise. ******************** 1590 NAME: PC PRACTITIONER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS REGISTRATION USAGE: Controlled Subscri ENTERED: AUG 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA is for the purpose of determining the ien and name of the practitioner filling the PC position. ROUTINE: SCAPMCU2 COMPONENT: $$NMPCPR(DFN[,DATE][,PCROLE]) VARIABLES: DFN Type: Input Pointer to patient file DATE Type: Input Date of interest PCROLE Type: Input Default=1 (PC Practitioner Position) note 2= pc attending NMPCPR(DFN,DATE,PCROLE) ;returns ien & name of pract filling pc position ******************** 1592 NAME: PATIENT CARE ENCOUNTER CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Controlled Subscri ENTERED: AUG 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File The purpose of this IA is to allow access to the ^AUPNPROB( global for purposes of gathering information specific to a problem. ^AUPNPROB(D0,0) .01 DIAGNOSIS 0;1 Direct Global Read & w 1.02 CONDITION 1;2 Direct Global Read & w ROUTINE: ******************** 1593 NAME: PATIENT CARE ENCOUNTER CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING CLINICAL PROCEDURES EMERGENCY DEPARTMENT ADDED 10/10/2008 LEXICON UTILITY added 6/8/2011 VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: AUG 9,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.27 ROOT: AUTNPOV( DESCRIPTION: TYPE: File The purpose of this IA is to allow access to the ^AUTNPOV( global for purposes of gathering information specific to a problem. ^AUTNPOV(D0,0) .01 NARRATIVE 0;1 Direct Global Read & w ROUTINE: ******************** 1594 NAME: APPOINTMENT MULTIPLE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS Although Scheduling is allowing AICS to set a variable to the 0th node of this multiple to prevent multiple hits to this node to retrieve the many required fields...AICS will notify Scheduling if it intends to utilize any fields on the 0th node that fall outside of this integration agreement. USAGE: Controlled Subscri ENTERED: AUG 12,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The purpose of this IA is to allow direct reference to the Appointment multiple of the patient file to access a number of fields. This IA will allow reference to the entire ^DPT(D0,'S',D1,0) node. This will prevent multiple global hits to gather data from the fields referenced in this IA. ^DPT(D0,'S',D1,0) .01 CLINIC 0;1 Direct Global Read & w 3 STATUS 0;2 Direct Global Read & w 21 OUTPATIENT ENCOUNTER 0;20 Direct Global Read & w 22 ENCOUNTER FORMS PRIN 0;21 Direct Global R/W & w/ 23 ENCOUNTER FORMS AS A 0;22 Direct Global R/W & w/ Appointment multiple of the Patient file. ROUTINE: ******************** 1595 NAME: FILE SECURITY CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: GEN. MED. REC. - I/O USAGE: Private ENTERED: AUG 15,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3.0 FILE: 1 ROOT: DIC DESCRIPTION: TYPE: File Intake/Output V3 is asking for a one-time exemption to be able to read/write to the ^DIC(file,0,access) global where 126 <= file <= 126.95 and access=(DD,RD,WR,LAYGO,DEL). ^DIC(file,0,'DD') Intake/Output can read/write the ^DIC(file,0,"DD") node, where file is a valid file in the Intake/Output package. ^DIC(file,0,'DEL') Intake/Output can read/write the ^DIC(file,0,"DEL") node, where file is a valid file in the Intake/Output package. ^DIC(file,0,'LAYGO') Intake/Output can read/write the ^DIC(file,0,"LAYGO") node, where file is a valid file in the Intake/Output package. ^DIC(file,0,'RD') Intake/Output can read/write the ^DIC(file,0,"RD") node, where file is a valid file in the Intake/Output package. ^DIC(file,0,'WR') Intake/Output can read/write the ^DIC(file,0,"WR") node, where file is a valid file in the Intake/Output package. ROUTINE: ******************** 1597 NAME: LEXICON EXPRESSION INFORMATION CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 18,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine LEXA is used by the Lexicon Utility to perform a silent look-up and return an array of the expression found. ROUTINE: LEXA COMPONENT: INFO(IEN,DATE) VARIABLES: IEN Type: Input Internal Entry Number in the Expression file #757.01. LEX Type: Output The local array LEX("SEL") contains the major concept, synonyms, lexical variants, associated codes (i.e., ICD, CPT, DSM, etc.), the expression definition (if one exists), the semantic class, the semantic type, and all VA classification sources. See the Lexicon Utility's Technical Manual for a detailed description of this array. DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Active codes will be retrieved and displayed. This entry point allows applications to retrieve information about an expression without conducting a search. ******************** 1599 NAME: LEXICON USER DEFAULTS - FILTER CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN1^LEXDFL will be used to setup user default filter for conducting searches in the Lexicon Utility. This entry point, along with EN1^LEXDCC, EN1^LEXDVO, EN1^LEXDCX and EN1^LEXDDS replaces ^GMPTDUSR used in verion 1.0 of the Clinical Lexicon Utility (see DBIA 339). ROUTINE: LEXDFL COMPONENT: EN1(LEXAP) VARIABLES: LEXAP Type: Input LEXAP is the Internal Entry Number of the Subset Definition file (#757.2) where the application definition is located. This entry point allows a single user to edit their default look-up filter for the Lexicon Utility. ******************** 1601 NAME: LEXICON USER DEFAULTS - DISPLAY CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN1^LEXDCC(LEXAP) will be used to setup user default display (classification codes) for conducting searches in the Lexicon Utility. This entry point along with EN1^LEXDFL, EN1^LEXDVO, EN1^LEXDCX and EN1^LEXDDS replaces ^GMPTDUSR used in verion 1.0 of the Clinical Lexicon Utility (see DBIA 339). ROUTINE: LEXDCC COMPONENT: EN1(LEXAP) VARIABLES: LEXAP Type: Input LEXAP is the Internal Entry Number of the Subset Definition file (#757.2) where the application definition is located. This entry point allows a single user to edit their default look-up display for the Lexicon Utility. ******************** 1603 NAME: LEXICON USER DEFAULTS - VOCABULARY CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN1^LEXDVO will be used to setup user default vocabulary for conducting searches in the Lexicon Utility. This entry point, along with EN1^LEXDFL, EN1^LEXDCC, EN1^LEXDCX and EN1^LEXDDS replaces ^GMPTDUSR used in version 1.0 of the Clinical Lexicon Utility (see DBIA 339). ROUTINE: LEXDVO COMPONENT: EN1(LEXAP) VARIABLES: LEXAP Type: Input LEXAP is the Internal Entry Number of the Subset Definition file (#757.2) where the application definition is located. This entry point allows a single user to edit their default look-up vocabulary for the Lexicon Utility. ******************** 1605 NAME: LEXICON USER DEFAULTS - SHORTCUTS CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN1^LEXDCX will be used to setup user default shortcuts by context for conducting searches in the Lexicon Utility. This entry point along with EN1^LEXDFL, EN1^LEXDCC, EN1^LEXDVO and EN1^LEXDDS replaces ^GMPTDUSR used in version 1.0 of the Clinical Lexicon Utility (see DBIA 339). ROUTINE: LEXDCX COMPONENT: EN1(LEXAP) VARIABLES: LEXAP Type: Input LEXAP is the Internal Entry Number of the Subset Definition file (#757.2) where the application definition is located. This entry point allows a single user to edit their default look-up shortcuts for the Lexicon Utility. ******************** 1607 NAME: LEXICON USER DEFAULTS - LIST CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN1^LEXDDS will be used to list user defaults for searching the Lexicon to a device (terminal or printer). This entry point along with EN1^LEXDFL, EN1^LEXDCC, EN1^LEXDVO and EN1^LEXDCX replaces ^GMPTDUSR used in version 1.0 of the Clinical Lexicon Utility (see DBIA 339). ROUTINE: LEXDDS COMPONENT: EN1(LEXAP) VARIABLES: LEXAP Type: Input LEXAP is the Internal Entry Number of the Subset Defintion file (#757.2) where the application definition is located. This entry point allows a single user to list their Lexicon Utility defaults to a device (terminal or printer). ******************** 1609 NAME: LEXICON SETUP SEARCH PARAMETERS CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 19,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Lexicon Utility uses LEXSET to setup search parameters based on applications definitions, subset definitions and user defaults stored in the Subsets Definition file (#757.2). These search parameters are stored in the global array ^TMP("LEXSCH",$J). ROUTINE: LEXSET COMPONENT: CONFIG(LEXNS,LEXSS,DATE) VARIABLES: LEXNS Type: Input LEXNS is an application identifier (formerly namespace) which tells the setup routines which application definition in file 757.2 to use to retrieve application defaults (i.e., global, display, filter, etc.) Acceptable values for LEXNS are found in file 757.2 in the "AN" index: ^LEXT(757.2,"AN",LEXNS) LEXSS Type: Input LEXSS is a subset identifier which tells the setup routines which subset definition in file 757.2 to use to retrieve subset and user defaults (i.e., global, display, filter, etc.). Acceptable values for LEXSS may be found in file 7 57.2 in either the "AA" or the "AB" indexes: ^LEXT(757.2,"AA",LEXSS) ^LEXT(757.2,"AB",LEXSS) TMP(LEXSCH Type: Output ^TMP("LEXSCH",$J) is a global array used by the Lexicon Utility to control how a search of the Lexicon is to be conducted. It contains the following segments: APP Application (from LEXNS) DIS Display format FIL Filter FLN File Number GBL Global (Fileman DIC) IDX Index used during the search LEN Length of list to display LOC Hospital Location OVR Overwrite User Defaults flag SCT Shortcuts SVC Service UNR Unresolved Narrative flag USR User (DUZ) VDT Version Date Check (for classification codes) VOC Vocabulary A detailed description of this global array may be found in the Lexicon Utility's Technical Manual. DATE Type: Input This is a date in Fileman format used to check classification code codes to determine if they are active or inactive on the specified date. If not supplied, it will default to TODAY. This entry point may be used by other applicaitons to setup parameters for conducting a search of the Lexicon Utility. ******************** 1611 NAME: PROBLEM FILE UPDATE BY LEXICON CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: LEXICON UTILITY USAGE: Private ENTERED: AUG 20,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File This gives the Lexicon Utility the ability to update the ICD codes and the Lexicon pointer (Problem) in the Problem List application with each new release of the Lexicon. ^AUPNPROB(D0,0) .01 DIAGNOSIS 0;1 Both R/W w/Fileman Pointer to ICD-9 file #80. ^AUPNPROB(D0,1) 1.01 PROBLEM 1;1 Both R/W w/Fileman Pointer to Expressions file #757.01. ^AUPNPROB('B') Needed to traverse the "B" index to the .01 field pointing to ICD file #80. ^AUPNPROB(D0,800) 80001 SNOMED CT CONCEPT CO 800;1 Read w/Fileman This is a SNOMED CT Code found in the Lexicon CODES file #757.02. ROUTINE: ******************** 1612 NAME: DSM FILE CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 20,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 627.7 ROOT: YSD(627.7, DESCRIPTION: TYPE: File This will enable access to the DSM Code, DSM version and the Disorder Name. ^YSD(627.7,D0,0) .01 CODE 0;1 Direct Global Read & w 2 DSM VERSION 0;3 Direct Global Read & w ^YSD(627.7,D0,D) 40 DISORDER NAME D;1 Direct Global Read & w ROUTINE: ******************** 1614 NAME: LEXICON EXPRESSIONS FROM CODES CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 20,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Lexicon Utility uses the LEXCODE routine to extract expressions (terms) in the form of Fileman's output variable "Y" based on a classification code. ROUTINE: LEXCODE COMPONENT: EN(LEXSO,DATE) VARIABLES: LEXSO Type: Input LEXSO is a classification code from one of several sources (i.e., ICD, CPT, DSM). A complete list of these sources can be found in the Lexicon Utility's Technical Manual. LEXS(SAB,# Type: Output LEXS(SAB,#)=IEN^TERM is a local array containing references to expressions linked to the classification code. SAB refers to the three-character source abbreviation of the classification system (i.e., ICD-9-CM = ICD). A description of this array and a list of the source abbreviations can be found in the Lexicon Utility's Technical Manual. DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. This entry point builds a local array containing expressions linked to an active classification code. ******************** 1615 NAME: ENCOUNTER FORM DATA ENTRY CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 27,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a supported reference to process encounter form data. Packages that know patient, visit date/time, and clinic can call this API to use the AICS data entry system to prompt users for encounter data and subsequently store this data using the PCE device interface (this is done automatically using the AICS parameters). ROUTINE: IBDFDEA COMPONENT: EN1(PXCA,IBDF) VARIABLES: Type: PXCA Type: Both Pass by reference. The results of processing are returned in this array. See PCE device interface manual for description of data nodes. IBDF Type: Input Pass IBDF array to include: REQUIRED: IBDF("APPT") = Appointment date/time IBDF("DFN") = Pointer to Patient file (2) OPTIONAL: IBDF("CLINIC") = Pointer to Hospital Location file (44). If Clinic is not defined and no form printed, data entry will not be allowed. IBDF("NOAPPT") = If the AICS parameters allow for making follow-up appointments, setting this to any non-zero value will suppress the ability to add follow-up appts. IBDF("PROVIDER") = If defined, will be used as primary provider for data entry. Use for provider data entry options. May be called to use the AICS data entry system to prompt users for encounter data and subsequently store this data using the PCE device interface. ******************** 1616 NAME: PNs TITLE file conv to TIU CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: AUG 27,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: ROOT: DESCRIPTION: TYPE: Other Progress Notes patch GMRP*2.5*44 will be exporting a series of options to facilitate the clean-up of the PNs package in preparation for the conversion to TIU. Once clean-up is complete the final step is to run the conversion of the Progress Notes Title file (#121.2) to the TIU Document Definition file (#8925.1). ROUTINE: ******************** 1618 NAME: DIV CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: SEP 13,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Lab is requesting a database agreement to call the DIV routine at line tag VER for the workload data Lab archiving verify option. The option is Verify Files for Archiving. This option allows the user to select either the WKLD DATA (64.1) or LAB MONTHLY WORKLOADS (67.9) file and choose to verify data in either the whole file or entries selected by the Select Entries for Archiving option. Routine name:LRARVER line: ALL D VER^DIV(LRART) where LRART = file # 64.1 or 67.9 line: VWD+1 D VER^DIV(64.11,.LRWIN) where LRWIN is an array of records to verify line: VLMW+1 D VER^DIV(67.911,.LRWIN) where LRWIN is an array of records to verify ROUTINE: DIV COMPONENT: VER VARIABLES: ******************** 1619 NAME: Set ID nodes in post-install patch routine CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: SEP 24,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.1 FILE: 357 ROOT: DD(357.02 DESCRIPTION: TYPE: File KIDS cannot support adding new Identifiers with a partial DD update, AICS wants to send a post-install routine to add a new Identifier and update existing data-file entries for the ENCOUNTER FORM file (357). The following ^DD and ^IBE(357 nodes will be set in a post-install routine: ^DD(357.02,0,"ID",.02)=W " ",@("$P($P($C(59)_$S($D(^DD(357.02,.02,0)): $P(^(0),U,3),1:0)_$E("_DIC_"Y,0),0),$C(59)_$P(^(0),U,2)_"":"",2), $C(59),1)") $P(^DD(357,2,0),"^",2)="357.02I" $P(^IBE(357,D0,2,0),"^",2)="357.02I" ROUTINE: ******************** 1621 NAME: %ZTER (ERROR RECORDING) CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA is to document the supported calls into the %ZTER routine in support of standard error trapping. ROUTINE: %ZTER COMPONENT: $$NEWERR VARIABLES: This is an extrinsic function to report if the current platform supports the new standard error trapping. It always returns 1. All current VA systems support the new error trapping standard. The SACC has being changed to allow the use of $ESTACK, $ETRAP, $ECODE There are still inconsistency when mixing the old and new error trapping. To set a new trap: N $ESTACK,$ETRAP S $ETRAP="D ERROR^XXX" or N $ESTACK,$ETRAP S $ETRAP="S $EC="""" Q -1" These are still valid. Usage to set new trap: N $ESTACK,$ETRAP S $ETRAP="D ERROR^XXX" Usage to set old style trap: N $ESTACK,$ETRAP S $ETRAP="" S X="ERROR^YYY",@^%ZOSF("TRAP") The vendors differ in how they support the mixing of old and new forms of error trapping. A common way is to look at the current stack frame and, if it finds the old form, it uses that; otherwise it looks for the new style. This gives the old style a local scope of the current stack level. COMPONENT: UNWIND VARIABLES: This entry point is used after a package error trap to quit back to the calling routine. Control returns to the level above the one that NEWED $ESTACK. MAIN S X=1 D SUB W X Q SUB N $ESTACK,$ETRAP S $ETRAP="D ERROR" S X=1/0 Q Usage: ERROR D ^%ZTER ;This will record the error info and clear $ECODE S ^XXX="Incomplete record" G UNWIND^%ZTER COMPONENT: %ZTER VARIABLES: %ZT Type: Input (optional) The %ZT array can be used to identify a global node whose descendents should be recorded in the error log. When called within the standard Kernel error trap, %ZT is set to record the user's location in the menu system. >S %ZT("^TMP($J)")="" >D ^%ZTER This routine can be called from the top DO ^%ZTER to record the variables at the current time into the error trap. This will clear $ZE and $ECODE. COMPONENT: APPERROR VARIABLES: %ZT Type: Input The same as calling %ZTER. This entry will point allow developers to pass-in the error message that will be displayed in the error trap listing. Usage: D APPERROR^%ZTER("My App Error") ******************** 1622 NAME: DBIA1622 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: OCT 18,1996 STATUS: Active EXPIRES: JUL 1,1997 DURATION: Till Otherwise Agr VERSION: FILE: 3.8 ROOT: XMB(3.8, DESCRIPTION: TYPE: File Request DBIA to allow MailMan to K ^DD(3.8,0,"ID",5.1) as a post-install routine on a patch. There currently is no other way to remove a field as an identifier. ROUTINE: ******************** 1623 NAME: SCDXUAPI - OCCASION OF SERVICE ENTRY CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE EVENT CAPTURE USAGE: Controlled Subscri ENTERED: OCT 22,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The SCDXUAPI is used to add locations to the HOSPITAL LOCATION file which are deemed occasions of service. This routine has some supported references, but they should only be used after being discussed with the scheduling developers. The subscription to these APIs will be controlled. There are 4 supported calls in this routine. Line tags not specifically mentioned in this DBIA are NOT supported. Detailed documentation on these calls is provided within the routine. The supported calls are: RAD - this tag is specifically written for the radiology package. It allows them to pass in an IEN and convert the entry in file 44 to be an occasion of service location. LOC - main entry point to add occasion of service locations. This may also be used to edit or inactivate a location. SCREEN - provides a screen (S DIC("S")="SCREEN^SCDXUAPI(pkg)" to allow selection of only occasion of service locations which were added by the package passed in. EXEMPT - provides a screen (S DIC("S")="EXEMPT^SCDXUAPI()") which will allow selection of only stop codes which are deemed occasion of service stop codes. ROUTINE: SCDXUAPI COMPONENT: $$RAD(IEN,PKG) VARIABLES: IEN Type: Input IEN of the entry in the Hospital Location file that needs to be converted to an occasion of service location. PKG Type: Input Calling package IEN (pointer to the PACKAGE file). FUNCTION O Type: Output Returns one of three things: - If the function was able to alter the location passed in to be an occasion of service location, it will return the same IEN passed in. - If it was unable to use the location passed in, a new one will be created and its IEN will be returned - If the input checks failed for this location, and error message will be returned in the format -1^error code^description. The potential codes and descriptions are: 1 - Hospital Location IEN is Invalid 2 - Neither institution nor division defined properly for existing entry 3 - Location has an inactivation date 4 - Invalid PKG variable passed in 5 - IEN belongs to another package (PKG file entries don't match) 6 - Invalid stop code passed 7 - Invalid IEN passed to LOC call (package doesn't 'own' IEN) 8 - NAME, INST, and STOP not all defined before LOC call when IEN not set 9 - Unable to add entry to Hospital Location file 10 - Stop code not an occassion of service stop This call will accept the IEN of a location currently defined. It will check to look for clinic patterns. If none exist, it will update the location fields for an occasion of service location. If there are clinic patterns set up, it will convert the existing entry to non-count and create a new entry with the appropriate fields defined. It will return the IEN of the entry used (either the same as the incoming IEN or the IEN of the new entry which had to be created). Input: IEN of existing entry in the Hospital Location file PKG as either name, namespace, or IEN of package file Output: same IEN or different one if new one had to be created - OR- -1^code^description of error encountered Error codes possible: 1 - Hospital Location IEN is Invalid 2 - Neither institution nor division defined properly for existing entry 3 - Location has an inactivation date 4 - Invalid PKG variable passed in 5 - IEN belongs to another package (PKG file entries don't match) 6 - Invalid stop code passed 7 - Invalid IEN passed to LOC call (package doesn't 'own' IEN) 8 - NAME, INST, and STOP not all defined before LOC call when IEN not set 9 - Unable to add entry to Hospital Location file 10 - Stop code not an occassion of service stop COMPONENT: LOC(NAME,INST,STOP,PKG,IEN,INACT) VARIABLES: NAME Type: Input NAME - name of the location to be added. Only required if IEN not passed in. INST Type: Input Pointer to the institution file designating the location of the clinic. Only required if IEN not defined. stop Type: Input External value of the stop code value (example 108). This is only required if IEN is not passed in. PKG Type: Input Required variable indicating the calling package (pointer to the PACKAGE file). IEN Type: Input Optional variable denoting an existing entry in the Hospital Location file. If this exists, the name, institution, stop, and/or inactivation date fields are updated per values passed in. INACT Type: Input Optional: if passed in, it is a date that the location should be inactivated. FUNCTION O Type: Output The output will be either: - The IEN of the location created (if IEN is not passed in) - The IEN of the location updated (same as IEN passed in) - An error code if the process could not be completed. The error code will be in the format -1^error code^description where the error codes and descriptions are as follows: 1 - Hospital Location IEN is Invalid 2 - Neither institution nor division defined properly for existing entry 3 - Location has an inactivation date 4 - Invalid PKG variable passed in 5 - IEN belongs to another package (PKG file entries don't match) 6 - Invalid stop code passed 7 - Invalid IEN passed to LOC call (package doesn't 'own' IEN) 8 - NAME, INST, and STOP not all defined before LOC call when IEN not set 9 - Unable to add entry to Hospital Location file 10 - Stop code not an occassion of service stop This call will accept the name, division, and stop code (DSS ID) of the clinic location to be add/edited. If the IEN is passed in, the entry with that IEN will be updated. Otherwise, a new entry will be added. If the INACT variable is set to a date, it will INACTIVATE the location (if it exists). Input: NAME of clinic to be created (optional) INST as pointer to the institution file (optional) STOP as number of stop code (not IEN) for occasion of service range of codes (optional) PKG as package file IEN, name, or namespace - required! IEN as IEN of location if you want to update an already existing location (optional. If not defined, NAME, INST, STOP become required) INACT as a date if you want to inactivate the location that has the IEN you defined (optional) Output: IEN of location created/inactivated - OR - -1^error message if problem encountered Possible error messages: 1 - Hospital Location IEN is Invalid 2 - Neither institution nor division defined properly for existing entry 3 - Location has an inactivation date 4 - Invalid PKG variable passed in 5 - IEN belongs to another package (PKG file entries don't match) 6 - Invalid stop code passed 7 - Invalid IEN passed to LOC call (package doesn't 'own' IEN) 8 - NAME, INST, and STOP not all defined before LOC call when IEN not set 9 - Unable to add entry to Hospital Location file 10 - Stop code not an occassion of service stop COMPONENT: $$SCREEN(PKG) VARIABLES: PKG Type: Input Pointer to the PACKAGE file indicating the calling package. FUNCTION O Type: Output A sting of M code that should be set into the variable DIC("S") when doing a lookup to the Hospital Location file. Allows a package to select from only the occasion of service locations added by their package. This value should be set to DIC("S") when doing a lookup on the Hospital Location file (S DIC("S")=$$SCREEN^SCDXUAPI(pkg)). COMPONENT: $$EXEMPT() VARIABLES: FUNCTION O Type: Output A sting of M code that should be set into the variable DIC("S") when doing a lookup to the Clinic Stop file. Allows a package to select only stop codes which are deemed by Headquarters personnel to be occasion of service stop codes. ******************** 1624 NAME: Cross Reference on Date of Death Field CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 24,1996 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File A APSOD xref on the Date of Death field in file #2. This Xref will be used to discontinue all active outpatient medication whenever a date of death is entered for a patient. This IA applicable only for Outpatient Pharmacy version 7.0. ^DPT(D0,.351) => DATE OF DEATH .351 DATE OF DEATH .35;1 Read w/Fileman This field is used to indicate a date of death for a patient. ^DD(2,.351,1,52,0) = 2^APSOD^MUMPS ^DD(2,.351,1,52,1) = I $$VERSION^XPDUTL("PSO")>6 D APSOD^PSOCAN3(DA) ^DD(2,.351,1,52,2) = I $$VERSION^XPDUTL("PSO")>6 D APSOD^PSOAUTOC(DA) ^DD(2,.351,1,52,3) = Discontinues Outpatient Medications for v7. ^DD(2,.351,1,52,"%D",0) = ^^2^2^2961024^^^^ ^DD(2,.351,1,52,"%D",1,0) = This xref is used to discontinue all active outpatient medications whenever ^DD(2,.351,1,52,"%D",2,0) = a date of death is entered for the patient. ^DD(2,.351,1,52,"%D",3,0) = This xref is used with v7 of Outpatient Pharmacy (DBIA #1624). ^DD(2,.351,1,52,"%D",4,0) = Kill logic updated with DG*5.3*455. Mail message sent to pharmacy when date ^DD(2,.351,1,52,"%D",5,0) = of death is deleted to holders of PSORPH key. ^DD(2,.351,1,52,"DT") = 2961023 ROUTINE: ******************** 1625 NAME: PERSON CLASS API'S CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 7,1996 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Based on a multiple in the NEW PERSON file (#200) which contains entries that reflect the assignement of HCFA taxonomy to providers, these APIs provide data for a given NEW PERSON file entry on HCFA code, profession, specialty, and subspecialty. ROUTINE: XUA4A72 COMPONENT: $$GET(DUZ[,DATE]) VARIABLES: DUZ Type: Input Internal entry number for the Person being checked in the New Person file. DATE Type: Input Date in internal FileMan format, to indicate effective date for determination. Returns the "IEN^Profession^Specialty^Sub-specialty^Effect date^Expired date^VA code" for the person identified by the DUZ in effect on the date passed in, in internal FileMan format, (TODAY if no date passed in). Returns -1 if DUZ doesn't point to a valid user or user has never had a Person Class assigned. Returns -2 if no active Person Class on that date. COMPONENT: $$IEN2CODE(IEN) VARIABLES: Returns the VA CODE from the PERSON CLASS file that corresponds to the IEN number passed in. If the IEN passed in does not match a valid entry in file 8932.1, an empty string is returned COMPONENT: $$CODE2TXT(IEN or Vcode) VARIABLES: IEN or Vco Type: Input Pass in either the IEN or the VA Vcode for the text that should be returned. $$CODE2TXT Type: Output Text for the code. This extrinsic function returns the three parts of the HCFA text from the person class file based on passing in the IEN or the VA's Vcode. COMPONENT: $$IEN2DATA(IEN or Vcode) VARIABLES: $$IEN2DATA Type: Output Person class data for an IEN IEN Type: Input IEN to file 200 COMPONENT: $$VCLK(X) VARIABLES: X Type: Input Vcode $$VCLK Type: Output IEN to file 200 ******************** 1629 NAME: XWB GET VARIABLE VALUE CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING IMAGING VISTA WEB JSHARVEY 20061128/ ADDED VISTA WEB AS SUBSCRIBER AS PER IVEY. INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VA POINT OF SERVICE (KIOSKS) FEE BASIS CLAIMS SYSTEM MEDICAL DOMAN WEB SERVICE WEB VISTA REMOTE ACCESS MANAGEME Added 9/27/19 USAGE: Controlled Subscri ENTERED: NOV 28,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure One can call the XWB GET VARIABLE VALUE RPC (distributed with the RPC Broker) to retrieve the value of any M variable in the server environment. Pass the variable name in Param[0].Value, and the type (reference) in Param[0].PType. Also, the current context of the user must give them permission to execute the XWB GET VARIABLE VALUE RPC (it must be included in the RPC multiple of the "B"-type option registered with the CreateContext function). This RPC accepts the name of a variable which will be evaluated and its value returned to the server. For example, this RPC may be called with a parameter variable like DUZ which will be returned as 123456. It should NOT be used to return the value of anything other than a variable. For example, the RPC should not attempt to return the value of a global or function call, as these are unsupported uses of the RPC and are not guaranteed to work consistently. Integration Agreement (IA) #1629 ROUTINE: VARVAL XWBLIB ******************** 1630 NAME: XUS AV CODE CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER VISTA INTEGRATION ADAPTOR JOINT LEGACY VIEWER WEB VISTA REMOTE ACCESS MANAGEME Added 9/27/19 USAGE: Private ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Broker Signon RPC'S. This DBIA covers the following RPC's XUS AV CODE XUS VA HELP XUS CVC XUS SIGNON SETUP That are all private to Broker. This API checks if a ACCESS/VERIFY code pair is valid. It returns an array of values R(0)=DUZ if sign-on was OK, zero if not OK. R(1)=(0=OK, 1,2...=Can't sign-on for some reason). R(2)=verify needs changing. R(3)=Message. R(4)=0 R(5)=count of the number of lines of text, zero if none. R(5+n)=message text. ROUTINE: VALIDAV XUSRB ******************** 1631 NAME: XUS INTRO MSG CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER IMAGING WEB VISTA REMOTE ACCESS MANAGEME Added 9/27/19 USAGE: Controlled Subscri ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure RPC to return the INTRO TEXT from the KSP file. This RPC returns the INTRO message from the KERNEL SYSTEM PARAMETERS file. ROUTINE: INTRO XUSRB ******************** 1632 NAME: XUS SIGNON SETUP CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure RPC ICR #1632 - API ICR #4054 Establishes the environment necessary for VistA sign-on. ROUTINE: SETUP XUSRB ******************** 1633 NAME: XUS SEND KEYS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER USAGE: Private ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This is a two part RPC for a Broker Signon component. XUS DIVISION GET XUS DIVISION SET The rpc XUS DIVISION GET gets a list of the institutions that this user may signon as belonging to. The rpc XUS DIVISION SET sets the Kernel variable DUZ(2) to the selected Division/institution. Returns an array of strings that are used in the hashing algorithm. The strings that are returned are picked up from Z^XUSRB. ROUTINE: SENDKEYS XUSRB ******************** 1634 NAME: TIU NOTES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 30,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API gets lists of progress notes for a patient, with optional parameters for STATUS, EARLY DATE/TIME, and LATE DATE/TIME. ROUTINE: NOTES TIUSRVLO ******************** 1635 NAME: TIU GET RECORD TEXT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE IMAGING ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT BAR CODE EXPANSION INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** JOINT LEGACY VIEWER Added as a subscriber for JLV 2.6 release USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC will get the textual portion of a TIU Document Record. ROUTINE: TGET TIUSRVR1 ******************** 1639 NAME: ORQQAL LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of allergies for a patient. ROUTINE: LIST ORQQAL ******************** 1641 NAME: ORQQAL DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL BAR CODE EXPANSION USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This function returns a string of information for a specific allergy/ adverse reaction. Returned data is delimited by "^" and includes: allergen/reactant, originator, originator title, verified/not verified, observed/historical,,type, observation date, severity, drug class, symptoms/reactions (mulitple symptoms possible - delimited by ";"), comments. ROUTINE: DETAIL ORQQAL ******************** 1642 NAME: ORQQPL LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL VISUAL IMPAIRMENT SERVICE TEAM BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertigan. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns a list of problems for a patient. ROUTINE: LIST ORQQPL ******************** 1643 NAME: ORQQPL DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertigan. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns a string of detailed information for a problem. ROUTINE: DETAIL ORQQPL ******************** 1647 NAME: ORQQVI VITALS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL VISTA INTEGRATION ADAPTOR USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The array returned will be in the format: Vitals IEN Vital Type Short Label - ie 'T' for Temperature Metric measurement (if available), including units. If no metric value is available, the imperial measurement is returned here. Date/time Vital measurement taken Imperial measurement, including units Array of patient most recent vitals within start and stop date/times. If no start and stop dates are indicated, the most recent are returned. If no start date is passed then the start date is 1 (i.e. before any dates). If no stop date is passed then the start date is also the stop date and if there is not start date then 9999999 is used as the stop date. ROUTINE: FASTVIT ORQQVI ******************** 1649 NAME: ORQPT DEFAULT PATIENT LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: REGISTRATION CARE MANAGEMENT HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns the current user's default patient list. ROUTINE: DEFLIST ORQPTQ11 ******************** 1650 NAME: ORQPT PROVIDERS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns an array of providers. ROUTINE: PROV ORQPTQ2 ******************** 1651 NAME: ORQPT PROVIDER PATIENTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns an array of patients linked to a provider/user. ROUTINE: PROVPTS ORQPTQ2 ******************** 1652 NAME: ORQPT CLINIC PATIENTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns patients with appointments at a clinic between start and stop dates ROUTINE: CLINPTS ORQPTQ2 ******************** 1653 NAME: ORQPT SPECIALTIES CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns an array of treating specialties. ROUTINE: SPEC ORQPTQ2 ******************** 1654 NAME: ORQPT SPECIALTY PATIENTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns an array of patients linked to a treating specialty. ROUTINE: SPECPTS ORQPTQ2 ******************** 1655 NAME: ORQPT TEAMS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: REGISTRATION CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: DEC 9,2004 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns a list of teams. ROUTINE: TEAMS ORQPTQ1 ******************** 1656 NAME: ORQPT TEAM PATIENTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: REGISTRATION CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: DEC 9,2004 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns an array of patients on a team. ROUTINE: TEAMPTS ORQPTQ1 ******************** 1659 NAME: ORQQPS LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns a list of a patient's medications. ROUTINE: LIST ORQQPS ******************** 1670 NAME: TIU SUMMARIES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API gets lists of Discharge Summaries for a patient, with optional parameters for STATUS, EARLY DATE/TIME, and LATE DATE/TIME. ROUTINE: SUMMARY TIUSRVLO ******************** 1671 NAME: ORQQCN LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE FUNCTIONAL INDEPENDENCE INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH added 4/21/2011 VISTA INTEGRATION ADAPTOR DENTAL CPRS approved adding Dental as a subscriber for Dental Record Manager to this ICR on 8/11/2009 to document existing references. However the update was not made to the ICR until 2/9/18. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Parameters: Patien DFN, Start Date, End Date, Service, Status Patient DFN - DFN of patient from VistA system. Start Date - Date to begin searching for consult records. If blank, ALL records for the patient will be returned. End Date - Date to stop searching for consult records. If Start Date is blank, End Date will be ignored. Service - Consult service (File 123.5 entry) to return records for. If Service is blank, records will be returned for All Services. Status - An order status (File 100.01) to search for. May be a single or multiple comma separated statuses. If blank, all statuses will be returned. Returns a list of consult requests for a patient within optional date range and optional service. ROUTINE: LIST ORQQCN ******************** 1672 NAME: ORQQCN DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE VISTA INTEGRATION ADAPTOR ADVANCED PROSTHETICS ACQUISITION The Advanced Prosthetics Acquisition Tool (APAT) GUI uses RPC ORQQCN DETAIL in several places to return detailed information regarding a Consult Request for display on the GUI. This information is displayed when the user selects the consult from a list of Prosthetic Suspense items. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns formatted detailed information regarding the consult request, including result report if available. ROUTINE: DETAIL ORQQCN ******************** 1676 NAME: ORQPT WARDS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH FUNCTIONAL INDEPENDENCE CARE MANAGEMENT BAR CODE EXPANSION VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: FEB 17,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns a list of wards. ROUTINE: WARD ORQPTQ2 ******************** 1680 NAME: ORQOR DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: JOINT LEGACY VIEWER Added as a subscriber for JLV 2.6 release. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns detailed information regarding an order. ROUTINE: DETAIL ORWOR ******************** 1681 NAME: ORQPT DEFAULT LIST SOURCE CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH SHIFT CHANGE HANDOFF TOOL USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Function returns the source of the current user's default patient list. ROUTINE: DEFSRC ORQPTQ11 ******************** 1684 NAME: ORWPT ID INFO CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertigan. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns identifying information for a patient. ROUTINE: IDINFO ORWPT ******************** 1685 NAME: ORWPT LIST ALL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VA POINT OF SERVICE (KIOSKS) The ORWPT LIST ALL RPC will be triggered by a request sent by the Vecna Kiosk system. Access to this RPC is needed for VPS*1*1. VPS*1*2 will not be using this RPC. VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a set of patient names for use with a long list box. ROUTINE: LISTALL ORWPT ******************** 1687 NAME: ORWLR CUMULATIVE REPORT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expires on 10/27/17 when HMP will be shutdown. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. On 11/3/16, the CPRS team disapproved use of the ORWLR CUMULATIVE REPORT RPC and recommended HMP use the EN~LR7OSUM API rather than going through CPRS. On 10/3/17, the HMP project team stated the ORWLR CUMULATIVE REPORT RPC is not used but is included in the HMP UI CONTEXT option. HMP was added as a subscriber on 10/26/17 to document HMP's use of the ICR. If HMP is reactivated in the future, the HMP project team will need to work with the CPRS team to resolve this issue. USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call returns an up to date laboratory cumulative report for a given patient. ROUTINE: CUM ORWLR ******************** 1689 NAME: ORWPT LOOKUP CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a set of patient names matching a given criteria. ROUTINE: LOOKUP ORWPT ******************** 1691 NAME: ORQQVS VISITS/APPTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of patient appointments and visits for a date/time range. location. ROUTINE: VSITAPPT ORQQVS ******************** 1692 NAME: ORQQPP LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL BAR CODE EXPANSION USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of active Patient Postings for a patient. ROUTINE: LIST ORQQPP ******************** 1693 NAME: ORQPT WARDRMBED CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the ward, room-bed for a patient. ROUTINE: WRB ORQPTQ3 ******************** 1694 NAME: ORQQPX IMMUN LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of patient immunizations. ROUTINE: IMMLIST ORQQPX ******************** 1699 NAME: ORQQLR DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the details of a lab order. ROUTINE: DETAIL ORQQLR ******************** 1702 NAME: ORQQPS DETAIL CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Controlled Subscri ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the details of a medication order. ROUTINE: DETAIL ORQQPS ******************** 1705 NAME: TIU NOTES BY VISIT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING JOINT LEGACY VIEWER Added as a subscriber for JLV 2.6 release. USAGE: Controlled Subscri ENTERED: APR 30,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API gets lists of Progress Notes by visit from TIU. ROUTINE: NOTES TIUSRVLV ******************** 1706 NAME: TIU SUMMARIES BY VISIT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 30,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API returns lists of Discharge Summaries by visit. ROUTINE: SUMMARY TIUSRVLV ******************** 1713 NAME: SC LISTER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Per LIST^DIC(), returns the starting location, number of records to retrieve, file to retrieve them from, and index to use. ROUTINE: LISTC SCUTBK ******************** 1714 NAME: SC FILER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Generic call to file edits into FM file. ROUTINE: FILEC SCUTBK ******************** 1715 NAME: SC DELETE ENTRY CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Allows file entry deletion via FileMan ^DIK call. ROUTINE: DIKC SCUTBK1 ******************** 1716 NAME: SC FIND CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Under Revision EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Per FIND^DIC, find records in a file. ROUTINE: FINDC SCUTBK2 ******************** 1717 NAME: SC FILE NUMBER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Broker callback to get file number. ROUTINE: FILENOC SCUTBK1 ******************** 1718 NAME: SC GLOBAL NODE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Call to pass back a global node. ROUTINE: NODEC SCUTBK1 ******************** 1719 NAME: SC GETS ENTRY DATA CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Calls database server at GETS^DIQ. ROUTINE: GETSC SCUTBK2 ******************** 1720 NAME: SC LOCK/UNLOCK NODE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Allow locking/unlocking of M global node. ROUTINE: LOCKC SCUTBK1 ******************** 1721 NAME: SC VALIDATOR CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This function allows the application to validate user input to a field before filing data. The call uses the database server VAL^DIE call. ROUTINE: VALC SCUTBK ******************** 1722 NAME: SC GLOBAL NODE COUNT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the number of entries found in the global node at the ROOT,XREF, VALUE. If 0 is returned, then there were no values at that node. Pass in ("ROOT"), ("XREF"), ("VALUE") ROUTINE: GLCNT SCUTBK1 ******************** 1723 NAME: SC PRTP CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the currently active staff member for a position. Send in Position Ien and date range, returns name and ien from New Person file. SC("IEN")=ien SC("BEGIN")=begining date for check SC("END")=ending date for check ROUTINE: PRTP SCUTBK1 ******************** 1724 NAME: SC MAILMAN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Sends Mailman message from information sent from client ROUTINE: MAILC SCUTBK10 ******************** 1725 NAME: SC NEW HISTORY OK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call passes back whether the date for a new history entry is valid or not. Primarily for files 404.52, 404.58, 404.59. Returns a 1 if ok, or a 0 if not. ROUTINE: NEWHIST SCUTBK10 ******************** 1726 NAME: SC CHANGE HISTORY OK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call returns a 1 if changing an exisiting date for a History entry is ok, or a 0 if the date cannot be changed. Primary history files are 404.52, 404.58, 404.59 ROUTINE: CHGDTC SCUTBK10 ******************** 1727 NAME: SC INACTIVATE ENTRY CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call returns a 1 if the entry can be inactivated, or a 0 if the entry cannot. Used primarily for history files. ROUTINE: INACTC SCUTBK10 ******************** 1728 NAME: SC DELETE HISTORY CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call returns a 1 if the entry can be deleted, a 0 if it cannot be deleted. Restricted to files 404.52, 404.58, 404.59 history files at present. ROUTINE: DELDTC SCUTBK10 ******************** 1729 NAME: SC HISTORY STATUS OK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call returns a 1 if the status of a new history entry is ok, a 0 if it is not. Currently restricted to files, 404.52, 404.58, 404.59 ROUTINE: NEWSTC SCUTBK10 ******************** 1730 NAME: SC MEAN TEST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns mean test data for patient from API call LST^DGMTU ROUTINE: MNTEST SCUTBK10 ******************** 1731 NAME: SC TEAM LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of teams the patient is currently assigned to. ROUTINE: TMLST SCUTBK11 ******************** 1732 NAME: SC PATIENT LOOKUP CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Patient lookup. This is intended as a temporary RPC until a VA or FileMan component is available. Does a Multiple index lookup on the PATIENT file (#2). This does not invoke DPTLK. Given lookup value, this returns a list of the form DFN^patient name^DOB^PID. Only the first 500 records that match the value are returned. ROUTINE: FINDP SCUTBK11 ******************** 1733 NAME: SC POSITION MEMBERS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns an array of positions. For each position, the standard role, team member currently filling, and the preceptor (if any) for the team member. Returns both Internal and external values. Piece 1: Team Ien 2: Position Ien 3: Team member Ien (File #200) 4: Team member's name 5: Precpetor's Ien (File #200) 6: Preceptor's Name 7: Primary Care role (if any) for position. ROUTINE: PSLST SCUTBK11 ******************** 1734 NAME: SC FILE SINGLE VALUE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure File a single value, similar to DIE stuff. For those instances where a single value needs to be filed or changed, and that value is not associated with a specific component on the client side. ie changing a flag. ROUTINE: VFILE SCUTBK11 ******************** 1735 NAME: SCTM AUTOLINK GETRECORD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API returns the 0th node of the Team file(#404.51) entry and the list of current autolinks. ROUTINE: GETREC SCAPMCU3 ******************** 1736 NAME: SC KEY CHECK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Return 1 if the user is assigned the key passed in, else return 0 ROUTINE: SECKEY SCUTBK11 ******************** 1737 NAME: SCTM AUTOLINK SETRECORD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API sets the list of autolinks for a team. ROUTINE: SETREC SCAPMCU3 ******************** 1738 NAME: SCTM AUTOLINK GETLINK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This rpc returns the list of Team names that are autolinked to an entity. ROUTINE: GETLINK SCAPMCU3 ******************** 1739 NAME: SCRP DEFINITION GETRECORD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC returns a scheduling report definition as defined in file 404.92. ROUTINE: GETREC SCRPBK ******************** 1740 NAME: SCUT GET USER RECORD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC returns user related data often needed by scheduling modules. The data returned is used to set instance variables for the TScUser object type on the client. ROUTINE: GETUSER SCUTBK3 ******************** 1741 NAME: SCRP QUERY GETRECORD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC returns a scheduling report query template definition as definedin file 404.95. ROUTINE: GETREC SCRPBK0 ******************** 1751 NAME: XWB CREATE CONTEXT CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: VISTA INTEGRATION ADAPTOR MEDICAL DOMAN WEB SERVICE JOINT LEGACY VIEWER WEB VISTA REMOTE ACCESS MANAGEME Added 9/27/19 USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Establishes context on the server, which will be checked by the Broker before executing any other remote procedure. Since context is nothing more than a client/server "B"-type option in the OPTION file (#19), standard MenuMan security is applied in establishing a context. Therefore, a context option can be granted to user(s) exactly the same way as regular options are done using MenuMan. A context can not be established for the following reasons: · The user has no access to that option · The option is temporarily out of order An application can switch from one context to another as often as it needs to . Each time a context is created the previous context is overwritten. For more information on creating a context and the overall Broker security see Broker on-line help documentation. Integration Agreement (IA) #1751 ROUTINE: CRCONTXT XWBSEC ******************** 1752 NAME: SCRP SELECTION SOURCE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC returns a list of entries that is displayed to the user as part of the entry selection process. This process occurs during query template setup. It involves the user indicating which divsions, teams, roles, clinics, practitioners and user classes s/he desires information about on a report. ROUTINE: GETDATA SCRPBK1 ******************** 1753 NAME: SCRP FILE ENTRY GETSELECTION CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC returns information assoicated with an entry on the entity selection form of the Query Template Utility. The RPC gets invoked as a result of the user clicking the right mouse button and selecting 'Details'. ROUTINE: GETSEL SCRPBK11 ******************** 1754 NAME: SCRP QUERY SAVE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC attempts to save the query template definition for the user. Before saving query, the RPC will validate the query criteria and report any errors without saving query. The query template definition must pass the validation check before it can be saved. ROUTINE: SAVE SCRPBK2 ******************** 1755 NAME: SCRP QUERY VALIDATE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC will validate the criteria specified in the query template definiton passed in as part of the call. The validation checks the criteria against what data is required the report assoicated with the template. If the validation check fails, then the errors found are returned as part of the RPC, otherwise a success flag(1) is returned. ROUTINE: VALID SCRPBK4 ******************** 1756 NAME: SCRP QUERY DELETE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC allows for the deletion of a query, usually at the request of the user. ROUTINE: DELETE SCRPBK2 ******************** 1757 NAME: SCRP QUERY CHECK NAME CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC checks to see if the user already has a query with the name being passed in as part of the RPC. If there is already a query with the same name, the RPC passes back the internal entry number of the RPC, otherwise the RPC passes back a 0. ROUTINE: NAME SCRPBK2 ******************** 1758 NAME: SCUT SET USER QUERY DEFAULT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC is used to set or change the user's defualt PCMM query template. ROUTINE: SETDEF SCUTBK3 ******************** 1759 NAME: SCRP REPORT PRINT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC queues a report to print based the the query template definition passed in as part ithe RPC call. The RPC returns the TaskMan task number. Before the report assoicated with the query template is queued to print, it must pass a validation check. This check makes sure the criteria in the template is appropriate for the report. If the validation fails, the errors are returned as part of the RPC. ROUTINE: PRINT SCRPBK3 ******************** 1760 NAME: SC STAFF LOOKUP CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of staff members. ROUTINE: STAFFLK SCUTBK12 ******************** 1761 NAME: SC USER CLASS STATUS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a 1 if the User class is installed and in use, a 0 if the User Class is not installed ROUTINE: CHKUSR SCUTBK12 ******************** 1762 NAME: SC PRIMARY CARE TEAM CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the primary care team for a patient for the date specified. Pass in the DFN and Date. Returns team information. ROUTINE: GETPC SCUTBK12 ******************** 1763 NAME: SC BUILD PAT CLN LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Calls a build to create a list of patients in ^TMP($J,"SCCLPT" for retreival by blocks of names. Single array could be to large to handle as a single retreive. ROUTINE: PTCLBLD SCUTBK20 ******************** 1764 NAME: SC GET PAT BUILD CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Private ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: PTCLGET SCUTBK20 ******************** 1765 NAME: SC ASSIGN PATIENT LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: PTASGN1 SCUTBK20 ******************** 1766 NAME: SC FILE PATIENT LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: PTASGN2 SCUTBK20 ******************** 1767 NAME: SC BUILD PAT TM LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: PTTMBLD SCUTBK20 ******************** 1768 NAME: SC GET PAT TM LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: PTTMGET SCUTBK20 ******************** 1769 NAME: SC GET PAT BLOCK CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Retrieve a block of patients available to be assigned from the ^TMP holding global built by the SC BLD PAT.... remote procedure call. Input $J, the starting number in the block, the ending number in the block, and the last entry in the global. ROUTINE: PTGET SCMCBK ******************** 1770 NAME: SC BLD PAT LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Builds a list of patients to be assigned to either a team or position through the multiple assignment form. This list is called by the actual "filer" for either the Team or the position. The list's format is ^TMP($J,"SC PATIENT LIST",DFN) ROUTINE: PTLSTBLD SCMCBK ******************** 1771 NAME: SC FILE PAT TM ASGN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure File patient team assignments in ^TMP("SC PATIENT LIST",DFN) global for later processing ROUTINE: PTFILE SCMCBK ******************** 1772 NAME: SC BLD PAT CLN LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC build a list of patients by assignment to a selected clinic. Lookup is in the Hospital location file, screening of "C" in the (0,3) node. List is stored in ^TMP($J,"SCCLPT",N)=DFN. List is alphabetized by name. ROUTINE: PTCLBLD SCMCBK ******************** 1773 NAME: SC FILE PAT POS ASGN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure File patient position assignments in ^TMP("SC PATIENT LIST",DFN) global for later processing ROUTINE: POSFILE SCMCBK ******************** 1774 NAME: SC BLD PAT SCDE LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Buils a list of patients who are associated with a particular stop code. Only those patients within the specified date range will appear in the list. Screens out inactive stop codes. Format of the list is ^TMP($J,"SCSCDE",DFN) ROUTINE: PTSCBLD SCMCBK ******************** 1775 NAME: SC BLD PAT TM LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Builds a list of patients who are assigned to the selected team. format of the list is ^TMP($J,"SCTEAM",n)=DFN. ROUTINE: PTTMBLD SCMCBK ******************** 1776 NAME: SC BLD PAT POS LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Build a list of patients who are assigned to a selected position. The format of the list is ^TMP($J,"SCPOS",n)=DFN. This list is called the actual filer through another RPC. ROUTINE: PTPSBLD SCMCBK ******************** 1777 NAME: SC PAT ENROLL CLN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Enrolls patient in the clinic that is associated with the position the patient is being assigned to. Pass in DFN, Clinic, required fields, and the date assigned. ROUTINE: PTCLEN SCMCBK1 ******************** 1778 NAME: SC CHECK FOR PC POS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: CHKPOS SCMCBK1 ******************** 1779 NAME: SC FILE ALL PAT TM ASGN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure File patient - team assignments in ^TMP("SC PATIENT LIST",DFN) global ROUTINE: ASGNALL SCMCBK1 ******************** 1780 NAME: SC BLD PAT APT LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Builds a list of patients for a selected clinic by appointment date range. This list is stored in ^TMP($J,"SCAPP",n)=DFN. List is in alphabetical order. ROUTINE: PTAPBLD SCMCBK ******************** 1781 NAME: SC FILE ALL PAT POS ASGN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 17,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: ASGALLP SCMCBK1 ******************** 1782 NAME: TIU GET PN TITLES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL IMAGING ORDER ENTRY/RESULTS REPORTING VISUAL IMPAIRMENT SERVICE TEAM SPINAL CORD DYSFUNCTION added 11/28/06/JSHarvey USAGE: Controlled Subscri ENTERED: NOV 28,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API returns a list of Progress Notes Titles, including a SHORT LIST of preferred titles as defined by the user, and a LONG LIST of all titles defined at the site. ROUTINE: NOTES TIUSRVD ******************** 1783 NAME: TIU GET DS TITLES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 29,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API returns a list of Discharge Summary Titles, including a SHORT LIST of preferred titles as defined by the user, and a LONG LIST of all titles defined at the site. ROUTINE: SUMMARY TIUSRVD ******************** 1784 NAME: TIU LOAD BOILERPLATE TEXT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING IMAGING VA POINT OF SERVICE (KIOSKS) Added VPS as subscriber, effective with VPS*1*3 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC will load the boilerplate text associated with the selected title, and execute the methods for any objects embedded in the boilerplate text. ROUTINE: BLRSHELL TIUSRVD ******************** 1790 NAME: TIU SIGN RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL IMAGING FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING VISUAL IMPAIRMENT SERVICE TEAM INSURANCE CAPTURE BUFFER JUNE 2009 VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) Effective with VPS*1*3 HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API Supports the application of the user's electronic signature to a TIU document while evaluating authorization, and validating the user's electronic signature. ROUTINE: SIGN TIUSRVP ******************** 1791 NAME: ORWU USERINFO CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH REGISTRATION Veteran ID Card Replacement (VIC) uses the RPC to obtain the CPRS timeout parameter. BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertig an. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. SHIFT CHANGE HANDOFF TOOL USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns preferences for the current user. ROUTINE: USERINFO ORWU ******************** 1796 NAME: TIU GET PERSONAL PREFERENCES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 30,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns Users personal preferences for TIU in the following format: TIUY = USER [1P] ^ DEFAULT LOCATION [2P] ^ REVIEW SCREEN SORT FIELD [3S] ^ ==>REVIEW SCREEN SORT ORDER [4S] ^ DISPLAY MENUS [5S] ^ PATIENT ==>SELECTION PREFERENCE [6S] ^ ASK 'Save changes?' AFTER EDIT [7S] ^ ==>ASK SUBJECT FOR PROGRESS NOTES [8S] ^ ROUTINE: GETPREF TIUSRVR ******************** 1797 NAME: SC BLD NOPC TM LIST CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Builds a list of patients that have a primary care assignment, but no current primary care team assignment. Uses $$PTPCNTM^SCAPMC20 ROUTINE: NOPCTM SCMCBK1 ******************** 1798 NAME: SC PAT ASGN MAILMAN CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Builds the before and after status for a single patient assignment to either a team or a position, and fires off a mailman message. ROUTINE: PTASGMM SCUTBK10 ******************** 1799 NAME: TIU UPDATE RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This API updates the record named in the TIUDA parameter, with the information contained in the TIUX(Field #) array. The body of the modified TIU document should be passed in the TIUX("TEXT",i,0) subscript, where i is the line number (i.e., the "TEXT" node should be ready to MERGE with a word processing field). Any filing errors which may occur will be returned in the single valued ERR parameter (which is passed by reference). ROUTINE: UPDATE TIUSRVP ******************** 1800 NAME: TIU REQUIRES COSIGNATURE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING VISUAL IMPAIRMENT SERVICE TEAM INSURANCE CAPTURE BUFFER ADDED JUNE2009 VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) Effective with VPS*1*3 HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expires on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR to address any potential changes. USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Boolean RPC simply evaluates whether the current user requires cosignature for TIU DOCUMENTS, and returns a 1 if true, or a 0 if false. ROUTINE: REQCOS TIUSRVA ******************** 1801 NAME: TIU LOAD RECORD FOR EDIT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING INSURANCE CAPTURE BUFFER ADDED JUNE2009 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC loads the return array with data in a format consistent with that required by the TIU UPDATE RECORD API. It should be invoked when the user invokes the Edit action, to load the dialog for editing the document. ROUTINE: GET4EDIT TIUSRVR ******************** 1802 NAME: TIU DETAILED DISPLAY CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA will use this RPC in the VIAB*1*5 patch. One of the charges to the VIA project is exposing RPCs and creating ICRs for those RPCs that are already in use by the MDWS infrastructure. VIA provides a Class I product of services that work with VistaLink, replacing the need for developers to use MDWS services. TIU*1.0*300 patch is associated with the VIAB*1*5 patch to set the APP PROXY ENABLED field to Yes. USAGE: Private ENTERED: APR 30,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Gets details for display of a given record. ROUTINE: RPC TIUSRV ******************** 1805 NAME: TIU CREATE ADDENDUM RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING AUTOMATED MED INFO EXCHANGE INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure allows the creation of addenda to TIU Documents. ROUTINE: MAKEADD TIUSRVP ******************** 1806 NAME: TIU CREATE RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING DENTAL RECORD MANAGER VISUAL IMPAIRMENT SERVICE TEAM AUTOMATED MED INFO EXCHANGE INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) Effective with VPS*1*3 HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: APR 29,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure allows the creation of TIU DOCUMENT records. ROUTINE: MAKE TIUSRVP ******************** 1811 NAME: TIU DELETE RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL FUNCTIONAL INDEPENDENCE ORDER ENTRY/RESULTS REPORTING VISUAL IMPAIRMENT SERVICE TEAM HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure 1) A document in the CONSULTS class/DC can not be written unless it is linked to a Consult request 2) A document outside of the CONSULTS class/DC can not be associated with a consult 3) An addendum can not be linked to a consult request directly Deletes TIU Document records...Evaluates authorization. ROUTINE: DELETE TIUSRVP ******************** 1812 NAME: ORWPT DEMOG CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns common demographic information for a patient. ROUTINE: DEMOG ORWPT ******************** 1813 NAME: ORWPT GETVSIT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a visit file pointer and optionally creates a new visit. ROUTINE: GETVSIT ORWPT ******************** 1814 NAME: ORWU VALIDSIG CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** VISTA WEB WEB VISTA REMOTE ACCESS MANAGEME Added 10/2018 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Validates a broker encrypted electronic signature. ROUTINE: VALIDSIG ORWU ******************** 1815 NAME: ORWPT APPTLST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of appointments for a patient (for visit selection). ROUTINE: APPTLST ORWPT ******************** 1816 NAME: ORWU HOSPLOC CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com USAGE: Private ENTERED: MAR 24,2011 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure .Y=returned list, FROM=text to $O from, DIR=$O direction Sample return data: Y(1)="153^AAC-PROS" Y(2)="274^ALB-PRRTP" Y(3)="115^ALCOHOL" Y(4)="64^AUDIOLOGY" Y(6)="11^BCMA" Y(9)="143^BON-HBHC SOCIAL WORK" Returns a set of hospital locations for use in a long list box. ROUTINE: HOSPLOC ORWU ******************** 1817 NAME: ORWPT ADMITLST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE MENTAL HEALTH VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** JOINT LEGACY VIEWER Added as a subscriber for JLV release 2.6 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of admissions for a patient (for visit selection). ROUTINE: ADMITLST ORWPT ******************** 1819 NAME: ORWPT PSCNVT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Calls the pharmacy and lab order conversion routines. ROUTINE: PSCNVT ORWPT ******************** 1824 NAME: ORWD DT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: FUNCTIONAL INDEPENDENCE USAGE: Private ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a date in internal Fileman format. ROUTINE: DT ORWD ******************** 1834 NAME: TIU PRINT RECORD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Allows Printing of TIU Documents on demand. ROUTINE: RPC TIUPD ******************** 1835 NAME: TIU GET DOCUMENT PARAMETERS CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 29,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure returns the parameters by which a given document or document type is to be processed. ROUTINE: DOCPARM TIUSRVP1 ******************** 1836 NAME: ORWU NEWPERS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com CARE MANAGEMENT BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertig an. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. VISTA INTEGRATION ADAPTOR FEE BASIS CLAIMS SYSTEM HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a set of New Person file entries for use in a long list box. ROUTINE: NEWPERS ORWU ******************** 1837 NAME: ORWU DEVICE CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Private ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of print devices. ROUTINE: DEVICE ORWU ******************** 1838 NAME: ORWRA IMAGING EXAMS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns a list on imaging exams for a specific patient. ROUTINE: EXAMS ORWRA ******************** 1839 NAME: ORWRA REPORT TEXT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL HEALTH MANAGEMENT PLATFORM Effective with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns an array containing a formattied imaging report. This array matches exactly the report format on the roll 'n scroll version of CPRS. ROUTINE: RPT ORWRA ******************** 1840 NAME: ORWRP REPORT LISTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns a list of reports, Health Summary types and date ranges that can be displayed at the workstation. There are no input parameters fo this rpc. ROUTINE: LIST ORWRP ******************** 1841 NAME: ORWRP REPORT TEXT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE NATIONAL HEALTH INFO NETWORK NHIN will call the entry point RPT^ORWRP directly from a NHIN routine. VA POINT OF SERVICE (KIOSKS) The ORWRP REPORT TEXT RPC will be triggered by a request sent by the Vecna Kiosk system. IMAGING MAG*3.0*138 began using this ICR. The subscription will be used in Telepathology project allowing pathologists to view released reports in the Telepathology Worklist GUI application. VISTA WEB 10/2/13 DT: This is being requested because of patch WEBV*1.0*29. VistAWeb uses the RPC that is covered by the ICR 1841. However, it has been discovered that the ICR was never updated to include that usage. VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. JOINT LEGACY VIEWER Added as a subscriber for JLV 2.6 release USAGE: Controlled Subscri ENTERED: DEC 18,2009 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This rpc retrieves the report text for a report selected on the Report tab. the report format on the roll 'n scroll version of CPRS. ROUTINE: RPT ORWRP ******************** 1847 NAME: DBIA1847 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: NOV 21,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 21 ROOT: DIC(21, DESCRIPTION: TYPE: File DSS Extracts will reference the following data from the PERIOD OF SERVICE file (#21). ^DIC(21,D0,0) .03 CODE 0;3 Read w/Fileman ROUTINE: ******************** 1848 NAME: DBIA1848 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX DIETETICS PHARMACY BENEFITS MANAGEMENT MENTAL HEALTH Added 03/22/21, effective with Mental Health's Suicide Prevention Project, patch YS*5.01*135. USAGE: Controlled Subscri ENTERED: NOV 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File In addition to fields which are supported by DBIA 10039, DSS Extracts will reference the following data from the WARD LOCATION file (#42). The DSS Extracts UNIT DOSE EXTRACT DATA file (#728.904) contains a field, WARD, which is a pointer to the WARD LOCATION file (#42). DSS uses the "AINV" cross reference on the OUT-OF-SERVICE DATE(S) field. Global: ^DIC(42,D0,"OOS","AINV",INVERSE_DATE,DA) ^DIC(42,D0,"OOS", .01 OUT-OF-SERVICE DATE( 0;1 Direct Global Read & w .04 RETURN TO SERVICE DA 0;4 Direct Global Read & w .06 IS ENTIRE WARD OUT O 0;6 Direct Global Read & w DSS examines the OUT-OF-SERVICE DATE multiple (#200). The entire zero node is read into a local variable. The fields above are used. ^DIC(42, 400 G&L ORDER ORDER;1 Direct Global Read & w This field indicates the G&L Order that this Ward will print and subsequently, the Totals on the Bed Status Report, (e.g. Ward with a G&L Order of 1.5 would be placed after a Ward with a G&L Order of 1.49 or earlier and would be before a Ward with a G&L Order of 1.51 or greater). This G&L Order placement has a direct impact on the way the totals calculate on the Bed Status Report. .015 DIVISION 0;15 Direct Global Read & w DIC(42,' Direct Global Read & w This file contains all the facility ward locations and their related data, i.e., Operating Beds, Bedsection, etc. The wards are created/edited using the WARD DEFINITION option of the ADT module. ^DIC(42,D0,1, .01 TOTAL 0;1 Direct Global Read & w This field is the .01 field on the TOTALS multiple in the Ward Location file. ROUTINE: ******************** 1849 NAME: DBIA1849 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: NOV 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File DSS Extracts will point to the MEDICAL CENTER DIVISION file (#40.8). Most of the DSS extract files include a free text FACILITY field which contains a pointer to this file. Direct read of the 'B' Cross Reference is permitted. ^DG(40.8,D0,0) .01 NAME 0;1 Direct Global Read & w 3 OUTPATIENT ONLY 0;3 Direct Global Read & w Indicates if a a division has only Outpatient Services. Used by multi-divisional sites to track data by division on the DSS commercial system. The number is used to build feeder locations. ROUTINE: ******************** 1850 NAME: DBIA1850 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SURGERY CLINICAL REMINDERS INSURANCE CAPTURE BUFFER ADDED JUNE 2009 USAGE: Controlled Subscri ENTERED: NOV 26,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File In addition to fields which are supported by DBIA 10035, DSS Extracts references the following data from the PATIENT file (#2). Most of the DSS Extracts files contain a field, PATIENT NO. - DFN, which is a pointer to the PATIENT file (#2). This agreement now includes only the PREFERRED FACILITY field (#27.02). All other PATIENT file data is obtained by use of supported functionality in ^VADPT. ^DPT(D0,ENR) 27.02 PREFERRED FACILITY Read w/Fileman ROUTINE: ******************** 1851 NAME: DBIA1851 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 78.3 ROOT: RA(78.3, DESCRIPTION: TYPE: File The DSS Extracts RADIOLOGY EXTRACT file (#727.814) contains a field, DIAGNOSTIC CODE, which is a pointer to the DIAGNOSTIC CODES file (#78.3). ^RA(78.3,D0,0) .01 DIAGNOSTIC CODE 0;1 Direct Global Read & w ROUTINE: ******************** 1852 NAME: DBIA1852 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79.2 ROOT: RA(79.2, DESCRIPTION: TYPE: File DSS Extracts references the following data from the IMAGING TYPE file(#79.2). The DSS Extracts RADIOLOGY EXTRACT file (#727.814) contains a field, IMAGING TYPE, which is a pointer to the IMAGING TYPE file (#79.2). ^RA(79.2,D0,0) .01 TYPE OF IMAGING 0;1 Read w/Fileman This field contains the name of this type of imaging. 3 ABBREVIATION 0;3 Direct Global Read & w This is the abbreviation associated with this type of imaging. This field may also be read via VA FileMan. This file contains, for each imaging type entry, parameters that the module uses during various stages of exam and report processing and inquiring. The parameter switches allow the 'customizing' of the module for each type of imaging. ROUTINE: ******************** 1853 NAME: DBIA1853 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 131.7 ROOT: SRS( DESCRIPTION: TYPE: File DSS Extracts references the following data from the OPERATING ROOM file (#131.7). ^SRS(D0,2) 9 TYPE 2;1 Direct Global Read & w ROUTINE: ******************** 1854 NAME: DBIA1854 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 134 ROOT: SRO(134, DESCRIPTION: TYPE: File The DSS Extracts SURGERY EXTRACT file (#727.811) contains a field, OR TYPE, which is a pointer to the OPERATING ROOM TYPE file (#134). ^SRO(134,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1855 NAME: DBIA1855 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 137.45 ROOT: SRO(137.45, DESCRIPTION: TYPE: File DSS Extracts references the following data from the LOCAL SURGICAL SPECIALTY file (#137.45). ^SRO(137.45,D0,0) 1 NATIONAL SURGICAL SP 0;2 Direct Global Read & w ROUTINE: ******************** 1856 NAME: DBIA1856 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 3,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File DSS Extracts references the following data from the PTF file (#45). From the 501 multiple (45.02): ^DGPT(D0,M,D1,0) 5 ICD 1 0;5 Direct Global Read & w ^DGPT(D0,M,D1,P) 20 TRANSFER DRG P;1 Direct Global Read & w ROUTINE: ******************** 1857 NAME: DBIA1857 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.9 ROOT: DG(45.9, DESCRIPTION: TYPE: File DSS Extracts references the following data from the PAF file (#45.9). DSS uses the "AA" cross reference on the ASSESSMENT DATE field. Global: ^DG(45.9,"AA",DATE,D0) ^DG(45.9,D0,0) .01 NAME 0;1 Direct Global Read & w 2 ASSESSMENT DATE 0;2 Direct Global Read & w 7 DATE OF ADMISSION/TR 0;7 Direct Global Read & w DSS reads the entire zero node into a local variable. The above fields are used. ROUTINE: ******************** 1858 NAME: DBIA1858 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 72 ROOT: RA(72, DESCRIPTION: TYPE: File DSS Extracts references the following data from the EXAMINATION STATUS file (#72). ^RA(72,D0,0) 3 ORDER 0;3 Direct Global Read & w ROUTINE: ******************** 1859 NAME: DBIA1859 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79 ROOT: RA(79, DESCRIPTION: TYPE: File DSS Extracts references the following data from the RAD/NUC MED DIVISION file (#79). Direct global read of the 'B' cross reference is also permitted in file #79. ^RA(79,D0,0) .01 DIVISION 0;1 Direct Global Read & w ROUTINE: ******************** 1860 NAME: DBIA1860 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79.1 ROOT: RA(79.1, DESCRIPTION: TYPE: File The DSS Extracts RADIOLOGY EXTRACT file (#727.814) contains a field, IMAGING LOCATION, which is a pointer to the RADIOLOGY LOCATIONS file (#79.1). ^RA(79.1,D0,0) .01 LOCATION 0;1 Direct Global Read & w ROUTINE: ******************** 1861 NAME: DBIA1861 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX DSS EXTRACTS uses a FileMan read (EN^DIQ1) to obtain data from the ABBREVIATION field (#2). USAGE: Controlled Subscri ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 10 ROOT: DIC(10, DESCRIPTION: TYPE: File DSS Extracts references the following data from the RACE file (#10). ^DIC(10,D0,0) 2 ABBREVIATION 0;2 Direct Global Read & w This field contains the abbreviation for this race entry. ROUTINE: ******************** 1863 NAME: DBIA1863 CUSTODIAL PACKAGE: DENTAL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 220.5 ROOT: DENT(220.5, DESCRIPTION: TYPE: File DSS Extracts references the following data from the DENTAL PROVIDER file (#220.5). ^DENT(220.5,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1864 NAME: DBIA1864 CUSTODIAL PACKAGE: DENTAL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 4,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 225 ROOT: DENT(225, DESCRIPTION: TYPE: File DSS Extracts references the following data from the DENTAL SITE PARAMETERS file (#225). (Included in these references is a Direct Global Read of the 'B' Cross Reference.) ^DENT(225,D0,0) .01 STATION.DIVISION 0;1 Direct Global Read & w ROUTINE: ******************** 1865 NAME: DBIA1865 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX PHARMACY DATA MANAGEMENT ORDER ENTRY/RESULTS REPORTING MRSA INITIATIVE REPORTS NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD Virtual Patient Record (VPR), patch VPR*1*2,is using #1865 to get additional patient movement information beyond what VADPT provides; specifically,looking for the movements tied to an admission using the APCA index. HEALTH MANAGEMENT PLATFORM Data is extracted from the Patient Movement (#405) file and used as part of the patient sync that syncs the VistA data with the JSON Data System (JDS). This data is then used to create the patient record that is available to the users. Fields used by HMP are: Date/Time (#.01), Transaction (#.02), Attending Physician (#.19), Facility Treating Specialty (#.09) and Ward Location (#.06). HMP is also using the ATID1, APMV, B and C cross references to look up data in the file. ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File DSS Extracts points to and references the following data from the PATIENT MOVEMENT file (#405). Most of the DSS extract files include a MOVEMENT FILE # field which is a pointer to the PATIENT MOVEMENT file (#405). For the extract date range, DSS uses the following cross references: "ATID1" cross reference ^DGPM("ATID1",DFN,INVERSE_DATE,D0 "ATID2" cross reference ^DGPM("ATID2",DFN,INVERSE_DATE,D0 "ATID6" cross reference ^DGPM("ATID6",DFN,INVERSE_DATE,D0 "ATT1" cross reference ^DGPM("ATT1",DATE,D0 "ATT2" cross reference ^DGPM("ATT2",DATE,D0 "ATT3" cross reference ^DGPM("ATT3",DATE,D0 "ATT6" cross reference ^DGPM("ATT6",DATE,D0 "APCA" cross reference ^DGPM("APCA",DFN,CORRES_ADM,DATE,D0 "APMV" cross reference ^DGPM("APMV",DFN,CORRES_ADM,INVERSE_DATE,D0 "ATS" cross reference ^DGPM("ATS",DFN,CORRES_ADM,INVERSE_DATE, TREATING_SPECIALTY,D0 ^DGPM(D0,0) .01 DATE/TIME 0;1 Direct Global Read & w .02 TRANSACTION 0;2 Direct Global Read & w .03 PATIENT 0;3 Direct Global Read & w .06 WARD LOCATION 0;6 Direct Global Read & w .09 FACILITY TREATING SP 0;9 Direct Global Read & w .14 ADMISSION/CHECK-IN M 0;14 Direct Global Read & w .16 PTF ENTRY 0;16 Direct Global Read & w .17 DISCHARGE/CHECK-OUT 0;17 Direct Global Read & w .18 MAS MOVEMENT TYPE 0;18 Direct Global Read & w .19 ATTENDING PHYSICIAN 0;19 Direct Global Read & w .24 RELATED PHYSICAL MOV 0;24 Direct Global Read & w .04 TYPE OF MOVEMENT 0;4 Direct Global Read & w The zero node is read into a local variable. The fields above are used. The "B" and "C" x-ref may also be read directly. ^DGPM(D0,'USR') 100 ENTERED BY USR;1 Read w/Fileman 101 ENTERED ON USR;2 Read w/Fileman ROUTINE: ******************** 1867 NAME: DBIA1867 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: IFCAP USAGE: Private ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200 DESCRIPTION: TYPE: File This IA adds two fields to file 200 -- COMMERCIAL PHONE (# .135) and SUPPLY EMPLOYEE (# 400). These fields should be sent out any time file 200 is sent out as a full DD. No data should go with these fields. Any data at the sites in those fields should remain. ROUTINE: ******************** 1869 NAME: DBIA1869 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 720 ROOT: ECP( DESCRIPTION: TYPE: File DSS Extracts references the following data from the EVENT CAPTURE PROCEDURE file (#720). ^ECP(D0,0) .01 PROCEDURE NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1870 NAME: DBIA1870 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 720.1 ROOT: EC(720.1, DESCRIPTION: TYPE: File DSS Extracts references the following data from the EVENT CAPTURE LOG file (#720.1). ^EC(720.1,D0,0) 1 CONVERSION (V.2.0) D 0;2 Direct Global Read & w ROUTINE: ******************** 1872 NAME: DBIA1872 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 720.3 ROOT: ECJ( DESCRIPTION: TYPE: File DSS Extracts references the following data from the EC EVENT CODE SCREENS file (#720.3). In order to pass the correct version number to the Austin Automation Center, DSS Extracts examines the Event Capture DD as follows: I $D(^DD(720.3)) S ECVER= ^ECJ(D0,0) .01 EVENT CODE 0;1 Direct Global Read & w ROUTINE: ******************** 1873 NAME: DBIA1873 READ ACCESS TO FILE #721 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SPINAL CORD DYSFUNCTION MYHEALTHEVET USAGE: Controlled Subscri ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 721 ROOT: ECH( DESCRIPTION: TYPE: File DSS Extracts references the following data from the EVENT CAPTURE PATIENT file (#721). DSS checks for the existence of the EVENT CAPTURE PATIENT file (#721) to determine if Event Capture is in use prior to performing the extract (i.e., global ^ECH). DSS uses the "AC1" cross reference on the DATE/TIME OF PROCEDURE field. Global: ^ECH("AC1",LOCATION,DATE,DA) The Re-Engineered SPINAL CORD DYSFUNCTION application needs to acces the EVENT CAPTURE PATIENT file (#721) for reporting purposes. Spinal Cord needs the ability to look at a patient's CPT and ICD code history. MHV uses the "APAT" cross reference on the Procedure IEN, Date/Time of Procedure fields to get the IEN of Workload, ^ECH("APAT",Procedure IEN,Date/Time of Procedure fields,Workload IEN). Read-only access is granted for:- EVENT CAPTURE PATIENT file (# 721) ^ECH(D0,0) 2 DATE/TIME OF PROCEDURE 0;3 ^ECH(D0,"DX",D1,0) .01 SECONDARY ICD-9 CODE 0;1 ^ECH(D0,"P") 19 PCE CPT CODE P;1 20 PRIMARY ICD-9 CODE P;2 ^ECH("APAT") ^ECH(D0,0) 1 PATIENT 0;2 Direct Global Read & w 2 DATE/TIME OF PROCEDU 0;3 Direct Global Read & w 3 LOCATION 0;4 Direct Global Read & w 5 SECTION 0;6 Direct Global Read & w 6 DSS UNIT 0;7 Direct Global Read & w 7 CATEGORY 0;8 Direct Global Read & w 8 PROCEDURE 0;9 Direct Global Read & w 9 VOLUME 0;10 Direct Global Read & w 11 ORDERING SECTION 0;12 Direct Global Read & w 27 DSS ID 0;20 Direct Global Read & w 26 ASSOCIATED CLINIC 0;19 Direct Global Read & w DSS reads the entire zero node into a local variable. The above fields are used. ^ECH(D0,P) 19 PCE CPT CODE P;1 Direct Global Read & w 20 ICD-9 CODE P;2 Direct Global Read & w 21 AGENT ORANGE P;3 Direct Global Read & w 22 RADIATION EXPOSURE P;4 Direct Global Read & w 23 ENVIRONMENTAL CONTAM P;5 Direct Global Read & w 24 SERVICE CONNECTED P;6 Direct Global Read & w 25 SENT TO PCE P;7 Direct Global Read & w 35 MILITARY SEXUAL TRAU P;9 Direct Global Read & w 39 HEAD/NECK CANCER P;10 Direct Global Read & w 40 COMBAT VETERAN P;11 Direct Global Read & w DSS reads the entire P node into a local variable. The above fields are used. ^ECH(D0,MOD,D1,0) 36 CPT MODIFIER 0;1 Direct Global Read & w ^ECH(D0,DX,0) 38 SECONDARY ICD-9 CODE DX;0 Direct Global Read & w ^ECH( APAT "APAT" CROSS-REFEREN Direct Global Read & w ROUTINE: ******************** 1874 NAME: DBIA1874 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX MYHEALTHEVET USAGE: Controlled Subscri ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 725 ROOT: EC(725, DESCRIPTION: TYPE: File MHV Secure Messaging - Workload Credit HL7 Interface references NAME, NATIONAL NUMBER fields from the EC NATIONAL PROCEDURE file (#725). DSS Extracts references the following data from the EC NATIONAL PROCEDURE file (#725). The 'E' cross reference will also be referenced with a Direct global read. ^EC(725,"E",National Number, DA). ^EC(725,D0,0) .01 NAME 0;1 Direct Global Read & w 1 NATIONAL NUMBER 0;2 Direct Global Read & w 4 CPT 0;5 Direct Global Read & w The Current Procedural Terminology (CPT) code equivalent for this national or local procedure. The national or local procedure pointer to the CPT file (#81). This file contains a set of nationally defined procedures for use in the Event Capture software. These procedures are necessary for data collection in DSS that are not represented in the CPT file (#81). These procedures were defined by the Decision Support System (DSS) Program Office or its designee. Entries in this file are standard procedures that should not be edited or deleted. Options exist within the Event Capture Management Menu that provide users the tools to add locally recognized procedures to this file. These local entries will be added, by the using the Event Capture software, at internal entry number above 90,000. This file should NOT be modified directly using VA FileMan. ROUTINE: ******************** 1875 NAME: DBIA1875 CUSTODIAL PACKAGE: EVENT CAPTURE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 5,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 726 ROOT: EC(726, DESCRIPTION: TYPE: File DSS Extracts points to and references the following data from the EVENT CAPTURE CATEGORY file (#726). The DSS Extracts EVENT CAPTURE LOCAL EXTRACT file (#727.815) contains a field, CATEGORY, which is a pointer to the EVENT CAPTURE CATEGORY file (#726). ^EC(726,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1876 NAME: DBIA1876 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX PHARMACY BENEFITS MANAGEMENT Actually only needs to reference field .01. CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: DEC 6,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59 ROOT: PS(59, DESCRIPTION: TYPE: File The DSS PRESCRIPTION EXTRACT file (#727.81) contains the DIVISION field (9) which is a pointer to the OUTPATIENT SITE file (#59). Direct global read of the 'B' Cross Reference is permitted into this file. ^PS(59,D0,0) .01 NAME 0;1 Direct Global Read & w .06 SITE NUMBER 0;6 Direct Global Read & w This field is used to show the site/station number. ^PS(59,D0,INI) 100 RELATED INSTITUTION INI;1 Direct Global Read & w This field is a pointer to the Institution file [^DIC(4,]. ROUTINE: ******************** 1877 NAME: DBIA1877 CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: DEC 10,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 213.3 ROOT: NURSF(213.3, DESCRIPTION: TYPE: File The DSS Extracts NURSING EXTRACT file (#727.805) contains a field, NURSING BEDSECTION, which is a pointer to the NURS AMIS WARD file (#213.3). ^NURSF(213.3,D0,0) .01 BED SECTION 0;1 Direct Global Read & w ROUTINE: ******************** 1878 NAME: DBIA1878 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 11,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Open subscription for Outpatient Pharmacy prescription data. ROUTINE: PSOORDER COMPONENT: EN(DFN,RX#) VARIABLES: DFN Type: Input This variable is the patient's internal entry number from the Patient file (#2). This variable is optional. If the internal entry number is not sent, then a null value must be passed in it's place. RX# Type: Input This variable is the internal entry number of a prescription. This number either comes from the Pharmacy Patient file (#55), Prescription Profile sub-file which requires a separate DBIA. Return Outpatient Prescriptions: Open Subscription (Supported). Requires version 7 of Outpatient Pharmacy software installed. Entry Point: EN^PSOORDER(DFN,RX#) Passed: DFN: Internal entry number for patient in Patient file (#2). DFN is optional. A null value must be passed in it's place. RX#: Internal entry number for prescription in Prescription file (#52). Returned: ^TMP("PSOR",$J,RXN,0)=ID^FD^LSFD^ST^RX#^QTY^DS^RF^RFM^DRCT^RXC T^EXDT^RELDT^RTSDT^WPC^PAT^LDT RXN = Internal Rx # ID = Issue date of Rx FD = Fill date of Rx. LSFD = Last fill date of Rx ST = Status of Rx. This variable has the format A;B where: A = code B = external printable form, (e.g., A for ACTIVE, DC for discontinued) If status of prescription equals Hold: ^TMP("PSOR",$J,RXN,"HOLD",0)=HDRS^HDCOM^HDDT HDRS = Hold Reason, HDCOM = Hold Comments, HDDT = Hold Date If status of prescription equals Suspended or has had an entry in the Suspense file (#52.5) ^TMP("PSOR",$J,RXN,"SUS",0)=PRT^CMIND PRT = Printed Status: Printed, or Not Printed CMIND = CMOP Indicator. Data will only appear in this field if sites has the CMOP package installed and in use. Q = Queued for Transmission, X = Transmission Completed, L = Loading for Transmission, P = Printed Locally RX# = External Rx number QTY = Quantity Dispensed DS = Day Supply RF = Number of refills RFM = Number of refills remaining DRCT = Drug Cost of Original Fill RXCT = Cost of Original Fill EXDT = Expiration/Cancel date of Rx RELDT = Release Date/Time RTSDT = Returned to Stock Date WPC = Was Patient Counseled - (Yes/No) PAT = Patient. This variable has the format A;B where A is the internal pointer and B is the external printable form. LDT = This date is the date the original Rx was added to the prescription file (#52). Login Date. ^TMP("PSOR",$J,RXN,1)= PR^CLK^VRP^CLN^RXP^MW^DIV^OERR#^FP^NDC^TPBRX PR = Provider. This variable has the format A;B where A is the internal pointer and B is external printable form. CLK = Entered By (clerk code). This variable has the format A;B where A is the internal pointer and B is external printable form. VRP = Verifying Pharmacist. This variable has the format A;B where A is the internal pointer and B is external printable form. CLN = Clinic. This variable has the format A;B where A is the internal pointer and B is external printable form. Data comes from file #44. RXP = Rx Patient Status. This variable has the format A;B where A is the internal pointer and B is external printable form. M/W = Mail/Window Routing. This variable has the format A;B where A is the code and B is external printable form. DIV = Pointer to Outpatient Site file (#59). OERR# = Order number that points to the CPRS Orders file (#100). FP = Finishing Person. This variable has the format A;B where A is the internal pointer and B is external printable form. NDC = National Drug Code. TPBRX = This variable indicates that the Rx has been created as part of the Transitional Pharmacy Benefit project. CMOP Data: If applicable ^TMP("PSOR",$J,RXN,"CMOP",n,0)=TRANS #^SEQ #^FILL #^CMSTA^CMDCDT^NDC TRANS # = Transaction number. Pointer value to the CMOP Transmission file (#550.2). SEQ # = Sequence number. This number represents the order number sent to the CMOP Host facility. Fill # = Fill #. 0 for original, 1-11 for refills. CMSTA = CMOP Status. This variable has the format A;B where A is the internal pointer and B is external printable form. CMDCDT = CMOP cancel date NDC = National Drug file Code - free text ^TMP("PSOR",$J,RXN,"CMOP",1,1,0)=CMDC REASON CMDC REASON = CMOP cancel reason. note: CMDCDT and CMDC REASON fields are only populated if CMSTA equals 3. Drug Data: ^TMP("PSOR",$J,RXN,"DRUG",0)= DR^VA PRINT NAME^DRUG ID^VA DRUG CLASS DR = Drug in Rx. This variable has the format A;B where A is the internal pointer and B is external printable form. VA Print Name = VA Print name found in NDF DRUG ID = National drug ID found in NDF VA DRUG CLASS = VA DRUG CLASSIFICATION ^TMP("PSOR",$J,RXN,"DRUGOI",0)= ORDERABLE ITEM ORDERABLE ITEM = Pharmacy Orderable Item tied to drug in Rx. This variable has the format A;B where A is the internal pointer and B is external printable form concatenated with dose form, i.e., ASPIRIN TAB. Copay: If applicable ^TMP("PSOR",$J,RXN,"IB",0)=COPAY TRANSACTION TYPE^IB NUMBER) COPAY TRANSACTION TYPE = 1 or 2 IB NUMBER = IB pointer number Refills: ^TMP("PSOR",$J,RXN,"REF",n,0)=RFD^PR^CLK^QTY^DS^DRCT^RXCT^RELD T^RTSDT^M/W^DIV^LDT^NDC RXN = Internal Rx # RFD = Refill Date PR = Provider. This variable has the format A;B where A is the internal pointer and B is external printable form. CLK = Refill entry by. This variable has the format A;B where A is the internal pointer and B is external printable form. QTY = Quantity Dispensed DS = Day Supply DRCT = Drug Cost of Refill RXCT = Cost of Refill RELDT = Release Date/Time RTSDT = Returned to Stock Date M/W = Mail/Window Routing. This variable has the format A;B where A is the code and B is external printable form. DIV = Pointer to Outpatient Site file (#59). LDT = This date indicates the date the refill was requested. This is not the date the refill will be dispensed (Login Date). NDC = National Drug Code Partial Fills: ^TMP("PSOR",$J,RXN,"RPAR",n,0)=PRD^PR^CLK^QTY^DS^DRCT^RXCT^REL DT^RTSDT^M/W^DIV^LDT^NDC RXN = Internal Rx # PRD = Partial Date PR = Provider. This variable has the format A;B where A is the internal pointer and B is external printable form. CLK = Refill entry by. This variable has the format A;B where A is the internal pointer and B is external printable form. QTY = Quantity Dispensed DS = Day Supply DRCT = Drug Cost of partial RXCT = Cost of partial RELDT = Release Date/Time RTSDT = Returned to Stock Date M/W = Mail/Window Routing. This variable has the format A;B where A is the code and B is external printable form. DIV = Pointer to Outpatient Site file (#59). LDT = This date indicates the date the partial fill was created (Login Date). NDC = National Drug Code Activity Log: ^TMP("PSOR",$J,RXN,"ACT",n,0)=D/T^REA^NEW PERSON^RX #^COMMENTS D/T = Date/Time entry made REA = Reason entry was made New Person = Entry created by RX # = Which fill the activity occurred on (original, refill, partial). Comments = Comments about the Activity that occurred. Medication Instructions: ^TMP("PSOR",$J,RXN,"SIG",n,0)= Condensed Medication Instructions (SIG) ^TMP("PSOR",$J,RXN,"SIG1",n,0)= Expanded Medication Instructions (SIG) Dispensing Instructions: ^TMP("PSOR",$J,RXN,"MI",N,0)=DOSAGE^DOSE^UNITS^NOUN^DURATION^C ONJUNCTION^MRT^SCH^VERB DOSAGE = This is the strength of the medication dispensed. This variable can be a numeric value or free-text. DOSE = This numeric value represents the total number of pills to make a total dosage. This value is only returned when the dosage is numeric. UNITS = This data element is the unit of measure the medication is dispense. This variable has the format A;B where A is the internal pointer and B is external printable form. NOUN = This data element indicates the form the medication was dispensed, i.e., tablet. DURATION = This indicates how long this dosage should be taken. CONJUNCTION = This data element is used for complex dosaging instructions. MRT = This data element indicates how the medication is ingested (medication route). This variable has the format A;B where A is the internal pointer and B is external printable form. SCH = This data indicates when the medication is taken (schedule). VERB = This data element indicates what action is taken to ingest the medication. Patient Instructions: ^TMP("PSOR",$J,RXN,"PI",n,0)=EXPANDED PATIENT INSTRUCTIONS The ^TMP("PSOR",$J) is killed each time the entry point is called. It will be the responsibility of each developer to kill the ^TMP("PSOR",$J) global and the DFN and Rx # variables when finished. ******************** 1880 NAME: DBIA1880 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: DEC 12,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6, DESCRIPTION: TYPE: File DSS Extracts references the following data from the IV ADDITIVES file (#52.6). This reference is used ONLY for the small number of sites who are still running a version of Inpatient Meds prior to version 4.5. For version 4.5 (or greater), this information comes from the IV EXTRACT DATA holding file (#728.113) which is populated by PSIVSTAT. ^PS(52.6,D0,0) 1 GENERIC DRUG 0;2 Direct Global Read & w ROUTINE: ******************** 1882 NAME: ACCESS TO ECXPIV1 CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 12,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DSS Extracts needs data from the Inpatient Medications package which cannot be extracted from any file. The IV team has modified routine PSIVSTAT to call, after executing %ZOSF("TEST"), routine ECXPIV1 to move data into a DSS file for future extract by DSS. The requested data is placed in the ECUD variable, which the ECXPIV1 routine uses to store the data in the IV EXTRACT DATA file (#728.113). ROUTINE: ECXPIV1 COMPONENT: VARIABLES: ECUD Type: Output Variable ECUD contains the following pieces of data: 1. Patient for whom drug was dispensed. 2. Order number. 3. The drug dispensed. 4. Date drug dispensed. 5. Transaction type. 6. Additive strength. 7. Additive strength units. 8. Solution volume. 9. Provider who order the drug. 10. Type. 11. Cost of units dispensed. 12. Clinic Location if available for Out Patients. 13. Order Start Date/Time. 14. IV Room associated with this order. 15. Date/time verified by the nurse. If not available, this will be the login date/time of the order. ******************** 1884 NAME: DBIA1884 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX DRUG ACCOUNTABILITY USAGE: Controlled Subscri ENTERED: DEC 13,1996 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.5 ROOT: PS(59.5, DESCRIPTION: TYPE: File DSS Extracts references the following data from the IV ROOM file (#59.5). This agreement will be restricted to only Pharmacy packages after 12/31/2006. Please do not add any additional code that utilizes this Integration Agreement. An API has been created that can be used in place of any code needing to make use of this agreement. This API was released with patch PSJ*5*163. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with this API, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. ^PS(59.5,D0,0) .01 NAME 0;1 Direct Global Read & w .02 DIVISION 0;4 Write w/Fileman This field contains the pointer to the MEDICAL CENTER DIVISION file (#40.8). The division should be the one where the IV Room is located. This field is populated by an option on the DSS menu. It is solely for use by the DSS software and has no impact on Pharmacy at this time. Direct Global Read is also permitted into this field. ^PS(59.5,D0,I) 19 INACTIVATION DATE I:1 Direct Global Read & w ROUTINE: ******************** 1886 NAME: DBIA1886-A CUSTODIAL PACKAGE: HOME BASED PRIMARY CARE SUBSCRIBING PACKAGE: PATIENT FEEDBACK USAGE: Private ENTERED: JAN 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 631 ROOT: HBHC(631, DESCRIPTION: TYPE: File The "AC" cross-reference will be used to find HBHC patients discharged within a date range. ^HBHC(631,D0,0) .01 NAME 0;1 Direct Global Read & w 14 ADMIT/REJECT ACTION 0;15 Direct Global Read & w 17 ADMISSION DATE 0;18 Direct Global Read & w 39 DISCHARGE DATE 0;40 Direct Global Read & w ^HBHC(631,D0,1) 67 CASE MANAGER 1;13 Direct Global Read & w ROUTINE: ******************** 1887 NAME: DBIA1886-B CUSTODIAL PACKAGE: HOME BASED PRIMARY CARE SUBSCRIBING PACKAGE: PATIENT FEEDBACK USAGE: Private ENTERED: JAN 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 631.4 ROOT: HBHC(631.4, DESCRIPTION: TYPE: File ^HBHC(631.4,D0,0) 1 PROVIDER NAME 0;2 Direct Global Read & w ROUTINE: ******************** 1888 NAME: DBIA1888 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File The Lab Emerging Pathogen Initiative is requesting a integration agreement to reference to two fields in the PTF file (#45) PTF file (#45) ^DGPT(D0,300) = (#300.03) LEGIONNAIRE'S DISEASE ^DGPT(D0,"M",D1,300) = (#300.03) LEGIONNAIRE'S DISEASE ^DGPT(D0,300) 300.03 LEGIONNAIRE'S DISEAS PIECE 3 Direct Global Read & w ^DGPT(D0,M,D1,300) 300.03 LEGIONNAIRE'S DISEAS PIECE 3 Direct Global Read & w ROUTINE: ******************** 1889 NAME: ADD/EDIT/DELETE PCE DATA SILENTLY CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SURGERY RADIOLOGY/NUCLEAR MEDICINE AUTOMATED INFO COLLECTION SYS LAB SERVICE EVENT CAPTURE ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES SCHEDULING INTEGRATED BILLING PROSTHETICS DENTAL CLINICAL PROCEDURES OUTPATIENT PHARMACY QUASAR REGISTRATION VISUAL IMPAIRMENT SERVICE TEAM MENTAL HEALTH JSHARVEY 20061128/Added MH as subscriber as per Fain. EMERGENCY DEPARTMENT ADDED 10/10/2008 BAR CODE MED ADMIN ADDED 8/28/09 ADVANCED PROSTHETICS ACQUISITION Added 8/14/18. USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PURPOSE: Provide a utility for ancillary packages such as Laboratory, Surgery, Medicine, Radiology, Text Integration Utility (TIU) and Computerized Patient Record System (CPRS) to non- interactively (silently) add/edit/delete data, including encounter, provider, diagnosis and procedure information. Dr. Kizer's 10/1/96 mandate which requires a provider, a procedure and a diagnosis to positively document the occurrence of an encounter, and the resulting change to use this data rather than stop codes to document workload and initiate third party billing, necessitated the development of an application programmer interface (API) which would support the mandated requirements. PCE was tasked with developing the API. $$DATA2PCE^PXAPI was developed to enable the adding, editing and deletion of encounter, provider, diagnosis and procedure data. Data will be stored in the Visit and V files and will be posted on the PXK VISIT DATA EVENT for use by subscribing packages such as Scheduling. This document includes: 1. Definitions and Conventions used to describe the API. 2. Description of $$DATA2PCE^PXAPI, its parameter definitions, and the returned values. 3. A table which describes the subscripts used for passing data to PCE. 4. An example array for passing data to PCE. DEFINITIONS AND CONVENTIONS: Listed below are definitions and conventions used to describe this API. 1. Valid data values: [ 1 | 0 | null ] `1' Denotes TRUE or YES `0' Denotes FALSE or NO null Denotes VALUE NOT KNOWN 2. Counter "i" is used as a subscript. It denotes a sequence number, i.e., 1, 2, 3. To denote deletion of a data ITEM, pass the "@" symbol as the data value in the node for the item being deleted. You may not delete required data items. 4. To denote deletion of an ENTRY, pass "1" as the data value in the "DELETE" node of the identified entry. $$DATA2PCE^PXAPI(INPUT_ROOT,PKG,SOURCE,.VISIT,USER,ERRDISP,.ERRARRAY,PPEDIT, .ERRPROB,.ACCOUNT) This is a function which will return a value identifying the status of the call. Data that is processed by PCE will be posted on the PXK VISIT DATA EVENT protocol. Parameter Description: 1. INPUT_ROOT: (required) Where INPUT_ROOT is a unique variable name, either local array or global array, which identifies the defined data elements for the encounter. An example of an INPUT_ROOT is ^TMP("LRPXAPI",$J) or ^TMP("RAPXAPI",$J). The gross structure of the array includes four additional subscripts (ENCOUNTER, PROVIDER, DX/PL, PROCEDURE and STOP) for defining the data passed. A detailed description of this array and its structure are included below in a table format. 2. PKG: (required) Where PKG is a pointer to the Package File (9.4). 3. SOURCE: (required) Where SOURCE is a string of text (3-30 character) identifying the source of the data. The text is the SOURCE NAME field (.01) of the PCE Data Source file (839.7). If the SOURCE currently does not exist in the file, it will be added. Examples of SOURCE are: "LAB DATA" or "RADIOLOGY DATA" or "PXCE DATA ENTRY" or "AICS ENCOUNTER FORM." 4. VISIT: (optional) Where VISIT is a pointer to the Visit file (9000010) which identifies the encounter which this data must be associated with. If the pointer to the Visit file does not match data passed in INPUT_ROOT then this DBIA will return negative value '-3', see the Returned Value description below. If the pointer value to the Visit is saved, it is necessary to also subscribe to IA 1902. 5. USER: (optional) User who is responsible for add/edit/delete action on the encounter. Pointer to the New Person file (200). If USER is not defined, DUZ will be used. 6. ERRDISP: (optional) To display errors during development, this variable may be set to "1". If it is defined the errors will be displayed on screen when the error occurs. If ERRDISP is not defined, errors will be posted on the defined INPUT_ROOT subscripted by "DIERR". BLD^DIALOG is used to manage errors. Review BLD^DIALOG and MSG^DIALOG descriptions included in the FileMan v. 22.0 Programmer Manual on pages 2-33 to 2-38. 7. ERRARRAY: (optional) A dotted variable name. When errors and warnings occur, the array will contain the PXKERROR array elements to the caller. 8. PPEDIT: (optional) Set to 1 if you want to edit the Primary Provider. Only use for the moment that editing is being done. 8. ERRPROB: (optional) A dotted variable name. When errors and warnings occur, they will be passed back in the form of an array with the general description of the problem. 8. ACCOUNT: (optional) A dotted variable name. Where ACCOUNT is the PFSS Account Reference associated with the data being by the calling application. Each PFSS Account represents an internal entry number in the PFSS ACCOUNT file (#375). Returned Value: 1 If no errors occurred and data was processed. -1 An error occurred. Data may or may not have been processed. If ERR_DISPLAY is undefined, errors will be posted on the INPUT_ROOT subscripted by "DIERR". -2 Unable to identify a valid VISIT. No data was processed. -3 API was called incorrectly. No data was processed. It is advisable to verify a Return Value for confirmation if the passed data was processed or not, also if this DBIA is called in background. ENCOUNTER: All data must be associated with an entry in the VISIT file (#9000010). Only one "ENCOUNTER" node may be passed with each call to $$DATA2PCE^PXAPI. The "ENCOUNTER" node documents encounter specific information and must be passed: 1. To create an entry in the VISIT file (9000010). All provider, diagnosis and procedure data is related to an entry in the VISIT file. 2. To enable adding, editing or deleting "ENCOUNTER" node data elements. When encounter data elements are not added, edited or deleted, the VISIT parameter may be passed in lieu of defining an "ENCOUNTER" node. SUBSCRIPT DESCRIPTION: "ENCOUNTER",1,"ENC D/T") Required This is the encounter date/ time for primary encounters or the date for occasions of service. If the encounter is related to an appointment, this is the appointment date/time. If this is an occasion of service created by an ancillary package, this is the date/time of the instance of care. Imprecise dates are allowed for historical encounters. Encounter date/time may be added, but not edited. *Deletions of encounters can occur only when nothing is pointing to the encounter. *"ENC D/T" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the VISIT/ADMIT DATE&TIME field (#.01) in the Visit file of the vistit IEN passed as the VISIT parameter. Only matching values will be accepted and if on match occurs then '-3' will be retured, see the Returned Value above. Format: FileMan Internal Format for date/time "ENCOUNTER",1,"PATIENT") Required This is the patient DFN. This cannot be edited or deleted. *"PATIENT" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the PATIEN NAME field (# .05) in the Visit file of the visit IEN passed as the VISIT parameter. Only matching values will be accepted and if on match occurs then -3 will be returned, see the Returned Value above. Format: Pointer to IHS Patient file (9000001) This file is Dinumed to the Patient file (2) "ENCOUNTER",1,"HOS LOC") Required This is the hospital location where the encounter took place for primary encounters, or this is the ordering location for ancillary encounters. *"HOS LOC" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the HOSPITAL LOCATION filed (#.22) in the Visit file of the visit IEN passed as the VISIT parameter. Only matching values will be accepted and if no match occurs then '-3' will be returned, see the Returned Value above. Format: Pointer to Hospital Location file (44) "ENCOUNTER",1,"OUTSIDE LOCATION") Optional This is an outside location of an encounter, not included in the INSTITUTION file. The OUTSIDE LOCATION should exclude the INSTITUTION: "ENCOUNTER",1,"INSTITUTION") and the INSTITUTION should exclude the OUTSIDE LOCATION. Format: Free text (2-245 characters) "ENCOUNTER",1,"INSTITUTION") Optional This is the Institution where the encounter took place. If it is not defined, the division defined for the Hospital Location is used. If that is not defined, $$SITE^VASITE is used. Format: Pointer to IHS Location file (9999999.06). This file is dinumed to the Institution file (4). "ENCOUNTER",1,"SC") Optional This encounter is related to a service connected condition. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CV") Optional This encounter is related to Combat Veteran Format: [ 1 | 0 | null ] "ENCOUNTER",1,"AO") Optional This encounter is related to Agent Orange exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"IR") Optional This encounter is related to Ionizing Radiation exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"EC") Optional This encounter is related to Environmental Contaminant exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"SHAD") Optional This encounter is related to Project 112/SHAD Format: [ 1 | 0 | null ] "ENCOUNTER",1,"MST") Optional This encounter is related to Military Sexual Trauma. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"HNC") Optional This encounter is related to Head & Neck Cancer. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CLV") Optional This encounter is related to Camp Lejeune. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CHECKOUT D/T") Optional This is the date/time when the encounter was checked out. Format: FileMan Internal Format for date/time "ENCOUNTER",1,"ELIGIBILITY") Optional This is the eligibility of the patient for this encounter. Format: Pointer to Eligibility Code file (8) "ENCOUNTER",1,"APPT") Optional This is the appointment type of the encounter. Format: Pointer to Appointment Type file (409.1) "ENCOUNTER",1,"SERVICE CATEGORY") Required This denotes the type of encounter. Format: Set of Codes. A::=Ambulatory Should be used for clinic encounters. "A" s are changed to "I" s by Visit Tracking if patient is an inpatient at the time of the encounter. H::=Hospitalization Should be used for an admission. I::=In Hospital C::=Chart Review T::=Telecommunications N::=Not Found S::=Day Surgery E::=Event (Historical) Documents encounters that occur outside of this facility. Not used for workload credit or 3rd party billing. R::=Nursing Home D::=Daily Hospitalization Data X::=Ancillary Package Daily Data. "X" s are changed to "D" s by Visit Tracking if patient is an inpatient at the time of the encounter. "ENCOUNTER",1,"DSS ID") Optional This is required for ancillary occasions of service such as laboratory and radiology or telephone encounters Format: Pointer to Clinic Stop file (40.7) "ENCOUNTER",1,"ENCOUNTER TYPE") Required This identifies the type of encounter, e.g., primary encounter, ancillary encounter, etc. A "Primary" designation indicates that the encounter is associated with an appointment or is a standalone. Examples of ancillary encounters include Laboratory and Radiology instances of care. Format: Set of Codes. P::=Primary O::=Occasion of Service S::=Stop Code A::=Ancillary Ancillary packages such as Laboratory and Radiology Should pass an "A" C::=Credit Stop If the visit number is included in passed parameters then the passed code will be checked against the ENCOUNTER TYPE field (#15003) in the Visit file of the visit IEN passed as VISIT parameter. Only matching values will be accepted and if no match occurs then '-3' will be returned, see the Returned Value above. "ENCOUNTER",1,"PARENT") Optional This is the parent encounter for which the ENCOUNTER is a supporting encounter. For example, this would be the primary encounter for which this occasion of service supports and should be associated. Format: Pointer to Visit file (9000010). "ENCOUNTER",1,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "ENCOUNTER",1,"DELETE") Optional This is a flag that denotes deletion of the encounter entry. Encounter will not be deleted if other data is pointing to it. Format: [ 1 | null ]| PROVIDER: The "PROVIDER" node may have multiple entries (i) and documents the provider, indicates whether he/she is the primary provider, and indicates whether the provider is the attending provider. Comments may also be passed. To delete the entire "PROVIDER" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PROVIDER",i,"NAME") Required Provider's IEN. Format: Pointer to NEW PERSON file (200) "PROVIDER",i,"PRIMARY") Optional Indicator that denotes this provider as the "primary" provider. Format: [ 1 | 0 | null ] "PROVIDER",i,"ATTENDING") Optional Indicator that denotes this provider as the attending provider. Format: [ 1 | 0 | null ] "PROVIDER",i,"COMMENT") Optional Comment Format: Free text (1 - 245 characters) "PROVIDER",i,"DELETE") Optional This is a flag that denotes deletion of the Provider entry. Format: [ 1 | null ]| DX/PL: The "DX/PL" node may have multiple entries (i) and documents diagnoses and/or problems. Only active ICD-9-CM codes will be accepted. The "DX/PL" node adds diagnoses to the PCE database as well as adding an active or inactive diagnosis or problem to the Problem List. If a diagnosis or problem already exists on the Problem List, this node may be used to inactivate it. To delete the entire "DX/PL" entry from PCE (not Problem List), set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "DX/PL",i,"DIAGNOSIS") Required for PCE Optional for PL Diagnosis code Format: Pointer to ICD9 Diagnosis file (80) "DX/PL",i,"PRIMARY") Optional for PCE N/A for PL Code that specifies that the diagnosis is the "primary" diagnosis for this encounter. Only one "primary" diagnosis is recorded for each encounter. Format: "P"::=Primary "1"::=Primary "S"::=Secondary "0"::=Secondary "DX/PL",i,"ORD/RES") Optional for PCE N/A for PL Code that specifies that the diagnosis is either an "ordering diagnosis or is a "resulting diagnosis or "both for this encounter. Format: "O ::=Ordering "R ::=Resulting "OR ::=Both Ordering and Resulting "DX/PL",i,"LEXICON TERM") Optional for PCE Optional for PL This is a term that is contained in the Clinical Lexicon. Format: Pointer to the Expressions file (757.01) "DX/PL",i,"PL IEN") Optional for PCE *Optional for PL This is the problem IEN that is being acted upon. *This node is required to edit an existing problem on the Problem List. Format: Pointer to Problem List file (9000011) "DX/PL",i,"PL ADD") N/A for PCE *Optional for PL *This is required to Add a diagnosis/problem to the Problem List. "1" indicates that the entry should be added to the Problem List. Format: [ 1 | 0 | null ] "DX/PL",i,"PL ACTIVE") N/A for PCE Optional for PL This documents whether a problem is active or inactive. The Default is Active if not specified. Format: Set of Codes. A::=Active I::=Inactive "DX/PL",i,"PL ONSET DATE") N/A for PCE Optional for PL The date that the problem began. Format: FileMan Internal Format for date. "DX/PL",i,"PL RESOLVED DATE") N/A for PCE Optional for PL The date that the problem was resolved. Format: FileMan Internal Format for date. "DX/PL",i,"PL SC") Required for PCE Optional for PL This problem is related to a service connected condition. Format: [ 1 | 0 | null ] "DX/PL",i,"PL CV") Required for PCE Optional for PL This problem is related to Combat Veteran Format: [ 1 | 0 | null ] "DX/PL",i,"PL AO") Required for PCE Optional for PL This problem is related to Agent Orange exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL IR") Required for PCE Optional for PL This problem is related to Ionizing Radiation exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL SHAD") Required for PCE Optional for PL This problem is related to Project 112/SHAD Format: [ 1 | 0 | null ] "DX/PL",i,"PL EC") Required for PCE Optional for PL This problem is related to Environmental Contaminant exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL MST") Required for PCE Optional for PL This problem is related to Military Sexual Trauma. Format: [ 1 | 0 | null ] "DX/PL",i,"PL HNC") Required for PCE Optional for PL This problem is related to Head and/or Neck Cancer Format: [ 1 | 0 | null ] "DX/PL",i,"PL CLV") Required for PCE Optional for PL This problem is related to Camp Lejeune. Format: [ 1 | 0 | null ] "DX/PL",i,"NARRATIVE") *Optional for PCE *Optional for PL The provider's description of the diagnosis/problem. *If NARRATIVE is not passed for a diagnosis/problem, the Description from the ICD Diagnosis file (80) will be used as the default. Format: Free text (2-245 characters) "DX/PL",i,"CATEGORY") Optional for PCE N/A for PL A term that denotes a grouping or category for a set of related diagnosis/problem. Format: Free text (2-245 characters) "DX/PL",i,"ENC PROVIDER") Optional for PCE *Optional for PL Provider who documented the diagnosis/problem. *This is required to Add a diagnosis/problem to the Problem List. Format: Pointer to New Person file (200) "DX/PL",i,"EVENT D/T") Optional for PCE N/A for PL Date/Time Diagnosis was documented. Format: FileMan Internal Format for date/time "DX/PL",i,"COMMENT") Optional for PCE *Optional for PL Comment Format: PCE Free Text (1-245 char) PL Free Text (3-60 char) "DX/PL",i,"DELETE") Optional for PCE N/A for PL This is a delete flag used to denote deletion of the diagnosis entry. Format: [ 1 | null ]| PROCEDURE: The "PROCEDURE" node may have multiple entries (i). Only active CPT/HCPCS codes will be accepted. The "PROCEDURE" node documents the procedure(s), the number of times the procedure was performed, the diagnosis the procedure is associated with and the narrative that describes the procedure. It also enables documentation of the provider who performed the procedure, the date/time the procedure was performed and any comments that are associated with the procedure. To delete the entire "PROCEDURE" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PROCEDURE",i,"PROCEDURE") Required Procedure code Format: Pointer to CPT file (81) "PROCEDURE",i,"MODIFIERS",MODIFIER)="" Optional CPT Modifier(s) Format: external form. Any number of modifiers may be listed. "PROCEDURE",i,"QTY") Required Number of times the procedure was performed. Format: Whole number > 0 "PROCEDURE",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified procedure and is the primary diagnosis associated with this procedure. Format: Pointer to ICD Diagnosis file (80) "PROCEDURE",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified procedure. Format: Pointer to ICD Diagnosis file (80) "PROCEDURE",i,"NARRATIVE") *Optional The provider's description of the procedure performed. *If NARRATIVE is not passed for a procedure, the Short Name from the CPT file (81) will be used as the default. Format: Free text (2-245 characters) "PROCEDURE",i,"CATEGORY") Optional A term that denotes a grouping or category for a set of related procedures. Format: Free text (2-245 characters) "PROCEDURE",i,"ENC PROVIDER") Optional Provider who performed the procedure. Format: Pointer to New Person file (200) "PROCEDURE",i,"ORD PROVIDER") Optional Provider who ordered the procedure. Format: Pointer to New Person file (200) "PROCEDURE",i,"ORD REFERENCE") Optional Order reference for the ordered procedure. Format: Pointer to the Order file (100) "PROCEDURE",i,"EVENT D/T") Optional Date/Time procedure was done. Format: FileMan Internal Format for date/time "PROCEDURE",i,"DEPARTMENT") Optional A 3-digit code that defines the service area. Missing Department Codes will be assigned a Department Code. The Department Code will be the Stop Code associated (in the HOSPITAL LOCATION file, #44) with the Hospital Location of the patient visit. If no Department Code can be established, a 999 will be passed to the PFSS Cache. Format: Set of Codes. 1::=Poor 2::=Fair 3::=Good 4::=Group--No Assessment 5::=Refused 108::=Laboratory 160::=Pharmacy 419::=Anesthesiology 423::=Prosthetics 180::=Oral Surgery 401::=General Surgery 402::=Cardiac Surgery 403::=Otorhinolaryngology (ENT) 404::=Gynecology 406::=Neurosurgery 407::=Ophthalmology 409::=Orthopedics 410::=Plastic Surgery (inc. H&N) 411::=Podiatry 412::=Proctology 413::=Thoracic Surgery 415::=Peripheral Vascular 457::=Transplantation 105::=General Radiology 109::=Nuclear Medicine 109::=Cardiology Studies (Nuclear Med) 115::=Ultrasound 703::=Mammography 150::=CT Scan 151::=Magnetic Resonance Imaging 152::=Angio-Neuro-Interventional 421::=Vascular Lab "PROCEDURE",i,"COMMENT") Optional Comment Free Text (1-245 characters) "PROCEDURE",i,"DELETE") Optional This is a flag that denotes deletion of the Procedure entry. Format: [ 1 | null ]| PATIENT ED: The "PATIENT ED" node may have multiple entries (i). To delete the entire "PATIENT ED" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PATIENT ED",i,"TOPIC") Required Education Topic that patient received education. Format: Pointer to Education Topics file (9999999.09) "PATIENT ED",i,"UNDERSTANDING") Optional The patients level of understanding of the education. Format: Set of Codes. 1::=Poor 2::=Fair 3::=Good 4::=Group--No Assessment 5::=Refused "PATIENT ED",i,"ENC PROVIDER") Optional Provider who was the educator. Format: Pointer to New Person file (200) "PATIENT ED",i,"EVENT D/T") Optional Date/Time of Event Format: FileMan Internal Format for date/time "PATIENT ED",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "PATIENT ED",i,"DELETE") Optional This is a flag that denotes deletion of the Provider entry. Format: [ 1 | null ]| "PATIENT ED",i,"DELETE") Optional This is a flag that denotes deletion of the Patient Ed entry. Format: [ 1 | null ]| HEALTH FACTOR: The "HEALTH FACTOR" node may have multiple entries (i). To delete the entire "HEALTH FACTOR" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "HEALTH FACTOR",i,"HEALTH FACTOR") Required Health Factor that contributes to a patient's state of health. Format: Pointer to Health Factors file (9999999.64) "HEALTH FACTOR",i,"LEVEL/SEVERITY") Optional Level/Severity of health factor related to the patient's state of health. Format: Set of Codes. M::=Minimal MO:=Moderate H:=Heavy/Severe "HEALTH FACTOR",i,"ENC PROVIDER") Optional Provider who documented the health factor. Format: Pointer to New Person file (200) "HEALTH FACTOR",i,"EVENT D/T") Optional Date/Time of Event Format: FileMan Internal Format for date/time "HEALTH FACTOR",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "HEALTH FACTOR",i,"DELETE") Optional This is a flag that denotes deletion of the Health Factor entry. Format: [ 1 | null ]| EXAM: The "EXAM" node may have multiple entries (i). To delete the entire "EXAM" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "EXAM",i,"EXAM") Required Exam that was performed. Format: Pointer to Exam file (9999999.15) "EXAM",i,"RESULT") Optional Result of Exam Format: Set of Codes. A::=Abnormal N::=Normal "EXAM",i,"ENC PROVIDER") Optional Provider who performed the exam.. Format: Pointer to New Person file (200) "EXAM",i,"EVENT D/T") Optional Date/Time of Exam Format: FileMan Internal Format for date/time "EXAM",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "EXAM",i,"DELETE") Optional This is a flag that denotes deletion of the Exam entry. Format: [ 1 | null ]| SKIN TEST: The "SKIN TEST" node may have multiple entries (i). To delete the entire "SKIN TEST" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "SKIN TEST",i,"TEST") Required Skin Test that was performed Format: Pointer to Skin Test file (9999999.28) "SKIN TEST",i,"READING") Optional Numeric measurement of the surface area tested (in millimeters). Format: Whole number between 0 and 40 inclusive. "SKIN TEST",i,"RESULT") Optional Results of the Skin Test Format: Set of Codes. P::=Positive D::=Doubtful N::=Negative O::=No Take "SKIN TEST",i,"D/T READ") Optional Date/time skin test was read Format: FileMan Internal Format for date/time "SKIN TEST",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified skin test and is the primary diagnosis associated with this skin test. Format: Pointer to ICD Diagnosis file (80) "SKIN TEST",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified skin test. Format: Pointer to ICD Diagnosis file (80) "SKIN TEST",i,"ENC PROVIDER") Optional Provider who read the skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"EVENT D/T") Optional Date/Time test was administered. Format: FileMan Internal Format for date/time "SKIN TEST",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "SKIN TEST",i,"READER") Optional The person who read the skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"ORD PROVIDER") Optional The provider who ordered this skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"D/T PLACEMENT RECORDED") Optional The date and time of documentation of the placement of the skin test. Format: FileMan Internal Format for date/time "SKIN TEST",i,"ANATOMIC LOC") Optional The anatomic location of skin test placement. Format: Pointer to Imm Administration Site (Body) file (920.3) "SKIN TEST",i,"D/T READING RECORDED") Optional The date and time of documentation of the reading of the skin test. Format: FileMan Internal Format for date/time "SKIN TEST",i,"READING COMMENT") Optional Comment related to the reading of the patient's skin test. Format: Free Text field (1-245 characters) "SKIN TEST",i,"DELETE") Optional This is a flag that denotes deletion of the Skin Test entry. Format: [ 1 | null ]| IMMUNIZATION: The "IMMUNIZATION" node may have multiple entries (i). To delete the entire "IMMUNIZATION" entry, set the "DELETE" node to 1. Effective with PX*1*209, the "IMMUNIZATION" node contains modifications to include additional fields: Event Info Source, Dosage, Route, Admin Site, Lot #. These new fields are optional, and therefore backward compatible. SUBSCRIPT DESCRIPTION: "IMMUNIZATION",i,"IMMUN") Required Immunization that was performed. Format: Pointer to Immunization file (9999999.14) "IMMUNIZATION",i,"SERIES") Optional Series specifies the sequence of the series for the immunization that was administered. Format: Set of Codes. P::=Partially complete C::=Complete B::=Booster 1::=Series1 thru 8::=Series8 "IMMUNIZATION",i,"REACTION") Optional The observed reaction to the immunization. Format: Set of Codes. 0::=None 1::=Fever 2::=Irritability 3::=Local Reaction or Swelling 4::=Vomiting 5::=Rash or Itching 6::=Lethargy 7::=Convulsions 8::=Arthritis or Arthralgias 9::=Anaphylaxis or Collapse 10::=Respiratory Distress 11::=Other "IMMUNIZATION",i,"CONTRAINDICATED") Optional This field may be used to indicate that this immunization should not be administered again. "1" indicates that the immunization should not be given to the patient in the future. Format: [ 1 | 0 | null ] "IMMUNIZATION",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified immunization and is the primary diagnosis associated with this immunization. Format: Pointer to ICD Diagnosis file (80) "IMMUNIZATION",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified immunization. Format: Pointer to ICD Diagnosis file (80) "IMMUNIZATION",i,"ENC PROVIDER") Optional Provider who performed the immunization. Format: Pointer to New Person file (200) "IMMUNIZATION",i,"EVENT D/T") Optional Date/Time immunization was administered. Format: FileMan Internal Format for date/time "IMMUNIZATION",i,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "IMMUNIZATION",i,"LOT NUM") Optional The lot number of the Immunization entered for this event. Format: Pointer to Immunization Lot file (9999999.41) "IMMUNIZATION",i,"INFO SOURCE") Optional The source of the information obtained for this immunization event. Format: Pointer to Immunization Info Source file (920.1) "IMMUNIZATION",i,"ADMIN ROUTE") Optional The method this vaccine was administered. Format: Pointer to Imm Administration Route file (920.2) "IMMUNIZATION",i,"ANATOMIC LOC") Optional The area of the patient's body through which the vaccine was administered. Format: Pointer to Imm Administration Site (Body) file (920.3) "IMMUNIZATION",i,"DOSE") Optional The amount of vaccine product administered for this immunization. Format: Numeric (between 0 and 999, 2 fractional digits) "IMMUNIZATION",i,"DOSE UNITS") Optional The units that reflect the actual quantity of the vaccine product administered. Format: Pointer to the UCUM Codes file (#757.5) "IMMUNIZATION",i,"VIS",SEQ #,0)=VISIEN^DATE Optional The Vaccine Information Statement (VIS) offered to or given to the patient before administration of the immunization, and the date it was offered or given. Format: "VISIEN" is a pointer to the Vaccine Information Statement file (#920). "DATE" is a date (without time) in FileManager internal format. NOTE: If the caller is updating a previously recorded immunization: 1) If the caller passes in VIS data in the "VIS" subscript, the system will purge the previously filed VIS data before filing the updates. 2) If the caller does not pass in any VIS data, the previously filed VIS data persists. 3) If the caller wants to delete the previously filed VIS without replacing it with anything else, that is done explicitly by setting the "VIS" subscript as follows: "IMMUNIZATION",i,"VIS")="@" "IMMUNIZATION",i,"REMARKS",SEQ #,0) Optional Comments related to the immunization encounter with the patient. Format: Free-text in the format of a FileManager word-processing field. NOTE: If the caller is updating a previously recorded immunization: 1) If the caller passes in remarks in the "REMARKS" subscript, the system will purge the previously filed remarks before filing the updates. 2) If the caller does not pass in any remarks, the previously filed remarks persist. 3) If the caller wants to delete the previously filed remarks without replacing it with anything else, that is done explicitly by setting the "REMARKS" subscript as follows: "IMMUNIZATION",i,"REMARKS")="@" "IMMUNIZATION",i,"ORD PROVIDER") Optional The provider who ordered the immunization. Format: Pointer to New Person file (#200). "IMMUNIZATION",i,"WARNING ACK") Optional This field indicates acknowledgement of a contraindication/refusal event warning for this immunization with the decision to proceed with administration. Format: [ 1 | 0 | null ] "IMMUNIZATION",i,"OVERRIDE REASON" Optional This is the reason for overriding the warning of existing contraindication and/or refusal reasons. Format: Free Text (3-245 characters). "IMMUNIZATION",i,"DELETE") Optional This is a flag that denotes deletion of the Immunization entry. Format: [ 1 | null ]| TREATMENT: The "TREATMENT" node may have multiple entries (i). To delete the entire "TREATMENT" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "TREATMENT",i,"TREATMENT") Required Name of Treatment Format: Pointer to Treatment file (9999999.17) "TREATMENT",i,"QTY") Optional Number of times the treatment was performed. Format: Whole number > 0 "TREATMENT",i,"NARRATIVE") *Optional The provider's description of the treatment performed. *If NARRATIVE is not passed for a treatment, the Treatment Name from the Treatment file (9999999.17) will be used as the default. Format: Free text (2-245 characters) "TREATMENT",i,"CATEGORY") Optional A term that denotes a grouping or category for a set of related treatments. Format: Free text (2-245 characters) "TREATMENT",i,"ENC PROVIDER") Optional Provider who performed the treatment. Format: Pointer to New Person file (200) "TREATMENT",i,"EVENT D/T") Optional Date/Time treatment was done. Format: FileMan Internal Format for date/time "TREATMENT",i,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "TREATMENT",i,"DELETE") Optional This is a flag that denotes deletion of the Treatment entry. Format: [ 1 | null ]| IMM CONTRA/REFUSAL: The "IMM CONTRA/REFUSAL" node may have multiple entries (i). To delete the entire "IMM CONTRA/REFUSAL" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "IMM CONTRA/REFUSAL",i,"CONTRA/REFUSAL") Required The Contraindication or Refusal Reason. Format: Variable Pointer to: IMM Contraindication Reasons file (920.4) or IMM Refusal Reasons file (920.5). "IMM CONTRA/REFUSAL",i,"IMMUN") Required The immunization contraindicated or refused. Format: Pointer to Immunization file (9999999.14) "IMM CONTRA/REFUSAL",i,"WARN UNTIL DATE") Optional The date until which a warning should be given for this contraindication/refusal. Format: FileManager Internal Format for date. "IMM CONTRA/REFUSAL",i,"EVENT D/T") Optional The date/time of this contraindication/refusal event. Format: FileManager Internal Format for date/time. "IMM CONTRA/REFUSAL",i,"ENC PROVIDER") Optional This is the provider who recorded the contraindication/refusal event. Format: Pointer to New Person file (#200). "IMM CONTRA/REFUSAL",i,"COMMENT") Optional Comment. Format: Free Text (1-245 characters). "IMM CONTRA/REFUSAL",i,"DELETE") Optional This is a flag that denotes deletion of the IMM Contra/Refusal entry. Format: [ 1 | null ]| EXAMPLE OF DATA PASSED TO $$DATA2PCE^PXAPI Provided below is an example of data passed to $$DATA2PCE^PXAPI where Laboratory is the ancillary package reporting the data. $$DATA2PCE^PXAPI("LRPXAPI",$J,182,"LAB DATA") This is an example where Laboratory passes two laboratory tests (Glucose and CPK) which were resulted on 4/20/96 at 9:30 a.m. This occasion of service is defined as an Ancillary Package Daily Data (X). ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"CREDIT STOP") = 59 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"ENC D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"HOS LOC") = 59 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"PATIENT") = 1030 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"SERVICE CATEGORY") = X ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"ENC PROVIDER") = 58 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"EVENT D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"PROCEDURE") = 82950 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"QTY") = 1 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"ENC PROVIDER") = 58 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"EVENT D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"PROCEDURE") = 82552 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"QTY") = 1 ^TMP("LRPXAPI",543173595,"PROVIDER",1,"NAME") = 58 ^TMP("LRPXAPI",543173595,"PROVIDER",1,"PRIMARY") = 1 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"PROCEDURE") = ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"MODIFIERS",57) = "" ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"QUANTITY") = 1 ROUTINE: PXAPI COMPONENT: DATA2PCE VARIABLES: ******************** 1890 NAME: DBIA1889-B CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SURGERY RADIOLOGY/NUCLEAR MEDICINE AUTOMATED INFO COLLECTION SYS LAB SERVICE EVENT CAPTURE ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES PROSTHETICS QUASAR REGISTRATION CLINICAL PROCEDURES EMERGENCY DEPARTMENT ADDED 10/10/2008 MENTAL HEALTH ADDED 5/29/2020 USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$DELVFILE^PXAPI(WHICH,VISIT,PKG,SOURCE,ASK,ECHO,USER) This function may be used to delete data from the Visit file (9000010) and V files, including V CPT (9000010.18), V EXAM (9000010.13), V HEALTH FACTORS (9000010.11), V PATIENT ED (9000010.16), V POV (9000010.07), V PROVIDER (9000010.06), V SKIN TEST (9000010.12) and V TREATMENT (9000010.15). Parameter Description: 1. WHICH: (required) An ^ delimited string where two or three characters separated by an ^ designate the V file from which data should be deleted, e.g., "PRV^POV^CPT^HF". "ALL" may be used to delete data from all V files. VISIT is the string which will delete the administrative data and STOP is the string which will delete the additional stop codes. An example of a function call which will delete data typically deleted through Delete Check Out is: $$DELVFILE^PXAPI("ALL",VISIT,,,1,1) Possible individual strings which may be included in WHICH include: ALL To delete all items CPT To delete procedures HF To delete health factors IMM To delete immunizations PEP To delete patient education POV To delete problem of visit (diagnoses) PRV To delete provider SK To delete skin tests STOP To delete additional stop codes. The primary clinic stop will not be deleted. TRT To delete treatments VISIT To delete Service Connected, Classification question data, check out date. XAM To delete examinations 2. VISIT: (required) A number which is a pointer to the VISIT file (9000010). This is the visit for which related data will be deleted. 3. PKG: (optional) The internal entry number of the package in the Package file (9.4) or the namespace for the package. If passed, only items created by this package will be deleted. 4. SOURCE: (optional) A string denoting the source of the data. This is an entry in the Data Source file (839.7). If passed, only items created by this source will be deleted. 5. ASK: (optional) If ASK is passed and it does not equal 0 or "", then PCE will prompt the user to verify that they want to delete the data before proceeding with the deletions. PCE recommends setting ASK to 1 to indicate that the user should be asked to confirm that the data should be deleted. 6. ECHO: (optional) If ECHO is passed and it does not equal 0 or "", then PCE will display to the user what is being deleted. PCE recommends setting ECHO to 1 to indicate that the data deletions should be displayed to the user, e.g. Deleting Procedures.... Deleting Providers.... Deleting Diagnoses.... The message will be displayed only if data has been deleted. 7. USER: (optional) Set USER to the user's DUZ to restrict deletion of data to those entries created by the user. If USER is not passed, is equal to 0 or "", PCE will not apply deletion restriction based on the user. Returned Value: 1 If no errors occurred and deletion processed completely. 0 If errors occurred but deletion processed completely as possible. -1 User indicated that the data should not be deleted, or User up-arrowed out, or errors occurred. In any case, nothing was deleted. -2 If unable to identify a valid VISIT. -3 If API was called incorrectly. -4 If dependent entry count is still greater than zero. ROUTINE: PXAPI COMPONENT: DELVFILE VARIABLES: ******************** 1891 NAME: DBIA1889-C CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$INTV^PXAPI(WHAT,PKG,SOURCE,.VISIT,.HL,.DFN,APPT,LIMITDT,ALLHLOC) This API should be used by subscribing packages to prompt for Visit and related V-file data. The parameters passed by the subscribing packages determine which prompts will be displayed. If VISIT, HL or DFN are passed by reference (.), a value will be returned for those variables. Parameter Description: 1. WHAT: Required parameter that defines the series of prompts that will be displayed. ADDEDIT When not an appointment. INTV Includes all prompts for the checkout interview: 1. Patient (if not defined) 2. Hospital Location (if not defined) 3. Appointment/Eligibility (Call to Scheduling API if the encounter is not associated with an appointment and is a new encounter.) 4. Check Out Date/Time 5. Service Connected/Classification Questions Service Connected Agent Orange Exposure Ionizing Radiation Exposure Environmental Contaminants Exposure Military Sexual Trauma Head and/or Neck Cancer Combat Vet Project 112/SHAD Exposure Camp Lejeune 6. Provider (multiple) Provider Primary/Secondary Designation 7. Procedures (multiple) CPT code Modifiers (multiple) Quantity 8. Diagnosis (multiple) ICD9 code Primary/Secondary Designation 9. Stop Code (multiple) Discontinued after 10/1/96 Stop code PRV Includes all prompts for provider information (multiple): 1. Provider 2. Primary/Secondary Designation POV Includes all prompts for diagnosis information (multiple): 1. ICD9 code 2. Primary/Secondary Designation CPT Includes prompts for procedure information and allows association of data with a provider (multiple): 1. Provider 2. Primary/Secondary Provider Designation 3. CPT code 4. CPT Modifiers (multiple) 5. Quantity SCC Includes prompts for service connected conditions and classification questions: 1. Service Connected 2. Combat Vet 3. Agent Orange Exposure 4. Ionizing Radiation Exposure 5. Environmental Contaminants Exposure 6. Project 112/SHAD Exposure 7. Military Sexual Trauma 8. Head and/or Neck Cancer 9. Camp Lejeune CODT Includes prompt for check-out date/time: 1. Date/time Checked Out ADQ Includes all administrative prompts related to the interview: 1. Patient (if not defined) 3. Appointment/Eligibility (API called if encounter is not associated with an appointment) 4. Check Out Date/Time 5. Service Connected 6. Combat Vet 7. Agent Orange Exposure 8. Ionizing Radiation Exposure 9. Environmental Contaminants Exposure 10. Project 112/SHAD Exposure 11. Military Sexual Trauma 12. Head and/or Neck Cancer 13. Camp Lejeune STP Includes prompt for a stop code (multiple): 1. Stop Code (only for encounters before 10/1/96) 2. PKG: Required parameter that is the designated namespace for the package as defined in the Package file or is a pointer to the Package file (9.4). 3. SOURCE: Required parameter that is used for auditing purposes and defines the data collection source. This parameter could be the calling routine or a description of the caller, e.g., PIMS CHECKOUT, PXCE DATA ENTRY, PANDAS, TELEFORM. It will be added to the PCE Data Source file (839.7). 4. VISIT: Required parameter except when "INTV" and "ADQ" are called. This parameter defines the encounter and is a pointer to the Visit file (9000010). 5. HL: Optional parameter (passed if known) that defines the hospital location for the encounter and points to the Hospital Location file (44). If the subscribing package knows the hospital location, it should be passed to avoid unnecessary prompting. 6. DFN: Required parameter if there is no known visit (VISIT) and there is an appointment (APPT); otherwise, it is an optional parameter (passed if known) that defines the patient and points to the Patient/IHS file (9000001). If the subscribing package knows the patient, it should be passed to avoid unnecessary prompting. 7. APPT: Optional parameter that points to the Appointment subfile (2.98) of the Patient file (2). This parameter defines the appointment date/time. 8. LIMITDT: Optional parameter that restricts creation of new visits to the date passed or after the date passed. The format of the parameter is internal fileman date. 9. ALLHLOC: Optional parameter if is not passed, 0, or null then only clinics can be entered for hospital locations otherwise any non disposition hospital location can be entered. Returned Variables: If VISIT, HL or DFN are passed by reference (.), a value will be returned for those variables. 1 When the call to the API is successful; no errors were encountered. 0 When user up-arrows out. Minimally, a visit exists. Other processing may have occurred. -1 When user up-arrows out or errors out and nothing has been processed. -2 When no visit was created and no subsequent processing occurred. -3 When the API was incorrectly called. ROUTINE: PXAPI COMPONENT: INTV VARIABLES: ******************** 1892 NAME: DBIA1889-D CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING LAB SERVICE USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$ENCEDIT^PXAPI(WHAT,PKG,SOURCE,DFN,BEGDT,ENDT,HLOC,SCREEN,APPT,PRMPT) This is an interactive API that may be called to display a list of encounters for selection. It allows adding a new encounter, or selecting an encounter to edit or delete. If the user indicates that an encounter should be added, an entry will be created in the Visit file (9000010), and the user will be prompted based on the WHAT parameter. If an encounter is selected to edit, the user will be prompted based on the WHAT parameter. If an encounter is selected for deletion, all data associated with the encounter will be deleted, and the entry in the Visit file will be assessed for deletion and deleted if possible. Parameter Description: 1. WHAT: (required) This parameter is string text that identifies the set of prompts. INTV Includes all prompts for the checkout interview: 1. Patient (if not defined) 2. Hospital Location (if not defined) Appointment/Eligibility (Call to Scheduling API if the encounter is not associated with an appointment and is a new encounter.) 3. Check Out Date/Time 4. Service Connected/Classification Questions Service Connected Agent Orange Exposure Ionizing Radiation Exposure Environmental Contaminants Exposure Military Sexual Trauma Head and/or Neck Cancer Combat Vet Project 112/SHAD Exposure Camp Lejeune 5. Provider (multiple) Provider Primary/Secondary Designation 6. Procedures (multiple) CPT code Modifiers (multiple) Quantity 7. Diagnosis (multiple) ICD9 code Primary/Secondary Designation 8. Stop Code (multiple) Discontinued after 10/1/96 Stop code ADQ Includes all administrative prompts related to the interview: 1. Patient (if not defined) 2. Hospital Location (if not defined) 3. Appointment/Eligibility (API called if encounter is not associated with an appointment) 4. Check Out Date/Time 5. Service Connected 6. Combat Vet 7. Agent Orange Exposure 8. Ionizing Radiation Exposure 9. Environmental Contaminants Exposure 10. Project 112/SHAD Exposure 11. Military Sexual Trauma 12. Head and/or Neck Cancer 13. Camp Lejeune 2. PKG: (required) This parameter is the assigned package Name space as designated in the Package file (9.4) or is a pointer to the Package file (9.4). 3. SOURCE: (required) This parameter is used for auditing purposes and defines the data collection source. This parameter could be the calling routine or a description of the caller, e.g., PIMS CHECKOUT, PXCE DATA ENTRY, PANDAS, TELEFORM. It will be added to the PCE Data Source file (839.7). 4. DFN: (required) This parameter represents the patient and is the internal entry number of the Patient's entry in the Patient/IHS file (9000001) which is dinumed to the Patient file (2). 5. BEGDT: (optional) This is the beginning date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010) for the identified patient will be returned. 6. ENDT: (optional) This is the ending date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010) for the identified patient will be returned. 7. HLOC: (optional) This is the Hospital Location. It is a pointer to the Hospital Location file (44). This restricts display of encounters to those associated with this hospital location. If HLOC is not passed, all encounters for the identified patient, irrespective of the hospital location, will be returned. 8. SCREEN: (optional) This is a screen based on the Primary field (15003) and Service Category field (.07) of the Visit file (9000010). It is a set of codes that represents an encounter type, e.g., primary, occasion of service, stop code. More than one code may be used, e.g., PO. If SCREEN is not passed, all encounters, except those that represent historical encounters, will be included in the list. If the screen includes E, only historical encounters will be displayed. If the screen does not include E, only non-historical encounters will be displayed. A Occasions of service that are passed to PCE by ancillary packages using DATA2PCE^PXAPI. P Primary visits are encounters created for appointments and standalone's either through manual data entry or via DATA2PCE^PXAPI. O Occasions of Service are encounters that are created when data for an ancillary package such as Radiology or Laboratory is manually entered through Scheduling or PCE. Assignment of this code is determined based on a managed set of stop codes provided by ancillary packages. S Stop Codes are child encounters that are created to store additional stop codes for a parent encounter. This will be discontinued after 10/1/96. E Historical Encounters are encounters that document clinical activities. They are not associated with an appointment and are not used for billing or workload purposes. Use "XE" to display all historical encounters. X All encounters, excluding historical encounters. "X" is the default when no SCREEN is defined. 9. APPT: (optional) This parameter determines the contents of the encounter list--whether the encounter include appointments and standalones, just appointments or just standalones. If APPT is not passed, no appointment/encounter relationship will be assessed. 1 Display only encounters related to an appointment. 0 Don't screen on encounter/appointment relationship. -1 Display only encounters not related to an appointment (standalones). 10. PRMPT:(optional) This determines the prompt used by the API. If PRMPT is not passed or null, only selection of an item from the list will be enabled. A Includes ADD in the prompt. D Includes DELETE in the prompt. Returned Value: >0 Internal entry number of the selected encounter, IEN in the Visit file (9000010). D^Visit IEN User selected an encounter to DELETE. -1 No visit selected, user up-arrowed out, nothing done. -2^Text Error encountered. Text string documents error. -3^Text Deletion Errors. If deletion occurred, it was incomplete. ====================================================================== $$LOPENCED^PXAPI(WHAT,PKG,SOURCE,DFN,BEGDT,ENDT,HLOC,SCREEN,APPT,PRMPT) This is an interactive API that may be called to display a list of encounters for selection. It allows adding a new encounter, or selecting an encounter to edit or delete. If the user indicates that an encounter should be added, an entry will be created in the Visit file (9000010), and the user will be prompted based on the WHAT parameter. If an encounter is selected to edit, the user will be prompted based on the WHAT parameter. If an encounter is selected for deletion, all data associated with the encounter will be deleted, and the entry in the Visit file will be assessed for deletion and deleted if possible. This API should be used to allow continuous looping through encounter edit until the user exits the functionality. This API loops calling ENCEDIT^PXAPI to collect encounter data repeatedly. Parameter Description: 1. WHAT: (required) This parameter is string text that identifies the set of prompts. INTV Includes all prompts for the checkout interview: 1. Patient (if not defined) 2. Hospital Location (if not defined) Appointment/Eligibility (Call to Scheduling API if the encounter is not associated with an appointment and is a new encounter.) 3. Check Out Date/Time 4. Service Connected/Classification Questions Service Connected Agent Orange Exposure Ionizing Radiation Exposure Environmental Contaminants Exposure Military Sexual Trauma Head and/or Neck Cancer Combat Vet Project 112/SHAD Exposure Camp Lejeune 5. Provider (multiple) Provider Primary/Secondary Designation 6. Procedures (multiple) CPT code Modifiers (multiple) Quantity 7. Diagnosis (multiple) ICD9 code Primary/Secondary Designation 8. Stop Code (multiple) Discontinued after 10/1/96 Stop code ADQ Includes all administrative prompts related to the interview: 1. Patient (if not defined) 2. Hospital Location (if not defined) 3. Appointment/Eligibility (API called if encounter is not associated with an appointment) 4. Check Out Date/Time 5. Service Connected 6. Combat Vet 7. Agent Orange Exposure 8. Ionizing Radiation Exposure 9. Environmental Contaminants Exposure 10. Project 112/SHAD Exposure 11. Military Sexual Trauma 12. Head and/or Neck Cancer 13. Camp Lejeune 2. PKG: (required) This parameter is the assigned package Namesapce as designated in the Package file (9.4) or is a pointer to the Package file (9.4). 3. SOURCE: (required) This parameter is used for auditing purposes and defines the data collection source. This parameter could be the calling routine or a description of the caller, e.g., PIMS CHECKOUT, PXCE DATA ENTRY, PANDAS, TELEFORM. It will be added to the PCE Data Source file (839.7). 4. DFN: (required) This parameter represents the patient and is the internal entry number of the Patient's entry in the Patient/IHS file (9000001) which is dinumed to the Patient file (2). 5. BEGDT: (optional) This is the beginning date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010) for the identified patient will be returned. 6. ENDT: (optional) This is the ending date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010) for the identified patient will be returned. 7. HLOC: (optional) This is the Hospital Location. It is a pointer to the Hospital Location file (44). This restricts display of encounters to those associated with this hospital location. If HLOC is not passed, all encounters for the identified patient, irrespective of the hospital location, will be returned. 8. SCREEN: (optional) This is a screen based on the Primary field (15003) and Service Category field (.07) of the Visit file (9000010). It is a set of codes that represents an encounter type, e.g., primary, occasion of service, stop code. More than one code may be used, e.g., PO. If SCREEN is not passed, all encounters, except those that represent historical encounters, will be included in the list. If the screen includes E, only historical encounters will be displayed. If the screen does not include E, only non-historical encounters will be displayed. A Occasions of service that are passed to PCE by ancillary packages using DATA2PCE^PXAPI. P Primary visits are encounters created for appointments and standalone's either through manual data entry or via DATA2PCE^PXAPI. O Occasions of Service are encounters that are created when data for an ancillary package such as Radiology or Laboratory is manually entered through Scheduling or PCE. Assignment of this code is determined based on a managed set of stop codes provided by ancillary packages. S Stop Codes are child encounters that are created to store additional stop codes for a parent encounter. This will be discontinued after 10/1/96. E Historical Encounters are encounters that document clinical activities. They are are not associated with an appointment and are not used for billing or workload purposes. Use "XE" to display all historical encounters. X All encounters, excluding historical encounters. "X" is the default when no SCREEN is defined. 9. APPT: (optional) This parameter determines the contents of the encounter list--whether the encounter include appointments and standalones, just appointments or just standalones. If APPT is not passed, no appointment/encounter relationship will be assessed. 1 Display only encounters related to an appointment. 0 Don't screen on encounter/appointment relationship. -1 Display only encounters not related to an appointment (standalones). 10. PRMPT: (optional) This determines the prompt used by the API. If PRMPT is not passed or null, only selection of an item from the list will be enabled. A Includes ADD in the prompt. D Includes DELETE in the prompt. Returned Value: >0 Internal entry number of the selected encounter, IEN in the Visit file (9000010). D^Visit IEN User selected an encounter to DELETE. -1 No visit selected, user up-arrowed out, nothing done. -2^Text Error encountered. Text string documents error. -3^Text Deletion Errors. If deletion occurred, it was incomplete. ROUTINE: PXAPI COMPONENT: ENCEDIT VARIABLES: COMPONENT: LOPENCED VARIABLES: ******************** 1893 NAME: DBIA1889-E CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: QUASAR USAGE: Controlled Subscri ENTERED: MAR 8,2004 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$VISITLST^PXAPI(DFN,BEGINDT,ENDDT,HLOC,SCREEN,APPT,PRMPT) Use this API to display a list of encounters. This is an interactive API that allows the user to enter "A" to ADD a new encounter or to select an encounter to edit or delete. If no date range is passed, all entries in the Visit file (9000010 ) for the identified patient will be included in the list. If the HLOC is not passed, all entries in the Visit file (9000010) for the identified patient will be included in the list. If SCREEN is not passed, all encounters, except those that represent historical encounters, will be included in the list. If APPT is not passed, no appointment/encounter relationship will be assessed. If PRMPT is not passed or is null, only selection of an item from the list will be enabled. Parameter Description: 1. DFN: (required) This number represents the patient and is the internal entry number of the Patient's entry in the Patient/IHS file (9000001) which is dinumed to the Patient file (2). 2. BEGINDT: (optional) This is the beginning date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010 ) for the identified patient will be included in the list. 3. ENDDT: (optional) This is the ending date, in an INTERNAL FORMAT, of the date range. If no date range is passed, all entries in the Visit file (9000010 ) for the identified patient will be included in the list. 4. HLOC: (optional) This is the Hospital Location. It is a pointer to the Hospital Location file (44). This restricts display of encounters to those associated with this hospital location. If the HLOC is not passed, all entries in the Visit file (9000010) for the identified patient will be included in the list. 5. SCREEN: (optional) This is a screen based on the Primary field (15003) and Service Category field (.07) of the Visit file (9000010). It is a set of codes that represents an encounter type, e.g., primary, occasion of service, stop code. More than one code may be used, e.g., PO. If SCREEN is not passed, all encounters, except those that represent historical encounters, will be included in the list. If the screen includes E, only historical encounters will be displayed. If the screen does not include E, only non-historical encounters will be displayed. A Occasions of service that are passed to PCE by ancillary packages using DATA2PCE^PXAPI. P Primary visits are encounters created for appointments and standalone's either through manual data entry or via DATA2PCE^PXAPI. O Occasions of Service are encounters that are created when data for an ancillary package such as Radiology or Laboratory is manually entered through Scheduling or PCE. Assignment of this code is determined based on a managed set of stop codes provided by ancillary packages. S Stop Codes are child encounters that are created to store additional stop codes for a parent encounter. This will be discontinued after 10/1/96. E Historical Encounters are encounters that document clinical activities. They are not associated with an appointment and are not used for billing or workload purposes. Use "XE" to display all historical encounters. This screen must be used in combination with one of the other codes. X All encounters, excluding historical encounters. "X" is the default when no SCREEN is defined. 6. APPT: (optional) This determines the contents of the encounter list--whether the encounters include appointments and standalones, just appointments or just standalones. If APPT is not passed, no appointment/encounter relationship will be assessed. 1 Display only encounters related to an appointment. 0 Don't screen on encounter/appointment relationship. -1 Display only encounters not related to an appointment (standalones). 7. PRMPT: (optional) This determines the prompt used by the API. If PRMPT is not passed or null, only selection of an item from the list will be enabled. A Includes ADD in the prompt. D Includes DELETE in the prompt. Returned Value: >0 Internal entry number of the selected encounter, IEN in the Visit file (9000010) A User indicated to ADD an encounter. D^IEN User selected an encounter to DELETE. -1 No visit selected -2^Text Error encountered. Text documents error. ROUTINE: PXAPI COMPONENT: VISITLST VARIABLES: ******************** 1894 NAME: DBIA1889-F CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES LAB SERVICE DENTAL CARE MANAGEMENT OUTPATIENT PHARMACY INTEGRATED BILLING CLINICAL CASE REGISTRIES QUASAR CLINICAL PROCEDURES EMERGENCY DEPARTMENT ADDED 10/10/2008 NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD Effective with VPR*1*0. MYHEALTHEVET Added 10/9/14. BAR CODE EXPANSION Added 10/10/14 as subscriber. Effective with new project Bar Code Enhancement - Transfusion Verification, namespace MJCF. The new package build is MJCF*1.0.KID. VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR Added 3/15/17 REGISTRATION Added 2/2/21, effective with DG*5.3*1034 USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine ENCEVENT^PXKENC(VISITIEN,DONTKILL) This API was developed to extract all encounter data for a single encounter. The data represents elements that are stored in the Visit file (9000010) and other PCE files. Parameter Description: 1. VISITIEN (required) This is a pointer to the Visit file (9000010). 2. DONTKILL (optional) This determines whether or not the ^TMP array will be killed. Enter 0 or "" (null) to kill the array, and 1 to retain the array. Returned: The data is stored in a ^TMP global array with subscripts denoting the category of returned data. The data returned in the ^TMP global represents data from one encounter. The structure of the returned ^TMP global is: ^TMP("PXKENC",$J,VISIT,V FILE STRING,V FILE RECORD,DD SUBSCRIPT) =DATA Where: Global Root Temporary global file root: ^TMP Subscript 1 String notation representing Package: "PXKENC" Subscript 2 Job Number: $J Subscript 3 Internal Entry Number of the Visit (IEN). Subscript 4 String representing the Visit or V file data category: "CPT" = V CPT (procedure) #9000010.18 "HF" = V Health Factors #9000010.23 "ICR" = V Imm Contra/Refusal #9000010.707 Events "IMM" = V Immunization #9000010.11 "PED" = V Patient Ed #9000010.16 "POV" = V POV (diagnosis) #9000010.07 "PRV" = V Provider #9000010.06 "SK" = V Skin Test #9000010.12 "TRT" = V Treatment #9000010.15 "VST" = Visit file #9000010 "XAM" = V Exam #9000010.13 "CSTP" = Visit file #9000010 This subscript contains child visits used to store additional Stop Codes. Subscript 5 Internal entry number of the entry in the file represented in subscript #4 Subscript 6 Subscript or DD node on which the data is stored. Every DD node is published whether or not there is any data for that node. e.g. 0, 12, and 811 Data: The DATA that exists to the right of the global node is a reflection of data as it appears in the global node of the IEN of the file (noted in subscript #5) and the NODE of that IEN (described in subscript #6). Data Capture of Example output: Included below is a capture of the ^TMP("PXKENC" global. ^TMP("PXKENC",549479964,78,"CPT",135,0) = 34510^1030^78^176^^^^^^^^^^^^1 ^TMP("PXKENC",549479964,78,"CPT",135,1,0) = ^^1^1 ^TMP("PXKENC",549479964,78,"CPT",135,1,1,0) = 16 ^TMP("PXKENC",549479964,78,"CPT",135,12) = ^^^108 ^TMP("PXKENC",549479964,78,"CPT",135,802) = ^TMP("PXKENC",549479964,78,"CPT",135,811) = ^TMP("PXKENC",549479964,78,"POV",96,0) = 9054^1030^78^177^^^^^^^^S ^TMP("PXKENC",549479964,78,"POV",96,12) = ^^^108 ^TMP("PXKENC",549479964,78,"POV",96,800) = 0 ^TMP("PXKENC",549479964,78,"POV",96,802) = 168 ^TMP("PXKENC",549479964,78,"POV",96,811) = ^TMP("PXKENC",549479964,78,"POV",104,0) = 2569^1030^78^178^^^^^^^^P ^TMP("PXKENC",549479964,78,"POV",104,12) = ^TMP("PXKENC",549479964,78,"POV",104,800) = ^TMP("PXKENC",549479964,78,"POV",104,802) = ^TMP("PXKENC",549479964,78,"POV",104,811) = this is a comment ^TMP("PXKENC",549479964,78,"PRV",94,0) = 58^1030^78^S^A ^TMP("PXKENC",549479964,78,"PRV",94,12) = ^TMP("PXKENC",549479964,78,"PRV",94,811) = ^TMP("PXKENC",549479964,78,"PRV",114,0) = 108^1030^78^S ^TMP("PXKENC",549479964,78,"PRV",114,12) = ^TMP("PXKENC",549479964,78,"PRV",114,811) = ^TMP("PXKENC",549479964,78,"SK",3,0) = 1^1030^78^D^3^2960328.182336 ^TMP("PXKENC",549479964,78,"SK",3,12) = ^58^^108 ^TMP("PXKENC",549479964,78,"SK",3,811) = ^TMP("PXKENC",549479964,78,"TRT",2,0) = 162^1030^78^3^^175 ^TMP("PXKENC",549479964,78,"TRT",2,12) = ^108^^58 ^TMP("PXKENC",549479964,78,"TRT",2,802) = ^TMP("PXKENC",549479964,78,"TRT",2,811) = ^TMP("PXKENC",549479964,78,"VST",78,0) = 2960321.1^2960326^V^^1030^660 ^A^143^23^^^^2960326^^^^^^^ ^11^39^31^13560 ^TMP("PXKENC",549479964,78,"VST",78,11) = ^TMP("PXKENC",549479964,78,"VST",78,21) = ^TMP("PXKENC",549479964,78,"VST",78,150) = 1^^P ^TMP("PXKENC",549479964,78,"VST",78,800) = 0 ^TMP("PXKENC",549479964,78,"VST",78,811) = ==================================================================== $$GETENC^PXAPI(DFN,ENCDT,HLOC) This API was developed to extract all encounter data for all encounters that match the passed parameters. The data represents elements that are stored in the Visit file (9000010) and other PCE files. Parameter Description: 1. DFN: (required) Pointer to IHS/PATIENT file (9000001) 2. ENCDT: (required) Date/Time of encounter in Fileman format 3. HLOC: (required) Pointer to Hospital Location file (44) Returned Value: -2 If Called incorrectly -1 If no encounter is found >0 Visit file ien(s) separated by ^ The data is stored in a ^TMP global array with subscripts denoting the category of returned data. The data returned in the ^TMP global represents data from one encounter. The structure of the returned ^TMP global is: ^TMP("PXKENC",$J,VISIT,V FILE STRING,V FILE RECORD,DD SUBSCRIPT) =DATA Where: Global Root Temporary global file root: ^TMP Subscript 1 String notation representing Package: "PXKENC" Subscript 2 Job Number: $J Subscript 3 Internal Entry Number of the Visit (IEN). Subscript 4 String representing the Visit or V file data category: "CPT" = V CPT (procedure) #9000010.18 "HF" = V Health Factors #9000010.23 "ICR" = V Imm Contra/Refusal #9000010.707 Events "IMM" = V Immunization #9000010.11 "PED" = V Patient Ed #9000010.16 "POV" = V POV (diagnosis) #9000010.07 "PRV" = V Provider #9000010.06 "SK" = V Skin Test #9000010.12 "TRT" = V Treatment #9000010.15 "VST" = Visit file #9000010 "XAM" = V Exam #9000010.13 "CSTP" = Visit file #9000010 This subscript contains child visits used to store additional Stop Codes. Subscript 5 Internal entry number of the entry in the file represented in subscript #4 Subscript 6 Subscript or DD node on which the data is stored. Every DD node is published whether or not there is any data for that node. e.g. 0, 12, and 811 Data: The DATA that exists to the right of the global node is a reflection of data as it appears in the global node of the IEN of the file (noted in subscript #5) and the NODE of that IEN (described in subscript #6). Data Capture of Example output: Included below is a capture of ^TMP("PXKENC". ^TMP("PXKENC",549479964,78,"CPT",135,0) = 34510^1030^78^176^^^^^^^^^^^^1 ^TMP("PXKENC",549479964,78,"CPT",135,1,0) = ^^1^1 ^TMP("PXKENC",549479964,78,"CPT",135,1,1,0) = 16 ^TMP("PXKENC",549479964,78,"CPT",135,12) = ^^^108 ^TMP("PXKENC",549479964,78,"CPT",135,802) = ^TMP("PXKENC",549479964,78,"CPT",135,811) = ^TMP("PXKENC",549479964,78,"POV",96,0) = 9054^1030^78^177^^^^^^^^S ^TMP("PXKENC",549479964,78,"POV",96,12) = ^^^108 ^TMP("PXKENC",549479964,78,"POV",96,800) = 0 ^TMP("PXKENC",549479964,78,"POV",96,802) = 168 ^TMP("PXKENC",549479964,78,"POV",96,811) = ^TMP("PXKENC",549479964,78,"POV",104,0) = 2569^1030^78^178^^^^^^^^P ^TMP("PXKENC",549479964,78,"POV",104,12) = ^TMP("PXKENC",549479964,78,"POV",104,800) = ^TMP("PXKENC",549479964,78,"POV",104,802) = ^TMP("PXKENC",549479964,78,"POV",104,811) = this is a comment ^TMP("PXKENC",549479964,78,"PRV",94,0) = 58^1030^78^S^A ^TMP("PXKENC",549479964,78,"PRV",94,12) = ^TMP("PXKENC",549479964,78,"PRV",94,811) = ^TMP("PXKENC",549479964,78,"PRV",114,0) = 108^1030^78^S ^TMP("PXKENC",549479964,78,"PRV",114,12) = ^TMP("PXKENC",549479964,78,"PRV",114,811) = ^TMP("PXKENC",549479964,78,"SK",3,0) = 1^1030^78^D^3^2960328.182336 ^TMP("PXKENC",549479964,78,"SK",3,12) = ^58^^108 ^TMP("PXKENC",549479964,78,"SK",3,811) = ^TMP("PXKENC",549479964,78,"TRT",2,0) = 162^1030^78^3^^175 ^TMP("PXKENC",549479964,78,"TRT",2,12) = ^108^^58 ^TMP("PXKENC",549479964,78,"TRT",2,802) = ^TMP("PXKENC",549479964,78,"TRT",2,811) = ^TMP("PXKENC",549479964,78,"VST",78,0) = 2960321.1^2960326^V^^1030^660 ^A^143^23^^^^2960326^^^^^^^ ^11^39^31^13560 ^TMP("PXKENC",549479964,78,"VST",78,11) = ^TMP("PXKENC",549479964,78,"VST",78,21) = ^TMP("PXKENC",549479964,78,"VST",78,150) = 1^^P ^TMP("PXKENC",549479964,78,"VST",78,800) = 0 ^TMP("PXKENC",549479964,78,"VST",78,811) = The ^TMP("PXKENC",$J) global may be killed before and/or after the call. ROUTINE: PXAPI COMPONENT: GETENC VARIABLES: COMPONENT: ENCEVENT VARIABLES: ******************** 1895 NAME: DBIA1889-G CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: LAB SERVICE TEXT INTEGRATION UTILITIES ORDER ENTRY/RESULTS REPORTING NATIONAL HEALTH INFO NETWORK VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: MAR 2,2004 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$VST2APPT^PXAPI(VISIT) This function tells if Visit is related to an appointment. Or if it is a standalone visit (i.e. is not related to an appointment). Parameter: VISIT ien to a Visit file (#9000010) entry Returned value: 1 if the visit is related to an appointment. 0 if the visit is NOT related to an appointment. -1 if the visit is not a valued pointer. ======================================================================= $$APPT2VST^PXAPI(PATIENT,DATETIME,HOSPLOC) The function returns the visit that is related to an appointment. Must be able to resolve the Patient, Date/Time and Clinic to an appointment entry in the Patient file. Parameters: PATIENT DFN of a patient in the Patient file (#2) and the Patient/IHS file (#9000001) DATETIME The date and time of the appointment HOSPLOC The Clinic of the appointment, pointer to Hospital Location file (#44) Returned value: >0 ien of visit that relates to the apppointment 0 if there is no appointment or the appointment does not point to a visit. ROUTINE: PXAPI COMPONENT: APPT2VST VARIABLES: COMPONENT: VST2APPT VARIABLES: ******************** 1896 NAME: DBIA1889-H CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$SOURCE^PXAPI(NAME) This API returns a pointer to the PCE Data Source file (#839.7) for the text name of the Data Source. If the Data Source is not in the file it will be added and the pointer to the new entry returned. Parameter Description: NAME Text name for the source of data to PCE. Returned Value: -1 Error in processing. >0 IEN of the NAME in the PCE Data Source file. ROUTINE: PXAPI COMPONENT: SOURCE VARIABLES: ******************** 1897 NAME: DBIA1889-I CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$SWITCHD^PXAPI This call may be used to return the switch over date defined in the SD/PCE Switch Over Date field (.02) of the PCE Parameters file (815). This is the date which Scheduling stopped asking for the clinical data and PCE started asking for it instead. Parameter Definition: None Returned Value: Date Internal FileMan format for date. Null If date is undefined. ===================================================================== $$SWITCHCK^PXAPI(DATE) The call may be used to compare a date to the switch over date defined in the SD/PCE Switch Over Date field (.02) of the PCE Parameters file (815). Parameter Definition: DATE Internal FileMan date. Returned Value: 1 If the date passed is greater than or equal to the switch over date. 0 If the date passed is less than the switch over date or the switch over date is undefined. ROUTINE: PXAPI COMPONENT: SWITCHD VARIABLES: COMPONENT: SWITCHCK VARIABLES: ******************** 1898 NAME: DBIA1889-J CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$STOPCODE^PXAPI(STOPCODE,PATIENT,DATE) This function call returns the quantity of a particular Stop Code for a patient on one day. This is used by Scheduling. Parameter Definition: STOPCODE (required) pointer to #40.7 PATIENT (required) pointer to #2 DATE (required) the date in Fileman format (time is ignored if passed) Returned Value: the count of how many of that stop code are stored for that one day ====================================================================== $$CPT^PXAPI(CPT,PATIENT,DATE,HLOC) This is the function call to return the quantity of a particular CPT for a patient on one day and for one hospital location if passed. This is used by Scheduling to make sure that it has the CPT code the same number of times as PCE does. Parameter Description: CPT (required) pointer to #81 PATIENT (required) pointer to #2 DATE (required) the date in Fileman format (time is ignored if passed) HLOC (optional) pointer to Hospital Location file (#44) Returned Value: The count of how many (total quinity) of that cpt code are stored for that one day for that one patient in that one Hospital Location. ROUTINE: PXAPI COMPONENT: CPT VARIABLES: COMPONENT: STOPCODE VARIABLES: ******************** 1899 NAME: DBIA1889-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine PCE Device Interface module local array structures exported with PCE. Conventions An Error Suspension file records data that fails the verification process or if there are errors in storing. 1. In listings of valid values [1 | 0 | null] 1 denotes TRUE or YES 0 denotes FALSE or NO null denotes VALUE NOT SUPPLIED BY DATA CAPTURE APPLICATION 2. The PCE Device Interface uses a locally name-spaced array (called LOCAL in this document ) with the following gross structure to receive data from an external device. Developers should use an array in their namespace to represent the LOCAL array. It is possible that data from multiple providers was captured for the encounter. The ENCOUNTER node records information about the "main" provider. It is mandatory that this person be identified in the ENCOUNTER node. Data will NOT be moved to VISTA if such a provider is not identified on the ENCOUNTER node. The remaining nodes in the LOCAL( array [VITALS, DIAGNOSIS, PROCEDURE, PROBLEM... ] are specific to the particular PROVIDER associated with the data on that node. If the provider is unknown, (for example, the identity of the nurse who took the vitals was not captured on a scanned encounter form) the provider subscript may be set to zero except provider is required for PROBLEM. This is a concession to reality, and should not be encouraged. If a provider CAN be identified, they SHOULD be identified. Locally name-spaced array: LOCAL("DIAGNOSIS/PROBLEM",) LOCAL("PROBLEM",) LOCAL("SOURCE") LOCAL("ENCOUNTER") LOCAL("DIAGNOSIS",) LOCAL("PROCEDURE",) LOCAL("PROVIDER",) LOCAL("IMMUNIZATION",) LOCAL("SKIN TEST",) LOCAL("EXAM",) LOCAL("PATIENT ED",) LOCAL("HEALTH FACTORS",) LOCAL("VITALS",) Vitals are not processed by PCE but are passed to the Vitals/Measurement package. LOCAL("LOCAL", This data doesn PCE and will not be processed by PCE, but it may be used to pass local data to a local process (see protocol for local data processing). 3. The Encounter and Source nodes are required; the rest are optional. 4. All entries in the local array are resolved to internal values as defined below. 5. By convention; use a DUZ = .5 (the POSTMASTER) as a default when one cannot be determined. This is only for tasked jobs on some systems. 6. The data in the ENCOUNTER, PROCEDURE, and DIAGNOSIS/ PROBLEM or DIAGNOSIS nodes are the minimal set for capturing workload starting 10/1/96. The data in the rest of the nodes with the associated providers build on the clinically relevant data set and are not used for workload 7. While ENCOUNTER, PROCEDURE, and DIAGNOSIS/PROBLEM or DIAGNOSIS values are required to capture workload and generate a bill, they may not be present in every data set passed through this event point. For example, data on Vitals may be collected by a Nurse and passed through the event point for storage independent of other data associated with the encounter. Because of this, these are NOT required values in this version. 8. If there is a different (ancillary) hospital location for this patient encounter, you have to do a separate encounter. Separate calls for each hospital location are required. Required Input LOCAL( LOCAL( is a local array as defined in the remainder of this document. Developers should use an array in their namespace to represent the LOCAL array; e.g., IBDFPCE. Result returned PXCASTAT 1 = event processing occurred and the data was passed to DHCP. 0 = event processing could not occur. There is data in LOCAL("ERROR" explaining why. LOCAL("ERROR" as described below. Denotes Errors. Data associated with the error was not filed. The node does not exist if errors do not occur. LOCAL("ERROR",,,,)="Free text message^REJECTED VALUE" Where ::= "ENCOUNTER" | "VITALS" | "DIAGNOSIS" | "PROCEDURE" | "PROBLEM" | rest of list| ::= internal entry number of provider. Is 0 (ZERO) for ENCOUNTER and SOURCE ::= sub-entry 'i' for that provider Is 0 (ZERO) for ENCOUNTER, SOURCE and PROVIDER ::= $P( selector in LOCAL(,,) that failed. The value of may be 0 (ZERO) if a problem is found that does not relate to a single specific piece. LOCAL("WARNING" as described below. Denotes problems with the data that did not prevent processing. Processing continued after the warnable condition was detected. The node does not exist if warning, conditions do not occur. Warnings do NOT affect the value of PXCASTAT. LOCAL("WARNING",,,,) ="Free text message^QUESTIONABLE VALUE" Where ::= "ENCOUNTER" | "VITALS" | "DIAGNOSIS" | "PROCEDURE" | "PROBLEM" ::= internal entry number of provider. Is 0 (ZERO) for ENCOUNTER and SOURCE ::= sub-entry 'i' for that provider Is 0 (ZERO) for ENCOUNTER, SOURCE, and PROVIDER ::= $P( selector in LOCAL(,,) in question. The value of may be 0 (ZERO) if a problem is found that does not relate to a single specific piece. Entry Point for processing the data in the foreground FOREGND^PXCA(.LOCAL,.PXCASTAT) All data for the event driver is to be stored in the local array, LOCAL(, in the proper format by the source prior to calling this entry point. This entry point validates and verifies the data and then if there are no validation errors, the data is processed in the foreground. Computation by the source will not continue until all processing is completed by any and all 'down-stream' protocol event points. Entry Point for processing the data in the background on the Host BACKGND^PXCA(.LOCAL,.PXCASTAT) All data for the event driver is to be stored in the local array, LOCAL(, in the proper format by the source prior to calling this entry point. This entry point validates and verifies the data and then if there are no validation errors, the data is processed in the background via TASKMAN. Computation by the source may continue. Entry Point for data validation VALIDATE^PXCA(.LOCAL) The data in the local array, LOCAL(, is validated and verified, but is not processed. Use of this entry point by your application will result in the data being validated twice, since it is validated prior to processing by the FOREGND^PXCAEP and BACKGND^PXCAEP entry points. If a piece of data cannot be validated, an entry is placed in the LOCAL("ERROR" node as described above Protocol for local data processing PXCA DATA EVENT Other developers who wish to use any of the data in the local array, including local additions, can attach a protocol that calls their routines to the item multiple of this protocol. This protocol is activated if there are no errors in the data validation and after PCE has processed the data. For data unique to the encounter SOURCE data LOCAL("SOURCE") = 1^2^3^4^5, where: Piece 1 Data Source Required for PCE Required for SD Format: DATA SOURCES file (#839.7) Piece 2 DUZ Required for PCE Required for Scheduling Piece 3 Form numbers Not stored by PCE Piece 4 Batch ID Not stored by PCE Piece 5 Record ID Not stored by PCE Encounter data LOCAL("ENCOUNTER") = 1^2^3^4^5^6^7^8^9^10^11^12^13^14^15^16^17^18, where: LOCAL("ENCOUNTER",modifier[E;1/.01]) = "" Piece 1 Appointment Date/Time Required for PCE Required for Scheduling Format: Fileman Date/Time Piece 2 Patient DFN Required for PCE Required for Scheduling Format: Pointer to IHS PATIENT file (#9000001) Piece 3 Hospital Location IEN Each hospital location is a separate encounter P,S Format: Pointer to HOSPITAL LOCATION file (#44) Piece 4 Provider IEN This is the person that saw the Patient at the scheduled date and time. Required for PCE Format: Pointer to NEW PERSON file (#200) Piece 5 Visit CPT code IEN Format: Pointer to TYPE OF VISIT (#357.69) Piece 6 SC Condition Format: [1 | 0 | null] Piece 7 AO Condition Format: [1 | 0 | null] Piece 8 IR Condition Format: [1 | 0 | null] Piece 9 EC Condition Format: [1 | 0 | null] Piece 10 MST Condition Format: [1 | 0 | null] Piece 13 Eligibility Code IEN Format: Pointer to ELIGIBILITY CODE file (#8) Piece 14 Check-out date and time Format: Fileman Date/Time Piece 15 Provider indicator (relates to 4) Required for PCE Format: Set of Codes P ::= Primary S ::= Secondary Piece 16 Attending Physician IEN (May or may not be the same as 4) Format: Pointer to NEW PERSON file (#200) Piece 17 HNC Condition Format: [ 1 | 0 | null ] Piece 18 CV Condition Format: [ 1 | 0 | null ] All of the remaining entries in the LOCAL( array are specific to a particular Provider associated with the data on that node. If the provider is unknown, (for example, the identity of the nurse who took the vitals isn t recorded on a scanned encounter form), the provider subscript may be set to zero. Diagnosis and/or Problems, specific to one provider We recommend that you use these nodes instead of the separate Diagnosis and Problem nodes. If no Diagnosis and/or Problems, $D(LOCAL("DIAGNOSIS/PROBLEM")) is true. LOCAL("DIAGNOSIS/PROBLEM",, i) = 1^2^3^4,...17^18 where: Piece 1 Diagnosis Code IEN Required for PCE Required for Scheduling Format: Pointer to ICD9 DIAGNOSIS file (#80) Piece 2 Diagnosis Specification Code Required for PCE N/A for Problem List Format: Set of Codes P ::= Primary S ::= Secondary Piece 3 Clinical Lexicon Term IEN Format: Pointer to EXPRESSIONS file (#757.01) Piece 4 Problem IEN Required by Problem List for existing Format: Pointer to PROBLEM LIST file (#9000011) Piece 5 Add to Problem List N/A for PCE Required by Problem List for new problem Format: [1 | 0 | null] Piece 6 Problem Active? Default is Active if not specified N/A for PCE Format: Set of Codes A ::= Active I ::= Inactive Piece 7 Problem Onset Date N/A for PCE Format: Fileman Date/Time Piece 8 Problem Resolved Date N/A for PCE Format: Fileman Date/Time Piece 9 SC Condition Format: [1 | 0 | null] Piece 10 AO Condition Format: [1 | 0 | null] Piece 11 IR Condition Format: [1 | 0 | null] Piece 12 EC Condition Format: [1 | 0 | null] Piece 13 Provider Narrative Required for PCE Required by Problem List for new problem Format: free text, 2-80 Characters Piece 14 Category Header for Provider Narrative N/A for Problem List Format: free text, 2-80 Characters Piece 15 MST Condition Format: [ 1 | 0 | null ] Piece 16 HNC Condition Format: [ 1 | 0 | null ] Piece 17 CV Condition Format: [ 1 | 0 | null ] Piece 18 Order/Resulting Format: Set of Codes O ::= Ordering R ::= Resulting B ::= Both Ordering and Resulting LOCAL("DIAGNOSIS/PROBLEM",,i,"NOTE") = 1, where: Piece 1 Provider N/A for PCE Format: free text, 3-60 Characters NOTE: If the NOTE node is not needed, it does not have to exist. NOTE: Information is passed to Problem List if there is data for any of the positions 5-8 on the "DIAGNOSIS/PROBLEM" node or if there is "NOTE" node. NOTE: A provider is required to add a new problem to the Problem List. Diagnosis data list, specific to one provider, for Problems being treated at this encounter: If no Diagnoses, then '$D(LOCAL("DIAGNOSIS",))is true. LOCAL("DIAGNOSIS",,i) = 1^2^3^4^...^13^14 where: Piece 1 Diagnosis code IEN Required for PCE Required for Scheduling Format: Pointer to ICD9 DIAGNOSIS File (#80) Piece 2 Diagnosis specification code Will default to "S" if blank Format: Set of Codes. P ::= Primary S ::= Secondary Piece 3 SC Condition Format: [1 | 0 | null] Piece 4 AO Condition Format: [1 | 0 | null] Piece 5 IR Condition Format: [1 | 0 | null] Piece 6 EC Condition Format: [1 | 0 | null] Piece 7 Associated Problem IEN Format: Pointer to PROBLEM LIST file 9000011 Piece 8 Physician's term for Diagnosis Required for PCE Format: free text, 2-80 Characters Piece 9 Physician's term for Category Header May have been used as a grouping for a set of related Diagnosis which the provider selected from Format: free text, 2-80 Characters Piece 10 Lexicon IEN Format: Pointer to EXPRESSIONS File (#757.01) Piece 11 MST Condition Format: [ 1 | 0 | null ] Piece 12 HNC Condition Format: [ 1 | 0 | null ] Piece 13 CV Condition Format: [ 1 | 0 | null ] Piece 14 Order/Resulting Format: Set of Codes O ::= Ordering R ::= Resulting B ::= Both Ordering and Resulting NOTE: PCE recommends using the DIAGNOSIS/PROBLEM node so that the diagnosis can point to the problem that it relates to. Procedures data list, specific to one provider If no Procedures, then '$D(LOCAL("PROCEDURE",)) is true. LOCAL("PROCEDURE",,i) = 1^2^3^4^5^6^7^8^9^10^ 11^12^13^14,(pieces defined below) LOCAL("PROCEDURE",,i,modifier[E;1/.01]) = "" Piece 1 CPT4 Procedure code Required by PCE for V CPT file (Procedures) if this field is blank then will be stored in V TREATMENT file Required for Scheduling Format: Pointer to CPT file (#81) Piece 2 Quantity Performed Required for PCE Required for Scheduling Format: number > 0 Piece 3 Procedure specification code For CPT only. Format: Set of Codes P ::= Primary S ::= Secondary Piece 4 Date/Time Procedure performed Format: Fileman Date/Time Piece 5 Primary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 6 Physician's term for Procedure Required for PCE Format: free text, 2-80 Characters Piece 7 Physician's term for Category Header May have been used as a grouping for a set of related Procedures which the provider selected from Format: free text, 2-80 Characters Piece 8 1st Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 9 2nd Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 10 3rd Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 11 4th Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 12 5th Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 13 6th Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 14 7th Secondary Associated Diagnosis IEN For this CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) NOTE: If a Procedure doesn t have a CPT code, it can be passed without one and will be stored in the V Treatment file but will not be used for workload or billing. Problem data list, specific to one provider If no Problems, then '$D(LOCAL("PROBLEM",)) is true. LOCAL("PROBLEM",,i) = 1^2^3^4^5^...^15 where: Piece 1 Problem Name Required for new Problem List, i.e. if Pos. 10 is null Format: free text Piece 2 Problem Onset Date Format: Fileman Date/Time Piece 3 Problem Active? Default is ACTIVE if not specified Format: [1 | 0 | null] Piece 4 Problem Date Resolved Format: Fileman Date/Time Piece 5 SC Condition Format: [1 | 0 | null] Piece 6 AO Condition Format: [1 | 0 | null] Piece 7 IR Condition Format: [1 | 0 | null] Piece 8 EC Condition Format: [1 | 0 | null] Piece 9 ICD 9 Code value {optional} Format: Pointer to ICD DIAGNOSIS File (#80) Piece 10 Problem IEN Must be null if new problem Required for editing existing Problem Format: Pointer to PROBLEM LIST file 9000011 Piece 11 Physician's term for Problem Null if new problem Format: free text, 60 Characters Max Piece 12 Lexicon IEN Format: Pointer to EXPRESSIONS File (#757.01) Piece 13 MST Condition Format: [ 1 | 0 | null ] Piece 14 HNC Condition Format: [ 1 | 0 | null ] Piece 15 CV Condition Format: [ 1 | 0 | null ] NOTE: The data in this node is passed to Problem List. A Provider is required to add a new problem to the Problem List. When a new problem is added to the Problem List, the problem IEN is not required. If data is passed to edit existing data, the problem IEN must be passed. NOTE: It is better to use the DIAGNOSIS/PROBLEM node so that the diagnosis can point to the problem that it relates to. Provider data list, specific to one provider Use this node to pass of additional providers which do not have data associated with them. If no additional Providers, then '$D(LOCAL("PROVIDER",< PROVIDER IEN>)) is true. LOCAL ("PROVIDER",= 1^2 where: Piece 1 Provider indicator Required for PCE Format: Set of Codes. P: = Primary S: = Secondary Piece 2 Attending Format: [1|0| null] NOTE: If a provider is on the Encounter node and also on this node then the data on this node will be used for Primary/Secondary indicator. Immunization data list, specific to one provider If no immunization entries, then '$D(LOCAL("IMMUNIZATION",)) is true. LOCAL ("IMMUNIZATION",,i)=1^2^3^4^5^6^7^8^9^10^11^12^13^14^15 Piece 1 Immunization Required for PCE Format: Pointer to IMMUNIZATION File (9999999.14) Piece 2 Series Format: Set of Codes. P::=Partially complete C::=Complete B::=Booster 1::=Series1 ... 8::=Series8 Piece 4 Reaction REACTION Field (9000010.11,.06) SET Format: Set of Codes. '0' FOR NONE '1' FOR FEVER; '2' FOR IRRITABILITY; '3' FOR LOCAL REACTION OR SWELLING; '4' FOR VOMITING; '5' FOR RASH OR ITCHING; '6' FOR LETHARGY; '7' FOR CONVULSIONS; '8' FOR ARTHRITIS OR ARTHRALGIAS; '9' FOR ANAPHYLAXIS OR COLLAPSE; '10' FOR RESPIRATORY DISTRESS; '11' FOR OTHER; Piece 5 Contraindicated Format: [1|0|null] Piece 6 Event D/T Format: Fileman Date/Time Piece 7 Remarks Format: Comment Piece 8 Primary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80 Piece 9 1st Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 10 2nd Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 11 3rd Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 12 4th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 13 5th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 14 6th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 15 7th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Skin Test data list, specific to one provider If no skin test entries, then '$D(LOCAL("SKIN TEST",)) is true. LOCAL ("SKIN TEST",,i)=1^2^3^4^5^6^7^8^9^10^11^12^13 Piece 1 SKIN TEST Required for PCE Format: Pointer to SKIN TEST File (9999999.28) Piece 2 READING Format: Whole number between 0 and 40 inclusive Piece 3 RESULT Format: Set of Codes. P::=Positive N::=Negative D::=Doubtful 0::=No Take Piece 4 Date Read Format: Fileman Date/Time Piece 5 Date of Injection Format: Fileman Date/Time Piece 6 Primary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80 Piece 7 1st Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 8 2nd Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 9 3rd Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 10 4th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 11 5th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 12 6th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Piece 13 7th Secondary Associated Diagnosis IEN For this mapped CPT only. Format: Pointer to ICD DIAGNOSIS File (#80) Examination data list, specific to one provider If no examination entries, then '$D(LOCAL("EXAM",)) is true. LOCAL ("EXAM",")=1^2 Piece 1 EXAM Required for PCE Format: Pointer to EXAM File (9999999.15) Piece 2 RESULT Format: Set of Codes. A::=Abnormal N::=Normal Patient Education data list, specific to one provider If no Patient Education entries, then '$D(LOCAL("PATIENT ED",)) is true. LOCAL ("PATIENT ED",,i)=1^2 Piece 1 Topic Required for PCE Format: Pointer to EDUCATION TOPICS File (9999999.09) Piece 2 Level of Understanding Format: Set of Codes. 1::=Poor 2::=Fair 3::=Good 4::=Group - No Assessment 5::=Refused Health Factors data list, specific to one provider If no Health Factors entries, then '$D(LOCAL("HEALTH FACTORS",)) is true. LOCAL ("HEALTH FACTORS",,i)=1^2 Piece 1 Health Factor Required for PCE Format: Pointer to HEALTH FACTORS File (9999999.64) Piece 2 Level/Severity Format: Set of Codes. M::=Minimal MO::=Moderate H::=Heavy/Severe Vitals data list, specific to one provider If no Vitals, then '$D(LOCAL("VITALS",)) is true. LOCAL("VITALS",,i) = 1^2^3^4, where: Piece 1 Type Required for PCE Format: Set of Codes. AG::= ABDOMINAL GIRTH AUD::= AUDIOMETREY BP::= BLOOD PRESSURE FH::= FUNDAL HEIGHT FT::= FETAL HEART TONES HC::= HEAD CIRCUMFERENCE HE::= HEARING HT::= HEIGHT PU::= PULSE RS::= RESPIRATIONS TMP::=TEMPERATURE TON::=TONOMETRY VC::= VISION CORRECTED VU::= VISION UNCORRECTED WT::= WEIGHT Piece 2 Value Required for PCE Format: Numeric Piece 3 Units Not stored; used for conversions Format: Set of Codes. C::=Centigrade (degrees) CM::=Centimeter F::= Fahrenheit (degrees) IN::=Inches KG::=Kilograms LB::=Pounds Piece 4 Date/Time Measurement taken Format: Fileman Date/Time If the TYPE is HT: If the UNIT is CM it is converted to IN so that it can be stored. If the UNIT is "" it is assumed to be IN. If the TYPE is WT If the UNIT is KG it is converted to LB so that it can be stored. If the UNIT is "" it is assumed to be LB. If the TYPE is TMP If the UNIT is C it is converted to F so that it can be stored. If the UNIT is "" it is assumed to be F. NOTE: This data is passed to the Vitals/Measurement package for validation and storage. Local data list, specific to one provider If no local entries, then '$D(LOCAL("LOCAL",)) is true. LOCAL("LOCAL",,i) = Site Specific data encoding Pieces All Site Specific data encoding Not stored in PCE Format: Site Specific NOTE: LOCAL("LOCAL" where "LOCAL" is replaced by locally namespaced string. ROUTINE: PXCA COMPONENT: FOREGND VARIABLES: COMPONENT: BACKGND VARIABLES: COMPONENT: VALIDATE VARIABLES: ******************** 1900 NAME: DBIA1900-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Visit Tracking is a utility that can be used by a variety of VISTA modules (usually via PCE), with potential benefits for clinical, administrative, and fiscal applications. Visit Tracking will allow VISTA packages to link an event to a patient visit entry, thereby linking that event to any number of events occurring throughout the hospital during the patient's outpatient and/or inpatient episode. Visit Tracking is not a stand-alone application. Other packages will normally call PCE, which will handle the calls to Visit Tracking. The key to the creation of visits will be to ensure the clinical meaningfulness of visits. The creation of visits is facilitated by the Visit Tracking module. In order to ensure a consistent implementation of visit creation across packages, each package needs to have an agreement with the Visit Administrator to create visits. This section describes the guidelines which should be used for VA developers populating visits in the Visit file. These guidelines are based on a combination of the experience of Albuquerque's joint venture sharing, IHS' PCC pilot test at Tucson VAMC, MCCR data capture pilots, HSR&D workload reporting studies at Hines VAMC, and DMMS/DSS event data capture. The purpose of the VISIT file in the VA: The VISIT file has multiple purposes. The primary role is to record when and where clinical encounters related to a patient have occurred. Visits will be recorded for both Outpatient and Inpatient encounters. Outpatient encounters include scheduled appointments and walk-in unscheduled visits. Inpatient encounters include the admission of a patient to a VAMC and any clinically significant change related to treatment of that patient. For example, a treating specialty change is clinically significant, whereas a bed switch is not. The clinically significant visits created throughout the inpatient stay are related to the inpatient admission visit. If the patient is seen in a clinic while an Inpatient, a separate visit will be created representing the appointment visit?this visit is related to the Admission visit. A clinician's telephone communications with a patient may be represented by a separate visit. The clinical visits can be viewed from two approaches: 1) a team of providers can be associated with a primary clinical visit (this is the traditional view taken by IHS); or 2) a primary clinic visit can represent the primary provider's care, and a separate visit can be created to reflect the secondary provider's care. Additionally, the VISIT file can provide a breakdown of other ancillary services provided during the clinically significant visit. Laboratory or Radiology services are other examples of services provided that could have a separate visit reflecting the service involvement related to a clinic appointment on the same day. Create and/or Match Visit Using Input Criteria ^VSIT INPUT: VSIT VSIT("VDT") may be used instead of VSIT. (time will default to 12 noon if not specified) DFN VSIT("PAT") may be used instead of DFN. [VSIT(0)] [VSIT("")] (used in match logic if VSIT(0)["M") (for SVC, TYP, INS, CLN, ELG, LOC) Note: For multiple field values use [[^...]] i.e., VSIT("SVC")="H^D" (will find both) VSITPKG VSIT("PKG") may be used instead of VSITPKG. OUTPUT: VSIT() N^S[^1] where: N = or -1 if could not get a visit or -2 if calling package is not active in Visit Package Parameters S = 1 = ) array passed in with all the entries defined and the defaulted values added VSIT(,) returns the data that is stored in the Visit file in the same format as VSIT() Variable descriptions: VSIT() Variable Names for VISIT file fields, Where is a general reference to the field mnemonic. file: 9000010, global: ^AUPNVSIT( Key Indicates r indicated a required field m matching/screening logic can/does apply s system generated e strongly encouraged Key Field Variable Description .001 VSIT("IEN") NUMBER (visit internal entry number) rm .01 VSIT("VDT") VISIT/ADMIT DATE&TIME (date) s .02 VSIT("CDT") DATE VISIT CREATED (date) m .03 VSIT("TYP") TYPE (set) rm .05 VSIT("PAT") PATIENT NAME (pointer PATIENT file #9000001) (IHS file DINUMed to PATIENT file #2) m .06 VSIT("INS") LOC. OF ENCOUNTER (pointer LOCATION file #9999999.06) (IHS file DINUMed to INSTITUTION file #4) .07 VSIT("SVC") SERVICE CATEGORY (set) ms .08 VSIT("DSS") DSS ID (pointer to CLINIC STOP file) .09 VSIT("CTR") DEPENDENT ENTRY COUNTER (number) .11 VSIT("DEL") DELETE FLAG (set) .12 VSIT("LNK") PARENT VISIT LINK (pointer VISIT file #9000010) s .13 VSIT("MDT") DATE LAST MODIFIED (date) .18 VSIT("COD") CHECK OUT DATE&TIME (date) .21 VSIT("ELG") ELIGIBILITY (pointer ELIGIBILITY CODE file #8) rm .22 VSIT("LOC") HOSPITAL LOCATION (pointer HOSPITAL LOCATION file #44) .23 VSIT("USR") CREATED BY USER (pointer NEW PERSON file #200) .24 VSIT("OPT") OPTION USED TO CREATE (pointer OPTION file #19) .25 VSIT("PRO") PROTOCOL (pointer PROTOCOL file #101) .26 VSIT("ACT") PFSS ACCOUNT REFERENCE (pointer PFSS ACCOUNT file #375) 2101 VSIT("OUT") OUTSIDE LOCATION (free text) 80001 VSIT("SC") SERVICE CONNECTED (set) 80002 VSIT("AO" AGENT ORANGE EXPOSURE (set) 80003 VSIT("IR") IONIZING RADIATION EXPOSURE (set) 80004 VSIT("EC") PERSIAN GULF EXPOSURE (set) 80005 VSIT("MST") MILITARY SEXUAL TRAUMA (set) 15001 VSIT("VID") VISIT ID (free text) 15002 VSIT("IO") PATIENT STATUS IN/OUT (set) 15003 VSIT("PRI") ENCOUNTER TYPE (set) 81101 VSIT("COM") COMMENTS r 81202 VSIT("PKG") PACKAGE (pointer PACKAGE file #9.4) 81203 VSIT("SOR") DATA SOURCE (pointer PCE DATA SOURCE file #839.7) r VSIT(0) A string of characters that defines how the visit processor will function. F Force adding a new entry. I Interactive mode E Use patient's primary eligibility if not defined on call with VSIT("ELG"). N Allow creation of new visit. D Look back "n" number of days for match, defaults to one (1). D[] i.e., VSIT(0)="D7" e.g., VSIT(0)="D5" (visit date to visit date - 4) use "D0" to require exact match on visit date and time. M Impose criteria on matching/screening of visits. Uses the VSIT() array: Matching elements must equal their corresponding field. mr DFN Internal entry number of the patient file. If not defined the VSIT("PAT") will be used. mr VSIT The date (and time) of the visit. If not defined then VSIT("VDT") will be used. r VSITPKG Package Name Space. If not defined then VSIT("PKG") will be used. VSIT() N^S[^1] where: N = S = 1 = ROUTINE: VSIT COMPONENT: VSIT VARIABLES: ******************** 1901 NAME: VISIT FILE DATE LAST MODIFIED CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine MODIFIED^VSIT(IEN) Sets the Date Last Modified (.13) field to NOW. This is used by PCE so that the Date Last Modified refers to any modification to the Visit or any V-File. Parameter Description: IEN Pointer to the Visit file (#9000010) Returned Value: none ========================================================================== UPD^VSIT This will update any fields in the Visit file (#9000010) that can be edited. Look up a visit and return all of its information Where VSIT("HNC") has been identified as the reason for the visit, It will also update the NOSE AND THROAT RADIUM HISTORY file (#28.11) to validate the patient has been treated for Head and Neck Cancer, if no previous validation has taken place. Parameter Description: VSIT("IEN") Pointer to the Visit file (#9000010) Any of the following variables that are going to be updated: Field # Variable Description .03 VSIT("TYP") TYPE (set) .06 VSIT("INS") LOC. OF ENCOUNTER (pointer LOCATION file #9999999.06) (IHS file DINUMed to INSTITUTION file #4) .07 VSIT("SVC") SERVICE CATEGORY (set) .08 VSIT("DSS") DSS ID (pointer to CLINIC STOP file) .12 VSIT("LNK") PARENT VISIT LINK (pointer VISIT file #9000010) .13 VSIT("MDT") DATE LAST MODIFIED (date) This will be set to "NOW" by Visit Tracking. .18 VSIT("COD") CHECK OUT DATE&TIME (date) .21 VSIT("ELG") ELIGIBILITY (pointer ELIGIBILITY CODE file #8) .22 VSIT("LOC") HOSPITAL LOCATION (pointer HOSPITAL LOCATION file #44) .23 VSIT("USR") CREATED BY USER (pointer NEW PERSON file #200) .24 VSIT("OPT") OPTION USED TO CREATE (pointer OPTION file #19) .25 VSIT("PRO") PROTOCOL (pointer PROTOCOL file #101) 2101 VSIT("OUT") OUTSIDE LOCATION (free text) 80001 VSIT("SC") SERVICE CONNECTED (set) 80002 VSIT("AO") AGENT ORANGE EXPOSURE (set) 80003 VSIT("IR") IONIZING RADIATION EXPOSURE (set) 80004 VSIT("EC") PERSIAN GULF EXPOSURE (set) 80005 VSIT("MST") MILITARY SEXUAL TRAUMA (set) 80006 VSIT("HNC") HEAD AND NECK CANCER (set) 80007 VSIT("CV") COMBAT VETERAN (set) 80008 VSIT("SHAD") PROJECT 112/SHAD (set) 80009 VSIT("CLV") CAMP LEJEUNE EXPOSURE (set) 15001 VSIT("VID") VISIT ID (free text) 15002 VSIT("IO") PATIENT STATUS IN/OUT (set) 15003 VSIT("PRI") ENCOUNTER TYPE (set) 81101 VSIT("COM") COMMENTS 81202 VSIT("PKG") PACKAGE (pointer PACKAGE file #9.4) 81203 VSIT("SOR") DATA SOURCE (pointer PCE DATA Returned Value: none ROUTINE: VSIT COMPONENT: UPD VARIABLES: COMPONENT: MODIFIED VARIABLES: ******************** 1902 NAME: DBIA1900-C CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER SCHEDULING RADIOLOGY/NUCLEAR MEDICINE TEXT INTEGRATION UTILITIES EVENT CAPTURE LAB SERVICE CLINICAL REMINDERS CLINICAL PROCEDURES REGISTRATION USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Ever field that points to the Visit file (#9000010) needs to have two cross references. One is a regular Fileman cross reference. If the field is in a multiple then this cross reference must be a whole file cross reference. This cross reference is used to make sure that a Visit file entry is not delete as long as there is a user of the entry. The second cross reference calls ADD for the set logic and SUB for the kill logic. This cross reference tells Visit Tracking how many file entries are using (pointing to) a Visit file entry. Below is an example of this cross reference CROSS-REFERENCE: file number^Asomething^MUMPS 1)= D ADD^AUPNVSIT 2)= D SUB^AUPNVSIT This cross-reference adds and subtracts from the dependent entry count in the VISIT file. ADD^VSIT or the more effect version: ADD^AUPNVSIT Increase the dependent entry count for the Visit file entry by one. INPUT X Visit IEN SUB^VSIT or the more effect version: SUB^AUPNVSIT Decrease the dependent entry count for the Visit file entry by one. INPUT X Visit IEN NOTE: These calls are customarily done through a MUMPS cross reference on the field pointing to a Visit file entry. The input parameter X is set by Fileman. ROUTINE: VSIT COMPONENT: ADD VARIABLES: COMPONENT: SUB VARIABLES: ******************** 1903 NAME: DBIA1900-D CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$IEN2VID^VSIT(VISIT) This function returns the Visit ID for the Visit IEN passed in. Parameter: VISIT IEN to a Visit file (#9000010) entry Returned value: Visit ID if value Visit IEN -1 if the Visit IEN is not a valued pointer ======================================================================= $$VID2IEN^VSIT(VID) This function returns the Visit IEN for the Visit ID passed in. Parameter: VID Visit ID Returned value: >0 IEN to a Visit file (#9000010) entry -1 if there is no Visit file (#9000010) entry for the Visit ID ROUTINE: VSIT COMPONENT: IEN2VID VARIABLES: COMPONENT: VID2IEN VARIABLES: ******************** 1904 NAME: DBIA1900-E CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER SCHEDULING LAB SERVICE BAR CODE MED ADMIN ADDED 8/28/09 USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$PKG2IEN^VSIT(PKG) Returns a pointer to the Package file when you pass in the package name space or name. The pointer to the package is required for some calls to PCE. This function is provided so that the calling packages all do not have to do this lookup themselves. Parameter Description: PKG Package name space or name Returned Value: >0 Pointer to the package in the Package file #9.4 -1 If called without PKG or if could not find the package in the Package file. $$PKGON^VSIT(PKG) Returns the active flag for the package. A package that is active can create Visits. PCE will be creating the Visits for most packages so they will not need to be active. Only PCE will need to be active to create the visit for them. Parameter Description: PKG Package name space or name Returned Value: 1 The package can create visits (active) 0 The package cannot create visits (not active) -1 Called wrong or could not find package in Visit Tracking Parameters file # 150.9 ROUTINE: VSIT COMPONENT: PKG2IEN VARIABLES: COMPONENT: PKGON VARIABLES: ******************** 1905 NAME: RETURN SELECTED VISITS FROM VSIT CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL CASE REGISTRIES VA CERTIFIED COMPONENTS - DSSI ORDER ENTRY/RESULTS REPORTING INPATIENT MEDICATIONS VISUAL IMPAIRMENT SERVICE TEAM EVENT CAPTURE ECS added 8/12/09 VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine SELECTED^VSIT(DFN,SDT,EDT,HOSLOC,ENCTYPE,NENCTYPE,SERVCAT,NSERVCAT,LASTN) Returns selected visits depending on screens passed in. Parameter Description: Only the DFN is required. DFN Pointer to the Patient file (#2) SDT Start Date EDT End Date HOSLOC Pointer to the Hospital Location file (#44) ENCTYPE Encounter types is a string of all the Encounter Types (field #15003) wanted. e.g. "OA" for only Ancillary and Occasion of service NENCTYPE Not Encounter types is a string of all the Encounter Types (field #15003) not wanted. e.g. "T" for do not include Telephone SERVCAT Service Categories is a string of all the Service Categories (field #.07) to include. If non is passed all is assumed. e.g. "H" for just historical. "T" for just Telephone. "AIT" for ambulatory (in and out patient) and Telephone. NSERVCAT Not Service categories is a string of all the Service Categories (field #.07) to not include. LASTN How many to return starting with the End Date an going backwards Returned Array: (may be killed before and after use) ^TMP("VSIT",$J,vsit ien,#) vsit ien Pointer to the Visit file (#9000010) # Is a sequence number i.e. 1,2,3, ... Where the values stored in the array are of the form: Piece 1: Date and Time from the Vsit File Entry Piece 2: If Service Category '= "H" then Hospital Location (pointer to file#44) ";" External Value If Service Category = "H" then Location of Encounter (Pointer to file #9999999.06) ";" External Value Piece 3: Service Category (Value of field .07 set of codes) Piece 4: Service Connected (Value of field 80001 External Value) Piece 5: Patient Status in/out (Value of field 15002 set of codes) Piece 6: Clinic Stop ien (Pointer to file # 40.7 ";" External value) ROUTINE: VSIT COMPONENT: SELECTED VARIABLES: ******************** 1906 NAME: DBIA1900-G CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL CASE REGISTRIES VA CERTIFIED COMPONENTS - DSSI USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$LOOKUP^VSIT(IEN,FMT,WITHIEN) Look up a visit and return all of its information. Parameter Description: IEN Visit IEN OR the Visit's ID FORMAT Is the format that you want the output in, where: I ::= internal format E ::= external format B ::= both internal and external format B is the default if anything other than "I" or "E" WITHIEN 0 if you do not want the ien of the vsit as the first subscript 1 if you do. 1 is the default. Returned Value: >0 Pointer to the Visit file (#9000010) -1 if IEN was not a valid IEN or Visit ID Returned Array: The array of all the fields in the visit file. If both internal and external format are returned the format is: internal^external VSIT(,) or VSIT() depending on the value of WITHIEN Field # Variable Description .01 VSIT("VDT") VISIT/ADMIT DATE&TIME (date) .02 VSIT("CDT") DATE VISIT CREATED (date) .03 VSIT("TYP") TYPE (set) .05 VSIT("PAT") PATIENT NAME (pointer PATIENT file #9000001) (IHS file DINUMed to PATIENT file #2) .06 VSIT("INS") LOC. OF ENCOUNTER (pointer LOCATION file #9999999.06) (IHS file DINUMed to INSTITUTION file #4) .07 VSIT("SVC") SERVICE CATEGORY (set) .08 VSIT("DSS") DSS ID (pointer to CLINIC STOP file) .09 VSIT("CTR") DEPENDENT ENTRY COUNTER (number) .11 VSIT("DEL") DELETE FLAG (set) .12 VSIT("LNK") PARENT VISIT LINK (pointer VISIT file #9000010) .13 VSIT("MDT") DATE LAST MODIFIED (date) .18 VSIT("COD") CHECK OUT DATE&TIME (date) .21 VSIT("ELG") ELIGIBILITY (pointer ELIGIBILITY CODE file #8) .22 VSIT("LOC") HOSPITAL LOCATION (pointer HOSPITAL LOCATION file #44) .23 VSIT("USR") CREATED BY USER (pointer NEW PERSON file #200) .24 VSIT("OPT") OPTION USED TO CREATE (pointer OPTION file #19) .25 VSIT("PRO") PROTOCOL (pointer PROTOCOL file #101) 2101 VSIT("OUT") OUTSIDE LOCATION (free text) 80001 VSIT("SC") SERVICE CONNECTED (set) 80002 VSIT("AO") AGENT ORANGE EXPOSURE (set) 80003 VSIT("IR") IONIZING RADIATION EXPOSURE (set) 80004 VSIT("EC") PERSIAN GULF EXPOSURE (set) 80005 VSIT("MST") MILITARY SEXUAL TRAUMA (set) 80006 VSIT("HNC") HEAD AND NECK CANCER (set) 80007 VSIT("CV") COMBAT VETERAN (set) 80008 VSIT("SHAD") PROJECT 112/SHAD (set) 80009 VSIT("CLV") CAMP LEJEUNE EXPOSURE (set) 15001 VSIT("VID") VISIT ID (free text) 15002 VSIT("IO") PATIENT STATUS IN/OUT (set) 15003 VSIT("PRI") ENCOUNTER TYPE (set) 81101 VSIT("COM") COMMENTS 81202 VSIT("PKG") PACKAGE (pointer PACKAGE file #9.4) 81203 VSIT("SOR") DATA SOURCE (pointer PCE DATA SOURCE file (#839.7) ROUTINE: VSIT COMPONENT: LOOKUP VARIABLES: ******************** 1907 NAME: DBIA1900-H CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL CASE REGISTRIES USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$HISTORIC^VSIT(IEN) Returns a flag indicating whether the visit is Historical. Parameter Description: IEN Pointer to the Visit file (#9000010) Returned Value: 1 If it is an Historical visit ("E" in the Service Category field #.07) 0 If it is not an Historical visit -1 If the IEN is bad ROUTINE: VSIT COMPONENT: HISTORIC VARIABLES: ******************** 1908 NAME: DBIA1900-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER SCHEDULING USAGE: Private ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine $$PKG^VSIT(PKG,VALUE) This API adds the package to the Package multiple (field #3) of the Visit Tracking Paramenters (150.9) file. It also set the sets the Active Flag in the multiple. If the package is already in the Package multiple it just set the Active Flag for that package. Parameter Description: PKG Package Name Space VALUE Value on the ON/OFF flag under package multiple 1 for ON and 0 for OFF Returned Value: 1^active Where active is the value stored in the active flag -1 Error in processing ROUTINE: VSIT COMPONENT: PKG VARIABLES: ******************** 1909 NAME: DBIA1900-B CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER SCHEDULING USAGE: Controlled Subscri ENTERED: JAN 23,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2.0 FILE: ROOT: DESCRIPTION: TYPE: Routine KILL^VSITKIL(IEN) Deletes the visit if there is no files pointing to it. Before deleting checks all the backward pointers to see if the visit is being pointed to. Parameter Description: IEN Pointer to the Visit file (#9000010) ROUTINE: VSITKIL COMPONENT: KILL VARIABLES: ******************** 1910 NAME: DBIA1910 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX MENTAL HEALTH USAGE: Controlled Subscri ENTERED: JAN 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File DSS Extracts references the following data from the OUTPATIENT ENCOUNTER file (#409.68). The data is referenced in the Clinic Visit Extract for scheduled appointments, dispositions, stand- alones, and appended visits. (1) In determining the number of scheduled appointments: For each clinic in the HOSPITAL LOCATION file, the APPOINTMENT multiple is examined. For each patient appointment in the date range, the APPOINTMENT multiple in the PATIENT file is examined. We get the OUTPATIENT ENCOUNTER (p20) pointer. Using this IEN, we get the VISIT FILE ENTRY from the OUTPATIENT ENCOUNTER file. This is used to call a PCE API for data. (2) In determining the number of dispositions, stand-alones, etc.: We loop through the "B" cross-reference of the OUTPATIENT ENCOUNTER file for the extract date range and get the encounter IEN. Since all of the data is on the zero node, we set a local variable to the zero node and process it from there. DSS uses the "B" cross reference on the DATE field. ^SCE("B",DATE,D0) ^SCE(D0,0) .01 DATE 0;1 Direct Global Read & w .02 PATIENT 0;2 Direct Global Read & w .03 CLINIC STOP CODE 0;3 Direct Global Read & w .04 LOCATION 0;4 Direct Global Read & w .05 VISIT FILE ENTRY 0;5 Direct Global Read & w .06 PARENT ENCOUNTER 0;6 Direct Global Read & w .08 ORIGINATING PROCESS 0;8 Direct Global Read & w The zero node is read into a local variable. The fields above are used. ROUTINE: ******************** 1911 NAME: DBIA1911 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING MENTAL HEALTH The Addiction Severity Index (ASI) module of Mental Health uses this call to file ASI notes. LAB SERVICE OUTPATIENT PHARMACY IMAGING DIETETICS added 12/10/2007 USAGE: Controlled Subscri ENTERED: JAN 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API may be called by an application on the VistA server to create a TIU Document with the following constraints and optional properties: Return variable (must pass by reference): TIUIFN (pass by ref) = New note IFN in file 8925, = -1 or variations if error. Required Input parameters: DFN = Patient IFN in file #2 TIUAUTH = Author IFN in file #200 TIURDT = Date/time of note in FM format TIUTITLE = Title IFN in file 8925.1 Required global "input" variable: ^TMP("TIUP",$J) = Array root for text in format compatible with FM Word-processing fields. e.g., ^TMP("TIUP",$J,0)=^^1^1^2961216^ ^TMP("TIUP",$J,1,0)=Testing the TIUPNAPI. Optional Input variables: TIULOC = Patient Location IFN in file #44 TIUES = 1 if TIU should prompt/process E-SIG TIUPRT = 1 if TIU should prompt user to print note TIUESBY = Signer IFN in file #200: Calling App is responsible for Electronic Signature TIUASKVS = BOOLEAN flag indicating whether to ask for visit TIUADEL = BOOLEAN flag for automatic delete instead of leaving UNSIGNED document if TIUESBY>0 and signature fails. See NOTE on TIUADEL, below. NOTE: The following change was made in patch TIU*1*184 in response to a patient safety issue where SIGNED notes were sometimes created without a valid expected cosigner being specified for users requiring cosignature. If the API is called non-interactively for a user requiring cosignature with the intention that the API create a SIGNED document (TIUESBY>0), then the signature will now FAIL. Generally signature failure leaves the document unsigned. However, if TIUADEL=1, signature failure deletes the document. ** Therefore we do not recommend the use of TIUADEL in this particular situation (non-interactive, user requires cosignature, TIUESBY>0). ** ROUTINE: TIUPNAPI COMPONENT: NEW VARIABLES: TIUIFN Type: Output Passed by Reference. If the call to NEW^TIUPNAPI is successful, the internal entry number in file 8925 will be returned. If the call is unsuccessful, the return variable will be set to -1 or a variation. DFN Type: Input Pass by value. Required. This is the Internal Entry Number of the patient in the PATIENT File (#2). TIUAUTH Type: Input Pass by value. Required. This is the internal entry number of the AUTHOR of the note in the NEW PERSON File (#200). TIURDT Type: Input Pass by value. Required. Reference Date/time of document in internal FM format. TMP Type: Input The temporary global array ^TMP("TIUP",$J) MUST be loaded with the word- processing data to be filed with the note, prior to calling the API, using the following subscripting scheme: ^TMP("TIUP",$J,0)="^^<# lines>^<# lines>^ ^ ^TMP("TIUP",$J,1,0)="" ^TMP("TIUP",$J,2,0)="" ^TMP("TIUP",$J,3,0)="" ^TMP("TIUP",$J,n,0)="" TIULOC Type: Input Pass by value. Optional. This is the Internal Entry Number of the LOCATION in the HOSPITAL LOCATION File (#44). TIUES Type: Input Pass by Value. Optional. BOOLEAN flag. Pass as 1 if you want TIU to prompt for Electronic Signature. TIUPRT Type: Input Pass by Value. Optional. BOOLEAN flag. Pass as 1 if you want TIU to prompt for printing on completion. TIUESBY Type: Input Pass by Value. Optional. Pass IEN of the person whose electronic signature is to be applied to the document. ONLY pass this if the calling application has already prompted for/validated the user's electronic signature. TIUASKVS Type: Input Pass by Value. Optional. BOOLEAN flag. Pass as 1 if you want TIU to prompt for selection of a visit with which the document is to be associated. TIUADEL Type: Input Optional. BOOLEAN flag. Pass as a 1 if TIUESBY>0 and calling application wants to have the newly created document automatically deleted if the electronic signature fails for any reason. If TIUADEL is not set, the document is left UNSIGNED. If TIUESBY>0 and the API is called non-interactively for users who require cosignature, we do NOT recommend the use of TIUADEL. See general description of API. TIUTITLE Type: To file a TIU Document from a VistA M-application, call: NEW^TIUPNAPI(TIUIFN,DFN,TIUAUTH,TIURDT,TIUTITLE,TIULOC, TIUES,TIUPRT,TIUESBY,TIUASKVS,TIUADEL) NOTE: per VistA SAC, all input parameters passed by reference in the formal list should be namespaced for the calling application. ******************** 1912 NAME: DBIA1912 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Controlled Subscri ENTERED: JAN 28,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The MAS Developers would like a one-time integration agreement with the FileMan Developers: For patch DG*5.3*111, as part of the installation environment checker, DG53111E, we check the second line of the following routine using $TEXT: DIFROMSS The check is to ensure that the package version is 21 and DIFROMSS has patch #15 indicated in its second line. This environment checker routine is necessary because the prefix, "DI", is not unique to the VA FILEMAN package in the PACKAGE file (#9.4). An earlier package named FILEMAN shares the same Prefix, and as a result, the "Required Build" function in the KIDS Build does not function properly when referencing a FileMan patch. ROUTINE: DIFROMSS ******************** 1914 NAME: GMRVALL0 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: JAN 29,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Nursing can access the following entry point described in this DBIA for GMRVED0 routine. ROUTINE: GMRVALL0 COMPONENT: LIST VARIABLES: GNUROP Type: Input This variable is passed in with a value of 1 to indicate that the edit process is requested by the Nursing Service. GMROUT Type: Both This variable indicates whether the user abnormally exited the vitals/measurements selection. It is passed in with a value of 0. GMRENTY Type: Output The type of vitals/measurements to edit. GMRSTR Type: Output The string of which vitals/measurements to edit, for example, "T;P;R;BP;". This entry point displays the vitals/measurements for the User Configurable Combination option. This option allows users to select types of vitals/measurements to edit. ******************** 1916 NAME: SCAPMC - SUPPORTED PCMM CALLS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are supported references in the SCAPMC routine: (1) $$PRTM(SCTEAM,SCDATES,SCUSRA,SCROLEA,SCLIST,SCERR) -- (2) $$PRCL(SC44,SCDATES,SCPOSA,SCUSRA,SCROLEA,SCLIST,SCERR) -- (3) $$PRPT(DFN,SCDATES,SCPOSA,SCUSRA,SCROLEA,SCPURPA,SCLIST,SCERR) -- ; (4) $$PTTM(SCTEAM,SCDATES,SCLIST,SCERR) -- (5) $$TMPT(DFN,SCDATES,SCPURPA,SCLIST,SCERR) -- (6) $$INSTPCTM(DFN,SCEFF) -- (7) $$PTPR(SC200,SCDATES,SCPURPA,SCROLEA,SCLIST,SCERR,SCYESCL)-- ROUTINE: SCAPMC COMPONENT: $$PRTM VARIABLES: $$PRTM(SCTEAM,SCDATES,SCUSRA,SCROLEA,SCLIST,SCERR) -- Extrinsic function call to return an array of practitioners who are assigned to positions on a team for a time period. Output: @SCLIST() = array of practitioners Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of NEW PERSON file entry (#200) 2 Name of person 3 IEN of TEAM POSITION file (#404.57) 4 Name of Position 5 IEN OF USR CLASS(#8930) of POSITION (#404.57 6 USR Class Name 7 IEN of STANDARD POSITION (#403.46) 8 Standard Role (Position) Name 9 Activation Date for 404.52 (not 404.59!) 10 Inactivation Date for 404.52 11 IEN of Position Ass History (404.52) 12 IEN of Preceptor Position 13 Name of Preceptor Position SCERR() = Array of DIALOG file messages(errors) . @SCERR(0)= Number of error(s), UNDEFINED if no errors Foramt: Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error COMPONENT: $$PRCL VARIABLES: $$PRCL(SC44,SCDATES,SCPOSA,SCUSRA,SCROLEA,SCLIST,SCERR) -- Extrinsic function to return a list of practitioners associated to a clinic in PCMM. There is an association if the practitioner is assigned to a position for the time period and that position has the clinic as its ASSOCIATED CLINIC. Note: Multiple positions can have the same clinic. @SCLIST() = array of practitioners Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of NEW PERSON file entry (#200) 2 Name of person 3 IEN of TEAM POSITION file (#404.57) 4 Name of Position 5 IEN OF USR CLASS(#8930) of POSITION (#404.57) 6 USR Class Name 7 IEN of STANDARD POSITION (#403.46) 8 Standard Role (Position) Name 9 Activation Date for 404.52 (not 404.59!) 10 Inactivation Date for 404.52 11 IEN of Position Ass History (404.52) 12 IEN of Preceptor Position 13 Name of Preceptor Position @sclist@('scpr',sc200,sctp,scact,scn)="" SCERR() = Array of DIALOG file messages(errors) . Foramt: @SCERR@(0) = Number of errors, undefined if none Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error COMPONENT: $$PRPT VARIABLES: $$PRPT(DFN,SCDATES,SCPOSA,SCUSRA,SCROLEA,SCPURPA,SCLIST,SCERR) -- Extrinsic function to return a list of practitioners assigned to a patient. The practitioner is assigned to a patient if both the patient and the practitioner are assigned to a position for the time period. SCLIST() = array of practitioners Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of NEW PERSON file entry (#200) 2 Name of person 3 IEN of TEAM POSITION file (#404.57) 4 Name of Position 5 IEN OF USR CLASS(#8930) of POSITION (#404.57) 6 USR Class Name 7 IEN of STANDARD POSITION (#403.46) 8 Standard Role (Position) Name 9 Activation Date for 404.52 (not 404.59!) 10 Inactivation Date for 404.52 11 IEN of Position Ass History (404.52) 12 IEN of Preceptor Position 13 Name of Preceptor Position SCERR() = Array of DIALOG file messages(errors) . @SCERR(0)= Number of error(s), UNDEFINED if no errors Foramt: Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error COMPONENT: $$PTTM VARIABLES: $$PTTM(SCTEAM,SCDATES,SCLIST,SCERR) -- Extrinsic function to return a list of patients assigned to a team for a time period. @SCLIST() = array of patients Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of PATIENT file entry 2 Name of patient 3 IEN of Patient Team Assignment 4 Activation Date 5 Inactivation Date 6 Patient Long ID (SSN) SCERR() = Array of DIALOG file messages(errors) . @SCERR@(0)=number of errors, undefined if none Foramt: Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error COMPONENT: $$TMPT VARIABLES: $$TMPT(DFN,SCDATES,SCPURPA,SCLIST,SCERR) Extrinsic function to return a list of teams assigned to a patient fo time period. Output: @SCLIST() = array of teams (includes SCTM xref) Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of TEAM file entry 2 Name of team 3 IEN of file #404.42 (Pt Tm Assignment) 4 current effective date 5 current inactivate date (if any) 6 pointer to 403.47 (purpose) 7 Name of Purpose 8 Is this the pt's PC Team? Subscript: "SCTM",SCTM,IEN ="" SCERR() = Array of DIALOG file messages(errors) . @SCERR@(0) = number of errors, undefined if none Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error ; COMPONENT: $$INSTPCTM VARIABLES: DFN Type: Input DFN - - Pointer to File #2, PATIENT File SC44 Type: Input SC44 - Pointer to File #44, Hospital Location File (clinic) SCTEAM Type: Input SCTEAM - Pointer to File #404.51, TEAM File SCEFF Type: Input SCEFF - Effective Date of interest SCDATES Type: Input SCDATES - Name of date array to define time period as follows: @SCDATES@("BEGIN") = begin date to search (inclusive) [default: TODAY] ("END") = end date to search (inclusive) [default: TODAY] ("INCL") = 1: only use pracitioners who were on team for entire date range 0: anytime in date range [default: 1] SCUSRA Type: Input SCUSRA = Name of array of usr classes to use/exclude @SCUSRA@(ptr)="", where ptr is a pointer to File #8930 if $D(@SCUSRA@("EXCLUDE")) -> list to exclude SCROLEA Type: Input SCROLEA = Name of array of roles/standard positions to include/exclude @SCROLEA@(ptr)="" where ptr is a pointer to File #403.46 if $D(@(SCROLEA@("EXCLUDE")) ->list to exclude SCPURPA Type: Input SCPURPA = Name of array of team purposes to include/exclude @SCPURPA@(ptr)="" where ptr is a pointer to File #403.47 if $D(@SCPURPA@("EXCLUDE")) -> list to exclude SCLIST Type: Output SCLIST = Name of output array (local or ^TMP reference) Example using $$PRTM: >S SCTEAM=1 ;1 is ien of 404.51 entry >S RWD("BEGIN")=DT-30 ;Time period starts 30 days ago >S RWD("END")=DT+30 ;and ends 30 days from now >S RWD("INCL")=0 ;list if active any time in period >W $$PRTM^SCAPMC(SCTEAM,"RWD",,,"RWOUT","RWERR" ) 1 >ZW RWOUT RWOUT(0)=2 RWOUT(1)=1212^INSLEY,MARCIA L.^1^AAA ROB 1^^^2^PHYSICIAN-PRIMARY CARE^2960627^^1 ^^ RWOUT(2)=10866^WHELAN,ROBERT^2^AAA ROB NURSE^^^6^NURSE (RN)^2960627^^2^1^AAA ROB 1 RWOUT("SCPR",1212,1,2960627,1)= RWOUT("SCPR",10866,2,2960627,2)= $$INSTPCTM(DFN,SCEFF) -- Extrinsic function to retrun the institution and team for the patient's prinmary care team for a given date. Returned - 0 if not ok (error), otherwise: Piece# Description 1 Pointer to the File #404.51 2 Name of Team 3 Pointer to File #4 4 Name of Institution COMPONENT: $$PTPR VARIABLES: SC200 Type: Input ien of NEW PERSON file(#200) [required] SCDATES Type: Input SCDATES("BEGIN") = begin date to search (inclusive) [default: TODAY] ("END") = end date to search (inclusive) [default: TODAY] ("INCL") = 1: only use patients who were assigned to team for entire date range 0: anytime in date range [default: 1] SCPURPA Type: Input array of pointers to team purpose file 403.47 ; if none are defined - returns all teams ; if @SCPURPA@('exclude') is defined - exclude listed teams SCROLEA Type: Input array of pointer to 403.46 (per SCPURPA) SCLIST Type: Input array name to store list [ex. ^TMP("SCPT",$J)] SCERR Type: Input array NAME to store error messages. VARIABLES: $$PTPR(SC200,SCDATES,SCPURPA,SCROLEA,SCLIST,SCERR,SCYESCL)- Extrinsic function call to return an array of patients for a practitioner within a time period. Output: SCLIST() = array of patients Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of PATIENT file entry 2 Name of patient 3 IEN of Pt Team Posit Asment if position=source 4 Activation Date 5 Inactivation Date 6 Source 1=Clinic, Null=Position 7 IEN of Clinic if clinic=source SCERR() = Array of DIALOG file messages(errors) . @SCERR@(0) = number of errors, undefined if none Format: Subscript: Sequential # from 1 to n Piece Description 1 IEN of DIALOG file Returned: 1 if ok, 0 if error ******************** 1929 NAME: DBIA1929 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: FEB 12,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.1 ROOT: PSI(58.1, DESCRIPTION: TYPE: File The Controlled Substances routines PSDTRA* need read access to #58.1 to copy data from an AREA OF USE to a NARCOTIC AREA OF USE. ^PSI(58.1,D0,0) .01 AREA OF USE 0;1 Direct Global Read & w ^PSI(58.1,D0,1,D1,0) .01 ITEM 0;1 Direct Global Read & w 1 STOCK LEVEL 0;2 Direct Global Read & w 30 INACTIVATION DATE 0;3 Direct Global Read & w 10 LOCATION 0;8 Direct Global Read & w ^PSI(58.1,D0,1,D1,2,D2,0) .01 TYPE 0;1 Direct Global Read & w ROUTINE: ******************** 1930 NAME: DBIA1930 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: FEB 13,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.7 ROOT: PS(59.7, DESCRIPTION: TYPE: File Controlled Substances needs to check the DATE OP INSTALLED field before posting outpatient prescriptions and the DATE V2 CS/DA CONVERSION field before doing a conversion in a post-init. ^PS(59.7,D0,49.99) 49.98 DATE OP INSTALLED 49.99;2 Direct Global Read & w ^PS(59.7,D0,70) 71 DATE V2 CS/DA CONVER 70;4 Direct Global R/W & w/ ROUTINE: ******************** 1931 NAME: DBIA1931 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES NATIONAL DRUG FILE AUTO REPLENISHMENT/WARD STOCK CMOP OUTPATIENT PHARMACY DRUG ACCOUNTABILITY PHARMACY BENEFITS MANAGEMENT USAGE: Controlled Subscri ENTERED: FEB 13,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.5 ROOT: DIC(51.5, DESCRIPTION: TYPE: File Various pharmacy packages need read access to this file. ^DIC(51.5,D0,0) .01 ABBREVIATION 0;1 Direct Global Read & w ROUTINE: ******************** 1932 NAME: DBIA1932 CUSTODIAL PACKAGE: INCOMPLETE RECORDS TRACKING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: FEB 13,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 393.3 ROOT: VAS(393.3, DESCRIPTION: TYPE: File This will allow Text Integration Utilities (TIU) to point to the IRT TYPE OF DEFICIENCY file #393.3. ROUTINE: ******************** 1934 NAME: DBIA1934 CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: FEB 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Distribute AMIE input template. ROUTINE: COMPONENT: DVBA C ADD 2507 PAT VARIABLES: Input Template: DVBA C ADD 2507 PAT Compiled Routine: DVBAXA File: 2 ******************** 1936 NAME: DBIA1936 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: FEB 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Distribute IB input template. ROUTINE: COMPONENT: IB SCREEN1 VARIABLES: Input Template: IB SCREEN1 Compiled Routine: IBXSC1 File: 399 ******************** 1937 NAME: DBIA1937 - EC HL7 INTERFACE CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: FEB 18,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771 ROOT: HL(771, DESCRIPTION: TYPE: File The Event Capture HL7 internal interface will reference the following data from the HL7 APPLICATION PARAMETER FILE (#771). In File 771, the Event Capture HL7 internal interface will reference the current mail group from field (#4). ^HL(771,D0,0) 4 MAIL GROUP 0;4 Direct Global Read & w Notifications of any problems that occur while generating or processing messages will be sent to the mail group specified in this field. ROUTINE: ******************** 1938 NAME: GMRVSITE CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Nursing package can use the DEFAULT and CHAR entry points in the GMRVSITE routine of the Vitals/Measurements package. ROUTINE: GMRVSITE COMPONENT: DEFAULT VARIABLES: The Change Default Qualifiers for Temp./Pulse [NURCPE-VIT VMQUALITY] option can call this entry point to change default qualifiers for temperature and pulse entries in the GMRV VITAL CATEGORY (#120.53) file. COMPONENT: CHAR VARIABLES: The Enter/Edit Vitals Qualifiers [NURCPE-VIT VMSITE] option can call this entry point to configure the GMRV VITAL QUALIFIER (#120.52) file entries. ******************** 1939 NAME: DBIA1938 - EC HL7 INTERFACE CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: FEB 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 772 ROOT: HL(772, DESCRIPTION: TYPE: File The Event Capture HL7 internal interface will reference the following data from the HL7 MESSAGE TEXT FILE (#772). In File 772, the Event Capture HL7 internal interface will reference information related to the MSH and MSA segments from the MESSAGE TEXT field (#200). ^HL(772,D0,'IN',D01,0) 200 MESSAGE TEXT IN;0 Direct Global Read & w The actual text of the incoming HL7 message(s). ROUTINE: ******************** 1940 NAME: GMRVCAQU CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: FEB 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Nursing package can call EN1^GMRVCAQU in the Vitals/Measurements package. ROUTINE: GMRVCAQU COMPONENT: EN1 VARIABLES: The Display Vitals Category/Qualifier Table [NURCPE-VIT CAT/QUAL TABLE] option can call this entry point to display a table of categories and qualifiers for various vitals/measurements (e.g., blood pressure). ******************** 1941 NAME: SETTING DD NODES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS USAGE: Private ENTERED: FEB 21,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: AICS V3.0 FILE: 1 ROOT: DD( DESCRIPTION: TYPE: File This integration agreement is for a one time use for AICS v3.0 to set the following three DD nodes. These nodes point to the Expressions file (757.01) which has changed global locations in Lexicon Utility v2.0 from ^GMP to ^LEX. Approximately half of VAMC's have installed Lexicon Utility v2.0. The setting of these nodes will set the Data Dictionaries to the correct global location for the version of Lexicon Utility. I $D(^LEX) D .S ^DD(357.3,2.02,0)="CLINICAL LEXICON ENTRY^P757.01'^LEX(757.01,^2;2^Q" .S ^DD(358.3,2.02,0)="CLINICAL LEXICON ENTRY^P757.01'^LEX(757.01,^2;2^Q" .S ^DD(357.951,2.02,0)="CLINICAL LEXICON^P757.01'^LEX(757.01,^2;2^Q" .D MES^XPDUTL(">>> AICS Data Dictionaries updated to use Lexicon Utility version 2.0") E D MES^XPDUTL(">>> AICS Data Dictionaries updated to use Clinical Lexicon Utility version 1.0") ^DD(357.3,2.02,0) ALL Direct Global Write & ^DD(358.3,2.02,0) ALL Direct Global Write & ^DD(357.951,2.02,0) ALL Direct Global Write & ROUTINE: ******************** 1945 NAME: DBIA1945 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 3,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.51 ROOT: SCTM(404.51, DESCRIPTION: TYPE: File DSS Extracts references the following data from the TEAM file (#404.51). A DSS option, "Primary Care Team Print", prints an alphabetical list of all primary care teams and the IEN for each team. The intent of the option is to provide help for building primary care teams on the commercial DSS system. ^SCTM(404.51,D0,0) .01 NAME O;1 Read w/Fileman ROUTINE: ******************** 1946 NAME: DBIA1946 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DSS Extracts uses the Lab Service LRCAPDSS routine. For a date range, the LRCAPDSS routine examines the WKLD DATA file (#64.1) and stores appropriate data into the WKLD LOG FILE file (#64.03) for use by the DSS Laboratory Extract. Variables: LRSDT Input Start Date LREDT Input End Date Prior to running this routine, the calling routine will purge the WKLD LOG FILE file (#64.03). ROUTINE: LRCAPDSS COMPONENT: LRCAPDSS VARIABLES: ******************** 1947 NAME: DBIA1947 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX VBECS IMAGING VistA Imaging (VI) requests to obtain TYPE (#3) and SUBSCRIPT(#4) field data from the LABORATORY TEST (#60) file. VI also requests to obtain data from the NATIONAL VA LAB CODE (#64) field from the LABORATORY TEST (#60) file. USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File DSS Extracts references and points to the following data from the LABORATORY TEST file (#60). DSS accesses the NAME field using a direct global read for the "Print DSS Lab Test Datasheet" option and for generating DSS lab feeder keys. The DSS Extracts LABORATORY EXTRACT file (#727.813) contains a field, TEST, and the DSS LAB TESTS file (#727.2) contains a multiple field, LOCAL LAB TEST NAME, which point to the LABORATORY TEST file (#60). The DSS Lab Results Extract references the NATIONAL VA LAB CODE field. ^LAB(60,IEN,0) .01 NAME 0;1 Direct Global Read & w 3 TYPE 0;3 Direct Global Read & w 4 SUBSCRIPT 0;4 Direct Global Read & w ^LAB(60,IEN,64) 64 NATIONAL VA LAB CODE 64;1 Direct Global Read & w 64.1 RESULT NTL CODE 64;2 Direct Global Read & w ROUTINE: ******************** 1948 NAME: DBIA1948 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VBECS USAGE: Controlled Subscri ENTERED: MAR 4,1997 STATUS: Active EXPIRES: 2000 DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File DSS Extracts references the following data from the LAB DATA file (#63). These fields are used in the DSS Lab Extract for the original/old format which does not use LMIP codes. With the FY'98 release of DSS Extracts, this should no longer be needed. Therefore, this IA is to be in effect for no more than 3 years, with a sunset clause of 2000. ^LR(D0,0) .01 LRDFN 0;1 Direct Global Read & w .02 PARENT FILE 0;2 Direct Global Read & w .03 NAME 0;3 Direct Global Read & w DSS reads the entire zero node into a local variable. The fields above are used. ROUTINE: ******************** 1949 NAME: LAB DSS EXTRACT CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Controlled Subscri ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 64 ROOT: LAM( DESCRIPTION: TYPE: File DSS Extracts references the following data from the WKLD CODE file (#64). ^LAM(D0,0) .01 PROCEDURE 0;1 Direct Global Read & w 1 WKLD CODE 0;2 Direct Global Read & w ^LAM(D0,5,D1,1,D2,0 3 TEST Direct Global Read & w ^LAM(D0,5,D1,1,D2,1 4 LOINC CODE Direct Global Read & w ^LAM('AI' Access to 'AI' cross reference using LOINC CODE IEN (reference DBIA #5547). ROUTINE: ******************** 1950 NAME: DBIA1950 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 64.03 ROOT: LRO(64.03, DESCRIPTION: TYPE: File DSS Extracts references the following data from the WKLD LOG FILE file (#64.03). This LABORATORY file has been converted for exclusive use by DSS software to collect laboratory workload for DSS defined products. In addition to the direct global read references indicated below, DSS has complete direct global read and write access into the entire WKLD LOG FILE file (#64.03). The entire file is KILLed from the system prior to DSS calling a Lab API which populates file 64.03. ^LRO(64.03,D0,0) .01 SEQ NUMBER 0;1 Direct Global Read & w 1 PROVIDER 0;2 Direct Global Read & w 2 PATIENT NAME 0;3 Direct Global Read & w 3 DATE COMPLETE 0;4 Direct Global Read & w 4 REPORTING SITE 0;5 Direct Global Read & w 5 LOCATION TYPE 0;6 Direct Global Read & w 6 ACCESSION AREA 0;7 Direct Global Read & w 7 LAB TEST NAME 0;8 Direct Global Read & w 8 URGENCY OF TEST 0;9 Direct Global Read & w 9 TREATING SPECIALTY 0;10 Direct Global Read & w 10 WKLD CODE 0;11 Direct Global Read & w 11 LRIDT 0;12 Direct Global Read & w 12 DATE COLLECTED 0;13 Direct Global Read & w 13 DATE ORDERED 0;14 Direct Global Read & w 14 HOSPITAL LOCATION 0;15 Direct Global Read & w 15 ACCESSION FILE INDEX 0;16 Direct Global Read & w 16 SPECIMEN 0;17 Direct Global Read & w 17 DATE OF EXTRACT 1;0 Direct Global Read & w ^LRO(64.03,D0,1,D1,0) .01 DATE OF EXTRACT 0;1 Direct Global Read & w 1 EXTRACT START DATE 0;2 Direct Global Read & w 2 EXTRACT END DATE 0;3 Direct Global Read & w 3 COMPILE COMPLETE DAT 0;4 Direct Global Read & w 4 USER 0;5 Direct Global Read & w The above fields are used from the DATE OF EXTRACT multiple. ROUTINE: ******************** 1951 NAME: RECONSTRUCT ACCESSION NODE CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 68 ROOT: LRO(68 DESCRIPTION: TYPE: File DSS Extracts points to and references the following data from the ACCESSION file (#68). The DSS Extracts LABORATORY EXTRACT file (#727.813) contains a field, ACCESSION AREA, which is a pointer to the ACCESSION file (#68). Direct global read of the 'B' Cross Reference is also permited into the ACCESSION file (#68). Blood Bank Data =============== DSS uses LAB DATA file (#63) and Blood Bank's node ^LR(D0,"BB",D1,0) to extract blood bank records. We then use ACCESSION NUMBER field (#.06) to identify ACCESSION file (#68) corresponding entry. This allows us to identify provider and division associated with patient blood bank record. ^LRO(68,D0,0) .01 AREA 0;1 Direct Global Read & w The accession area of the Lab. .09 ABBREVIATION 0;11 Direct Global Read & w Abbreviation for the accession area. .19 LAB DIVISION 0;19 Read w/Fileman This field will be used to determine which lab division a particular accession area belongs. ^LRO(68,D0,1,D1,1,D2,0) 6.5 PROVIDER 0;8 Read w/Fileman The internal number of the provider requesting the test(s) is stored here. ^LRO(68,D0,1,D1,1,D2,.4) 26 DIV .4;1 Read w/Fileman ROUTINE: ******************** 1953 NAME: DBIA1953 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DSS Extracts uses the Lab Service LRCAPDAR routine. For a date range, the LRCAPDAR routine examines the LAB DATA file (#63) and stores appropriate data into the LAB DSS LAR EXTRACT file (#64.036) for use by the DSS Laboratory Results Extract. Variables: LRSDT Input Start Date LREDT Input End Date Prior to running this routine, the calling routine will purge the LAB DSS LAR EXTRACT file (#64.036). ROUTINE: LRCAPDAR COMPONENT: LRCAPDAR VARIABLES: ******************** 1954 NAME: DBIA1954 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 64.036 ROOT: LAR(64.036, DESCRIPTION: TYPE: File DSS Extracts references the following data from the LAB DSS LAR EXTRACT file (#64.036). This LABORATORY file has been created for exclusive use by DSS software to collect laboratory clinical data for the DSS Lab Results Extract. In addition to the direct global read references indicated below, DSS has complete direct global read and write access into the entire LAB DSS LAR EXTRACT file (#64.036). The entire file is KILLed from the system prior to DSS calling a Lab API which populates file 64.036. ^LAR(64.036,D0,0) .01 SEQ # 0;1 Direct Global Read & w 1 POINTED TO FILE 0;2 Direct Global Read & w 2 DFN 0;3 Direct Global Read & w 3 DATE ORDERED 0;4 Direct Global Read & w 4 TIME ORDERED 0;5 Direct Global Read & w 5 DATE RESULTS AVAIL 0;6 Direct Global Read & w 6 TIME RESULTS AVAIL 0;7 Direct Global Read & w 7 SPECIMEN 0;8 Direct Global Read & w 8 RESULTS 1;0 Direct Global Read & w 9 EXTRACTION DATA 2;0 Direct Global Read & w ^LAR(64.036,D0,1,0) .01 DSS TEST NUMBER 0;1 Direct Global Read & w 1 RESULTS 0;2 Direct Global Read & w 2 HI/LO FLAG 0;3 Direct Global Read & w 3 NTL CODE 0;4 Direct Global Read & w The above fields are used from the RESULTS multiple. ^LAR(64.036,D0,2,0) .01 EXTRACTION DATE 0;1 Direct Global Read & w 1 EXTRACTION START DAT 0;2 Direct Global Read & w 2 EXTRACTION END DATE 0;3 Direct Global Read & w 3 COMPLETED D/T 0;4 Direct Global Read & w 4 USER 0;5 Direct Global Read & w The above fields are used from the EXTRACTION DATA multiple. ROUTINE: ******************** 1955 NAME: DBIA1955 CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 727.2 ROOT: ECX(727.2 DESCRIPTION: TYPE: File Lab Service references the following data from the DSS LAB TESTS file (#727.2). This reference is made from the LRCAPDAR routine written by Lab Service to provide lab clinical results data to DSS. ^ECX(727.2,D0,1,0) 2 SOURCE 0;2 Direct Global Read & w The above field is used from the DSS LAB TEST multiple (727.21). ^ECX(727.2,D0,1,D1,LOC,0) .01 LOCAL LAB TEST NAME 0;1 Direct Global Read & w The above field is used from the LOCAL LAB TEST NAME multiple (727.211). ^ECX(727.2,D0,BL,0) .01 BLOOD SPECIMEN 0;1 Direct Global Read & w The above field is used from the BLOOD SPECIMEN multiple (727.22). ^ECX(727.2,D0,UR,0) .01 URINE SPECIMEN 0;1 Direct Global Read & w The above field is used from the URINE SPECIMEN multiple (727.23). ROUTINE: ******************** 1956 NAME: DBIA1956 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 6,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49, DESCRIPTION: TYPE: File Supported DBIA #10093 provides FileMan read access to all fields of the SERVICE/SECTION file (#49). The DSS Surgery Extract uses a direct global read on the NATIONAL SERVICE field (730) for the purpose of determining the service to which the attending surgeon is assigned. The technical description follows: ATTENDING'S SERVICE is a pointer to the NATIONAL SERVICE file (#730). Derived from the SERVICE/SECTION field (29) in the NEW PERSON file (#200) for the ATTENDING SURGEON field (13) in the SURGERY EXTRACT file (#727.811) which is a pointer to the SERVICE/SECTION file (#49). The pointer value identifies the NATIONAL SERVICE field (730) in the SERVICE/SECTION file (#49) which points to the NATIONAL SERVICE file (#730). Therefore, DSS Extracts references the following data from the SERVICE/SECTION file (#49). ^DIC(49,D0,730) 730 NATIONAL SERVICE 730;1 Direct Global Read & w ROUTINE: ******************** 1957 NAME: File Security Codes CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: NURSING SERVICE GEN. MED. REC. - I/O GEN. MED. REC. - VITALS GEN. MED. REC. - GENERATOR USAGE: Private ENTERED: MAR 10,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC DESCRIPTION: TYPE: File The Gen. Med. Rec. - I/O (Intake and Output), Gen. Med. Red. - Vitals (Vitals/Measurements), Nursing Service and Text Generator packages have permission to set the security nodes (i.e., "DD", "RD", "DEL", "LAYGO", and "WR") in FILE 1 for those files within the package's number range. For example: S ^DIC(210,0,"DD")="@" Package Number Range ------- ------------ Intake & Output 126-126.95 Vitals/Measurments 120.5-120.57 Nursing Service 210-219.7 Text Generator 124-124.3 With the next release of each package, the installation process will allow the site to change its file security codes to match the codes as they appear in the documentation. The site can answer YES to change their file security codes to match the package documentation or NO to leave them as is. ROUTINE: ******************** 1958 NAME: DBIA1958 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Supported ENTERED: MAR 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API will get Lab results for a given patient based on various input parameters. ROUTINE: LR7OSUM COMPONENT: EN(Y,DFN,SDATE,EDATE,COUNT,GIOM,SUBHEAD) VARIABLES: Y Type: Output Tells the calling routine where the data is stored. DFN Type: Input Internal number of the patient as stored in ^DPT(DFN SDATE Type: Input Start date to search for results (optional) EDATE Type: Input EDATE=End date to search for results (optional) COUNT Type: Input COUNT=Count of results to send (optional) GIOM Type: Input GIOM=Right margin - default 80 (optional) SUBHEAD Type: Input SUBHEAD=Array of subheaders from file 64.5, misc, micro & AP to show results. Null param = get all results This is a 'silent' call. No prompts are given. The results are formatted and stored in the global: ^TMP("LRC",$J) "CH" type results are stored in the pre-defined cumulative format. Headers for each format are stored in: ^TMP("LRH",$J,NAME)=line # An index of where tests can be found in a report are found in: ^TMP("LRT",$J,print name)=header^line # of 1st occurrence Test entries without a header means that the test is defined in the report, but there are no results. COMPONENT: GET64(Y) VARIABLES: Y Type: Output This is the name of the array that the report headers are returned in. This entry point will get a list, in Y(name) of all the minor headers from the Lab Reports file. It also includes in the Y array the names of other report headers not included in the Lab Reports file such as S Y("MISCELLANEOUS TESTS")="" S Y("MICROBIOLOGY")="" S Y("BLOOD BANK")="" S Y("CYTOPATHOLOGY")="" S Y("SURGICAL PATHOLOGY")="" S Y("EM")="" This call is intended to be used with EN^LR7OSUM when it is necessary to pre-select a specific area within Lab for retreiving results. ******************** 1962 NAME: DBIA1962 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: IMAGING This request is needed for referencing/reading Lab Data global nodes and writing the Image pointer in the appropriate Image field. To be used for setting Image pointers and for verification of Image pointers (set during image capture) and for report dislay. USAGE: Controlled Subscri ENTERED: MAR 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR(DO,0 DESCRIPTION: TYPE: File This request is for referencing/reading and writing the Image field in the Laboratory Data file 63. Imaging saves Image pointers in the following sub-field of the Lab Data file: For Autopsy Images: Lab Data sub-file: DD(63.2,0) = AUTOPSY ORGAN/TISSUE SUB-FIELD^NL^2005.1^9 sub-fields: DD(63.2,2005,0) = IMAGE (GROSS)^63.28P^^2005;0 DD(63.2,2005.1,0) = IMAGE (MICROSCOPIC)^63.45P^^2005.1;0 For Surgical Pathology Images: Lab Data sub-file: DD(63.08,0) = SURGICAL PATHOLOGY SUB-FIELD^NL^2005^38 Sub-field: DD(63.08,2005,0) = IMAGE^63.82005P^^2005;0 For Cytology Images: Lab Data sub-file: DD(63.09,0) = CYTOPATHOLOGY SUB-FIELD^NL^2005^34 Sub-field: DD(63.09,2005,0) = IMAGE^63.92005P^^2005;0 For Electron Microcopy DD(63.02,0) = EM SUB-FIELD^NL^2005^32 Sub-field: DD(63.02,2005,0) = IMAGE^63.22005P^^2005;0 Reading of this file is required to verify the Lab file's references, saved during image capture, needed for displaying lab reports. Write access is needed during image capture to save the image pointer in the appropriate Lab accession area (SP, CY, etc.). ^LR(DO,'AU') 14.7 AUTOPSY RELEASE DATE AU;15 Direct Global Read & w Autopy release date/time 14 AUTOPSY ACC # AU;6 Direct Global Read & w Autopsy accession number 13.5 RESIDENT PATHOLOGIST 0;7 Direct Global Read & w RESIDENT PATHOLOGIST 11 AUTOPSY DATE/TIME 0;1 Direct Global Read & w AUTOPSY DATE/TIME Autopsy node. ^LR('AAUA', Cross reference for Autopsy by year, accession area abbreviation, accession number, lrdfn. ^LR('ASPA', Cross reference for Surical pathology, accession area abbreviation, accession number, lrdfn. ^LR('ACYA' Cross reference for Cytology. LR('ACYA',YEAR,ACCESSION AREA ABBREVIATION,ACCESSION NUMBER, LRDFN ^LR('AEMA', Cross reference for Electron Microscopy LR('AEMA',YEAR,ACCESSION AREA ABBREVIATION, ACCESSION NUMBER,LRDFN ^LR(D0,0) .02 PARENT FILE 0;2 Direct Global Read & w Pointer to file of file - Patient file or Referal file. .03 NAME 0;3 Direct Global Read & w Patient name. Root node of file 63 ^LR(DO,'SP',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w Date & time speciment taken. .02 PATHOLOGIST 0;2 Direct Global Read & w Pathologist .06 SURGICAL PATH ACC # 0;6 Direct Global Read & w Surgical Pathology accession number. ^LR(D0,'SP',D1,.1,D2,0) .01 SPECIMEN 0;1 Direct Global Read & w Specimen 2005 Image 2005 Both R/W w/Fileman Image pointer ^LR(DO,'AY',D1,0) .01 AUTOPSY ORGAN/TISSUE 0;1 Direct Global Read & w AUTOPSY ORGAN/TISSUE - Specimen 2005 IMAGE (GROSS) 2005 Both R/W w/Fileman IMAGE POINTER 2005.1 IMAGE (MICROSCOPIC) 2005.1 Both R/W w/Fileman IMAGE POINTER AUTOPSY ORGAN/TISSUE subfile. ^LR(DO,'CY',D1,0) .01 DATE/TIME SPECIMEN 0;1 Direct Global Read & w DATE/TIME SPECIMEN TAKEN .02 PATHOLOGIST 0;2 Direct Global Read & w PATHOLOGIST .06 CYTOPATH ACC # 0;6 Direct Global Read & w CYTOPATH ACCESSION NUMBER. ^LR(DO,'CY',D1,.1,D2,0) .01 SPECIMEN 0;1 Direct Global Read & w SPECIMEN 2005 IMAGE 2005 Both R/W w/Fileman IMAGE POINER ^LR(DO,'EM',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w DATE/TIME SPECIMEN TAKEN .02 PATHOLOGIST 0;2 Direct Global Read & w PATHOLOGIST .06 EM ACC # 0;6 Direct Global Read & w EM ACCESSION NUMBER ^LR(DO,'EM',D1,.1,D2,0) .01 SPECIMEN 0;1 Direct Global Read & w Specimen. 2005 IMAGE 2005 Both R/W w/Fileman Image pointer Electron Microscopy sub file. ROUTINE: ******************** 1963 NAME: DBIA1963 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: IMAGING VBECS ORDER ENTRY/RESULTS REPORTING VIRTUAL PATIENT RECORD USAGE: Controlled Subscri ENTERED: MAR 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 68 ROOT: LRO(68 DESCRIPTION: TYPE: File The purpose of this request is to provide the Imaging package access to read the Laboratory Accession file for image capture. Image capture for Radiology will require the person to provide an Accession area, Accession year and Accession number. These entries are used to verify the existence of the Lab entry and to display a list of specimens for the accession number provided. ^LRO(68,DO,0) .01 AREA 0;1 Direct Global Read & w ACCESSION AREA .09 ABBREVIATION 0;11 Direct Global Read & w ACCESSION AREA ABBREVIATION .02 LR SUBSCRIPT 0;2 Direct Global Read & w The subscript where the data is stored..."SP","CY",etc. ROUTINE: ******************** 1965 NAME: GMRYMNT CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: MAR 22,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Nursing Service package has permission to call the GMRYMNT routine in order to display or print its End of Shift report. ROUTINE: GMRYMNT COMPONENT: SELSITE VARIABLES: DFN Type: Input The calling routine must have DFN defined. GMRXY Type: Output Contains all current and discontinued IV sites used within the last 24 hours. This entry point extracts all current and discontinued IV sites used within the last 24 hours. ******************** 1966 NAME: DBIA1966 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE TOOLKIT Parameter Tools references 4.2 to store system level parameters. CMOP HEALTH SUMMARY HEALTH LEVEL SEVEN ORDER ENTRY/RESULTS REPORTING Effective with Patch OR*3*401- change to routine ORKMGR to create an error message that could occur when a user uses option [ORK EDITABLE BY USER]. VISTA SYSTEM MONITOR Environment check routine in patch KMPV*1*1 will verify the new domain added by XM*999*178 existgs before proceeding with KMPV patch installation. PROBLEM LIST Effective with patch GMPL*2.0*49 - the application will check for any default selection list parameter settings and prohibit any list deletions if current assignments are active. If any lists cannot be deleted, the application will display the list of current parameter entity/value assignments. This may include any default lists that are assigned at the system/domain level. The domain name is retrieved for the purpose of this display. USAGE: Controlled Subscri ENTERED: MAR 25,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2 DESCRIPTION: TYPE: File ^DIC(4.2, .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1967 NAME: DBIA1967 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.5 ROOT: DIC(51.5 DESCRIPTION: TYPE: File This data is accessed when a drug is marked for CMOP. ^DIC(51.5,D0) .01 ABBREVIATION 0;1 Direct Global Read & w .02 EXPANSION 0;2 Direct Global Read & w ROUTINE: ******************** 1968 NAME: DBIA1968 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine In the CMOP routine PSXEDIT, a call is made to EN1^PSONEW2 to complete the editing of a prescription. ROUTINE: PSONEW2 COMPONENT: EN1 VARIABLES: PSORXED Type: Output ******************** 1969 NAME: DBIA1969 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package calls the Outpatient Pharmacy routine, PSORXL in order to print prescription labels at the medical center pharmacy. ROUTINE: PSORXL COMPONENT: D1 VARIABLES: COMPONENT: QLBL VARIABLES: PPL Type: Output ******************** 1970 NAME: DBIA1970 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: 6 FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package makes a call to the Outpatient Pharmacy routine, PSOSURST in order to reset and print pharmacy labels. This call is made when the user selects the option to reset and print window labels. There aren't any I/O variables. ROUTINE: PSOSURST COMPONENT: START VARIABLES: No variables are passed with this call. ******************** 1971 NAME: DBIA1971 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package makes a call to the Outpatient Pharmacy routine, PSOSULBL. This call is made from the CMOP routine, PSXRSUS when the user selects the option to Print Standard Suspense at the medical center pharmacy. There aren't any I/O variables in this call. ROUTINE: PSOSULBL COMPONENT: ASK VARIABLES: No variables are passed with this call. ******************** 1972 NAME: DBIA1972 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package makes a call to the Outpatient Pharmacy routine, PSOSUCHG. This call is made when a user is using the Change Suspense Date option on the Suspense Menu for Outpatient Pharmacy. Any Rx that is entered by the user is screened for CMOP. This screening process is handled by the CMOP routine, PSXCH. Once the screening is finished PSXCH calls PSOSUCHG to complete the processing. ROUTINE: PSOSUCHG COMPONENT: RTN VARIABLES: COMPONENT: ALL VARIABLES: COMPONENT: SPEC VARIABLES: XOK Type: Output XOK indicates that the Rx is suspended for CMOP and it is okay to change the suspense date. XOK = 1 -> changing suspense date is okay, XOK = 0, changing of the suspense date is not allowed. ******************** 1973 NAME: DBIA1973 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package makes a call to the Outpatient Pharmacy routine, PSOLSET. This call is made to set up the required OP system variables that are necessary for pulling Rx's from suspense during the CMOP transmission process or when CMOP labels are printed at the medical center pharmacy. ROUTINE: PSOLSET COMPONENT: PSOLSET VARIABLES: PSOPAR Type: Output PSOBAR0 Type: Output PSOBAR1 Type: Output PSOBARS Type: Output PSOCAP Type: Output PSOCLC Type: Output PSOCNT Type: Output PSODIV Type: Output PSXDTCUT Type: Output PSOINST Type: Output PSOION Type: Output PSOIOS Type: Output PSOLAP Type: Output PSONULBL Type: Output PSOPAR7 Type: Output PSOPROP Type: Output PSOPRPAS Type: Output PSOREL Type: Output PSOREO Type: Output PSOSITE Type: Output PSOSITE7 Type: Output PSOSYS Type: Output PSXSYS Type: Output ******************** 1974 NAME: DBIA1974 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CMOP package makes a call to the Outpatient Pharmacy routine, PSOCP. This call is made when the CMOP process is filing the release data that is returned by the CMOP facility. The call is made in order to generate any copay charges for the Rx. ROUTINE: PSOCP COMPONENT: CP VARIABLES: PSOCPRX Type: Output PSOCPRX contains the record number of the prescription in the Rx file (#52). ******************** 1978 NAME: DBIA1978 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.5 ROOT: PS(52.5, DESCRIPTION: TYPE: File The CMOP package requires direct R/W access to all fields and cross-references in file 52.5. ROUTINE: ******************** 1979 NAME: DBIA1979 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 54 ROOT: PS(54 DESCRIPTION: TYPE: File The Consolidated Mail Outpatient Pharmacy package has modified the input transform for the .01 field in the RX CONSULT file (#54). This modification will prevent the first 20 entries in the file from being edited. This is necessary to provide uniformity in the drug warnings that are transmitted to the CMOP with each prescription. The drug warnings are passed by their record number in the RX CONSULT file from the hospital to the CMOP facility and then on to the vendor system. These numbers must match between all the medical centers using the CMOP software, the CMOP Facility, and the vendor system, or the incorrect drug warning could be printed on the prescription label. The modified input transform is shown below: ^DD("54",".01","0")="NAME^RFX^^0;1^K:$L(X)>25!($L(X)<1)!"(X"?1P.E)!(($G(DA )>0)&($G(DA)<21)) X" ^PS(54,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 1980 NAME: DBIA1980 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CMOP HEALTH SUMMARY ADDED 6/27/2011 USAGE: Controlled Subscri ENTERED: MAR 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51 ROOT: PS(51 DESCRIPTION: TYPE: File The Consolidated Mail Outpatient Pharmacy package accesses the 'A' cross reference in the MEDICATION INSTRUCTION file (#51). This cross reference used to expand the SIG in order to send this data with the prescription when it is transmitted to the CMOP facility to be filled. The CMOP package only reads the data in this cross reference. ^PS(51,A,X) This cross reference is used to look up the expanded SIG for a prescription. ROUTINE: ******************** 1983 NAME: DBIA1983 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAR 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File The CMOP package requires direct R/W access to all fields and cross-references in file 50. ROUTINE: ******************** 1985 NAME: DBIA1985 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS AICS wishes to call these linetags for the purpose of using the output transforms for outputting entries during formatting and after scanning, before sending data to PCE. USAGE: Controlled Subscri ENTERED: APR 2,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: ROOT: DESCRIPTION: TYPE: Routine This IA supports calls into the following linetags within routine PXAPIIB: $$DSPLYED^PXAPIIB <--Education $$DSPLYEX^PXAPIIB <--Examinations $$DSPLYHF^PXAPIIB <--Health Factors $$DSPLYIM^PXAPIIB <--Immunizations $$DSPLYSK^PXAPIIB <--Skin Tests $$POV^PXAPIIB <-Purpose of Visit ROUTINE: PXAPIIB COMPONENT: DSPLYED VARIABLES: Education Factors COMPONENT: DSPLYEX VARIABLES: Examinations COMPONENT: DSPLYHF VARIABLES: Health Factors COMPONENT: DSPLYIM VARIABLES: Immunizations COMPONENT: DSPLYSK VARIABLES: Skin Tests COMPONENT: POV VARIABLES: Purpose of Visit ******************** 1986 NAME: EXECUTE DD NODES OF File 391.71 Cross-references CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Controlled Subscri ENTERED: MAY 7,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 391.71 ROOT: DESCRIPTION: TYPE: File A cross-reference on a field in the Patient file #2 creates an entry in ADT/HL7 PIVOT file #391.71 and/or sets the cross-references in file #391 by executing the ^DD cross-reference nodes. ^DD(2,.01,1,991,0) = 2^AVAFC01^MUMPS ^DD(2,.02,1,991,0) = 2^AVAFC02^MUMPS ^DD(2,.03,1,991,0) = 2^AVAFC03^MUMPS ^DD(2,.05,1,991,0) = 2^AVAFC05^MUMPS ^DD(2,.08,1,991,0) = 2^AVAFC08^MUMPS ^DD(2,.09,1,991,0) = 2^AVAFC09^MUMPS ^DD(2,.111,1,991,0) = 2^AVAFC111^MUMPS ^DD(2,.1112,1,991,0) = 2^AVAFC1112^MUMPS ^DD(2,.112,1,991,0) = 2^AVAFC112^MUMPS ^DD(2,.113,1,991,0) = 2^AVAFC113^MUMPS ^DD(2,.114,1,991,0) = 2^AVAFC114^MUMPS ^DD(2,.115,1,991,0) = 2^AVAFC115^MUMPS ^DD(2,.117,1,991,0) = 2^AVAFC117^MUMPS ^DD(2,.131,1,991,0) = 2^AVAFC131^MUMPS ^DD(2,.132,1,991,0) = 2^AVAFC132^MUMPS ^DD(2,.211,1,991,0) = 2^AVAFC211^MUMPS ^DD(2,.219,1,991,0) = 2^AVAFC219^MUMPS ^DD(2,.2403,1,991,0) = 2^AVAFC2403^MUMPS ^DD(2,.301,1,991,0) = 2^AVAFC301^MUMPS ^DD(2,.302,1,991,0) = 2^AVAFC302^MUMPS ^DD(2,.31115,1,991,0) = 2^AVAFC31115^MUMPS ^DD(2,.323,1,991,0) = 2^AVAFC323^MUMPS ^DD(2,.351,1,991,0) = 2^AVAFC351^MUMPS ^DD(2,391,1,991,0) = 2^AVAFC391^MUMPS ^DD(2,1901,1,991,0) = 2^AVAFC1901^MUMPS Global ^DD(2,1901,1,991 DD(2,1901,1,991 ^DD(2,1901,1,991,0) = 2^AVAFC1901^MUMPS ^DD(2,1901,1,991,1) = D:($T(AVAFC^VAFCDD01)'="") AVAFC^VAFCDD01(DA) ^DD(2,1901,1,991,2) = D:($T(AVAFC^VAFCDD01)'="") AVAFC^VAFCDD01(DA) ^DD(391.71,.06,1,1,0) = 391.71^AC^MUMPS ^DD(391.71,.08,1,1,0) = 391.71^AXMIT2^MUMPS ^DD(391.71,.06,0) = TRANSMITTED^S^1:NEED TO TRANSMIT;^0;6^Q ^DD(391.71,.06,1,0) = ^.1 ^DD(391.71,.06,1,1,0) = 391.71^AC^MUMPS ^DD(391.71,.06,1,1,1) = S:+X ^VAT(391.71,"AC",$E(X,1,30),DA)="" ^DD(391.71,.06,1,1,2) = K ^VAT(391.71,"AC",$E(X,1,30),DA) ^DD(391.71,.08,0) = REQUIRES TRANSMISSION^S^0:NO;1:YES;^0;8^Q ^DD(391.71,.08,.1) = Requires Transmission ^DD(391.71,.08,1,0) = ^.1 ^DD(391.71,.08,1,1,0) = 391.71^AXMIT2^MUMPS ^DD(391.71,.08,1,1,1) = Q:(($G(VAFCA08))!('X)) N A S A=$P(^VAT(391.71,DA,0),"^",4) S:(+A) ^VAT(391.71,"AXMIT",A,DA)="" ^DD(391.71,.08,1,1,2) = N A S A=$P(^VAT(391.71,DA,0),"^",4) K:(+A) ^VAT(391.71,"AXMIT",A,DA) ROUTINE: ******************** 1987 NAME: DBIA1987 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: 9999999.09 ROOT: AUTTEDT( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTEDT(#,0) piece 1 and piece 3 ... and to the "B" cross-reference ^AUTTEDT(#,0) .01 NAME 0;1 Direct Global Read & w Name of Education Topic .03 Inactive Flag 0;3 Direct Global Read & w Education Topics ROUTINE: ******************** 1988 NAME: DBIA1988 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: 9999999.15 ROOT: AUTTEXAM( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTEXAM(#,0) piece 1 and piece 4 ... and to the "B" cross-reference ^AUTTEXAM(#,0) .01 NAME 0;1 Direct Global Read & w Name of Exam. .04 INACTIVE FLAG 0;4 Direct Global Read & w This file is a list of Physical Exams that have been defined specifically for use in entering Examinations performed on an Outpatient or Inpatient Encounter. ROUTINE: ******************** 1989 NAME: DBIA1989 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING HEALTH SUMMARY VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM Added with HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** MENTAL HEALTH Added 6/3/19. Effective with YS*5.01*140. USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: 9999999.64 ROOT: AUTTHF( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTHF(#,0) piece 1 and piece 11 ... and to the "B" cross-reference ^AUTTHF( .01 FACTOR 0;1 Direct Global Read & w Name of Health Factor. .11 INACTIVE FLAG 0;11 Direct Global Read & w .10 ENTRY TYPE 0;10 Direct Global Read & w This file contains a descriptive name of health factors, and their health factor category. ROUTINE: ******************** 1990 NAME: DBIA1990 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS BAR CODE MED ADMIN ADDED 8/28/09 PHARMACY DATA MANAGEMENT ADDED 8/28/09 VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: 9999999.14 ROOT: AUTTIMM( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTIMM(#,0) piece 1 and piece 7 ... and to the "B" cross-reference ^AUTTIMM(#,0) .01 NAME 0;1 Direct Global Read & w Name of Immunization. .07 INACTIVE FLAG 0;7 Direct Global Read & w This file is a list of Immunizations and associated codes developed specifically for use in the IHS. This file contains a full descriptive name for each Immunization, plus a shortened name of Ten Characters which is used on the Health Summary and on reports where space is limited, plus a Two Digit Code for each Immunization. ROUTINE: ******************** 1991 NAME: DBIA1991 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: 9999999.28 ROOT: AUTTSK( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTSK(#,0) piece 1 and piece 3 ... and to the "B" cross-reference ^AUTTSK(#,0) .01 NAME 0;1 Direct Global Read & w Name of Skin Test .03 INACTIVE FLAG 0;3 Direct Global Read & w This file contains Skin Tests. It consists of a full descriptive name, a Ten Character Abbreviated Name for the Health Summary and other reports where spaces are limited, plus a Two Digit Code (IHS only). ROUTINE: ******************** 1992 NAME: DBIA1992 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS For use in our Scanned Forms w/ Bill Generated option. ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: APR 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 399 ROOT: DGCR(399 DESCRIPTION: TYPE: File This ingegration agreement allows access to the following global nodes within file 399: ^DGCR(399,"AOPV" use of the AOPV cross-reference for look-up ^DGCR(399,#,0) ^DGCR(399,#,"S") ^DGCR(399,#,"U1") ^DGCR(399,#,"OP",0) ^DGCR(399,#,0) .01 BILL NUMBER 0;1 Direct Global Read & w ^DGCR(399,#,S) 1 DATE ENTERED S;1 Direct Global Read & w 12 DATE FIRST PRINTED S;12 Direct Global Read & w 17 DATE BILL CANCELLED S;17 Direct Global Read & w ^DGCR(399,#,OP) 43 OP VISITS DATE(S) OP;4 Direct Global Read & w Request to read both the global and the AOPV X-reference on this field. ^DGCR(399,#,U1) 201 TOTAL CHARGES U1;1 Direct Global Read & w ROUTINE: ******************** 1994 NAME: DBIA1994 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CPT USAGE: Private ENTERED: APR 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a one-time only DBIA with PCE to allow the CPT v.6.0 package update to revise routine PXBUTL to eliminate references to files 409.72, which will no longer be maintained. These references have been replaced by supported calls to supported APIs. ROUTINE: PXBUTL COMPONENT: CPTOK VARIABLES: Returns effective date/status for procedure code. COMPONENT: CPTSCREN VARIABLES: Returns status for procedure code. ******************** 1995 NAME: CPT Code APIs CUSTODIAL PACKAGE: CPT/HCPCS CODES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This contains the supported references to routine ICPTCOD for the supported APIs to be released with v.6.0 of CPT. These entry points will retrieve CPT/HCPCS code related data. All entry points will return -1^error description in an error condition. ROUTINE: ICPTCOD COMPONENT: $$CPT(CODE,CDT,SRC) VARIABLES: CODE Type: Input The CPT, HCPCS, or Level III code in either internal or external format. CDT Type: Input The date for which status of the code is being checked. The Default value is TODAY. If CDT < 1/1/1989, use 1/1/1989 If CDT > DT, validate with newest In/Activation Dates If CDT is year only, use first of the year If CDT is year and month only, use first of the month $$CPT Type: Output String, containing the following information in the following "^" pieces: Piece Description ===== =========== 1 internal entry number of code in ^ICPT 2 CPT CODE (.01 field) 3 SHORT NAME (versioned from .01 field #61 multiple) 4 CATEGORY ien (#3 field) 5 SOURCE code (#6 field) ==> C:CPT; H:HCPCS; L:VA LOCAL 6 EFFECTIVE DATE (from .01 field #60 multiple) 7 STATUS 0:inactive; 1:active (from .02 of #60 multiple) 8 INACTIVE DATE (versioned from .01 field #60 multiple) 9 ACTIVE DATE (versioned from .01 field #60 multiple) 10 NOTICE OF TEXTUAL INACCURACY SRC Type: Input Flag to indicate if Level III codes need to be screened out. If SRC=0 or null, Level III codes are not processed as valid input; if SRC>0, Level III codes are accepted. Extrinsic function that returns basic information for CPT code. WARNING: Use of the INACTIVE FLAG field (#5) can produce unpredictable results if the API is not used. COMPONENT: $$CPTD(CODE,'OUTARR',DFN,CDT) VARIABLES: CODE Type: Input The CPT or HCPCS code in either internal or external format. $$CPTD Type: Output Contains number of lines (number of subscripts) in description (array) OUTARR Type: Both An array name in which to store the returned versioned description. If no name is provided, the default name will be ^TMP("ICPTD",$J,. The calling routine is responsible for killing ^TMP("ICPTD",$J) after the call, if used. On return, the array contains corresponding lines of text of the code's versioned description (field 62) OUTARR(1) = 1st line of description OUTARR(last) = last line of description OUTARR(last+1) = blank line OUTARR(last+2) = NOTICE OF TEXTUAL INACCURACY where last+2 is the value returned by $$CPTD. DFN Type: Input Not in use. Added in anticipation of future need. CDT Type: Input Code Date to check, Default = Today (FileMan format) Not in use. Added for future need. If CDT < 1/1/1989, use 1/1/1989 If CDT > DT, use the most recent description If CDT is year only, use first of the year If CDT is year and month only, use first of the month Extrinsic function that returns the full description of a code, from the "D" node (field 50) of the ICPT file. COMPONENT: $$CODM(CODE,'OUTARR',SRC,CDT,DFN) VARIABLES: CODE Type: Input The CPT, HCPCS, or Level III code in either internal or external format. OUTARR Type: Both An array name in which to store the list of acceptable modifiers. If no name is provided, the default name will be ^TMP("ICPTM",$J, The calling routine is responsible for killing ^TMP("ICPTM",$J) after the call, if used. Array sorted on Modifier (field .01) and containing the Versioned Name (field #61), and ien of modifier. OUTARR()= versioned name^ien SRC Type: Input Flag to indicate if Level III codes and modifiers need to be screened out. If SRC=0 or null, Level III codes are not valid input and Level III modifiers are not valid output; if SRC>0, Level III codes and modifiers are included. *Note that all Level III modifiers are currently INACTIVE, and will be rejected. CDT Type: Input Date in Fileman format to check modifier status against. If CDT=0 or null, both active and inactive modifiers will be included in the output as acceptable modifiers. If CDT is passed as a date, only modifiers being active as of this date will be included in the output as acceptable modifiers. If CDT < 1/1/1989, use 1/1/1989 If CDT > DT, validate with newest In/Activation Dates If CDT is year only, use first of the year If CDT is year and month only, use first of the month DFN Type: Input Not in use. Included in anticipation of future needs. $$CODM Type: Output Number of modifiers in OUTARR(mod name). or -1^error description in an error condition Extrinsic function that returns alphabetic array containing list of all acceptable modifiers for a selected code. COMPONENT: $$MOD(MOD,MFT,MDT,SRC) VARIABLES: $$MOD Type: Output String containing modifier data in "^" pieces: Piece Description ===== =========== 1 internal entry number 2 MODIFIER (.01 field) 3 NAME (.02 field) 4 CODE (.O3 field) alternate 5-digit code for CPT modifiers 5 SOURCE (.04 field) C:CPT; H:HCPCS; V:VA NATIONAL 6 EFFECTIVE DATE (.01 field of multiple field 60) 7 STATUS (.02 field of multiple field 60) 8 INACTIVE DATE (.01 field of multiple field 60) 9 ACTIVE DATE (.01 field of multiple field 60) 10 NOTICE OF TEXTUAL INACCURACY MOD Type: Input MODIFIER (.01 field or ien: External or ien format) MFT Type: Input MOD format where "I" = internal (ien); "E" = external (.01) Default value is "E". MDT Type: Input Date to check modifier status for. Default value is TODAY. If MDT < 1/1/1989, use 1/1/1989. If MDT > DT, validate with newest In/Activation Dates If MDT is year only, use first of the year If MDT is year and month only, use first of the month SRC Type: Input Flag to indicate if Level III modifiers need to be screened out If SRC=0 or null, Level III modifiers are not valid input; if SRC>0, Level III modifiers are accepted. *Note that all Level III modifiers are currently INACTIVE, and will be rejected. Extrinsic function that returns basic information for MODIFIER WARNING: Use of the INACTIVE FLAG field (#5) can produce unpredictable results if the API is not used. COMPONENT: $$MODP(CODE,MOD,MFT,MDT,SRC) VARIABLES: $$MODP Type: Output If pair not okay, 0. If pair okay, string containing modifier data in "^" pieces: Piece Description ===== =========== 1 internal entry number 2 NAME (.02 field) CODE Type: Input The CPT, HCPCS, or Level III code in either internal or external format. MOD Type: Input MODIFIER (.01 field or ien: External or ien format) MFT Type: Input MOD format where "I" = internal (ien); "E" = external (.01) Default value is "E". MDT Type: Input Date to check modifier status for. Default value is TODAY. If MDT < 1/1/1989, use 1/1/1989 If MDT > DT, validate with newest In/Activation Dates If MDT is year only, use first of the year If MDT is year and month only, use first of the month SRC Type: Input Flag to indicate if Level III codes and modifiers need to be screened out. If SRC=0 or null, Level III codes and Level III modifiers are not valid input; if SRC>0, Level III codes and modifiers are accepted. *Note that all Level III modifiers are currently INACTIVE, and will be rejected. Extrinsic function that returns ien value of modifier if it can be used with code - MODIFIER/CODE pair checker. COMPONENT: $$CODEN(CODE) VARIABLES: $$CODEN Type: Output The Internal Entry Number of the CPT or HCPCS code. CODE Type: Input CPT/HCPCS Code REQUIRED Extrinsic function that returns the ien of a CPT or HCPCS code COMPONENT: $$CODEC(CODE) VARIABLES: $$CODEC Type: Output The CPT or HCPCS code. CODE Type: Input The Internal Entry Number of the CPT or HCPCS code. Extrinsic function that returns the CPT or HCPCS code of an ien. ******************** 1996 NAME: CPT/HCPCS Modifier APIs CUSTODIAL PACKAGE: CPT/HCPCS CODES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This contains the supported references to routine ICPTMOD for the supported APIs. These entry points will retrieve CPT MODIFIER related data. All entry points will return '-1^error description' in an error condition. ROUTINE: ICPTMOD COMPONENT: $$MOD(MOD,MFT,MDT,SRC,DFN) VARIABLES: MOD Type: Input MODIFIER (.01 field or ien: External or ien format) MFT Type: Input Modifier format where "I"=internal (ien); "E"=external (.01) Default value is "E" MDT Type: Input Date to check modifier status for. If MDT < 1/1/1989, use 1/1/1989 If MDT > DT, validate with newest In/Activation Dates If MDT is year only, use first of the year If MDT is year and month only, use first of the month $$MOD Type: Output A "^" delimited string containing the following pieces: 1 Internal Entry Number (IEN) 2 MODIFIER (.01 field) 3 NAME (Versioned Name from multiple field 61) 4 CODE (.O3 field) alt. 5-digit code for CPT modifiers 5 SOURCE (.04 field) C:CPT; H:HCPCS; V:VA NATIONAL 6 EFFECTIVE DATE (from multiple field 60) 7 STATUS (.02 field of multiple field 60) SRC Type: Input If 0 or Null, check national (level 1, level 2) mods only If SRC>0, include VA modifiers DFN Type: Input Extrinsic function that returns basic information for MODIFIER. Returns string of data. WARNING: Use of the INACTIVE FLAG field (#5) can produce unpredictable results if the API is not used. COMPONENT: $$MODP(CODE,MOD,MFT,MDT,SRC,DFN) VARIABLES: CODE Type: Input The CPT or HCPCS code in either internal or external format. MOD Type: Input MODIFIER (.01 field or ien: External or ien format) MFT Type: Input Modifier format where "I"=internal (ien); "E"=external (.01) Default value is "E" MDT Type: Input Date to check modifier status for. If MDT < 1/1/1989, use 1/1/1989 If MDT > DT, validate with newest In/Activation Dates If MDT is year only, use first of the year If MDT is year and month only, use first of the month $$MODP Type: Output If pair is acceptable: IEN^Versioned Name (from 61 multiple) If pair is unacceptable: 0 or -1^error message SRC Type: Input If 0 or Null, check national (level 1, level 2) mods only If SRC>0, include VA modifiers Extrinsic function that returns ien value of modifier if it can be used with code - MODIFIER/CODE pair checker. Returns ien of MOD if acceptable pair, 0 if not. COMPONENT: $$MODD(CODE,OUTARR,DFN,CDT) VARIABLES: $$MODD Type: Output Returns the number of lines of text in the versioned description or '-1^error message' if there is no versioned description. CODE Type: Input This is either a CPT/HCPCS Modifier code (external, field .01) or an Internal Entry Number (IEN) of the CPT Modifier file #81.3. OUTARR Type: Both This is an array name in which to store the returned versioned description of the Modifier - e.g. "ABC" or "ABC("TEST")" or temp array. If no name is provided, the default name will be ^TMP("ICPTD",$J,. The calling routine is responsible for killing ^TMP("ICPTD",$J) after the call, if used. On return, the array contains corresponding lines of text of the Modifier's versioned description (field 62) ARRAY(1) = 1st line of description ARRAY(last) = last line of description ARRAY(last+1) = blank line ARRAY(last+2) = NOTICE OF TEXTUAL INACCURACY where last+2 is the value returned by $$MODD. DFN Type: Input Future use. CDT Type: Input Code Set Versioning date - active as of date in Fileman Format, default = today (FM) If CDT < 2890101, use 2890101 If CDT > DT, validate with In/Activation Dates If CDT is year only, use first of the year If CDT is year and month, use first of the month Returns an array of text containing the versioned Modifier description. COMPONENT: MODA(CODE,DATE,.ARY) VARIABLES: CODE Type: Input (Required) This is a CPT CODE. DATE Type: Input (Required) This is the date to use for retrieving the list of CPT Modifiers and determine if the relationship between the CPT code and the CPT Modifier is Active or Inactive. The default value for this date is TODAY. .ARY Type: Input (Required) Input array passed by reference. ARY Type: Output This is an array of Active and Inactive CPT Modifiers for a CPT code in the following format: ARY(0) = 4 Piece String 1 # of Modifiers found for code CODE (input) 2 # of Modifiers w/Active Ranges 3 # of Modifiers w/Inactive Ranges 4 Code ARY(ST,MOD) = 8 Piece Output String ST Status A=Active I=Inactive MOD Modifier (external format) 8 Piece String 1 IEN of Modifier 2 Versioned Short Text (name) 3 Activation date of Modifier 4 Beginning Range Code 5 Ending Range Code 6 Activation Date of Range 7 Inactivation Date of Range 8 Modifier Identifier This entry point builds a list of Active and Inactive CPT Modifiers that are used in conjunction with a CPT code. The determination of the status of Active versus Inactive is made based on a date provided (default TODAY). The list is placed in a local array passed by reference. ******************** 1997 NAME: CPT Utility APIs CUSTODIAL PACKAGE: CPT/HCPCS CODES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine contains supported calls for the CPT package. These include an extrinsic variable, which returns the Distribution Date, an extrinsic function that returns the category name for a category ien, functions to perform Status Checks on codes, to retrieve the Next or Previous code, and to retrieve the History of code activation/inactivation. Both entry points will return -1^error description in an error condition. Another entry point will display the CPT SIGNON COPYRIGHT MESSAGE to the calling device. ROUTINE: ICPTAPIU COMPONENT: CPTDIST VARIABLES: DATE Type: Output DISTRIBUTION DATE (.02 field of file 81.2) Extrinsic Variable - returns distribution date of current release. S X=$$CPTDIST^ICPTAPIU COMPONENT: CAT VARIABLES: CAT Type: Input Internal entry number of category. STR Type: Output Category name (.01 field) for CAT (file 81.1) -1^error description returned if error condition. Extrinsic function that returns the CATEGORY NAME, given the internal entry number. S X=$$CAT^ICPTAPIU(CAT) COMPONENT: COPY VARIABLES: none Type: D COPY^ICPTAPIU will display the CPT SIGNON COPYRIGHT MESSAGE to the calling device. COMPONENT: $$STATCHK(CODE,CDT) VARIABLES: CODE Type: Input CPT Code or Modifier REQUIRED CDT Type: Input Code Date to check, Default = Today (FileMan format) If CDT is year only, use first of the year If CDT is year and month only, use first of the month If CDT < 1/1/1989, use 1/1/1989 If CDT > DT, validate with newest In/Activation Dates $$STATCHK Type: Output String, containing the following information in the following "^" pieces: Piece Description ===== =========== 1 STATUS where 0:inactive; 1:active 2 IEN of code/modifier, -1 on error Extrinsic function that returns the Status of a CPT Code or Modifier. COMPONENT: $$NEXT(CODE) VARIABLES: CODE Type: Input CPT Code or Modifier REQUIRED $$NEXT Type: Output The Next CPT Code/Modifier, Null if there is none. Extrinsic function that returns the Next CPT Code or Modifier (active or inactive). COMPONENT: $$PREV(CODE) VARIABLES: CODE Type: Input CPT Code or Modifier REQUIRED $$PREV Type: Output The Previous CPT Code/Modifier, Null if there is none. Extrinsic function that returns the Previous CPT Code or Modifier (active or inactive). COMPONENT: $$HIST(CODE,ARY) VARIABLES: CODE Type: Input CPT Code or Modifier REQUIRED .ARY Type: Both Array, passed by Reference ARY (which was passed by reference) is returned as follows: ARY(0) = Number of Activation History Entries, -1 if error ARY(date) = STATUS where 0:inactive; 1:active 'date' is in FileMan format ARY("IEN") = Internal Entry Number of CPT code/modifier $$HIST Type: Output Number of Activation History Entries, -1 if error Extrinsic function that returns the activation history of a CPT Code or Code Modifier. COMPONENT: PERIOD(CODE,ARY) VARIABLES: CODE Type: Input CPT Code or Modifier REQUIRED ARY Type: Output Array, passed by Reference REQUIRED Return Activation/Inactivation Period(s) in ARY ARY(0) = IEN (or, -1 if error) ARY(Act_date) = Inactivation Date^Versioned Short Name Text (field #61) COMPONENT: CR(.ARY) VARIABLES: .ARY Type: Input (Required) Name of Locay Array passed by reference. ARY Type: Output Local array containing the CPT Copyright information. This API is used to place the Copyright Infomration in a Local Array ******************** 1998 NAME: DBIA1998 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS AICS presently prints out action profiles after the Encounter Form, and would like the ability to print the DUE as well. USAGE: Controlled Subscri ENTERED: APR 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows a call in to routine PSODACT and line tag ENSTUFF for purposes of printing the Drug Use Evaluations (DUE). ROUTINE: PSODACT COMPONENT: ENSTUFF VARIABLES: PSOINST Type: Input POSPAR Type: Input Prints an answer sheet for DUE RX's. ******************** 2005 NAME: DBIA2005 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: INTEGRATED PATIENT FUNDS USAGE: Supported ENTERED: APR 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Funds of Patient routines PRPFPURG and PRPFSCV2 are invoking an IFCAP programming call ADD^PRCGPM1. ROUTINE: PRCGPM1 COMPONENT: ADD(X,Y,Z) VARIABLES: X Type: Input Routine entry point (optional) and name to be executed by purgemaster in standard M format - entry point^routine name. Y Type: Input Variable string to be utilized by the routine called in X. Structure of variable is defined by developer of routine being executed. Typically this is a ^ delimited string. Z Type: Both Return variable - 1 if successful, 0 if unsuccessful in adding record to purgemaster. Parameter call to add new entry to purge master file. ******************** 2010 NAME: DBIA2010 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 38.5 ROOT: DGIN(38.5, DESCRIPTION: TYPE: File This agreement will be used to allow Integrated Billing access to all recorded patient record inconsistencies which are located in the INCONSISTENT DATA (#38.5) file. ^DGIN(38.5,D1,'I',D0 .01 INCONSISTENCY 0;1 Direct Global Read & w The INCONSISTENCY (#.01) field is a pointer to the INCONSISTENT DATA ELEMENTS (#38.6) file. This field is dinummed, so that the values in this multiple are obtained by $Ordering at the sub-file entry level. All inconsistencies for a patient are found in the INCONSISTENCY mulitple which are stored at this level. Pointer values to all inconsistencies in file #38.6 are found by $Ordering at the level of D0. ROUTINE: ******************** 2011 NAME: DBIA2011 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 38.6 ROOT: DGIN(38.6, DESCRIPTION: TYPE: File This agreement will be used to allow access for Integrated Billing to the table values in the INCONSISTENT DATA ELEMENTS (#38.6) file for all patient record inconsistencies. ^DGIN(38.6,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the Name of the inconsistency. Reference to the inconsistency name is needed to print the patient record inconsistency name on a report. ROUTINE: ******************** 2012 NAME: Rad/Nuc Med non-cancelled exam list by patient CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine EN2^RAO7PC1 can be used to retrieve a list, by patient, of Radiology/Nuclear Medicine non-cancelled exams within the last seven days. ROUTINE: RAO7PC1 COMPONENT: EN2 VARIABLES: EN2^RAO7PC1(RADFN) Input: RADFN = Internal entry number (ien) of the patient in the Rad/Nuc Med Patient file #70. (Note: this ien is the same ien used in the Patient file #2. File 70 is DINUMED to file 2. RADFN is also known as the patient ien. Output: ^TMP($J,"RAE7",patient ien,exam id)=procedure name^case number^ report status^imaging location ien^imaging location name^ contrast medium or media used Note regarding contrasts: Single characters in parenthesis indicate contrast involvement: (I)=Iodinated ionic; (N)=Iodinated non-ionic; (L)=Gadolinium; (C)=Oral Cholecystographic; (G)=Gastrografin; (B)=Barium; (M)=unspecified contrast media subscripts ---------- Patient ien: Internal entry number of the patient in both the Rad/Nuc Med Patient file # 70 and the Patient file #2. Exam Id: Reverse exam date/time of the exam concatenated to the ien of the case. Example: 7019698.9093-1 (where the exam date/time is 03/01/1998@9:06am and the case ien is 1. '7019698.9093' is derived from: 9999999.9999-2980301.0906) array value (in ascending piece position) ----------------------------------------- Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure up until the exam status is 'COMPLETE'. Case Number: Identifying external case number for an exam. Can be a number between 1 and 99999. Report Status: External name of the report status. Possible statuses include: DRAFT, PROBLEM DRAFT, RELEASED/NOT VERIFIED, VERIFIED and NO REPORT. It is possible for the exam to have a report ien, but a 'NO REPORT' status if a stub report record was created to contain a pointer to the Imaging package file of images. Imaging Location (ien): The internal entry number of the Imaging Location in file 79.1 where the exam was performed. This ien is NOT DINUMED to the Hospital Location file #44. Imaging Location Name: Name of the imaging location in the Imaging Locations file #79.1. ******************** 2013 NAME: DBIA2013 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: HEALTH LEVEL SEVEN USAGE: Private ENTERED: APR 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101 ROOT: ORD(101,,774) DESCRIPTION: TYPE: File HL7 1.6 needs permission to export new field, ROUTING LOGIC, with Protocol File (101) as part of the CIRN patch HL*1.6*14. ^ORD(101,,774 774 ROUTING LOGIC 774;1 Both R/W w/Fileman 101,774 ROUTING LOGIC 774;E1,245 MUMPS INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM LAST EDITED: SEP 24, 1996 HELP-PROMPT: This is Standard MUMPS code. DESCRIPTION: This field is similar to the GENERATE/PROCESS ROUTINE field for a given CLIENT protocol, but is executed only when a message is in an OUTBOUND state. Normally, HL7 'broadcasts' a message to all subscribers whenever a message is generated. In some cases, a client may need to receive the message only if it matches a particular condition. This field permits the application to set up screening logic to interpret the message and generate a supplemental list of 'recipients' known to be interested in the data when it meets these conditions. The result of this routine should be the creation of the HLL("LINKS") array. WRITE AUTHORITY: @ ROUTINE: ******************** 2015 NAME: DBIA2015 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ICR - IMMUNOLOGY CASE REGISTRY USAGE: Private ENTERED: APR 29,1997 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. The Immunology Case Registry package (ICR) extracts Outpatient Pharmacy data to the National registry for the tracking of disease categories such as HIV and Renal Failure. The ICR SITE PARAMETERS file (#158.9) contains two fields, ENTRY IN DRUG FILE and NDF ENTRY, which is a pointer to the Drug file (#50) and NATIONAL DRUG FILE ENTRY field (#20). In order to consolidate local drug names with the National Drug File name for reporting purposes in the national registry, the Immunology Case Registry package requests a DBIA to point to the following file. Global: ^PSDRUG( Drug File #50 Field : .01 GENERIC NAME 0;1 DIRECT GLOBAL READ 20 NATIONAL DRUG FILE ENTRY ND;1 DIRECT GLOBAL READ ^PSDRUG(D0,0) .01 GENERIC NAME 0;1 Direct Global Read & w This is the generic name of the drug. 20 NATIONAL DRUG FILE E ND;1 Read w/Fileman This is the pointer to the National Drug file. 2 VA CLASSIFICATION 0;2 Direct Global Read & w 16 PRICE PER DISPENSE U 660;6 Direct Global Read & w 21 VA PRODUCT NAME ND;2 Direct Global Read & w ROUTINE: ******************** 2018 NAME: Determining RPC Broker context CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: CLINICAL PROCEDURES SURGERY TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: OCT 28,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This integration agreement is temporary. The Kernel RPC Broker is going to publish a standard method that will replace this agreement. Subscribing packages should be prepared to use that standard method within three months of its availability, or within a time frame negotiated and approved by the Kernel RPC Broker. This agreement allows packages to check for the existence of the variable XWBOS to determine if the current routine execution was called from an RPC Broker context. This is needed to control user interface actions that are dependent on whether they are roll-and-scroll based or GUI based. ROUTINE: ******************** 2019 NAME: DBIA2019 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: MAY 13,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications needs data from the Dietetics System package which can not be extracted from any file. The data returns from CUR^FHORD7 call will be used to display on the Inpatient Medications' MAR. ROUTINE: FHORD7 COMPONENT: CUR VARIABLES: DFN Type: Input ADM Type: Input Y Type: Output A string of Abbreviated Labels from file 111. ******************** 2021 NAME: FileMan Replace/With Editor Call CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CAPACITY MANAGEMENT VAX CAPACITY MANAGEMENT SIZING AND UTILIZATION MONITOR CAPACITY MANAGEMENT USAGE: Private ENTERED: MAY 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA permits Capacity Management utilities to call the FileMan Replace/With Editor entry point at RW^DIR2. ROUTINE: DIR2 COMPONENT: RW VARIABLES: Y Type: Both The string to be edited is passed and returned in Y. X Type: Output X contains the User's last raw input. DIRWP Type: Input DIRWP allows leading "^"s in the text. RW^DIR2 is the entry point for the FileMan replace/with editor. The string to be edited is passed in Y. DIRWP mustn't exist unless you want to allow leading "^"s in the text. ******************** 2022 NAME: RECOMPILATION OF INPUT TEMPLATES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION CLINICAL INFO RESOURCE NETWORK RADIOLOGY/NUCLEAR MEDICINE USAGE: Controlled Subscri ENTERED: MAY 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .402 ROOT: DIE DESCRIPTION: TYPE: File When installing a patch that includes changes to field definitions in a data dictionary, KIDS does not recompile the compiled input templates. This integration agreement covers recompilation of input templates. Recompilation of input templates may involve the following steps: (1) Traverse the "AF" cross-reference of the ^DIE global (file #.402) to obtain a list of compiled input templates for the affected fields. The structure of this cross-reference is ^DIE("AF",file,field,template)="" Subfields would be treated like fields of their respective subfiles, i.e. ^DIE("AF",subfile,subfield,template)="". (2) For each template that is being recompiled, access ^DIE(template,"ROU") to determine the compiled routine. (3) Invoke EN^DIEZ to recompile that input template. ^DIE(AF The "AF" cross-reference has the following structure: ^DIE("AF",file,field,template)="" ^DIE("AF",subfile,subfield,template)="" ^DIE(D0,ROU 1815 ROUTINE INVOKED ROU;E1,1 Direct Global Read & w ROUTINE: ******************** 2023 NAME: DBIA2023 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER VISIT TRACKING USAGE: Private ENTERED: MAY 19,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: Other PCE Patient Care Encounter and Visit Tracking is requesting permission to look at the following nodes of the Data Dictionary. 1) ^DD(FILE,0,"PT",FILE,FIELD) ;Pointer Nodes 2) ^DD(FILE,FIELD,1,SUB,0) ;Zero node of the Cross-reference Multiple 3) ^DD(FILE,FIELD,1,SUB,1) ;Set logic of the Cross-reference This will allow us to check for any FILE and FIELD that is pointing to the VISIT file #9000010 to make sure that a BROKEN pointer will not be created if an entry in the VISIT file is deleted by way of PCE OR VISIT TRACKING. It will also allow us to write reports to show who is pointing to a particular VISIT at times when it is necessary to Debug the Visit File Data Base. ROUTINE: ******************** 2024 NAME: DBIA2024 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 20,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine We are making a call to BN1^PRCAFN to return the AR bill number regardless of the type of bill. ROUTINE: PRCAFN COMPONENT: $$BN1 VARIABLES: X Type: Input Internal file number of the bill entry in file 399. This function returns the AR bill number for all types of bills. ******************** 2026 NAME: SDPCE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: APR 3,2003 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will permit PCE to use exiting Scheduling function calls to get Eligibility, Appointment Type, and Status of an encounter. ROUTINE: SDPCE COMPONENT: $$ELAP VARIABLES: DFN Type: Input Patient SC Type: Input Clinic IEN OUTPUT Type: Output String: Elig ptr^ Elig text^ Appt Ptr^ Appt Text This function call returns the patient eligibility and appointment type data in the following string: Elig ptr^ Elig text^ Appt Ptr^ Appt Text Usage: S OUTPUT=$$ELAP^SDPCE(DFN,SC) COMPONENT: $$STATUS VARIABLES: SDVSIT Type: Input VISIT file IEN OUTPUT Type: Output Status of the encounter Internal IEN^External Value This returns the status of an encounter. Usage: S OUTPUT=$$STATUS^SDPCE(SDVSIT) COMPONENT: EN VARIABLES: Originally EN^SDPCE was run by the Entry Action on the protocol SDAM PCE EVENT which is an item on the protocol PXK VISIT DATA EVENT. In order to run PXK VISIT DATA EVENT as a TaskMan job the call to EN^SDPCE was moved to the routine EVENT^PXKMAIN in patch PX*1*211. ******************** 2027 NAME: DBIA2027 EDUCATION TOPICS CUSTODIAL PACKAGE: INDIAN HEALTH SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: MAY 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.09 ROOT: AUTTEDT( DESCRIPTION: TYPE: File The PCE Patient Care Encounter Package requests a DBIA to distribute the Indian Health Services EDUCATION TOPICS file (9999999.09) in the VA. ROUTINE: ******************** 2028 NAME: READ ACCESS ONLY TO PCE VISIT FILE CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER CLINICAL REMINDERS RADIOLOGY/NUCLEAR MEDICINE TEXT INTEGRATION UTILITIES ORDER ENTRY/RESULTS REPORTING SCHEDULING To be able to identify an optional secondary visit by checking cross-reference 6/20/14 - PCMMR added. Beginning with SD*5.3*603, PCMMR will assign a patient to a team in a pending status until they have a completed encounter with a team member. Once they have the encounter, they are switched to an active status. PCMMR uses a remote procedure call to identify an encounter in the Outpatient Encounter (#409.68) file based on the checkout date and makes a determination if the status should be updated to active. With the Outpatient Encounter file data, additional data elements can be obtained from the Visit (#9000010) and V Provider (#9000010.06) files. Returned array includes Patient DFN, Encounter Date/Time(#.01 field - 409.68), Provider IEN (#.01 field - 9000010.06), Primary/Secondary (#.04 field - 9000010.06), Stop Code (#.03 field - 409.68), Encounter Type (#15003 field - 9000010), Checkout Completed Date/Time (#.07 field - 409.68), Outpatient Encounter (#409.68) IEN, Outpatient Encounter Parent IEN, Visit (#9000010) IEN, and Visit Parent IEN (#12 field - 9000010). PCMMR will display the last encounter date for the patient. EMERGENCY DEPARTMENT added 10/10/2008 ONCOLOGY Added 1/8/09 VIRTUAL PATIENT RECORD Effective with VPR*1*0. WOMEN'S HEALTH HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. MASTER PATIENT INDEX VISTA MVI requires read access to Visit File to support the validity of Date of Death of patients. MVI will determine whether a given patient reported as deceased is actually deceased by looking at the Visit file to determine if the patient has had any type of interaction at the site. USAGE: Controlled Subscri ENTERED: MAY 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File Visit Tracking grants PCE Patient Care Encounter Global Read to the Visit file: all fields and all cross references. ROUTINE: ******************** 2029 NAME: DBIA2029 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUN 2,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing requests permission to call three entry points in the Outpatient Pharmacy routine PSOCPTRI. This routine contains the interface points between IB and Pharmacy which are needed to support the real-time billing of Tricare prescriptions using a commercial pharmacy billing software package. ROUTINE: PSOCPTRI COMPONENT: $$CHK(ORIG,REF) VARIABLES: ORIG Type: Input ORIG is a pointer to the specific prescription in file #52 for which authorization to bill the fiscal intermediary is being requested. REF Type: Input REF is a pointer to the refill in file #52.1 for the prescription ORIG. If authorization is requested for the original fill of the prescription, then REF will be 0. $$CHK Type: Output 0 = prescription/refill should not be billed 1 = should not be billed This entry point is used to determine if Pharmacy will allow a specific prescription/refill to be billed to the CHAMPUS/Tricare fiscal intermediary. COMPONENT: LABEL(RX,PSOLAP,PSOSITE,DUZ,PSOTRAMT) VARIABLES: RX Type: Input RX is a pointer to the prescription, in file #52, for the prescription whose label must be printed. PSOLAP Type: Input PSOLAP is the device on which the label should be printed. PSOSITE Type: Input PSOSITE is a pointer to the Pharmacy in file #59 in which the medication was dispensed. DUZ Type: Input DUZ is a pointer to the user in file #200 who originally requested that the prescription label be printed. PSOTRAMT Type: Input PSOTRAMT is the copayment amount to be charged to the patient for the prescription. This amount is printed on the prescription label. This entry point is called by Integrated Billing from a background to print the presciption label after authorization to bill the prescription has been electronically received from the Tricare fiscal intermediary. COMPONENT: $$TRANS(ORIG,REF,PSOV) VARIABLES: ORIG Type: Input ORIG is a pointer to the prescription in file #52 for the prescription for which information is being requested. REF Type: Input REF is pointer to the refill in file #52.1 for the prescription for which information is being requested. If information for the original fill is being requested, then REF is set to 0. PSOV Type: Output PSOV is passed by reference to this routine. Prescription information is returned from this routine by populating an array of this referenced variable. The array definition is as follows: PSOV("NDC") - the NDC number of the prescribed drug, from file #50 PSOV("DIV") - the dispensinf Pharmacy from file #59 PSOV("FDT") - the date the prescription was filled, which is the Last Fill (#101) field, or if blank, the Dispensed (#25) field from file #52. PSOV("RX#") - the prescription number from file #52 (field #.01) PSOV("QTY") - the quantity (QTY, field #7) of the prescription from file #52 PSOV("SUP") - the Days Supply (field #8) of the prescription from file #52 PSOV("ISS") - the Issue Date (field #1) of the prescription from file #52 PSOV("#REF") - the number of refills (field #9) authorized for the prescription, from file 52. PSOV("COMP") - Compound Code for the drug of the prescription. If the DEA, SPECIAL HANDLING (#3) field of the drug contains a 0 (zero), a 2 will be returned. If it does not contain a 0 (zero), a 1 will be returned. PSOV("DEA") - This is the DEA# (#53.2) field from the NEW PERSON (#200) file, for the Provider associated with the original fill of the prescription. $$TRANS Type: Output 1 = Adequate information exists for CHAMPUS Rx billing purposes. -1 = Not enough information for CHAMPUS Rx billing pruposes, mainly no prescription data, or an NDC number cannot be determined for the drug associated with the Outpatient prescription. This call is used to collect prescription information which is used to build the message which is electronically transmitted to the fiscal intermediary. ******************** 2030 NAME: DBIA2030 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: JUN 3,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Outpatient Pharmacy requests permission to call two entry points in the Integrated Billing routine IBACUS. This routine contains the interface points between Outpatient Pharmacy and Integrated Billing which are needed to support the real-time billing of Tricare prescriptions using a commercial pharmacy billing software package. ROUTINE: IBACUS COMPONENT: $$TRI VARIABLES: OUT Type: Output OUT is the value returned by this function. If the site is billing Tricare prescriptions, OUT is returned as 1; otherwise OUT is returned as 0. This entry point is used to determine if the site is using a commercial pharmacy billing software package to bill Tricare prescriptions. COMPONENT: $$CHPUS(PSTRP,DT,TRXI,PSTRF,PSOLAP,PSTRD,PSTRDZ) VARIABLES: PSTRP Type: Input PSTRP is the pointer to the PATIENT File (#2), for the patient receiving the prescription. DT Type: Input DT is the current date. TRXI Type: Input TRXI is the pointer to the PRESCRIPTION File (#52). PSTRF Type: Input PSTRF is the fill number for the prescription. It will be 0 for an original prescription, 1 for refill #1, 2 for refill #2, 3 for refill #3, etc. PSOLAP Type: Input PSOLAP is the device which the user is currently signed in under to print Outpatient labels. PSTRD Type: Input PSTRD is the pointer to the OUTPATIENT SITE File (#59), which the user is currently signed in under. PSTRDZ Type: Input PSTRDZ is the pointer to the NEW PERSON File (#200), for the user who is processing the prescription. OUT Type: Output OUT is the value returned by this function. OUT is set to 1 if the prescription is to be billed as Tricare, OUT is 0 if the prescription is not to be billed as Tricare. This entry point is used to determine if an Outpatient prescription will be billed as Tricare by the commercial pharmacy billing software package. ******************** 2031 NAME: DBIA2031 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JUN 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is needed to get information about the type of charges on the receivables from integrated billing. ROUTINE: IBRFN COMPONENT: $$REC(IBSTR,IBTYP,IBDISP) VARIABLES: IBSTR Type: Input This variable is either the RX number or FI authorization number or the ECME number. $$REC Type: Output The function value will return either IFN in the ACCOUNTS RECEIVABLE (#430) OR -1 if no corresponding bill is found. IBTYP Type: Output Output variable to be passed by reference. This variable will determine how the passed in number in IBSTR was identified by the system. A value of 1 indicates a TRICARE Auth#, 2 indicates an ECME number, 3 indicates an Rx number, while 0 indicates unknown. IBDISP Type: Output Output variable to be passed by reference. This variable will contain the external display version of the passed in number IBSTR. For example to contain the leading zeros on an ECME#. If the passed in value in variable IBSTR was 54321 to perform a claim look-up by the ECME#, then output variable IBDISP will either be 0054321 or 000000054321 depending on if the ECME# is 7 digits or 12 digits in length. This function is needed to get the receivable for an authorization number or RX number or an ECME number. COMPONENT: $$AUD(INPUT) VARIABLES: INPUT Type: Input This variable is the IFN from the ACCOUNTS RECEIVABLE file (#430). $$AUD Type: Output This variable will return either a 1 for needs to be audited or a 0 if the receivable does not need to be audited. This call is needed to determine if a particular receivable needs to be audited or not. COMPONENT: $$TYP(INPUT) VARIABLES: INPUT Type: Input This variable is the IFN from the Accounts Receivable (#430). $$TYP Type: Output This variable will be either one of the following: I - Inpatient bill O - Outpatient bill PH- Pharmacy bill PR- Prosthetics bill -1 if no bill type can be determined This call will return the type of charge that is being billed. ******************** 2032 NAME: DELETE C XREF CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: MAILMAN USAGE: Controlled Subscri ENTERED: JUN 10,1997 STATUS: Active EXPIRES: SEP 1,1997 DURATION: Till Otherwise Agr VERSION: FILE: 3.9 ROOT: DD(3.91 DESCRIPTION: TYPE: File Subj: Request for DBIA [#24183795] 09 Jun 97 11:11 10 Lines For MailMan patch XM*7.1*40, Request DBIA to delete "C" xref on field 1 (LAST RESPONSE READ) of RECIPIENT multiple of MESSAGE file. The following code to be included in a pre-init routine: K ^DD(3.91,1,1) K ^DD(3.91,0,"IX","C") K ^DD(3.91,"IX",1) ROUTINE: ******************** 2033 NAME: DBA2033 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 13,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this agreement is to provide access to the Surgery package (custodian) by the Imaging package (subscriber) for obtain a surgical case listing to append images to. Requesting permission to use the Surgery API, GET^SROGTSR, for listing surgical cases. ROUTINE: SROGTSR COMPONENT: GET VARIABLES: SRDFN Type: Input Patient's ien SRGY Type: Output An array of surgery cases: array(0)="# of cases found" or "0^There are no cases entered" array(#)="#^display date^description^surgery ien^internal date format ^number of images for the surgical case."" Obtains a listing of surgery cases for the patient specified by the calling routine. An array will be passed with the following: array(0)="# of cases found" or "0^There are no cases entered" array(#)="#^display date^description^surgery ien^internal date format ^number of images for the surgical case" ******************** 2034 NAME: DBIA2034 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This supported reference allows packages to retrieve Sponsor information which is associated with a patient. The sponsors are the people who are responsible for the patient's Tricare or CHAMPVA medical benefits coverage. ROUTINE: IBCNSU4 COMPONENT: GET(DFN,.ARRAY) VARIABLES: DFN Type: Input This is a pointer to the patient in file #2. ARRAY Type: Output This array, passed into the routine by reference by the calling application, has the following structure: ARRAY = #, where # equals the number of relationships which the patient has with different sponsors. For each specific sponsor relationship, the following two array elements are returned: 1. ARRAY(n,"REL") = 1^2^3^4^5, where n => sequential number for each relationship, begining with 1 1 => The Sponsor name 2 => The sponsor "family prefix." This is the DOD scheme for indicating the patient's relationship to the sponsor, where 01 indicates spouse, 02 indicates oldest child, 03 indicates next oldest child, etc. 3 => Sponsor Type (either TRICARE or CHAMPVA) 4 => The effective date of the relationship, in FileMan format 5 => The expiration date of the relationship, in FileMan format 2. ARRAY(n,"SPON") = 1^2^3^4^5^6, where n => sequential number for each relationship, begining with 1 1 => The Sponsor name 2 => Sponsor date of birth, in external (displayable) format 3 => Sponsor social security number, in external (including dashes) format 4 => Sponsor's military status (either ACTIVE DUTY or RETIRED) 5 => Sponsor Branch of Service (expanded value from entry in file #23) 6 => Sponsor's Rank in Service (free-text value entered by user). This is the entry point invoked by the calling application to retrieve patient sponsor information. The output is returned in an array which is passed by reference by the calling application. ******************** 2035 NAME: DBIA2035 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JUN 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is needed to allow the user to be alerted that there is another payer for a receivable for co-ordination of benefits purposes. ROUTINE: IBCNSBL2 COMPONENT: BULL(IBIFN,IBORIG,IBPYMT) VARIABLES: IBIFN Type: Input This is the bill's internal number from ACCOUNTS RECEIVABLE file (#430) IBORIG Type: Input This variable is the original amount of bill. IBPYMT Type: Input This variable is the total paid on bill. If a secondary payer exists a bulletin is generated to the IB CAT C mail group. COMPONENT: $$EOB(IBIFN,IBORIG,IBPYMT) VARIABLES: IBIFN Type: Input IFN from ACCOUNTS RECEIVABLE file (#430). IBORIG Type: Input Original amount of receivable. IBPYMT Type: Input Total paid on receivable. OUT Type: Output 1^free text name of other payer or 0 for no other payer This function is needed to determine if the receivable has another payer. ******************** 2036 NAME: DD GLOBAL CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: VISIT TRACKING USAGE: Private ENTERED: JUN 6,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File The Visit Tracking package have been granted permission to access the DD global as defined in this DBIA. ^DD(file,field,0) .2 SPECIFIER 0;2 Direct Global Read & w This field is used to determine the data type of the filed. .3 POINTER 0;3 Direct Global Read & w This field used to decode a set of codes to its external format and to make sure that a code is a valid code. It is also used to get the pointed to file for pointer fields. ROUTINE: ******************** 2037 NAME: DBIA2037 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: APR 21,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA provides an entry point which may be invoked by a calling application to initiate an interactive session which will allow the user to add new sponsors or edit existing sponsors, and to relate a sponsor to a patient. ROUTINE: IBCNSU41 COMPONENT: SPON(DFN) VARIABLES: DFN Type: Input This is a pointer to the patient in file #2. This entry point allows the user to add/edit sponsors and relate the sponsor to a patient. In the first sequence of prompts, the user is asked to enter a sponsor. If the sponsor is an existing sponsor, then the user may add/edit sponsor attributes. Otherwise, the user is asked to add the person as a new sponsor, and then to add/edit the attributes. The system then determines if the patient has a relationship with the selected/added sponsor. If so, the sponsor relationship attributes may then be updated. Otherwise, the user is asked to establish a relationship for the patient with the selected sponsor. The sponsor relationship attributes may then be updated. ******************** 2038 NAME: DBIA2038 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100 ROOT: OR( DESCRIPTION: TYPE: File This is a one-time request for Consults/Request Tracking Patch GMRC*2.5*13 to correct the pointer field 'CURRENT AGENT/PROVIDER' within the OE/RR Package file, ORDERS #100. This field was incorrectly populated by the Consults/Request package with a Variable Pointer, the Consults patch #13 will replace the incorrect pointer with its Non-Variable equivalent. The correction occurs at the time of the patch install and will only be executed that one time. ROUTINE: ******************** 2039 NAME: MEDICINE UPDATE API CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING USAGE: Controlled Subscri ENTERED: JUN 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point creates new entries, if needed, in the Medical Patient file (#690) and the Medicine Procedure data files (see file list under MCD0). It also allows the Imaging package to populate the Image multiple in the Medicine Procedure data files. ROUTINE: MCUIMAG0 COMPONENT: UPDATE(MCDATE,MCPROCD0,MCDFN,.MCMAGPTR,[.]MCD0,OK) VARIABLES: MCDATE Type: Input Date/Time of a procedure (VA FileMan internal format) MCPROCD0 Type: Input A pointer to the Procedure/Subspecialty file (#697.2), e.g., ^MCAR(697.2,MCPROCD0,... MCDFN Type: Input A pointer to the Patient file (#2), e.g., ^DPT(MCDFN,... MCMAGPTR() Type: Both An array whose subscripts are pointers to the Image file (#2005). The elements of the array should be set to null. To create a new Medicine Procedure data file stub record without image data, set this paramerter such that $O(MCMAGPTR(0))'>0. (Also see MCD0.) On output: Returned as: MCMAGPTR('File_#2005_Pointer')= MCFILE ^ MCD0 ^ MCD1, e.g., ^MCAR(MCFILE,MCD0,2005,MCD1,0)='File_#2005_P ointer' MCD0 Type: Input A pointer to one of the entries in one of the Medicine Procedure data files, e.g., ^MCAR(691,MCD0,... This parameter may be passed by reference or by value. If passed by reference, it will be returned as Pointer#^File# if there were no problems (i.e., OK>0). If OK'>0, the value of MCD0 should not be relied on. Pass in this parameter as null to create a new stub record in one of the Medicine Procedure data files. (Also see MCMAGPTR.) A list of Medicine Procedure data files follows: 691*, 691.1*, 691.5*, 691.6, 691.7, 691.8, 694*, 694.5 698, 698.1, 698.2, 698.3, 699*, 699.5*, 700, 701* Note, only those marked with a '*' have Image pointer multiples. OK Type: Output Flag: '1^Message' = All is well, '0^Message' = Bad news The list of possible return values is shown below: 0^Medicine Procedure file global location not found MEANING: The Global Location field (#1) in the Procedure / Subspecialty file (#697.2) has a value in it that is less than or equal to zero. 0^Medical Patient field not found in Medicine Procedure file MEANING: A field that points to the Patient file (#2) could not be found in the Medicine Procedure data file (see file list under MCD0). 0^Medicine Procedure file global name not found MEANING: The global root of the Medicine Procedure data file (see file list under MCD0) could not be found. (File file (#1) problem) 0^Medicine Procedure file global subscript location not found MEANING: The node on which the image pointer multiple stores its data cound not be found (Medicine DD problem). 0^Cannot add patient to Medical Patient file MEANING: A new record could not be created in the Medical Patient file (#690). 0^Cannot create stub record in the Medicine Procedure data file MEANING: A new stub record could not be created in one of the Medicine Procedure data files (see file list under MCD0). 0^No image number to file in Medicine Procedure file MEANING: The MCMAGPTR() array was not passed in, does not contain any data, or was passed in incorrectly. 0^Image field not found in the Medicine Procedure file MEANING: A field number of 2005 was not found in the Medicine Procedure data file (see file list under MCD0). 0^Cannot add image to Medicine Procedure file MEANING: A new image sub-record could not be added to the Image multiple (#2005) in the Medicine Procedure data file (see file list under MCD0). 0^Patient mismatch MEANING: The Medicine Procedure data file record pointed to by the MCD0 parameter has a different Patient file (#2) pointer than the Patient file (#2) pointer that was passed in in the MCDFN parameter. 0^Procedure/Subspecialty mismatch MEANING: The Medicine Procedure data file record pointed to by the MCD0 parameter has a different Procedure / Subspecialty file (#697.2) pointer than the Procedure / Subspecialty file (#697.2) pointer that was passed in in the MCPROCD0 parameter. 0^Procedure is invalid MEANING: The value passed in in the MCPROCD0 parameter failed the input transform of the field it was going to be stuffed into. 0^Entry 'GENERIC PROCEDURE' not found MEANING: The 'GENERIC PROCEDURE' entry was not found in the Procedure/Subspecialty file (#697.2). This message is only valid after the installation of patch MC*2.3*8. 0^Entry 'GENERIC SUBSPECIALTY' not found MEANING: The 'GENERIC SUBSPECIALTY' entry was not found in the Procedure/Subspecialty file (#697.2). This message is only valid after the installation of patch MC*2.3*8. 0^Invalid Procedure/Subspecialty MEANING: The pointer to the Procedure/Subspecialty file (697.2) (MCPROCD0) is not flagged as a procedure or a subspecialty in the 'Procedure/Subspecialty' field (697.2,1001). This message is only valid the installation of patch MC*2.3*8. 1^Record match found MEANING: The Medicine Procedure data file record pointed to by the MCD0 parameter has Patient file (#2) and Procedure / Subspecialty (#697.2) pointers that match the values passed in in the MCDFN and MCPROCD0 parameters. Note, this message is used internally within the API and you will most likely never see it since it will be superseded by one of the other messages. 1^New stub record created in Medicine Procedure data file MEANING: New stub record have been created in the Medical Patient file (#690) (if needed) and one of the Medicine Procedure data files (see file list under MCD0). Note, this message will only be returned if $O(MCMAGPTR(0))'>0 and MCD0'>0 and the creation of the new record(s) was successful. 1^The Medicine Procedure file has been updated MEANING: The Image file (#2005) pointers passed in in the MCMAGD0() array have been added to (or have been found to previously exist in) the Image multiple (#2005) of the Medicine Procedure data file (see file list under MCD0). ******************** 2040 NAME: MEDICINE KILL API CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING USAGE: Controlled Subscri ENTERED: JUN 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point removes entries from the Image multiples in the Medicine Procedure data files. ROUTINE: MCUIMAG0 COMPONENT: KILL VARIABLES: MCFILE Type: Input A Medicine Procedure data file number 691*, 691.1*, 691.5*, 691.6, 691.7, 691.8, 694*, 694.5 698, 698.1, 698.2, 698.3, 699*, 699.5*, 700, 701* (Note: only those marked with a '*' have Image pointer multiples) MCD0 Type: Input A pointer to one of the entries in one of the Medicine Procedure data files, e.g., ^MCAR(MCFILE,MCD0,... MCD1 Type: Input A pointer to one of the entries in the in the Image multiple e.g., ^MCAR(MCFILE,MCD0,2005,MCD1,0)='File_#2005_P ointer' OK Type: Output Flag: '1^Message' = All is well, '0^Message' = Bad news The list of possible return values is shown below: 0^Image field not found in the Medicine Procedure file MEANING: A pointer to the Image file (#2005) was not found in the Medicine Procedure data file (see file list under MCD0). 0^Medicine Procedure file global name not found MEANING: The global root of the Medicine Procedure data file (see file list under MCD0) could not be found. (File file (#1) problem) 0^Medicine Procedure file global subscript location not found MEANING: The node on which the image pointer multiple stores its data cound not be found (Medicine DD problem). 1^Image pointer deleted from Medicine Procedure file MEANING: The pointer to the Image file (#2005) has been removed from the Medicine Procedure data file. ******************** 2041 NAME: DB2041 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: IMAGING WOMEN'S HEALTH BAR CODE MED ADMIN USAGE: Controlled Subscri ENTERED: JUN 25,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Used to display the Patient Profile report via a "silent call". ROUTINE: DGRPD COMPONENT: EN VARIABLES: IOP Type: Input DEVICE NAME DFN Type: Input Patient's internal entry number in file 2. Prints a patient profile. Passed to this routine is the device and patient's DFN. ******************** 2043 NAME: DBIA2043 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine EN1^RAO7PC1 can be used to return a list of a patient's Rad/Nuc Med procedures and related information. Cancelled exams may be included, depending upon the RACINC input parameter. Exam ID output can be used as input to another API to retrieve result reports. (See DBIA #2265) Report ien output can also be used to retrieve a report. (See DBIA #1177) ROUTINE: RAO7PC1 COMPONENT: EN1(RADFN,RABDT,RAEDT,RAEXN,RACINC) VARIABLES: RADFN Type: Input Internal entry number (ien) of the patient in the Rad/Nuc Med Patient file #70. (Note: this ien is the same ien used in the Patient file #2. File 70 is DINUMED to file 2. RADFN is also known as the patient ien. RABDT Type: Input Beginning date used to extract exam data for a specific time frame. RAEDT Type: Input Ending date used to extract exam data for a specific time frame. RAEXN Type: Input Maximum number of exams to extract within a time frame. If RAEXN is numeric, then each case within a parent procedure is counted separately. However, if RAEXN has a trailing "P", then all cases within a parent procedure are counted together as 1. RACINC Type: Input Include cancelled exams flag (1 if yes, default is no). This input parameter was added in RA*5.0*26. A later patch, RA*5.0*36, further restricts when cancelled cases would be returned: (1) case's division's ALLOW RPTS ON CANCELLED CASES? is "Y" and (2) case has a report. TMP($J,'RA Type: Output ^TMP($J,"RAE1",patient ien,exam id)= procedure name^case number^report status^ abnormal alert flag^report ien^exam status order #~exam status name^imaging location name^ imaging type abbr~imaging type name^ abnormal results flag^CPT Code^CPRS Order ien^ Images exist flag subscripts ---------- Patient ien: Internal entry number of the patient in both the Rad/Nuc Med Patient file #70 and the Patient file #2. Exam Id: Reverse exam date/time of the exam concatenated to the ien of the case. Example: 7019698.9093-1 (where the exam date/time is 03/01/1998@9:06am and the case ien is 1. '70119689.9093' is derived from: 9999999.9999-2980301.0906) array value (in ascending piece position) ----------------------------------------- Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure prior to the exam reaching a 'COMPLETE' status. Case Number: Identifying external case number for an exam. Can be a number between 1 and 99999. Report Status: External name of the report status. Possible statuses include: DRAFT, PROBLEM DRAFT, RELEASED/NOT VERIFIED, VERIFIED and NO REPORT. It is possible for the exam to have a report with a 'NO REPORT' status. A 'NO REPORT' status refers to a stub report that was created for the Imaging package file of images, this stub report record has no data entered by Radiology/Nuclear Medicine staff. Abnormal Alert Flag: Set to 'Y' if an abnormal diagnostic code is assigned to this case, blank if no abnormal code. A diagnostic code is considered abnormal if its entry in the Diagnostics Codes file #78.3 contains a 'Y' in the 'Generate Abnormal Alert' field. Report ien: This is the internal entry number of a report in the Rad/Nuc Med Reports file #74. Exam Status Order Number: A number between 0 and 9 where: 0=cancelled, 1=waiting for exam & 9=complete. All other order numbers are site configurable. Exam Status Name: External representation of exam status. Examples: WAITING FOR EXAM, EXAMINED, CANCELLED and COMPLETE. Imaging Location Name: Name of the imaging location in the Imaging Location file #79.1. This file points to the Hospital Location file #44. These files are not DINUMED. Imaging Type Abbreviation: This is a 1-4 character abbreviation of the imaging type of the exam. Examples: ANI, CARD, CT, MAM, MRI, NM, RAD, US and VAS. Imaging Type Name: External representation of the imaging type name. Examples: ANGIO/NEURO/INTERVENTIONAL, CARDIOLOGY STUDIES (NUC MED), CT SCAN, GENERAL RADIOLOGY, MAGNETIC RESONANCE IMAGING, MAMMOGRAPHY, NUCLEAR MEDICINE, ULTRASOUND and VASCULAR LAB. Abnormal Results Flag: Set to 'Y' if our primary diagnostic code has the field, PRINT ON ABNORMAL REPORT set to 'Yes'. If the field is set to any other value than 'Yes', our flag value is blank (null). CPT Code: This is the Current Procedural Terminology (CPT) code assigned to the registered procedure. Detailed and Series procedure types have CPT codes. Broad and Parent procedure types do not have CPT codes. CPRS Order ien: This is a pointer data type that indicates the record number of the order in the Order Entry/Results Reporting (OE/RR) package. This piece will be non-null if the OE/RR package is running and the Radiology/Nuclear Medicine package is available through OE/RR. Images exist flag: Set to 'Y' if images are associated with the report identified by Report ien above. If no images exist this flag will be set to 'N'. This flag was introduced in RA*5.0*26. Patch RA*5.0*10 provides additional ^TMP nodes for optional retrieval: Output: ^TMP($J,"RAE1",patient ien, exam id,"CMOD",n)= CPT modifier^CPT modifier name where n=1,2,3...total number of CPT modifiers for the exam Patch RA*5.0*36 provides additional ^TMP nodes for optional retrieval: Output: ^TMP($J,"RAE1",patient ien, exam id,"CPRS")= member of set^parent procedure name where member of set is the value of MEMBER OF SET in subfile 70.03 If the name of the Parent Procedure cannot be found, then "PARENT PROCEDURE" will be put into the second piece. ******************** 2045 NAME: DBIA2045 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: SURGERY VIRTUAL PATIENT RECORD Added 10/26/18 for VPR*1*8, to support the new HealthShare effort. USAGE: Controlled Subscri ENTERED: JUN 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File This will permit the direct reads using the "AVSIT" cross reference of the OUTPATIENT ENCOUNTER file (#409.68). This will be used to find an encounter associated with a specific visit from the VISIT file (#9000010), or determine that no entry exists for a visit in the OUTPATIENT ENCOUNTER file. Once the "AVSIT" cross-reference has been used to determine if an entry exists, the entry will be viewed, using VA FileMan, to check the STATUS field (#.12) ^SCE('AVSIT', This will enable the user to look up the OUTPATIENT ENCOUNTER associated with a particular visit. ^SCE(D0,0) .12 STATUS 0;12 Read w/Fileman This contains the status of the Outpatient encounter. ROUTINE: ******************** 2048 NAME: DBIA2048 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HOME BASED PRIMARY CARE USAGE: Private ENTERED: JUN 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.18 ROOT: AUPNVCPT( DESCRIPTION: TYPE: File This will allow the user to use the "AD" cross-reference to obtain the ifn of a record using the VISIT number, in order to find the value of the CPT(.01) and ENCOUNTER PROVIDER (1204) fields in the V CPT file (#9000010.18). ^AUPNVCPT('AD', This will allow the user to find the associated V CPT entries based on the VISIT number. ^AUPNVCPT(D0,0) .01 CPT 0;1 Direct Global Read & w This contains the pointer to the CPT file (#81) for the associated procedure. ^AUPNVCPT(D0,12) 1204 ENCOUNTER PROVIDER 12;4 Direct Global Read & w This field contains a pointer to the NEW PERSON file (#200) for the provider associated with this CPT. ROUTINE: ******************** 2049 NAME: LABORATORY DPT REFERRAL POINTER CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUN 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Laboratory Electronic Date Interchange (LEDI) software is used to accept electronic orders from and send electronic results to other Laboratory Information Systems (LIS). The LEDI specimen accessioning procedure has been redesigned to limit or eliminate the user's clerical patient demographic data entry. This is achieved by adding an enhancement to the existing FileMan patient lookup. All LEDI patients are accessioned into the Referral File (#67). Adding patients to this file requires the entry of Name, DOB, PID and Sex. The clerical step of entering patient's demographic data is done by the accessioning software. If the FileMan lookup on the ^DPT( file is successful, a pointer is to be placed in the Patient ^DPT( file pointing to corresponding Referral entry. This pointer servers as a positive link identifier for future reference. This new pointer serves the same purpose as the existing field in the PATIENT FILE, LABORATORY REFERENCE (#63) except the new field will point to the Referral File (#67). Patient (#2) File ^DD(2,67,0)=LAB REFERRAL REF^P67'X^LRT(67,^LRT(;1^K X NUMBER:67 LABEL: LAB REFERRAL REF SPECIFIER: P67'X POINTER: LRT(67, GLOBAL SUBSCRIPT LOCATION: LRT;1 INPUT TRANSFORM: K X DESCRIPTION: This field contains the pointer reference to the Referral file of the Laboratory Package. This field is set by the laboratory accessioning software and should not be edited. Changing of this pointer will result in misidentification of patients that could have dire medical repercussions. This DBA is requesting the permission for establishment of this field within the Patient File and permission to set and read this field directly. ROUTINE: ******************** 2050 NAME: Database Server (DBS) API: DIALOG Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DIALOG file utilities. BLD: DIALOG Extractor $$EZBLD: DIALOG Extractor (Single Line) MSG: Output Generator ROUTINE: DIALOG COMPONENT: BLD() VARIABLES: DIALOG# Type: Input (Required) Record number from the DIALOG file for the text to be returned. [.]TEXT_PA Type: Input (Optional) Local array containing the dialog parameters to substitute into the resulting text. Set the subscript of each node in this array to a dialog parameter that's in a |window| in the referenced Dialog entry's text. The value of each node should be in external, printable format, and will be substituted in the Dialog text for that dialog parameter. [.]OUTPUT_ Type: Both (Optional) This is useful mainly if you are returning error messages as part of an API for other programmers to use. Use it to pass dialog parameters back to the user of your API, such that they can be accessed individually instead of just being embedded in the error text. OUTPUT_ARR Type: Both (Optional) If provided, the text will be output in the local or global array named by this parameter. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: S Suppresses the blank line that is normally inserted between discrete blocks of text that are built by separate calls to this routine. F Formats the local array similar to the default output format of the ^TMP global, so that MSG^DIALOG can be called to either write the array to the current device or to a simple local array. This entry point performs the following functions: Extracts a dialog from a FileMan DIALOG file entry Substitutes dialog parameters into the text if requested Returns the text in an array Format: BLD^DIALOG(DIALOG#,[.]TEXT_PARAM,[.]OUTPUT_PARAM,OUTPUT_ARRAY, FLAGS) COMPONENT: $$EZBLD() VARIABLES: DIALOG# Type: Input (Required) Record number from the DIALOG File for the text to be returned. [.]TEXT_PA Type: Input (Optional) Name of local array containing the parameter list for those parameters that are to be incorporated into the resulting text. These parameters should be in external, printable format. If there is only one parameter in the list, it can be passed in a local variable or as a literal. This extrinsic function returns the first line of text from an entry in the DIALOG File. It can be used when the text entry is only one line and when the output does not need to be put into an array. Format $$EZBLD^DIALOG(DIALOG#,[.]TEXT_PARAM) COMPONENT: MSG() VARIABLES: FLAGS Type: Input (Optional) Flags to control processing. If none of the text type flags (E, H or M) is entered, the routine behaves as if "E" were entered. If no flags are entered, it behaves as if FLAGS contained "WE". The possible values are: A Local Array specified by the second parameter receives the text. W Writes the text to the current device. S Saves the ^TMP or other designated input array (does not kill the array). E Error array text is processed. H Help array text is processed. M Message array text (other text) is processed. B Blank lines are suppressed between error messages. T Return Total number of lines in the top level node of the local array specified by the second parameter. Type: .OUTPUT_AR Type: Both (Optional) This parameter contains the name of the local array to which the text is to be written. If FLAGS contains an A, this parameter must be sent. Otherwise, the parameter is ignored. TEXT_WIDTH Type: Input (Optional) Maximum line length for formatting text. LEFT_MARGI Type: Input (Optional) Left margin for writing text. If sent, the text is lined up in a column starting at this column number. INPUT_ROOT Type: Input (Optional) Closed root of local input array in which text resides. If the text resides in a local array, this parameter must be sent. ARRAY Type: Output Total number of lines (only returned if FLAGS contains "T"). ARRAY(n) Type: Output A line of formatted text (n=sequential integer starting with 1). This procedure takes text from one of the FileMan dialogue arrays (for errors, help text, or other text) or from a similarly structured local array writes it and/or moves it into a simple local array. Format: MSG^DIALOG(FLAGS,.OUTPUT_ARRAY,TEXT_WIDTH,LEFT_MARGIN,INPUT_RO OT) ******************** 2051 NAME: Database Server API: Lookup Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Lookup utilities. FIND: Finder $$FIND1: Finder (Single Record) LIST: Lister ROUTINE: DIC COMPONENT: FIND() VARIABLES: FILE Type: Input (Required) This parameter is the number of the file or subfile to search. If it is a subfile, it must be accompanied by the IENS parameter. IENS Type: Input (Optional) The IENS that identifies the subfile if FILE is a subfile number. Defaults to no subfile. FIELDS Type: Input (Optional) The fields to return with each entry found, in addition to the .01 field, internal entry number, and any MUMPS identifiers on the file. Defaults to returning the internal entry number, the .01 field, and all identifiers. FLAGS Type: Input (Optional) This parameter lets the caller adjust the Finder's algorithm. The possible values are: A Allow pure numeric input to always be tried as an IEN. M Multiple index lookup allowed. O Only find exact matches if possible. Q Quick lookup. X EXact matches only. VALUE Type: Input (Required) The lookup value. NUMBER Type: Input (Optional) The maximum number of entries to find. INDEXES Type: Input (Optional) The indexes the Finder should search for matches. SCREEN Type: Input (Optional) A screen to apply to each record found. IDENTIFIER Type: Input (Optional) The text to accompany each found entry to help identify it to the end user. TARGET_ROO Type: Both (Optional) The array that should receive the output list of found entries. If not specified, the default location is descendent from ^TMP("DILIST",$J). When the calling application is finshed with the data the ^TMP("DILIST",$J) array may be killed. MSG_ROOT Type: Both (Optional) The array that should receive any error messages. This procedure finds records in a file based on an input value. Format FIND^DIC(FILE,IENS,FIELDS,FLAGS,VALUE,NUMBER,INDEXES,SCREEN,ID ENTIFIER, TARGET_ROOT,MSG_ROOT) COMPONENT: $$FIND1() VARIABLES: FILE Type: Input (Required) This parameter should be the number of the file or subfile to search. If it is a subfile, it must be accompanied by the IENS parameter. IENS Type: Input (Optional) The IENS that identifies the subfile if FILE is a subfile number. FLAGS Type: Input (Optional) This parameter lets the caller adjust the Finder's algorithm. The possible values are: A Allow pure numeric input to always be tried as an IEN. M Multiple index lookup allowed. O Only find exact matches if possible. Q Quick lookup. X EXact matches only. VALUE Type: Input (Required) The lookup value. INDEXES Type: Input (Optional) The indexes the Finder should search for a match. SCREEN Type: Input (Optional) A screen to apply to the record found. MSG_ROOT Type: Both (Optional) The array that should receive any error messages. This extrinsic function finds a single record in a file based on an input value; if more than one match is found, the function returns an error. Format $$FIND1^DIC(FILE,IENS,FLAGS,VALUE,INDEXES,SCREEN,MSG_ROOT) COMPONENT: LIST() VARIABLES: FILE Type: Input (Required) The file whose entries are to be listed. This should equal the file or subfile number, depending on what the caller wishes to list. IENS Type: Input (Optional) If the FILE parameter equals a file number, don't pass the IENS parameter; it is not needed. If, on the other hand, the FILE parameter equals a subfile number, the Lister needs the IENS parameter to help identify which subfile to list. FIELDS Type: Input (Optional) The fields to return with each entry in the list instead of the field identifiers otherwise returned. FLAGS Type: Input (Optional) Flags to control processing: B Backwards. (Defaults to traversing forward.) I Internal format is returned. NUMBER Type: Input (Optional) The number of entries to return. [.]FROM Type: Both Optional) The index entry from which to begin the list (e.g., a FROM value of "XQ" would list entries following XQ). PART Type: Input (Optional) The partial match restriction. INDEX Type: Input (Optional) The index from which to build the list. Defaults to "B". SCREEN Type: Input (Optional) The screen to apply to each potential entry in the returned list to decide whether or not to include it. This code can rely upon the following: Naked indicator Zero-node of entry's record. D Index being traversed. DIC Number of file being traversed. DIC(0) Flags passed to the Lister (direction). Y Record number of entry under consideration. Y() array For subfiles, descendants give record numbers for all upper levels. Structure resembles DA. Y1 IENS equivalent to Y array. IDENTIFIER Type: Input (Optional) The text to accompany each potential entry in the returned list to help identify it to the end user. TARGET_ROO Type: Both (Optional) The array that should receive the output list. MSG_ROOT Type: Both (Optional) The array that should receive any error messages. This procedure, expected to be used to populate a GUI Listbox gadget, retrieves a list of records from a file. Format LIST^DIC(FILE,IENS,FIELDS,FLAGS,NUMBER,[.]FROM,PART,INDEX,SCRE EN, IDENTIFIER,TARGET_ROOT,MSG_ROOT) ******************** 2052 NAME: Database Server API: Data Dictionary Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Data dictionary utilities. FIELD: DD Field Retriever FIELDLST: DD Field List Retriever FILE: DD File Retriever FILELST: DD File List Retriever $$GET1: Attribute Retriever ROUTINE: DID COMPONENT: FIELD() VARIABLES: FILE Type: Input (Required) File or subfile number. FIELD Type: Input (Required) Field name or number. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: N No entry in the target array is created if the attribute is null. Z Word processing attributes include "0" nodes with text. ATTRIBUTES Type: Input (Required) A list of attribute names separated by semicolons. Full attribute names must be used. Following are the attributes that can be requested: AUDIT AUDIT CONDITION COMPUTE ALGORITHM COMPUTED FIELDS USED DATE FIELD LAST EDITED DECIMAL DEFAULT DELETE ACCESS DESCRIPTION FIELD LENGTH GLOBAL SUBSCRIPT LOCATION HELP-PROMPT INPUT TRANSFORM LABEL MULTIPLE-VALUED OUTPUT TRANSFORM POINTER READ ACCESS SOURCE SPECIFIER TECHNICAL DESCRIPTION TITLE TYPE WRITE ACCESS XECUTABLE HELP TARGET_ROO Type: Both (Required) The closed root of the array that should receive the attributes. MSG_ROOT Type: Both (Optional) The name of a closed root reference that is used to pass error messages. If not passed, ^TMP("DIERR",$J) is used. This procedure retrieves the values of the specified field-level attributes for the specified field. Format FIELD^DID(FILE,FIELD,FLAGS,ATTRIBUTES,TARGET_ROOT,MSG_ROOT) COMPONENT: FIELDLST() VARIABLES: TARGET_ROO Type: Both (Required) The root of an output array. Output TARGET_ROOT The descendants of the array root are subscripted by the attribute names. "WP" nodes indicate that the attribute consists of a word processing field. This procedure returns a list of field-level attributes that are supported by FileMan. It shows specifically which attributes the Data Dictionary retriever calls can return. Format FIELDLST^DID(TARGET_ROOT) COMPONENT: FILE() VARIABLES: FILE Type: Input (Required) File number (but not subfile attributes). FLAGS Type: Input (Optional) Flags to control processing. The possible values are: N No entry in the target array is created if the attribute is null. Z Word processing attributes include Zero (0) nodes with text. ATTRIBUTES Type: Input (Required) A list of attribute names separated by semicolons. Full attribute names must be used: ARCHIVE FILE AUDIT ACCESS DATE DD ACCESS DEL ACCESS DESCRIPTION DEVELOPER DISTRIBUTION PACKAGE ENTRIES GLOBAL NAME LAYGO ACCESS LOOKUP PROGRAM NAME PACKAGE REVISION DATA REQUIRED IDENTIFIERS RD ACCESS VERSION WR ACCESS TARGET_ROO Type: Both (Required) The name of a closed array reference. MSG_ROOT Type: Both (Optional) The name of a closed root array reference that is used to pass error messages. If not passed, messages are returned in ^TMP("DIERR",$J). This procedure retrieves the values of the file-level attributes for the specified file. It does not return subfile attributes. Format FILE^DID(FILE,FLAGS,ATTRIBUTES,TARGET_ROOT,MSG_ROOT) COMPONENT: FILELST() VARIABLES: DD File List Retriever COMPONENT: $$GET1() VARIABLES: FILE Type: Input (Required) File number. FIELD Type: Input Field number or name. (Required only when field attributes are being requested, otherwise this function assumes a file attribute is being requested). FLAGS Type: Input (Optional) Flag to control processing: Z Zero nodes on word processing attributes are included in the array subscripts. ATTRIBUTE Type: Input (Required) Data dictionary attribute name. TARGET-ROO Type: Both Closed array reference where multi-lined attributes will be returned. (Required only when multi-line values are returned, such as word processing attributes like "DESCRIPTION"). MSG-ROOT Type: Both (Optional) The name of a closed root reference that is used to pass error messages. If not passed, ^TMP("DIERR",$J) is used. This extrinsic function retrieves a single attribute from a single file or field. Format $$GET1^DID(FILE,FIELD,FLAGS,ATTRIBUTE,TARGET_ROOT,MSG_ROOT) ******************** 2053 NAME: Data Base Server API: Editing Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Editing Utilities CHK: Data Checker FILE: Filer HELP: Helper UPDATE: Updater VAL: Validator WP: Word Processing Filer $$KEYVAL^DIE( ): Key Validator VALS^DIE( ): Fields Validator ROUTINE: DIE COMPONENT: CHK() VARIABLES: FILE Type: Input (Required) File or subfile number. FIELD Type: Input (Required) Field number for which data is being validated. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: H Help (single "?") is returned if VALUE is not valid. E External value is returned in RESULT(0). VALUE Type: Input (Required) Value to be validated, as entered by a user. .RESULT Type: Both (Required) Local variable that receives output from the call. MSG_ROOT Type: Both (Optional) Root into which error, help, and message arrays are put. If this parameter is not passed, these arrays are put into nodes descendent from ^TMP. This procedure checks user-supplied data against the data dictionary definition of a field. Format CHK^DIE(FILE,FIELD,FLAGS,VALUE,.RESULT,MSG_ROOT) COMPONENT: FILE() VARIABLES: FLAGS Type: Input (Optional) Flags to control processing. The possible values are: K LocKing is done by the Filer. (See discussion of Locking below.) S Save FDA. If this flag is not set and there were no errors during the filing process, the FDA is deleted. If this flag is set, the array is never deleted. E External values are processed. If this flag is set, the values in the FDA must be in the format input by the user. The value is validated and filed if it is valid. If the flag is not set, values must be in internal format and must be valid; no validation or transformation is done by the Filer FDA_ROOT Type: Input (Required) The root of the FDA that contains the data to file. MSG_ROOT Type: Both (Optional) The root of an array (local or global) into which error messages are returned. If this parameter is not included, error messages are returned in the default array-^TMP("DIERR",$J). This procedure: Puts validated data that is in internal FileMan format into the database. OR: Validates data that is in external (user-provided) format, converts it to internal FileMan format, and files valid data into the database. Format FILE^DIE(FLAGS,FDA_ROOT,MSG_ROOT) COMPONENT: HELP() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Optional) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Field number for which help is requested. FLAGS Type: Input (Required) Flags used to determine what kind of help is returned by the call. If a lower case letter is shown, use it to suppress that kind of help-useful in conjunction with ? or ??. The possible values are: ? Help equivalent to user entering one "?" at an edit prompt. (Also help returned for an invalid response.) ?? Help equivalent to user entering "??" at an edit prompt. A All available help for the field. F Fields that can be used for lookups. Returned for top-level .01 fields and for pointed-to files for pointer data types. For pointed-to files, the "F" flag is effective only if the "G" flag is also sent. H Help prompt text. X Xecutable help-the MUMPS code contained in Xecutable Help is executed. In order to have the help returned in an array, the executed code must use EN^DDIOL to load the help message. D Description text for the field; this may be multiple lines. P Pointer screen description. C Set of Codes screen description. T Date/Time generic help. This help text is customized based on the allowable and required elements of the particular Date/Time field. S Set of codes possible choices. Any screen that exists on the set of codes field is applied so that only actually selectable choices are presented. U Unscreened set of codes choices. V Variable pointer help that lists the prefixes and messages associated with a particular variable pointer field. B (b) Brief variable pointer help. A single line beginning with "To see the entries ...". M More variable pointer help. Detailed description of how to enter variable pointer data. G (g) getting help from pointed-to file. Help for the .01 field of pointed-to file is returned. MSG_ROOT Type: Both (Optional) Closed root into which the output from the call is put. If not supplied, output is returned in ^TMP. DIHELP Type: Output Number of lines of help text returned TMP("DIHEL Type: Output Array containing the lines of help text. The text is found in integer subscripted nodes (n), beginning with 1. A blank node is inserted between each different type of help returned. This procedure retrieves user-oriented help for a field from the Data Dictionary and other sources. Format HELP^DIE(FILE,IENS,FIELD,FLAGS,MSG_ROOT) COMPONENT: UPDATE() VARIABLES: FLAGS Type: Input (Optional) Flags to control processing. The possible values are: E External values are processed. If this flag is set, the values in the FDA must be in the format input by the user. The Updater validates all values and converts them to internal format. Invalid values cancel the entire transaction. If the flag is not set, values must be in internal format and must be valid. S The Updater Saves the FDA instead of killing it at the end. FDA_ROOT Type: Input (Required) The name of the root of a FileMan Data Array, which describes the entries to add to the database. IEN_ROOT Type: Both (Optional) The name of the Internal Entry Number Array (or IEN Array). Output: As the Updater assigns record numbers to the records described in the FDA, it sets up nodes in the IEN Array to indicate how it decoded the sequence numbers. MSG_ROOT Type: Both (Optional) The array that should receive any error messages. If the MSG_ROOT is not passed, errors are returned descendent from ^TMP("DIERR",$J). This procedure adds new entries in files or subfiles. Format UPDATE^DIE(FLAGS,FDA_ROOT,IEN_ROOT,MSG_ROOT) COMPONENT: VAL() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Required) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Field number for which data is being validated. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: E External value is returned in RESULT(0). F FDA node is set for valid data in array identified by FDA_ROOT. H Help (single ?) is returned if VALUE is not valid. R Record identified by IENS is verified to exist and to be editable. Do not include "R" if there are placeholders in the IENS. VALUE Type: Input (Required) Value to be validated as input by a user. .RESULT Type: Both (Required) Local variable which receives output from call. FDA_ROOT Type: Both (Optional; required if F flag present) Root of FDA into which internal value is loaded if F flag is present. MSG_ROOT Type: Both (Optional) Root into which error, help, and message arrays are put. If this parameter is not passed, these arrays are put into nodes descendent from ^TMP. The purpose of the Validator procedure is to take the external form of user input and determine if that value is valid. Format VAL^DIE(FILE,IENS,FIELD,FLAGS,VALUE,.RESULT,FDA_ROOT,MSG_ROOT) COMPONENT: WP() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Required) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Field number of the word processing field into which data is being filed. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: A Append new word processing text to the current word processing data. If this flag is not sent, the current contents of the word processing field are completely erased before the new word processing data is filed. K LocK the entry or subentry before changing the word processing data. WP_ROOT Type: Input (Required) The root of the array that contains the word processing data to be filed. MSG_ROOT Type: Both (Optional) Root into which errors are put. If this parameter is not passed, these arrays are put into nodes descendent from ^TMP. This procedure files a single word processing field. Format WP^DIE(FILE,IENS,FIELD,FLAGS,WP_ROOT,MSG_ROOT) COMPONENT: $$KEYVAL() VARIABLES: FLAGS Type: Both (Optional) Flags to control processing. The possible values are: Q = Quit when the first problem in the FDA is encountered. FDA_ROOT Type: Both (Required) The root of the FDA that contains the data to be checked. The array can be a local or global one. See the Database Server Introduction for details of the structure of the FDA. The value of fields in the FDA must be the internal value. Do not pass external (e.g., unresolved pointer values, non-FileMan dates) in the FDA. No action is taken on fields in the referenced FDA if those fields do not participate in a Key defined in the KEY file. MSG_ROOT Type: Both (Optional) The root of an array into which error messages are returned. If this parameter is not included, errors are returned in the default array: ^TMP("DIERR",$J). 0/1 Type: Output The function returns a 1 if key integrity is not violated by any value in the FDA and a 0 if an invalid key was produced by any of the values. The Key Validator extrinsic function verifies that new values contained in the FDA do not produce an invalid key. All keys in which any field in the FDA participates are checked. If the value for a field in a key being checked is not present in the FDA, the value used to verify the key is obtained from the previously filed data. Format $$KEYVAL^DIE(FLAGS,FDA_ROOT,MSG_ROOT) COMPONENT: VALS() VARIABLES: FLAGS Type: Input (Optional) Flags to control processing. The possible values are: K - If the file has a Primary Key, this flag indicates that the Primary Key fields, not the .01 field, are to be used for lookup in the Finding and LAYGO/Finding nodes of the FDA. Without this flag, VALS^DIE assumes that you want to file the fields in the Primary Key, rather than use them for lookup, and performs the uniqueness check. This flag is equivalent to the "K" flag in the Updater (UPDATE^DIE). R - Records identified by IENSs in the FDA_EXT are verified to exist and to be editable. (Same as R flag for VAL^DIE.) U - Don't perform key validation. Without this flag, the data in the FDA is checked to ensure that no duplicate keys are created and that key field values are not deleted. FDA_EXT_RO Type: Input (Required) The root of a standard FDA. This array should contain the external values that you want to validate. This is the input array. See the Database Server Introduction for details of the structure of the FDA. FDA_INT_RO Type: Both (Required) The root of a standard FDA. This FDA is the output array, and upon return is set equal to the internal values of each validated field. If a field fails validation, its value is set to an up-arrow (^). (NOTE: If a field is valid, the corresponding node in the output array is set to the internal value, not an up-arrow (^), even if that field violates key integrity.) See the Database Server Introduction for details of the structure of the FDA MSG_ROOT Type: Both (Optional) The root of an array (local or global) into which error messages are returned. If this parameter is not included, error messages are returned in the default array: ^TMP("DIERR",$J). The Fields Validator procedure validates data for a group of fields and converts valid data to internal VA FileMan format. It is intended for use with a set of fields that comprise a logical record; fields from more than one file can be validated by a single call. By default, the integrity of any keys affected by the new values is checked. The Fields Validator performs the same checks performed by VAL^DIE (see for details). Format VALS^DIE(FLAGS,FDA_EXT_ROOT,FDA_INT_ROOT,MSG_ROOT) ******************** 2054 NAME: Data Base Server API: Misc. Library Functions CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Various libaray functions. CLEAN: Array and Variable Clean-up $$CREF: Root Converter (Open to Closed Format) DA: DA( ) Creator DT: Date Converter FDA: FDA Loader $$IENS: IENS Creator $$OREF: Root Converter (Closed to Open Format) $$VALUE1: FDA Value Retriever (Single) VALUES: FDA Values Retriever ROUTINE: DILF COMPONENT: CLEAN VARIABLES: None Type: This procedure kills the standard message arrays and variables that are produced by VA FileMan. COMPONENT: $$CREF() VARIABLES: OPEN_ROOT Type: Input (Required) An open root which is a global root ending in either an open parenthesis or a comma. This extrinsic function converts the traditional open root format to the closed root format used by subscript indirection. Format $$CREF^DILF(OPEN_ROOT) COMPONENT: DA() VARIABLES: IENS Type: Input (Required) A string with record and subrecord numbers in IENS format. .DA Type: Both (Required) The name of the array which receives the record numbers. NOTE: This array is cleaned out (killed) before the record numbers are loaded. This procedure converts an IENS into an array with the structure of a DA() array. Format DA^DILF(IENS,.DA) COMPONENT: DT() VARIABLES: FLAGS Type: Input (Optional) Control processing of user input and the type of output returned. Generally, FLAGS is the same as %DT input variable to ^%DT entry point, with the following exceptions: "A" is not allowed and the meaning of "E" is different (see below). The possible values are: E External, readable date returned in zero-node of RESULT. F Future dates are assumed. N Numeric-only input is not allowed. P Past dates are assumed. R Required time input. S Seconds will be returned. T Time input is allowed but not required. X EXact date (with month and day) is required. IN_DATE Type: Input (Required) Date input as entered by the user in any of the formats known to VA FileMan. .RESULT Type: Both (Required) Local array that receives the internal value of the date/time and, if the "E" flag is sent, the readable value of the date. Output Output is returned in the local array passed by reference in the RESULT parameter, shown below: RESULT Date in internal FileMan format. If input is invalid or if help is requested with a "?", -1 is returned. RESULT(0) If requested, date in external, readable format. When appropriate, error messages and help text are returned in the standard manner in ^TMP or in MSG_ROOT (if it is specified). LIMIT Type: Input (Optional) A value equal to a date/time in FileMan internal format or NOW. IN_DATE is accepted only if it is greater than or equal to LIMIT if it is positive, or less than or equal to LIMIT if it is negative. This is equivalent to the %DT(0) variable in the ^%DT call. MSG_ROOT Type: Both (Optional) Root into which error, help, and message arrays are put. This procedure converts a user-supplied value into VA FileMan's internal date format and (optionally) into the standard VA FileMan external, readable date format. Format DT^DILF(FLAGS,IN_DATE,.RESULT,LIMIT,MSG_ROOT) COMPONENT: FDA() VARIABLES: FILE Type: Input (Required) File or subfile number. .DA Type: Input (Required for format 2) DA() array containing entry and subentry numbers. IENS Type: Input (Required for format 1) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Field number for which data is being loaded into the FDA. FLAGS Type: Input (Optional) Flag to control processing: R Record identified by IENS or .DA is verified to exist. Do not use the "R" FLAG if the IENS or DA() array contain placeholder codes instead of actual record numbers. VALUE Type: Input (Required, can be null) Value to which the FDA node will be set. FDA_ROOT Type: Both (Required) The root of the FDA in which the new node is loaded. MSG_ROOT Type: Both (Optional) Root into which error, help, and message arrays are put. If this parameter is not passed, these arrays are put into nodes descendent from ^TMP. This procedure can be used to load data into the FDA. It accepts either the traditional DA( ) array or the IENS for specifying the entry. No validation of VALUE is done. Format 1. FDA^DILF(FILE,IENS,FIELD,FLAGS,VALUE,FDA_ROOT,MSG_ROOT) 2. FDA^DILF(FILE,.DA,FIELD,FLAGS,VALUE,FDA_ROOT,MSG_ROOT) COMPONENT: $$IENS() VARIABLES: .DA Type: Both Input Parameters .DA (Required) An array with the structure of the traditional VA FileMan DA() array-that is, DA=lowest subfile record number, DA(1)=next highest subfile record number, etc. Output A string of record numbers in the IENS format-that is, "DA,DA(1),...DA(n),". This extrinsic function returns the IENS when passed an array in the traditional DA() structure. Format $$IENS^DILF(.DA) COMPONENT: $$OREF() VARIABLES: CLOSED_ROO Type: Input (Required) A closed root, which is a global root ending in a closed parenthesis. This extrinsic function converts a closed root to an open root. It converts an ending close parenthesis to a comma. Format $$OREF^DILF(CLOSED_ROOT COMPONENT: $$VALUE1() VARIABLES: FILE Type: Input (Required) File or subfile number. FIELD Type: Input (Required) Field number for which data is being requested. FDA_ROOT Type: Input (Required) The root of the FDA from which data is being requested. This extrinsic function returns the value associated with a particular file and field in a standard FDA. Only a single value is returned. Format $$VALUE1^DILF(FILE,FIELD,FDA_ROOT) COMPONENT: VALUES() VARIABLES: FILE Type: Input (Required) File or subfile number. FIELD Type: Input (Required) Field number for which data is being requested. FDA_ROOT Type: Input (Required) The root of the FDA from which data is being requested. .RESULT Type: Both (Required) Local array that receives output from the call. The array is killed at the beginning of each call. This procedure returns values from an FDA for a specified field. Format VALUES^DILF(FILE,FIELD,FDA_ROOT,.RESULT) COMPONENT: LOCK() VARIABLES: REF Type: Both Input: RESOLVED GLOBAL REFERENCE - (Required) This is the fully resolved global reference. Output: $Truth value - 1 equals lock obtained; 0 equals lock failed. The purpose is to lock a global reference using VA FileMan's Lock time out value(DILOCKTM). Format: LOCK^DILF(resolved global reference) Input: RESOLVED GLOBAL REFERENCE - (Required)This is the fully resolved global reference. Output: $Truth value - 1 equals lock obtained; 0 equals lock failed Example: >S REF="^MYFILE(123,1,0)" >D LOCK^DILF(REF) >W $T 1 >W DILOCKTM 3 ******************** 2055 NAME: Data Base Server API: Misc. Data Libaray Functions CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Data libaray functions. $$EXTERNAL: Converter to External $$FLDNUM: Field Number Retriever PRD: Package Revision Data Initializer RECALL: Recall Record Number $$ROOT: File Root Resolver $$VFIELD: Field Verifier $$VFILE: File Verifier ROUTINE: DILFD COMPONENT: $$EXTERNAL() VARIABLES: FILE Type: Input (Required) The number of the file or subfile that contains the field that describes the internal value passed in. FIELD Type: Input (Required) The number of the field that describes the internal value passed in. FLAGS Type: Input (Optional) A single-character code that explains how to handle output transforms found along pointer chains. F First. If the first field in a pointer chain has an output transform, apply the transform to that first field and quit. Ignore any other output transforms found along the pointer chain. With the exception of this function, FileMan regularly handles output transforms this way. L Last. If the last field in a pointer chain has an output transform, apply the transform to that last field and quit. Ignore any other output transforms found along the pointer chain. U Use. Use the first output transform found on the last field in the pointer chain. Following the pointer chain, watch for output transforms. When one is found, remember it, but keep following the pointer chain. When the last field in the chain is reached, apply the remembered transform to that last field. INTERNAL Type: Input (Required) The internal value that is to be converted to its external format. MSG_ROOT Type: Both (Optional) The array that should receive any error messages. If the MSG_ROOT is not passed, errors are returned descendent from ^TMP("DIERR",$J). This extrinsic function converts any internal value to its external format. Format $$EXTERNAL^DILFD(FILE,FIELD,FLAGS,INTERNAL,MSG_ROOT) COMPONENT: $$FLDNUM() VARIABLES: FILE Type: Input (Required) The file number of the field's file or subfile. FIELDNAME Type: Input (Required) The full name of the field for which you want the number. This extrinsic function returns a field number when passed a file number and a field name. Format $$FLDNUM^DILFD(FILE,FIELDNAME) COMPONENT: PRD() VARIABLES: FILE Type: Input (Required) File or subfile number. DATA Type: Input (Required) Free text information, determined by the developer. This procedure sets the PACKAGE REVISION DATA attribute for a file. Format PRD^DILFD(FILE,DATA) COMPONENT: RECALL() VARIABLES: FILE Type: Input (Required) The file or subfile number. IENS Type: Input (Required) The IENS that identifies the record selected. USER Type: Input (Required) The user number (i.e., DUZ) of the user who made the selection. This procedure saves a record number for later retrieval using spacebar recall. Format RECALL^DILFD(FILE,IENS,USER) COMPONENT: $$ROOT() VARIABLES: FILE Type: Input (Required) File number or subfile number. IENS Type: Input (Required when passing subfile numbers) Standard IENS indicating internal entry number. FLAGS Type: Input (Optional) If set to 1 (true), returns a closed root. The default is to return an open root. ERROR_FLAG Type: Input (Optional) If set to 1 (true), processes an error message if error is encountered. This extrinsic function resolves the file root when passed file or subfile numbers. Format $$ROOT^DILFD(FILE,IENS,FLAGS,ERROR_FLAG) COMPONENT: $$VFIELD() VARIABLES: FILE Type: Input (Required) The number of the file or subfile in which the field to be checked exists. FIELD Type: Input (Required) The number of the field to be checked. This extrinsic function verifies that a field in a specified file exists. Format $$VFIELD^DILFD(FILE,FIELD) COMPONENT: $$VFILE() VARIABLES: FILE Type: Input (Required) The number of the file or subfile that you want to check. This extrinsic function verifies that a file exists. Format $$VFILE^DILFD(FILE) ******************** 2056 NAME: Data Base Server API: Data Retriever Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 2,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Data retriever utilities. $$GET1: Single Data Retriever GETS: Multiple Data Retriever ROUTINE: DIQ COMPONENT: $$GET1() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Required) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Can be one of the following: A single field number A list of field numbers, separated by semicolons A range of field numbers, in the form M:N, where M and N are the end points of the inclusive range. All field numbers within this range are retrieved. * for all fields at the top level (no sub-multiple record). ** for all fields including all fields and data in sub-multiple fields. Field number of a multiple followed by an * to indicate all fields and records in the sub-multiple for that field. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: E Returns External values in nodes ending with "E". I Returns Internal values in nodes ending with "I". (Otherwise, external is returned). N Does not return Null values. R Resolves field numbers to field names in target array subscripts. Z Word processing fields include Zero nodes. TARGET_ROO Type: Both (Required) The name of a closed root reference. Output: The output array is in the FDA format, i.e., TARGET_ROOT(FILE,IENS,FIELD)=DATA. WP fields have data descendent from the field nodes in the output array. MSG_ROOT Type: Both (Optional) The name of a closed root reference that is used to pass error messages. This procedure retrieves one or more fields of data from a record or sub-record(s) and places the values in a target array. Format GETS^DIQ(FILE,IENS,FIELD,FLAGS,TARGET_ROOT,MSG_ROOT) COMPONENT: GETS() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Required) Standard IENS indicating internal entry numbers. FIELD Type: Input (Required) Can be one of the following: A single field number A list of field numbers, separated by semicolons A range of field numbers, in the form M:N, where M and N are the end points of the inclusive range. All field numbers within this range are retrieved. * for all fields at the top level (no sub-multiple record). ** for all fields including all fields and data in sub-multiple fields. Field number of a multiple followed by an * to indicate all fields and records in the sub-multiple for that field. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: E Returns External values in nodes ending with "E". I Returns Internal values in nodes ending with "I". (Otherwise, external is returned). N Does not return Null values. R Resolves field numbers to field names in target array subscripts. Z Word processing fields include Zero nodes. TARGET_ROO Type: Both (Required) The name of a closed root reference. Output: The output array is in the FDA format, i.e., TARGET_ROOT(FILE,IENS,FIELD)=DATA. WP fields have data descendent from the field nodes in the output array. MSG_ROOT Type: Both (Optional) The name of a closed root reference that is used to pass error messages. This procedure retrieves one or more fields of data from a record or sub-record(s) and places the values in a target array. Format GETS^DIQ(FILE,IENS,FIELD,FLAGS,TARGET_ROOT,MSG_ROOT) ******************** 2058 NAME: PACKAGE FILE LOOKUP CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE TOOLKIT ORDER ENTRY/RESULTS REPORTING INPATIENT MEDICATIONS Only good for version 4.5 of Outpatient Pharmacy INTEGRATED BILLING Looking up the IEN for the KERNEL package and lookup is only being done in a post-install routine. Using the IEN as an input to the function PUT^XPAR to define an entry in file 8989.5 (PARAMETERS) for XUSNPI QUALIFIED IDENTIFIER. 1 EVENT CAPTURE ADDED 2/28/2012 USAGE: Controlled Subscri ENTERED: JUL 7,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.4 ROOT: DIC(9.4, DESCRIPTION: TYPE: File With the addition of the new Parameter Tools functionality, Lab has need to retrieve the package file internal entry number and the namespace. Lab would like permission to retrieve the IEN of the package file by referencing the B and C indexes. Additionally, a direct access of the PREFIX field is requested. ^DIC(9.4,B,PACKAGE NAME,IEN) uses B x-ref to get IEN for given package name ^DIC(9.4,C,PREFIX,IEN) Uses C index to get IEN for a given package prefix ^DIC(9.4,IEN,0) 1 PREFIX 0;2 Direct Global Read & w gets PREFIX for existing package .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2060 NAME: LAB USE OF OR(100, CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100 ROOT: OR(100, DESCRIPTION: TYPE: File Lab needs to access the ORDERS file (#100) as part of its interface with the Order Entry/Results Reporting package. ^OR(100,DA,0) 4 CURRENT AGENT/PROVID 0;4 Direct Global Read & w Lab checks for existence of an order ($D(^OR(100,DA,0)) as wel as the value in field #4. ^OR(100,DA,3) 5 STATUS 3;3 Direct Global Read & w ^OR(100,DA(1),8,DA,0) .01 DATE/TIME ORDERED 0;1 Direct Global Read & w ^OR(100,'AN' Reference to the AN cross reference is needed in the OE/RR 2.5 interface to clean-up old lab notifications. This is not used with OE/RR 3.0. ^OR(100,DA,4) 33 PACKAGE REFERENCE 4;1 Direct Global Read & w ^OR(100,DA,6) 65 DC REASON TEXT 6;5 Direct Global Read & w ROUTINE: ******************** 2061 NAME: DBIA2061 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: LAB SERVICE NATIONAL DRUG FILE SURGERY RISK ASSESSMENT Added 6/11/20, effective with SRA*3*3 USAGE: Controlled Subscri ENTERED: JUL 11,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 3.8 ROOT: XMB(3.8 DESCRIPTION: TYPE: File This is an agreement for FileMan read/write access to subfile 3.812, (#12) MEMBERS - REMOTE. ^XMB(3.8,D1,6, .01 MEMBERS - REMOTE 0;1 Both R/W w/Fileman ROUTINE: ******************** 2065 NAME: DBIA2065 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: HEALTH SUMMARY WOMEN'S HEALTH ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT ACCOUNTS RECEIVABLE NATIONAL HEALTH INFO NETWORK USAGE: Controlled Subscri ENTERED: JUL 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File This will permit direct reads using the "ADFN" cross reference of the OUTPATIENT ENCOUNTER file (#409.68). This will be used to find an encounter associated with a specific patient for a specific date via ^SCE("ADFN",PATIENT,DATE,D0). Once the "ADFN" cross-reference has been used to determine if an entry exists, the entry will be viewed by a direct global read of the 0-node, and using the following fields: .03 - CLINIC STOP CODE; .04 - LOCATION; .05 - VISIT FILE ENTRY; .06 - PARENT ENCOUNTER; and .08 - ORIGINATING PROCESS TYPE. ^SCE(DA,0) .03 CLINIC STOP CODE 0;3 Direct Global Read & w .04 LOCATION 0;4 Direct Global Read & w .05 VISIT FILE ENTRY 0;5 Direct Global Read & w .06 PARENT ENCOUNTER 0;6 Direct Global Read & w .08 ORIGINATING PROCESS 0;8 Direct Global Read & w ^SCE('ADFN' ROUTINE: ******************** 2067 NAME: UPDATE PACKAGE FILE VERSION/APPLICATION HISTORY CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUL 22,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These functions can be used during the Pre or Post Install routine to update the VERSION multiple and the PATCH APPLICATION HISTORY multiple in the PACKAGE file. ROUTINE: XPDIP COMPONENT: $$PKGPAT(package ien, version, .ARRAY) VARIABLES: package ie Type: Input PACKAGE file entry ien. version Type: Input This is the version number, must contain a decimal. e.g. 8.0 ARRAY Type: Input ARRAY needs to be passed by reference if you want to update the DESCRIPTION field in the PATCH APPLICATION HISTORY multiple. ARRAY = patch number^date installed^installed by patch number = number SEQ#number, i.e. 51 SEQ #32 date installed = Fileman format, use DT installed by = user ien, use DUZ ARRAY(1) = closed global root of location of the Description e.g. ^XTMP($J,""WP"") $$PKGPAT Type: Output version ien^patch ien Update the PATCH APPLICATION HISTORY of the VERSION multiple in the PACKAGE file. COMPONENT: $$PKGVER(package ien, .version) VARIABLES: package ie Type: Input PACKAGE file entry ien version Type: Input This can be either a string or array. If it is an array, then it must be passed by reference. version= version number^date distributed^date installed^installed by user ien version(1) = closed global root of the location of the Description e.g. ^XTMP($J,""WP"") all date values must be internal FileMan date format version number must contain a decimal point $$PKGVER Type: Output version ien Update the VERSION multiple in the PACKAGE file, #9.4 ******************** 2068 NAME: AR PACKAGE FILE UPDATE CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JUL 24,1997 STATUS: Active EXPIRES: SEP 1997 DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This is a one time agreement to allow the updating of patch information in the AR package file for a consolidated patch release. ROUTINE: ******************** 2069 NAME: DBIA2069 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PATIENT REPRESENTATIVE USAGE: Private ENTERED: JUL 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The patient Representative package would like to reference two fields from the patient file, and stuff the information into the 0 node of file 745.1 (CONSUMER CONTACT file). .323 Period of Service .32201 Persian Gulf Service ^DPT(D0,.32) DPT(D0,. PERIOD OF SERVICE Read w/Fileman ^DPT(D0,.322) .32201 PERSIAN GULF SERVICE Read w/Fileman ROUTINE: ******************** 2070 NAME: DBIA2070 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX VISTA HEALTH DATA REPOSITORY TEXT INTEGRATION UTILITIES TIU access is only permitted for the AICN x-ref. USAGE: Controlled Subscri ENTERED: AUG 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The Clinical Information Resource Network (CIRN) and Master Patient Index (MPI) will use the following fields on the MPI and MPIHIS nodes to facilitate the exchange of patient demographic and clinical data. ^DPT(D0,'MPI', 991.01 INTEGRATION CONTROL MPI;1 Both R/W w/Fileman The FM r/w is to allow the Master Patient Index VistA package to retrieve and update the Integration Control Number field via APIs. 991.02 ICN CHECKSUM MPI;2 Both R/W w/Fileman 991.03 CIRN MASTER OF RECOR MPI;3 Both R/W w/Fileman 991.04 LOCALLY ASSIGNED ICN MPI;4 Both R/W w/Fileman 991.05 SUBSCRIPTION CONTROL MPI;5 Both R/W w/Fileman 991.06 CMOR ACTIVITY SCORE MPI;6 Both R/W w/Fileman 991.07 SCORE CALCULATION DA MPI;7 Both R/W w/Fileman 991.01 INTEGRATION CONTROL MPI;1 Direct Global Read & w The Direct Read access is to support the seeding process of the last treatment date field in the Treating Facility file in the RG*1*4 patch. The direct read will minimize the number of disk hits and effeciency of disk hits and effeciency of the seeding which affects thousands of entries. ^DPT('ACMOR', 991.03 CIRN MASTER OF RECOR x-ref Direct Global R/W & w/ ^DPT('ACMORS', 991.06 CMOR ACTIVITY SCORE x-ref Direct Global R/W & w/ ^DPT('AICN', 991.01 INTEGRATION CONTROL x-ref Direct Global R/W & w/ ^DPT('AICNL', 991.04 LOCALLY ASSIGNED ICN x-ref Direct Global R/W & w/ ^DPT('AMPIMIS', .01 NAME x-ref Direct Global R/W & w/ Temporary cross reference that lets the MPI Missing ICN job know that a patient was added to the Patient file, via another package other than PIMS, and needs to get an ICN. Once the ICN is assigned (local or national) the cross reference is killed. ^DPT('AHICN', 991.01 INTEGRATION CONTROL x-ref Direct Global R/W & w/ Used to create ICN History, ICN lookup capability. ^DPT('AR', 991.01 INTEGRATION CONTROL x-ref Direct Global R/W & w/ Cross Reference is used to delete the 'AMPIMIS' cross reference denoting missing ICN. ^DPT(D0,'MPIFHIS',D1, .01 ICN HISTORY 0;1 Direct Global R/W & w/ ICN History, to track changes in Integration Control Number for each patient. This will be used by M code to perform lookups when ICN can't be found to see if it was used previously. 1 ICN CHECKSUM 0;2 Direct Global R/W & w/ 2 CMOR 0;3 Direct Global R/W & w/ 3 DATE/TIME OF CHANGE 0;4 Direct Global R/W & w/ ^DPT('ASCN2', 991.05 SUBSCRIPTION CONTROL x-ref Direct Global R/W & w/ This cross-reference is used by CIRN (Clinical Information Resource Network) for various data validation and reporting functions. ^DPT(0) CIRN is requesting permission to reference by Direct Read the Header Node of the PATIENT file in order to display the number of patients (piece 4) and the last record number entered (piece 3). **CIRN IS AWARE THAT THIS DATA MAY NOT BE RELIED ON TO BE ACCURATE, AS THOSE PIECES OF THE HEADER NODE ARE NOT ALWAYS CORRECTLY UPDATED.** ^DPT(D0,'MPICMOR', .01 CMOR HISTORY 0;1 Direct Global Read & w 3 CMOR CHANGE DATE 0;4 Direct Global Read & w ROUTINE: ******************** 2071 NAME: CODE INDEX (FPDS) CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: FEE BASIS FEE BASIS CLAIMS SYSTEM USAGE: Private ENTERED: AUG 12,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 420.6 ROOT: PRCD(420.6 DESCRIPTION: TYPE: File This agreement permits FEE BASIS to point to the CODE INDEX (#420.6) file and also to access data in the 0 node to support a screen of choices. The CODE INDEX file contains the list of vendor FPDS socio-econonomic groups. ^PRCD(420.6,D0,0) .01 NAME 0;1 Read w/Fileman This is the name of the code index. 1 CODE INDEX 0;2 Read w/Fileman This is the code for the index. 2 EFFECTIVE DATE 0;3 Direct Global Read & w This is the year that the Federal Procurement Data Systems (FPDS) index became effective. 5 APPLICABLE BUSINESS 0;6 Direct Global Read & w This field contains a comma delimited list of applicable business types. The list entered here will determine the choices displayed when editing a vendor's SOCIOECONOMIC GROUPS (FPDS) data. ROUTINE: ******************** 2074 NAME: DBIA2074 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: AUG 18,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File Read access is requested of all fields on the Zero node of this file. These fields will be used for reporting purposes. These fields are: Fld # Fld Name Node;Pce .01 NAME 0;1 1 AMIS REPORTING STOP CODE 0;2 2 INACTIVE DATE 0;3 3 CONVERT TO STOP CODE 0;4 4 COST DISTRIBUTION CENTER 0;5 Read access is requested of the "C" cross reference on this file. The "C" cross reference will be used to check the existence of a specific 'Amis Reporting Stop Code' as defined in field number 1. It is noted that Event Capture needs to reference entries in the Clinic Stop file (40.7) via Internal Entry Numbers (pointers) to that file. ^DIC(40.7,DA,0) .01 NAME 0;1 Read w/Fileman The Name of the Clinic Stop Code. 1 AMIS REPORTING STOP 0;2 Read w/Fileman This field contains the number related to the stop code that is used when generating the OPC file. This number is what is transmitted. 2 INACTIVE DATE 0;3 Read w/Fileman This field contains a date of when a Clinic Stop code has been inactivated. 3 CONVERT TO STOP CODE 0;4 Read w/Fileman This field contains a pointer value to the new Clinic Stop codes that have a three number AMIS REPORTING STOP CODE. 4 COST DISTRIBUTION CE 0;5 Read w/Fileman This field contains a number related to the cost distribution center. This file contains all Clinic Stops (DSS IDs) and their associated AMIS Stop Code. ROUTINE: ******************** 2075 NAME: DBIA2075 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Supported ENTERED: AUG 20,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement expands agreement 10095 for XTKERMIT. This agreement allows access to the KERMIT HOLDING file (#8980) and the API that adds entries to it, RFILE^XTKERM4. The "AOK" cross-reference of the KERMIT HOLDING file (#8980) may be checked to see if the user has an entry in the KERMIT HOLDING file (#8980). If not, RFILE^XTKERM4 may be called to add an entry to the file. ROUTINE: XTKERM4 COMPONENT: RFILE VARIABLES: XTKDIC Type: Output This variable returns the global root and is a calling variable used by calls to RECEIVE^XTKERMIT or SEND^XTKERMIT. XTMODE Type: Output This variable is returned, it is used as input to calls to RECEIVE^XTKERMIT or SEND^XTKERMIT. A call to RFILE^XTKERM4 will allow a user to add or select an entry in the KERMIT HOLDING file (#8980). ******************** 2076 NAME: DBIA2076-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 20,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine To support patient data review, CIRN needs to include a Hinq inquiry. ROUTINE: DG10 COMPONENT: HINQ VARIABLES: DFN Type: Input Patient IEN Background Hinq inquiry ******************** 2077 NAME: DBIA2077 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: SEP 24,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.17 ROOT: AUTTTRT( DESCRIPTION: TYPE: File This integration agreement authorizes global reference to the zeroith node of the following file for purposes of retrieving the name and inactive flag: ^AUTTTRT(#,0) piece 1 and piece 4 ... and to the "B" cross-reference ^AUTTTRT(#,0) .01 NAME 0;1 Direct Global Read & w .04 INACTIVE FLAG 0;4 Direct Global Read & w .01 NAME 0;1 Read w/Fileman This file is a table with site defined Treatment names. These are names of treatments that are not covered in the ICD-9-CM Procedures or the CPT Procedures. Examples may include treatments such as Ear Irrigation, or Instructions or Counseling given to a patient for a Medical Problem. ROUTINE: ******************** 2078 NAME: DBIA2078 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 20,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8980 ROOT: DIZ(8980 DESCRIPTION: TYPE: File Integration Agreement to read the "AOK" cross reference and check for the existence of the ^DIZ(8980,"AOK",DUZ) cross-reference. If not, data is added to the KERMIT HOLDING file (#8980) via the RFILE^XTKERM4 entry point. ^DIZ(8980,D0,0) 4 CREATOR 0;5 Read w/Fileman The CREATOR field contains the person who owns this entry. This file provides a holding place for data being transferred by the KERMIT protocol. By default the data can only be accessed by the user that created it. The Kermit Menu (XT-KERMIT options) may be used to send and receive data via this file. The menu also allows the creator of the data to permit access by others. This file is cross-referenced by name, creator, and access allowed to user. ROUTINE: ******************** 2079 NAME: DBIA2079 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: AUG 22,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.6 ROOT: PSNDF DESCRIPTION: TYPE: File Pharmacy Data Management requests an intergration agreement to look at National Drug file 50.6. ^PSNDF(D0,0) .01 VA GENERIC NAME 0;1 Direct Global Read & w ^PSNDF(D0,2,D1,0) .01 DOSAGE FORM 0;1 Direct Global Read & w ^PSNDF(D0,5,D1,0) .01 VA PRODUCT NAMES 0;1 Direct Global Read & w 1 DOSAGE FORM ENTRY 0;2 Direct Global Read & w ^PSNDF(D0,5,D1,2) 5 VA PRINT NAME 0;1 Direct Global Read & w 6 VA PRODUCT IDENTIFIE 0;2 Direct Global Read & w 7 TRANSMIT TO CMOP 0;3 Direct Global Read & w 8 VA DISPENSE UNIT 0;4 Direct Global Read & w ROUTINE: ******************** 2080 NAME: DBIA2080 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: AUG 22,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management requests an intergration agreement with National Drug File package to call up line-tag REACT1^PSNOUT. The master Drug Enter/Edit option in PDM needs the ability to match to NDF if the user has the proper key. PDM requires at least NDF 3.15 to be in place in order to install. A ^%ZOSF test will be executed on routine PSNOUT. The line-tag allows the user to match, verify, and merge an entry in DRUG file 50 to NATIONAL DRUG file 50.6. ROUTINE: PSNOUT COMPONENT: REACT1 VARIABLES: none Type: Allows user to match, verify, and merge to NDF. ******************** 2081 NAME: DBIA2081 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 30,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Other Pharmacy Data Management requests an intergration agreement with the VA FileMan package. PDM requests to do a one-time hard kill of four triggers which are no longer valid in DRUG file 50. These triggers will be killed in a post install routine in Pharmacy Data Management version 1.0. The fields affected in DRUG file 50 are: Field 12 ORDER UNIT Field 13 PRICE PER ORDER UNIT Field 15 DISPENSE UNITS PER ORDER UNIT Field 16 PRICE PER DISPENSE UNIT In addition: Field 23 PACKAGE SIZE (input transform) Field 24 PACKAGE TYPE (input transform) Field 8 WARNING LABEL (overflow of input transform code) The KILL logic looks as follows: K ^DD(50,12,1,535000),^DD(50,203),^DD(50,13,1,535000),^DD(50,15,1,535000), ^DD(50,16,1,1),^DD(50,"TRB",16) K ^DD(50,0,"IX","AE",50,202),^DD(50,0,"IX","IV",50.03,.01) K ^DD(50,0,"IX","IV1",50,204),^DD(50,0,"IX","IV2",50,201.1),^DD(50,0,"PT",50.03 ,.02) K ^DD(50,0,"IX","AV1",50,200),^DD(50,0,"IX","AD",50,201),^DD(50,0,"IX","AF",50, 201.3),^DD(50,0,"IX","AV2",50,201),K ^DD(50,23,2),^DD(50,23,2.1),^DD(50,24,2),^DD(50,24,2.1),^DD(50,8,9.2) ROUTINE: ******************** 2082 NAME: DBIA2082 CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 25,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 357.69 ROOT: IBE(357.69, DESCRIPTION: TYPE: File This DBIA is to allow PCE to read AICS' file TYPE OF VISIT file (#357.69) for the following files. ^IBE(357.69, .01 CODE [0;1] Read/Fileman .015 SHORT NAME [computed] Read/Fileman .02 RECOMMENDED HEADER [0;2] Read/Fileman .03 RECOMMENDED TEXT [0;3] Read/Fileman .04 INACTIVE FLAG [0;4] Read/Fileman .05 NEW,ESTABLISHED,CONSULT [0;5] Read/Global ROUTINE: ******************** 2083 NAME: DBIA2083 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER RADIOLOGY/NUCLEAR MEDICINE USAGE: Controlled Subscri ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.41 ROOT: SD(409.41, DESCRIPTION: TYPE: File This DBIA allows PCE to Globally read Scheduling's OUTPATIENT CLASSIFICATION TYPE file (#409.41) for the below fields. This is used in asking the user the patient Service Connected and Classification questions. PCE is now asking these question for Scheduling. ^SD(409.41, .01 NAME 0;1 Direct Global Read & w .02 PROMPT 0;2 Direct Global Read & w .03 INPUT TYPE 0;3 Direct Global Read & w .04 DEFAULT 0;4 Direct Global Read & w .05 REQUIRED 0;5 Direct Global Read & w .06 DISPLAY NAME 0;6 Direct Global Read & w .07 ABBREVIATION 0;7 Direct Global Read & w ROUTINE: ******************** 2084 NAME: DBIA2084 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.42 ROOT: SDD(409.42, DESCRIPTION: TYPE: File PCE request a DBIA with Scheduling to kill entries in the OUTPATIENT CLASSIFICATION file (#409.42). This is done in the process of asking the user for the patient's classification if the classification " is no longer applicable...". This is needed because PCE now ask the classification questions for Scheduling and this was done in the asking of the classification questions. ROUTINE: ******************** 2085 NAME: DBIA2085 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43 DESCRIPTION: TYPE: File This is needed because PCE now ask the classification questions for Scheduling. ^DG(43,1,SCLR) 224 ALLOW UP-ARROW OUT O SCLR;24 Direct Global Read & w ROUTINE: ******************** 2086 NAME: DBIA2086 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File This is so PCE can find the Outpatient Encounter and thus the Visit for a disposition. ^DPT(DFN,0) .083 CHECK FOR DUPLICATE 0;20 Direct Global Read & w ^DPT(DFN,DIS,D1,0) 18 OUTPATIENT ENCOUNTER 0;18 Direct Global Read & w ROUTINE: ******************** 2087 NAME: DBIA2087 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER SPINAL CORD DYSFUNCTION USAGE: Controlled Subscri ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.5 ROOT: GMR(120.5, DESCRIPTION: TYPE: File This is used in the Caseload Profile report. It is looking for blood pressures above 159/90 (either value high). ^GMR(120.5,D0,0) .01 DATE/TIME VITALS TAK 0;1 Direct Global Read & w .03 VITAL TYPE 0;3 Direct Global Read & w 1.2 RATE 0;8 Direct Global Read & w ^GMR(120.5,C, This is the "C" cross reference. Direct Global Read. ROUTINE: ******************** 2088 NAME: DBIA2088 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 26,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File ^SCE(D0,0) .02 PATIENT 0;2 Direct Global Read & w .05 VISIT FILE ENTRY 0;5 Direct Global Read & w .06 PATENT ENCOUNTER 0;6 Direct Global Read & w .1 APPOINTMENT TYPE 0;10 Direct Global Read & w .12 STATUS 0;12 Direct Global Read & w ^SCE(AVSIT, This is the "AVSIT" cross reference. Direct Global Read. ROUTINE: ******************** 2090 NAME: ACCESS TO PATIENT MOVEMENT DATA CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER MRSA INITIATIVE REPORTS ADDED 4/10/09 DIETETICS ADDED 6/8/09 10/12/12-Added Date/Time (#.01) and Discharge/Check-Out Movement (#.17) fields for Dietetics MENTAL HEALTH Added 03/22/21, effective with Mental Health's Suicide Prevention Project, patch YS*5.01*135. USAGE: Controlled Subscri ENTERED: AUG 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File THIS ICR ALLOWS ACCESS TO PATIENT MOVEMENT DATA. ^DGPM(APTT1,DFN, This is the cross reference on admitting date. ^DGPM(APTT3,DFN, This is the cross reference on discharge date. ^DGPM(APTT2,DFN ^DGPM(APID,DFN,INVERSE DATE_AS,DA ^DGPM(D0,0 .03 PATIENT 0;3 Direct Global Read & w .06 WARD LOCATION 0;6 Direct Global Read & w .07 ROOM-BED 0;7 Direct Global Read & w .14 ADMISSION/CHECK-IN M 0;14 Direct Global Read & w .18 MAS MOVEMENT TYPE 0;18 Direct Global Read & w .01 DATE/TIME 0;1 Direct Global Read & w .17 DISCHARGE/CHECK-OUT 0;17 Direct Global Read & w ROUTINE: ******************** 2091 NAME: DBIA2091 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER PHARMACY BENEFITS MANAGEMENT The Pharmacy Benefits Management package extracts provider data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. SCHEDULING USAGE: Controlled Subscri ENTERED: AUG 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8932.1 ROOT: USC(8932.1, DESCRIPTION: TYPE: File ^USC(8932.1, .01 OCCUPATION (HCFA) 0;1 Direct Global Read & w 1 SPECIALTY (HCFA) 0;2 Direct Global Read & w 2 SUBSPECIALTY (HCFA) 0;3 Direct Global Read & w 3 STATUS 0;4 Direct Global Read & w ^USC(8932.1,B, This is the "B" cross reference. ^USC(8932.1,F, This is the "F" cross reference. ROUTINE: ******************** 2092 NAME: 2092 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File This is used by the PCE Reports. ^LAB(60,D0,0) 5 LOCATION (DATA NAME) 0;5 Direct Global Read & w ^LAB(60,C, This is the "C" cross reference. Direct Global Read. ROUTINE: ******************** 2093 NAME: DBIA2092-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER OUTPATIENT PHARMACY USAGE: Private ENTERED: AUG 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File This is used by the PCE Reports. ^LR(D0,CH,D1,0) .05 SPECIMEN TYPE 0;5 Direct Global Read & w ^LR(D0,CH,D1,test) test test value test;1 Direct Global Read & w high/low high/low flag test;2 Direct Global Read & w This field flags if a result is high or low and an "*" is include for critical values. The "*" is being looked for to find critical results. This is for all of the "CH" nodes that the different test results are stored on. ROUTINE: ******************** 2094 NAME: 2094 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: AUG 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File This is used to see if a provider has been inactivated at the time of the patient encounter. ^VA(200,D0,PS) 53.4 INACTIVE DATE PS;4 Direct Global Read & w ROUTINE: ******************** 2095 NAME: DBIA2095 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: SEP 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File Drug Accountability/Inventory Interface (DA) v3.0 interfaces with the DRUG (#50) file to assist Pharmacy in maintaining a perpetual inventory. DA contains two methods of maintaining the drug balances. The site can either interface with the Generic Inventory Package (GIP) or with the prime vendor's electronic invoice data. The DRUG file is used to store matches between drugs and either an item in GIP or the NDC in the prime vendor's invoice data. It is also used to identify matched drugs when they are received and dispensed drugs via other VISTA Pharmacy packages. When the fields are read, it is by a direct global read. When the fields are written to, it is by a FileMan DIE call. Read fields: ============ GLOBAL MAP DATA DICTIONARY #50 -- DRUG FILE -------------------------------------------------------------------------- ^PSDRUG(D0,0)= (#.01) GENERIC NAME [1F] ^ ^ ^ ^ ^ (#6) FSN [6F] ^ ^ ^ ==>(#51) NON-FORMULARY [9S] ^ ^ ^PSDRUG(D0,1,0)=^50.1A^^ (#9) SYNONYM ^PSDRUG(D0,1,D1,0)= (#.01) SYNONYM [1F] ^ (#2) NDC CODE [2F] ^ ==>(#1) INTENDED USE [3S] ^ (#400) VSN [4F] ^ (#401) ==>ORDER UNIT [5P] ^ (#402) PRICE PER ORDER UNIT [6N] ^ ==>(#403) DISPENSE UNITS PER ORDER UNIT [7N] ^ (#404) ==>PRICE PER DISPENSE UNIT [8N] ^ (#405) VENDOR [9F] ^ ^PSDRUG(D0,2)= ^ ^ (#63) APPLICATION PACKAGES' USE [3F] ^ (#31) NDC [4F] ^ ^PSDRUG(D0,441,0)=^50.0441P^^ (#441) IFCAP ITEM NUMBER ^PSDRUG(D0,441,D1,0)= (#.01) ITEM NUMBER [1P] ^ ^PSDRUG(D0,660)= ^ (#12) ORDER UNIT [2P] ^ (#13) PRICE PER ORDER UNIT [3N] ==>^ ^ (#15) DISPENSE UNITS PER ORDER UNIT [5N] ^ (#16) ==>PRICE PER DISPENSE UNIT [6N] ^ ^ (#14.5) DISPENSE UNIT ==>[8F] ^ ^PSDRUG(D0,660.1)= (#50) CURRENT INVENTORY [1N] ^ ^PSDRUG(D0,I)= (#100) INACTIVE DATE [1D] ^ ^PSDRUG(D0,ND)= (#20) NATIONAL DRUG FILE ENTRY [1P] ^ (#21) VA PRODUCT ==>NAME ENTRY [2N] ^ (#22) PSNDF VA PRODUCT NAME ENTRY [3N] ^ ==>(#23) PACKAGE SIZE [4P] ^ (#24) PACKAGE TYPE [5P] ^ Cross-references Read: ===================== ITEM NUMBER(AB), VSN(AVSN), SYNONYM(C), VA PRODUCT NAME(VAPN), NDC(NDC) Fields Written to: ================== GLOBAL MAP DATA DICTIONARY #50 -- DRUG FILE -------------------------------------------------------------------------- ^PSDRUG(D0,0)= (#.01) GENERIC NAME [1F] ^ ^PSDRUG(D0,1,0)=^50.1A^^ (#9) SYNONYM ^PSDRUG(D0,1,D1,0)= (#.01) SYNONYM [1F] ^ (#2) NDC CODE [2F] ^ ==>(#1) INTENDED USE [3S] ^ (#400) VSN [4F] ^ (#401) ==>ORDER UNIT [5P] ^ (#402) PRICE PER ORDER UNIT [6N] ^ ==>(#403) DISPENSE UNITS PER ORDER UNIT [7N] ^ (#404) ==>PRICE PER DISPENSE UNIT [8N] ^ (#405) VENDOR [9F] ^ ^PSDRUG(D0,2)= ^ ^ ^ (#31) NDC [4F] ^ ^PSDRUG(D0,441,0)=^50.0441P^^ (#441) IFCAP ITEM NUMBER ^PSDRUG(D0,441,D1,0)= (#.01) ITEM NUMBER [1P] ^ ^PSDRUG(D0,660)=^ (#12) ORDER UNIT [2P] ^ (#13) PRICE PER ORDER UNIT [3N] ==>^ ^ (#15) DISPENSE UNITS PER ORDER UNIT [5N] ^ (#16) ==>PRICE PER DISPENSE UNIT [6N] ^^ (#14.5) DISPENSE UNIT [8F] ^PSDRUG(D0,660.1)= (#50) CURRENT INVENTORY [1N] ^ Three print templates are used to print two reports. PSADRIP and PSADRIH are used to print the DRUG file/ITEM MASTER file Comparison Report from a selected sort range The report contains information on packaging and pricing. PSADRIH is the header on this report. PSADRI is used to print the Inquire/Compare DRUG file/ITEM MASTER file report that compares the packaging and pricing between the DRUG file and the ITEM MASTER file. ^PSDRUG(D0,0) .01 GENERIC NAME 0;1 Read w/Fileman This is the generic name of the drug. 51 NON-FORMULARY 0;9 Direct Global Read & w This is used to designate the drug as non-formulary. This file holds the information related to each drug that can be used to fill a prescription. It is pointed to from several other files and should be handled carefully, usually only by special individuals in the pharmacy service. Entries are not typically deleted, but rather made inactive by entering an inactive date. This file must be built by Pharmacy Service BEFORE going on-line. It is common to use another centers file and edit it to match your center's unique formulary. ^PSDRUG(D0,1,D1,0) .01 SYNONYM 0;1 Write w/Fileman This field is used as a quick code for look ups or to locate NDCs so the drug's inventory can be incremented when orders are received. 1 INTENDED USE 0;3 Write w/Fileman If you designate a synonym as a quick code, then it will not appear on the formulary listing for distribution in the hospital. If it is designated as a trade name, then it will appear on the listing. This field does not affect the ability to look-up a drug by quick code or trade name. If the intended use is for Controlled Substances or Drug Accountability, the synonym is used to locate NDCs so the drug's inventory can be incremented when orders are received. 2 NDC CODE 0;2 Write w/Fileman This field will contain the national drug code. 400 VSN 0;4 Write w/Fileman This is the vendor's stock number for the NDC. 401 ORDER UNIT 0;5 Write w/Fileman This is the NDC's unit of order. 402 PRICE PER ORDER UNIT 0;6 Write w/Fileman This is the price for one unit of order. 403 DISPENSE UNITS PER O 0;7 Write w/Fileman This is the number of dispense units in one order unit. 404 PRICE PER DISPENSE U 0;8 Write w/Fileman This is the cost of one dispense unit. 405 VENDOR 0;9 Write w/Fileman This is the name of the vendor from which the drug was purchased. This multiple contains the Synonym, NDC Code, Intended Use, VSN, Order Unit, Price per Order Unit, Dispense Units per Order Unit, Price per Dispense Unit, and Vendor fields. It is used for a quick code for look ups or to locate NDCs to increment the drug's inventory when orders are received. ^PSDRUG(D0,2) 63 APPLICATION PACKAGES 2;3 Direct Global Read & w This field is free text, but contains the codes of the DHCP packages that consider this drug part of its formulary. This field is set through the routine ^PSGIU, and NOT through VA FileMan. 31 NDC 2;4 Write w/Fileman This is the National Drug Code for this drug. This global node contains the drug restriction, which VISTA applications are using the drug, the primary NDC, and a pointer to the PRIMARY DRUG file (#50.3). ^PSDRUG(D0,441,0) .01 ITEM NUMBER 0;1 Write w/Fileman This field contains any or all items in the ITEM MASTER file that relate to this drug. This relationship will enable automated receiving from the IFCAP Inventory module. With the "AB" cross reference this multiple will be used when PRCP routines pass receiving data to PSA routines. ^PSDRUG(D0,660) 12 ORDER UNIT 660;2 Write w/Fileman This is the order unit for this drug. 13 PRICE PER ORDER UNIT 660;3 Write w/Fileman This is the price per order unit for this drug. 15 DISPENSE UNITS PER O 660;5 Write w/Fileman This is the dispense units per order unit for this drug. 16 PRICE PER DISPENSE U 660;6 Write w/Fileman This is the dispense units per order unit for this drug. NOTE: This field is set with a TRIGGER when the PRICE PER ORDER UNIT is set. 14.5 DISPENSE UNIT 660;8 Write w/Fileman This is the dispense unit for this drug. This global node contains packaging, dispense unit, pricing, reordering levels, and source data. ^PSDRUG(D0,660.1) 50 CURRENT INVENTORY 660.1;1 Write w/Fileman This field contains the current number of the drug in stock. This node contains the total number of dispense units that are in inventory for all sites using this DRUG file. ^PSDRUG(D0,'I') 100 INACTIVE DATE I;1 Direct Global Read & w This is the date the drug is inactive. This global node contains the date the drug will be or was made inactive. ^PSDRUG(D0,'ND') 20 NATIONAL DRUG FILE E 'ND';1 Direct Global Read & w This is the pointer to the National Drug file (^PSNDF). 22 PSNDF VA PRODUCT NAM 'ND';3 Direct Global Read & w This is the index of the VA Product Name in the National Drug file. 23 PACKAGE SIZE 'ND';4 Direct Global Read & w This is the pointer to the Package Size file. 24 PACKAGE TYPE 'ND';5 Direct Global Read & w This is the pointer to the Package Type file. This global node contains NATIONAL DRUG FILE (50.6) links and packaging data. ROUTINE: ******************** 2096 NAME: 2096 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING PCE PATIENT CARE ENCOUNTER USAGE: Controlled Subscri ENTERED: DEC 1,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.63 ROOT: SD(409.63, DESCRIPTION: TYPE: File ^SD(409.63,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2097 NAME: DBIA2097 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX the MPI is viewing AUDIT data from the MPI VETERAN/CLIENT (#985) file, including the B cross-reference. GLOBAL REFERENCE: ^DIA(985,'B',ICN,IEN) "B" x-ref for MPI VETERAN/CLIENT (#985) file USAGE: Private ENTERED: AUG 29,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1.1 ROOT: DIA( DESCRIPTION: TYPE: File CIRN needs to display the last date edited for a patient. CIRN recommends that sites turn on auditing for demographic fields. To get the last date edited, if auditing is turned on, CIRN checks the $P(^DIA(2,0),U,3)+1 for the last entry and then $O(^DIA(2,"B",DFN,LAST ENTRY),-1) to find the most recent edit, $P(^DIA(2,IEN,0),U,2). CIRN requests direct read access to these nodes. ^DIA(D0,0) .001 NUMBER 0;3 Direct Global Read & w Last entry ^DIA(2,'B',DFN,IEN) "B" x-ref for PATIENT file ^DIA(D0,IEN,0) .02 DATE/TIME RECORDED 0;2 Direct Global Read & w ROUTINE: ******************** 2098 NAME: DIQUIET TO SUPPRESS WRITES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: RPC BROKER LAB SERVICE MAILMAN REGISTRATION IMAGING INTEGRATED BILLING CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: SEP 2,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other 1. DESCRIPTION OF USE OF DIQUIET IN FILEMAN HISTORY OF DIQUIET: The purpose for creating DIQUIET was mostly that as we were creating the data-base server calls, we sometimes needed to call into Classic FileMan, and we absolutely didn't want FileMan to talk. DIQUIET was a variable that would let us know within those classic calls that we were being called from a DBS call, so we shouldn't talk. Therefore, at the start of almost all the DBS calls, we set DIQUIET=1. DIQUIET was also used as a flag in EN^DDIIOL, which is embedded in Xecutable code in the DD, to assure that text is placed in ^TMP instead of being Written when DBS calls are involved. SETTING DIQUIET WITHIN FILEMAN CODE: DIQUIET is set to 1 at the start of the following published calls: Finder FIND^DIC Finder (Single Record) $$FIND1^DIC Lister LIST^DIC DD Field Retriever FIELD^DID DD Field List Retriever FIELDLST^DID DD File Retriever FILE^DID DD File List Retriever FILELIST^DID Attribute Retriever $$GET1^DID Data Checker CHK^DIE Filer FILE^DIE Helper HELP^DIE Updater UPDATE^DIE Validator VAL^DIE Word-Processing Filer WP^DIE Single Data Retriever $$GET1^DIQ Data Retriever GETS^DIQ In addition, there are a few places that Classic FileMan sets DIQUIET for the same reason. Import Tool (DDMP, DDMPU) because the Import tool is designed to be silent like the DBS calls. DIED and DIEZ1 (classic DIE call to edit data) sets DIQUIET if the user is stuffing data in a SET OF CODES field, because it makes a call to ^DIR and does not want the Reader to talk. DIEZ, DIKZ and DIPZ (template and x-ref compilation) appear to have silent entry points (all labeled EN2) that set DIQUIET. I believe that these were created by Rick, I don't think they're documented. Perhaps KIDS uses them, I need to discuss this with him. DIP (the PRINT routine) sets DIQUIET if it is not already set, and if all the information that DIP normally prompts the user for has been sent (I.E., file and fields to print, sort criteria, device, etc.), or if the print job is queued. That was to avoid some places where FileMan was writing error messages. HONORING DIQUIET TO SUPPRESS WRITES: Mostly we made changes to classic FileMan as we needed to, in places where we were calling it from the new DBS calls and wanted it to be silent. The places are: DDIOL (The loader), where DIQUIET tells the routine to load the text that is passed into an array rather than writing it. That's why we were able to tell people that any writes that they have in their DDs should call ^DDIOL rather than just write. %DT (date validation routine) to keep the date from echoing back. DT^DICRW (routine that sets up required FileMan variables). Was writing a line-feed. DIE3 (enter/edit) Does not write "Searching for a..." when doing a lookup on a file pointed-to by a variable pointer, and does not ask OK when a pointed-to entry is found, even if the DD has been set up that way. DIP The changes to the print are described above, and were not done for the DBS calls, as we don't call the print from within any of them. DIR1 The Reader doesn't write a message when processing sets of codes if DIQUIET is set. This was required by DIE when stuffing a SET OF CODES field, as I described above. 2. REASON RPC BROKER NEEDS TO SET DIQUIET: Setting of DIQUIET variable, which is used within the VA FileMan package to suppress WRITEs from FileMan routines and DDs, to 1. Variable being set by RPC Broker when it is certain that no direct user-interaction is appropriate (client/server environment). The only FileMan code that the Broker does directly that requires DIQUIET to be set is DT^DICRW (a linefeed is suppressed). However, since the Broker performs the code written in RPCs, having DIQUIET set protects the code in the RPCs from inadvertently Writing because of a call to a FileMan routine or the Xecution of a DD node. ROUTINE: ******************** 2099 NAME: PSORPH CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the PSORPH security key. ROUTINE: ******************** 2100 NAME: DBIA2100 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the following security keys: PSJU MGR PSJI MGR PSGWMGR PSJ RPHARM PSJ RNURSE PSJ PHARM TECH ROUTINE: ******************** 2104 NAME: DBIA2104 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the PSAMGR and PSA ORDERS security keys. ROUTINE: ******************** 2105 NAME: DBIA2105 CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the PSDMGR security key. ROUTINE: ******************** 2106 NAME: DBIA2106 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the PSNMGR security key. ROUTINE: ******************** 2107 NAME: PSXCMOPMGR CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to check for the PSXCMOPMGR security key. ROUTINE: ******************** 2108 NAME: DBIA2108 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to use the PSJ OAOPT input template to Pharmacy System file 59.7. ROUTINE: ******************** 2109 NAME: DBIA2109 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.45 ROOT: PS(53.45 DESCRIPTION: TYPE: File PDM requests to look at INPATIENT USER PARAMETERS file 53.45. PDM requests permission to use the [PSJ IUP SUPER EDIT] and [PSJ IUP USER EDIT] input templates for INPATIENT USER PARAMETERS file 53.45. ROUTINE: ******************** 2110 NAME: DBIA2110 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.6 ROOT: PS(59.6 DESCRIPTION: TYPE: File PDM requests permission to look at INPATIENT WARD PARAMETERS file 59.6. PDM requests permission to use the [PSJIWPIEDIT] input template for INPATIENT WARD PARAMETERS file 59.6. ROUTINE: ******************** 2111 NAME: DBIA2111 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 57.7 ROOT: PS(57.7 DESCRIPTION: TYPE: File PDM requests permission to look at MEDICATION ADMINISTERING TEAM file 57.7. PDM requests permission to use the [PSJUMATE] input template to MEDICATION ADMINISTERING TEAM file 57.7. ROUTINE: ******************** 2112 NAME: DBIA2112 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 57.5 ROOT: PS(57.5 DESCRIPTION: TYPE: File PDM requests permission to look at WARD GROUP file 57.5. PDM requests permission to use the [PSJU WG] input template for WARD GROUP file 57.5. ROUTINE: ******************** 2114 NAME: DBIA2114 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.15 ROOT: PS(51.15 DESCRIPTION: TYPE: File PDM requests permission to look at ADMINISTRATION SHIFT file 51.15. PDM requests permission to use the [PSJ SHIFT EDIT] input template for ADMINISTRATION SHIFT file 51.15. ROUTINE: ******************** 2115 NAME: DBIA2115 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.2 ROOT: PS(53.2 DESCRIPTION: TYPE: File PDM requests permission to look at ORDER SET file 53.2. PDM requests permission to use the [PSJUOSE] input template for UNIT DOSE ORDER SET file 53.2. ROUTINE: ******************** 2116 NAME: DBIA2116 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other PDM requests permission to use [PSJ SCHEDULE EDIT] and [PSJ EXT SCHEDULE EDIT] input templates to ADMINISTRATION SCHEDULE file 51.1. ROUTINE: ******************** 2118 NAME: DBIA2118 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine is part of the Kernel Device handler. It is used for making TCP/IP connection between computers. It only deals with IP address. ROUTINE: %ZISTCP COMPONENT: CALL(IPaddress,Socket [,Timeout]) VARIABLES: IPaddress Type: Input This first parameter is the IP address of the host system to connect to. It must be in the IP format of 4 numbers separated by dots. i.e. 152.128.1.25 Socket Type: Input This second parameter is the socket to connect to on the remote host. It is a integer from 1-65535. Values below 5000 are for standard internet services like SMTP mail. Timeout Type: Input This optional third parameter is the timeout to apply to the open. IO Type: Output If the connection is made then IO will hold the implemention value that is used to reference the connection. POP Type: Output This variable reports the connection status. A value of 0 means the connection was successful. A positive value means the connection failed. It works the same as a call to %ZIS. This entry point is used to make a TCP/IP connection to a remote system. COMPONENT: CLOSE VARIABLES: IO Type: Both This hold the connection to close. It gets reset to the home device for the process. This call is used to close the connection opened with the CALL entry point. It works like a call to %ZISC. ******************** 2119 NAME: DBIA2119 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Access to some device handler tools. ROUTINE: %ZISUTL COMPONENT: OPEN(handle [,valiop] [,.valzis]) VARIABLES: handle Type: Input A unique free text name to associate with a device you want to open. valiop Type: Input Output device specification, in the same format as the IOP input variable for the %ZIS entry point. The one execption to this is passing a value of null: this is like leaving IOP undefined. With %ZIS, on the other hand, setting IOP to null specifies the home device. To request the home device, pass a value of "HOME" instead. valzis Type: Input (optional) Input specification array, in the same format (and with the same meanings) as the %ZIS input specification array for the ^%ZIS entry point. Must be passed by reference. Please see the documentation of the ^%ZIS function for more information. One of three functions that support using multiple devices at the same time. OPEN^%ZISUTL returns all the same output variables as the ^%ZIS entry point. OPEN^%ZISUTL serves as a "wrapper" arount the ^%ZIS entry point, providing additional management of IO variables that ^%ZIS does not (principally to support opening multiple devices simultaneously). COMPONENT: CLOSE(handle) VARIABLES: handle Type: Input The handle of a device opened with an OPEN^%ZISUTL call. Use the CLOSE^%ZISUTL to close a device opened with the OPEN^%ZISUTL function. When you close a device with CLOSE^%ZISUTL, the IO variables are set back to the home device's and the home device is made the current device. COMPONENT: SAVDEV(handle) VARIABLES: handle Type: Input A unique free text name to associate with a device you want to use. IO* Type: Both The standard set of IO variables. Use SAVDEV^%ZISUTL to save the current device IO* variables under the handle name. COMPONENT: RMDEV(handle) VARIABLES: handle Type: Input A unique free text name to associate with a device you want to delete. This call deletes the data associated with the handle. It doesn't change any of the IO* variables. COMPONENT: USE(handle) VARIABLES: IO* Type: Output Standard IO variables. Use the USE^%ZISUTL to restore the variables save with OPEN^%ZISUTL or SAVDEV^%ZISUTL. It then does a USE of the device if it is open. The same a a DO USE^%ZISUTL(handle) U IO. ******************** 2120 NAME: DBIA2120 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IA between Kernel and RPB Broker. ROUTINE: XUSRB COMPONENT: $$KCHK(key) VARIABLES: key Type: Input A security key name to be checked. This entry point is used to check if a user holds a given KEY. COMPONENT: LOGOUT VARIABLES: This entry point is used by BROKER to update Kernel sign-on logs when a user ends a Broker session. ******************** 2121 NAME: DBIA2121 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a custom call developed for the RPC Broker. ROUTINE: XUSRB1 COMPONENT: $$DECRYP(string) VARIABLES: string Type: Input A text string. This call is used to unscramble strings that are sent between the Broker client and Kernel. ******************** 2122 NAME: DBIA2122 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PDM requests permission to call PSOHELP1. This routine is called by a compiled cross-reference routine (PSSJXR) ON PHARMACY PATIENT file 55. PSOHELP1 sets two cross-references in file #55 ("A" and "P") involked from VA FileMan. ROUTINE: PSOHELP1 COMPONENT: SREF VARIABLES: X Type: Input DATE DA Type: Both ENTRY NUMBER IN SUB-FILE 55.03 DA(1) Type: Both ENTRY NUMBER COMPONENT: KREF VARIABLES: X Type: Input date DA(1) Type: Both entry number DA Type: Both ENTRY NUMBER IN SUB-FILE 55.05 ******************** 2124 NAME: DBIA2124 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER USAGE: Private ENTERED: SEP 5,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Special call to menu system to check access to options and RPC's. ROUTINE: XQCS COMPONENT: $$CHK(user, option, rpc) VARIABLES: user Type: Input DUZ option Type: Input A option name. rpc Type: Input A RPC name. This call checks that a given user has access to a option or RPC. COMPONENT: $$OPTLK(option) VARIABLES: option Type: Input This is the Option name to be looked up. This API does a lookup on the OPTION file to find a option IEN that is passed back to the calling routine. ******************** 2125 NAME: DBIA2125 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.45 ROOT: PS(53.45 DESCRIPTION: TYPE: File PDM requests permission to look at INPATIENT USE PARAMETERS file 53.45. ^PS(53.45, .01 INPATIENT USER 0;1 Both R/W w/Fileman .02 MAY SELECT DISPENSE 0;2 Both R/W w/Fileman .03 ALLOW USER TO RENEW 0;3 Both R/W w/Fileman .04 ALLOW USER TO HOLD O 0;4 Both R/W w/Fileman .05 ALLOW USER TO D/C OR 0;5 Both R/W w/Fileman .06 PRINT PROFILE IN ORD 0;6 Both R/W w/Fileman .07 LABEL PRINTER 0;7 Both R/W w/Fileman .08 TYPE OF USER 0;8 Both R/W w/Fileman .09 ALLOW AUTO-VERIFY FO 0;9 Both R/W w/Fileman .1 USE WARD LABEL SETTI 0;10 Both R/W w/Fileman .11 INPATIENT PROFILE OR 0;11 Both R/W w/Fileman .12 ORDER ENTRY PROCESS 0;12 Both R/W w/Fileman ROUTINE: ******************** 2126 NAME: ACCESS FILE 59.6 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.6 ROOT: PS(59.6 DESCRIPTION: TYPE: File PDM requests permission to look at INPATIENT WARD PARAMETERS file 59.6. ^PS(59.6,D0,0) 1 MAR ORDER SELECTION 0;2 Both R/W w/Fileman 2 PRINT PENDING ORDERS 0;6 Both R/W w/Fileman .03 DAYS UNTIL STOP DATE 0;3 Both R/W w/Fileman .04 SAME STOP DATE ON AL 0;4 Both R/W w/Fileman .05 DEFAULT START DATE C 0;5 Both R/W w/Fileman .07 TIME OF DAY ORDERS S 0;7 Both R/W w/Fileman .08 START TIME FOR 24 HO 0;8 Both R/W w/Fileman .09 STOP TIME FOR MAR 0;9 Both R/W w/Fileman .11 DAYS NEW LABELS LAST 0;11 Both R/W w/Fileman .12 LABEL FOR WARD STAFF 0;12 Both R/W w/Fileman .13 WARD LABEL PRINTER 0;13 Both R/W w/Fileman .14 PHARMACY LABEL PRINT 0;14 Both R/W w/Fileman .15 LABEL ON AUTO-DISCON 0;15 Both R/W w/Fileman .16 LABEL FOR PHARMACY 0;16 Both R/W w/Fileman ROUTINE: ******************** 2127 NAME: DBIA2127 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: SEP 1,2020 DURATION: Till Otherwise Agr VERSION: FILE: 50.3 ROOT: PS(50.3 DESCRIPTION: TYPE: File This file was originally associated with Inpatient Medications as the custodial package. Due to the conversion of Rational to GitHub, this file is now assigned to the Pharmacy Data Management Package, making this ICR no longer necessary because PDM was the only subscribing package. Additionally the 50.3 file is no longer used, but has not gone through a formal retirement in the ICRs. Old text before 9/1/20: PDM requests permission to look at PRIMARY DRUG file 50.3. ^PS(50.3,D0,0) .01 NAME 0;1 Direct Global R/W & w/ .02 DEA, SPECIAL HANDLIN 0;2 Both R/W w/Fileman .03 MESSAGE 0;3 Both R/W w/Fileman ^PS(50.3,D0,1,D1,0) .01 APPLICATION 0;1 Both R/W w/Fileman .02 NON-FORMULARY 0;2 Both R/W w/Fileman .03 INACTIVE DATE 0;3 Both R/W w/Fileman .05 DAY (nD) or DOSE (nL 0;5 Both R/W w/Fileman .06 MED ROUTE 0;6 Both R/W w/Fileman .07 SCHEDULE TYPE 0;7 Both R/W w/Fileman .08 SCHEDULE 0;8 Both R/W w/Fileman ^PS(50.3,D0,1,D1,1,D2,0) .01 FORMULARY ALTERNATIV 0;1 Both R/W w/Fileman ^PS(50.3,D0,2,0) 2 SYNONYM 0;1 Both R/W w/Fileman ROUTINE: ******************** 2131 NAME: DBIA2131 CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.4 ROOT: PS(59.4 DESCRIPTION: TYPE: File PDM requests permission to look at INPATIENT SITE file 59.4. ^PS(59.4, .01 NAME 0;1 Both R/W w/Fileman 4 MERGE INV. SHEET AND 0;5 Both R/W w/Fileman 5 PRINT RETURN COLUMNS 0;6 Both R/W w/Fileman 4.5 AR/WS AMIS FLAG 0;25 Both R/W w/Fileman 5.5 IS SITE SELECTABLE F 0;26 Both R/W w/Fileman 5.6 PROMPT FOR BAR CODES 0;27 Both R/W w/Fileman 31 IS SITE SELECTABLE F 0;31 Both R/W w/Fileman ROUTINE: ******************** 2132 NAME: DBIA2132 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.15 ROOT: PS(51.15 DESCRIPTION: TYPE: File PDM requests permission to look at ADMINISTRATION SHIFT file 51.15. ^PS(51.15, .01 NAME 0;1 Direct Global R/W & w/ 1 ABBREVIATION 0;2 Direct Global R/W & w/ 2 STANDARD START/STOP 0;3 Direct Global R/W & w/ 4 PACKAGE 0;4 Direct Global R/W & w/ ^PS(51.15,D0,1, .01 HOSPITAL LOCATION 0;1 Direct Global R/W & w/ 1 START/STOP TIMES 0;2 Direct Global R/W & w/ ROUTINE: ******************** 2133 NAME: DBIA2133 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 56 ROOT: PS(56 DESCRIPTION: TYPE: File PDM requests permission to look at DRUG INTERACTION file 56. ^PS(56,D0,0) .01 NAME 0;1 Direct Global R/W & w/ 1 INGREDIENT 1 0;2 Direct Global R/W & w/ 2 INGREDIENT 2 0;3 Direct Global R/W & w/ 3 SEVERITY 0;4 Direct Global R/W & w/ 6 LOCALLY EDITED L;1 Direct Global R/W & w/ ROUTINE: ******************** 2135 NAME: DBIA2135 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 8,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Prosthetics package requests permission to use IFCAP program PRCFSITE to set special IFCAP variables used in the package. ROUTINE: PRCFSITE COMPONENT: DIVFY VARIABLES: PRC('FY') Type: Output Return the current fiscal year. PRC('PARAM Type: Output Returns the zero node of the parameter file. PRC('PER') Type: Output Returns information about the user. PRC('QTR') Type: Output Returns the current fiscal quarter. PRC('SITE' Type: Output Returns the site/station number. PRCF('X') Type: Input Set to "S" which defines which local values to return. ******************** 2136 NAME: DBIA2136 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.608 ROOT: PS(50.608 DESCRIPTION: TYPE: File PDM requests permission to look at PACKAGE TYPE file 50.608. ^PS(50.608,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2137 NAME: DBIA2137 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.609 ROOT: PS(50.609 DESCRIPTION: TYPE: File PDM requests permission to look at PACKAGE SIZE file 50.609. ^PS(50.609,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2138 NAME: DBIA2138 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT INPATIENT MEDICATIONS USAGE: Private ENTERED: SEP 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.605 ROOT: PS(50.605 DESCRIPTION: TYPE: File PDM requests permission to look at VA DRUG CLASS file 50.605. ^PS(50.605,D0,0) .01 CODE 0;1 Direct Global Read & w 1 CLASSIFICATION 0;2 Direct Global Read & w ROUTINE: ******************** 2139 NAME: DBIA2139 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: NOV 25,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 57.1 ROOT: PS(57.1 DESCRIPTION: TYPE: File PDM requests permission to look at PHARMACY QUICK ORDER file 57.1. ^PS(57.1,D0,0) .01 NAME 0;1 Direct Global Read & w 1 PROTOCOL 0;2 Direct Global Read & w 2 TYPE 0;3 Direct Global Read & w ^PS(57.1,D0,3,D1,0) .01 ADDITIVE 0;1 Direct Global Read & w 1 STRENGTH 0;2 Direct Global Read & w ^PS(57.1,D0,4,D1,0) .01 SOLUTION 0;1 Direct Global Read & w 1 VOLUME 0;2 Direct Global Read & w ^PS(57.1,D0,2,D1,0) 6 PROVIDER COMMENTS 2;1 Direct Global Read & w ^PS(57.1,D0,1) 3 *PRIMARY DRUG 1;1 Direct Global Read & w 4 MED ROUTE 1;2 Direct Global Read & w 5 SCHEDULE 1;3 Direct Global Read & w 9 DOSAGE ORDERED 1;4 Direct Global Read & w 10 INFUSION RATE 1;5 Direct Global Read & w 11 PROVIDER COMMENTS PR 1;6 Direct Global Read & w ROUTINE: ******************** 2140 NAME: DBIA2140 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.1 ROOT: PS(53.1, DESCRIPTION: TYPE: File The Pharmacy Data Management package requests permission to read fields from the NON-VERIFIED ORDERS file (#53.1). ^PS(53.1, 7 SCHEDULE TYPE 0;7 Direct Global Read & w This describes the type of schedule for the dispensing of the medication(s) that make up the order. PRE-OP orders are usually considered to be ON-CALL orders, and orders dispensed as MUTLI-DOSE CONTAINERS are usually considered to be FILL ON REQUEST orders. 9 RENEWAL 4;9 Direct Global Read & w 28 STATUS 0;9 Direct Global Read & w 49 ORDERS FILE ENTRY 0;21 Direct Global Read & w This is the pointer value to the ORDER (#100) File. 62 IV ROOM 8;8 Direct Global Read & w 113 CLINIC DSS;1 Direct Global Read & w ROUTINE: ******************** 2144 NAME: DBIA2144 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PDM requests permission to use the PSGAL5 Inpatient Medications routine. PHARMACY PATIENT File (#55) belongs to PDM, however, there are subfiles within this file which are compiled cross-references. The PSSJXR routine serves as the driver for these cross-references in file #55. This driver routine calls PSGAL5 routine. ROUTINE: PSGAL5 COMPONENT: PSGAL5 VARIABLES: PSGAL Type: Input OLD VALUE PSGALFF Type: Input FIELD NUMBER IN SUB-FILE 55.09 PSGALFN Type: Input SUB-FILE NUMBER ******************** 2145 NAME: DBIA2145 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PDM requests permission to use the PSGAMSA Inpatient Medications routine. A ZOSF test will be done before invoking the routine. PHARMACY PATIENT File (#55) belongs to PDM, however, there are subfiles within this file which are compliled cross-references. The PSSJXR routine serves as the driver for these cross-references in file #55. This driver routine calls PSGAMSA routine. ROUTINE: PSGAMSA COMPONENT: EN VARIABLES: DFN Type: Input ENTRY NUMBER PSGORD Type: Input PRE-EXCHANGE UNITS PSGORD1 Type: Input EXTRA UNITS DISPENSED PSGLOG Type: Input RETURNS ******************** 2146 NAME: DBIA2146 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A ZOSF test will be done before invoking the routine. ROUTINE: PSGCT COMPONENT: $$EN(ST,AM) VARIABLES: ST Type: Input Start Date/Time in FileMan format. AM Type: Input # minutes to add or subtract. $$EN Type: Output new date. ******************** 2150 NAME: DBIA2150 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A ZOSF test will be done before invoking the routine. ROUTINE: PSGNE3 COMPONENT: $$ENSD(schedule,admin time,login time,'') VARIABLES: schedule Type: Input admin time Type: Input Administration Times. login time Type: Input Login Date/Time. $$ENSD Type: Output Default Start Date/Time for an Inpatient Medication Order. ******************** 2153 NAME: DBIA2153 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JUL 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Pharmacy Data Management V. 1.0 application requests an integration agreement with the Inpatient Medications V. 5.O application to make an external call to ENIVKV^PSGSETU. The external call is executed from the PSSVIDRG routine within the Pharmacy Data Management application. The PSSVIDRG routine will perform an ^%ZOSF test before invoking the routine This external call is used to clean up or kill existing IV variables. ROUTINE: PSGSETU ******************** 2154 NAME: DBIA2154 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine PDM requests permission to use the PSIVWL Inpatient Medications routine. A ZOSF test will be done before invoking the routine. ROUTINE: PSIVWL COMPONENT: ENT VARIABLES: PSIVMIN Type: Input PSIVMIN=# of minutes to add or subtract. PSIVSD Type: Input PSIVSD=date to add or subtract from in FileMan format. Y Type: Output Y=result. ******************** 2155 NAME: DBIA2155 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JUL 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management V. 1.0 application requests an integration agreement with the Inpatient Medications V. 5.O application to make an external call to ENQ^PSIV. The external call is executed from the PSSVIDRG routine within the Pharmacy Data Management application. This external call is used to read a user response. ROUTINE: PSIV COMPONENT: ENQ VARIABLES: X Type: Both **Input** X = data string with conditions. X ="... an IV ADDITIVE or IV SOLUTION (A/S): ^ADDITIVE^^ADDITIVE,SOLUTION" **Output** X= Results or User Response Example: ... an IV ADDITIVE or IV SOLUTION (A/S): ADDITIVE// ^ ******************** 2156 NAME: DBIA2156 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JUL 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management V. 1.0 application requests an integration agreement with the Inpatient Medications V. 5.O application to make an external call to the PSIVHLP1 routine. The external call is executed from the PSSVIDRG routine within the Pharmacy Data Management application. This external call is used to provide help information related to IV Additives and Solutions. ROUTINE: PSIVHLP1 ******************** 2157 NAME: DBIA2157 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JUL 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Pharmacy Data Management V. 1.0 application requests an integration agreement with the Inpatient Medications V. 5.O application to make an external call to the PSIVXU routine. The external call is executed from the PSSVIDRG routine within the Pharmacy Data Management application. The PSSVIDRG routine will perform an ^%ZOSF test before invoking the routine. This external call is used to group drug information for reports. ROUTINE: PSIVXU ******************** 2159 NAME: DBIA2159 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: SEP 29,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: File PDM requests permission to look at the ^DD global for following files: Global route File # File -------------------------------------------------------------------- ^DD(50 50 DRUG File 50 DRUG MUMPS x-ref (AUDAP) Field .01 GENERIC NAME - ^DD(50,51,0). ^DD("50",".01","1","3","0")="50^AUDAP^MUMPS" ^DD("50",".01","1","3","1")="I '$D(PSGINITF) S ^PSDRUG("AUDAP")=$S($D(^PS(59.7,1 ,20)):$P(^(20),"^"),1:"")" ^DD("50",".01","1","3","1.1")="S X=Y(0) S Y(1)=$S($D(^PSDRUG(D0,0)):^(0),1:"") S X=$P(Y(1),U,1) S XMB(1)=X" ^DD("50",".01","1","3","1.2")="S X=Y(0) S Y(2)=$C(59)_$S($D(^DD(50,51,0)):$P(^(0 ),U,3),1:""),Y(1)=$S($D(^PSDRUG(D0,0)):^(0),1:"") S X=$P($P(Y(2),$C(59)_$P(Y(1), U,9)_":",2),$C(59),1) S XMB(2)=X" ^DD("50",".01","1","3","1.3")="S X=Y(0) S Y(1)=$S($DPSDRUG(D0,0)):^(0),1:"") S X=$S('$D(^PS(50.5,+$P(Y(1),U,2),0)):"",1:$P(^(0),U,1)) S XMB(3)=X" ^DD("50",".01","1","3","1.4")="S X=Y(0) S Y(1)=$S($D(^PSDRUG(D0,0)):^(0),1:"") S X1),U,10) S XMB(4)=X" ^DD("50",".01","1","3","2")="Q" ^DD("50",".01","1","3","2.2")="S X=Y(0) S Y(2)=$C(59)_$S($D(^DD(50,51,0)):$P(^(0 ),U,3),1:""),Y(1)=$S($D(^PSDRUG(D0,0)):^(0),P(Y(2),$C(59)_$P(Y(1), U,9)_":",2),$C(59),1) S XMB(2)=X" ^DD("50",".01","1","3","2.3")="S X=Y(0) S Y(1)=$S($D(^PSDRUG(D0,0)):^(0),1:"") S X=$S('$D(^PS(50.5,+$P(Y(1),U,2),0)):"",(0),U,1)) S XMB(3)=X" ^DD("50",".01","1","3","2.4")="S X=Y(0) S Y(1)=$S($D(^PSDRUG(D0,0)):^(0),1:"") S X=$P(Y(1),U,10) S XMB(4)=X" ^DD("50",".01","1","3","3")="Used by the Unit npatient Medications package s." **************** ^DD(51.1 51.1 ADMINISTRATION SCHEDULE File 52.6 IV ADDITIVES INPUT TRANSFORM Field 5 ADMINISTRATION TIMES - ^DD(51.1,1,0) ^DD("52.6","5","0")="ADMINISTRATION TIMES^FX^^0;6^X $P(^DD(51.1,1,0),"^",5,999) Q" ^DD("52.6","5","3")="Answer must be 2-119 characters in length." ^DD("52.6","5","20","0")="^.3LA^1^1" ^DD("52.6","5","20","1","0")="PSJI" ^DD("52.6","5","21","0")="^^3^3^2910412^^^^" ^DD("52.6","5","21","1","0")=" Enter the admin. times that this drug is given m ost frequently. This" ^DD("52.6","5","21","2","0")="field will be shown as default for the 'ADMIN. TIM ES: ' prompt during" ^DD("52.6","5","21","3","0")="ordry of IVPB's." ^DD("52.6","5","DT")="2910412" **************** ^DD(52.6 52.6 IV ADDITIVES File 52.6 IV ADDITIVES INPUT TRANSFORM Field 13 CONCENTRATION - ^DD(52.6,2,0) ^DD("52.6","13","0")="CONCENTRATION^FX^^0;10^K:X'=+X!(X>99999)!(X<0)!(X?.E1". "3N .N) X I $D(X) S PSIVX=X,Y=^DD(52.6,2,0),X=$P(^PS(52.6,D0,0),"^",3) D ENC^PSIV D EN^DDIOL(" "_X_"/ML","","?0") S X=PSIVX_" "_X_"/ML" K PSIVX" ^DD("52.6","13","3")="Type a number between 0 and 99999 (no more than 2 decimal digits, and no trailing 0's are allowed)." **************** ^DD(50.4 50.4 DRUG ELECTROLYTES File 52.6 IV ADDITIVES INPUT TRANSFORM Subfile 52.62 Field 1 CONCENTRATION - ^DD(50.4,1,0) ^DD("52.62","1","0")="CONCENTRATION^RFX^^0;2^K:+X'=X!(X>99999)!(X<0)!(X?.E1". "5N .N) X I $D(X) S PSIVX=X,Y=^DD(50.4,1,0),X=$P(^PS(50.4,+^PS(52.6,DA(1),2,DA,0),0) ,"^",2) D ENC^PSIV S X=PSIVX_" "_X K PSIVX D STRTH^PSSDDUT2" ^DD("52.62","1","3")="Type a number between 0 and 99999." **************** ^DD(59.723 59.7 PHARMACY SYSTEM File 59.7 PHARMACY SYSTEM INPUT TRANSFORM Subfile 59.723 Field .01 TO SERVICE - ^DD(59.723,.01,0) PSYS2 D EN^DDIOL("(""From"" service is "_$S('$D(PS(59.7,D0,23,D1,0)):"UNKNOWN" ,$P(^(0),"^")]"":$P(^PS(";"_$P(^DD(59.723,.01,0),"^",3),";"_$P(^PS(59.7,D0,23 ,D1 ,0),"^")_":",2),";"),1:"UNKNOWN")_")") Q **************** ^DD(55.01 55 PHARMACY PATIENT File 52.6 IV ADDITIVES INPUT TRANSFORM Field 4 USUAL IV SCHEDULE - ^DD(55.01,.09,0) ^DD("52.61","4","0")="USUAL IV SCHEDULE^FX^^0;5^X $P(^DD(55.01,.09,0),"^",5,999) " ^DD("52.61","4","3")="Answer must be 1-22 characters in length." ^DD("52.61","4","20","0")="^.3LA^1^1" ^DD("52.61","4","20","1","0")="PSJI" ^DD("52.61","4","21","0")="^^2^2^2910305^^^" ^DD("52.61","4","21","1","0")=" Enter the schedule that should be 'stuffed' int o the schedule field" ^DD("52.61","4","21","2","0")="of the IV order using this quick code." ^DD("52.61","4","DT")="2860223" **************** ^DD(50.4 50.4 DRUG ELECTROLYTES File 52.7 IV SOLUTIONS INPUT TRANSFORM Subfile 52.702 Field 1 CONCENTRATION - ^DD(50.4,1,0) ^DD("52.702","1","0")="CONCENTRATION^RFX^^0;2^K:+X'=X!(X>99999)!(X<0)!(X?.E1" ."5 N.N) X I $D(X) S PSIVX=X,Y=^DD(50.4,1,0),X=$P(^PS(50.4,+^PS(52.7,DA(1),2,DA,0),0 ),"^",2) D ENC^PSIV S X=PSIVX_" "_X K PSIVX D STRTH^PSSDDUT2" ^DD("52.702","1","3")="Type a number between 0 and 99999." ROUTINE: ******************** 2160 NAME: DBIA2160 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING LAB SERVICE HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: SEP 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: XUTL('OR',$J DESCRIPTION: TYPE: File Order Entry uses ^XUTL("OR",$J,xxx where xxx is the ancillary or support packages' namespace. ROUTINE: ******************** 2161 NAME: HLFNC2 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 29,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: HLFNC2 COMPONENT: INIT VARIABLES: EID Type: Input (required) Name or IEN of the event driver or subscriber protocol in the Protocol file (#101) for which the initialization variables are to be returned. HL Type: Both (required) Pass by reference. The variable in which the array of values will be returned or an error message. INT Type: Input 1 indicates that only array values for internal DHCP to DHCP message exchange should be initialized. API call INIT^HLFNC2(EID,.HL,INT), returns an array of values in the variable specified by parameter HL. If no error occurs, the array of values is returned. Otherwise, the single value HL is returned equal to the following : error code^error messages. COMPONENT: MSH VARIABLES: HL Type: Input (required) Pass by reference. The array of values returned by the call to INIT^HLFNC2. MID Type: Input (required) The Message Control ID to be included in the MSH segment. The Batch Control ID for the batch is returned by the call to CREATE^HLTF. The application concatenates a sequential number to the batch ID to create the MID. RESULT Type: Output (required) Pass by reference. The variable that will be returned to the calling application that contains the MSH segment. If the MSH segment is longer than 245 characters there will be a RESULT(1). If the required variables, HL or MID are missing, RESULT will be null. SECURITY Type: Input An optional input parameter which includes the security to be included in field #8 of the MSH segment. API call MSH^HLFNC2(.HL,MID,.RESULT,SECURITY), builds an HL7 Message Header (MSH) segment. The MSH segment is returned in variable RESULT. COMPONENT: RSPINIT VARIABLES: EIDS Type: Input (required) Name or IEN of the subscriber protocol in the Protocol file (#101) for which the initialization variables are to be returned. This is the first parameter. The receiving application processing the inbound message should use HL("EIDS") as this first parameter to RSPINIT^HLFNC2 API as this variable is created for the application by the HL7 background job. This parameter should be used as a call by value. HL Type: Output (required) Pass by reference. The variable in which the array of values will be returned or an error message. The application should use its own namespaced HL array name. API call RSPINIT^HLFNC2(HL("EIDS"),.MYNSPCHL), returns an array of values in the variable specified by parameter MYNSPCHL. If no error occurs, the array of values is returned. Otherwise, the single value MYNSPCHL is returned equal to the following : error code^error messages. 1. Response message(s) not constructed properly when the HL7 field separator and encoding characters are different between sending system and receiving system. This issue is a result of the Processing Routine utilizing the environmental variables HL("FS") and HL("ECH") for both parsing the inbound HL7 message and constructing the outbound response message. After the Processing Routine has constructed the body of the response message, it calls GENACK^HLMA1 to queue up the response message. In turn, VistA HL7 constructs the message header based on the application associated with the subscriber protocol. Thus, the message header would have a different set of delimiters than the body of the HL7 message. This patch does not immediately correct this problem. However, it does provide a new API that can be used to create environmental variables to assist the Processing Routine in constructing the response message with the proper delimiters. This problem will only disappear when all VistA HL7 applications have migrated to using this new API to assist each in constructing the response message. New API: RSPINIT^HLFNC2 RSPINIT(EIDS,HL);Initialize Variables in HL array for Building a Response Message ; ;This is a subroutine call with parameter passing that returns an ;array of values in the variable specified by the parameter HL. If no ;error occurs, the array of values is returned. Otherwise, the single ;value HL is returned equal to the following: error code^error message ; ;Required Input Parameters ; EIDS = Name or IEN of the subscriber protocol in ; Protocol file for which the initialization variables are ; to be returned ; HL = The variable in which the array of values will be returned ; This parameter must be passed by reference ; Usage: D RSPINIT^HLFNC2(HL("EIDS"),.MYHLARRY) The Processing Routine should call this RSPINIT^HLFNC2 API to create the environmental variables needed to assist in constructing the response message. This API should be used especially when there is a possibility of the field separator and Encoding Characters being different between the sending application and the receiving application. The second parameter to this API should be an application namespaced variable passed by reference. This second parameter should NOT have HL namespace. However, the first parameter should be the name or IEN of the subscriber protocol. VistA HL7 provides this information to the Processing Routine through the variable HL("EIDS"). Therefore, HL("EIDS") should be used as the first parameter passed by value. As before, the Processing Routine should use the environmental variables HL("FS") and HL("ECH") in parsing the inbound HL7 message. However, the Processing Routine should use its own namespaced array as the second parameter of the call to RSPINIT^HLFNC2. For instance, if the second parameter was MYHLARRY, then the Processing Routine should use MYHLARRY("RFS") and MYHLARRY("RECH") as the variables containing the delimiters to assist in constructing the response message. This RSPINIT^HLFNC2 API may be called by the Processing Routine any time after the VistA HL7 has called the Processing Routine to process the inbound message and just before constructing the response message and calling GENACK^HLMA1. Below is an example of what may be returned in the second parameter: Description: ============================ MYHLARRY("RAN")=XWB RECEIVER receiving application name MYHLARRY("RECH")=~|\& response encoding characters| MYHLARRY("RETN")=R08 response event type name MYHLARRY("RFS")=^ response field separator MYHLARRY("RMTN")=TBR response message type Before referencing the return array with the individual subscripts (as shown above) for the purpose of building the response message, the processing routine should first check the top level root (i.e.: MYHLARRY) for a possible error. If an error should occur, RSPINIT^HLFNC2 will return the error code and text description in the top level root. The format of this of this top level root when an error occurs will look like the following: MYHLARRY=Error_Code#^Error_Text The following is a list of potential errors returned: o Missing EIDS Input Parameter o Invalid Subscriber Protocol o Susbscriber Applicaton Missing in Protocol File The above list is provided only as an example and the actual error code and error text description are subject to change. Therefore, the processing routine should merely check to see if an error was returned. For example, I $G(MYHLARRY) D ALERT ... Q D BLDRSPNs D GENACK^HLMA1(... Note, the processing routine should check for an error to determine whether it should proceed with building the response message and subsequently call GENACK^HLMA1. If an error was returned by RSPINIT^HLFNC2, the processing routine should not proceed. However, if the processing routine already parsed and processed the inbound message, it should be aware that the sending application may continue to resend the same message repeatedly and as such act accordingly. ******************** 2163 NAME: DBIA2163 CUSTODIAL PACKAGE: QUALITY ASSURANCE INTEGRATION SUBSCRIBING PACKAGE: INCIDENT REPORTING USAGE: Private ENTERED: DEC 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 740 ROOT: QA(740 DESCRIPTION: TYPE: File Requesting permission to add two new fields in QA Site Paramter file (#740) to store whether or not the station is multi-divisional for the Incident Reporting package (namespace QAQ), and if yes, the names of the Medical Centers within the NDBI Integration Group. ^QA(740, 751 MULTI-DIVISIONAL INC QAN Read w/Fileman Stores whether or not station is an NDBI Integration Site. 752 IR HOSPITAL DIVISION QAN2 Read w/Fileman Multiple storing the names of the Medical Centers within an Integration Group. ROUTINE: ******************** 2164 NAME: HL7 MESSAGE ADMINISTRATION CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine API to generate a HL7 message. ROUTINE: HLMA COMPONENT: GENERATE VARIABLES: HLEID Type: Input The name or IEN of the event driver protocol in the Protocol File (#101). HLARYTYP Type: Input Array type. One of the following codes: LM = local array containing a single message LB = local array containing a batch of messages GM = global array containing a single message GB = global array containing a batch of messages HLFORMAT Type: Input Format of array, 1 for pre-formatted in HL7 format, otherwise 0 HLRESLT Type: Both The variable that will be returned to the calling application with either a error message or a unique message ID. HLMTIEN Type: Input Optional IEN of entry in Message Text file where the message being generated is to be stored. This parameter is only passed for a batch type message. HLP Type: Input The HLP parameter is passed-by-reference. The HLP subscripts that are processed by GENERATE^HLMA are identical to the DIRECT^HLMA HLP subscripts. These subscripts are listed below. o HLP("PRIORITY") = I for immediate or D for deferred o HLP("SECURITY") = A 1 to 40 character string o HLP("CONTPTR") = Continuation pointer, a 1 to 180 character string o HLP("NAMESPACE") = Free-text value, 4 character limit, stored that is to be stored in the NAMESPACE field (#16) in the HL Message Text file (#772.) o HLP("SUBSCRIBER") = Free-text, multi-piece value, used to control the routing-related fields in the MSH segment. See patch HL*1.6*93 documentation for full details. The GENERATE^HLMA(HLEID,HLARYTYP,HLFORMAT,HLRSLT,HLMTIEN,HLP) entry point to used to generate a HL7 message. It returns a unique message ID if a message is successfully generated. COMPONENT: DIRECT VARIABLES: HLEID Type: Input The name or IEN of the event driver protocol in the Protocol File (#101). HLARYTYP Type: Input Array type. One of the following codes: LM = local array containing a single message LB = local array containing a batch of messages GM = global array containing a single message GB = global array containing a batch of messages HLFORMAT Type: Input Format of array, 1 for pre-formatted in HL7 format, otherwise 0 HLRESLT Type: Both The variable that will be returned to the calling application with either a error message or a unique message ID. If the call is successful (message sent), the Result parameter is returned with piece 1 equal to the message ID of the message created. If the call failed (message was not sent), the Result parameter is returned with the following three pieces of data: message ID(0 if none assigned)^error code^error description If the call failed, +$P(RESULT,U,2) returns True. HLMTIEN Type: Input Optional IEN of entry in Message Text file where the message being generated is to be stored. This parameter is only passed for a batch type message. HLP Type: Input The HLP parameter is passed-by-reference. The HLP subscripts that are processed by DIRECT^HLMA are identical to the GENERATE^HLMA HLP subscripts. These subscripts are listed below. o HLP("PRIORITY") = I for immediate or D for deferred o HLP("SECURITY") = A 1 to 40 character string o HLP("CONTPTR") = Continuation pointer, a 1 to 180 character string o HLP("NAMESPACE") = Free-text value, 4 character limit, stored that is to be stored in the NAMESPACE field (#16) in the HL Message Text file (#772.) o HLP("SUBSCRIBER") = Free-text, multi-piece value, used to control the routing-related fields in the MSH segment. See patch HL*1.6*93 documentation for full details. The DIRECT^HLMA(HLEID,HLARYTYP,HLFORMAT,HLRSLT,HLMTIEN,HLP) entry point is used to generate a HL7 message. It returns a unique message ID if a message was successfully generated. Unlike the GENERATE^HLMA API, the DIRECT^HLMA API opens the connection directly for message delivery. (GENERATE^HLMA delivers messages via queued background job.) Applications that use the DIRECT API must provide the guaranteed delivery if needed. Call INIT^HLFNC2 before making this call, to set up HL7 environment variables needed to build your message and needed by DIRECT^HLMA. The DIRECT^HLMA call has the same input parameters as GENERATE^HLMA. Like GENERATE^HLMA, it expects segments for the message to be already loaded in the HLA("HLS") local array or the^TMP("HLS") global array. For more information on the expected format of HLA("HLS") or^TMP("HLS"), please see the GENERATE^HLMA call. To select the subscriber to transmit to, this call first checks the contents of the HLL("LINKS")array; it will use first record it finds. If that array is empty, it uses the first subscriber protocol it finds in the Subscribers multiple of the event driver protocol. Upon return, DIRECT^HLMA does not invoke the event driver protocol's GENERATE/PROCESS ACK ROUTINE to processes the acknowledgment. When control is returned to the calling routine, the environment is left in the same condition as if you were in the "processing routine environment" when receiving an acknowledgment; the variables HLNEXT,HLNODE, and HLQUIT are defined so that you can process the response. Note that DIRECT^HLMA supports: o All acknowledgment modes (including deferred acknowledgments o Batch message transmission The timeout for the synchronous transmission is determined by the settings of the TCP used. Example: D DIRECT^HLMA("EVENT DRIVER PROTOCOL","GB",1,.MYRESULT) I +$P(MYRESULT,U,2) D ERR Q ; message was not transmitted I HLMTIEN D PROCESS ; response was returned from target system ******************** 2165 NAME: HL7 MESSAGE ADMINISTRATION CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine API to generate a HL7 acknowledgement message. ROUTINE: HLMA1 COMPONENT: GENACK VARIABLES: HLEID Type: Input IEN of the event driver protocol from the Protocol File (#101) HLMTIENS Type: Input IEN of entry in Message Text file for subscriber application. HLEIDS Type: Input IEN of subscriber event from the Protocol File (#101) HLARYTYP Type: Input Array type. One of the following codes: LM = local array containing a single message LB = local array containing a batch of messages GM = global array containing a single message. GB = global array containing a batch of messages. HLFORMAT Type: Input Format of array, 1 for pre-formatted in HL7 format, otherwise 0 HLRESLTA Type: Both Variable returned to the calling application either containing an error message or null if no error occurred. HLMTIENA Type: Input Optional variable of the IEN of the entry in Message Text file where the acknowledgement message will be stored. This is only passed for a batch acknowledgement. HLP Type: Input HLP("PRIORITY") = I for immediate or D for deferred HLP("SECURITY") = A 1 to 40 character string GENACK(HLEID,HLMTIENS,HLEIDS,HLARYTYP,HLFORMAT,HLRESLTA,HLMTIE NA,HLP) Entry point to generate a HL7 acknowledgement message. ******************** 2166 NAME: PATIENT ALLERGIES CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: MAR 10,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8, DESCRIPTION: TYPE: File The Baxter Sure-Med Pharmacy Interface needs to reference a patient's allergies to transmit via HL7 segment message. ^GMR(120.8,'B',DFN, .01 PATIENT 0;1 Direct Global Read & w This is the patient to whom a allergy/adverse reaction pertains. By looping through the "B" cross-reference, any multiple allergies/ adverse reactions can be obtained. .02 REACTANT 0;2 Direct Global Read & w This is the agent to which the patient has a reaction. This global contains patient allergy/adverse reaction information. ^GMR(120.8,D0,26,'AVER','E') 26 COMMENTS 26 Direct Global Read & w This global reference checks to see if an allergy/adverse reaction was entered in error. If this is an error entry, it will be ignored. ROUTINE: ******************** 2167 NAME: ALLERGY SIGN/SYMPTOMS CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.83 ROOT: GMRD(120.83, DESCRIPTION: TYPE: File The Baxter Sure-Med Pharmacy Interface is requesting permission to retrieve the reaction for the HL7 AL1 segment message. It is currently an optional field. ^GMRD(120.83,D0,0),U) .01 NAME 0;1 Direct Global Read & w A sign/symptom that can be associated with an allergy. D0 is obtained as the first piece from the first piece of ^GMR(120.8,D0,10,D1,0). ROUTINE: ******************** 2171 NAME: DBIA2171 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 7,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Function API's to access parts of the Institution file. This DBIA documents some entry point for accessing the Institution file that were requested by the CIRN developers or implemented by the IFR project. ROUTINE: XUAF4 COMPONENT: PARENT VARIABLES: array Type: Both As a input it is the $NAME reference for the Array name you want results back in. As output it holds - array("p",ien)=station name ^ station number Note: with the business rule that institutions can only have one parent per type, if you specific the input variable type - you will get an array that will only have one pien in it. If the type variable is left blank, find all parents for the institution and list then in the array. lookup Type: Input Lookup value - either ien, station number, station name. If IEN it will have the ` in front of it. type Type: Input Type (optional) - type of institution from file 4.05 (in cirn case it is = visn) PARENT^XUAF4(array,lookup[,type]) for a specified institution who is its VISN or parent. COMPONENT: SIBLING VARIABLES: array Type: Both As a input it is the $NAME reference for the Array name you want results back in. As the output array("p",pien,"c",cien)=station name ^ station number Note: with the business rule that institution can only have one parent per type, if you specific the input variable type - you will get an array that will only have one pien in it. If the type variable is left blank, find all parents for the institution and list then in the array. Also, the input site is included in the list child Type: Input Lookup value - either ien, station number, station name. If IEN it will have the ` in front of it. type Type: Input Type (optional) - type of institution from file 4.05 (in cirn case it is = visn) SIBLING^XUAF4(array,child [,type]) - all institutions in a specified institutions visn. COMPONENT: CHILDREN VARIABLES: array Type: Both Array - As a input it is the $NAME reference for the Array name you want results back in. Output Variable array ("c" , ien)=station name ^ station number parent Type: Input Parent - Lookup value either ien, station number, station name. If IEN it will have the ` in front of it. CHILDREN^XUAF4(array,parent) - for a specified VISN return a list of all institutions that make up the VISN. COMPONENT: $$NNT VARIABLES: ien Type: Input ien is the pointer value to file 4. $$NNT^XUAF4(ien) - This will return the "station name ^ station number ^ station type" COMPONENT: $$CIRN VARIABLES: inst Type: Input inst - Lookup value either ien, station number, station name. If IEN it will have the ` in front of it. value Type: Input value - (optional) Restricted to use by CIRN. This allows the setting of the field to a new value. $$CIRN^XUAF4(inst [,value]) - This function returns the value of the CIRN enabled field from the institution file. COMPONENT: $$LKUP VARIABLES: inst Type: Input inst - Lookup value either ien, station number, station name. If IEN it will have the ` in front of it. $$LKUP^XUAF4(inst) - This function does a lookup on the Institution file and returns the IEN OR 0. COMPONENT: $$NS VARIABLES: IEN Type: Input The internal entry number for the institution that is requested. This extrinsic function returns a string with the institution name a "^" and the institution station number. The input is a valid IEN for the institution. COMPONENT: $$WHAT VARIABLES: ien Type: Input ien is the pointer value to file 4. field Type: Input "field" is a single valued field in the file. Controls what data is returned. This entry point returns the data from one field in the institution file. COMPONENT: $$IEN VARIABLES: STA Type: Input Station number (required) $$IEN^XUAF4(STA) - This function returns the Internal Entry Number (IEN) of the entry for a given STATION NUMBER (#99) in the INSTITUTION (#4) file. COMPONENT: $$STA VARIABLES: IEN Type: Input Internal Entry Number (required) $$STA^XUAF4(IEN) - This function returns the STATION NUMBER (#99) of the INSTITUTION (#4) file entry for a given Internal Entry Number (IEN). This entry point will be available after patch XU*8*126. COMPONENT: $$TF VARIABLES: IEN Type: Input Internal Entry Number (required) Type: This function returns the truth-value to the question is this an active treating medical facility? COMPONENT: $$O99 VARIABLES: IEN Type: Input The Internal Entry Number of the INSTITUTION (#4) file entry whose STATION NUMBER (#99) was deleted. IEN Type: Output The Internal Entry Number of the INSTITUTION (#4) file entry with a valid STATION NUMBER (#99) -- the station number deleted from the input IEN during the clean up process with patch XU*8.0*126. $$O99^XUAF4(IEN) - This function returns the Internal Entry Number of the valid INSTITUTION (#4) file entry with station number that this entry (input IEN) was merged with during the clean up. This function may be used by application developers to re-point their INSTITUTION (#4) file references to a valid entry complete with station number. COMPONENT: F4 VARIABLES: STA Type: Input Station number (required) ARRAY Type: Input The array for return values (required). FLAG Type: Input A = Active entries only (optional) M = Medical treating facilities only DATE Type: Input Return name on this FM internal date (optional) ARRAY Type: Output ARRAY=IEN or '0^error message' ARRAY("NAME")=name ARRAY("VA NAME")=official VA name ARRAY("STATION NUMBER")=station number ARRAY("TYPE")=facility type name ARRAY("INACTIVE")=inactive FM internal date (0=not inactive) Note: if inactive date not available then 1 ARRAY("REALIGNED TO")='IEN^station number^date' ARRAY("REALIGNED FROM")='IEN^station number^date' ARRAY("MERGE",IEN)=merged records F4^XUFA4(STA,ARRAY,FLAG,DATE) - This API returns the INSTITUTION (#4) file Internal Entry Number and other data, including historical, for a given station number. COMPONENT: $$LEGACY VARIABLES: STA Type: Input Station Number in question. This function returns the truth value for a station number. Has this station number been realigned? (Is it a legacy station number.) COMPONENT: $$NAME VARIABLES: IEN Type: Input Internal Entry Number This function returns the OFFICIAL NAME (#100) of an Institution given its Internal Entry Number. If field #100 is null, the #.01 field is returned. COMPONENT: $$ACTIVE VARIABLES: IEN Type: Input Internal Entry Number This function returns the truth value for the question -- is this an active facility? (The INACTIVE FACILITY FLAG #101 not set.) COMPONENT: $$PADD VARIABLES: IEN Type: Input Internal Entry Number This function returns the physcial address information for an Institution in an up-arrow delimited string (street addr^city^state^zip) for a given Internal Entry Number. COMPONENT: $$MADD VARIABLES: IEN Type: Input Internal Entry Number This function returns the mailing address information for an Institution in an up-arrow delimited string (street addr^city^state^zip) for a given Internal Entry Number. COMPONENT: $$PRNT VARIABLES: STA Type: Input STA is station number of the child facility. This function returns the string "IEN^station_number^name" of the parent facility of a given child facility station number. COMPONENT: LOOKUP VARIABLES: Y Type: Output See FileMan IX^DIC documentation. This utility prompts a user for a coding system and then prompts for an identifier -- its an IX^DIC call on a new style cross-reference of the ID (#.02) field of the IDENTIFIER (#9999) multiple of the INSTITUTION (#4) file. COMPONENT: $$IDX VARIABLES: CDSYS Type: Input CDSYS is an existing CODING SYSTEM (#.01) in the INDENTIFIER (#9999) multiple of the INSTITUTION (#4) file. D CDSYS^XUAF4(.Y) to see existing coding systems in the file. ID Type: Input ID is the ID (#.02) in the INDENTIFIER (#9999) multiple of the INSTITUTION (#4) that corresponds to the coding system you input as the first parameter. $$ Type: Output Internal Entry Number This function returns the Internal Entry Number of an Institution file entry for a given coding sytem / ID pair. COMPONENT: CDSYS VARIABLES: Y Type: Both Y -- pass by reference returns Y(coding_system) = $D_of_local_system ^ coding_system name COMPONENT: $$ID VARIABLES: CDSYS Type: Input CDSYS is an existing CODING SYSTEM (#.01) in the INDENTIFIER (#9999) multiple of the INSTITUTION (#4) file. D CDSYS^XUAF4(.Y) to see existing coding systems in the file. IEN Type: Input Internal Entry Number $$ID Type: Output The ID (identifier) that is associated with the given coding system / IEN. This function returns the ID of an Institution file entry for a given coding system / IEN. COMPONENT: $$BNSTA VARIABLES: STA Type: Input Station Number This function returns the billing facility name for a given station number. COMPONENT: $$BNIEN VARIABLES: IEN Type: Input Internal Entry Number This function returns the billing facility name for a given IEN. COMPONENT: $$HPADD VARIABLES: IEN Type: Input Internal Entry Number XUEDT Type: Input Effective Date for Historical Address search This function returns the correct historical physical address information, if available, for an Institution in an up-arrow delimited string (street addr^city^state^zip) for a given Internal Entry Number and Effective Date. If no historical physical address information is available based on the ien and effective date, a null value will be returned. COMPONENT: $$CERNER VARIABLES: STA Type: Input Station number This function checks if a facility has been converted to CERNER. ; Take in STA = Station number ; Return -1 for invalid station number ; Return 1 for CERNER station ******************** 2172 NAME: DBIA2172 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 8,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The routine XPDID contains calls to support the Kernel Installation and Distribution System. All of the calls can only be used in the context of the KIDS software. INIT This tag initializes the screen and draws the borders for the box and draws the progress bar. It also creates a scrolling region in the box. INPUT: none OUTPUT: XPDIDVT=1 if output device supports graphics, =0 if not TITLE(text) This tag displays the text as a title at the top of the box. INPUT: text OUTPUT: none EXIT(text) This tag restore the screen to normal, cleans up all variables, and displays the text. INPUT: text OUTPUT: none UPDATE(current number of items) This tag updates the progress bar to show the percentage complete of the installation. INPUT: current number of items XPDIDTOT = total number of items For example, if you are converting 100 records and want to update the user every time you have completed 10% of the records you would do the following: Set XPDIDTOT=100 F%=1:1:100 D CONVERT I'(%#10) D UPDATE^XPDID(%) ROUTINE: XPDID COMPONENT: UPDATE(N) VARIABLES: XPDIDTOT Type: Input This is the total number of items that is being updated. N Type: Input The current number of items being updated. Update the progress bar by N, current number of items. COMPONENT: TITLE(X) VARIABLES: X Type: Input This is the text you want to display Display the text, X, as a title at the top of the box. COMPONENT: INIT VARIABLES: Initializes the device and draws the borders for the box and draws the progress bar. COMPONENT: EXIT(X) VARIABLES: X Type: Input Text to display on screen after removing box and progress bar. Restores the screen to normal, cleans up all variables, and displays the text in the variable X. ******************** 2173 NAME: DBIA2173 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE USAGE: Controlled Subscri ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.7 ROOT: PS(52.7 DESCRIPTION: TYPE: File This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2174 NAME: DBIA2174 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.606 ROOT: PS(50.606 DESCRIPTION: TYPE: File Inpatient Medications request permission to look at DOSAGE FORM file 50.606. This file was previously in National Drug File. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2175 NAME: DBIA2175 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.4 ROOT: PS(50.4 DESCRIPTION: TYPE: File Inpatient Medications requests permission to look at DRUG ELECTROLYTES file 50.4. This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2176 NAME: DBIA2176 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51 ROOT: PS(51 DESCRIPTION: TYPE: File Inpatient Medications request permission to look at MEDICATION INSTRUCTION file 51. This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2177 NAME: DBIA2177 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.1 ROOT: PS(51.1 DESCRIPTION: TYPE: File Inpatient Medications requests permission to look at ADMINISTRATION SCHEDULE file 51.1. This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2178 NAME: DBIA2178 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE USAGE: Controlled Subscri ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.2 ROOT: PS(51.2 DESCRIPTION: TYPE: File Inpatient Medications request permission to look at MEDICATION ROUTES file 51.2. This file was previously in Inpatient Meds versions up to 5.0. Now it has moved to Pharmacy Data Management 1.0. It is used extensively throughout our routines. With this move, we are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2179 NAME: DBIA2179 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9009032.4 ROOT: APSPQA(32.4 DESCRIPTION: TYPE: File Inpatient Medications requests permission to look at APSP INTERVENTION file 9009032.4. ^APSPQA(32.4,D0,0) .01 INTERVENTION DATE 0;1 Both R/W w/Fileman .02 PATIENT 0;2 Both R/W w/Fileman .04 PHARMACIST 0;4 Both R/W w/Fileman .05 DRUG 0;5 Both R/W w/Fileman .06 INTERVENTION 0;7 Both R/W w/Fileman .08 RECOMMENDATION 0;8 Both R/W w/Fileman .14 ORIGINATING PACKAGE 0;14 Both R/W w/Fileman .15 RX # 0;15 Both R/W w/Fileman .03 PROVIDER 0;3 Direct Global R/W & w/ ROUTINE: ******************** 2180 NAME: DBIA2180 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE BAR CODE MED ADMIN ADDED 8/28/09 USAGE: Controlled Subscri ENTERED: OCT 14,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.7 ROOT: PS(50.7 DESCRIPTION: TYPE: File Inpatient Medications request permission to look at PHARMACY ORDERABLE ITEM file 50.7. This is a new file with Pharmacy Data Management v1.0. It is used extensively throughout our routines. We are requesting read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2181 NAME: DBIA2181 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.7 ROOT: PS(59.7 DESCRIPTION: TYPE: File Inpatient Medications requests permission to look at the following fields in the PHARMACY SYSTEM file 59.7. FIELD NUMBER NAME NODE AND PIECE 59.7,20.01 IV STATS/200 CONVERSION STATUS 20;10 59.7,20.1 VERSION NUMBER LAST INITS RUN 20;1 59.7,20.11 NEW PERSON CONVERSION DATE 20;11 59.7,20.12 PRIMARY DRUG CONVERSION DATE 20;12 59.7,20.13 DATE V4 PRE-PACKET INSTALLED 20;13 59.7,20.14 LAST N-V ORDER CONVERTED TO V4 20;14 59.7,20.15 DATE NON-VERIFIED CONVERTED 20;15 59.7,20.16 ORDERABLE ITEM CONVERSION DATE 20;16 59.7,20.2 DATE INITS LAST RUN 20;2 59.7,20.3 USER TO LAST RUN INITS 20;3 59.7,20.4 SITE FOR BACKGROUND JOB 20;4 59.7,20.401 UD STATS/200 CONVERSION MARKER 20.4;1 59.7,20.402 IV STATS/200 CONVERSION STATUS 20.4;2 59.7,20.403 NEW PERSON CONVERSION DATE 20.4;3 59.7,20.404 LAST N-V ORDER CONVERTED TO V4 20.4;4 59.7,20.405 DATE NON-VERIFIED CONVERTED 20.4;5 59.7,20.406 LAST PAT CONVERTED FOR VER 4 20.4;6 59.7,20.407 LAST PICK LIST TO PD MARKER 20.4;7 59.7,20.408 DATE PICK LISTS CONVERT TO PD 20.4;8 59.7,20.409 ORDER SET CONVERSION MARKER 20.4;9 59.7,20.41 ORDER SET CONVERSION DATE 20.4;10 59.7,20.411 DATE UD STATS FILE CONVERTED 20.4;11 59.7,20.5 DATE ATC DATA CONVERTED 20;5 59.7,20.6 DEFAULT WARD 20;6 59.7,20.8 LAST PATIENT CONVERTED TO V4 20;8 59.7,20.9 UD STATS/200 CONVERSION STATUS 20;9 59.7,21 NON-FORMULARY MESSAGE 21;0 59.7,22 WARD ACTIONS 22;0 59.722,.01 FROM WARD 0;1 59.722,1 TO WARD 1;0 59.7221,.01 TO WARD 0;1 59.722,2 'ON PASS' ACTION 0;2 59.722,3 ACTION ON AUTHORIZED ABSENCE 0;3 59.722,4 ACTION ON UNAUTHORIZED ABSENCE 0;4 59.7,23 D/C ON SERVICE TRANSFER 23;0 59.723,.01 FROM SERVICE 0;1 59.723,1 TO SERVICE 1;0 59.7231,.01 TO SERVICE 0;1 59.7,25 INPATIENT ORDER NUMBER 25;E1,245 59.7,25.1 DATE 5.0 UD VER CONV FINISHED 20.5;1 59.7,25.2 DATE 5.0 CONVERSION COMPLETED 20.5;2 59.7,25.3 DATE 5.0 PICK LIST CONV FINISH 20.5;3 59.7,25.4 DATE 5.0 ORDER SET CONV FINISH 20.5;4 59.7,26 PRINT 6 BLOCKS FOR THE PRN MAR 26;1 59.7,26.2 ATC SORT PARAMETER 26;2 59.7,26.3 PRINT DIET ABBR LABEL ON MAR 26;3 59.7,26.4 MAR SORT 26;4 59.7,26.5 CALC UNITS NEEDED PRN ORDERS 26;5 59.7,26.6 DAYS UNTIL STOP FOR ONE-TIME 26;6 59.7,26.7 ROUND ATC PICK LIST UNITS 26;7 59.7,26.8 EFD SCHEDULE 26;8 59.7,30.1 DATE IV ORDERS CONVERTED 30;1 59.7,30.2 LAST PATIENT CONVERTED (IV) 30;2 59.7,31 DAYS TO RETAIN IV STATISTICS 31;1 59.7,32 IV IDENTIFIER 31;2 59.7,34 EXPIRED IV TIME LIMIT 31;4 59.7,60.02 LAST PAT CONVERTED FOR VER 4 60;2 59.7,61.2 DAYS NEW LABELS LAST 61;2 59.7,63.51 PICK LIST AUTO-PURGE 63.5;1 59.7,63.52 DATE/TIME AUTO-PURGE EDITED 63.5;2 59.7,63.53 USER LAST EDITING AUTO-PURGE 63.5;3 59.7,63.54 DATE PICK LIST LAST FILED AWAY 63.5;4 59.7,64 PARAM FILE CONVERSION STATUS 20.4;12 59.7,65 PICK LIST CONVERSION DATE 20.4;13 59.7,66 V4.5 PICK LIST CONVERT MARKER 20.4;14 59.7,67 V4.5 PICK LIST CONVERT STATUS 20.4;15 59.7,80 PSS VERSION 80;1 59.7,81 ORDERABLE ITEM STATUS TRACKER 80;2 Use of input template PSJ OAOPT is also requested. GLOBAL MAP DATA DICTIONARY #59.7 -- PHARMACY SYSTEM FILE 10/17/97 STORED IN ^PS(59.7, (1 ENTRY) SITE: SALT LAKE ISC UCI: OEX,OER -------------------------------------------------------------------------- This file contains data that pertains to the entire Pharmacy system of a medical center, and not to any one site or division. The number ranges for the nodes and field numbers are as follows: 0 - 9.99 RESERVED 10 - 19.99 National Drug File 20 - 29.99 Inpatient 30 - 39.99 IV's 40 - 49.99 Outpatient 50 - 59.99 Ward Stock/AR 60 - 69.99 Unit Dose 70 - 79.99 Drug Accountability 80 - 89.99 Pharmacy Data Management ROUTINE: ******************** 2182 NAME: CLINICAL REMINDERS APIs CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: HEALTH SUMMARY AUTOMATED INFO COLLECTION SYS ORDER ENTRY/RESULTS REPORTING LAB SERVICE SCHEDULING VA POINT OF SERVICE (KIOSKS) WOMEN'S HEALTH HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JAN 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PXRM COMPONENT: MAIN(DFN,PXRMITEM,OUTTYPE,DISC) VARIABLES: DFN Type: Input Pointer to Patient file (#2) PXRMITEM Type: Input Internal entry number of Clinical Reminder definition (file #811.9) OUTTYPE Type: Input This is the type of output to return. The possible values are: 0 - Reminders DUE NOW only (CLINICAL REMINDERS DUE HS component) 1 - All Reminders with Next and Last Information (CLINICAL REMINDERS SUMMARY HS component) 5 - Health Maintenance (CLINICAL REMINDERS MAINTENANCE HS component) 10 - MyHealtheVet summary 11 - MyHealtheVet detailed 12 - MyHealtheVet combined DISC Type: Input (optional) If this variable is true then the disclaimer will be loaded in ^TMP("PXRM",$J,"DISC") TMP Type: Output The results of the reminder evaluation are returned in ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM) where PXRMRNAM is the PRINT NAME or if it is undefined then it is the NAME. The format is: ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)=STATUS^DU E DATE^LAST D0NE DATE and ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM,"TXT",N)=T EXT where N is a number and TEXT is a text string. The text returned depends on the output type (OUTTYPE) and the results of the reminder evaluation. If DISC is true then the disclaimer will be loaded into ^TMP("PXRM",$J,"DISC"). It contains the disclaimer. The caller should kill both ^TMP("PXRHM",$J) and ^TMP("PXRM",$J) after display of the data is complete. This is the standard entry point for reminder evaluation. The current date and time are used for the evaluation date and time. COMPONENT: FIDATA(DFN,PXRMITEM,.FINDINGS) VARIABLES: Return the finding evaluation array to the caller in the array FINDINGS. The caller should use the form: D FIDATA^PXRM(DFN,PXRMITEM,.FINDINGS) The elements of the FINDINGS array will correspond to the findings in the reminder definition. For finding N, FINDINGS(N) will be 0 if the finding is false and 1 if it is true. For true findings there will be additional elements. The exact set of additional elements will depend on the type of finding. Some examples are: FINDINGS(N)=1 FINDINGS(N,"DATE")=FileMan date FINDINGS(N,"FINDING")=variable pointer to the finding FINDINGS(N,"SOURCE")=variable pointer to the data source FINDINGS(N,"VALUE")=value of the finding, for example the value of a lab test COMPONENT: $$INACTIVE(PXRMITEM) VARIABLES: $$INACTIVE Type: Output Return the INACTIVE FLAG 1 - reminder is inactive 0 - reminder is active COMPONENT: MAINDF(DFN,PXRMITEM,OUTTYPE,EVALDT) VARIABLES: DFN Type: Input Pointer to Patient file (#2) PXRMITEM Type: Input Internal entry number of Clinical Reminder definition (file #811.9) OUTTYPE Type: Input This is the type of output to return. The possible values are: 0 - Reminders DUE NOW only (CLINICAL REMINDERS DUE HS component) 1 - All Reminders with Next and Last Information (CLINICAL REMINDERS SUMMARY HS component) 5 - Health Maintenance (CLINICAL REMINDERS MAINTENANCE HS component) 10 - MyHealtheVet summary 11 - MyHealtheVet detailed 12 - MyHealtheVet combined EVALDT Type: Input This is the FileMan date and time to use for the reminder evaluation. TMP Type: Output The results of the reminder evaluation are returned in ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM) where PXRMRNAM is the PRINT NAME or if it is undefined then it is the NAME. The format is: ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM)=STATUS^DU E DATE^LAST DONE DATE and ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM,"TXT",N)=T EXT where N is a number and TEXT is a text string. The text returned depends on the output type (OUTTYPE) and the results of the reminder evaluation. The finding evaluation array (FIEVAL) is returned in: ^TMP("PXRHM",$J,"PXRMITEM,"FIEVAL") A description of the contents of FIEVAL can be found in the Clinical Reminders Managers Manual. The caller should kill both ^TMP("PXRHM",$J) and ^TMP("PXRM",$J) after display of the data is complete. This entry point is used for reminder evaluation. The date and time to use for the evaluation is an input parameter. The finding evaluation array is returned in ^TMP("PXRHM",$J,PXRMITEM,PXRMRNAM). See below for details. ******************** 2184 NAME: DBIA2184 CUSTODIAL PACKAGE: DRG GROUPER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: OCT 15,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Clinical Reminders use the application group PXRS for screening taxonomy selections. The following files need to belong to this application group: File 80 - ICD DIAGNOSIS, File 80.1 - ICD OPERATION/PROCEDURE File 81 - CPT ROUTINE: ******************** 2185 NAME: DBIA2185 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call PSJQOS^ORCONV3. This entry point passes Unit Dose Order Set information to OERR to allow the creation of Quick orders from each Order Set. Inpatient Meds receives no output from this call. The data passed is described below. ^TMP("PSJQOS",$J,"NM")=ORDER SET NAME ^TMP("PSJQOS",$J,#,1)=ORDERABLE ITEM IEN^MED ROUTE IEN^ SCHEDULE ^DOSAGE ORDERED ^TMP("PSJQOS",$J,#,2)=SPECIAL INSTRUCTIONS ^TMP("PSJQOS",$J,#,3)=DISPENSE DRUG IEN^UNITS PER DOSE ROUTINE: ORCONV3 COMPONENT: PSJQOS VARIABLES: ******************** 2186 NAME: DBIA2186 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine has a number of supported entry points to support package interfaces with CPRS. ROUTINE: ORX1 COMPONENT: $$NA(DEFAULT,REQUIRD,FB,DIRA,DC,LIST) VARIABLES: DEFAULT Type: Input Free text code or pointer value to the nature of order in file 100.02 REQUIRD Type: Input Set to 1 to require a response from the user. FB Type: Input Used to screen selection by type (frontdoor or backdoor types). DIRA Type: Input Prompt used to set DIR("A") in call to ^DIR DC Type: Input Set to 1 if you only want to include DC types. LIST Type: Input List of nature of order codes allowed (from file 100.02). If this is passed then DC and FB parameters are ignored. Y Type: Output Y represents the value returned by the function. It is in the form: pointer^name^code This is a function that will prompt for and return a Nature of Order from the Nature of Order file. COMPONENT: NA1(SCREEN) VARIABLES: SCREEN Type: Input Used like DIC("S") to screen out entries. This is a call to get a standard help matrix for Nature of Order. COMPONENT: NA2(SCREEN) VARIABLES: SCREEN Type: Input Used like DIC("S") to screen out entries. This is a call to get a standard help matrix for DC Reason. COMPONENT: $$DC(DEFAULT,REQ,PKG,DIRA) VARIABLES: DEFAULT Type: Input Internal # from ORDER REASON (100.03) file to use as default. REQ Type: Input Set to 1 to require a response. PKG Type: Input Pointer to file 9.4 (Package) to screen selection to package specific reasons. DIRA Type: Input Default prompt used to set DIR("A") when calling ^DIR. Y Type: Output Y represents the value returned by this function. It is in the form: pointer^name Function to prompt for and get a DC Reason from the Order Reason (100.03) file. ******************** 2187 NAME: DBIA2187 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is a supported entry point for use by packages interfacing with CPRS. ROUTINE: ORERR COMPONENT: EN(ORTYP,ORMSG,ORVAR) VARIABLES: ORTYP Type: Input Text to identify problem. ORMSG Type: Input HL7 message array. ORVAR Type: Input ORVAR is an array with a list of variable names as subscripts that you need saved when ORERR is called. This call will log an error/problem in the OE/RR Errors (100.4) file. It is used by OE/RR and interfacing packages to identify potential problems. ******************** 2188 NAME: DBIA2188 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call (Outpatient Pharmacy) EN^PSOHLNEW. This entry point allows the order message array from OERR to be passed to Outpatient Pharmacy for processing. All message arrays from OERR come through the Inpatient Meds routine. The PATIENT CLASS field comes in the array from OERR. If the value is "I", it is processed as an Inpatient Order. If the value is "O" this call is made to process the order as an Outpatient order. Variables are described below. Input: EN^PSOHLNEW(.MSG) MSG - The message array from OERR. Output: none ROUTINE: PSOHLNEW COMPONENT: EN VARIABLES: ******************** 2189 NAME: DBIA2189 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 17,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications request permission to call (Outpatient Pharmacy) EN^PSODRDU2. If the inpatient has a drug-drug interaction, drug class, or duplicate drug with an outpatient order with call is made. The call displays the outpatient order's information. The call occurs during the inpatient order entry. Variables are described below. Input: EN^PSODRDU2(DFN,RXNUM) DFN - Patient's internal entry number is ^DPT. RXNUM - P1_P2_;_P3 where P1= Order number P2= Order Type, either "P" for pending or "R" for active RX P3= Pharmacy package code, either "I" or "O" Output: none ROUTINE: PSODRDU2 COMPONENT: EN VARIABLES: ******************** 2190 NAME: DBIA2190 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: OCT 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications request permission to call (Outpatient Pharmacy) ^PSOORDRG. This call returns drug-drug order checks. ROUTINE: PSOORDRG COMPONENT: EN(PSODFN,DREN) VARIABLES: PSODFN Type: Input Patient's internal entry number in ^DPT. DREN Type: Input Drug internal entry number in ^PSDRUG (#50) DRUG INTER Type: Output ^TMP($J,"DI",n,0) = Interacting Drug IEN^Interacting Drug Name^Interaction Ptr (file #56)^severity (CRITICAL or SIGNIFICANT) ^Ingredient #1 (ptr to file #50.416) ^Ingredient #2 (ptr to file #50.416)^OERR IEN^ORDER #;TYPE^PKG (I or O) DRUG CLASS Type: Output ^TMP($J,"DC",n,0) = VA Drug Class Name^Generic Drug Name (file #50)^Drug File (#50) IEN)^OERR IEN^ORDER # ;TYPE^PKG (I or O) DUPLICATE Type: Output ^TMP($J,"DD",n,0) = Duplicate drug IEN (file #50)^Duplicate Drug Name)^OERR IEN^ORDER #;TYPE^PKG (I or O) This call returns drug-drug order checks. COMPONENT: DRGCHK VARIABLES: ******************** 2191 NAME: DBIA2191 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 55 ROOT: PS(55 DESCRIPTION: TYPE: File This file is used extensively throughout our routines. We request read and write access to the entire file and cross-references via FileMan utilities and direct writes/reads. The fields we use are listed below. The UNIT DOSE multiple and IV multiple represent the majority of the fields in the file. Because they are so numerous, we would like full access to the file. ROUTINE: ******************** 2192 NAME: DBIA2192 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 21,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This file was previously under Outpatient Pharmacy. Now, Pharmacy Data Management 1.0 sends it out. This file is used extensively throughout our routines. We use a majority of the fields in this file. We request read and write access to the entire file, cross-references and templates via FileMan utilities and direct writes/reads. ROUTINE: ******************** 2195 NAME: DBIA2195 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY PHARMACY DATA MANAGEMENT Added 5/13/16,ICR subscription missed from previous project USAGE: Controlled Subscri ENTERED: OCT 22,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.6 ROOT: PSNDF(50.6, DESCRIPTION: TYPE: File Inpatient Medications requests access to file 50.6 NATIONAL DRUG. ^PSNDF(D0,0) .01 VA GENERIC NAME 0;1 Direct Global Read & w ^PSNDF(D0,2,D1,0) .01 DOSAGE FORM 0;1 Direct Global Read & w 1 ROUTE OF ADMINISTRAT 0;2 Direct Global Read & w 3 VA DRUG CLASSIFICATI 0;3 Direct Global Read & w ^PSNDF(D0,5,D1,0) .01 VA PRODUCT NAMES 0;1 Direct Global Read & w 1 DOSAGE FORM ENTRY 0;2 Direct Global Read & w 2 STRENGTH ENTRY 0;3 Direct Global Read & w 3 UNITS ENTRY 0;4 Direct Global Read & w 11 PPI 0;7 Direct Global Read & w 12 USP GENERIC 0;8 Direct Global Read & w ^PSNDF(D0,5,D1,1) 4 INGREDIENT ENTRY#1 1;1 Direct Global Read & w ^PSNDF(D0,5,D1,2) 5 VA PRINT NAME 2,1 Direct Global Read & w 6 VA PRODUCT IDENTIFIE 2,2 Direct Global Read & w 7 TRANSMIT TO CMOP 2,3 Direct Global Read & w 8 VA DISPENSE UNIT 2,4 Direct Global Read & w ^PSNDF(D0,5,D1,3) 9 INGREDIENT ENTRY#2 3;1 Direct Global Read & w ^PSNDF(D0,1,D1,0) .01 INGREDIENTS 0;1 Direct Global Read & w ^PSNDF(D0,2,D1,3,D2,4,D3,0) .01 UNITS 0;1 Direct Global Read & w ^PSNDF(D0,2,D1,3,D2,0) .01 STRENGTH 0;1 Direct Global Read & w ROUTINE: ******************** 2196 NAME: DBIA2196 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS CLINICAL INFO RESOURCE NETWORK PHARMACY DATA MANAGEMENT ADVERSE REACTION TRACKING USAGE: Controlled Subscri ENTERED: OCT 22,1997 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50.416 ROOT: PS(50.416 DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSN*4*94. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. Inpatient Medications requests access to file 50.416, DRUG INGREDIENTS. ^PS(50.416,D0,0) .01 NAME 0;1 Direct Global Read & w Also Direct Global Read to the 'B' cross-reference. ROUTINE: ******************** 2197 NAME: CPRS needs Install Start Time CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING INPATIENT MEDICATIONS OUTPATIENT PHARMACY SCHEDULING MASTER PATIENT INDEX ADDED 3/12/09 USAGE: Controlled Subscri ENTERED: OCT 25,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.7 ROOT: XPD(9.7, DESCRIPTION: TYPE: File Currently, the only way to get the start and completion date of an install is to get the IEN of the build and reference the fields directly. ^XPD(9.7,'B' Would like to use the B x-ref to pull the IEN of the INSTALL file entry for the first build in the series. ^XPD(9.7,IEN,1) 11 INSTALL START TIME 1;1 Direct Global Read & w Uses IEN obtained by B index to get the INSTALL START TIME for the first build in the series. This is used to determine the overall installation start time. ROUTINE: ******************** 2198 NAME: TEST FOR BROKER CONTEXT CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Use this function in the M code called by an RPC to determine if the current process is being executed by the Broker. ROUTINE: XWBLIB COMPONENT: $$BROKER() VARIABLES: Format $$BROKER^XWBLIB Input (none) Output Return Value 1 if the current process is being executed by the Broker; 0 if not. Example I $$BROKER^XWBLIB D .; broker-specific code ******************** 2199 NAME: CPRS checks for CMOP activation CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 27,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: OE/RR 3.0 FILE: 550 ROOT: PSX(550 DESCRIPTION: TYPE: File CPRS checks to see whether CMOP is activated or not to determine whether to default meds for mail or window pick-up. The installation of CPRS also makes a check to ensure that CMOP is inactivated prior to installation. ^PSX(550,'C') ROUTINE: ******************** 2200 NAME: DBIA2200 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY VIRTUAL PATIENT RECORD Added 6/6/19 so VPR provide Custom Services to the Pharmacy Advanced Medication Platform (AMPL) GUI project for prescription display information. Effective with VPR*1*14. USAGE: Controlled Subscri ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy package makes a call to the CMOP routine, PSXOPUTL to get CMOP data from the pharmacy files. This data is used when displaying the Rx profile to the screen. ROUTINE: PSXOPUTL COMPONENT: PSXOPUTL VARIABLES: PSXZ Type: Output This variable passes the value in the CMOP Indicator field (#3) of the Rx Suspense file (#52.5). ******************** 2201 NAME: DBIA2201 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOLBL, calls the CMOP routine, PSXSRP to make the activity log entry in the Prescription file (#52) when labels are reprinted using the Outpatient Pharmacy option Reprint Batches from Suspense [PSO PNDRPT]. This call doesn't pass variables. ROUTINE: PSXSRP COMPONENT: AREC VARIABLES: ******************** 2203 NAME: DBIA2203 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOORUT1, calls the CMOP routine, PSXOPUTL, to get CMOP data from the Outpatient Pharmacy and CMOP files. This data is used by the OERR interface. ROUTINE: PSXOPUTL COMPONENT: PSXOPUTL VARIABLES: DA Type: Input This is the internal entry number of the record in the Rx Suspense file (#52.5). PSXZ Type: Output This stores the value of the CMOP Indicator field (#3) in the Rx Suspense file (#52.5). ******************** 2204 NAME: DBIA2204 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSORXPR, calls the CMOP routine, PSXVIEW, to get CMOP data from the Outpatient Pharmacy and CMOP files. This data is displayed when viewing Rx's. The only variable passed in this call is DA. The PSXVIEW routine displays the information on the screen. ROUTINE: PSXVIEW COMPONENT: PSXVIEW VARIABLES: DA Type: Input DA is the internal entry number of the record in the Rx file (#52). ******************** 2205 NAME: DBIA2205 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOSUCHG, calls the CMOP routine, PSXCH to screen Rx's for CMOP when changing the suspense date for Rx's. Suspense dates cannot be changed for CMOP prescriptions if the CMOP suspense status is "TRANSMISSION COMPLETED" or "LOADING FOR TRANSMISSION". ROUTINE: PSXCH COMPONENT: P VARIABLES: SFN Type: Input SFN is the internel entry number of the record in the RX SUSPENSE (#52.5) file. COMPONENT: A VARIABLES: SFN Type: Input SFN is the internal entry number of the record in the RX SUSPENSE (#52.5) file. XOK Type: Output XOK=0 indicates that the suspense date cannot be changed at this time. XOK'=0 indicates that the suspense date can be changed at this time. ******************** 2206 NAME: DBIA2206 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOSUCH1, calls the CMOP routine, PSXCH, to screen Rx's when changing the suspense date. ROUTINE: PSXCH COMPONENT: X VARIABLES: SFN Type: Input SFN is the internal entry number of the record in the Rx Suspense file (#52.5). ******************** 2207 NAME: DBIA2207 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOSULB1, calls the CMOP routine, PSXRSUS if the site is using the CMOP software. This call displays the CMOP Print from Suspense file options. ROUTINE: PSXRSUS COMPONENT: PSXRSUS VARIABLES: PSXSYS Type: Input This is a CMOP system variable. If this variable is defined, the site is a CMOP remote medical center. ******************** 2208 NAME: DBIA2208 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSOSURST, calls the CMOP routine, PSXRPPL1 if the site is using the CMOP software. This call displays the CMOP Reprint Batches from Suspense options. ROUTINE: PSXRPPL1 COMPONENT: PSXRPPL1 VARIABLES: PSXSYS Type: Input This is a CMOP system variable. If this variable is defined, the site is a CMOP remote medical center. ******************** 2209 NAME: DBIA2209 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 28,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy routine, PSORXED, calls the CMOP routine, PSXEDIT. This call will screen Rx's for CMOP when editing the Rx. ROUTINE: PSXEDIT COMPONENT: PSXEDIT VARIABLES: PSORXED Type: Input This variable stores the zero node of the entry in the Rx file (#52). PSXFROM Type: Input This variable stores the process name that is making the call to the routine. It is used to determine the action to be made on the Rx during processing. ******************** 2211 NAME: DBIA2211 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 29,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call (Outpatient Pharmacy) ^PSOORDA. This call builds the ^TMP("PSJAL" and ^TMP("PSJDA" globals that contain the patients Allergy/Adverse Reaction information to display on the ListMan screen. ROUTINE: PSOORDA COMPONENT: BEG VARIABLES: PSJINPT Type: Input This variable is set to 1 to identify that the call is coming from the Inpatient Meds routine. DFN Type: Input This is the patient's IEN number in ^DPT. TMP global Type: Output The call returns all of a patients allergy and adverse reaction information in the ^TMP("PSJDA",N,0). The variable "N" is the screen line numbers. Inpatient Meds uses this ^TMP global to display the information through ListMan. Example below. ^TMP("PSJDA",539016357,1,0) = Verified ^TMP("PSJDA",539016357,2,0) = Drug: ^TMP("PSJDA",539016357,3,0) = 1 DAVE DRUG ^TMP("PSJDA",539016357,4,0) = Food: ^TMP("PSJDA",539016357,5,0) = 2 STRAWBERRIES ^TMP("PSJDA",539016357,6,0) = Other: ^TMP("PSJDA",539016357,7,0) = ^TMP("PSJDA",539016357,8,0) = Non-Verified ^TMP("PSJDA",539016357,9,0) = Drug: ^TMP("PSJDA",539016357,10,0) = 3 CODEINE ^TMP("PSJDA",539016357,11,0) = 4 PENNTUSS ^TMP("PSJDA",539016357,12,0) = 5 RADIOLOGICAL/CONTRAST MEDIA ^TMP("PSJDA",539016357,13,0) = Other: ^TMP("PSJDA",539016357,14,0) = 6 DUST This entry point builds the ^TMP("PSJDA" global containing all of the patients allergy and adverse reaction information. COMPONENT: DSPLY VARIABLES: PSJINPT Type: Input This variable is set to 1 to identify that the call is coming from the Inpatient Meds routine. ORN Type: Input This variable is the allergy/adverse reaction number choosen from the allergy/adverse reaction screen. DFN Type: Input This is the patient's IEN number in ^DPT. TMP global Type: Output This call returns detailed information about a single allergy/adverse reaction for a patient in ^TMP("PSJAL",N,0). The variable "N" is the screen line numbers. Inpatient Meds uses this ^TMP global to display the information through ListMan. Example below. ^TMP("PSJAL",539016357,1,0) = Causative Agent: STRAWBERRIES ^TMP("PSJAL",539016357,2,0) = Severity: ^TMP("PSJAL",539016357,3,0) = Ingredients: ^TMP("PSJAL",539016357,4,0) = ^TMP("PSJAL",539016357,5,0) = VA Drug Class: ^TMP("PSJAL",539016357,6,0) = Originated: 03/10/95 Originator: ANDERSON,CURTIS ^TMP("PSJAL",539016357,7,0) = Verified: Yes OBS/Hist: OBSERVED ^TMP("PSJAL",539016357,8,0) = ^TMP("PSJAL",539016357,9,0) = Comments: ^TMP("PSJAL",539016357,10,0) = Patient reacts severly to strawberries in any naturally occurring form. ^TMP("PSJAL",539016357,11,0) = ^TMP("PSJAL",539016357,12,0) = Signs/Symptoms: HIVES ^TMP("PSJAL",539016357,13,0) = Mechanism: UNKNOWN The call returns all of a patients allergy and adverse reaction information in the ^TMP("PSJAL",N,0). The variable "N" is the screen line numbers. Inpatient Meds uses this ^TMP global to display the information through ListMan. ******************** 2212 NAME: NEW PERSON editing CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MAILMAN USAGE: Private ENTERED: OCT 29,1997 STATUS: Active EXPIRES: DEC 31,2500 DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File With patch XM*7.1*50, MailMan will be dropping phone and address fields from its MAILBOX file 3.7 and would like to let users edit, instead, various fields in the NEW PERSON file 200. The fields are: 31.3 preferred editor .111 street address 1 .112 street address 2 .113 street address 3 .114 city .115 state .116 zip .132 office phone .133 phone #3 .134 phone #4 .136 fax # .137 voice pager .138 digital pager I intend to let the user edit the fields using a FileMan call. I intend to retrieve the data by direct global reads. One global access will retrieve the record with the address fields; the other, the record with the phone numbers. I will not be retrieving the data for the preferred editor. ^VA(200,D0,.13) => phone numbers .132 OFFICE PHONE .13;2 Write w/Fileman .133 PHONE #3 .13;3 Write w/Fileman .134 PHONE #4 .13;4 Write w/Fileman .136 FAX NUMBER .13;6 Write w/Fileman .137 VOICE PAGER .13;7 Write w/Fileman .138 DIGITAL PAGER .13;8 Write w/Fileman ^VA(200,D0,.11) => address .111 STREET ADDRESS 1 .11;1 Write w/Fileman .112 STREET ADDRESS 2 .11;2 Write w/Fileman .113 STREET ADDRESS 3 .11;3 Write w/Fileman .114 CITY .11;4 Write w/Fileman .115 STATE .11;5 Write w/Fileman .116 ZIP CODE .11;6 Write w/Fileman ^VA(200,D0,1) => preferred editor 31.3 PREFERRED EDITOR 1;5 Write w/Fileman ROUTINE: ******************** 2213 NAME: XRTL SET TO FORCE RESPONSE TIME MONITORING CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: RPC BROKER USAGE: Private ENTERED: OCT 29,1997 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.1 FILE: ROOT: DESCRIPTION: TYPE: Other XRTL=1 is a flag that allows response time monitoring. It is typically set during signon based on a flag in the Kernel Site Parameter file. Because resource utilization must be monitored closely in the new client/server environment, the RPC Broker needs to NEW and SET the XTRL variable in its code. This will allow for the monitoring of all RPCs. (The README file that accompanies version 1.1 of the RPC Broker notifies IRM staff that the monitoring is being turned on.) When sufficient data has been collected the SETting of XTRL will be removed by a patch. ROUTINE: ******************** 2214 NAME: DBIA2214 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at the PATIENT ALLERGY file 120.8 for the purpose of its drug-allergy check functionality. ^GMR(120.8,D0,0) => GMR ALLERGY (0;3) 1 GMR ALLERGY 0;3 Direct Global Read & w This field is a variable pointer to help relate this allergy to some record in one of the files to which this field points. This is the PATIENT ALLERGY file. ROUTINE: ******************** 2215 NAME: INTEGRATION BILLING ACTION FILE ACCESS CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 350 ROOT: IB( DESCRIPTION: TYPE: File The Outpatient Pharmacy package requests permission to look at the INTEGRATED BILLING ACTION file 350. ^IB(D0,0) .03 ACTION TYPE 0;3 Direct Global Read & w This field points to an entry in the IB ACTION TYPE file. Entries in the IB ACTION TYPE file provide specific information about the type of entry that is being created and provides data necessary to AR to resolve the data from the application. .09 PARENT CHARGE 0;9 Direct Global Read & w This is a pointer to the original IB ACTION entry that this entry refers to. For a NEW entry it will point to itself. For all other entries it will point to the original entry. The most recent entry can be found by reading the ^IB("APDT",parent,0) cross reference. .11 AR BILL NUMBER 0;11 Direct Global Read & w The AR BILL NUMBER in external format. .12 AR TRANSACTION NUMBE 0;12 Direct Global Read & w This is the pointer value to the AR TRANSACTION file. .05 STATUS 0;5 Direct Global Read & w This is the current status of the INTEGRATED BILLING file entry. This is the INTEGRATED BILLING ACTION file 350. It is a link between ACCOUNTS RECEIVABLE and an application. Entries in this file are created by applications calling approved application specific routines. ROUTINE: ******************** 2216 NAME: DBIA2216 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: OCT 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 350.3 ROOT: IBE(350.3 DESCRIPTION: TYPE: File The Outpatient Pharmacy package requests access to the Pharmacy Copayment charge cancellation reasons that are stored in the IB CHARGE REMOVE REASONS (#350.3) file. Pharmacy needs to conduct two look-ups on this file. The first look-up allows the user to select a Pharmacy Copayment charge cancellation reason from this file. The second look-up is conducted internally by the application to find the entry RX DELETED from this file, when a prescription is deleted or returned to stock. ^IBE(350.3,D0,0) .01 NAME 0;1 Read w/Fileman The FileMan read is required to allow the user to select an entry from this file, and to find the entry RX DELETED. This reference represents an entry in this file that may be looked up by a user or the application itself. ROUTINE: ******************** 2219 NAME: DBIA2219 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY VBECS ADDED 11/27/2007 USAGE: Controlled Subscri ENTERED: NOV 3,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 100 ROOT: OR(100 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at ORDER file 100. ^OR(100, .02 OBJECT OF ORDER 0;2 Direct Global Read & w This field contains the individual object of the order. Depending on the parent file entry, this will be the Patient, Control Point, etc. 9 REPLACED ORDER 3;5 Direct Global Read & w This is the file of orders/requisitions made for any package through the ORder Entry option (OR). ROUTINE: ******************** 2220 NAME: DBIA2220 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: APR 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integration agreement to use the variables SDSTPAMB, SDIEMM, VALQUIET in the routine SCDXHLDR. SDSTPAMB prevents Scheduling/Amb Care from sending an Event Capture patient procedure to the Austin NPCD for workload credit. However, the patient procedure is still filed in the respective Scheduling/PCE files. SDIEMM is used to prevent the validation checks from executing during the Event Capture conversion completed as part of the install of EC*2*7. VALQUIET is used to prevent the validation dialogue from displaying to the user during Event Capture patient record edit processing. ROUTINE: SCDXHLDR COMPONENT: EN VARIABLES: SDSTPAMB Type: Input Variable used to prevent Scheduling/Amb Care from sending an Event Capture patient procedure (encounter) to Austin NPCD for workload credit. SDIEMM Type: Input Variable used to prevent the validation checks from executing. VALQUIET Type: Input Variable used to prevent the validation dialogue from displaying. ******************** 2221 NAME: DBIA2221 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS CLINICAL INFO RESOURCE NETWORK PHARMACY DATA MANAGEMENT USAGE: Controlled Subscri ENTERED: NOV 3,1997 STATUS: Active EXPIRES: JUN 1,2006 DURATION: VERSION: FILE: 50.607 ROOT: PS(50.607 DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSN*4*94. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of June 1, 2006. The Outpatient Pharmacy package request permission to look at DRUG UNITS file 50.607. We need the individual drug unit of a drug when building our segments for HL7 data transmission. ^PS(50.607,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the drug unit of the measure. This file contains the individual drug units. ROUTINE: ******************** 2223 NAME: DBIA2223 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 3,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 50.7 ROOT: PS(50.7 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at PHARMACY ORDERABLE ITEM file 50.7. This is a new file of Pharmacy Data Management 1.0. It is used extensively throughout our routines. We are requesting read/write access to the entire file and cross-references through direct reads/writes and VA Fileman utilities. ROUTINE: ******************** 2224 NAME: DBIA2224 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 3,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 51 ROOT: PS(51 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at MEDICATION INSTRUCTION file 51. ^PS(51, .01 NAME 0;1 Direct Global Read & w This is the name of the medication instruction. We use the 'A' cross reference to get the expanded SIG for the prescription. We use the 'B' cross reference to get the IEN of the entry in the file. 1 EXPANSION 0;2 Direct Global Read & w This is the full explanation of the medication instruction. 2 MED ROUTE 0;5 Direct Global Read & w This is a pointer to the MEDICATION ROUTES file 51.2. 3 SCHEDULE 0;6 Direct Global Read & w This field contains the prescription schedule. 9 PLURAL 9;1 Direct Global Read & w This field is used to indicate if there is a plural name for this medication instruction. 30 INTENDED USE 0;4 Direct Global Read & w This is a set of codes field used to determine how the instruction is viewed by the user. The entry may be marked for OUTPATIENT ONLY (0), for OUTPATIENT AND INPATIENT (1), or for INPATIENT ONLY (2). 31 FREQUENCY (IN MINUTE 0;8 Direct Global Read & w This is the number of minutes between each time that the action should take place. This field will be used to calculate defaults for Quantity and Days Supply in the Outpatient Pharmacy Package. It will also be used to calculate defaults for the fields in the pharmacy dialog in Computerized Patient Record System (CPRS). 1.1 OTHER LANGUAGE EXPAN 4;1 Direct Global Read & w This file holds the abbreviations which are often used when entering the prescription's SIG. Each record holds an expansion of the abbreviation. ^PS(51,'A',D0) This cross reference is used to get the drug's expanded name and plural. ^PS(51,'B',D0) This cross reference is used to obtain the expanded SIG. ROUTINE: ******************** 2225 NAME: DBIA2225 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 3,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 51.1 ROOT: PS(51.1 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at ADMINISTRATION SCHEDULE file 51.1. We use the 'B' cross reference to $Order through the file to get the expansion of the Administration Schedule for the prescription. ^PS(51.1, 8 OUTPATIENT EXPANSION 0;8 Direct Global Read & w This field contains the expansion for this Administration Schedule to be used in the Outpatient Pharmacy package. 2 FREQUENCY (IN MINUTE 0;3 Direct Global Read & w This is the number of minutes between each time that the action should take place. This file contains a set of standard times over which medications are to be administered. ^PS(51.1,'B',D0,0) .01 NAME 0;1 Direct Global Read & w This cross reference on the .01 field is used to $Order through the file to get the Outpatient Expansion for the prescription. ROUTINE: ******************** 2226 NAME: DBIA2226 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 3,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 51.2 ROOT: PS(51.2 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at MEDICATION ROUTES file 51.2. ^PS(51.2,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the route of administration for a medication. 1 ABBREVIATION 0;3 Direct Global Read & w This is an abbreviation of the medication route. 3 PACKAGE USE 0;4 Direct Global Read & w This field is used to screen out Med Routes not needed by Outpatient or Inpatient. 4 OUTPATIENT EXPANSION 0;2 Direct Global Read & w This is the Medication Route's expansion used by Outpatient Pharmacy. This file contains the medication routes. ROUTINE: ******************** 2227 NAME: DBIA2227 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP USAGE: Controlled Subscri ENTERED: NOV 4,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 54 ROOT: PS(54 DESCRIPTION: TYPE: File This Outpatient Pharmacy package request permission to look at RX CONSULT file 54. ^PS(54,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains a brief description of any medical warnings associated with the specific drug. 1 TEXT 1;0 Direct Global Read & w This is a multiple field which contains an expansion of any medical warnings associated with the specific drug. This file holds the expansion of the number codes that represent the additional warnings/consultations that may be needed for a particular drug. ^PS(54,D0,1,D1,0) .01 TEXT 0;1 Direct Global Read & w This field contains the expanded description of any medical warnings. ROUTINE: ******************** 2228 NAME: DBIA2228 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP INCOME VERIFICATION MATCH USAGE: Controlled Subscri ENTERED: NOV 14,2005 STATUS: Active EXPIRES: DEC 31,2006 DURATION: VERSION: FILE: 55 ROOT: PS(55 DESCRIPTION: TYPE: File This agreement will be retired on 12/31/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*101. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. All fields and x-refs in file 55 have global read access by the subscribing packages. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of December 31, 2006. The Outpatient Pharmacy and CMOP packages request full access to PHARMACY PATIENT file 55. This file is used extensively throughout our routines. Therefore, we request read and write access to the entire file and cross references through Fileman utilities and direct reads/writes. ROUTINE: ******************** 2229 NAME: DBIA2229 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 4,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 56 ROOT: PS(56 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at DRUG INTERACTION file 56. ^PS(56,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the name of the drug interaction. 1 INGREDIENT 1 0;2 Direct Global Read & w This is a pointer to DRUG INGREDIENTS file 50.416. It is used to store the first ingredient of the adverse drug/drug interaction. 2 INGREDIENT 2 0;3 Direct Global Read & w This is a pointer to DRUG INGREDIENTS file 50.416. It is used to store the second ingredient of the adverse drug/drug interaction. It must be different from the first ingredient. 3 SEVERITY 0;4 Direct Global Read & w This field is used to indicate the type of reaction from the interaction. It is a set of codes for Critical (1) or Significant (2). 4 NATIONALLY ENTERED 0;5 Both R/W w/Fileman This field is used to indicate if this data was sent out by the ISC. 5 TOTAL INDEXES 0;6 Direct Global R/W & w/ This field is used to store the total number of interactions for an entry. 7 INACTIVATION DATE 0;7 Direct Global Read & w This file is used to store drug-drug interactions. ^PS(56,'APD',D0,D1,0) This cross reference is used to index the file by adverse drug reactions. ROUTINE: ******************** 2230 NAME: DBIA2230 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: NOV 4,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 550 ROOT: PSX(550 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at CMOP SYSTEM file 550. ^PSX(550,D0,0) 1 STATUS 0;2 Direct Global Read & w This is a set of codes field indicating whether the status of thee facility relative to CMOP transmission is ACTIVE (A) or INACTIVE (I). This is a system parameter file for CMOP. ^PSX(550,'C',D0) This cross reference on the STATUS field will exist only if there is an active CMOP site that the remote will be transmitting CMOP Rx's to. ROUTINE: ******************** 2231 NAME: DBIA2231 CUSTODIAL PACKAGE: CMOP SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY E CLAIMS MGMT ENGINE USAGE: Controlled Subscri ENTERED: NOV 4,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 550.2 ROOT: PSX(550.2 DESCRIPTION: TYPE: File The Outpatient Pharmacy package request permission to look at CMOP TRANSMISSION file 550.2. ^PSX(550.2, 5 TRANSMISSION DATE/TI 0;6 Direct Global Read & w This field contains the date and time of the CMOP transmission. 3 CMOP SYSTEM 0;4 Read w/Fileman .01 TRANSMISSION 0;1 Read w/Fileman 1 STATUS 0;2 Read w/Fileman 2 DIVISION 0;3 Read w/Fileman 4 SENDER 0;5 Read w/Fileman 6 CREATED DATE/TIME 0;7 Read w/Fileman 7 RECEIVED DATE/TIME 1;1 Read w/Fileman 8 RETRANSMISSION # 1;2 Read w/Fileman 9 ORIGINAL TRANSMISSIO 1;3 Read w/Fileman 10 CLOSED DATE/TIME 1;4 Read w/Fileman 13 TOTAL ORDERS 1/7 Read w/Fileman 14 TOTAL RXS 1;8 Read w/Fileman This file maintains summary information of all CMOP transmissions. ^PSX(550.2,'B',D0,D1) This cross reference on the TRANSMISSION field contains the number of the CMOP transmission. ^PSX(550.2,'D',D0,D1) ^PSX(550.2,D0,15, .01 PRESCRIPTIONS 0;1 Read w/Fileman .02 FILL 0;2 Read w/Fileman .03 PATIENT 0;3 Read w/Fileman ROUTINE: ******************** 2232 NAME: Resource Device CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 5,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA describes some API's to support Resource devices. ROUTINE: XUDHSET COMPONENT: RES VARIABLES: $$RES^XUDHSET(device_name,resource_name,slot_count,description ,subtype) device_name For the resource device. resource_name (optional) The resource name if not the same as the device name. slot_count The number of concurrent jobs that can use this device. defaults to 1. description The device description, defaults to 'Resource Device'. subtype The subtype to use, defaults to P-OTHER. returns If an error '-1^text' The 'IEN^device name' like a DIC call. This call is used to setup a Resource device. ******************** 2233 NAME: DBIA2233 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX INCOMPLETE RECORDS TRACKING USAGE: Controlled Subscri ENTERED: NOV 6,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File DSS Extracts has permission to execute a direct global read to the MULTIDIVISIONAL MED CENTER? field (#43) (GL;2) in the MAS PARAMETERS file (#43). ^DG(43,D0,GL) 11 MULTIDIVISIONAL MED GL;2 Direct Global Read & w Indicates if the facility is a multi-divisional medical center. This file contains site specific parameters used by ADT Modules. ROUTINE: ******************** 2235 NAME: DBIA2235 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX EVENT CAPTURE USAGE: Private ENTERED: NOV 6,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File This agreement gives permission to execute a $Order direct global read of the 'LOC' Cross Reference on the Institution file (#4). In addition, editing of the CURRENT LOCATION field (#720) in the Institution file, using supported FileMan calls, is also allowed. Edits to this field affect the 'LOC' Cross Reference by setting or killing it as needed. ^DIC(4,'LOC' This cross reference contains the name of the institution that may be used to enter Event Capture data. ^DIC(4,'EC' 720 CURRENT LOCATION EC;1 Both R/W w/Fileman This field is used to identify if the location is one that can be used within Event Capture. ROUTINE: ******************** 2236 NAME: DBIA2236 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: APR 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integration agreement to use the function $$OKTOXMIT^SCDXFU04 to determine if Event Capture patient procedures are to be sent to the Austin NPCD for workload credit. This integration agreement is used solely by the Event Capture Patient file (#721) clean up patch, EC*2*7. ROUTINE: SCDXFU04 COMPONENT: $$OKTOXMIT(ENCDATE,COMPDATE) VARIABLES: Determine if an encounter occurring on a specified date should be transmitted to the National Patient Care Database for database and workload credit. ******************** 2237 NAME: DBIA2237 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX AUTOMATED MED INFO EXCHANGE VA CERTIFIED COMPONENTS - DSSI USAGE: Controlled Subscri ENTERED: NOV 6,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 133 ROOT: SRO(133 DESCRIPTION: TYPE: File DSS Extracts has permission to execute direct global reads of the SITE field (#.01) (0;1) and the 'B' Cross Reference on the SURGERY SITE file (#133). ^SRO(133,D0,0) .01 SITE 0;1 Direct Global Read & w This is the institution responsible for the Surgery service. If the facility is multi-divisional, there will be more than one entry in this file. The Surgery Site Parameter file contains elements to the Surgery package that may be specific to each individual site. ROUTINE: ******************** 2238 NAME: CHANGE RPC RETURN TYPE CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Use this function in the M code called by an RPC to change the return value type that the RPC will return on the fly. ROUTINE: XWBLIB COMPONENT: $$RTRNFMT(TYPE,WRAP) VARIABLES: TYPE Type: Input Set this to the RETURN VALUE TYPE to change the RPC's setting to. You can set it to one of the following numeric or free text values: numeric free text 1 SINGLE VALUE 2 ARRAY 3 WORD PROCESSING 4 GLOBAL ARRAY 5 FOR GLOBAL INSTANCE WRAP Type: Input Set to 1 to set the RPC's WORD WRAP ON setting to True; set to 0 to set the RPC's WORD WRAP ON setting to False. Format $$RTRNFMT^XWBLIB(type, wrap) Input type Set this to the RETURN VALUE TYPE to change the RPC's setting to. You can set it to one of the following numeric or free text values: numeric free text 1 SINGLE VALUE 2 ARRAY 3 WORD PROCESSING 4 GLOBAL ARRAY 5 FOR GLOBAL INSTANCE wrap Set to 1 to set the RPC's WORD WRAP ON setting to True; set to 0 to set the RPC's WORD WRAP ON setting to False. Output Return Value 0 if the return value type could not be changed; otherwise, the numeric code representing the return value type that the RPC is changed to. Example I '$$RTRNFMT^XWBLIB("ARRAY",1) D .; branch to code if can't change RPC type ******************** 2239 NAME: XWBAPVER -- RPC VERSION CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other XWBAPVER is a documented variable that will contain an RPC version if one was set in the client application (using the RPCVersion property). Otherwise XWBAPVER defaults to 0. ROUTINE: ******************** 2240 NAME: ENCRYPTING -- CLIENT/SERVER CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel and the RPC Broker provide encryption functions that can be used to encrypt messages sent between the client and the server. This function encrypts a string before transport to a Client system, where it will be decrypted. ROUTINE: XUSRB1 COMPONENT: $$ENCRYP(STRING) VARIABLES: STRING Type: Input The string that needs to be encrypted. Function performs encryption on the input string, returning the encrypted string. ******************** 2241 NAME: DECRYPTING -- CLIENT/SERVER CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Kernel and the RPC Broker provide encryption functions that can be used to encrypt messages sent between the client and the server. This function decrypts a string that was encrypted on a Client system. ROUTINE: XUSRB1 COMPONENT: $$DECRYP(ENCRIPTED_STRING) VARIABLES: ENCRYPTED_ Type: Input Function decrypts a string that has been encrypted using the Encrypt Delphi function supplied by Broker, returning the decrypted string. ******************** 2242 NAME: DBIA2242 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: IMAGING GEN. MED. REC. - VITALS USAGE: Controlled Subscri ENTERED: NOV 20,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will provide temporary entry points to routine DGSEC to enable the listed packages to update the DG SECURITY LOG when a sensitive patient has been accessed. This will be in effect until supported entry points are defined. ROUTINE: DGSEC COMPONENT: BULTIN VARIABLES: Y Type: Input Y = DFN, Pointer to the PATIENT file (#2) DGOPT Type: Input S DGOPT=$S(XQOPT<0:"^UNKNOWN",1:XQOPT) ; equals the calling option XMCHAN Type: Input Set = 1 to suppress dots printed by mailman DIC(0) Type: Input Set = $TR(DIC(0),"E") to suppress output and prompting Generate bulletin that Sensitive Patient has been accessed. COMPONENT: SETLOG VARIABLES: Y Type: Input Y = DFN, Pointer to the PATIENT file (#2) DGOPT Type: Input S DGOPT=$S(XQOPT<0:"^UNKNOWN",1:XQOPT) ; equals the calling option DG1 Type: Input Set = 1 for inpatient, = 0 for outpatient DIC(0) Type: Input Set = $TR(DIC(0),"E") to suppress output and prompting Create entry in DG SECURITY LOG of sensitive patient access. ******************** 2243 NAME: Tasking KIDS Installation CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: DEC 3,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this DBIA is to document the use of a KIDS entry point to task off a KIDS Install. This is useful if a large conversion needs to run in background while users are back on the system. For example, the first KIDS build can install a new version of software, then task off a second clean-up/conversion build. This allows users back on the system because the new version install completes and unlocks options and protocols. Meanwhile the clean-up runs in background under KIDS and makes use of KIDS checkpoints, restart upon failure, and message logging that can later be accessed in the Install File Print. ROUTINE: XPDIJ COMPONENT: EN VARIABLES: XPDA Type: Input Internal entry number of the build to be tasked in the Install file #9.7 The KIDS entry point EN^XPDIJ can be used with XPDA defined to task off a KIDS install. ******************** 2244 NAME: PATIENT REPRESENTATIVE CUSTODIAL PACKAGE: QUALITY ASSURANCE INTEGRATION SUBSCRIBING PACKAGE: PATIENT REPRESENTATIVE USAGE: Private ENTERED: DEC 4,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 740 ROOT: QA( DESCRIPTION: TYPE: File I am the developer for the Quality Assurrance packages. I had previouly gotten an agreement to use two fields in the QA Site Parameter file (#740) to keep multi-divisional information fot the Patient Representative package. The Integration agreement is #2073. File 740 is part of the Integration Module. Both of these packages are in the Quality Assurrance group, the agreements are to keep a documentation trail. It turns out that the two fields in the agreement (741.1 and 741.11) are on the "OS" nodes, which are still being used by some stations for Occurrance Screening. I have decided to create comparable fields on the "QAC" nodes to provide the same functionality. The new fields are #749 MULTI-DIVISIONAL PAT REP FACILITY #750 PAT REP HOSPITAL DIVISION ^QA(740,D0,'QAC') 749 MULTI-DIVISIONAL PAT QAC;3 Read w/Fileman ^QA(740,D0,'QAC2', 750 PAT REP HOSPITAL DIV QAC2;0 Read w/Fileman Multiple for division within an NDBI group. ROUTINE: ******************** 2245 NAME: DBIA2245 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: DEC 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Outpatient Pharmacy requests permission to pass an internal entry number from the SERVICE/SECTION File (#49) to Integrated Billing, and have a flag returned that indicates if the service can be used for Copay billing in Outpatient Pharmacy. ROUTINE: IBARX1 COMPONENT: $$SERV(Y) VARIABLES: Y Type: Input Pointer to the SERVICE/SECTION File (#49) associated with the Outpatient Site. PSOIBST Type: Output Indicates if the SERVICE/SECTION is valid for Copay Billing, 1 for yes, 0 for no. This entry point is used to determine if the Service/Section pointer associated with the Outpatient Site is valid for Outpatient Copay billing. ******************** 2246 NAME: DBIA2246 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: JAN 7,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File Inpatient Medications requests permission to $O through the OPTION file (#19), "B" cross reference. We also request Write access by VA FileMan to the OUT OF ORDER MESSAGE field (#2). In version 5.0, this code is used to disable options during the pre install routine and enable them in the post install routine. The group of options that deal with Pick Lists are inactivated during the pre install routine. The options cannot be enabled until the end of the Pick List conversion, which is hours after the KIDS install finishes. The last task of the Pick List conversion routine is to enable the Pick List options again. This is needed to keep the users from processing any Pick Lists until the conversion is completely finished. Making the edit to the OUT OF ORDER MESSAGE FIELD seems to be the only way to accomplish this job. ^DIC(19,#,0) 2 OUT OF ORDER MESSAGE 0;3 Write w/Fileman Use ^DIE to edit this field. ROUTINE: ******************** 2247 NAME: DBIA-2247 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP USAGE: Controlled Subscri ENTERED: DEC 9,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 3.2 ROOT: %ZIS(2 DESCRIPTION: TYPE: File Outpatient Pharmacy package request permission to look at TERMINAL TYPE file 3.2. ^%ZIS(2,D0,BAR0) 61 BAR CODE OFF BAR0;E1, Direct Global Read & w The argument of a MUMPS WRITE statement that will turn off bar code printing mode of a device. This file is pointed to by the Subtype field of the Device file. It holds attributes that charaterize a terminal type. ^%ZIS(2,D0,BAR1) 60 BAR CODE ON BAR1;E1, Direct Global Read & w The argument of a MUMPS WRITE statement that will turn on bar code printing mode of a device. ROUTINE: ******************** 2248 NAME: DBIA 2248 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX DSS EXTRACTS use the result of ACTIVE^DGACT will be used to determine if a Facility Treating Specialty should be reported on DSS reports. ORDER ENTRY/RESULTS REPORTING ADDED 5/20/2010 LAB SERVICE added 4/3/2007 VA POINT OF SERVICE (KIOSKS) To implement the ORWPT SELECT functionality in the VPS namespace, VPS is subscribing to ICR 2248. This will allow VPS to call TSDATA^DGACT as is currently done by ORWPT SELECT and to obtain active facility treating specialty/specialties. VIRTUAL PATIENT RECORD HMP team added the call to TSDATA~DGACT to their demogaphic update. VPR needs the data returned from this call as well as ensuring the selected specialty is still active. HEALTH MANAGEMENT PLATFORM Routine HMPDJ00 calls this API in order to retrieve data for the Treating Specialty from the Treating Specialty file (#45.7) and the Specialty file (#42.4) if the file exists. ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: DEC 12,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement gives permission to use registration software to determine Facility Treating Specialty file (#45.7) and Specialty file (#42.4) properties. Line tag ACTIVE^DGACT will determine if a Facility Treating Specialty or Specialty is active on a specific date. Line tag TSDATA^DGACT returns Facility Treating Specialty or Specialty; whether the node exits, active on a specific date, associated properties. ROUTINE: DGACT COMPONENT: ACTIVE VARIABLES: DSS has permission to call ACTIVE^DGACT passing in three arguments. Argument 1: File number 45.7 or 42.4 Argument 2: IEN of the Facility Treating Specialty or Specialty Argument 3: Date to check the active/inactive status of the treating speciality DSS expects ACTIVE^DGACT to return the following result: 1 if the Facility Treating Speciality was active on the given date 0 if the Facility Treating Speciality was inactive on the given date An example of how this tag may be referenced: S ACTVAL=$$ACTIVE^DGACT(45.7,ECXSPIEN,DT) COMPONENT: TSDATA VARIABLES: Subscriber has permission to call TSDATA^DGACT passing in three, optionally four arguments. Argument 1: File number 45.7 or 42.4 Argument 2: IEN of Facility Treating Specialty or Specialty Files Argument 3: Array variable used to return entry properties Argument 4: Date to check the active/inactive status of the treating specialty (optional, if no date is passed, the current date will be used) Subscriber expects TSDATA^DGACT to return the following results: 1 if the Treating Specialty exists. -1 if the Treating Specialty does not exist. If the Teating Specialty exists, return array: ARRAY(0) := 1 if Treating Specialty was active on the given date. 0 if Treating Spdcialty was not active on the given date. If Argument 1 = 45.7 ARRAY(1) := Name of Facility Treating Specialty ARRAY(2) := Specialty ptr to 42.4 File^Specialty Name ARRAY(3) := Abbreviaton ARRAY(4) := Service ptr to 49 File^Service name If Argument 1 = 42.4 ARRAY(1) := Name of Specialty ARRAY(2) := Print Name ARRAY(3) := Service (set of codes value)^Service name ARRAY(4) := Ask Psychiatric Question? (set of codes value)^null,yes,or no. ARRAY(5) := Billing Rate Bedsection^ ARRAY(6) := MPCR Account ARRAY(7) := PTF Code (alpha-numeric) An example of how this tag may be referenced: S ACTVAL=$$TSDATA^DGACT(45.7,124,.DATA) S ACTVAL=$$TSDATA^DGACT(45.7,124,.DATA,3071002) S ACTVAL=$$TSDATA^DGACT(42.4,100,.DATA) S ACTVAL=$$TSDATA^DGACT(42.4,100,.DATA,3071002) ******************** 2249 NAME: DBIA-2249 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: DEC 9,1997 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Outpatient Pharmacy package request permission to read the 'AMV1' and 'APTT1' cross references of REGISTRATION file 405. ^DGPM('AMV1' This file holds data for all admissions, transfers, discharges, treating specialty changes, and lodger movements. ^DGPM('APTT1' ROUTINE: ******************** 2250 NAME: DBIA2250 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: DEC 9,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49, DESCRIPTION: TYPE: File Outpatient Pharmacy requests permission to access data in the SERVICE/SECTION (#49) file. One use will be to loop through the file to retrieve internal entry numbers to be used for a call to Integrated Billing to find the correct entry necessary to process Co-pay prescriptions in Pharmacy. Another will be to access the names of the file entries in order to provide complete demographic information for an outpatient site through the Pharmacy Reengineering APIs. ^DIC(49,DA Outpatient needs the Internal numbers of entries in this file to determine the correct entry for generating Pharmacy Copay charges. ^DIC(49, .01 NAME 0;1 Direct Global Read & w Outpatient needs the Internal numbers of entries in this file to determine the correct entry for generating Pharmacy CoPay charges. ROUTINE: ******************** 2251 NAME: DBIA-2251 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY SCHEDULING CLINICAL REMINDERS EVENT CAPTURE ADDED 2/28/2012 USAGE: Controlled Subscri ENTERED: AUG 25,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 4 ROOT: DIC(4 DESCRIPTION: TYPE: File Outpatient Pharmacy package request permission to look at INSTITUTION file 4 to get the Institution name and/or station number. ^DIC(4, .01 NAME 0;1 Direct Global Read & w This is the name of the Institution. 99 STATION NUMBER 99;1 Direct Global Read & w 5 MULTI-DIVISION FACIL DIV;1 Direct Global Read & w This file contains a listing of VA institutions. ROUTINE: ******************** 2252 NAME: DBIA2252 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: DEC 16,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 7 ROOT: DIC(7, DESCRIPTION: TYPE: File This request is so that the Laboratory Package to be able to read from the ^DIC(7, global. The purpose of this would be to take the second piece of the zero node, ^DIC(7,D0,0)= (#.01) NAME [1F] ^ (#1) ABBREV. TITLE [2F] ^ to append onto the Pathologist's Name on the various Pathology reports. This should be a temporary request and can be revisited when the Anatomic Pathology reports incorporate electronic signature. ROUTINE: ******************** 2253 NAME: DBIA2253 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 55.06 ROOT: DD(55.06, DESCRIPTION: TYPE: File Inpatient Medications requests permission to call routine ^DIC with the variable DIC defined as "^DD(55.06," and DIC(0)="QEM" or DIC(0)="QE". This will perform a lookup on the field names of a particular file and return the needed variables. This is used in our routines to allow a user to up-arrow jump to another field during the editing of an order. Example: The user is editing an order and enters "^STA". The ^DIC lookup is performed, finds the START DATE field, and returns the field's internal entry number. That number is then used to go to the appropriate code to edit that field. ROUTINE: DIC ******************** 2255 NAME: DBIA2255 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 30,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File Inpatient Medications requests direct read access to pharmacy files node ^DD(file #,field #,12). We are reading from this node to return the POINTER SCREEN description. ^DD(file #,field #,12) 12 POINTER SCREEN Direct Global Read & w Pointer Screen description for the field. ROUTINE: ******************** 2256 NAME: DBIA2256 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: DEC 31,1997 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.1 ROOT: DD(53.1 DESCRIPTION: TYPE: File Inpatient Medications requests permission to call routine ^DIC with the variable DIC defined as "^DD(53.1," and DIC(0)="QEM". This will perform a lookup on the field names of a particular file and return the needed variables. This is used in our routines to allow a user to up-arrow jump to another field during the editing of an order. Example: The user is editing an order and enters "^STA". The ^DIC lookup is performed, finds the START DATE field, and returns the field's internal entry number. That number is then used to go to the appropriate code to edit that field. ROUTINE: ******************** 2257 NAME: DBIA2257 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: JAN 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call INPAT^PSOBUILD. This entry point is used to display a patient's current Outpatient medications. Input variable: PSODFN Output variable: ROUTINE: PSOBUILD COMPONENT: INPAT VARIABLES: PSODFN Type: Input Patient's IEN in ^DPT(. This entry point will display a patient's current Outpatient Medications. ******************** 2258 NAME: DBIA2258 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: JAN 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call ^PSOVWI (Outpatient Pharmacy). This entry point is used to display a Pharmacy intervention in a captioned format. ROUTINE: PSOVWI COMPONENT: PSOVWI (top of routine) VARIABLES: PSOVWI Type: Input PSOVWI("DIC"). The global root for DIC. This entry point is used to display a Pharmacy intervention in a captioned format. ******************** 2259 NAME: DBIA2259 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: JAN 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Inpatient Medications requests permission to use the following Outpatient Pharmacy templates. These templates are used by Inpatient Medications to Enter, Edit, and Print Pharmacy interventions. Input Template [PSO INTERVENTION EDIT] [PSO INTERVENTION NEW] Print Template [PSO INTERVENTIONS] Sort Template [PSO INTERVENTIONS] These templates are used by the following Inpatient Medication protocols: PSJ LM INTERVENTION EDIT PSJ LM INTERVENTION NEW ENTRY PSJ LM INTERVENTION PRINTOUT PSJ LM INTERVENTION VIEW ROUTINE: COMPONENT: PSO INTERVENTIONS VARIABLES: This print and sort template is used to print Pharmacy Interventions for a certain date range. COMPONENT: PSO INTERVENTION NEW VARIABLES: This input template is used to enter Pharmacy Interventions. COMPONENT: PSO INTERVENTION EDIT VARIABLES: This input template is used to edit already existing Pharmacy Interventions. ******************** 2260 NAME: DBIA1030-D CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: VENDOR - AUDIOFAX, INC. VENDOR - TECHPRO SYSTEMS INC USAGE: Controlled Subscri ENTERED: JAN 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point is used to build an Outpatient prescription profile for a patient. The profile is returned in the form of an array, named PSOSD. ROUTINE: PSORX1 COMPONENT: PROFILE VARIABLES: PSODFN Type: Input This is the internal entry number of the patient. This variable will be unchanged in this component. PSOSD Type: Output This is the array which contains the current prescriptions for the patient. It also contains current Pending orders that are in the PENDING OUTPATIENT ORDERS File (#52.41) for the patient. The variable PSOSD will be equal to the number of entries in the array. The pieces of the array are described after the following 2 examples. PSOSD("ACTIVE","CEFOPERAZONE 1GM INJ")=2050^5^^Z^AM103^10^820A1^30^ PSOSD("PENDING","METYRAPONE 250GM TAB")=*****^17^Z^Z^DX900^0^1132A1^90^29712 12.121545^1068^128 The first example, for CEFOPERAZONE 1GM INJ, is an active prescription. The pieces are as follows: Piece 1 - Internal number from the PRESCRIPTION File (#52). Piece 2 - Status code from the Status field of the PRESCRIPTION File (#52). Piece 3 - Free text set of characters used for different classifications of the drug (not applicable to the functions of this agreement). Piece 4 - Free text set of characters used to identify site parameters and drug characteristics. Piece 5 - VA classification of the drug. Piece 6 - Refills remaining for the prescription. Piece 7 - National Drug File information, in the form of National Drug File entry_"A"_VA Product Name entry. Piece 8 - Days supply of the prescription. The second example, for METYRAPONE 250MG TAB, is a Pending Outpatient ordered, not yet finished. The pieces are as follows: Piece 1 - Always ***** for a Pending order. Piece 2 - Always 17 for a Pending order. (Indicates Pending order status) Piece 3 - Always Z for a Pending order. Piece 4 - Always Z for a Pending order. Piece 5 - VA classification of the drug. Piece 6 - Number of refills requested by the ordering person. Piece 7 - National Drug File information, in the form of National Drug File entry_"A"_VA Product Name entry. Piece 8 - Quantity requested by the ordering person. Piece 9 - Effective date of the order. Piece 10 - Internal entry number from the PENDING OUTPATIENT ORDERS File (#52.41). Piece 11 - Internal entry number from the DRUG File (#50). This entry point returns an Outpatient prescription profile in the form of a PSOSD array. ******************** 2261 NAME: Print Med Instruction Sheet CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: JAN 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA will be used in the Outpatient Pharmacy package to print medication instruction sheets. ROUTINE: PSNPPIP COMPONENT: PSNPPIP VARIABLES: The top level entry point will be used to allow any instruction sheet to be printed for any selected drug. The user will be prompted for a drug name. COMPONENT: ENOP VARIABLES: DRUG IEN Type: Input Internal entry number of drug from file 50. Trade Name Type: Used This free text variable is printed as part of the header info. on the medication instruction sheet. PSNPPI("ME Type: Output This variable is only returned if there's no information available to print on the drug entered/selected. If this variable is returned the message will be diplayed to the user and killed after display. Rx Number Type: Used This variable is used to print the Rx number as part of the header. PSODFN Type: Used This variable is passed as the internal entry for the patient from file #2. This entry point will be used to pass in an internal number of a drug. The ENOP is an entry point where variables are passed. Variables: Drug IFN - required Trade Name - optional Internal Rx number - optional Patient's IFN - optional ******************** 2263 NAME: SUPPORTED PARAMETER TOOL ENTRY POINTS CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Parameter Tools is a generic method of handling parameter definition, assignment, and retrieval. A parameter may be defined for various entities where an entity is the level at which you want to allow the parameter defined (e.g. package level, system level, division level, location level, user level, etc.). A developer may then determine in which order the values assigned to given entities are interpreted. The following are some basic definitions used by Parameter Tools: Entity: ======= An entity is a level at which you can define a parameter. The entities allowed are stored in the Parameter Entity file (#8989.518). The list of allowable entities at the time this utility was released were: Prefix Message Points to File ------- ---------- ------------------------ PKG Package Package (9.4) SYS System Domain (4.2) DIV Division Institution (4) SRV Service Service/Section (49) LOC Location Hospital Location (44) TEA Team Team (404.51) CLS Class Usr Class (8930) USR User New Person (200) BED Room-Bed Room-Bed (405.4) OTL Team (OE/RR) OE/RR List (101.21) (Note: entries will be maintained via ToolKit patches. Entries existing in the file at the time it is referenced are considered supported.) Parameter: ========== A parameter is the actual name which values are stored under. The name of the parameter must be namespaced and it must be unique. Parameters can be defined to store the typical package parameter data (e.g. the default add order screen in OE/RR), but they can also be used to store GUI application screen settings a user has selected (e.g. font or window width). When a parameter is defined, the entities which may set that parameter are also defined. The definition of parameters is stored in the PARAMETER DEFINITION file (#8989.51). Value: ====== A value may be assigned to every parameter for the entities allowed in the parameter definition. Values are stored in the PARAMETERS file (#8989.5). Instance: ========= Most parameters will set instance to 1. Instances are used when more than one value may be assigned to a given entity/parameter combination. An example of this would be lab collection times at a division. A single division may have multiple collection times. Each collection time would be assigned a unique instance. Parameter Template: =================== A parameter template is similar to an input template. It contains a list of parameters that can be entered through an input session (e.g. option). Templates are stored in the Parameter Template file (#8989.52). Entries in this file must also be namespaced. This integration agreement defines the callable entry points in routine XPAR. ROUTINE: XPAR COMPONENT: EN(Entity,Parameter,Instance,Value,.Error) VARIABLES: Entity Type: Input REQUIRED The entity may be set to: 1) the internal variable pointer (nnn;GLO(123,) 2) the external format of the variable pointer using the 3 character prefix (prefix.entryname) or 3) the prefix alone to set the parameter based on current entity selected. This will work for the following entities: "USR" - uses current value of DUZ "DIV" - uses current value of DUZ(2) "SYS" - uses system (domain) "PKG" - uses the package to which the parameter belongs Parameter Type: Input REQUIRED Identifies the name or internal entry number of the parameter as defined in the PARAMETER DEFINITION file (#8989.51). Instance Type: Input OPTIONAL (defaults to 1 if not passed in) May be passed in external or internal format. Internal format requires that the value be preceded by the ` character). Value Type: Input REQUIRED May be passed in external or internal format. If using internal format for a pointer type parameter, the value must be preceded with the ` character.). If the value is being assigned to a word processing parameter, the text may be passed in the subordinate nodes of Value (e.g. Value(1,0)=Text) and the variable Value itself may be defined as a title or description of the text. Error Type: Output OPTIONAL If used, must be passed in by reference. It will return any error condition which may occur. If no error occurs, the value assigned will be 0 (zero). If an error does occur, it will be in the format: "#^errortext". This entry point will: 1) add the value as a new entry to the Parameters file if the Entity/Parameter/Instance combination does not already exist. 2) change the value assigned to the parameter if the Entity/Parameter/Instance combination already exists. or 3) delete the parameter instance if the value assigned is "@". COMPONENT: ADD(Entity,Parameter,Instance,Value,.Error) VARIABLES: Entity Type: Input Parameter Type: Input Instance Type: Input Value Type: Input Error Type: Output This entry point can be called to add a new parameter value. For definition of input and output variables, see component EN description. COMPONENT: CHG(Entity,Parameter,Instance,Value,.Error) VARIABLES: Entity Type: Input Parameter Type: Input Instance Type: Input Value Type: Input Error Type: Output This entry point can be called to change an existing parameter value. For definition of input and output variables, see component EN description. COMPONENT: DEL(Entity,Parameter,Instance,.Error) VARIABLES: Entity Type: Input Parameter Type: Input Instance Type: Input Error Type: Output This entry point can be called to delete an existing parameter value. For definition of input and output variables, see component EN description. COMPONENT: NDEL(Entity,Parameter,.Error) VARIABLES: This entry point can be called to delete the value for all instances of a parameter for a given entity. For definition of input and output variables, see component EN description. COMPONENT: REP(Entity,Parameter,CurrentInstance,NewInstance,.Error) VARIABLES: Entity Type: Input See EN^XPAR component for description. Parameter Type: Input See EN^XPAR component for description. CurrentIns Type: Input REQUIRED: The instance for which the value is currently defined. NewInstanc Type: Input REQUIRED The instance for which you want to assign the value currently assigned to CurrentInstance. Error Type: Output See EN^XPAR component for description. This entry point will allow a developer to replace the value of an instance with another value. COMPONENT: $$GET(Entity,Parameter,Instance,Format) VARIABLES: Entity Type: Input Entity is defined as the single entity or group of entities you want to look at in order to retrieve the value. Entities may be passed in internal or external format (e.g. LOC.PULMONARY or LOC.'57 or 57;SC(). The list of entities in this variable may be defined as follows: 1) a single entity to look at (e.g. LOC.PULMONARY). 2) the word "ALL" which will tell the utility to look for values assigned to the parameter using the entity precedence defined in the PARAMETER DEFINITION file. 3) A list of entities you want to search (e.g. "USR^LOC^SYS^PKG"). The list is searched from left to right with the first value found returned. 4) Items 2 or 3 with specific entity values referenced such as: ALL^LOC.PULMONARY - to look at the defined entity precedence, but when looking at location, only look at the PULMONARY location. USR^LOC.PULMONARY^SYS^PKG - to look for values for all current user, PULMONARY location, system, or package). Parameter Type: Input REQUIRED Identifies the name or internal entry number of the parameter as defined in the PARAMETER DEFINITION file (#8989.51). Instance Type: Input OPTIONAL (defaults to 1 if not passed in) May be passed in external or internal format. Internal format requires that the value be preceded by the ` character). Format Type: Input OPTIONAL - defaults to "Q" if not defined Format determines how the value is returned. It can be set to the following: 1) "Q" - returns the value in the quickest manner - internal format 2) "E" - returns external value 3) "I" - returns internal value 4) "B" - returns internal^external value This call will allow you to retrieve the value of a parameter. The value is returned from this extrinsic function in the format defined by the variable Format (see below). COMPONENT: GETLST(.List,Entity,Parameter,Format,.Error[,gbl]) VARIABLES: List Type: Output The array passed as List will be returned with all of the possible values assigned to the parameter. See variable description for Format to see how this data can be returned. If the parameter gbl is set to one, Then this parameter becomes a input and holds the closed root of a global where GETLST should put the output. e.i. $NA(^TMP($J,"XPAR")). Entity Type: Input See description of this variable under $$GET component. Parameter Type: Input See description of this variable under $$GET component. Error Type: Output Returns 0 if no error was encountered or returns an error code in the format #^errortext. Format Type: Input This variable defines how the data is returned from this call. The data will be returned in the array specified by the variable List. Possible values for Format are: 1) "Q" List(#)=internal instance^internal value 2) "I" List(internal instance)=internal value 3) "E" List(#)=external instance^external value 4) "B" List(#,"N")=internal instance^external instance List(#,"V")="internal value^external value 5) "N" List(external instance)=internal value^external value gbl Type: Input If this optional variable is set to 1. Then the parameter List must be set before the call to the closed global root where the return data should be put. e.i. GETLST^XPAR($NA(^TMP($J)),ent,par,fmt,.error ,1) This entry point is similar to $$GET^XPAR, but this will return ALL instances of a parameter. COMPONENT: GETWP(.ReturnedText,Entity,Parameter,Instance,.Error) VARIABLES: ReturnedTe Type: Both This variable is defined as the name of an array in which you want the text returned. .ReturnedText will be set to the title, description, etc. The actual word processing text will be returned in ReturnedText(#,0). Example: ReturnedText="Select Notes Help" ReturnedText(1,0)="To select a progress note from the list, " ReturnedText(2,0)="click on the date/title of the note." Entity Type: Input See description of variable under $$GET call. Parameter Type: Input See description of variable under $$GET call. Instance Type: Input See description of variable under $$GET call. Error Type: Output See description of this variable under the GETLST component. This call returns word processing text in ReturnedText. ReturnedText itself contains the value field, which is free text that may contain a title, description, etc. The word processing text is returned in ReturnedText(#,0). COMPONENT: ENVAL(.List,Parameter,Instance,.Error[,gbl]) VARIABLES: List Type: Output If the parameter gbl is set to one, Then this parameter becomes a input and holds the closed root of a global where GETLST should put the output. e.i. $NA(^TMP($J,"XPAR")). Parameter Type: Input (required) See description of variable under EN^XPAR() call. Instance Type: Input (required) See description of variable under EN^XPAR() call. Error Type: Output (optional) See description of variable under EN^XPAR() call. gbl Type: Input If this optional variable is set to 1. Then the parameter List must be set before the call to the closed global root where the return data should be put. e.i. S LIST=$NA(^TMP($J)) ENVAL^XPAR(LIST,par,inst,.error,1) This entry point will return all parameter instances. See GETLST and $$GET for a definition of input and output variables to this call. COMPONENT: PUT(Entity,Parameter,Instance,Value,.Error) VARIABLES: Entity Type: Input (required) See description of variable under EN^XPAR() call. Parameter Type: Input (required) See description of variable under EN^XPAR() call. Instance Type: Input (optional) See description of variable under EN^XPAR() call. Value Type: Input (required) See description of variable under EN^XPAR() call. Error Type: Output (optional) See description of variable under EN^XPAR() call. This entry point can be called to add or update a parameter instance and bypass the input transforms. ******************** 2264 NAME: DBIA2264 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: JAN 12,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 3.7 ROOT: XMB(3.7, DESCRIPTION: TYPE: File Clinical Reminders (PCE) would like to use : ^XMB(3.7,"M",XMZ,XMDUZ,BASKET,NUMBER) as part of a DIC lookup screen in an application that lets sites exchange reminder definitions via MailMan messages. The lookup is done on ^XMB(3.9) and the screen is used to filter out messages that have been deleted i.e., they are not in a basket. ^XMB(3.7,M,XMZ,XMDUZ,BASKET,NUMBER) ROUTINE: ******************** 2265 NAME: Rad/Nuc Med return report narrative text (exam) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 20,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: SEE WARNING FILE: ROOT: DESCRIPTION: TYPE: Routine EN3^RAO7PC1 can be used to return report narrative text associated with a patient's exam. *************************************************************************** ***************** REASON FOR STUDY data will NOT be available until AFTER ***************** the release of patch RA*5.0*75 by the RADIOLOGY product. *************************************************************************** ROUTINE: RAO7PC1 COMPONENT: EN3(X) VARIABLES: ** Please note that REASON FOR STUDY data will not be captured until the release of RA*5.0*75 ** EN3^RAO7PC1(X) Input: X = 'X' can assume one of two values: the first retrieves a single report for a single exam. Passed in as: Patient's DFN^inverse exam date/time^Case IEN (delimited by '^') If report(s) for a set of exams are requested, the input value for 'X' will not contain a Case ien value. Passed in as: Patient's DFN^inverse exam date/time (delimited by '^') Output: ^TMP($J,"RAE2",patient IEN,case IEN,procedure name)=report status^abnormal flag^CPRS Order IEN subscripts ---------- Patient IEN: IEN of the patient in both the Rad/Nuc Med Patient file #70 and the Patient file #2. Case IEN: IEN of the exam this data is extracted from. Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure prior to the exam reaching a 'COMPLETE' status. array value (in ascending piece position) ----------------------------------------- Report Status: External name of the report status. Possible statuses include: DRAFT, PROBLEM DRAFT, RELEASED/NOT VERIFIED, VERIFIED and NO REPORT. It is possible for the exam to have a report ien, but a 'NO REPORT' status if a stub report record was created to contain a pointer to the Imaging package file of images. Abnormal Alert Flag: Will be set to "Y" if the Primary Dx Code or Secondary Dx Code (if any) associated with this exam specifies that an Abnormal Alert be generated. Will be null if present Dx Codes do not specify Abnormal Alert generation. CPRS Order IEN: This is a pointer data type that indicates the record number of the order in the Order Entry/Results Reporting (OE/RR) package. This piece will be non-null if the OE/RR package is running and the Radiology/Nuclear Medicine package is available through OE/RR. Additional output ----------------- Note: The subscripts used in these data arrays are used in the data globals listed below. For subscript definitions, check section called 'subscripts' listed above. ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"D",n) Array Value ----------- Diagnostic code (n=1, this is the primary Dx returned in a brief text format) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"H",n) Array Value ----------- Clinical History (a line of text) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"I",n) Array Value ----------- Impression Text (a line of text) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"M",n) Array Value ----------- Modifier(s) (external format) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"R",n) Array Value ----------- Report Text (a line of text) ^TMP($J,"RAE2",Patient IEN,case IEN,procedure name,"RFS") Array Value ----------- Reason for Study (a line of text) ^TMP($J,"RAE2",Patient IEN,case IEN,procedure name,"CM",n) Array Value ----------- If applicable, the contrast media used during exam. Format: internal value^external value ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"V") Array Value (in ascending piece position) -------------------------------- Verifier ien: Internal entry number of the physician verifying the report. Signature Block Name: The name of the user as they wish it to appear with the notation that they signed the document electronically. ^TMP($J,"RAE2",patient ien,"PRINT_SET") Array Value ----------- Null (exists iff this is a printset) ^TMP($J,"RAE2",patient ien,"ORD") Array Value ----------- Name of ordered parent procedure for examsets and printsets. ^TMP($J,"RAE2",patient ien,"ORD",case ien) Array Value ----------- Name of ordered procedure, this may differ from the procedure registered. This global will be defined when the ordered procedure is not a parent procedure. (Not an examset or printset) ^TMP($J,"RAE2",patient ien,case ien,procedure name,"TCOM",1) Array value ----------- most recent technologist comment for this case ******************** 2266 NAME: Rad/Nuc Med return report narrative text (order) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: SEE ALERT FILE: ROOT: DESCRIPTION: TYPE: Routine EN30^RAO7PC1 can be used to return report narrative text associated with a patient's order. *************************************************************************** ***************** REASON FOR STUDY data will NOT be available until AFTER ***************** the release of patch RA*5.0*75 by the RADIOLOGY product. ************************************************************************* ROUTINE: RAO7PC1 COMPONENT: EN30(RAOIFN) VARIABLES: ** Please note that REASON FOR STUDY data will not be captured until the release of RA*5.0*75 ** EN30^RAO7PC1(RAOIFN) Input: RAOIFN = Internal entry number (IEN) of the order requested. Output: ^TMP($J,"RAE2",patient IEN,case IEN,procedure name)=report status^abnormal flag^CPRS Order IEN subscripts ---------- Patient IEN: IEN of the patient in both the Rad/Nuc Med Patient file #70 and the Patient file #2. Case IEN: IEN of the exam this data is extracted from. Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure prior to the exam reaching a 'COMPLETE' status. array value (in ascending piece position) ----------------------------------------- Report Status: External name of the report status. Possible statuses include: DRAFT, PROBLEM DRAFT, RELEASED/NOT VERIFIED, VERIFIED and NO REPORT. It is possible for the exam to have a report ien with a 'NO REPORT' status. A 'NO REPORT' status refers to a stub report that was created for the Imaging package file of images, this stub report record has no data entered by Radiology/Nuclear Medicine staff. Abnormal Alert Flag: Will be set to "Y" if the Primary Dx Code or Secondary Dx Code (if any) associated with this exam specifies that an Abnormal Alert be generated. Will be null if present Dx Codes do not specify Abnormal Alert generation. CPRS Order IEN: This is a pointer data type that indicates the record number of the order in the Order Entry/Results Reporting (OE/RR) package. This piece will be non-null if the OE/RR package is running and the Radiology/Nuclear Medicine package is available through OE/RR. Additional output ----------------- Note: The subscripts used in these data arrays are used in the data globals listed below. For subscript definitions, check section called 'subscripts' listed above. ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"D",n) Array Value ----------- Diagnostic code (n=1, this is the primary Dx returned in a brief text format) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"H",n) Array Value ----------- Clinical History (a line of text) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"I",n) Array Value ----------- Impression Text (a line of text) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"M",n) Array Value ----------- Modifier(s) (external format) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"R",n) Array Value ----------- Report Text (a line of text) ^TMP($J,"RAE2",Patient IEN,case IEN,procedure name,"RFS") Array Value ----------- Reason for Study (a line of text) ^TMP($J,"RAE2",Patient IEN,case IEN,procedure name,"CM",n) Array Value ----------- If applicable, the contrast media used during exam. Format: internal value^external value ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"V") Array Value (in ascending piece position) -------------------------------- Verifier IEN: IEN of the physician verifying the report. Signature Block Name: The name of the user as they wish it to appear with the notation that they signed the document electronically. ^TMP($J,"RAE2",patient IEN,"PRINT_SET") Array Value ----------- Null (exists iff this is a printset) ^TMP($J,"RAE2",patient IEN,"ORD") Array Value ----------- Name of ordered parent procedure for examsets and printsets. ^TMP($J,"RAE2",patient IEN,"ORD",case IEN) Array Value ----------- Name of orderer procedure, this may differ from the procedure registered. This global will be defined when the ordered procedure is not a parent procedure. (Not an examset or printset) ^TMP($J,"RAE2",patient IEN,case IEN,procedure name,"TCOM",1) Array value ----------- most recent technologist comment for this case ******************** 2267 NAME: Rad/Nuc Med return imaging location information CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine EN4^RAO7PC1 can be used to return a list of valid, active imaging locations within a particular imaging type. ROUTINE: RAO7PC1 COMPONENT: EN4(RABBRV,RAARY) VARIABLES: EN4^RAO7PC1(RABBRV,RAARY) Input: RABBRV = The abbreviation of the imaging type as it appears in the Imaging Type file #79.2. (Examples: ANI, CARD, CT, MAM, MRI, NM, RAD US and VAS) RAARY = This is the local array name in which the subscribing package would like the data returned. Returns a list of valid, active imaging locations associated with a specific imaging type. Output: local_array_name(file #79.1 ien)=ien Imaging Locations file #79.1^Hospital Location Name^ien Rad/Nuc Med Division file #79^ Division Name (from file #4) subscripts ---------- file #79.1 ien: The internal entry number of the record in the Imaging Locations file. array value (in ascending order) -------------------------------- ien Imaging Locations file #79.1: The internal entry number of the record in the Imaging Locations file. Hospital Location Name: The name of the Hospital Location. This is derived from the Imaging Locations file #79.1 entry. The Imaging Locations file #79.1 points to the Hospital Location file #44. ien Rad/Nuc Med Division file #79: The internal entry number of the record in the Rad/Nuc Med Division file. Division Name: The name of the Rad/Nuc Med Division. The Rad/Nuc Med Division file points to the Institution file #4. The division name is taken from the Institution file. The Rad/Nuc Med Division file #79 is DINUMED to the Institution file #4. ******************** 2268 NAME: Rad/Nuc Med exam case numbers linked to an order CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Supported ENTERED: JAN 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CASE^RAO7PC1 is an extrinsic function that can be used to retrieve the exam case numbers associated with an order. It returns the case numbers, the total number of exams linked to the order, and a flag indicating whether these exams are linked to a single report. ROUTINE: RAO7PC1 COMPONENT: CASE(RAOIFN,RARRAY) VARIABLES: CASE^RAO7PC1(RAOIFN,RARRAY) Input: RAOIFN = Internal entry number of the order requested. RARRAY = This is the local array name in which the subscribing package would like data returned. Returns an array subscripted by case number(s) for non-cancelled exam(s) associated with the order. It also returns a string in which the first piece is the number of exam(s) linked to the order. The second piece indicates whether or not the exam(s) are part of a printset. Output: local_array_name(case number)=total number of exams -or- error code^printset -or- error code text subscripts ---------- Case Number: This is the case number of the non-cancelled exam linked to an order. All registered exams have case numbers. array value (in ascending order) -------------------------------- First Piece: This can be a positive number indicating the number of exam(s) registered for a single order. It also may be an error code. For example, if an order is requested for an exam set, and we register three exams, the first piece would be a three. An error code of '-1' will exist if the order number is invalid. An error code of '-2' will exist if all the exams for this order are cancelled, or if we have not registered exams for the order at the time of the data extract. Second Piece: If the second piece equals the string, 'PRINTSET', the exams are part of a special exam set. The PRINTSET links all the exams of an exam set to a single report. If the first piece is a negative number, then the second piece defines the error code. Examples: 'cases cancelled', 'no case registered to date' or 'invalid order ien' are valid error code descriptors. ******************** 2269 NAME: DBIA2269 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS BENEFICIARY TRAVEL Referenced by the DIVISION (#11) field in the BENEFICIARY TRAVEL CLAIM file 392. USAGE: Controlled Subscri ENTERED: JAN 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File Inpatient Medications requests permission to have a field defined in the IV ROOM file (#59.5) that points to the MEDICAL CENTER DIVISION file (#40.8). This field contains the division where the IV Room is located. The Inpatient Medications field is populated by an option on the DSS Extracts menu. It is solely for use by the DSS software and has no impact on Pharmacy at this time. This field in Inpatient Medications supports DBIA #1849 for the DSS Extracts package. ^DG(40.8, .01 NAME 0;1 Pointed to The Inpatient Medications IV ROOM file (#59.5), DIVISION field (#.02) points to ^DD(40.8,.01). The Inpatient Medications field is populated by an option on the DSS Extracts menu. It is solely for use by the DSS software and has no impact on Pharmacy at this time. This field in Inpatient Medications supports DBIA #1849 for the DSS Extracts package. ROUTINE: ******************** 2270 NAME: Subscription Management CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The following API's support creation, references, and updates to HL7 subscriptions using the SUBSCRIPTION CONTROL FILE (774). In addition, Vista applications may set up a pointer to file 774 if needed. An example of this can be found in the Patient file. See the CIRN documentation for details on how this is used. ROUTINE: HLSUB COMPONENT: $$ACT VARIABLES: $$ACT^HLSUB Purpose: Request a new Subscription Control Number Example: KRN,KDE>S X=$$ACT^HLSUB KRN,KDE>W X 2 COMPONENT: UPD VARIABLES: UPD^HLSUB(HLSCN,HLNN,HLTP,HLAD,HLTD,HLRAP,.HLER) Purpose: Subscription Update-add/edit a subscriber Input: HLSCN=Subscription Control Number (required) HLNN=Logical Link name in file 870 (required) HLTP=Subscription Type (required) 0=descriptive updates only 1=clinical updates 2=other (locally defined) HLAD=Activation date (optional), defaults to 'now' HLTD=Termination date (optional), default is 'open-ended' HLRAP=HL7 receiving application HLER=error message(s) Notes: a. The ACTIVATION DATE and TERMINATION DATE fields can be pre-determined by the subscriber. b. Setting the TERMINATION DATE field is optional. Setting this field is effectively setting an expiration date for the subscriber. Messages will no longer be delivered to this network node as long as the current date is later than the termination date. If the current subscription has a Termination Date set and the subscriber changes their mind, the date can be changed or deleted with a new subscription update message. The current termination date will be deleted when the variable HLTD is set to 'null.' c. The Subscription Control Number and the Destination multiple are UNEDITABLE fields. d. All modifications to existing subscriber records using this call results in an update of the Subscriber History multiple. Example: a. KRN,KDE>D UPD^HLSUB(1,"TEST-LLP",1,"4/29/1997@10:27:57","","CIRN",.HLER) b. INQUIRE TO FILE ENTRIES: DESTINATION: CIRN@TEST LLP RECEIVING APPLICATION: CIRN LOGICAL LINK: TEST LLP TYPE: Patient Clinical and Descriptive CREATION DATE/TIME: APR 29, 1997@10:27:57 ACTIVATION DATE/TIME: APR 29, 1997@10:27:57 MODIFICATION DATE/TIME: APR 29, 1997@10:27:57 LAST CREATION DATE/TIME: APR 29, 1997@10:25:07 LAST ACTIVATION DATE/TIME: APR 29, 1997@10:25:07 LAST SUBSCRIPTION TYPE: Patient Clinical and Descriptive COMPONENT: GET VARIABLES: GET^HLSUB(HLSCN,HLTP,HLCL,.HLL) Purpose: Return active subscriber information Input: HLSCN=Subscription control number HLTP=Subscription type (optional) HLCL=HL7 Client Protocol (optional) HLL=Array of current subscribers (passed by reference) Output: HLL("LINKS",n)=CLIENT PROTOCOL^LOGICAL LINK^TYPE^CREATION DATE^ACTIVATION DATE^TERMINATION DATE Notes: a. When HLTP is 'null' all subscribers are returned. b. Multiple calls can be made to GET. For example, to route a message to both Clinical and Descriptive subscribers, the first call would have HLTP set to '0', and in the second call it would be set to '1.' If the HLL array already exists, it will be appended to. c. The HL7 Package requires the HLL array to contain both the HL7 Client Protocol and the Logical Link. In this call, the Client Protocol is optional. If you pass in the Protocol name, it will be returned in the first piece of the array. If you are making this call specifically to dynamically route a message, submit the Client Protocol. If you make this call to retrieve other information about the subscriber, the first piece of the HLL array will be null. Examples: (1) Return all subscriber information for SCN #1 KRN,KDE>K HLL D GET^HLSUB(1,,,.HLL) KRN,KDE>ZW HLL HLL("LINKS",1)=^INDY-TCP^RG SUBSCRIPTION@INDY-TCP^9^^23^1^2970501.184903^2970501.184903 (2) Return all subscribers using multiple calls and selected 'subscriber types' KRN,KDE>K HLL D GET^HLSUB(1,1,"CIRN ROUTER",.HLL) KRN,KDE>ZW HLL HLL("LINKS",1)=CIRN ROUTER^ISC-SF^1^2961031.142702^2950617.13 KRN,KDE>D GET^HLSUB(1,2,"CIRN ROUTER",.HLL) KRN,KDE>ZW HLL HLL("LINKS",1)=CIRN ROUTER^ISC-SF^1^2961031.142702^2950617.13 HLL("LINKS",2)=CIRN ROUTER^KERNEL^2^2961031.11144^2961031.110628 ******************** 2271 NAME: DERIVE LOGICAL LINK FROM INSTITUTION CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A new API has been created to return an array of Logical links when only an institution entry is known. This can be either a single institution or a VISN. A new field has been added to the HL LOGICAL LINK file (870) pointing to the INSTITUTION FILE. ROUTINE: HLUTIL3 COMPONENT: LINK VARIABLES: NOTE: THIS API IS DEPENDENT ON KERNEL PATCH XU*8*43 AND PROPER GROUPING OF INSTITUTIONS WITHIN A VISN AND PROPER ASSOCIATION OF A LOGICAL LINK WITH THE CORRESPONDING INSTITUTION. API TO RETURN LOGICAL LINKS WHEN YOU INPUT INSTITUTION OR VISN (NAME OR IEN) 1. LINK^HLUTIL3(HLINST,.HLI) Purpose: Return Logical Link(s) from DHCP Institution Input: HLINST=Institution or VISN name or ien Output: HLI(LINK_IEN)=LINK NAME passed by reference EXAMPLE: DEV,CRN>D LINK^HLUTIL3("VISN 2",.HLZ) DEV,CRN>ZW HLZ HLZ= HLZ(9)=TAMPA, FL ******************** 2278 NAME: DBIA2278 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION USAGE: Private ENTERED: FEB 2,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 441 ROOT: PRC(441 DESCRIPTION: TYPE: File The purpose of this agreement is to allow another package to lookup Item Master file (#441) entries by the short description (field #.05) using the "C" cross reference on that field or extract the value of the short description for a item whose Item Master File (IMF) number is known. ^PRC(441,D0,0) .05 SHORT DESCRIPTION 0;2 Direct Global Read & w ^PRC(441,'C', $Order() through the "C" cross reference on the SHORT DESCRIPTION (#.05) field. ROUTINE: ******************** 2283 NAME: DBIA2283 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: FEB 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.8 ROOT: PSD(58.8 DESCRIPTION: TYPE: File Inpatient Medications requests permission to reference by a direct read cross-reference ^PSD(58.8,"D",DRUG,WARD). This is the "D" cross-reference for field WARD (FOR DRUG) for sub-file 58.800115. This cross-reference is the link between the Controlled Substances package and the Inpatient Medications package for determining ward stocked drugs. ^PSD(58.8,'D',DRUG,WARD) D Cross WARD (FOR DRUG) PSD(58.8 Direct Global Read & w This is the "D" cross-reference for field WARD (FOR DRUG) for sub-file 58.800115. This cross-reference is the link between the Controlled Substances package and the Unit Dose package for determining ward stocked drugs. ROUTINE: ******************** 2284 NAME: DBIA2284 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: FEB 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.1 ROOT: PSI(58.1 DESCRIPTION: TYPE: File Inpatient Medications requests permission to reference by a direct read cross-reference ^PSI(58.1,"D", ITEM, WARD). This is the"D" cross-reference for field WARD (FOR ITEM) for sub-file 58.26. This cross-reference is used by the Inpatient Medications package to identify items on the Unit Dose pick list that are Ward Stock items. ^PSI(58.1,'D',ITEM,WARD) D Cross- WARD (FOR ITEM) PSI(58.1 Direct Global Read & w This is the "D" cross-reference for field WARD (FOR ITEM) for sub-file 58.26. This cross-reference is used by the Inpatient Medications package to identify items on the Unit Dose pick list that are Ward Stock items. ROUTINE: ******************** 2285 NAME: DBIA2285 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: FEB 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Dietetics uses the entry point FH^ORCONV3 of Order Entry version 3 (CPRS) and pass the converted PACKAGE REFERENCE to Order Entry for storage. ROUTINE: ORCONV3 COMPONENT: FH VARIABLES: ORIFN Type: Input The Internal Entry Number of the order in the Order file #100. ORPK Type: Input The converted PACKAGE REFERENCE string. FH entry point of routine ORCONV3. ******************** 2286 NAME: DBIA2286 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: FEB 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORCDFH COMPONENT: $$CANCEL VARIABLES: ORIFN Type: Input The Internal Entry Number of the order in the Order file (#100). Returns 0 or 1 for No or Yes on whether a tray service should be cancelled. COMPONENT: $$RESUME VARIABLES: ORIFN Type: Input The Internal Entry Number of the order in the Order file (#100). Returns a 0 or 1 for No or Yes on whether a tray service should be resumed. ******************** 2287 NAME: DBIA2287 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine FHWOR8 will pass back an array of the Dietetics Order parameter. ROUTINE: FHWOR8 COMPONENT: EN(DFN,FHPAR) VARIABLES: DFN Type: Input The Internal Entry Number of the inpatient. FHPAR Type: Both FHPAR is a Call By Reference variable. It is null before the call. After the call, the following array is pass back: FHPAR(1)=EARLY BREAKFAST TIME 1 EARLY BREAKFAST TIME 2 EARLY BREAKFAST TIME 3 LATE BREAKFAST TIME 1 LATE BREAKFAST TIME 2 LATE BREAKFAST TIME 3 EARLY NOON TIME 1 EARLY NOON TIME 2 EARLY NOON TIME 3 LATE NOON TIME 1 LATE NOON TIME 2 LATE NOON TIME 3 EARLY EVENING TIME 1 EARLY EVENING TIME 2 EARLY EVENING TIME 3 LATE EVENING TIME 1 LATE EVENING TIME 2 LATE EVENING TIME 3 FHPAR(2)=LATE BREAKFAST ALARM BEGIN LATE BREAKFAST ALARM END LATE NOON ALARM BEGIN LATE NOON ALARM END LATE EVENING ALARM BEGIN LATE EVENING ALARM END BEGIN BREAKFAST WINDOW BEGIN NOON WINDOW BEGIN EVENING WINDOW PROVIDE BAGGED MEALS? FHPAR(3)=TYPE OF SERVICE Each piece of data is separated by a "^". Sample Array: FHPAR(1)=6:20A^8:00A^^8:50A^9.25A^^11:00A^12 :00P^^12:50P^2:00P^3:00P^3:00P^ 4:30P^5:30P^^5:50P^8:50P^9:00P FHPAR(2)=630^830^1000^1505^2030^6:50A^11:25A ^4:55P^Y FHPAR(3)=TC The entry point EN will return the Dietetics Order Parameter. Sample call: FHPAR is null before the call. D EN^FHWOR8(DFN,.FHPAR) The array is passed back to FHPAR. COMPONENT: EN1(LOC,FHPAR) VARIABLES: FHPAR Type: Both FHPAR is a Call By Reference variable. It is null before the call. After the call, the following array is passed back: FHPAR(1)=EARLY BREAKFAST TIME 1 EARLY BREAKFAST TIME 2 EARLY BREAKFAST TIME 3 LATE BREAKFAST TIME 1 LATE BREAKFAST TIME 2 LATE BREAKFAST TIME 3 EARLY NOON TIME 1 EARLY NOON TIME 2 EARLY NOON TIME 3 LATE NOON TIME 1 LATE NOON TIME 2 LATE NOON TIME 3 EARLY EVENING TIME 1 EARLY EVENING TIME 2 EARLY EVENING TIME 3 LATE EVENING TIME 1 LATE EVENING TIME 2 LATE EVENING TIME 3 FHPAR(2)=LATE BREAKFAST ALARM BEGIN LATE BREAKFAST ALARM END LATE NOON ALARM BEGIN LATE NOON ALARM END LATE EVENING ALARM BEGIN LATE EVENING ALARM END BEGIN BREAKFAST WINDOW BEGIN NOON WINDOW BEGIN EVENING WINDOW PROVIDE BAGGED MEALS? FHPAR(3)=TYPE OF SERVICE Each piece of data is separated by a "^". Sample Array: FHPAR(1)=6:20A^8:00A^^8:50A^9.25A^^11:00A^12 :00P^^12:50P^2:00P^3:00P^3:00P^ 4:30P^5:30P^^5:50P^8:50P^9:00P FHPAR(2)=630^830^1000^1505^2030^6:50A^11:25A ^4:55P^Y FHPAR(3)=TC The entry point EN1 will return the Dietetics Order Parameter when passed a location. Sample call: FHPAR is null before the call. D EN1^FHWOR8(LOC,.FHPAR) The array is passed back to FHPAR. ******************** 2289 NAME: DBIA2289 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Extrinsic function call $$QUAN^FHWOR5R will return the total quantity in cc for a tubefeeding product. ROUTINE: FHWOR5R COMPONENT: QUAN VARIABLES: FHS Type: Input This is a Call By Value variable. The input format consist of the Internal Entry Number of the tubefeeding product concatenated with a "-" and concatenate with the strength of the product. Example, "12-3". FHQ Type: Input This is a Call By Value variable. The input consist of the Health Level 7 message segment of the tubefeeding product quantity, duration, and interval each separate by a "^". Example, 100&C^BID^H6. The input is 100CC, twice a day, for 6 hours. TC Type: Output This variable is the total quantity of the tubefeeding product in cc which will be returned by the function call. This extrinsic function will return the total quantity in cc of a tubefeeding product. Sample call: S X=$$QUAN^FHWOR5R(FHS,FHQ) X would contain the total cc of a tubefeeding product. ******************** 2290 NAME: DBIA2290 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Extrinsic function $$RESUME^FHWORR will return a flag on whether to prompt the user to resume the tray service or not. ROUTINE: FHWORR COMPONENT: RESUME VARIABLES: DFN Type: Input The Internal Entry Number of the inpatient. Y Type: Output This is a flag which is returned by the function call. The flag can be a null, 1, or 0. If Y = Null which means No Current Diet Order in file. If Y = 1 means to prompt the user to resume tray service. If Y = 0 means not to prompt the user. This entry point will check whether to prompt to resume tray service. ******************** 2291 NAME: DBIA2291 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine FHWOR7 will return the information on the Dietetics Profile. DFN have to be defined before using the routine. ROUTINE: FHWOR7 COMPONENT: FHWOR7 VARIABLES: DFN Type: Input The Internal Entry Number of the inpatient. TMP($J) Type: Output Dietetics will return the following arrays: Supplemental Feeding: ^TMP($J,"FHSF",1)=Date/Time (Internal FM form 2970422.103109)_"^"_ 10am feeding Quantity # 1_" "_10am Feeding name # 1_";"_ 10am feeding Quantity # 2_" "_10am Feeding name # 2_";"_ 10am feeding Quantity # 3_" "_10am Feeding name # 3_";"_ 10am feeding Quantity # 4_" "_10am Feeding name # 4_"^"_ 2pm feeding Quantity # 1_" "_2pm Feeding name # 1_";"_ 2pm feeding Quantity # 2_" "_2pm Feeding name # 2_";"_ 2pm feeding Quantity # 3_" "_2pm Feeding name # 3_";"_ 2pm feeding Quantity # 4_" "_2pm Feeding name # 4_"^"_ 8pm feeding Quantity # 1_" "_8pm Feeding name # 1_";"_ 8pm feeding Quantity # 2_" "_8pm Feeding name # 2_";"_ 8pm feeding Quantity # 3_" "_8pm Feeding name # 3_";"_ 8pm feeding Quantity # 4_" "_8pm Feeding name # 4 Tubefeeding: ^TMP($J,"FHTF",1)=Kcal/Day Food Preference: Likes: ^TMP($J,"FHFP","L",n)=Quantity_" "_Food Preference name_"^"_Meal (example BNE) n=Sequential number Dislikes: ^TMP($J,"FHFP","D",n)=Food Preference name_"^"_Meal n=Sequential number This routine will return Supplemental Feeding, Tubefeeding, and Food Preference of a particular inpatient in the ^TMP global. ******************** 2292 NAME: DBIA2292 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine P^FHWOR71 is an extrinsic function which returns the printable Dietetics Profile for a particular inpatient. ROUTINE: FHWOR71 COMPONENT: P VARIABLES: DFN Type: Input The Internal Entry number of the inpatient. Y Type: Output A flag of either a -1^displayable error text or 1 for sucessful. TMP($J,FHP Type: Output The displayable text of the Dietetics Profile is stored in the global ^TMP($J,"FHPROF",DFN,N)=Lines of text. Where N = sequential number. This extrinsic function returns a flag of either a -1 or 1. If flag is a -1, there is no profile. If flag is a 1, there is a profile and the printable Dietetics Profile is stored in ^TMP($J,"FHPROF",DFN,Sequential number). ******************** 2293 NAME: DBIA2293 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine FHWORA contains two extrinsic functions which will return the Nutrient Assessment dates for a particular patient and the printable Nutrient Assessment for an Assessment date of that patient. ROUTINE: FHWORA COMPONENT: FHWORADT VARIABLES: DFN Type: Input The Internal Entry Number of the patient. Y Type: Output A flag of either -1^error text for no assessment dates passed back with reason being error text or 1 for assessments dates for the patient have been found. TMP($J,FHA Type: Output All the Nutrient Assessment dates for a particular patient are stored in the global ^TMP($J,"FHADT",DFN,inverse internal date/time)=external date/time. This extrinsic function returns a flag of either a -1 or 1. If flag is a -1, no Assessment found. If flag is a 1, Assessment found and the Assessment dates for a paticular patient is stored in the global ^TMP($J,"FHADT",DFN,Inverse internal date/time). COMPONENT: FHWORASM VARIABLES: DFN Type: Input The Internal Entry Number of the patient. FHADTX Type: Input The external format of the Assessment date. Y Type: Output A flag of -1^error text for no assessment passed back with reason being in the error text or 1 for assessment for the patient have been found. TMP($J,FHA Type: Output The printable Nutrient Assessment is stored in the global ^TMP($J,"FHASM",DFN, Sequence number)="Lines of text". This extrinsic function returns a flag of either a -1 or 1. If flag is a -1, no Assessment found. If flag is a 1, the Assessment is found and the printable Nutrient Assessment for an Assessment date of a particular patient is stored in the global ^TMP($J,"FHASM",DFN,Sequential number). ******************** 2294 NAME: DBIA2294 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Entry Point CUR^FHORD7 will return the Current Diet of a particular inpatient. Before executing this entry point, make sure both variables, DFN and ADM, exists. ROUTINE: FHORD7 COMPONENT: CUR VARIABLES: DFN Type: Input The Internal Entry Number of the inpatient. Y Type: Output The free text of the current Diet. ADM Type: Input The admission number. This entry point returns the current Diet for an inpatient. ******************** 2295 NAME: DBIA2295 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8 DESCRIPTION: TYPE: File ^DG(40.8,D0,0) .01 NAME 0;1 Direct Global Read & w .07 INSTITUTION FILE POI 0;7 Direct Global Read & w ROUTINE: ******************** 2296 NAME: DBIA2296 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING BENEFICIARY TRAVEL USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43 DESCRIPTION: TYPE: File ^DG(43,D0,GL) 11 MULTIDIVISION MED CE GL;2 Direct Global Read & w 12 MEDICAL CENTER NAME GL;3 Direct Global Read & w ROUTINE: ******************** 2298 NAME: DBIA2298 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: HEALTH LEVEL SEVEN USAGE: Private ENTERED: MAR 5,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: File HL7 Patch 14 brings in updates to reference files for version 2.3 of the standard. These files contain identifiers that have changed with the latest version. KIDS does not install the new data correctly unless these identifiers are removed before installing the patch. Permission is requested to execute the following code as pre and post install routines in patch 14. HLP14PRE ;SFIRMFO/JC - HL7 PATCH 14 PRE-INIT ;03/05/98 11:44 ;;1.6;HEALTH LEVEL SEVEN;**14**;Oct 13, 1995 PRE ; K ^DD(779.001,0,"ID") K ^DD(771.2,0,"ID") Q POST ; S ^DD(779.001,0,"ID",2)="W "_""""_" "_""""_",$P(^(0),U,2)" S ^DD(771.2,0,"ID",2)="W "_""""_" "_""""_",$P(^(0),U,2)" ^DD(779.001,0,'ID' 'identifier' node of DD for file 779.001 and 771.2 ^DD(771.2,0,'ID' This is the 'identifier' node on the description field of file 771.2. ROUTINE: ******************** 2300 NAME: DBIA2300 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,DIS, Fileman captioned output of entire DISPOSITION LOG-IN DATE/TIME subrecord. ^DPT(D0,S, Fileman captioned output of entire APPOINTMENT subrecord. ^DPT(D0,DIS,D1,2) 21 WORKMEN'S COMP CLAIM 2;2 Direct Global Read & w 23 NEED RELATED TO AN A 2;4 Direct Global Read & w ^DPT(D0,S,D1,0) 3 STATUS 0;2 Direct Global Read & w 9 PURPOSE OF VISIT 0;7 Direct Global Read & w ROUTINE: ******************** 2309 NAME: DBIA2309 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL REMINDERS CLINICAL CASE REGISTRIES WOMEN'S HEALTH USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File ^AUPNVSIT(AA 'AA' xref. ^AUPNVSIT(AD 'AD' xref. ^AUPNVSIT(D0, Fileman captioned output of entire VISIT record. ^AUPNVSIT(D0,0) .12 PARENT VISIT LINK 0;12 Direct Global Read & w ROUTINE: ******************** 2310 NAME: DBIA2310 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.18 ROOT: AUPNVCPT( DESCRIPTION: TYPE: File ^AUPNVCPT(AD 'AD' xref. ^AUPNVCPT(D0, Fileman captioned output of entire V CPT record. ^AUPNVCPT(D0,12) 1204 ENCOUNTER PROVIDER 12;4 Direct Global Read & w ROUTINE: ******************** 2311 NAME: DBIA2311 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.13 ROOT: AUPNVXAM DESCRIPTION: TYPE: File ^AUPNVXAM(AD 'AD' xref. ^AUPNVXAM(D0, Fileman captioned output of entire V EXAM record. ROUTINE: ******************** 2312 NAME: DBIA2312 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF DESCRIPTION: TYPE: File ^AUPNVHF(AD 'AD' xref. ^AUPNVHF(D0, Fileman captioned output of entire V HEALTH FACTORS record. ROUTINE: ******************** 2313 NAME: DBIA2313 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL REMINDERS BAR CODE MED ADMIN BCMA added 12/12/08 /jsh USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.11 ROOT: AUPNVIMM( DESCRIPTION: TYPE: File ^AUPNVUMM(AD, "AD" xref. ^AUPNVIMM(D0, Fileman captioned output of entire V IMMUNIZATION record. ^AUPNVIMM(AA, "AA" xref. ROUTINE: ******************** 2314 NAME: DBIA2314 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.16 ROOT: AUPNVPED( DESCRIPTION: TYPE: File ^AUPNVPED(AD 'AD' xref. ^AUPNVPED(D0, Fileman captioned output of entire V PATIENT ED record. ROUTINE: ******************** 2315 NAME: DBIA2315 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.07 ROOT: AUPNVPOV( DESCRIPTION: TYPE: File ^AUPNVPOV(AD 'AD' xref. ^AUPNVPOV(D0, Fileman captioned output of entire V POV record. ROUTINE: ******************** 2316 NAME: DBIA2316 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING 6/20/14 - PCMMR added. Beginning with SD*5.3*603, PCMMR will assign a patient to a team in a pending status until they have a completed encounter with a team member. Once they have the encounter, they are switched to an active status. PCMMR uses a remote procedure call to identify an encounter in the Outpatient Encounter (#409.68) file based on the checkout date and makes a determination if the status should be updated to active. With the Outpatient Encounter file data, additional data elements can be obtained from the Visit (#9000010) and V Provider (#9000010.06) files. Returned array includes Patient DFN, Encounter Date/Time(#.01 field - 409.68), Provider IEN (#.01 field - 9000010.06), Primary/Secondary (#.04 field - 9000010.06), Stop Code (#.03 field - 409.68), Encounter Type (#15003 field - 9000010), Checkout Completed Date/Time (#.07 field - 409.68), Outpatient Encounter (#409.68) IEN, Outpatient Encounter Parent IEN, Visit (#9000010) IEN, and Visit Parent IEN (#12 field - 9000010). PCMMR will display the last encounter date for the patient. CLINICAL REMINDERS HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.06 ROOT: AUPNVPRV( DESCRIPTION: TYPE: File ^AUPNVPRV(AD 'AD' xref. ^AUPNVPRV(D0, Fileman captioned output of entire V PROVIDER record. ROUTINE: ******************** 2317 NAME: DBIA2317 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK( DESCRIPTION: TYPE: File ^AUPNVSK(AD 'AD' xref. ^AUPNVSK(D0, Fileman captioned output of entire V SKIN TEST record. ROUTINE: ******************** 2318 NAME: DBIA2318 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: FEB 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.15 ROOT: AUPNVTRT( DESCRIPTION: TYPE: File ^AUPNVTRT(AD 'AD' xref. ^AUPNVTRT(D0, Fileman captioned output of entire V TREATMENT record. ROUTINE: ******************** 2319 NAME: DBIA2319 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING SPINAL CORD DYSFUNCTION USAGE: Controlled Subscri ENTERED: FEB 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 119.4 ROOT: FH(119.4, DESCRIPTION: TYPE: File Order Entry Version 3 (CPRS) uses the Isolation/Precaution Type file (#119.4). The Order Dialog file (#101.41) points to file 119.4 and displays the Isolation/Precaution types for ordering. ^FH(119.4,D0,0) .01 NAME 0;1 Pointed to The name of the Isolation/Precaution type. .01 NAME 0;1 Direct Global Read & w ^FH(119.4,'B', ^FH(119.4,D0,'I') 99 INACTIVE I;1 Direct Global Read & w ROUTINE: ******************** 2320 NAME: DBIA2320 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 9,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The %ZISH calls described in the KERNEL SYSTEM Manual. This is a set of calls to work with Host files of the underlaying system. ROUTINE: %ZISH COMPONENT: CLOSE VARIABLES: Close host file opened by OPEN^%ZISH. COMPONENT: $$DEL VARIABLES: Delete host file. COMPONENT: $$FTG VARIABLES: Copy lines from a host file into a global. COMPONENT: $$GATF VARIABLES: Append records from a global to a host file. COMPONENT: $$GTF VARIABLES: Copy records from a global into a host file. COMPONENT: $$LIST VARIABLES: Retrieve a list of files in a directory. COMPONENT: $$MV VARIABLES: Rename host file. COMPONENT: OPEN VARIABLES: Open host file (bypass device handler). COMPONENT: $$PWD VARIABLES: Retrieve name of current directory. COMPONENT: $$STATUS VARIABLES: Return end-of-file status. COMPONENT: $$DEFDIR[(df)] VARIABLES: df Type: Input This is a directory path to be do a simple format check on. For NT it will change "/" to "\" and see that there is a trailing "\". There is no error response. $$DEFDIR Type: Output This api has two modes. If it is called with a null/missing parameter, it returns the "default directory for HFS files" from the KSP file (8989.3). If it is called with a parameter, it must be the directory for a file. This parameter will be check to see that it is in the correct format for this operating system. ******************** 2321 NAME: DBIA2321 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: AUTHORIZATION/SUBSCRIPTION CLINICAL INFO RESOURCE NETWORK CIRN only references the .01 field. CLINICAL REMINDERS IMAGING added 11/10/2010 VIRTUAL PATIENT RECORD Effective with VPR*1*0. USAGE: Controlled Subscri ENTERED: FEB 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: TIU(8925.1 DESCRIPTION: TYPE: File In order for the AUTHORIZATION/SUBSCRIPTION UTILITY (ASU) to work properly with TIU documents it needs the information contained in the first and fourth pieces of the zero node of the TIU DOCUMENT DEFINITION FILE, # 8925.1. It also needs to use the "AD" cross-reference to traverse the document class hierarchy to determine if authorization is granted at a higher level. Therefore ASU requests permission to do a direct global read of the first and fourth pieces of the zero node of file # 8925.1 and the "AD" node. ^TIU(8925.1,0) .01 NAME 0;1 Direct Global Read & w This includes direct access to the "B" x-ref. .04 TYPE 0;4 Direct Global Read & w AD Direct Global Read & w ROUTINE: ******************** 2322 NAME: Calls to TIULP CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: AUTHORIZATION/SUBSCRIPTION In order for the AUTHORIZATION/SUBSCRIPTION UTILITY (ASU) to work properly with TIU documents it needs to screen selection of documents. The function CANPICK^TIULP provides this functionality. ASU would like permission to call CANPICK^TIULP. ORDER ENTRY/RESULTS REPORTING OE/RR calls $$CANDO, $$CANLINK, and $$REQCOSIG. ADVERSE REACTION TRACKING CARE MANAGEMENT IMAGING USAGE: Controlled Subscri ENTERED: FEB 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA is a controlled subscription for calls to routine TIULP. ROUTINE: TIULP COMPONENT: $$CANPICK(TIUTYP) VARIABLES: TIUTYP Type: Input This is the ien of the document. This is a Boolean function that returns true if ?? and false otherwise. COMPONENT: $$CANDO(IEN,ACTION) VARIABLES: IEN Type: Input IEN of the TIU DOCUMENT file (#8925). ACTION Type: Input Pointer to the USR ACTION file (#8930.8). RESULT Type: Output RESULT=$$CANDO^TIULP(IEN,ACTION) where result is: 1 if user can perform action 0^'why not message' if user can't perform action Evaluates whether a user can perform an action on a specific TIU document. COMPONENT: $$REQCOSIG(TYPE,IEN,USER) VARIABLES: TYPE Type: Input Pointer to TIU DOCUMENT DEFINITION file (#8925.1). IEN Type: Input Pointer to TIU DOCUMENT file (#8925). USER Type: Input Pointer to NEW PERSON file (#200). RESULT Type: Output RESULT=$$REQCOSIG(TYPE,IEN,USER) where RESULT is 1 if user requires cosignature for the document or 0 otherwise. Evaluates whether a user requires a cosignature for a particular document. COMPONENT: $$CANLINK(TYPE) VARIABLES: TYPE Type: Input This is the IEN of the document in the TIU DOCUMENT DEFINITION FILE (#8925.1). RESULT Type: Output The function returns a BOOLEAN result (i.e., 1 if the document in question may be linked as an Interdisciplinary Entry, and 0^Explanatory text) if it cannot. BOOLEAN function which evaluates whether the current user (DUZ) link a document of a particular type to an Interdisciplinary Note. For use in ADD NEW ID NOTE, where the new entry has not yet been entered. not entered yet. Assume most favorable circumstances (i.e., user will complete the note), so if user still can't link, can tell them no, when they first select title for the new entry. Exclude titles that can be selected as Interdisciplinary Parents, since Parent and Child entries function as mutually exclusive, (regardless of business rules). COMPONENT: $$CANENTR(TIUTYP) VARIABLES: TIUTYP Type: Input Document type IEN. $$CANENTR Type: Output 1 == if user has privileges to enter a document of the type input 0 == otherwise ******************** 2323 NAME: Calls to routine TIULC1 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: AUTHORIZATION/SUBSCRIPTION In order for the AUTHORIZATION/SUBSCRIPTION UTILITY (ASU) to work properly with TIU documents it needs the display name for a document class. The function PNAME^TIULC1 returns this information. ASU would like permission to call PNAME^TIULC1. ORDER ENTRY/RESULTS REPORTING OE/RR makes calls to $$ISADDNDM, $$PNAME, and $$PTNAME. CARE MANAGEMENT Care Mgt uses DOCPRM to get document parameters. IMAGING USAGE: Controlled Subscri ENTERED: FEB 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIULC1. ROUTINE: TIULC1 COMPONENT: $$PNAME(DA) VARIABLES: DA Type: Input Internal entry number of document. Returns the Display Name of a document class. COMPONENT: $$ISADDNDM(IEN) VARIABLES: IEN Type: Input IEN of TIU DOCUMENT file (#8925). RESULT Type: Output RESULT=$$ISADDNDM(IEN) where RESULT is 1 if the document is an addendum and a 0 otherwise. Returns whether a TIU DOCUMENT entry (#8925) is an addendum or not. COMPONENT: $$PTNAME(DFN) VARIABLES: DFN Type: Input Internal entry number of the PATIENT file (#2). RESULT Type: Output RESULT=$$PTNAME^TIULC1(DFN) where RESULT returns the NAME field (.01) of the PATIENT file or "NAME UNKNOWN" if invalid DFN entered. Returns patient name. COMPONENT: DOCPRM(TYPE,.PARAMS,IEN) VARIABLES: TYPE Type: Input IEN of TIU DOCUMENT DEFINITION file (#8925.1). PARAMS Type: Both Array passed in by reference, to return data from the TIU DOCUMENT PARAMETERS file (#8925.95): PARAMS(0)=0-node of file entry PARAMS(5)=#^#^...^# where # is each entry in the Users Requiring Cosignature subfile (#8995.955) IEN Type: Input IEN of TIU DOCUMENT file (#8925); optional, used to get document type from parent document, if IEN is an addendum. Returns parameters for a document type. ******************** 2325 NAME: DBIA2325 CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: FEB 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When checking what a user can do with a document, (read, edit, etc.) TIU needs to evaluate the user's authorization. Therefore TIU requests permission to call the function CANDO^USRLA. ROUTINE: USRLA COMPONENT: $$CANDO(DOCTYPE,STATUS,EVENT,USER,USRROLE) VARIABLES: DOCTYPE Type: Input IEN in file 8925.1 TIU DOCUMENT DEFINITION. STATUS Type: Input Pointer to file 8925.6, TIU STATUS. EVENT Type: Input Pointer to file 8930.8, USR EVENT. USER Type: Input Pointer to file 200, NEW PERSON. USRROLE Type: Input Pointer to file 8930.2, USR ROLE. Return true if a user is authorized to perform the specified action on a document. ******************** 2326 NAME: DBIA2326 CUSTODIAL PACKAGE: DIETETICS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: FEB 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine ORSETUP in patch OR*2.5*49, CPRS PRE-INSTALL, and in Order Entry Version 3 (CPRS) calls routine FHWORI to populate the Orderable Item file (#101.43). FHWORI sends Order Entry Health Level 7 messages of Tubefeeding products, and Diets for storage in file 101.43. ROUTINE: FHWORI ******************** 2327 NAME: DBIA2327 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: FEB 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is needed to determine if a bill has multiple Insurance Carriers. ROUTINE: IBJTU31 COMPONENT: $$MINS(X) VARIABLES: X Type: Input File 399 internal entry number. This call will return 1 if the bill passed in X has multiple insurance carriers, 0 will be returned if bill does not. ******************** 2328 NAME: DBIA2328 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: FEB 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is needed to allow Accounts Receivable to call the Third Party Joint Inquiry List Template (Integated Billing) from an Accounts Receivable List Template option. This is needed to prevent users from having to exit one menu option and access another option. ROUTINE: IBJTLA COMPONENT: EN VARIABLES: This call is the main entry point into the Third Party Joint Inquiry List Template option. ******************** 2329 NAME: DBIA2329 CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: FEB 19,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine USRLFF is a library of file functions for providing read access to various AUTHORIZATION/SUBSCRIPTION data. ROUTINE: USRLFF COMPONENT: EVNTPTR VARIABLES: EVENT Type: Input EVENT is the name of the event such as "AMENDMENT" or "SIGNATURE." Returns a pointer in file 8930.8 to "EVENT." COMPONENT: EVNTVERB VARIABLES: IEN Type: Input Internal entry number of an event in file 8930.8. Return the verb in file 8930.8 for the event with ien IEN. COMPONENT: HASAS VARIABLES: IEN Type: Input Internal entry number of an entry in file 8930.1. Boolean function that returns true if entry IEN in file 8930.1 has Authorizations/Subscriptions. COMPONENT: USRCLASS VARIABLES: IEN Type: Input Internal entry number for file 8930. Returns the 0 node of entry IEN in file 8930. COMPONENT: USRROLE VARIABLES: ROLE Type: Input Examples of "ROLE" are "ATTENDING PHYSICIAN", and "TRANSCRIBER." Return the internal entry number from file 8930.2 for the role "ROLE." ******************** 2331 NAME: DBIA2331-A CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 2,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 65 ROOT: LRD(65 DESCRIPTION: TYPE: File Direct global reads to "AP", "B", and "C" x-refs is also specified. ^LRD(65 .01 UNIT ID 0;1 Direct Global Read & w .04 COMPONENT 0;4 Direct Global Read & w .06 EXPIRATION DATE/TIME 0;6 Direct Global Read & w ^LRD(65,D0,2, .01 PATIENT XMATCHED/ASS 0;1 Direct Global Read & w .02 DATE/TIME UNIT ASSIG 0;2 Direct Global Read & w ROUTINE: ******************** 2332 NAME: DBIA2331-B CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 2,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery package requests permission to call the Blood Bank routine, BAR^LRBLB from the Surgery routine SRBLOOD, to scan the blood product bag, to ensure bar code readability. ROUTINE: LRBLB COMPONENT: BAR VARIABLES: LR Type: Output X Type: Output ******************** 2333 NAME: DBIA2333 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: MAR 2,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Surgery package requests permission to call the Blood Bank routine, LRBLBU, to scan the Blood Unit ID and return that value in the variable "X" from the blood product bag. The Surgery routine SRBLOOD, will use this value to check for an association with the patient in the operating room and the scanned Blood Unit ID. ROUTINE: LRBLBU COMPONENT: LRBLBU VARIABLES: X Type: Both The variable "X" is returned from scanning the Blood Product ID. LR Type: Input ******************** 2334 NAME: DBIA2334 CUSTODIAL PACKAGE: LIST MANAGER SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS INTEGRATED BILLING See also IA 367. OUTPATIENT PHARMACY TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: MAR 4,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests permission to call RESET^VALM4 (List Manager). This entry point allows the use of the ListMan standard protocol VALM TURN ON/OFF MENUS ( Auto-Display(On/Off) )to toggle between a normal and expanded screen length. In each Inpatient Medications Protocol HEADER field, a call is made that declares a short and long screen length and makes the call to RESET^VALM4. Each time the user executes the VALM TURN ON/OFF MENUS protocol, the protocol choices at the bottom of the screen are removed or brought back and the screen length is adjusted accordingly. During the Alpha testing of Inpatient Medications 5.0 and CPRS 1.0 at Tuscaloosa AL and West Palm Beach FL, this ability to expand the ListMan screen viewing area brought extreme positive feedback from the users. ROUTINE: VALM4 COMPONENT: RESET VARIABLES: VALM('BM') Type: Input Declares a long or short bottom margin variable to be used when displaying the list. VALM('LINE Type: Input Modifies the number of screen lines for the list to be either regular or expanded. This changes each time the user executes the VALM TURN ON/OFF MENUS protocol. This entry point allows the use of the ListMan standard protocol VALM TURN ON/OFF MENUS ( Auto-Display(On/Off) )to toggle between a normal and expanded screen length. In each Inpatient Medications Protocol HEADER field, a call is made that declares a short and long screen length and makes the call to RESET^VALM4. Each time the user executes the VALM TURN ON/OFF MENUS protocol, the protocol choices at the bottom of the screen are removed or brought back and the screen length is adjusted accordingly. In each Inpatient Medications Protocol HEADER field, a call is made to A^PSJ200(a,b) with (a) defined as long screen number of lines and (b) defined as short screen number of lines. A^PSJ200() is coded as: A(LONG,SHORT,SHRINK) ; Resizes list area N PSJBM S PSJBM=$S(VALMMENU:SHORT,+$G(SHRINK):SHORT,1:LONG) I VALM("BM")'=PSJBM S VALMBCK="R" D .S VALM("BM")=PSJBM,VALM("LINES")=(PSJBM-VALM("TM"))+1 .I +$G(VALMCC) D RESET^VALM4 Q ******************** 2335 NAME: OE/RR CALL TO XPAR FOR BACKWARDS COMPATIBILITY CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 11,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3 of OE/RR FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA is a private agreement between OE/RR and the Parameter Tools portion of Toolkit to allow a call to PUT1^XPAR. This is needed until Radiology converts to using XPAR calls directly. Parameter Tools functionality was originally in the ORXP namespace, but was later moved to the XPAR namespace. ROUTINE: XPAR COMPONENT: PUT1 VARIABLES: i Type: Input PAR Type: Input INST Type: Input VAL Type: Input ERR Type: Output Call assumes existence of ENT, PAR, INST, and VAL. It returns output in ERR. For description of these variables, see DBIA 2263 for variables Entity, Parameter, Instance, Value, and Error. ******************** 2336 NAME: SUPPORTED CALLS TO XPAREDIT CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 11,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA contains a list of calls which are supported for use. The calls are part of the Parameter Tools component of Toolkit. Parameter Tools is a generic method of handling parameter definition, assignment, and retrieval. See DBIA 2263 for the main entry points to this module. This DBIA contains calls to XPAREDIT which contain some additional utilities to for editing parameters. ROUTINE: XPAREDIT COMPONENT: EN VARIABLES: This entry point can be called to prompt the user for a parameter to edit. This is provided more as a tool for developers and not for exported calls as it allows editing of ANY parameter. COMPONENT: TED(Template,ReviewFlags,AllEntities) VARIABLES: Template Type: Input REQUIRED The IEN or NAME of an entry in the Parameter Template file (#8989.52). ReviewFlag Type: Input OPTIONAL There are 2 flags (A and B) that can be used individually, together, or not at all. An 'A' indicates that the new values for the parameters in the template are displayed AFTER the prompting is done. 'B' indicates that the current values of the parameters will be displayed BEFORE editing. AllEntitie Type: Input OPTIONAL This is a variable pointer that should be used as the entity for all parameters in the template. If left blank, prompting for the entity is done as defined in the PARAMETER TEMPLATE file. TED^XPAREDIT(Template,ReviewFlags,AllEntities) allows editing of parameters defined in a template. The parameters in the template are prompted in more of a FileMan style - prompt by prompt. No dashed line dividers are displayed between each parameter. Since the dashed line headers are suppressed, it is important to define the VALUE TERM for each parameter in the template, as this is what is used to prompt for the value. COMPONENT: TEDH(Template,ReviewFlags,AllEntities) VARIABLES: Template Type: Input ReviewFlag Type: Input AllEntitie Type: Input This is similar to the TED^XPAREDIT call, except that the dashed line headers ARE shown between each parameter. For input variable definitions, see TED component/entry point. COMPONENT: EDITPAR(Parameter) VARIABLES: Parameter Type: Input Pass as the IEN or the NAME of the entry in the PARAMETER DEFINITION file (#8989.51) which you want to be edited. This entry point can be used to edit a single parameter. COMPONENT: GETPAR(.Variable) VARIABLES: OutputValu Type: Output Returns the value Y in standard DIC look-up format. Allow user to select PARAMETER DEFINITION file entry. COMPONENT: GETENT(.Entity,Parameter,.OnlyOne?) VARIABLES: Entity Type: Output REQUIRED Returns the selected entity in variable pointer format. Parameter Type: Input REQUIRED Specifies the parameter for which an entity should be selected. Parameter should contain two pieces: IEN^DisplayNameOfParameter. OnlyOne? Type: Output OPTIONAL Returns "1" if there is only one possible entity for the value. For example, if the parameter can only be set for the system, OnlyOne?=1. If the parameter could be set for any location, OnlyOne?=0. Interactively prompts for an entity, based on the definition of a parameter. COMPONENT: EDIT(Entity,Parameter) VARIABLES: Entity Type: Input REQUIRED Identifies the specific entity for which a parameter may be edited. Entity must be in variable pointer format. Parameter Type: Input REQUIRED Identifies the parameter that should be edited. Parameter should contain two pieces: IEN^DisplayNameOfParameter. Interactively edits the instance (if multiple instances are allowed) and the value for a parameter associated with a given entity. COMPONENT: BLDLST(.List,Parameter) VARIABLES: List Type: Input Name of array to receive output. Parameter Type: Input IEN of entry in the PARAMETER DEFINITION file. This entry point will return, in the array List, all entities allowed for the input Parameter. ******************** 2338 NAME: DBIA2338 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: INTEGRATED BILLING FILENUM = 391.1 ACCOUNTS RECEIVABLE FILENUM = 340 BAR CODE MED ADMIN FILENUM = 53.79 USAGE: Controlled Subscri ENTERED: MAY 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine During special processing related to the Patient Merge, the routine IBAXDR needs to call the entry point SAVEMERG^XDRMERGB. This call is used to save the file image of an entry involved in the merge process when only one of the entries (the entry being merged or the entry being merged into) is present in [FILENUM]. Normally, the merge process would handle when it can identify a FROM or a TO entry which is not present based on the DINUMed values. For [FILENUM], however, the internal entry numbers are determined from the "B"-cross- reference, and missing entries need to be handled separately. ROUTINE: XDRMERGB COMPONENT: SAVEMERG VARIABLES: FILENUM Type: Input This is the file number for the file which is being merged and for which the images are to be saved. IENFROM Type: Input The internal entry number of the FROM entry (the entry being merged into another entry). IENTO Type: Input The internal entry number of the TO entry (the entry into which the entry is being merged). This entry point acts to save an image of the currently existing data for the merge entry and merged into entry in the MERGE IMAGE file (#15.4). ******************** 2340 NAME: DIU(0) CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT DIETETICS SOCIAL WORK PHARMACY DATA MANAGEMENT LAB SERVICE IFCAP ADVERSE REACTION TRACKING AUTOMATED LAB INSTRUMENTS added 3/6/08 USAGE: Controlled Subscri ENTERED: MAR 5,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Specific to preventing DIK from running cross-references which include a test for the value of DIU(0) not being present. ROUTINE: DIK COMPONENT: DIK VARIABLES: DIU(0) Type: Input The variable DIU(0) will be set to a value of 1 ******************** 2341 NAME: DBIA2341 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: MAR 5,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: Other The Patient Merge application of the Kernel Toolkit requests a private integration agreement to set the variable VAFCA08 during a merge process. ROUTINE: COMPONENT: PATIENT FILE VARIABLES: VAFCA08 Type: Used Setting VAFCA08=1 will prevent the REQUIRES TRANSMISSION flag from being set. The major demographic fields are involved. ******************** 2342 NAME: DBIA2342 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: SURGERY USAGE: Controlled Subscri ENTERED: MAY 27,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771 ROOT: HL(771, DESCRIPTION: TYPE: File The Surgery package is granted permission to do a direct global read of the ACTIVE/INACTIVE field (#2) in the HL7 APPLICATION PARAMETER file (#771). Reading this field will allow the Surgery package to determine if the HL7 application associated with the Surgery HL7 interface is active or not. If the HL7 application is not active, the call to the Surgery HL7 interface will quit, thus avoiding needless processing. ^HL(771,D0,0) 2 ACTIVE/INACTIVE 0;2 Direct Global Read & w ROUTINE: ******************** 2343 NAME: DBIA2343 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 10,1998 STATUS: Under Revision EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The routine XUSER has supported entry points to lookup a user, check to determine if a user is active, DEA# details, DETOX#, authorized to write Controlled Substances, etc. ROUTINE: XUSER COMPONENT: $$LOOKUP VARIABLES: $$LOOKUP Type: Output The return is in the same format as a call to DIC. IEN^NAME Input Type: XUF Type: Input Parameter "Q" or "A" passed in. Usage S LRDOC=$$LOOKUP^XUSER("") This extrinsic function will do a lookup on the NEW PERSON file screening out uses that are TERMINATED. By default the call will ask if the correct user was selected. ie: Select NEW PERSON NAME: XUUSER,THREE Is XUUSER,THREE the one you want? YES// If the parameter is set to "Q" then this extra question is suppressed. If the parameter is set to "A" then don't select current users who have a termination date prior to today's date The return is in the same format as a call to DIC. IEN^NAME Adding new entry's isn't allowed. COMPONENT: $$ACTIVE VARIABLES: IEN Type: Input This is the IEN for the entry to be checked. $$ACTIVE Type: Output "" No user record. 0 User can't sign-on. 0^DISUSER User can't sign-on because of DISUSER flag. 0^TERMINATED^2980310 User terminated on date. 1^NEW A new user, could sign-on. 1^ACTIVE^2980310.09 An active user, last sign-on date. This API returns the active status indicator and latest signon information of a user in the NEW PERSON (#200) file. Usage S X=$$ACTIVE^XUSER(ien) Parameter: pointer to the NEW PERSON file. It returns the following codes: "" No user record. 0 User can't sign-on. 0^DISUSER User can't sign-on because of DISUSER flag. 0^TERMINATED^2980310 User terminated on date. 1^NEW A new user, could sign-on. 1^ACTIVE^2980310.09 An active user, last sign-on date. COMPONENT: $$PROVIDER VARIABLES: XUDA Type: Input This is the IEN for the entry to be checked. $$PROVIDER Type: Output "" No user record. "0^TERMINATED^2980310" User terminated on date. "1" Has a record and no termination date. XUF Type: Input Flag to control processing. 0 or not passed, do not include Visitors 1 include Visitors This entry point was added for CPRS. The definition of a provider is any entry in the new person file that doesn't have a termination date. A second parameter could be added to invoke other checks. Usage S X=$$PROVIDER^XUSER(XUDA,XUF) Parameter: IEN=pointer to the NEW PERSON file. XUF=flag to control processing 0 or not passed, do not include Visitors 1 include Visitors It returns the following codes: "" No user record. "0^TERMINATED^2980310" User terminated on date. "1" Has a record and no termination date. COMPONENT: $$DEA VARIABLES: $$DEA Type: Output DEA# (#53.2) field or the value returned based on the (optional) FLAG input parameter. *Note: Fee Basis,C&A providers will only return DEA# or null. Example 1: --------- DEA# (#53.2) field is "AB1234567" FACILITY DEA NUMBER field (#52) is "VA7654321" VA# field (#53.3) is "789" If the FLAG input parameter is null or "0", this API would return "AB1234567". If the FLAG input parameter is "1", this API would return "AB1234567". Example 2: --------- DEA# (#53.2) field is null FACILITY DEA NUMBER field (#52) is "VA7654321" VA# field (#53.3) is "789" If the FLAG input parameter is null or "0", this API would return "VA7654321-789". If the FLAG input parameter is "1", this API would return "789" Example 3: --------- DEA# (#53.2) field is null FACILITY DEA NUMBER field (#52) is "VA7654321" VA# field (#53.3) is null If the FLAG input parameter is null or "0", this API would return "". If the FLAG input parameter is "1", this API would return "" In both cases it returns an empty string. Example 4: --------- DEA# (#53.2) field is null FACILITY DEA NUMBER field (#52) is "VA7654321" VA# field (#53.3) is "789" PROVIDER TYPE field (#53.6) is "FEE BASIS" or "C&A" If the FLAG input parameter is null or "0", this API would return "". If the FLAG input parameter is "1", this API would return "" In both cases it returns an empty string. Example 5: --------- DEA# (#53.2) field is "AB1234567" but expired FACILITY DEA NUMBER field (#52) is "VA7654321" VA# field (#53.3) is "789" PROVIDER TYPE field (#53.6) is not a "FEE BASIS" nor a "C&A" If the new XPAR parameter 'PSOEPCS EXPIRED DEA FAILOVER' is set to 'Yes', API would return "VA7654321-789" If this parameter is set to 'No', API would return null (""). Example 6: --------- DEA# (#53.2) field is "AB1234567" DEA EXPIRATION DATE is "3201105" If the DATE parameter "3201104" passed in is less than DEA EXPIRATION DATE, this API would return "AB1234567". If the DATE parameter "3201106" passed in is greater than DEA EXPIRATION DATE, this API would return null (""). IEN Type: Input This is the New Person file (#200) IEN for the entry to be checked. FLAG(optio Type: Input This flag controls what is returned when the user does not have a value in the DEA# field (#53.2) of the NEW PERSON file (#200). * FLAG is null or "0" -- This routine will check to see if the user has values in the VA# field (#53.3) of the NEW PERSON file (#200) and the (new) FACILITY DEA NUMBER field (#52) of the INSTITUTION file (#4). If values are found in both of those fields, this routine will return the following: FACILITY DEA NUMBER field (#52)_"-"_VA# field(#53.3) * FLAG is "1" -- This routine will check to see if the user has a value in the VA# field (#53.3) of the NEW PERSON file (#200). If a value is found in that field, this routine will return that field value. Otherwise, this routine returns an empty string. DATE(optio Type: Input This parameter to enter in VA FileMan format. The date to be checked against the DEA# Expiration Date instead of default DT (today's date). The initial patch XU*8*580 provides this API and also adds a new field, FACILITY DEA NUMBER (#52), to the INSTITUTION file (#4). Usage: S X=$$DEA^XUSER(FLAG,IEN,DATE) This API returns a user's DEA number, if it exists in the DEA# (#53.2) field in the NEW PERSON (#200) file. If the DEA# field value is NULL, the value returned depends on the optional flag input parameter. COMPONENT: $$NAME VARIABLES: IEN Type: Input This is the IEN of the user in the New Person file #200. FORMAT(opt Type: Input This should be either "F" or "G", to indicate if the user's name should be returned formatted by Family or Given name, respectively. For example, "F"-Family (e.g., "Xuuser,Two") "G"(default)-Given (e.g., "Two Xuuser") $$NAME Type: Output The full name of the specified user in a mixed case displayable format; the user's given name (i.e. First Last) will be returned unless a second parameter of "F" is passed in to get the Family name (i.e. Last,First) This entry point returns the full name of the specified user in a mixed case displayable format; the user's given name (i.e. First Last) will be returned unless a second parameter of "F" is passed in to get the Family name (i.e. Last,First) Usage: S NAME=$$NAME^XUSER(IEN[,format]) COMPONENT: $$SDEA VARIABLES: FG(optiona Type: Input This flag is used for $$DEA call refer to description under $$DEA^XUSER component. IEN Type: Input This is the New Person file (#200) IEN for the entry to be checked. PSDEA Type: Input This parameter is DEA schedule. DEA schedule is a 2-6 position field. It comes from the DRUG file (#50) in Pharmacy. This field is used, by this API, to verify the provider is allowed to write orders for specific controlled substances. For example: if the schedule is 2A, this indicates a controlled substance, schedule 2. Chart for all values: 0 MANUFACTURED IN PHARMACY 1 SCHEDULE 1 ITEM 2 SCHEDULE 2 ITEM 3 SCHEDULE 3 ITEM 4 SCHEDULE 4 ITEM 5 SCHEDULE 5 ITEM 6 LEGEND ITEM 9 OVER-THE-COUNTER L DEPRESSANTS AND STIMULANTS A NARCOTICS AND ALCOHOLS P DATED DRUGS I INVESTIGATIONAL DRUGS M BULK COMPOUND ITEMS C CONTROLLED SUBSTANCES - NON NARCOTIC R RESTRICTED ITEMS S SUPPLY ITEMS B ALLOW REFILL (SCH. 3, 4, 5 ONLY) W NOT RENEWABLE F NON REFILLABLE E ELECTRONICALLY BILLABLE N NUTRITIONAL SUPPLEMENT U SENSITIVE DRUG $$SDEA Type: Output Returns: DEA# or Facility DEA_"-"_user VA# similar to the $$DEA call. 1 - DEA# is null from the $$DEA call. 2 - when all schedules equals '0'. 4^expiration date - DEA# expiration date has expired. It will check if DEA# and expiration date are not null. The expiration date is returned in external format. DATE(optio Type: Input This parameter to enter in VA FileMan format. The date to be checked against the DEA# Expiration Date instead of default DT (today's date). The DEA e-Prescribing of Control Substances project requires an API to utilize the following 'Privileges Algorithm' to check for prescribing privileges: -Blank = never answered (Allow all schedules but system to send the following electronic message: "DEA credentials have not been populated, call TBD responsible person.") -Any or all fields are answered = provide explicit set of permissions (that have been identified). -If it is answered that Prescriber has No privileges for all schedules = remove DEA number or VA number from file 200. -If Prescriber has been issued a DEA number, you have privileges. -If the Prescriber has been issued a VA number, this is a presumption of privileges. (Note: All of these checks do not apply to documentation of non-VA medication.) This API calls the $$DEA^XUSER() API (documented within this ICR). Usage: S X=$$SDEA^XUSER(FG,IEN,PSDEA,DATE) COMPONENT: $$DETOX VARIABLES: IEN Type: Input The IEN of user in NEW PERSON file (#200). $$DETOX Type: Output Returns: one of the following: - User's DETOX/MAINTENANCE ID number-If valid. - NULL-DETOX/MAINTENANCE ID number is NULL or the DEA EXPERATION DATE (#747.44) field in the NEW PERSON (#200) file is unpopulated. - DEA EXPIRATION DATE (#747.44)-When the DETOX/MAINTENANCE ID number is valid but the DEA EXPIRATION DATE has expired. DATE(optio Type: Input This parameter to enter in VA FileMan format. The date to be checked against the DEA# Expiration Date instead of default DT (today's date). This API obtains the value stored in the DETOX/MAINTENANCE ID NUMBER (#53.11) field in the NEW PERSON (#200) file. Usage: S X=$$DETOX^XUSER(IEN,DATE) COMPONENT: $$VDEA VARIABLES: RETURN Type: Input This is a reference to an array where the reasons why the user cannot sign orders for controlled substances and which DEA schedules the user can prescribe will be returned in. For example, RETURN("Is permitted to prescribe all schedules.)="" IEN Type: Input This is the IEN of the user in the NEW PERSON file (#200). $$VDEA Type: Output Returns: 1 - if the user is able to sign orders for controlled substances. 0 - if the user is not able to sign orders for controlled substances. RETURN Type: Output This array contains the reasons why the user cannot sign orders for controlled substances and which DEA schedules the user can prescribe. For example, RETURN("Is not permitted to prescribe any schedules.")="" The DEA electronic Prescribing of Controlled Substances (ePCS) project requires an API to determine if a user in the NEW PERSON file (#200) is able to sign orders for controlled substances. Usage: S X=$$VDEA^XUSER(.RETURN,IEN) ******************** 2345 NAME: D&PPM CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: JUN 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 410 ROOT: PRCS DESCRIPTION: TYPE: File ^PRCS(410,D0,0) 4 INVENTORY DISTRIBUTI 0;6 Read w/Fileman ROUTINE: ******************** 2346 NAME: DBIA2346 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: VISUAL IMPAIRMENT SERVICE TEAM USAGE: Private ENTERED: MAR 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File We were tasked to make the class III VIST software a nationally supported product. In doing so, we eliminated many of the unsupported calls to other packages and files. The following is a list of the remaining unsupported calls to the PATIENT file (#2). We will need a DBIA to cover these calls. ^DPT(D0,.31) .314 CLAIM FOLDER LOCATIO .31;4 Read w/Fileman The original version of the option "Individual Patient Record" references the CLAIM FOLDER LOCATION field (#.312) of the PATIENT File. This was not on the supported reference list. This field, CLAIM FOLDER LOCATION(#.312), has been starred for deletion. In our cleanup of the VIST software, we replaced this with the new field CLAIM FOLDER LOCATION(#.314). We will need a DBIA to allow this type of read. The lines of code read: S DIC="^DPT(",DA=DFN,DR=.314,DIQ="AN RV(" D EN^DIQ1 S ANRV(8)=ANRV(2,DFN,.314) .313 CLAIM NUMBER .31;3 Read w/Fileman The VARO CLAIMS file (#2043.5) has a print template [ANRV CLAIM REQ INQ] used in the option "Individual Claims Record" that references the CLAIM NUMBER field .313 in the PATIENT File (#2). We request read access on the CLAIM NUMBER field in the PATIENT file via FileMan extended syntax. ^DPT(D0,.372,D1,0) .01 RATED DISABILITIES ( .372,D1; Direct Global Read & w The routines used for the option "Individual Patient Record" reference the .372 node (Rated Disabilities sub-file). This is not on the supported reference list and I do not know of a supported API. We need a DBIA to have read access on the .372 node of the PATIENT file. The lines of code look like this: F I=0:0 S I=$O(^DPT(DFN,.372,I)) Q:'I D .S Y=+$G(^DPT(DFN,.372,I,0)),Y(1)=$P( ^(0),U,2) .02 PERCENTAGE .372,D1; Direct Global Read & w The routines used for the option "Individual Patient Record" reference the .372 node (Rated Disabilities sub-file). This is not on the supported reference list and I do not know of a supported API. We need a DBIA to have read access on the .372 node of the PATIENT file. The lines of code look like this: F I=0:0 S I=$O(^DPT(DFN,.372,I)) Q:'I D .S Y=+$G(^DPT(DFN,.372,I,0)),Y(1)=$P( ^(0),U,2) ^DPT(D0,.36) .361 PRIMARY ELIGIBILITY .36;1 Read w/Fileman VIST ROSTER File (#2040) .01 Field trigger references the PRIMARY ELIGIBILITY CODE Field (.361) in the PATIENT File. The trigger moves the current information from the PRIMARY ELIGIBILITY CODE field (.361) into the VA ELIGIBILITY CODE field in the VIST ROSTER file when the patient's name is added. We request the ability to access this field via a FileMan trigger cross-reference. ^DPT(D0,.32) .323 PERIOD OF SERVICE .32;3 Read w/Fileman The VIST ROSTER File (#2040) contains a computed field PERIOD OF SERVICE that uses the field PERIOD OF SERVICE .323 in the PATIENT File. We request a DBIA to access the PERIOD OF SERVICE field in the PATIENT File (#2) via FileMan. ^DPT(D0,.11) .117 COUNTY .11;7 Read w/Fileman The VIST ROSTER file (#2040) contains a computed field COUNTY (10) that uses the COUNTY field (.117) and the STATE field (.115) in the PATIENT File (#2). We need to request a DBIA to access the COUNTY field (.117) and the STATE field (.115) in the PATIENT file (#2) via FileMan. The computed field has the following algorithm: NAME:STATE:COUNTY:COUNTY:NAME_VA COUNTY CODE_COUNTY The actual FileMan generated code reads as follows: 2040,10 COUNTY ; COMPUTED MUMPS CODE: X ^DD(2040,10,9.6) S X=X_$P(Y(2040,10,303),U,3) _$P(Y(2040,10,303),U,1) S D0=Y(2040,10,80) S D1=Y(2040,10,281) 9.2 = S I(200)="^DIC(5,",J(200)=5 F D=0:0 S (D,D1)=$N(^DIC(5,D0,1,D)) Q:D'>0 I $D(^(D,0))#2 S X=$P(^(0),U,1) X DICMX Q:'$D(D) S D=D1 9.3 = S Y(2040,10,80)=$S($D(D0):D0,1:""),Y (2040 ,10,1)=$S($D(^ANRV(2040,D0,0)):^(0 ),1:""), D0=$P (Y(2040,10,1),U,1) S:'$D(^DPT(+D0,0)) D0=-1 S Y (2040,10,180)=$S($D(D0):D0,1:"") 9.4 = X ^DD(2040,10,9.3) S Y(2040,10,101)=$S($D (^DPT(D0,.11)):^(.11),1:""),D0=$P( Y(2040,1 0,101 ),U,5) S:'$D(^DIC(5,+D0,0)) D0=-1 S Y(2040,10,2 80)=$S($D(D0):D0,1:"") 9.5 = X ^DD(2040,10,9.4) S Y(2040,10,281)=$S($D (D1):D1,1:"") X ^DD(2040,10,9.2):D0>0 S X="" K DIC S Y=-1,DIC="^DIC(5,D0,1,",DIC(0)="NM F" D ^DIC:D0>0 S (D,D1)=+Y .115 STATE .11;5 Read w/Fileman The VIST ROSTER file (#2040) contains a computed field COUNTY (10)that uses the COUNTY field (.117) and the STATE field (.115) in the PATIENT File (#2). We need to request a DBIA to access the COUNTY field (.117) and the STATE field (.115) in the PATIENT file (#2) via FileMan. The computed field has the following algorithm: NAME:STATE:COUNTY:COUNTY:NAME_VA COUNTY CODE_COUNTY The actual FileMan generated code reads as follows: 2040,10 COUNTY ; COMPUTED MUMPS CODE: X ^DD(2040,10,9.6) S X=X_$P(Y(2040,10,303),U,3) _$P(Y(2040,10,303),U,1) S D0=Y(2040,10,80) S D1=Y(2040,10,281) 9.2 = S I(200)="^DIC(5,",J(200)=5 F D=0:0 S (D,D1)=$N(^DIC(5,D0,1,D)) Q:D'>0 I $D(^(D,0))#2 S X=$P(^(0),U,1) X DICMX Q:'$D(D) S D=D1 9.3 = S Y(2040,10,80)=$S($D(D0):D0,1:""),Y (2040 ,10,1)=$S($D(^ANRV(2040,D0,0)):^(0 ),1:""), D0=$P (Y(2040,10,1),U,1) S:'$D(^DPT(+D0,0)) D0=-1 S Y (2040,10,180)=$S($D(D0):D0,1:"") 9.4 = X ^DD(2040,10,9.3) S Y(2040,10,101)=$S($D (^DPT(D0,.11)):^(.11),1:""),D0=$P( Y(2040,1 0,101),U,5) S:'$D(^DIC(5,+D0,0)) D0=-1 S Y(2040,10,2 80)=$S($D(D0):D0,1:"") 9.5 = X ^DD(2040,10,9.4) S Y(2040,10,281)=$S($D (D1):D1,1:"") X ^DD(2040,10,9.2):D0>0 S X="" K DIC S Y=-1,DIC="^DIC(5,D0,1,",DIC(0)="NM F" D ^DIC:D0>0 S (D,D1)=+Y ROUTINE: ******************** 2347 NAME: DBIA2347 CUSTODIAL PACKAGE: FEE BASIS SUBSCRIBING PACKAGE: VISUAL IMPAIRMENT SERVICE TEAM USAGE: Private ENTERED: MAR 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 161 ROOT: FBAAA( DESCRIPTION: TYPE: File We were tasked to make the class III VIST software a nationally supported product. In doing so, we eliminated many of the unsupported calls to other packages and files. The following is a list of the remaining unsupported calls to the FEE BASIS PATIENT file (#161). The VIST software contains a report titled "Fee Basis List". It includes a sort template [ANRV FEE PT] and print template [ANRV FEE PT] with references to NAME (.01), the AUTHORIZATION multiple subfile (#161.01), FROM DATE(.01), TO DATE(.02), and TREATMENT TYPE CODE (.095) fields in the FEE BASIS PATIENT File (#161). We request read access via FileMan extended syntax for the FEE BASIS PATIENT fields NAME, AUTHORIZATION, FROM DATE, TO DATE, and TREATMENT TYPE CODE. Below is a capture of the templates in question and the report it generates. Here is an example of the report output; FEE PATIENT LISTING MAR 19,1998 12:40 PAGE 1 NAME SSN FROM DATE TO DATE TREATMENT TYPE CODE -------------------------------------------------------------------------- ANRVPATIENT,ONE 000-00-4444 FEB 17,1998 APR 18,1998 I.D. CARD STATUS ------------------------------ COUNT 1 This is a copy of the Sort Template; WANT TO EDIT 'ANRV FEE PT' TEMPLATE? NO// y YES NAME: ANRV FEE PT// READ ACCESS: WRITE ACCESS: SORT BY: @INTERNAL(VIST ELIGIBLE (AMIS))'="I";L1 Replace By 'VIST ELIGIBLE ', do you mean VIST ROSTER 'VIST ELIGIBLE (AMIS)'? Yes// (Yes) WITHIN INTERNAL(VIST ELIGIBLE (AMIS))'="I", SORT BY: @NAME// * Previous selection: NAME not null START WITH NAME: FIRST// WITHIN NAME, SORT BY: AUTHORIZATION// NAME:FEE BASIS PATIENT: By 'FEE BASIS PATIENT', do you mean the FEE BASIS PATIENT File, pointing via its 'NAME' Field? Yes// (Yes) FEE BASIS PATIENT FIELD: 1// AUTHORIZATION (multiple) AUTHORIZATION SUB-FIELD: TREATMENT TYPE CODE["CARD"&(TO DATE>T);L1 Replace WITHIN TREATMENT TYPE CODE["CARD"&(TO DATE>T), SORT BY: STORE IN 'SORT' TEMPLATE: INTEGRATION CONTROL REGISTRATIONS LIST MAY 12, 2021@12:53 PAGE 2 REMOTE PROCEDURE:DESCRIPTION -------------------------------------------------------------------------------- This is a copy of the Print template; WANT TO EDIT 'ANRV FEE PT' TEMPLATE? No// Y (Yes) NAME: ANRV FEE PT// READ ACCESS: WRITE ACCESS: FIRST PRINT FIELD: NAME;C1!// THEN PRINT FIELD: NAME:$E(SSN,1,3)_"-"_$E(SSN,4,5)_"-"_$E(SSN,6,9);"SSN" Replace By 'SSN', do you mean PATIENT 'SOCIAL SECURITY NUMBER'? Yes// (Yes) By 'SSN', do you mean PATIENT 'SOCIAL SECURITY NUMBER'? Yes// (Yes) By 'SSN', do you mean PATIENT 'SOCIAL SECURITY NUMBER'? Yes// (Yes) THEN PRINT FIELD: NAME:FEE BASIS PATIENT: Replace By 'FEE BASIS PATIENT', do you mean the FEE BASIS PATIENT File, pointing via its 'NAME' Field? Yes// (Yes) THEN PRINT FEE BASIS PATIENT FIELD: AUTHORIZATION// (multiple) THEN PRINT AUTHORIZATION SUB-FIELD: FROM DATE;C48// THEN PRINT AUTHORIZATION SUB-FIELD: TO DATE// THEN PRINT AUTHORIZATION SUB-FIELD: TREATMENT TYPE CODE// THEN PRINT AUTHORIZATION SUB-FIELD: THEN PRINT FEE BASIS PATIENT FIELD: THEN PRINT FIELD: We will need a DBIA to cover these calls. ^FBAAA(D0,1,D1,0) .01 FROM DATE 1;1 Read w/Fileman .02 TO DATE 1;2 Read w/Fileman .095 TREATMENT TYPE CODE 1;13 Read w/Fileman ^FBAAA(D0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2348 NAME: SERVICE CONNECTED CONDITIONS CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES DENTAL CLINICAL PROCEDURES VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: MAR 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API returns if the Service Connected and Conditions should/can be asked for a patient at a date/time. It also returns the current answers if any in Scheduling for an encounter for the patient at that date/time. ROUTINE: PXUTLSCC COMPONENT: SCCOND VARIABLES: Format of call: D SCCOND^PXUTLSCC(DFN,ENCDT,HOSPLOC,VISIT,.RETURN) Input Parameters: DFN pointer to PATIENT file (#2) ENCDT date and time of the encounter HOSPLOC pointer to HOSPITAL LOCATION file (#44) for the encounter VISIT (optional) pointer to VISIT file (#9000010) for the encounter if know Output Parameters: RETURN this is an array subscripted by "SC","CV","AO","IR","EC", "SHAD","MST", "HNC", and "CLV" that contains two pieces each first piece: 1 if the condition can be answered 0 if it should be null second piece: the answer that Scheduling has if it has one 1 ::= yes, 0 ::= no example: >ZW RETURN RETURN("AO") = "1^1" RETURN("EC") = "0^" RETURN("IR") = "0^" RETURN("SC") = "1^0" RETURN("CV") = "0^" RETURN("MST") = "0^" RETURN("HNC") = "0^" RETURN("SHAD") = "0^" RETURN("CLV") = "1^0" Can ask SC and if it is no then can ask AO but do not ask EC or IR. The current answers stored in Scheduling are NO for SC and YES for AO. ******************** 2349 NAME: ACTIVE PROVIDER CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES REGISTRATION SCHEDULING ADDED 7/13/07 USAGE: Controlled Subscri ENTERED: MAR 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This checks to see if a provider is active on the system and if they have an active Person Class on a given date. ROUTINE: PXAPI COMPONENT: ACTIVPRV VARIABLES: Format of Call $$ACTIVPRV^PXAPI(PROVIDER,DATETIME) Input parameters: PROVIDER pointer to provider in the NEW PERSON file (#200) DATETIME (optional) the date (and optional time) of to check if not passed the DT is used Returns 1 if provider is good 0 if provider is not active or does not have a Person Class on given date COMPONENT: PRVCLASS VARIABLES: Format of call: $$PRVCLASS^PXAPI(PROVIDER,DATETIME) Input parameters: PROVIDER pointer to provider in the NEW PERSON file (#200) DATETIME (optional) the date (and optional time) to check if not passed the DT is used Returns IEN^Occupation^specialty^sub-specialty^Effective date^expiration date ^VA Code if + of the return is >0 provider is active else -1 the provider is not active or bad call else -2 if no current person class ******************** 2350 NAME: DBIA2350 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: MAR 26,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Pharmacy Data Management requests permission to export the Inpatient Medications menu option PSJI IVCATEGORY. ROUTINE: ******************** 2351 NAME: OUTPATIENT ENCOUNTER SEARCH CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS ACCOUNTS RECEIVABLE USAGE: Private ENTERED: MAR 26,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine IBSDU is a routine I written for IB that provides a generic interface to the ACRP APPLICATION INTERFACE TOOL (AIT) introduced by Scheduling patch SD*5.3*131. The particular function that AICS needs is the 'SCAN' functionality that allows for a search for data in the encounter file without using the now prohibited direct file access. ROUTINE: IBSDU COMPONENT: SCAN VARIABLES: IBINDX Type: Input The index name 'property' of the Outpaitent Encounter Query object. This is how the query will be scanned - by patient, patient and date, date or by encounter. This determines the the cross reference to be used to perform the scan. VALID VALUES: PATIENT = individual patient PATIENT/DATE = individual patient and date or date range DATE/TIME = date or date range VISIT = individual encounter IBVAL Type: Input This is an array containing the actual values to use to scan the Outpatient Encounter Query object: IBVAL("DFN") = Patient ien IBVAL("BDT") = Earliest date/time to start scan IBVAL("EDT") = Last date/time to include in the scan IBVAL("VIS") = Encounter ien IBFILTER Type: Input The executable code to be used to filter (screen) entries when scanning using the Outpatient Encounter Query object. Unless the Call Back logic is very complicated and time consuming, it is more efficient to add an 'IF' statement to the Call Back logic than to use the FILTER property. IBCBK Type: Input This is the code that is executed for every outpatient encounter found during the execution of the Outpatient Encounter Query object's SCAN event that passes the 'filter' logic, if any. This directs the object as to what it should do with each valid encounter it finds. IBCLOSE Type: Input This is a flag that stipulates whether the Query object should be closed once the scan is completed. Due to the overhead of setting up the Outpatient Encounter Query object, it should not be opened and closed each time it is called if it is being used to 'loop'. The first 'scan' would open the Query and the last one would indicate to close it. Valid Values: 0 (or null) - DO NOT CLOSE QUERY 1 - CLOSE QUERY ON COMPLETION IBQUERY Type: Both The number coresponding to the Outpatient Encounter Query object that needs to be executed. This parameter is optional for a Query that is being closed and will not be reused. If passed by reference and the object is not requested to close, the value returned can be used for subsequent calls to the object to avoid the overhead associated with the opening of a Query object. IBDIR Type: Input This is a flag [optional] that specifies the direction of the search. VALID VALUES: FORWARD or null - Scan from first to last (default if undefined) BACKWARD - Scan from last to first IBZXERR Type: Input This is the name of the array that will be returned containing any errors found during the SCAN. If this variable is not defined, no errors will be returned. All errors returned are in the same format as the errors returned in the Fileman database server calls. This entrypoint uses the ACRP Applications Interface Tools (AIT) to scan through a date or date range and find encounter data for one or more patients. It is parameter driven. ******************** 2353 NAME: DBIA2353-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.11 ROOT: AUPNVIMM( DESCRIPTION: TYPE: File This is to allow for the reading of the set of codes with the Fileman call D FIELD^DID(9000010.11,field,"","POINTER","target_root","msg_root"). This is used by a RPC to pass the values for the field to the CPRS GUI. ^AUPNVIMM( .04 SERIES [0;4] Read w/Fileman .06 REACTION [0;6] Read w/Fileman .07 CONTRAINDICATED [0;7] Read w/Fileman ROUTINE: ******************** 2354 NAME: DBIA2353-B CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK( DESCRIPTION: TYPE: File This is to allow for the reading of the set of codes with the Fileman call D FIELD^DID(9000010.12,field,"","POINTER","target_root","msg_root"). This is used by a RPC to pass the values for the field to the CPRS GUI. ^AUPNVSK( .04 RESULTS [0;4] Read w/Fileman ROUTINE: ******************** 2355 NAME: DBIA2353-C CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.13 ROOT: AUPNVXAM( DESCRIPTION: TYPE: File This is to allow for the reading of the set of codes with the Fileman call D FIELD^DID(9000010.13,field,"","POINTER","target_root","msg_root"). This is used by a RPC to pass the values for the field to the CPRS GUI. ^AUPNVXAM( .04 RESULT [0;4] Read w/Fileman ROUTINE: ******************** 2356 NAME: DBIA2353-D CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.16 ROOT: AUPNVPED( DESCRIPTION: TYPE: File This is to allow for the reading of the set of codes with the Fileman call D FIELD^DID(9000010.16,field,"","POINTER","target_root","msg_root"). This is used by a RPC to pass the values for the field to the CPRS GUI. ^AUPNVPED( .06 LEVEL OF UNDERSTANDI [0;6] Read w/Fileman ROUTINE: ******************** 2357 NAME: DBIA2353-E CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF( DESCRIPTION: TYPE: File This is to allow for the reading of the set of codes with the Fileman call D FIELD^DID(9000010.23,field,"","POINTER","target_root","msg_root"). This is used by a RPC to pass the values for the field to the CPRS GUI. ^AUPNVHF( .04 LEVEL/SEVERITY [0;4] Read w/Fileman ROUTINE: ******************** 2358 NAME: DISCONTINUE OP MEDS ON DATE OF DEATH CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: APR 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PSOCAN3 COMPONENT: APSOD(DA) VARIABLES: DA Type: Input The DFN of the Patient. This is invoked from a Date of Death cross-reference to discontinue all active outpatient medications. It is effective for OP v 7 or higher. ******************** 2360 NAME: DBIA2360 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: APR 8,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM DESCRIPTION: TYPE: File In order to calculate the percentage of deaths within a Medical Center that results in Autopsy, direct global reads of ^DGPM("ATID3", and $P(^DGPM(DO,0),U,18) are requested by the Laboratory Package. ^DGPM(DO,0) .18 MAS MOVEMENT TYPE 0;18 Direct Global Read & w Field is a pointer to the MAS Movement Type file. Global contains the following cross-reference: ^DGPM("ATID3", which lists all PATIENT MOVEMENT TYPES of DISCHARGE. Read access is also requested for this cross-referernce in order for the calculations to be accurate. ^DGPM('ATID3', Cross Re ROUTINE: ******************** 2361 NAME: KILLING NODES IN DD FOR RATED DISABILITIES MULTIPLE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: APR 16,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Registration Package requests permission to kill 'extra' nodes descendant from ^DD(2.04,0,"NM") in the post-install for patch DG*5.3*147, leaving only ^DD(2.04,0,"NM","RATED DISABILITIES (VA)"). Justification ============= We are currently in testing for patch DG*5.3*147, which is National Enrollment. In part, this software consists of the transmission of patient data to local sites and its upload. We discovered that UPDATE^DIE was failing, resulting in the loss of the patient's rated disabilities. The cause was prior corruption of the DD for the 2.04 multiple (Rated Disabilities (VA)). There are extra nodes at the "NM" cross-reference. Deleting the nodes solved the problem. ROUTINE: ******************** 2362 NAME: DBIA2362-A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: APR 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19.081 ROOT: XUSEC(19, DESCRIPTION: TYPE: File Surgery request read access for all fields within the AUDIT LOG FOR OPTIONS File (#19.081), to produce a sorted audit report using the Surgery sort template, [SR BLOOD PRODUCT VERIFICATION]. The Surgery sort template, [SR BLOOD PRODUCT VERIFICATION] is coded to print the Audit Log for the Surgery option [SR BLOOD PRODUCT VERIFICATION] only. ^XUSEC(19,D0,0)= (#.01) OPTION [1P] ^ (#1) USER [2P] ^ (#2) DEVICE [3F] ^ ==>(#3) JOB [4N] ^ (#4) DATE/TIME OF EXIT FROM OPTION [5D] ^ ==>(#5) CPU [6F] ^ ^XUSEC(19,D0,1)= (#6) MESSAGE NUMBER [1N] ^ (#7) SENDER [2F] ^ ^XUSEC(19,D0,2)= (#8) SUBJECT [E1,65F] ^ ^XUSEC(19,D0,3)= (#9) ACTION [E1,245F] ^ ---------------------------------------------------------------------- Example of Sort Template SR BLOOD PRODUCT VERIFICATION; NAME: SR BLOOD PRODUCT VERIFICATION Replace READ ACCESS: @// WRITE ACCESS: @// SORT BY: ]DATE/TIME// * Previous selection: DATE/TIME from Jan 1,1998 START WITH DATE/TIME: FIRST// WITHIN DATE/TIME, SORT BY: OPTION["SR BLOOD PRODUCT VERIFICATION";L1 Replace WITHIN OPTION["SR BLOOD PRODUCT VERIFICATION", SORT BY: STORE IN 'SORT' TEMPLATE: FIRST PRINT FIELD: ^XUSEC(19,D0,0) .01 OPTION 0;1 Read w/Fileman This field indicates the name of the option being audited. POINTER TO OPTION FILE (#19) 1 USER 0;2 Read w/Fileman This field indicates the name of the user who has accessed the option. POINTER TO NEW PERSON FILE (#200) 2 DEVICE 0;3 Read w/Fileman A free text field, this field indicates the device used while the option was accessed. 3 JOB 0;4 Read w/Fileman This field records the job number associated with the option access. 4 DATE/TIME OF EXIT FR 0;5 Read w/Fileman This field marks the time when the user exited from the option. 5 CPU 0;6 Read w/Fileman This field records the CPU location of the option access. ^XUSEC(19,D0,1) 6 MESSAGE NUMBER 1;1 Read w/Fileman For a Server-type option this field will contain the message number in the Message File that activated (or tried to activate) the server option. This message is called the 'server request.' 7 SENDER 1;2 Read w/Fileman For a Server-type option this field will contain the return address of the person who initiated the server request, that is, the name of the person who sent the message that activated (or tried to activate) the option. ^XUSEC(19,D0,2) 8 SUBJECT 2;E1,65 Read w/Fileman For a Server-type option this field will contain the subject of the MailMan message that activated (or tried to activate) the option. ^XUSEC(19,D0,3) 9 ACTION 3;E1,245 Read w/Fileman For a Server-type option this field will contain the resulting action of a server request. In the event of an error, the error will be trapped by the server software and entered into this field. ROUTINE: ******************** 2363 NAME: DBIA2362-B CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: APR 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Surgery package requests permission to use the KERNEL print template, [XUOPTLOGP]. It will be called from the Surgery option, [SR BLOOD PRODUCT VERIFY AUDIT], to print the Audit Log for the Surgery option [SR BLOOD PRODUCT VERIFICATION]. ROUTINE: COMPONENT: [XUOPTLOGP] VARIABLES: KERNEL print template [XUOPTLOGP] used to print selected auditted options from the AUDIT LOG FOR OPTIONS File (#19.081). ******************** 2364 NAME: ASISTS use of fields in File 450 CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: ASISTS USAGE: Private ENTERED: APR 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 450 ROOT: PRSPC( DESCRIPTION: TYPE: File ^PRSPC( .01 EMPLOYEE NAME 0;1 Read w/Fileman 6 STATION NUMBER 0;7 Read w/Fileman 8 SSN 0;9 Read w/Fileman 10 EDUCATION 0;11 Read w/Fileman 13 GRADE 0;14 Read w/Fileman 16 OCCUPATION SERIES & 0;17 Read w/Fileman 31 SEX 0;32 Read w/Fileman 32 DATE OF BIRTH 0;33 Read w/Fileman 38 STEP 0;39 Read w/Fileman 458 COST CENTER/ORGANIZA 0;49 Read w/Fileman 604 LEVEL MISC;8 Read w/Fileman 80 SEPARATION IND 1;33 Read w/Fileman 19 PAY BASIS 0;20 Read w/Fileman 20 PAY PLAN 0;21 Read w/Fileman 26 RETIREMENT CODE 0;27 Read w/Fileman 28 SALARY 0;29 Read w/Fileman 186 RESIDENCE STATE ADD;6 Read w/Fileman 186.1 RESIDENCE ADDRESS LI ADD;7 Read w/Fileman 186.3 RESIDENCE ADDRESS LI ADD;9 Read w/Fileman 186.4 RESIDENCE ADDRESS ZI ADD;10 Read w/Fileman 226 FEGLI CODE FEGLI;4 Read w/Fileman 231 HEALTH INSURANCE FEHB;2 Read w/Fileman 30 SERVICE COMPUTATION 0;31 Read w/Fileman ROUTINE: ******************** 2365 NAME: Merge File Entries CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 27,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Overview A file in which entries need to be merged may be entered in the DUPLICATE RESOLUTION file (file 15.1). This requires adding the file as one which can be selected as the variable pointer, and search criteria would usually need to be specified to assist in identifying potential duplicate pairs (although an option can be use by which selected pairs can be added directly to the DUPLICATE RECORD file as verified duplicates). Verified duplicate pairs may be approved for merging, and a merge process generated for those approved pairs. A DUPLICATE RECORD file entry will also have handle files which are not associated as normal pointers identified in the PACKAGE file under the 'AFFECTS RECORD MERGE' subfile with special processing routines. ***IF A FILE HAS RELATED FILES WHICH ARE NOT NORMAL POINTERS, THEY SHOULD BE HANDLED ONLY AS ENTRIES IN THE DUPLICATE RECORD FILE AND THE TOOLKIT OPTIONS USED FOR MERGES INVOLVING THE FILE.*** The merge utility of Kernel Toolkit as revised by patch XT*7.3*23 provides an entry point which is available to developers for the merging of one or more pairs of records (a FROM record and a TO record) in a specified file. The merge process me rges the data of the FROM record into that of the TO record and deletes the FROM record, restoring by a hard set only the zero node with the .01 value on it until the merge process is completed (such that any references to that location via pointers will not error out). Any files which contain entries DINUMed with the data pairs are then also merged (and any files which are related to them by DINUM as well). Any pointers which can be identified rapidly by cross-references are modifie d so that references for the FROM entry become references to the TO entry instead. Following this, any files which contain other pointers are searched entry by entry to test for pointers to a FROM entry, and when found are modified to reference the TO entry. This search for pointer values is the most time consuming part of the entire process and may take an extended period depending upon the number of files that must be searched, the number of entries in those files, and how many levels of subfiles pointers may be located at. Since the search through these files will take the same period of time independent of the number of pairs which are being merged, it is suggested that as many pairs as convient be combined in one proc ess. At the end of the conversion of these pointers, the zero node stubs will be removed from the primary file and all related DINUMed files. The merge process is a single job which is tracked with frequent updates on location and status from start to finish. The job can be stopped at any time if necessary using Task Manager utilities (or in the event of a system crash, etc.) and restarted at the point of interruption at a later time. The manner in which data is merged. When a primary file or a DINUMed files entries are merged, any top level (single value) fields which are present in the FROM entry which are not present in the TO entry will be merged into the TO entries data. Any of these fields which contain cross-references will be entered using a VA File Manager utility (FILE^DIE) so that the cross-references will be fired. Other fields (those without cross-references) will be directly set into the data global. If a subfile entry exists in the FROM record which is not present in the TO record (as identified by the .01 value), that entry will be created with a VA File Manager utility (UPDATE^DIE) and the rest of the subfile merged over into the TO record and the cross-references within the subfile and any descendent subfiles run. If a subfile entry exists in the FROM record and an identical .01 value exists in the TO record, the subfile in the FROM record will be searched for any descendent subfiles which are not present in the TO record subfile. If such a subfile is found it will be merged into the subfile in the TO record and any cross-references in the merged subfile run. For fields which are simple pointers to the primary file (or any other file DINUMed to the primary file) the reference to the FROM record will be changed to a reference to the TO record. If the field contains a cross-reference this editing will be performed using a VA File Manager Utility call (FILE^DIE), otherwise it will be set directly into the global node. ROUTINE: XDRMERG COMPONENT: EN VARIABLES: FILE Type: Input Specifies the FILE NUMBER of the file in which the indcated entries are to be merged. ARRAYNAM Type: Input This variable contains the name of the array as a closed root under which the subscripts indicating the FROM and TO entries will be found. The data may have either two or four subscripts descendent from the array which is passed in. Please see the overall description provided for examples of its usage. The entry point EN^XDRMERG provides for merging of one or more pairs of records in a specified file. This entry point takes two (2) arguments, the file number (a numeric value) and a closed reference to the location where the program will find an array with subscripts indicating the record pairs to be merged (a text value). There can be either two or four subscripts in the data array as described below. the command D EN^XDRMERG(999000014,"MYLOC") would result in record pairs specified as subscripts in the array MYLOC to be merged in a hypotheical file 999000014. The array MYLOC might have been set up prior to this call in the following manner (or any equivalent way) where the subsripts represent the internal entry numbers of the FROM and TO records, respectively. S MYLOC(147,286)="",MYLOC(182,347)="",MYLOC(2047,192)="" S MYLOC(837,492)="",MYLOC(298,299)="" This would result in five record pairs being merged with record 147 (the FROM record) being merged into record 286 (the TO record), record 182 being merged into record 347, etc., to record 298 being merged into 299. Merges using the two subscript format will occur without a specific record of the entries prior to the merge (The internal entry numbers merged would be recorded under the file number in file 15.3) An alternative is a four subscript format for the data array which uses variable pointer formats for the FROM and TO records as the third and fourth subscripts. If the merge is performed with this four subscript array, then a premerge image of the data of both the FROM and TO records in the primary file and all other merged files (those related by DINUM) and information on all single value pointer values modified is stored in the MERGE IMAGE file (file 15.4). For the above example data [assuming that the global root for the hypothetical file 999000014 is ^DIZ(999000014,] the four subscript array might be generated using the following code S MYROOT=";DIZ(99900014," <--- note the leading ^ is ommitted S MYLOC(147,286,147_MYROOT,286_MYROOT)="" S MYLOC(182,347,182_MYROOT,347_MYROOT)="" S MYLOC(2047,192,2047_MYROOT,192_MYROOT)="" S MYLOC(837,492,837_MYROOT,492_MYROOT)="" S MYLOC(298,299,298_MYROOT,299_MYROOT)="" ; D EN^XDRMERG(99900014,"MYLOC") Exclusion of Multiple Pairs For a Record To insure that there are no unanticipated problems due to relationships between a specific record in multiple merges, prior to actually merging any data the various FROM and TO records included in the process are examined, and if one record is involved in more than one merge, all except the first pair of records involving that one are excluded from the merge. If any pairs are excluded for this reason, a mail message is generated to the individual responsible for the merge process as indicated by the DUZ. If the following entries were included in the MYLOC array MYLOC(128,247) MYLOC(128,536) and MYLOC(247,128) Only the first of these entries (based on the numeric sorting of the array) would be permitted to remain in the merge process, while the other two pairs would be omitted). And although it may seem unlikely that someone would indicate that a record should be merged into two different locations, while another location should be merged into one that was merged away, if the pairs are selected automatically and checks aren't included to prohibit such behavior, they will show up. That is why the merge process won't include more than one pair with a specific record in it. Problems Related To Data Entry While Merging The Merge Process has been designed to combine data associated with the two records in the manner described above. On occasion, however, there are problems which cause VA File Manager to reject the data that is being entered. This may happen for a number of reasons. Some that have been observed were: Clinics which had been changed so they no longer were indicated as Clinics (so they wouldn't add to the number that people had to browse through to select a clinic), but were rejected since the input transform checked that they be clinics; Pointer values that no longer had a valid value in the pointed to file (dangling pointers); Fields that have input transforms that prohibit data entry. :-) It is possible to use a validity checker on your data prior to initiating the actual merge process (this is the action taken by merges working from the Potential Duplicate file). The data pairs are processed in a manner similar to the actual merge, so only that data in any of the files which would be merged and for which the data would be entered using VA File Manager utilities for the specific pair are checked to insure they will pass the input transform. Any problems noted are incorporated into a mail message for resolution prior to attempting to merge the pair again, and the pair is removed from the data array that was passed in. Pairs which pass through this checking should not encounter any data problems while being merged. COMPONENT: RESTART VARIABLES: FILE Type: Input Specifies the FILE NUMBER of the file in which the indcated entries are to be merged. ARRAYNAM Type: Input This variable contains the name of the array as a closed root under which the subscripts indicating the FROM and TO entries will be found. The data may have either two or four subscripts descendent from the array which is passed in. Please see the overall description provided for examples of its usage. PHASE Type: Input This variable indicates the phase of the merge process in which the merge should be restarted. The value is a number in the range of 1 to 3, with no decimal places. Phase 1 is usually quite short and is the merge of the specified entries in the primary file. Phase 2 is the merging of entries in files which are DINUMed to the primary file and changing pointers which can be identified from cross-references. Phase 3 is finding pointer values by searching each entry in a file. This will usually be the longest phase of the merge process. CURRFILE Type: Input This is the current file NUMBER on which the merge process is operating. CURRIEN Type: Input This is the current internal entry number in the file on which the merge process is operating. This entry point is used to restart a merge which has been stopped. The information necessary for restarting may be viewed using the CHKLOCAL entry point in XDRMERG2 (see LOCAL MERGE STATUS). ******************** 2371 NAME: REATTACH SC TEAM AUTO-ADD PROTOCOL CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 28,1998 STATUS: Active EXPIRES: APR 23,1999 DURATION: Next Version VERSION: 3 FILE: ROOT: DESCRIPTION: TYPE: Other CPRS did an OOPS. When we attempted to add our protocol to theSC CLINIC ENTROLL/DISCHARGE EVENT DRIVER protocol, we ended up removing the SC TEAM AUTO-ADD protocol which was already attached. We would like permission to do the reattachment as part of OR*3*19. The patch sends SC TEAM AUTO-ADD as ATTACH AT SITE and SC CLINIC ENROLL/DISCHARGE EVENT DRIVER as USE AS LINK so we're not actually sending out the definitions, just making the connection. ROUTINE: COMPONENT: SC CLINIC ENROLL/DISCHARGE DRIVER VARIABLES: This protocol is being exported as USE AS LINK so we can reassign the SC TEAM AUTO-ADD protocol. COMPONENT: SC TEAM AUTO-ADD VARIABLES: This protocol is exported as ATTACH AT SITE to attach it to the SC CLINIC ENROLL/DISCHARGE EVENT DRIVER protocol. ******************** 2373 NAME: DIST(1.2 REFERENCE IN OE/RR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 29,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1.2 ROOT: DIST(1.2, DESCRIPTION: TYPE: File The Order Entry/Results Reporting module would like permission to reference the ALTERNATE EDITOR file. OE/RR uses the FM reader almost exclusively in the order dialog process. When taking actions such as copy and renew orders, it is necessary to allow comments (a word processing field) to be carried over. OE/RR would like to use the ALTERNATE EDITOR file to determine if the user is using the line editor. If not, it will display the text in the field prior to asking them if they want to edit it. Without this reference, always displaying the text in the field would cause those with the line editor to see it 2x. ^DIST(1.2,DA,0) .01 NAME 0;1 Read w/Fileman Used in an extrinsic function to return a 1 if the .01 is set to LINE EDITOR - VA FILEMAN. I 'X!($P($G(^DIST(1.2,+X,0)),U)="LIN E EDITOR - VA FILEMAN") S Y=1 ROUTINE: ******************** 2374 NAME: TOOLKIT NEEDS NAME CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT Toolkit would like permission to retrieve a file name from ^DIC(filenumber,0) via a direct global read. LAB SERVICE USAGE: Controlled Subscri ENTERED: APR 29,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC(filenumber,0) DESCRIPTION: TYPE: File The Parameter Tools component of Toolkit is a generic tool to allow setting parameters at various levels (system, package, etc.). In order to achieve this goal, it is necessary to make a direct global read to DIC to determine file name. ^DIC(filenumber,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2375 NAME: TOOLKIT NEEDS TO ACCESS VARIABLE PTR DEF CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: APR 29,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD(8989.5,.01,V DESCRIPTION: TYPE: File The Parameter Tools component of Toolkit allows setting of parameters at various levels. This necessitates a file structure with a variable pointer definition to point to the files which are allowed to be used through the Parameter Tools component. To ensure that no other files are pointed to, a check is done on the DD's "V" multiple, "B" cross-reference, to deterine whether an entry is in the variable pointer definitition. ^DD(8989.5,.01,V,B File 8989.5 is the Parameters file and its .01 is a variable pointer to multiple files. This reference allows the Parameter Tools component to ensure that only allowable files are being referenced. A function within toolkit returns a 1 if the file exists in the variable pointer definition or 0 otherwise. The following is the code it uses (in XPARDD1): ALLOW(FN) ; Screens allowable entities to variable ptrs in 8989.5,.01 ; ** VPDD ** see which files 8989.5 can point to Q:'FN 0 Q $D(^DD(8989.5,.01,"V","B",FN))>0 ROUTINE: ******************** 2376 NAME: DBIA2376 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: APR 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These entry points build drug information for patient's orders entered in the Inpatient Medications package. The data returned is used in order checks in Computerized Patient Record System. ROUTINE: PSJORUT2 COMPONENT: ENCHK VARIABLES: DFN Type: Input Patient internal entry number. PSJINX Type: Input Index number so duplicate drugs will be returned. PSGOCHK Type: Input Set to 1 if check should include dispense drugs in ^PS(53.45. PSIVOCHK Type: Input Set to 1 if check should include entries in DRG array. TMP($J,'OR Type: Output ^TMP($J,"ORDERS",PSJINX)= VA CLASSIFICATION^NATIONAL DRUG FILE ENTRY_"A"_PSNDF VA PRODUCT NAME ENTRY^DISPENSE DRUG NAME^ORDER NUMBER IN OR(100^INPATIENT MEDS ORDER NUMBER_";I" This entry point returns drug information for a specific patient's current orders in the Inpatient Medications package. COMPONENT: DDRUG VARIABLES: DDRUG Type: Input Dispense drug internal entry number. PSJINX Type: Input Index number so duplicate drugs will be returned. PSJORIEN Type: Input Internal entry number for order in ^OR(100. COD Type: Input Order number in Inpatient Meds. number_"P" if order is in ^PS(53.1. number_"U" if order is in ^PS(55. TMP($J,'OR Type: Output ^TMP($J,"ORDERS",PSJINX)= VA CLASSIFICATION^NATIONAL DRUG FILE ENTRY_"A"_PSNDF VA PRODUCT NAME ENTRY^DISPENSE DRUG NAME^ORDER NUMBER IN OR(100^INPATIENT MEDS ORDER NUMBER_IPOROP IPOROP-Set to ";O" if piece 2 of DDRUG array is "PSO". Set to ";N" if piece 2 of DDRUG array is "PSH". Defaults to an ";I". This entry point returns drug information for a single drug when it is chosen for an order. This is specifically used in IV orders to check against the other additives or solutions entered during a single order entry. ******************** 2377 NAME: DIR('V') usage in parameter tools CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: APR 30,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 7.3 FILE: ROOT: DESCRIPTION: TYPE: Other The parameter tools component of toolkit would like permission to use DIR("V") to ensure a silent interaction with the reader when doing data validation checks. ROUTINE: COMPONENT: DIR VARIABLES: DIR('V') Type: Input DIR("V") is an undocumented input variable to ^DIR that causes it to validate X based on the data type and parameters specified in DIR(0). It is like a silent data-type validator. Parameter Tools uses this variable when calling DIR to validate input values. DIR("V") is an undocumented input variable to ^DIR that causes it to validate X based on the data type and parameters specified in DIR(0). It is like a silent data-type validator. Parameter Tools uses this variable when calling DIR to validate input values. ******************** 2378 NAME: TEST FOR ADVERSE REACTION TO AGENT CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 6,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows a package to determine if a patient has an adverse reaction to an agent defined by the parameters TYP and PTR. ROUTINE: GMRAOR COMPONENT: $$ORCHK(DFN,TYP,PTR,LOC) VARIABLES: DFN Type: Input Patient's internal entry number (IEN) in the PATIENT file (#2). TYP Type: Input The type of agent to check. Possible values are: "CM" - Contrast Media Reaction "DR" - Drug Reaction "IN" - Drug Ingredient "CL" - Drug Class PTR Type: Input The agent to check for. Possible values are: If TYP="CM", PTR is ignored. If TYP="DR", PTR is formatted as PSNDA.PSNVPN, where PSNDA is the IEN to the VA GENERIC file (#50.6) and PSNVPN is the IEN to the VA PRODUCT file (#50.68). If TYP="IN", PTR is the IEN to the DRUG INGREDIENTS file (#50.416). If TYP="CL", PTR is the IEN to the VA DRUG CLASS file (#50.605). LOC Type: Input An optional location type flag. If TYP="CM" and LOC is defined and greater than 0, the type of site that documented the reaction ("LOCAL", "REMOTE SITE(S)", or "LOCAL AND REMOTE SITE(S)") will be returned in the second caret piece of $$ORCHK. If TYP="DR", TYP="IN", or TYP="CL", LOC is ignored. $$ORCHK Type: Output For all values of TYP, $$ORCHK will be defined as either an empty string if the parameters are incorrect or 0 if the patient has no reactions to the agent defined by the TYP and PTR parameters. The following additional values are returned depending on the value of TYP: If TYP="CM", $$ORCHK will be defined as either an empty string if the patient is not in the Adverse Reaction Tracking database or 1 if the patient has a reaction to contrast media. Additionally, if LOC is greater than zero, the second caret piece will contain the type of site that documented the reaction ("LOCAL", "REMOTE SITE(S)", or "LOCAL AND REMOTE SITE(S)"). If TYP="IN" or TYP="CL", $$ORCHK will be defined as 1 if the patient has a reaction to the agent defined by the PTR parameter. If TYP="DR" and the patient has a reaction to the agent defined in the PTR parameter, $$ORCHK will be defined as either 1 or 2. If the patient has a reaction to one of the ingredients in the agent defined by the PTR parameter, it will be 1. If the patient has a reaction to one of the drug classes to which the agent defined by the PTR parameter belongs, it will be 2. GMRAING Type: Output The calling application should either NEW this variable before calling this component or KILL this variable after it is no longer needed. If TYP="DR", this array will contain the drug ingredients in the agent defined by the PTR parameter to which the patient has a reaction to. Format: GMRAING(NUM)="ING (SD)" NUM - has a value of 1 for the first ingredient and increments by one for subsequent ingredients. ING - the name of the ingredient. SD - the type of site that documented the reaction. Possible values are "LOCAL" if only the current site documented the reaction, "REMOTE SITE(S)" if only a remote site documented the reaction, or "LOCAL AND REMOTE SITE(S)" if both the current and remote sites documented the reaction. If TYP="CM", TYP="IN", or TYP="CL", this array will be undefined. GMRADRCL Type: Output The calling application should either NEW this variable before calling this component or KILL this variable after it is no longer needed. If TYP="DR" and the patient does not have a reaction to any of the drug ingredients in the agent defined by the PTR parameter (GMRAING is undefined), this array will be defined. It will contain the drug classes of the agent defined by the PTR parameter to which the patient has a reaction to. Format: GMRADRCL(NUM)="DCC^DCN (SD)" NUM - has a value of 1 for the first drug class and increments by one for subsequent drug classes. DCC - five character code assigned to the drug class. DCN - the name of the drug class. SD - the type of site that documented the reaction. Possible values are "LOCAL" if only the current site documented the reaction, "REMOTE SITE(S)" if only a remote site documented the reaction, or "LOCAL AND REMOTE SITE(S)" if both the current and remote sites documented the reaction. If TYP="CM", TYP="IN", or TYP="CL", this array will be undefined. GMRAIEN Type: Output The calling application should either NEW this variable before calling this component or KILL this variable after it is no longer needed. If TYP="IN", this array will contain the PATIENT ALLERGIES file (#120.8) internal entry numbers (IENs) that match the ingredient defined by the PTR parameter as subscripts. If TYP="CL", this array will contain the PATIENT ALLERGIES file (#120.8) IENs that match the class defined by the PTR parameter as subscripts. Format: GMRAIEN(120.8_IEN)="" If TYPE="CM" or TYP="DR", this array will be undefined. $T Type: Output $T will be defined as 1 (True) if the patient has an allergy to an agent defined by the TYP and PTR variables, else it returns 0 (False). **NOTE: As of August 6, 1996 this variable is no longer supported. This call checks if the patient has an adverse reaction to an agent defined by the parameters TYP and PTR. **NOTE: Patch GMRA*4*46 was released on 05/24/2016 with a compliance date of 06/24/2016. This patch included the new $$ORCHK2 component, which is intended to replace this component. New subscribers should use the $$ORCHK2 component. A future patch will phase out the use of this component as subscribing applications move to the $$ORCHK2 component. COMPONENT: $$ORCHK2(DFN,TYP,PTR,LOC,RETURN) VARIABLES: DFN Type: Input Patient's internal entry number (IEN) in the PATIENT file (#2). TYP Type: Input The type of agent to check. Possible values are: "CM" - Contrast Media Reaction "DR" - Drug Reaction "IN" - Drug Ingredient "CL" - Drug Class PTR Type: Input The agent to check for. Possible values are: If TYP="CM", PTR is ignored. If TYP="DR", PTR is formatted as PSNDA.PSNVPN.LPTR, where PSNDA is the IEN to the VA GENERIC file (#50.6), PSNVPN is the IEN to the VA PRODUCT file (#50.68) and LPTR is the IEN to the DRUG file (#50). If PSNDA is passed in, then PSNVPN is required and LPTR is optional. LPTR may be passed in by itself, but the caller must include two preceding periods (i.e., "..1068"). If TYP="IN", PTR is the IEN to the DRUG INGREDIENTS file (#50.416). If TYP="CL", PTR is the IEN to the VA DRUG CLASS file (#50.605). LOC Type: Input An optional location type flag. If TYP="CM" and LOC is defined and greater than 0, the name of every site that documented the reaction and when each site documented the reaction will be returned in the second caret piece of $$ORCHK. If TYP="DR", TYP="IN", or TYP="CL", LOC is ignored. RETURN Type: Input Name of array in which to return order check messages. The name cannot be RETURN. If TYP="DR", data is returned in the named array. If TYP="IN", TYP="CL", or TYP="CM", RETURN is ignored. $$ORCHK2 Type: Output For all values of TYP, $$ORCHK2 will be defined as -1 if the parameters are incorrect, an empty string if the patient does not have an assessment or 0 if the patient has no known reactions to the agent defined by the TYP and PTR parameters. The following additional values are returned depending on the value of TYP: If TYP="CM" and the patient has a reaction to contrast media, $$ORCHK2 will be defined as 1. Additionally, if LOC is greater than zero, the second caret piece of $$ORCHK2 will contain the name of every site that documented the reaction and when each site documented the reaction. If TYP="IN" or TYP="DR" and the patient has a reaction to the agent defined in the PTR parameter, $$ORCHK2 will be defined as 1. If TYP="CL" and the patient has a reaction to the agent defined in the PTR parameter, $$ORCHK2 will be defined as 2. GMRAING Type: Output The calling application should either NEW this variable before calling this component or KILL this variable after it is no longer needed. If TYP="IN", this array will contain the drug ingredients in the agent defined by PTR to which the patient has a reaction to. Format: GMRAING(PTR)=Offender(s)^Caret-delimited string PTR - for local reactions, the internal entry number (IEN) in the PATIENT ALLERGIES file (#120.8) and for remote reactions, "R" followed by the reaction's number in the ^XTMP("ORRDI","ART",DFN) global (DFN is the patient's IEN in the PATIENT file, #2). Offender(s) - Drug ingredient(s) found in both the reaction and in the agent. Contains two sub-fields separated by the pipe character. Multiple ingredients are separated by "~". Sub-field 1: NAME field (#.01) in the DRUG INGREDIENTS file (#50.416) Sub-field 2: IEN in the DRUG INGREDIENTS file (#50.416) Caret-delimited string: For those pieces that contain sub-fields, the sub-fields are separated by the pipe character. Piece Value ============================================ ====== 1 Station Documenting Reaction Sub-field 1: NAME field (#.01) in the INSTITUTION file (#4) Sub-field 2: IEN in the INSITUTION file (#4) 2 Site Type of Documenting Station Sub-field 1: External format ("REMOTE" or "LOCAL") Sub-field 2: Internal format ("R" or "L") 3 ORIGINATION DATE/TIME field (#4) in the PATIENT ALLERGIES file (#120.8) Sub-field 1: External format Sub-field 2: Internal FileMan format 4 Severities String 5 REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) Sub-field 1: External format Sub-field 2: Internal format Multiple reactions are separated from each other with "~". 6 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) 7 GMR ALLERGY field (#1) in the PATIENT ALLERGIES file (#120.8) Sub-field 1: External format Sub-field 2: Internal format 8 OBSERVED/HISTORICAL field (#6) in the PATIENT ALLERGIES file (#120.8) Sub-field 1: External format Sub-field 2: Internal format 9 Database Type Sub-field 1: External format ("VISTA" or "COTS") Sub-field 2: Internal format ("V" or "C") Severities String - The reaction's severities. Contains two sub-fields separated by "|".| Multiple severities are separated by "~". Subfield 1: DATE/TIME OF EVENT field (#.01) in the ADVERSE REACTION REPORTING file (#120.85) Subfield 2: SEVERITY field (#14.5) in the ADVERSE REACTION REPORTING file (#120.85) If TYP="CM", TYP="DR", or TYP="CL", this array will be undefined. GMRADRCL Type: Output The calling application should either NEW this variable before calling this component or KILL this variable after it is no longer needed. If TYP="CL", this array will be defined. It will contain the drug classes of the agent defined by PTR to which the patient has a reaction to. Format: GMRADRCL(PTR)="Offender(s)^Caret-delimited string" PTR - for local reactions, the internal entry number (IEN) in the PATIENT ALLERGIES file (#120.8) and for remote reactions, "R" followed by the number in the ^XTMP("ORRDI","ART",DFN) global (DFN is the patient's IEN in the PATIENT file, #2). Offender(s) - VA drug class(es) found in both the reaction and in the agent. Contains two sub-fields separated by the pipe character. Multiple VA drug classes are separated by "~". Sub-field 1: NAME field (#.01) in the VA DRUG CLASS file (#50.605) Sub-field 2: IEN in the VA DRUG CLASS file (#50.605) Caret-delimited string: refer to the caret delimited string section in the GMRAING output variable. If TYP="CM", TYP="DR", or TYP="IN", this array will be undefined. RETURN Type: Output The calling application should either NEW the variable identified by the INPUT parameter RETURN before calling this component or KILL the variable identified by the INPUT parameter RETURN after it is no longer needed. If TYP="DR", this array will contain the data needed to construct the order check messages as well as the reaction data related to the message data. Format: RETURN=N N - total number of order check messages RETURN(X,PTR)=Caret-delimited string X - message number; starts at one and increments by one PTR - for local reactions, the internal entry number (IEN) in the PATIENT ALLERGIES file (#120.8) and for remote reactions, "R" followed by the reaction's number in the ^XTMP("ORRDI","ART",DFN) global (DFN is the patient's IEN in the PATIENT file, #2). Caret-delimited string - Reaction data associated with message X; all fields are in internal format Piece Value ============================================ ====== 1 Station Documenting Reaction IEN in INSTITUTION file (#4) 2 Site Type of Documenting Station "R" or "L" 3 ORIGINATION DATE/TIME field (#4) in the PATIENT ALLERGIES file (#120.8) 4 Severities String 5 REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) Multiple reactions are separated from each other with "~". 6 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) 7 GMR ALLERGY field (#1) in the PATIENT ALLERGIES file (#120.8) 8 OBSERVED/HISTORICAL field (#6) in the PATIENT ALLERGIES file (#120.8) 9 Database Type "V" or "C" Severities String - The reaction's severities. Contains two sub-fields separated by "|".| Multiple severities are separated by "~". Subfield 1: DATE/TIME OF EVENT field (#.01) in the ADVERSE REACTION REPORTING file (#120.85) Subfield 2: SEVERITY field (#14.5) in the ADVERSE REACTION REPORTING file (#120.85) RETURN(X,"MESSAGE",1)=N N - total number of stations included in this message RETURN(X,"MESSAGE",1,Y)=Caret-delimited string Y - internal entry number (IEN) of the documenting station's entry in the INSTITUTION file (#4) Caret-delimited string - site-specific data; all fields are in external format Piece Value ============================================ ====== 1 Station documenting reaction NAME field (#.01) in the INSTITUTION file (#4) 2 Site Type of Documenting Station "REMOTE" or "LOCAL" 3 ORIGINATION DATE/TIME field (#4) in the PATIENT ALLERGIES file (#120.8) 4 OBSERVED/HISTORICAL field (#6) in the PATIENT ALLERGIES file (#120.8) RETURN(X,"MESSAGE",1,Y,1,Z)=Caret-delimited string Z - Severity number; starts at one and increments by one. Corresponds to the severity's position number in the severities string in RETURN(X,PTR). Caret-delimited string - observation data; all fields are in external format Piece Value ============================================ ====== 1 DATE/TIME OF EVENT field (#.01) in the ADVERSE REACTION REPORTING file (#120.85) 2 SEVERITY field (#14.5) in the ADVERSE REACTION REPORTING file (#120.85) RETURN(X,"MESSAGE",2)=Caret-delimited string Caret-delimited string - reaction-specific data combined from all sites included in message X; all fields are in external format Piece Value ============================================ ====== 1 REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) 2 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) 3 GMR ALLERGY field (#1) in the PATIENT ALLERGIES file (#120.8) RETURN(X,"MESSAGE","OFFENDERS",SUB)= Tilde-delimited string SUB - the type of reaction item that was matched with the agent; "ING" for ingredient, "CLS" for class or "REC" for reactant (GMR ALLERGY field, #1, in the PATIENT ALLERGIES file, #120.8) Tilde-delimited string - the causative agents that were matched in external format delimited by "~" If TYP="IN", TYP="CL" or TYP="CM", the variable identified by the INPUT parameter RETURN will not be modified. This call checks if the patient has an adverse reaction to an agent defined by the parameters TYP and PTR. ******************** 2380 NAME: GMRD(120.82 USAGE IN OE/RR CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: MAY 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.82 ROOT: GMRD(120.82, DESCRIPTION: TYPE: File ^GMRD(120.82,'B', Allow use of B index to determine if an entry exists in the file and obtain the entry's IEN. ^GMRD(120.82, 1 ALLERGY TYPE 0;2 Direct Global Read & w ^GMRD(120.82,'D', Read access to the D index. ROUTINE: ******************** 2381 NAME: OE/RR REFERENCES TO PS(51.2, CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING OE/RR uses the "B" index to determine if there is an existing entry in the file and, if there is, determine that entry's IEN. USAGE: Controlled Subscri ENTERED: MAY 6,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 51.2 ROOT: PS(51.2, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. The Order Entry/Results Reporting package requests permission to access the NAME and ABBREVIATION fields in the MEDICATION ROUTES file (#51.2). ^PS(51.2,DA,0) .01 NAME 0;1 Direct Global Read & w 1 ABBREVIATION 0;3 Direct Global Read & w 3 PACKAGE USE 0;4 Direct Global Read & w 4 OUTPATIENT EXPANSION 0;2 Direct Global Read & w ROUTINE: ******************** 2382 NAME: OUTPATIENT PHARMACY/CIRN CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP USAGE: Private ENTERED: MAY 7,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OP v 6.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Outpatient Pharmacy provides the CIRN package prescription data at various stages in the prescription life cycle. The data is provided through the use of a single entry point EN^RGEQ("RX",RX IEN) in the CIRN package. The following Outpatient Pharmacy routines call this entry point from the lines indicated: ROUTINE LINE PSOAUTOC CAN+16 PSOBUILD GET+18 PSOCAN3 ADD+1 PSODISP BATCH+11 PSODISPS QTY+16 PSOHLD UHLD+10 UHLD+14 H+8 PSORESK BC1+21 PAR+14 PSORXED1 DIE+6 ROUTINE: RGEQ COMPONENT: EN("RX",RX IEN) VARIABLES: IEN Type: Input The internal entry # from the PRESCRIPTION file (#52). The call EN^RGEQ("RX",RX) where RX represents the internal entry number of a prescription from the PRESCRIPTION file (#52). ******************** 2383 NAME: SEND INPT MEDS TO CPRS CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: MAY 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call, OCL^PSJORRE, returns the Inpatient Medications data that is passed to Computerized Patient Record System and used for display in the CPRS meds screen. ROUTINE: PSJORRE COMPONENT: OCL VARIABLES: DFN Type: Input Patient's internal entry number. BDT Type: Input Date/Time to start search for medications. (optional) EDT Type: Input Date/Time to end search for medications. (optional) TFN Type: Input Subscript number to begin using for orders found. Each orders is placed into ^TMP("PS",$J,TFN). The variable TFN is incremented for each order. TMP('PS',$ Type: Output ^TMP("PS",$J,TFN,0)=ORDER #_File;I^DRUG^INFUSION RATE^STOP DATE^^TOTAL DOSE^UNITS PER DOSE^PLACER #^STATUS^^^^NOT TO BE GIVEN^PENDING RENEWAL (1 or 0) FILE: U = unit dose order (file #55, subfile 55.06) V = IV order (file #55, subfile 55.01) P = Pending order (file 53.1) ^TMP("PS",$J,TFN,"MDR",0)= # of LINES ^TMP("PS",$J,TFN,"MDR",D1,0)=MED ROUTE ABBR. ^TMP("PS",$J,TFN,"SCH",0)= # of LINES ^TMP("PS",$J,TFN,"SCH",D1,0)=SCHEDULE NAME ^TMP("PS",$J,TFN,"A",0)= # of LINES ^TMP("PS",$J,TFN,"A",D1,0)=ADDITIVE NAME^AMOUNT^BOTTLE ^TMP("PS",$J,TFN,"B",0)= # of LINES ^TMP("PS",$J,TFN,"B",D1,0)=SOLUTION NAME^AMOUNT^PRINT NAME {2} ^TMP("PS",$J,TFN,"P",0)=IEN^.01 of VA 200 ^TMP("PS",$J,TFN,"SIG",0)= # of LINES ^TMP("PS",$J,TFN,"SIG",D1,0)=SIG (outpatient) or INSTRUCTIONS (inpatient) ^TMP("PS",$J,TFN,"ADM",0)= # of LINES ^TMP("PS",$J,TFN,"ADM",D1,0)=ADMINISTRATION TIMES Where: administration time = Free text 2-119 characters ^TMP("PS",$J,TFN,"RMV",0)= # of LINES ^TMP("PS",$J,TFN,"RMV",D1,0)=REMOVAL TIMES Where: Removal time = Free text 2-119 characters ^TMP("PS",$J,TFN,"SIO",0)= # of LINES ^TMP("PS",$J,TFN,"SIO",D1,0)=SPECIAL INSTRUCTIONS/OTHER PRINT INFO (Special instructions = Free text 1-180 characters) ^TMP("PS",$J,TFN,"P",0)=PROVIDER IEN^.01 of VA(200 ^TMP("PS",$J,TFN,"IVLIM",0)=IV LIMIT ^TMP("PS",$J,TFN,"CLINIC",0)=CLINIC NUMBER ^TMP("PS",$J,TFN,"IND",0)=INDICATION OCL Type: Output Numeric value of 0,1,2,3 or null to denote which sorting option to print the display in CPRS. (optional) 0 or null - This provides the medication list as it was prior to CPRS GUI v27 so that other applications calling this API will not see any changes. 1 - Sorts by Status Group, Stop Date/Expiration Date. Following is the sort order: Pending ------- NON VERIFIED NON-VERIFIED PENDING Active/Hold ----------- ACTIVE ON CALL REFILL REINSTATED RENEWED SUSPENDED HOLD PROVIDER HOLD DONE DRUG INTERACTIONS Expired ------- EXPIRED Discontinued/Deleted -------------------- DATE OF DEATH ENTERED DELETED DISCONTINUED DISCONTINUED (EDIT) DISCONTINUED (RENEWAL) DISCONTINUED BY PROVIDER PURGE 2 - Sorts by Status Group, Status Location, Drug Name Alpha Characters. Following is the sort order: Active ------ ACTIVE REFILL HOLD SUSPENDED PROVIDER HOLD ON CALL Pending ------- NON-VERIFIED DRUG INTERACTIONS INCOMPLETE PENDING Discontinued ------------ DONE EXPIRED DISCONTINUED DELETED DISCONTINUED BY PROVIDER DISCONTINUED (EDIT) REINSTATED RENEWED 3 - Sorts by Drug (Alphabetically), Status Active, Status Recent, Expired (using ORCH context meds stop date). Condensed Med list call. OCL^PSJORRE(DFN,BDT,EDT,TFN,MVIEW): Passed: DFN - Patient's Internal Pointer BDT - Date/Time to start search for medications (optional) EDT - Date/Time to terminate search for medications (optional) TFN - Entry number to begin using for each order returned. MVIEW - Sort format for the returned display information (optional) ******************** 2384 NAME: DBIA2384 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: MAY 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call, OEL^PSJORRE1, returns the Inpatient Medications order data that is passed to Computerized Patient Record System. This array is used for the meds screen detailed order display. ROUTINE: PSJORRE1 COMPONENT: OEL VARIABLES: DFN Type: Input Patient internal entry number. ON Type: Input ON = ORDER #_FILE (from condensed list) FILE: U = unit dose order (file #55, subfile 55.06) V = IV order (file #55, subfile 55.01) P = Pending order (file 53.1) TMP('PS',$ Type: Output ^TMP("PS",$J,0)=DRUG^INFUSION RATE^STOPDATE^^START DATE^EXTERNAL STATUS^^^TOTAL DOSE^UNIT PER DOSE^PLACER #^^NOT TO BE GIVEN^PENDING RENEWAL (1 or 0) ^TMP("PS",$J,"MDR",0)= # of LINES ^TMP("PS",$J,"MDR",D1,0)=MED ROUTE ABBR. ^TMP("PS",$J,"SCH",0)= # of LINES ^TMP("PS",$J,"SCH",D1,0)=SCHEDULE NAME^SCHEDULE TYPE NAME^SCHEDULE TYPE CODE ^TMP("PS",$J,"SIG",0)= # of LINES ^TMP("PS",$J,"SIG",D1,0)=SIG (outpatient) or INSTRUCTIONS (inpatient) ^TMP("PS",$J,"PC",0)= # of LINES ^TMP("PS",$J,"PC",D1,0)=PROVIDER COMMENTS ^TMP("PS",$J,"A",0)= # of LINES ^TMP("PS",$J,"A",D1,0)=ADDITIVE NAME^AMOUNT^BOTTLE ^TMP("PS",$J,"ALOG",0) = # of LINES from ACTIVITY LOG multiple of File #53.1 ^TMP("PS",$J,"ALOG",D1,0) = ACTIVITY LOG DATE^ACTIVITY LOG USER [IEN into VA 200]^ACTION [IEN into File #53.3]^FIELD CHANGED DUE TO ACTIVITY^OLD FIELD DATA ^TMP("PS",$J,"B",0)= # of LINES ^TMP("PS",$J,"B",D1,0)=SOLUTION NAME^AMOUNT^PRINT NAME {2} ^TMP("PS",$J,"P",0)=IEN^.01 of VA 200 ^TMP("PS",$J,"ADM",0)= # of LINES ^TMP("PS",$J,"ADM",D1,0)=ADMINISTRATION TIMES Where: administration time = Free text 2-119 characters ^TMP("PS",$J,"RMV",0)= # of LINES ^TMP("PS",$J,"RMV",D1,0)=REMOVAL TIMES Where: Removal time = Free text 2-119 characters ^TMP("PS",$J,"SIO",0)= # of LINES ^TMP("PS",$J,"SIO",D1,0)=SPECIAL INSTRUCTIONS/OTHER PRINT INFO (Special instructions = Free text 1-180 characters) ^TMP("PS",$J,"IND",0)=1 ^TMP("PS",$J,"IND",1,0)=INDICATION ^TMP("PS",$J,"DD",0) = # of LINES ^TMP("PS",$J,"DD",D1,0)= DISPENSE DRUG IEN(from the U/D order)^Unit per Dose^CORRESPONDING OUTPATIENT DRUG IEN^ORDERABLE ITEM IEN ^TMP("PS",$J,"P",0)=Provider IEN^.01 of VA 200 Condensed Med list call. OEL^PSJORRE1(DFN,ON): Passed: DFN - Patient's Internal Pointer ON - ORDER #_FILE (from condensed list) FILE: U = unit dose order (file #55, subfile 55.06) V = IV order (file #55, subfile 55.01) P = Pending order (file 53.1) ******************** 2385 NAME: DBIA2385 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAY 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Consolidated Mail Outpatient Pharmacy (CMOP) Package requests an integration agreement with the Outpatient Pharmacy (OP) V. 7.0 package. The agreement covers a single entry point in the OP package at EN^PSOHLSN1(IEN #52, "ZD"). These two parameters are the only ones that are required. Others are optional. Prescription event data is passed through the OP package to the Clinical Information Resources Network (CIRN) package in the form of the Rx internal entry # from file 52. No data is returned to the CMOP package from the CIRN package. This agreement also covers the same entry point in the OP package at EN^PSOHLSN1(IEN #52, "SC"). These two parameters are the only ones that are required. Others are optional. In this case, the prescription event data is passed to the Computerized Patient Record System (CPRS) package to update status information for CMOP prescriptions. No data is returned to the CMOP package. ROUTINE: PSOHLSN1 COMPONENT: EN VARIABLES: IEN Type: Input IEN file # 52. A prescription IEN (file #52) is passed to the OUTPATIENT PHARMACY package, which hands the information to the CIRN software if called as EN^PSOHLSN1(IEN #52, "ZD") or to the CPRS software if called as EN^PSOHLSN1(IEN #52, "SC") ******************** 2386 NAME: PARAMETER TOOLS POINTS TO FILE 1 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File The Parameter Tools portion of Toolkit requests approval to point to the file of files (file #1). Parameter Tools uses this pointer to determine allowable files for setting up parameters. ROUTINE: ******************** 2387 NAME: LAB(60 USAGE IN OE/RR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VBECS USAGE: Controlled Subscri ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests permission to access the following fields and cross-references in the LABORATORY TEST file (#60). ^LAB(60, .01 NAME 0;1 Direct Global Read & w 4 SUBSCRIPT 0;4 Direct Global Read & w 320 REQUIRED COMMENT 0;19 Direct Global Read & w 9 LAB COLLECTION SAMPL 0;9 Direct Global Read & w 51 PRINT NAME .1;1 Direct Global Read & w ^LAB(60,D0,1, .01 SITE/SPECIMEN 0;1 Direct Global Read & w 8 UNITS 0;7 Direct Global Read & w 95.3 LOINC CODE 95.3;1 Direct Global Read & w ^LAB(60,D0,3, 7 REQUIRED COMMENT 0;6 Direct Global Read & w .01 COLLECTION SAMPLE 0;1 Direct Global Read & w 4 MAX. ORDER FREQ. 0;5 Direct Global Read & w 4.5 SINGLE DAY MAX ORDER 0;7 Direct Global Read & w ^LAB(60,DA,3,"B", Uses B index of COLLECTION SAMPLE multiple to look up entry. ^LAB(60,D0,2, .01 LAB TEST 0;1 Direct Global Read & w ^LAB(60,D0,8, .01 INSTITUTION 0;1 Direct Global Read & w 1 ACCESSION AREA 0;2 Direct Global Read & w ^LAB(60,"B", Global read access permitted ^LAB(60,D0,1,'B', Global read access permitted for SITE/SPECIMEN ROUTINE: ******************** 2388 NAME: LAB(61 USAGE IN OE/RR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA will be using the access in this ICR for VIAB ALLSPEC RPC and OrderMgmtSvc - getLabTestSpecPickLs USAGE: Private ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 61 ROOT: LAB(61, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests permission to access the following fields and cross-references in the TOPOGRAPHY FIELD file (#61). ^LAB(61,DA,0) .01 NAME 0;1 Direct Global Read & w 2 SNOWMED CODE 0;2 Direct Global Read & w ^LAB(61,'B', ^LAB(61,'C', ^LAB(61,'E', ^LAB(61,DA,64.91) 64.9103 INACTIVE DATE 64.91;1 Direct Global Read & w This field exists only in sites where the Laboratory System Re-engineering Project (LSRP) has been installed. It is the inactive date for this entry. When an entry is inactive, it should be selectable in CPRS for ordering purposes. The Inactive Date field is currently planned for distribution in Lab Re-engineering (patch LR*5.2*393). As of 2/12/13, it is not known if this patch will be nationally released. It is currently installed at the Huntington VAMC. There is also the possibility that a different LR patch will release this functionality. CPRS will reference the Inactive Date field for LSRP after the distribution of OR*3*315 scheduled for national release in February 2013. ROUTINE: ******************** 2389 NAME: LAB(62 USAGE IN OE/RR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VISTA INTEGRATION ADAPTOR VIA will be using the access in the ICR for their VIAB ALLSAMP RPC and OrderMgmtSvc - getLabSamplePickList USAGE: Private ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 62 ROOT: LAB(62, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests permission to access the following fields and cross-references in the COLLECTION SAMPLE file (#62). ^LAB(62,DA,0) .01 NAME 0;1 Direct Global Read & w 2 DEFAULT SPECIMEN 0;2 Direct Global Read & w 3 TUBE TOP COLOR 0;3 Direct Global Read & w 7 CAN LAB COLLECT 0;7 Direct Global Read & w ^LAB(62,DA,64.91) 64.9101 INACTIVE DATE 0;1 Direct Global Read & w The Inactive Date field is currently planned for distribution in Lab Re-engineering (patch LR*5.2*393). As of 2/12/13, it is not known if this patch will be nationally released. It is currently installed at the Huntington VAMC. There is also the possibility that a different LR patch will release this functionality. CPRS will reference the Inactive Date field for LSRP after the distribution of OR*3*315 scheduled for national release in February 2013. ROUTINE: ******************** 2390 NAME: LAB(62.05, USAGE IN OE/RR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 62.05 ROOT: LAB(62.05, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests permission to access the following fields in the URGENCY file (#62.05). ^LAB(62.05,DA,0) .01 URGENCY 0;1 Direct Global Read & w 1 CAN LAB COLLECT? 0;2 Direct Global Read & w 2 WORKLOAD ONLY 0;3 Direct Global Read & w 3 HL7 CODE 0;4 Direct Global Read & w ^LAB(62.05,'B', Use B index of file to look up entry. ROUTINE: ******************** 2391 NAME: LAB(62.07, USAGE IN OE/RR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 62.07 ROOT: LAB(62.07, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests permission to access the following field in the EXECUTE CODE file (#62.07). ^LAB(62.07,DA,.1) 1 EXECUTE CODE .1;1 Direct Global Read & w Executes value within OE/RR. ROUTINE: ******************** 2392 NAME: OE/RR ACCESS TO PS(51.1, CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 51.1 ROOT: PS(51.1, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. Order Entry/Results Reporting requests permission to access the following fields and cross-reference in the Administration Schedule file (#51.1). ^PS(51.1,DA,0) .01 NAME 0;1 Direct Global Read & w 1 STANDARD ADMINISTRAT 0;2 Direct Global Read & w 2 FREQUENCY (IN MINUTE 0;3 Direct Global Read & w 5 TYPE OF SCHEDULE 0;5 Direct Global Read & w 2.5 MAX DAYS FOR ORDERS 0;7 Direct Global Read & w ^PS(51.1,'AP'_nmsp, OE/RR uses the AP x-ref to access schedules by package prefix. ROUTINE: ******************** 2395 NAME: CALL TO GMRCAFRD CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Order Entry/Results Reporting packages requests approval to call FR^GMRCAFRD. ROUTINE: GMRCAFRD COMPONENT: FR(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123 Entry point to allow forwarding (rerouting) of a consult request. ******************** 2397 NAME: OE/RR CALL TO PSOHLUP CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 7 FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting calls PSOHLUP during the CPRS orders conversion. ROUTINE: PSOHLUP COMPONENT: EN1 VARIABLES: DFN Type: Input TALK Type: Input We pass in a 1 if we want it to 'talk' and a 0 if not. ******************** 2398 NAME: OE/RR CALL TO PSORENW CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Order Entry/Results Reporting would like approval to call the extrinsic function $$RENEW^PSORENW(ien). ROUTINE: PSORENW COMPONENT: $$RENEW(IEN) VARIABLES: IEN Type: Input Order number. $$RENEW Type: Output Returns a 1 if the order is renewable. A piece 2 will be included only if the Dispense Drug of the order is now matched to a different Pharmacy Orderable Item. This piece 2 will be the pointer value to the Pharmacy Orderable Item (#50.7) file. Returns a 0^reason if the order is not renewable. The reason (piece 2) is a short descriptive text that explains why the order is not renewable. Returns a -1 if the order cannot be found in Pharmacy. PSOCPDRG Type: Input This variable is the internal entry number of the Dispense Drug of the order. Extrinsic function to determine whether an order is renewable. ******************** 2399 NAME: OE/RR CALL TO PSOREF FOR REFILL CHECK CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting requests permission to call REFILL^PSOREF to determine whether an order is refillable. ROUTINE: PSOREF COMPONENT: REFILL VARIABLES: IEN Type: Input FLAG Type: Output Returns a 1 if order is refillable, 0 if not, -1 if order could not be found. Used to determine if an outpatient pharmacy order can be refilled. ******************** 2400 NAME: OE/RR CALLS TO PSOORRL CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES CLINICAL CASE REGISTRIES INPATIENT MEDICATIONS VBECS NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD SURGERY WOMEN'S HEALTH Women's Health will begin using this ICR in patch WV*1*24, part of the CPRS version 31 release. Women's Health needs to retrieve all of the contraceptive medications prescribed or administered to a patient, as well as the date last filled or last administered. With this information, Women's Health can calculate a patient's risk level of becoming pregnant while taking prescribed contraceptive medications. As some contraceptive medications are administered as clinic meds, Women's Health needs to retrieve both inpatient and outpatient medications. The risk level is calculated as low if the patient's prescription was last filled or a clinic medication was last administered within the last 100 days otherwise, the risk level is set to high. This data is only needed if the patient is identified within the Women's Health package as using a shot or pill, vaginal ring or patch as a contraceptive method. Women's Health is already approved to use ICR #6029 RETURN REMINDER ORDER CHECK ITEMS to identify contraceptive medications. VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: MAY 10,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting requests approval to make the following calls to PSOORRL. Patch PSO*7*622 updated OCL^PSOORRL with two new parameters to accept a second set of date ranges for Inpatient Medications. Previously, this API only supported one set of date ranges used for both Outpatient Medications and Inpatient Medications. Existing callers of this API will not see any change in behavior, as if nothing is passed into the new parameters, it will behave as it did previously. Only if a caller wishes to use different date ranges for Outpatient/Non-VA Medications and Inpatient Medication they need to utilize the new parameters. ROUTINE: PSOORRL COMPONENT: OCL VARIABLES: DFN Type: Input BEGDATEOUT Type: Input Beginning date for search of Outpatient & Non-VA medications. ENDDATEOUT Type: Input Ending date for search of Outpatient & Non-VA medications. TMP('PS',$ Type: Output Global location of returned list of meds. VIEW Type: Input Numeric value of 0,1,2,3 or null to denote which sorting option to print the display in CPRS. (optional) 0 or null - This provides the medication list as it was prior to CPRS GUI v27 so that other applications calling this API will not see any changes. 1 - Sorts the medication list by Prescription Status Group and Stop Date/Expiration Date. Following is the sort order: Pending group: Non-Verified Pending Active group: Active Hold Suspended (Active/Susp) Provider Hold Expired group: Expired Discontinued/Deleted group: Discontinued by Provider Discontinued (Edit) 2 - Sorts the medication list by Prescription Status Group, Status, and Drug Name. Following is the sort order: Active group: Active Hold Pending group: Non-Verified Pending Discontinued group: Discontinued by Provider Discontinued (Edit) 3 - Sorts the medication list by Drug Name, Active/Suspended and Stop Date/Expiration Date. BEGDATEINP Type: Input Beginning date for search of Inpatient medications. ENDDATEINP Type: Input Ending date for search of Inpatient medications. Note: If both BEGDATEINP and ENDDATEINP are not passed in to the API, then BEGDATEOUT and ENDDATEOUT will also be used for the Inpatient medications date range. Called to return a list of meds. OCL^PSOORRL(DFN,STARTDATEOUT,ENDDATEOUT,VIEW,STARTDATEINP,ENDD ATEINP) Passed: DFN - Patient's Internal Pointer StartdateOut - Date/Time to start search for Outpatient & Non-VA medications (optional) EnddateOut - Date/Time to terminate search for Outpatient & Non-VA medications (optional) View - Sort format for the returned display. (optional) StartdateInp - Date/Time to start search for Inpatient medications (Optional) EnddateInp - Date/Time to terminate search for Inpatient medications (Optional) Note: If both StartdateInp and EnddateInp are not passed in to the API, then StartdateOut and EnddateOut will also be used for the Inpatient medications date range. Returned: ^TMP("PS",$J,D0,0)=ORDER #_File;PKG^DRUG^INFUSION RATE^STOP DATE^REFILLS REMAINING^TOTAL DOSE^UNITS PER DOSE^PLACER #^STATUS^LAST FILLDATE^DAYS SUPPLY^QUANTITY^NOT TO BE GIVEN^PENDING RENEWAL (1 or 0)^ISSUE DATE(Outpatient) or START DATE(Inpatient)^LAST RELEASE DATE/TIME^LAST FILL DAY SUPPLY File: R;O = prescription (file #52), P;O = pending outpatient order (file #52.41), N;O = Non-VA Med (file #55, subfile #55.05), P;I = pending inpatient order (file #53.1), U;I = unit dose order (file #55, subfile 55.06), V;I = IV order (file #55, subfile 55.01) PKG = I (inpatient) or O (outpatient) ^TMP("PS",$J,D0,"MDR",0)= # of LINES ^TMP("PS",$J,D0,"MDR",D1,0)=MED ROUTE ABBR. ^TMP("PS",$J,D0,"SCH",0)= # of LINES ^TMP("PS",$J,D0,"SCH",D1,0)=SCHEDULE NAME ^TMP("PS",$J,D0,"A",0)= # of LINES ^TMP("PS",$J,D0,"A",D1,0)=ADDITIVE NAME^AMOUNT^BOTTLE ^TMP("PS",$J,D0,"B",0)= # of LINES ^TMP("PS",$J,D0,"B",D1,0)=SOLUTION NAME^AMOUNT ^TMP("PS",$J,D0,"P",0)=IEN^.01 of VA 200 ^TMP("PS",$J,D0,"SIG",0)= # of LINES ^TMP("PS",$J,D0,"SIG",D1,0)=SIG (outpatient) or INSTRUCTIONS (inpatient) ^TMP("PS",$J,"ADM",0)= # of LINES ^TMP("PS",$J,"ADM",D1,0)=ADMINISTRATION TIMES Where: administration time = Free text 2-119 characters ^TMP("PS",$J,"RMV",0)= # of LINES ^TMP("PS",$J,"RMV",D1,0)=REMOVAL TIMES Where: Removal time = Free text 2-119 characters ^TMP("PS",$J,"SIO",0)= # of LINES ^TMP("PS",$J,"SIO",D1,0)=SPECIAL INSTRUCTIONS/OTHER PRINT INFO (Special instructions = Free text 1-180 characters) ^TMP("PS",$J,D0,"P",0)=IEN of provider^.01 of VA 200. ^TMP("PS",$J,D0,"IND",0)=INDICATION COMPONENT: OEL VARIABLES: DFN Type: Input RXNUM Type: Input Prescription number. Returns detailed information on a particular pharmacy order. OEL^PSOORRL(DFN,ORDER) Passed: DFN - Patient's Internal Pointer ORDER - ORDER #_File;PKG (from condensed list) Returned: ^TMP("PS",$J,0)=DRUG^INFUSION RATE^STOPDATE^REFILLS REMAINING^START DATE^EXTERNAL STATUS^DAYS SUPPLY^QUANTITY^TOTAL DOSE^UNIT PER DOSE^PLACER #^LAST FILLDATE^NOT TO BE GIVEN^PENDING RENEWAL (1 or 0) ^TMP("PS",$J,"RXN",0)=EXTERNAL Rx NUMBER^LAST RELEASE DATE^ORIGINAL FILL ROUTING (W or M)^Remarks^FINISHED BY^ORIGINAL FILL DATE^ORIGINAL RELEASE DATE ^TMP("PS",$J,"RXN","RSTC")=ACTIVITY LOG^INITIATOR OF ACTIVITY^COMMENT ^TMP("PS",$J,"MDR",0)= # of LINES ^TMP("PS",$J,"MDR",D1,0)=MED ROUTE ABBR. ^TMP("PS",$J,"SCH",0)= # of LINES ^TMP("PS",$J,"SCH",D1,0)=SCHEDULE NAME ^TMP("PS",$J,"SIG",0)= # of LINES ^TMP("PS",$J,"SIG",D1,0)=SIG (outpatient) or INSTRUCTIONS (inpatient) ^TMP("PS",$J,"PAR",0) = # of LINES ^TMP("PS",$J,"PAR",n,0) = Fill Date^Days Supply^Quantity^Release Date^Routing (W or M)^REMARKS ^TMP("PS",$J,"PC",0)= # of LINES ^TMP("PS",$J,"PC",D1,0)=PROVIDER COMMENTS ^TMP("PS",$J,"A",0)= # of LINES ^TMP("PS",$J,"A",D1,0)=ADDITIVE NAME^AMOUNT^BOTTLE ^TMP("PS",$J,"B",0)= # of LINES ^TMP("PS",$J,"B",D1,0)=SOLUTION NAME^AMOUNT ^TMP("PS",$J,"P",0)=IEN of provider^.01 of VA 200 ^TMP("PS",$J,"ADM",0)= # of LINES ^TMP("PS",$J,"ADM",D1,0)=ADMINISTRATION TIMES Where: administration time = Free text 2-119 characters ^TMP("PS",$J,"RMV",0)= # of LINES ^TMP("PS",$J,"RMV",D1,0)=REMOVAL TIMES Where: Removal time = Free text 2-119 characters ^TMP("PS",$J,"SIO",0)= # of LINES ^TMP("PS",$J,"SIO",D1,0)=SPECIAL INSTRUCTIONS/OTHER PRINT INFO (Special instructions = Free text 1-180 characters) ^TMP("PS",$J,"DD",0) = # of LINES ^TMP("PS",$J,"DD",D1,0)= DISPENSE DRUG IEN(from the U/D order)^Unit per Dose^CORRESPONDING OUTPATIENT DRUG IEN^ORDERABLE ITEM IEN ^TMP("PS",$J,"REF",0) = # of LINES ^TMP("PS",$J,"REF",n,0) = Refill Date^Days Supply^Quantity^Release Date^Routing (W or M)^Remarks ^TMP("PS",$J,"REF",n,"RSTC")=ACTIVITY LOG^INITIATOR OF ACTIVITY^COMMENT ^TMP("PS",$J,"IND",0)=1 ^TMP("PS",$J,"IND",1,0)=INDICATION ******************** 2401 NAME: OE/RR CONVERSION CALL TO PSJIPST3 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The CPRS post-installation makes a call to BADNAMES^PSJIPST3 so that Inpatient Meds can send a list of IV orders where the user name could not be resolved. ROUTINE: PSJIPST3 COMPONENT: BADNAMES VARIABLES: ******************** 2402 NAME: INPATIENT MED CALLS FOR OE/RR CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting would like approval to make the following calls to PSJORUT2. ROUTINE: PSJORUT2 COMPONENT: $$ENNG(PSJDPT,PSJNUM) VARIABLES: PSJDPT Type: Input Patient DFN. PSJNUM Type: Input Order number $$ENNG Type: Output Returns a 1 if order should not be given; 0 otherwise. Call is made to determine whether a med order should be given. COMPONENT: ENVOL VARIABLES: OI Type: Input Pharmacy orderable item ARRAY Type: Input Name of array to return results in. Returns allowable volumes for a solution. ******************** 2403 NAME: OE/RR CALLS TO PSJORUTL CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting requests approval to make the following calls to PSJORUTL. ROUTINE: PSJORUTL COMPONENT: ENDD VARIABLES: PD Type: Input Primary Drug TYPE Type: Input O for Outpatient Med U for Unit Dose I for IV Med etc ARRAY Type: Input Name of array to be returned. Returns all local (DRUG file) entries associated with a National Drug file pointer. COMPONENT: ENRFA VARIABLES: DRUG Type: Input Pointer to DRUG file TYPE Type: Input O for Outpatient Med U for Unit Dose I for IV Med etc ARRAY Type: Input Name of array to be returned. Returns formulary alternatives for a dispense drug. COMPONENT: ENDCM VARIABLES: DRUG Type: Input Pointer to DRUG file RESULTS Type: Output Result of extrinsic function = price per dispense drug^message^NDF entry^PSNDF product name^Quantity dispense message Returns price, message, NDF entry, product name, and quantity dispense message. COMPONENT: ENDDIV VARIABLES: OI Type: Input Orderable Item pointer TYPE Type: Input Type of drug (A for additive; B for Base) VOLUME Type: Input Volume to uniquely identify orderable item. ARRAY Type: Input Name of array in which results will be returned. Returns all entries in DRUG file associated with Orderable Item. ******************** 2404 NAME: OE/RR CALL TO PSJORMAR CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting seeks approval to call MAR^PSJORMAR to print MAR label via Print Format. ROUTINE: PSJORMAR COMPONENT: MAR VARIABLES: DFN Type: Input ORDERNO Type: Input Order number FLAG Type: Input 1 to print patient data; 0 otherwise ARRAY Type: Input Name of array in which results will be returned. Allows printing of MAR label ******************** 2405 NAME: OE/RR CALLS TO PSSHL1 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1 FILE: ROOT: DESCRIPTION: TYPE: Routine Order Entry/Results Reporting wishes to document the call to EN1^PSSHL1 which is used to populate pharmacy orderables into the OE/RR ORDERABLE ITEM file. ROUTINE: PSSHL1 COMPONENT: EN1 VARIABLES: Called to populate Orderable Items file (#101.43) ******************** 2406 NAME: OE/RR CONVERSION CALLS LR7OV2 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is to document OE/RR v3's call to EN^LR7OV2 as part of the CPRS Orders conversion. ROUTINE: LR7OV2 COMPONENT: EN VARIABLES: ORVP Type: Input Variable pointer reference to patient FLAG Type: Input 0 if call should be silent; 1 if it can 'talk' This entry point will convert lab orders for a particular patient. ******************** 2407 NAME: OE/RR REFERENCES TO LRO(69, CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: MAY 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 69 ROOT: LRO(69, DESCRIPTION: TYPE: File Order Entry/Results Reporting requests approval to make the following refrences to the Lab Order Entry file (#69). ^LRO(69,D0,1, .01 LRDFN 0;1 Direct Global Read & w 7 PROVIDER 0;6 Direct Global Read & w .11 OERR ORDER # 0;11 Direct Global R/W & w/ 13 COLLECTION STATUS 1;4 Direct Global Read & w 16 WARD COMMENTS WP Direct Global Read & w ^LRO(69,D0,1,'AA', ^LRO(69,DA(2),1,DA(1),2,'B', ^LRO(69,D0,1,D1,2, 6 OERR ID 0;6 Direct Global Read & w ^LRO(69,'C', ^LRO(69,'D', ROUTINE: ******************** 2409 NAME: 2409 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: MAY 11,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 410 ROOT: PRCS(410, DESCRIPTION: TYPE: File ^PRCS(410,D0, .01 TRANSACTION NUMBER 0;1 Read w/Fileman ROUTINE: ******************** 2410 NAME: ENTER PROGRESS NOTE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY This entry point is used by the Outpatient Pharmacy package to enter progress notes after the entry of new prescriptions. Before attempting to make the call to this entry point a check is first made to see if the routine with the entry point reside on the system. The call is made as follows: I $T(MAIN^TIUEDIT)]"" D MAIN^TIUEDIT(3,.TIUDA,PSODFN,"","","","",1) CONSULT/REQUEST TRACKING Used to enter text of consult using TIU interface. INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: MAR 12,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point allows a package to invoke the TIU note entry process. ROUTINE: TIUEDIT COMPONENT: MAIN(TIUCLASS,SUCCESS,DFN,TIUTITLE,EVNTFLAG,NOSAVE,TIUNDA,TIUSNGL ,TIUCHNG) VARIABLES: TIUCLASS Type: Input The IEN of the TIU DOCUMENT DEFINITION file (#8925.1). SUCCESS Type: Input Passed in as a parameter array - .TIUDA DFN Type: Input Poniter to Patient file (#2). TIUSNGL Type: Input Passed in set to 1. TIUCHNG Type: Output Optional. Passed in by reference. Returns array TIUCHNG, whose subscripts describe changes made to an existing document. In particular, user addended or was invited to addend the document, or user edited away the text of an existing document, upon which the document was deleted. Used by TIU Interdisciplinary Notes to determine whether or not to rebuild a List Manager display after user asks to create a new document and ends up addending or editing an existing document instead. This entry point is used to allow a progress note to be entered for a known patient. ******************** 2411 NAME: DBIA2411 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: MAY 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point is used to backfill/convert a patients Inpatient Medications orders after the installation of Outpatient Pharmacy version 7.0, and Inpatient Medications version 5.0. ROUTINE: PSJUTL1 COMPONENT: CONVERT(PSOEDFN,PSOEWRT) VARIABLES: PSOEDFN Type: Input The internal entry number of the patient to be converted/backfilled. PSOEWRT Type: Input This variable is a 0 or 1. If 0, then it is a tasked job, and nothing is to be written. If 1, then a user has accessed the patient in the foreground, and messages can be written to the screen. This entry point is used to convert/backfill orders to CPRS from the Inpatient Medications package, after installation of Inpatient Medications version 5.0. ******************** 2412 NAME: ON-THE-FLY ORDERS CONVERSION CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE OUTPATIENT PHARMACY INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: MAY 14,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3 FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA is a controlled subscription for packages needing to envoke the OE/RR version 3 Orders Conversion for a patient. ROUTINE: OR3CONV COMPONENT: $$OTF(DFN,ORQUIET) VARIABLES: DFN Type: Input The IEN of the PATIENT file denoting the patient being processed. ORQUIET Type: Input Input a 1 to make the call silent or 0 to echo back information to the user as to what is occurring. Value Type: Output Result of extrinsic function will return: -1^error message if problem encountered 0 if patient already converted prior to call 1 if patient was successfully converted as part of call This entry point can be called by packages needing to ensure that the OE/RR Orders Conversion has been completed for a patient. It can be called as a silent or 'talking' call. ******************** 2414 NAME: ORDERS CONVERSION CHECK CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.99 ROOT: ORD(100.99, DESCRIPTION: TYPE: File This DBIA authorizes direct global read of some fields in the ^ORD(100.99,1,"CONV") node. This node contains the fields used by the CPRS v1 Orders Conversion. Calling packages can use this information to determine whether the Orders Conversion is complete. It also authorizes access to ^ORD(100.99,1,"PTCONV") which is a multiple which contains the DFNs of patients left to convert. ^ORD(100.99,1,'CONV') 3.01 OR3 CONVERSION COMPL CONV;1 Direct Global Read & w This will be a 1 if the conversion is complete or a 0 if it is in progress. If CPRS has not been installed or the conversion has not yet started, this node will not exist. 3.06 OR3 BACKGROUND JOB S CONV;6 Direct Global Read & w This field will contain the start date/time for the CPRS v1 Orders Conversion. 3.07 OR3 BACKGROUND JOB S CONV;7 Direct Global Read & w This field contains the completion time of the Orders Conversion. ^ORD(100.99,1,'PTCONV',DFN) .01 OR3 PATIENTS TO CONV 0;1 Direct Global Read & w DINUMed entry of PATIENT file entries that have not yet been converted ROUTINE: ******************** 2415 NAME: PS EVSEND OR CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS Inpatient Medications order information will be sent to other packages via the PS EVSEND OR protocol in the form of an array. An example of the call is D MSG^XQOR("PS EVSEND OR",.PSJMSG) OUTPATIENT PHARMACY Outpatient Pharmacy prescription information will be sent to other packages via the PS EVSEND OR protocol in the form of an array. An example of the call is D MSG^XQOR("PS EVSEND OR",.MSG). CLINICAL REMINDERS ORDER ENTRY/RESULTS REPORTING Listener protocols are OR RECEIVE and OCX ORDER CHECK HL7 RECIEVE. CLINICAL INFO RESOURCE NETWORK INTEGRATED BILLING SURGERY VIRTUAL PATIENT RECORD Listener protocol VPR XQOR EVENTS added with VPR*1*3. EMERGENCY DEPARTMENT Listener protocol is EDP Monitor. HEALTH MANAGEMENT PLATFORM Protocol is HMP XQOR EVENTS ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: MAY 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The PS EVSEND OR protocol is used to pass order messages from Pharmacy packages to other packages. This protocol is exported by the Pharmacy Data Management package, and is invoked by other Pharmacy Packages. ROUTINE: ******************** 2417 NAME: Pharmacy Schedule and Admin Team Utilities CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 15,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These entry points provide utilities to access entries in the ADMINISTRATION SCHEDULE file (#51.1). ROUTINE: PSJEEU COMPONENT: ENSE VARIABLES: PSJPP Type: Input The prefix of the package that the entry selected is assigned to. This allows add/edit/delete access to entries in the ADMINISTRATION SCHEDULE file (#51.1). The following fields are editable through this entry point: NAME (#.01); TYPE OF SCHEDULE (#5); STANDARD ADMINISTRATION TIMES (#1); MAX DAYS FOR ORDERS (#2.5) HOSPITAL LOCATION (#7) NAME (#.01) ADMINISTRATION TIMES (#1) COMPONENT: ENSHE VARIABLES: PSJPP Type: Input This must be the prefix of the package that the entry selected is assigned to. This allows add/edit/delete access to entries in the ADMINISTRATION SHIFT file (#51.15). The following fields are editable through this entry point: NAME (#.01); ABBREVIATION (#1); STANDARD START/STOP TIMES (#2) HOSPITAL LOCATION (#3) NAME (#.01) STANDARD START/STOP TIMES (#1) The PACKAGE field (#4) will be assigned whatever value passed in PSJPP. COMPONENT: ENSV VARIABLES: PSJW Type: Input IEN of the entry in the HOSPITAL LOCATION file (#44). The administration times or shifts for the entry identified will be returned if PSJW is specified and data exists for that location. PSJNE Type: Input If PSJNE exists these will be no dialogue with the user from this call. PSJPP Type: Input This must be the prefix of the package that the entry selected is assigned to. PSJX Type: Both Specifies the name of the schedule to be accessed. If the name specified is ambiguous and PSJNE is undefined the user will be prompted to selected the entry. PSJX will return the name of the entry selected or null if the entry is not found. PSJAT Type: Output Defines the admin times or shift if any are defined for the selected entry. PSJM Type: Output If the entry is found this will define the frequency (in minutes) assigned to the selected schedule. PSJTS Type: Output This will define the type of schedule for the selected entry. PSJY Type: Output Defines the IEN of the selected entry in the ADMINISTRATION SCHEDULE file (#51.1). Null is returned if no entry is found. PSJAX Type: Output This is the maximum days continuous orders last for the specified schedule. Null will be returned if not found. This validates a schedule and returns information about the selected entry. COMPONENT: ENSVI VARIABLES: PSJPP Type: Input This must be the prefix of the package that the entry selected is assigned to. Displays the NAME (#.01), STANDARD ADMINISTRATION TIMES (#1), MAX DAYS FOR ORDERS (#2.5) and SCHEDULE TYPE (#5) of the selected entry in the ADMINISTRATION file (#51.1). The user will be prompted to select the entry. COMPONENT: ENATV VARIABLES: X Type: Both This defines the data to be validated. If X defines a valid administration time(s) then it is returned as X. If it is not valid X is killed. Validates administration times. COMPONENT: ENSHV VARIABLES: X Type: Both This defines the data to be validated. If X defines a valid administration shift then it is returned as X. If it is not valid X is killed. COMPONENT: ENSPU VARIABLES: PSJSCH Type: Input The schedule of the action to be taken. PSJM Type: Input The frequency (in minutes) of the action. PSJAT Type: Input The administration times for the action. PSJTS Type: Input The schedule type of the schedule defined in PSJSCH. PSJSD Type: Input The start date/time of the range during which the action is to be taken. PSJFD Type: Input The stop date/time of the range during which the action is to be taken. PSJOSD Type: Input The start date/time of the action to be taken during the range defined by PSJSD and PSJFD. PSJOFD Type: Input The stop date/time of the action to be taken during the range defined by PSJSD and PSJFD. PSJC Type: Output Defines the number of times an action is to be taken. Calculates the number of times an action is to be taken. ******************** 2418 NAME: OE/RR CALL TO PSSJORDF CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VISTA INTEGRATION ADAPTOR VIABDX SAVE RPC references PSSJORDF routine. OUTPATIENT PHARMACY INPATIENT MEDICATIONS Added 8/24/20 USAGE: Controlled Subscri ENTERED: MAY 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA allows use of START^PSSJORDF and START1^PSSJORDF as documented in the OE/RR Developer Interface Specification. ROUTINE: PSSJORDF COMPONENT: START(PSJORD,PSJOPAC) VARIABLES: PSJORD Type: Input Orderable Item IEN TMP('PSJMR Type: Output MED ROUTE^MED ROUTE ABBREVIATION^MED ROUTE IEN^OUTPATIENT EXPANSION^IV FLAG^DEFAULT FLAG D in the DEFAULT FLAG field indicates this is the default MED ROUTE for the specified orderable item. TMP('PSJNO Type: Output NOUN^VERB^PREPOSITION TMP('PSJSC Type: Output DEFAULT SCHEDULE NAME PSJOPAC Type: Input This variable represents the pharmacy package for which the order is being entered in CPRS. "O" will be for an Outpatient order, and "I" will be for an Inpatient order. This will impact the default Schedule that is returned, since some Schedules are allowed for Outpatient orders, but not for Inpatient orders. The Default med route will be returned from the DEFAULT MED ROUTE field (#.06) of the PHARMACY ORDERABLE ITEM file (#50.7) if it is populated or from the POSSIBLE MED ROUTES multiple (#50.711) of the PHARMACY ORDERABLE ITEM file (#50.7) if it is populated with a single entry and the USE DOSAGE FORM MED ROUTE LIST field (#10) is set to "NO". The med route selection list will be returned with entries from the POSSIBLE MED ROUTES multiple (#50.711) if the USE DOSAGE FORM MED ROUTE LIST field (#10) is set to "NO". Otherwise, the med routes associated with the orderable item's dosage form, MED ROUTE FOR DOSAGE FORM multiple (#50.6061) of the DOSAGE FORM file (#50.606), will be returned. If there are no entries, then all med routes found in the MEDICATION ROUTES file (#51.2) will be returned. COMPONENT: START1(PSJORD,PSJQOF) VARIABLES: PSJORD Type: Both Array of pharmacy orderable items that make up the IV order. The inbound structure is: PSJORD(0)=Number of orderable items in the order PSJORD(n)=Orderable item IEN number The output structure is: PSJORD(n)=IEN^NAME^ABBREVIATION^OUTPATIENT EXPANSION^DEFAULT IEN is the Medication Route IEN from the Medication Route File #51.2. NAME, ABBREVIATION, and OUTPATIENT EXPANSION are all pieces of the data string from ^PS(51.2,IEN,0) If all the orderable items associated with the IV order have the same default med route defined in the Pharmacy Orderable Item File #50.7, then a "D" will be added as the last piece of the data string returned. If there is no default, or if there is more than one orderable item on the order, the DEFAULT piece will be null. PSJQOF Type: Input This denotes whether the IV order is a quick order or not. If the flat is set to 1 then all med routes defined in the med route file that are flagged for use in all packages, and are flagged for use in IVs will be returned. PSJQOF=0 This is not a quick order PSJQOF=1 This is a quick order This is the entry point from the CPRS IV Dialog for IV orders. If there is only one orderable item in the IV order request, then the same logic defined under the START component will be used to return the default med route and the med route selection list from the PHARMACY ORDERABLE ITEM file (#50.7). If there is more than one orderable item on the IV order request, the PHARMACY ORDERABLE ITEM file (#50.7) will be checked for each orderable item for the default med route and med route selection list as defined under START component. If there is a default med route common with every orderable item, then that default med route will be returned. Similarly, the list of possible med routes that are common with every orderable item will be returned. ******************** 2419 NAME: OE/RR REFERENCES TO RAMIS(71.2 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71.2 ROOT: RAMIS(71.2, DESCRIPTION: TYPE: File This DBIA requests direct global read access to the fields and cross-references documented in this DBIA. ^RAMIS(71.2,DA,0) .01 NAME 0;1 Direct Global Read & w 4 AMIS CREDIT INDICATO 0;2 Direct Global Read & w ^RAMIS(71.2,'AB' Loops through the 'AB' x-ref which is a whole file x-ref on the TYPE OF IMAGING multiple. ^RAMIS(71.2,'B' Used to get IEN of entry by name. ROUTINE: ******************** 2420 NAME: OE/RR REFERENCE TO RAMIS(71 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71, DESCRIPTION: TYPE: File This DBIA requests direct global read access to the RAD/NUC MED PROCEDURES file as listed in this DBIA. ^RAMIS(71,DA,0) 11 RAD/NM PHYS APPROVAL 0;11 Direct Global Read & w ROUTINE: ******************** 2421 NAME: GMRADPT DATA SUBSET CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING TEXT INTEGRATION UTILITIES MYHEALTHEVET VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: MAY 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows subscribing packages to retrieve a subset of the adverse reaction data returned by integration agreement #10099 GMRADPT. ROUTINE: GMRAOR1 COMPONENT: EN1(DFN,ARRAY) VARIABLES: DFN Type: Input The internal entry number (IEN) of the patient in the PATIENT file (#2). ARRAY Type: Input Name of the array to return data in. If not defined, data is returned in GMRARXN(). Returned Data Format: ARRAY(X)=Caret-delimited string X - number that starts at one for the first reaction and increments by one for each subsequent reaction Caret-delimited string: Piece Value ========================================== ======== 1 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) NOTE: For reactions of type DRUG, DRUG FOOD, DRUG OTHER, or DRUG FOOD OTHER where the REACTANT field does not exactly match the GMR ALLERGY field (#1) in external format, this piece will contain the GMR ALLERGY field in external format followed by a space followed by the REACTANT field surrounded by brackets. Consider two examples: "ATORVASTATIN [LIPITOR]" and "IODINE". 2 SEVERITY field (#14.5) in the ADVERSE REACTION REPORTING file (#120.85) in external format 3 IEN in the PATIENT ALLERGIES file (#120.8) ARRAY(X,"S",COUNT)=Semi-colon delimited string COUNT - number that starts at one for the first sign or symptom and increments by one for each subsequent sign or symptom. Semi-colon delimited string: Piece Value ========================================== ======== 1 REACTION sub-field (#.01) in the REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) in external format 2 DATE ENTERED sub-field (#3) in the REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) in internal FileMan format NOTE: This piece is only returned if the GMRAIDT input variable evaluates to true. GMRA Type: Input Optional. Type of reactions to return. Refer to integration agreement #10099 GMRADPT for an explanation of this variable. GMRAIDT Type: Input Optional. If set to a value that evaluates to true, the API will return the date/time on which each sign or symptom that is returned occurred in the second semi-colon piece of ARRAY(X,"S",COUNT). If set to a value that evaluates to false or is undefined, the API will not return the date/time. Returns array of adverse reactions for a patient along with signs and symptoms. ******************** 2422 NAME: Detailed Adverse Reaction CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement allows a package to retrieve detailed information for a specific adverse reaction. ROUTINE: GMRAOR2 COMPONENT: EN1(IEN,ARRAY) VARIABLES: IEN Type: Input Internal Entry Number (IEN) for the allergy/adverse reaction in the PATIENT ALLERGIES file (#120.8). ARRAY Type: Input Optional variable indicating the name of the array in which to return results. If this is undefined, data is returned in GMRACT(). GMRACT Type: Output Caret-delimited string: NOTE: Unless specified otherwise, all fields are returned in external format. Piece Value ============================================ ==== 1 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) 2 ORIGINATOR field (#5) in the PATIENT ALLERGIES file (#120.8) 3 TITLE field (#8) in the NEW PERSON file (#200) for the ORIGINATOR 4 VERIFIED field (#19) in the PATIENT ALLERGIES file (#120.8) 5 OBSERVED/HISTORICAL field (#6) in the PATIENT ALLERGIES file (#120.8) 6 MECHANISM field (#17) in the PATIENT ALLERGIES file (#120.8) 7 ALLERGY TYPE field (#3.1) in the PATIENT ALLERGIES file (#120.8) 8 VERIFIER field (#21) in the PATIENT ALLERGIES file (#120.8) 9 VERIFICATION DATE/TIME field (#20) in the PATIENT ALLERGIES file (#120.8) 10 ORIGINATION DATE/TIME field (#4) in the PATIENT ALLERGIES file (#120.8) GMRACT('C' Type: Output Array of comments for this reaction. Comments is a multiple field, and word processing: GMRACT('C' Type: Output Word processing text for comment GMRACT('C',Y). GMRACT('O' Type: Output Array of observation dates/severities for this reaction: . GMRACT('S' Type: Output Array of signs/symptoms for this reaction: . GMRACT('V' Type: Output Array of VA drug classes for this reaction: . GMRACT('I' Type: Output Array of drug ingredients for this reaction: . **NOTE: Patch GMRA*4*46 was released on 05/24/2016 with a compliance date of 06/24/2016. This patch included the new EN2 component, which is intended to replace this component. New subscribers should use the EN2 component. A future patch will phase out the use of this component as subscribing applications move to the EN2 component. COMPONENT: EN2(IEN,ARRAY) VARIABLES: IEN Type: Input Internal Entry Number (IEN) of the adverse reaction within the PATIENT ALLERGIES file (#120.8) to return data for. ARRAY Type: Input Name of the array to return data in. If not defined, data is returned in GMRACT(). Returned Data Format: NOTE: Unless specified otherwise, all fields are returned in external format. ARRAY=Caret-delimited string Caret-delimited string: Piece Value ========================================== ====== 1 REACTANT field (#.02) in the PATIENT ALLERGIES file (#120.8) NOTE: For reactions of type DRUG, DRUG FOOD, DRUG OTHER, or DRUG FOOD OTHER where the REACTANT field does not exactly match the GMR ALLERGY field (#1) in external format, this piece will contain the GMR ALLERGY field in external format followed by a space followed by the REACTANT field surrounded by brackets. Consider two examples: "ATORVASTATIN [LIPITOR]" and "IODINE". 2 ORIGINATOR field (#5) in the PATIENT ALLERGIES file (#120.8) 3 TITLE field (#8) in the NEW PERSON file (#200) for the ORIGINATOR 4 VERIFIED field (#19) in the PATIENT ALLERGIES file (#120.8) 5 OBSERVED/HISTORICAL field (#6) in the PATIENT ALLERGIES file (#120.8) 6 MECHANISM field (#17) in the PATIENT ALLERGIES file (#120.8) 7 ALLERGY TYPE field (#3.1) in the PATIENT ALLERGIES file (#120.8) 8 VERIFIER field (#21) in the PATIENT ALLERGIES file (#120.8) 9 VERIFICATION DATE/TIME field (#20) in the PATIENT ALLERGIES file (#120.8) 10 ORIGINATION DATE/TIME field (#4) in the PATIENT ALLERGIES file (#120.8) ARRAY("C",COUNT)=Caret-delimited string COUNT - number that starts at one for the first comment and increments by one for each subsequent comment Caret-delimited string: Piece Value ========================================== ====== 1 DATE/TIME COMMENT ENTERED sub-field (#.01) in the COMMENTS field (#26) in the PATIENT ALLERGIES file (#120.8) 2 COMMENT TYPE sub-field (#1.5) in the COMMENTS field (#26) in the PATIENT ALLERGIES file (#120.8) 3 USER ENTERING sub-field (#1) in the COMMENTS field (#26) in the PATIENT ALLERGIES file (#120.8) NOTE: Nodes descendant from ARRAY("C",COUNT) comprise the COMMENTS sub-field (#2) in the COMMENTS field (#26) in the PATIENT ALLERGIES file (#120.8). ARRAY("O",COUNT)=Caret-delimited string COUNT - number that starts at one for the first observer and increments by one for each subsequent observer Caret-delimited string: Piece Value ========================================== ====== 1 DATE/TIME OF EVENT field (#.01) in the ADVERSE REACTION REPORTING file (#120.85) 2 SEVERITY field (#14.5) in the ADVERSE REACTION REPORTING file (#120.85) ARRAY("S",COUNT)=TEXT COUNT - number that starts at one for the first sign or symptom and increments by one for each subsequent sign or symptom TEXT - REACTION sub-field (#.01) in the REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) followed by a space followed by the DATE ENTERED sub- field (#3) in the REACTIONS field (#10) in the PATIENT ALLERGIES file (#120.8) surrounded by parentheses. ARRAY("V",COUNT)=Caret-delimited string COUNT - number that starts at one for the first drug class and increments by one for each subsequent drug class Caret-delimited string: Piece Value ========================================== ====== 1 VA DRUG CLASS sub-field (#.01) in the DRUG CLASSES field (#3) in the PATIENT ALLERGIES file (#120.8) 2 CLASSIFICATION field (#1) in the VA DRUG CLASS file (#50.605) for the VA DRUG CLASS sub-field (#.01) entry in the DRUG CLASSES field (#3) in the PATIENT ALLERGIES file (#120.8) ARRAY("I",COUNT)=TEXT COUNT - number that starts at one for the first drug ingredient and increments by one for each subsequent drug ingredient TEXT - DRUG INGREDIENT sub-field (#.01) in the DRUG INGREDIENTS field (#3) in the PATIENT ALLERGIES file (#120.8) This call returns data for the adverse reaction specified by IEN. ******************** 2423 NAME: Inpatient Medications Quick Order Conversion CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Used by OR*2.5*49 to convert existing Inpatient Medication Quick Orders for use with CPRS v1.0. ROUTINE: PSSQOC COMPONENT: EN VARIABLES: This is the main entry point for the Inpatient Medication Quick Order Conversion. COMPONENT: EN(x) VARIABLES: X Type: Input Identifies protocol that is attached to the quick order that is to be converted. TMP('PSJQO Type: Output Converts the Inpatient Medications Quick Order attached to the protocol identified in X for use with CPRS v1.0. COMPONENT: EN(X) VARIABLES: ******************** 2424 NAME: ROUTINE CALLS IN GMRCA1 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will allow calling various entry points in GMRCA1. ROUTINE: GMRCA1 COMPONENT: DC(IEN,ACTION) VARIABLES: IEN Type: Input IEN of file 123 ACTION Type: Input Input 6 for DC or 19 for Cancel Call to DC a consult COMPONENT: COMMENT(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123 Allow comment to be added to existing consult. COMPONENT: RC(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123 Allow a consult to be received COMPONENT: PS(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123 Allow a service copy to be printed for a consult request. COMPONENT: EDTSUB(GMRCO) VARIABLES: GMRCO Type: Input IEN of file 123. Allow a provider or update user to edit/resubmit a canceled consult. ******************** 2425 NAME: CALL TO GMRCACTM CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Private ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will alow Order Entry/Results Reporting to call CPRS^GMRCACTM. ROUTINE: GMRCACTM COMPONENT: CPRS(IENSTRING) VARIABLES: IENSTRING Type: Input A string of IENs of file 123 separated by semi-colons. ORFLG(IEN) Type: Output ORFLG(IEN)=flag (1st piece) where IEN is the consult internal entry number and the flag is a number representing one of the following: 1 = GMRCACTM USER REVIEW SCREEN - tracking/review actions 2 = GMRCACTM SERVICE ACTION menu - service clinician actions 3 = Indicates the user is an administrative update user. CPRS uses this flag to build equivalent menus in the GUI and List Manager. ORFLG(IEN)= (2ND piece) IEN is the Consult (IEN) in file 123. The clinician's DUZ will be used to determine what type of update authority is granted. Piece two will contain the field in file 123.5 (REQUEST SERVICES) that gave the user update authority (ex. Update user WO/Notification, Special Update user, Administrative Update user). ORFLG(IEN)= (3rd piece) Piece will contain the Service in file 123.5 (REQUEST SERVICES) that gave the user update authority (ex. CARDIOLOGY, NEUROLOGY). ORFLG(IEN)= (4th piece) Piece will contain a "1" if the user is allowed to associate medicine results with a consult procedure request. ORFLG(IEN)= (5th piece) Piece will contain a "1" if a user can disassociate a medicine result that was incorrectly associated with a consult procedure request. ORFLG(IEN)= (6th piece) Piece will contain a "1" if the user is the provider or update user for the consult. If the piece contains a "1" the user is allowed to EDIT and RESUBMIT a canceled request. CPRS uses the ORFLG to perform the following: 1. Build equivalent menus (USER REVIEW, SERVICE ACTION) in the GUI and List Manager. 2. Determine user update authority. 3. List the Service that granted the update authority. 4. Determine if a user has authority to associate Medicine results with a Procedure Request. 5. Determine if a user has authority to disassociate a medicine result that was incorrectly associate with a Procedure Request. 6. Determine if a user has authority to EDIT and RESUBMIT a Cancel request. Call returns a flag determining whether a user has privileges for a particular consult service. This is used to determine what action menu a user should have to process or review consults. ******************** 2426 NAME: CALLS TO GMRCASV CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Private ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA request permission for Order Entry/Results Reporting to call the following entry points in GMRCASV. ROUTINE: GMRCASV COMPONENT: SERV1 VARIABLES: GMRCTO Type: Input Set to 1 to not include disabled or tracking only services GMRCDG Type: Input IEN of file 123.5 denoting consult service for which to return child entries. For OE/RR, this is 'ALL SERVICES' entry. TMP('GMRCS Type: Output ^TMP("GMRCSLIST",$J,COUNTER)=IEN^NAME^0^(+ if child exists)^USAGE TMP('GMRCS Type: Output ^TMP("GMRCS",$J,IEN)=CONSULT SERVICE NAME Gets list of orderable consult services. COMPONENT: ASRV VARIABLES: GMRCDG Type: Output IEN of consult service selected GMRCQUT Type: Output 1 if user aborts service question TMP('GMRCS Type: Output ^TMP("GMRCSLIST",$J,COUNTER)=IEN^NAME^0^(+ if child exists)^USAGE TMP('GMRCS Type: Output ^TMP("GMRCS",$J,IEN)=CONSULT SERVICE NAME Entry point to select a new consult service ******************** 2427 NAME: CALLS TO GMRCTIU CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will document the calls from Order Entry/Results Reporting to GMRCTIU. ROUTINE: GMRCTIU COMPONENT: ENTER(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123 Allows completion of a consult with a TIU note COMPONENT: ADDEND(IEN) VARIABLES: IEN Type: Input IEN of entry in file 123. Allows addendum to be attached to consult COMPONENT: ANYPENDG(DFN,USER) VARIABLES: DFN Type: Input This variable is a pointer to the PATIENT file (#2). USER Type: Input This variable is a pointer to the NEW PERSON (#200) file. BOOLEAN Type: Output This variable is returned as: 1 = there are unresolved consults the user may update 0 = there are no unresolved consults the user may update This API is used to determine if there are any unresolved consults for the patient (DFN) that the user (USER) may complete. COMPONENT: GET(IEN,TIEN,STATUS,AUTHOR) VARIABLES: IEN Type: Input IFN from file 123 TIEN Type: Input IFN from TIU STATUS Type: Input TIU status of report AUTHOR Type: Input Author of document as DUZ Update consult status from TIU results ******************** 2428 NAME: USE OF LR7OR3 CALLS CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA requesting access to TEST, SCOM, DEFURG and GCOM~LR7OR3 for use with VIAB LOAD RPC and OrderMgmtSvc - getLabTestSpecificParams USAGE: Controlled Subscri ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA formalizes the documentation for calls to LR7OR3 as documented in the OE/RR Interface Specification document. ROUTINE: LR7OR3 COMPONENT: TEST(TEST,.Y) VARIABLES: TEST Type: Input IEN of file 60 Y Type: Output Array of allowable and default attributes for test Call to return ordering parameters for a test. COMPONENT: SCOM(TEST,SAMP,.Y) VARIABLES: TEST Type: Input IEN of file 60 SAMP Type: Input Collection sample (pointer to file 62) Y Type: Output Array of text of ward remarks. Gets ward remarks for specimen and puts in text array. COMPONENT: $$DEFURG() VARIABLES: VALUE Type: Output Extrinsic function returns the internal value of the DEFAULT URGENCY field (#301) in the LABORATORY SITE file (#69.9). Returns default urgency for lab. COMPONENT: GCOM(TEST,.Y) VARIABLES: TEST Type: Input IEN of file 60 Y Type: Output Array of text of ward instructions. Gets General Ward Instructions for test and puts in text array. COMPONENT: COLL(TEST,.Y) VARIABLES: TEST Type: Input IEN of file 60 Y Type: Output Array of collection sample and specimen info for a test. Get Collection Sample and Specimen data for a test. ******************** 2429 NAME: USE OF LR7OV4 CALLS CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA is using the access in the ICR for VIAB IC VALID RPC and OrderMgmtSvc - getImmediateCollectValidText. It also needs this access for VIAB IMMED COLLECT RPC and OrderMgmtSvc - getImmediateCollectMessage. USAGE: Controlled Subscri ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA formalizes the documentation for calls to LR7OV4 as documented in the OE/RR Interface Specification document. ROUTINE: LR7OV4 COMPONENT: $$ON(DIV) VARIABLES: DIV Type: Input Pointer value from IMMED LAB COLLECT DIV. multiple in LABORATORY SITE file (#69.9). VALUE Type: Output Extrinsic function returns 1 if immediate collect is allowed for division. Otherwise, 0 is returned. Returns ordering parameters for immediate collection. COMPONENT: $$DEFTIME(DIV) VARIABLES: DIV Type: Input Pointer value from IMMED LAB COLLECT DIV. multiple in LABORATORY SITE file (#69.9). VALUE Type: Output Extrinsic function returns: internal date/time^external date/time if valid result found ""^error message if time could not be returned Returns next valid time form immediate collection. COMPONENT: $$VALID(DIV,TM) VARIABLES: DIV Type: Input Pointer value from IMMED LAB COLLECT DIV. multiple in LABORATORY SITE file (#69.9). TM Type: Input Collection date/time to validate VALUE Type: Output Extrinsic function returns: 1 if time is valid collection time 0^error message if tim not valid Validates immediate collection time. COMPONENT: SHOW(DIV,.Y) VARIABLES: DIV Type: Input Pointer value from IMMED LAB COLLECT DIV. multiple in LABORATORY SITE file (#69.9). Y Type: Output Array of allowable date/time ranges for immediate collection formatted for display. Returns an array of allowable date/time ranges for immediate collection which is formatted for display. ******************** 2430 NAME: USE OF XUTL('XQORM', CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Order Entry/Results Reporting uses this functionality to display DIALOG file entries for selection. HEALTH SUMMARY Health Summary uses this functionality to display Health Summary Components for selection. CONSULT/REQUEST TRACKING TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: MAY 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Setting data into XUTL("XQORM" allows the protocol unwinder to display the data as if it were a protocol. This has been used for quite some time, but was never formally requested/documented. ROUTINE: ******************** 2432 NAME: DBIA2432 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES GEN. MED. REC. - VITALS INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: JUN 24,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File Medicine requests a FILEMAN read to the DIVISION field (#3.5) of the HOSPITAL LOCATION file (#44) [$P(^SC(D0,0),"^",15)] to display what division a Ward belongs to. ^SC(D0,0 3.5 DIVISION 0;15 Read w/Fileman This field contains the Division assigned to the selected entry in the HOSPITAL LOCATION file (#44) ROUTINE: ******************** 2433 NAME: XPDGREF CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 10,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Developers can put information in the KIDS Transport Global, ^XTMP. The transport global will be available during the Environment Check, Pre-Install, and Post-Install routines. The developer can access the information by using the variable XPDGREF to read or set the transport global. example: to set the transport global S @XPDGREF@("My subscript",1)="Information I need" to read the transport global S X=@XPDGREF@("My subscript",1) Developers can create a routine that will always set information into the transport global whenever a package is transported. The field, PRE-TRANSPORTATION ROUTINE, will be run during the transport process. The variable XPDGREF will be available to set information into the transport global. ROUTINE: COMPONENT: XPDGREF VARIABLES: XPDGREF Type: Both This variable can be used to set or retrieve information from the KIDS transport global, ^XTMP. It can be used in the following routine: Pre-Transportation Routine, Pre-Install Routine, and Post-Install Routine. Example: to set the transport global S @XPDGREF@("My subscript",1)="Information I need" to read the transport global S X=@XPDGREF@("My subscript",1) This variable can be used to set or retrieve information from the KIDS transport global, ^XTMP. It can be used in the following routine: Pre-Transportation Routine, Pre-Install Routine, and Post-Install Routine. Example: to set the transport global S @XPDGREF@("My subscript",1)="Information I need" to read the transport global S X=@XPDGREF@("My subscript",1) ******************** 2434 NAME: DBIA2434 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 16,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Patch HL*1.6*36 introduces 3 new entry points in routine HLUTIL. These entry points support two new features, "Don't Purge" and "Reprocessing" messages, which were originally requested by the CIRN project. Patch HL*1.6*19 added a 4th API and restricted the use of all APIs to TCP/IP connections. ROUTINE: HLUTIL COMPONENT: $$DONTPURG VARIABLES: Sets the new flag field "DON'T PURGE" (#773,10) to prevent a message being purged by the "HL PURGE TRANSMISSIONS" option. input: none return value: 1 means field has been successfully set. -1 means call has failed; nothing has been changed. Call this function from one of the following routines: - RTN routine, in $$REPROC^HLUTIL(IEN,RTN). - routine in "GENERATE/PROCESS ROUTINE"(#101,771). - routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772). When called by these routines, HL7 assumes that the variable HLMTIENS (message IEN of file #773) is already properly defined. This variable should already be defined if in a message processing context. COMPONENT: $$TOPURG VARIABLES: Clear the flag field "DON'T PURGE" (#773,10) to allow the message to be purged by the "HL PURGE TRANSMISSIONS" option. input: none return value: 0 means field has been successfully cleared -1 means call has failed; nothing has been changed Call this function from one of the following routines: - RTN routine, in $$REPROC^HLUTIL(IEN,RTN). - routine in "GENERATE/PROCESS ROUTINE"(#101,771). - routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772). When called by these routines, HL7 assumes that the variable HLMTIENS (message IEN of file #773) is already properly defined. This variable should already be defined if in a message processing context. COMPONENT: $$REPROC VARIABLES: IEN Type: Input the internal entry number of the message in file 773 RTN Type: Input routine, to be Xecuted for reprocessing the message. Call this entry point to reprocess an inbound message in file 773. input value: IEN is the internal entry number of the message in file 773 RNT is the routine to execute to process the message return value: 0 means call has been successfully completed. -1 means call has failed; nothing has been changed. The IEN, which is provided to $$REPROC^HLUTIL(IEN,RTN) should be the message IEN of file #773. COMPONENT: $$SETPURG VARIABLES: STATUS Type: Input This variable can have a value of 1 or 0. 1 sets the message's purge flag such that the message won't be purged. 0 sets the message's purge flag such that the message will be purged. This function can set the new flag field "DON'T PURGE" (#773,10) to prevent or allow a message to be purged by the "HL PURGE TRANSMISSIONS" option. input: STATUS set to 0 or 1. 1=prevents message from being purged 0=allows message to be purged return value: 1 means field has been successfully set. -1 means call has failed; nothing has been changed. Call this function from one of the following routines: - RTN routine, in $$REPROC^HLUTIL(IEN,RTN). - routine in "GENERATE/PROCESS ROUTINE"(#101,771). - routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772). When called by these routines, HL7 assumes that the variable HLMTIENS (message IEN of file #773) is already properly defined. This variable should already be defined if in a message processing context. ******************** 2437 NAME: DBIA2437 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File References to ADT/Registration globals and routines. ^DGPM('APRD' 'APRD' xref. ^DGPM(D0,0) .06 WARD LOCATION 0;6 Direct Global Read & w Zeroeth node ROUTINE: ******************** 2438 NAME: DBIA2438 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT VA CERTIFIED COMPONENTS - DSSI POLICE & SECURITY VISTA INTEGRATION ADAPTOR VIA will be referencing the Name (#.01) field in the Medical Center Division (#40.8) file in the VIAB BMS RPC. USAGE: Controlled Subscri ENTERED: JUN 22,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File Pharmacy Benefits Management (PBM) software needs to extract the facility number from the Medical Center Division file #40.8. ^DG(40.8,DO,0) 1 Facility Number 0;2 Read w/Fileman This field stores the number of the facility that a division is affiliated with. This should be a 3 digit number the site is assigned. It may include a suffix. .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2440 NAME: DBIA2440 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT INCOMPLETE RECORDS TRACKING BAR CODE MED ADMIN USAGE: Controlled Subscri ENTERED: JUN 22,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42 DESCRIPTION: TYPE: File Pharmacy Benefits Managment (PBM) vs 3.0 (formerly D&PPM) software needs to access the division pointer. This will be used to extract the facility number from the Medical Center Division file. ^DIC(42, .015 DIVISION 0;11 Read w/Fileman Division pointer. Division at which this ward is located. ROUTINE: ******************** 2441 NAME: Obtain data from the Drug (50) file. CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: JUN 29,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. Radiology/Nuclear Medicine obtains the following data from Pharmacy Data Management's (PDM) Drug file: field name field number node;piece purpose -------------------------------------------------------------------------- Generic Name .01 0;1 display Generic Name VA Classification 2 0;2 radiopharmaceutical check Inactive Date 100 I;1 check if an active drug ^PSDRUG(D0,0) .01 Generic Name 0;1 Direct Global Read & w 2 VA Classification 0;2 Direct Global Read & w ^PSDRUG(D0,'I') 100 Inactive Date I;1 Direct Global Read & w This is the date that the drug was inactivated. ROUTINE: ******************** 2442 NAME: DBIA2442 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK IMAGING USAGE: Controlled Subscri ENTERED: JUN 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT( DESCRIPTION: TYPE: File CIRN needs read access to the ^RARPT global to calculate the Master of Record score. Traversing the ^RARPT("C" x-ref, CIRN uses $P(^RARPT(D0,0),U,3) to calculate the score. ^RARPT(D0,0) 3 EXAM DATE/TIME 0;3 Direct Global Read & w ROUTINE: ******************** 2443 NAME: DBIA2443 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK SPINAL CORD DYSFUNCTION JSHARVEY 20061107/ ADDED SCID TO SUBSCRIBER LIST AS PER FAIN. USAGE: Private ENTERED: JUN 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File CIRN traverses the ^SCE("C" x-ref and uses ^SCE(D0,0) to calculate the Master of Record score. ^SCE(D0,0) .01 DATE 0;1 Direct Global Read & w .03 CLINIC STOP CODE 0;3 Direct Global Read & w ROUTINE: ******************** 2444 NAME: DBIA2444 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File VISIT file access to zeroeth node. ^AUPNVSIT(D0,0) .24 OPTION USED TO CREAT 0;24 Direct Global Read & w Zeroeth node. ROUTINE: ******************** 2445 NAME: DBIA2445 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.13 ROOT: AUPNVXAM( DESCRIPTION: TYPE: File V EXAM file access. ^AUPNVXAM(D0,0) .01 EXAM 0;1 Direct Global Read & w Exam name field Zeroeth node. ROUTINE: ******************** 2446 NAME: DBIA2446 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF( DESCRIPTION: TYPE: File V HEALTH FACTORS file access. ^AUPNVHF(D0,0) .01 HEALTH FACTOR 0;1 Direct Global Read & w Health factor name field. Zeroeth node. ROUTINE: ******************** 2447 NAME: DBIA2447 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 900010.11 ROOT: AUPNVIMM( DESCRIPTION: TYPE: File V IMMUNIZATION file access. ^AUPNVIMM(D0,0) .01 IMMUNIZATION 0;1 Direct Global Read & w Immunization name field. Zeroeth node. ROUTINE: ******************** 2448 NAME: DBIA2448 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.16 ROOT: AUPNVPED( DESCRIPTION: TYPE: File V PATIENT ED file access. ^AUPNVPED(D0,0) .01 TOPIC 0;1 Direct Global Read & w Patient education name field. Zeroeth node. ROUTINE: ******************** 2449 NAME: DBIA2449 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK( DESCRIPTION: TYPE: File V SKIN TEST file access. ^AUPNVSK(D0,0) .01 SKIN TEST 0;1 Direct Global Read & w Skin test name field. Zeroeth node. ROUTINE: ******************** 2450 NAME: DBIA2450 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.15 ROOT: AUPNVTRT( DESCRIPTION: TYPE: File V TREATMENT file access. ^AUPNVTRT(D0,0) .01 TREATMENT 0;1 Direct Global Read & w .02 PATIENT NAME 0;2 Direct Global Read & w .03 VISIT 0;3 Direct Global Read & w .04 HOW MANY 0;4 Direct Global Read & w .06 PROVIDER NARRATIVE 0;6 Direct Global Read & w Zeroeth node. ^AUPNVTRT(AA 'AA' xref. ^AUPNVTRT(B 'B' xref. ^AUPNVTRT(C 'C' xref. ROUTINE: ******************** 2451 NAME: DBIA2451 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.09 ROOT: AUTTEDT( DESCRIPTION: TYPE: File EDUCATION TOPICS file access. ^AUTTEDT(D0,0) .01 NAME 0;1 Direct Global Read & w Education topic name field. Zeroeth node. ROUTINE: ******************** 2452 NAME: DBIA2452 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.15 ROOT: AUTTEXAM( DESCRIPTION: TYPE: File EXAM file access. ^AUTTEXAM(D0,0) .01 NAME 0;1 Direct Global Read & w Exam name field. Zeroeth node. ROUTINE: ******************** 2453 NAME: DBIA2453 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.64 ROOT: AUTTHF( DESCRIPTION: TYPE: File HEALTH FACTORS file access. ^AUTTHF(D0,0) .01 FACTOR 0;1 Direct Global Read & w Health factor name field. Zeroeth node. ROUTINE: ******************** 2454 NAME: DBIA2454 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL INFO RESOURCE NETWORK PHARMACY BENEFITS MANAGEMENT CLINICAL REMINDERS PHARMACY DATA MANAGEMENT USAGE: Controlled Subscri ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.14 ROOT: AUTTIMM( DESCRIPTION: TYPE: File IMMUNIZATION file access. ^AUTTIMM(D0,0) .01 NAME 0;1 Direct Global Read & w Immunization name field. Zeroeth node. ROUTINE: ******************** 2455 NAME: DBIA2455 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING CLINICAL INFO RESOURCE NETWORK CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.28 ROOT: AUTTSK( DESCRIPTION: TYPE: File SKIN TEST file access. ^AUTTSK(D0,0) .01 NAME 0;1 Direct Global Read & w Skin test name field. Zeroeth node. ROUTINE: ******************** 2456 NAME: DBIA2456 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.17 ROOT: AUTTTRT( DESCRIPTION: TYPE: File TREATMENT file access. ^AUTTTRT(D0,0) .01 NAME 0;1 Direct Global Read & w Treatment name field. Zeroeth node. ROUTINE: ******************** 2457 NAME: DBIA2457 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 627.8 ROOT: YSD(627.8, DESCRIPTION: TYPE: File DIAGNOSTIC RESULTS - MENTAL HEALTH file access. ^YSD(627.8,D0,60) 65 AXIS 5 60;3 Direct Global Read & w Contains GAF score. Data node where GAF score is stored. ^YSD(627.8,'AX5', 'AX5' crossreference. ROUTINE: ******************** 2458 NAME: DBIA2458 CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 357.69 ROOT: IBE(357.69, DESCRIPTION: TYPE: File TYPE OF VISIT file access. ^IBE(357.69,'B', 'B' crossreference. ROUTINE: ******************** 2460 NAME: DBIA2460 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File PATIENT file access. ^DPT(D0,.322) .322013 ENVIRONMENTAL CONTAM .322;13 Direct Global Read & w Environmental contaminants exposure indicator. Data node. ROUTINE: ******************** 2461 NAME: DBIA2461 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.32 ROOT: DG(408.32, DESCRIPTION: TYPE: File MEANS TEST STATUS file access. ^DG(408.32,'C' 'C' cross reference. ROUTINE: ******************** 2462 NAME: DBIA2462 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING PHARMACY BENEFITS MANAGEMENT PATIENT REPRESENTATIVE VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 27.11 ROOT: DGEN(27.11, DESCRIPTION: TYPE: File PATIENT ENROLLMENT file access. ^DGEN(27.11,D0,0) .01 ENROLLMENT DATE 0;1 Direct Global Read & w Enrollment date field. .03 SOURCE OF ENROLLMENT 0;3 Direct Global Read & w Source of enrollment field. .04 ENROLLMENT STATUS 0;4 Direct Global Read & w Enrollment status field. .06 FACILITY RECEIVED 0;6 Direct Global Read & w Facility received field. .07 ENROLLMENT PRIORITY 0;7 Direct Global Read & w Enrollment priority field. .08 EFFECTIVE DATE 0;8 Direct Global Read & w Effective date field. Zeroeth node. ^DGEN(27.11,'C', 'C' crossreference. ROUTINE: ******************** 2463 NAME: DBIA2463 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Means Test utility routine. ROUTINE: DGMTU COMPONENT: $$LST~DGMTU VARIABLES: DFN Type: Input patient ifn DGDT Type: Input Date/time to use as effective date for last means test status. Last Means Test information. Extrinsic function, the output is: Annual Means Test ien ^ date of test ^ status name ^ status code ******************** 2464 NAME: DBIA2464 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING ORDER ENTRY/RESULTS REPORTING Call to EN^DGPMSTAT in routine ORQPT2. USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient ward location utility. ROUTINE: DGPMSTAT COMPONENT: ~DGPMSTAT VARIABLES: DFN Type: Input patient ifn DGT Type: Input Date to check if patient was an inpatient. DGA1 Type: Output Corresponding admission movement ifn in ^DGPM DG1 Type: Output ward ^ room-bed ^ movement type DGXFR0 Type: Output Zeroeth node of last transfer movement for admission. Provides patient ward location for a given date/time. ******************** 2465 NAME: DBIA2465 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: JUL 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Provides ward location for a given inpatient movement. ROUTINE: DGPMUTL COMPONENT: WARD~DGPMUTL VARIABLES: D0 Type: Input Discharge movement ifn in ^DGPM X Type: Output Ward name for ward at discharge Provides ward location for a given inpatient movement. ******************** 2467 NAME: ORDERABLE ITEMS, PROMPT VALUES CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consult/Request Tracking has been using 2467 since the first GMRC patch. Effective with GMRC*3.0*106, the Community Care Referrals and Authorizations (CCR&A), a part of the Consult/Request Tracking (GMRC) package, is accessing the Orders File (#100) to get the Orderable Item from the Orderable Item multiple. The information is included in the HL7 message that is sent to the HealthShare Referral Manager (HSRM). HSRM is the management platform used to track and manage community care consults. CLINICAL REMINDERS ADVERSE REACTION TRACKING NATIONAL HEALTH INFO NETWORK HEALTH SUMMARY VIRTUAL PATIENT RECORD Effective with VPR*1*0. HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR VIA will be calling this API from VIAB MEDHIST RPC. USAGE: Controlled Subscri ENTERED: JUL 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement will allow subscribers to retrieve information from a specific order in the ORDER file (#100). ROUTINE: ORX8 COMPONENT: $$OI(IFN) VARIABLES: IFN Type: Input The Internal Entry Number (IEN) of the order in the ORDER file (#100). Result Type: Output The result of the extrinsic function is returned in the format: Orderable Item IEN^Orderable Item Name^Package ID Returns the first orderable item for the order. COMPONENT: $$VALUE(IFN,ID,INST,FORMAT) VARIABLES: IFN Type: Input The IEN of the order in the ORDER file (#100). ID Type: Input The free text identifier assigned to the prompt in the ID field of the Order Dialog file #101.41 (and stored with the value in the Responses multiple of the Orders file #100). INST Type: Input An integer, the instance of the value to return (default=1). FORMAT Type: Input A flag to indicate the desired form of the value; "E" will return the external form, or null for the default internal format. Result Type: Output The result of this extrinsic function. Returns a single value from the content of an order. COMPONENT: OIS(RESULT,IFN) VARIABLES: RESULT Type: Both This variable is a reference to an array that will contain the order's orderable items. The array is formatted as follows: RESULT(OI)=DATA OI: IEN of the orderable item in the ORDERABLE ITEMS file (#101.43). DATA: Caret-delimited ('^') string of field values from the ORDERABLE ITEMS file (#101.43): NAME (#.01) ^ ID (#2) IFN Type: Input IEN of the order in the ORDER file (#100). Returns an array of orderable items for a given order number. ******************** 2469 NAME: LAB ACCESSING FIELD LAB LABEL PRINTER IN DEVICE FILE CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: JUL 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.5 ROOT: %ZIS(1 DESCRIPTION: TYPE: File Lab requests permission to access the LAB LABEL PRINTER field (#101) in the Kernel DEVICE (#3.5) file. Field is used to determine if user has a Lab label printer associated with the user's home device in the DEVICE (#3.5) file. If an association exists then this device is used as the default prompt for label printer instead of the standard LABLABEL device. Code to access this field is as follows: I $G(IOS) D ; Check if label device assigned to this user's HOME Device . S X=$$GET1^DIQ(3.5,IOS_",",101,"E") . I $L(X) S %ZIS("B")=X ^%ZIS(1,IOS,101 101 LAB LABEL PRINTER 101;1 Read w/Fileman This field stores a default lab printer for a specific device which overrides the Lab's package-wide default printer LABLABEL. ROUTINE: ******************** 2474 NAME: DBIA2474 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: JUL 9,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. ^PSDRUG(D0,0) .01 GENERIC NAME 0;1 Direct Global Read & w ^PSDRUG(D0,'ND') 20 NATIONAL DRUG FILE E ND;1 Direct Global Read & w 21 VA PRODUCT NAME ND;2 Direct Global Read & w 25 NATIONAL DRUG CLASS ND;6 Direct Global Read & w 2 VA CLASSIFICATION 0;2 Direct Global Read & w ROUTINE: ******************** 2476 NAME: PSOCMOP CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: JUL 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement between the Consolidated Mail Outpatient Pharmacy (CMOP) package with the Outpatient Pharmacy V 7.0 (OP) package allows CMOP to call the routine PSOCMOP (used exclusively for CMOP purposes) at line tag TEST from routine PSXRESUB. This call allows an Rx fill that has been rejected by a CMOP host facility to be resubmitted to that facility a single time. Two input variables are passed to PSOCMOP: PPL = IEN of Rx in Prescription file (#52) ZD(IEN of Rx in 52) = Current Date/Time One output variable is returned: PPL = If contains a value indicates that Rx was not eligible for CMOP resubmission. If null, then Rx has been placed in suspense for CMOP transmission. CMOP Routine OP Routine Variables in Variables out PSXRESUB TEST^PSOCMOP PPL PPL ZD(IEN 52) ROUTINE: PSOCMOP COMPONENT: TEST VARIABLES: PPL Type: Both PPL on input contains the IEN of an Rx in file #52. PPL on output may contain the IEN or may be Null. ZD(IEN) Type: Input ZD(IEN 52) is set to the current Date/Time. COMPONENT: $$CMPRXTYP(DA) VARIABLES: DA Type: Input The IEN of the Rx in RX SUSPENSE file 52.5 $$CMPRXTYP Type: Output 'C' for Controlled Substance (CS) 'N' for Non-CS ******************** 2477 NAME: DBIA2477 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: JUL 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PSOLBL COMPONENT: DQ VARIABLES: PPL Type: Input The input variable PPL, which contains the internal entry number from the Prescription file (#52), is passed to PSOLBL. No data is returned to the OP package. This entry point is called by the CMOP package to pass the internal entry number of the Prescription file (#52) to the Outpatient Pharmacy software to print the prescription label. prescription label information. COMPONENT: IBCP VARIABLES: DFN Type: Input Patient VistA ID PSOSITE Type: Input Pointer to Pharmacy Site File (#59) PSOLBLCP Type: Output 0 -- NOT BILLABLE 1 -- BILLABLE 2 -- ADDITIONAL DATA NEEDED This entry point is called once for each DFN and it "helps determine" the copay status that will print on the CMOP form. If the patient is income exempt or 100% service connected, it will return a 0 for not billable. ("NO COPAY"). Additional checks for other exemptions are done following the call to determine the copay status if the value returned is a 1 or a 2. ******************** 2479 NAME: RAD/NUC MED REPORTS FILE (#74) ALL CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: WOMEN'S HEALTH SPINAL CORD DYSFUNCTION IMAGING ADDED 8/11/2010 CLINICAL REMINDERS Clinical Reminders has been granted subscriber status to this IA to facilitate the development and release of patch PXRM*2.0*71. USAGE: Controlled Subscri ENTERED: JUL 14,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to read with FileMan an entire RAD/NUC MED REPORTS file (#74) entry and to display certain Radiology/Nuclear Medicine report information concerning mammograms and breast ultrasound exams to the WVH users. On August 11th 2020, Clinical Reminders (PXRM) requested subscription to this Integration Agreement (IA) to access data in the RAD/NUC MED REPORTS file. It was decided at this time that all current and future subscribers to this IA would be granted full read with VA FileMan access to all fields in the RAD/NUC MED REPORTS file. Please note that as of this date (08/20/2020) the following fields are computed and have no global location: Field # Field Name ------- ---------- 102 PROCEDURE 103 EXAM STATUS 104 CATEGORY OF EXAM 106 WARD 107 SERVICE 108 PRINCIPAL CLINIC 109 CONTRACT/SHARING SOURCE 109.5 RESEARCH SOURCE 112 PRIMARY INTERPRETING RESIDENT 113 PRIMARY DIAGNOSTIC CODE 114 REQUESTING PHYSICIAN 115 PRIMARY INTERPRETING STAFF 116 COMPLICATION 118 PRIMARY CAMERA/EQUIP/RM 119 BEDSECTION ^RARPT(D0) The entire RAD/NUC MED REPORTS file can be read, by subscribing VistA applications, with VA FileMan. ROUTINE: ******************** 2480 NAME: RAD/NM PATIENT FILE (#70) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: WOMEN'S HEALTH VIRTUAL PATIENT RECORD DSS - DECISION SUPPORT SYSTEM EX 4/17/14-DSS added as a subscriber to reference the "ADC" cross reference. USAGE: Controlled Subscri ENTERED: JUL 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to view the following fields from the RAD/NUC MED PATIENT file (#70): [Modified 5/26/2009 to include Pregnancy Screen,Pregnancy Screen Comment and Imaging Order.] [Modified 08/04/2011 to include read w/FileMan access to the VISIT field (70.03;27). The request was made by AViVA (VPR).] ^RADPT( .01 NAME 0;1 Direct Global Read & w ^RADPT(D0,DT, .01 EXAM DATE 0;1 Direct Global Read & w ^RADPT(D0,DT,D1,P, .01 CASE NUMBER 0;1 Direct Global Read & w 2 PROCEDURE 0;2 Direct Global Read & w 8 PRINCIPAL CLINIC 0;8 Direct Global Read & w 13 PRIMARY DIAGNOSTIC C 0;13 Direct Global Read & w 14 REQUESTING PHYSICIAN 0;14 Direct Global Read & w 26 CREDIT METHOD 0;26 Direct Global Read & w 400 CLINICAL HISTORY FOR H;wp Read w/Fileman 32 PREGNANCY SCREEN 0;32 Read w/Fileman 11 IMAGING ORDER 0;11 Read w/Fileman 27 VISIT 0;27 Read w/Fileman ^RADPT(D0,DT,D1,P,D2,M, .01 MODIFIERS 0;1 Direct Global Read & w ^RADPT('ADC',DATE-CASE,D1,D2,D3) The ADC cross-reference identifies the date and case number of the Radiology exam. It is in the following format: ^RADPT("ADC",DATE-CASE#,DFN,INVERSE DATE/TIME,INTERNAL ENTRY NUMBER) for example: ^RADPT("ADC","121196-73",18,7038788.8783,1) ^RADPT(D0,DT,D1,P,D2,PCOMM, 80 PREGNANCY SCREEN COM PCOMM;1 Read w/Fileman ROUTINE: ******************** 2481 NAME: RAD/NUC MED PROCEDURES (#71) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: JUL 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71, DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to view the CPT Code associated with a Radiology/NM procedure to determine if the procedure is a mammogram or breast ultrasound procedure. ^RAMIS(71,D0,0) 9 CPT CODE 0;9 Read w/Fileman ROUTINE: ******************** 2482 NAME: PROCEDURE MODIFIERS (#71.2) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: JUL 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71.2 ROOT: RAMIS(71.2, DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to view the NAME field of the PROCEDURE MODIFIERS file (71.2) to determine which modifiers were used for a Radiology procedure. ^RAMIS(71.2,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2483 NAME: FILE 2 IA for WVH CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: JUL 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File The Women Veterans Health package would like to view the following fields in the Patient File (#2): ^DPT(D0,.13) .131 PHONE NUMBER [RESIDE 13;1 Read w/Fileman ^DPT(D0,.11) .111 STREET ADDRESS [LINE .11;1 Read w/Fileman .114 CITY .11;4 Read w/Fileman .115 STATE .11;5 Read w/Fileman .116 ZIP CODE .11;6 Read w/Fileman ^DPT(D0,VET) 1901 VETERAN (Y/N)? VET;1 Read w/Fileman ROUTINE: ******************** 2484 NAME: DIAGNOSTIC CODES (78.3) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: JUL 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 78.3 ROOT: RA(78.3, DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to point to the DIAGNOSTIC CODES (78.3) file so that the WV RESULTS/DIAGNOSIS file (790.31) file entries can be associated with the Radiology diagnostic codes. ^RA(78.3 .01 DIAGNOSTIC CODE 0;1 Pointed to ROUTINE: ******************** 2485 NAME: DBIA2485 CUSTODIAL PACKAGE: FEE BASIS SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH The IVM package generates a daily HL7 transmission (ORUZ07) to HEC. This transmission will include ZFE segments that are generated by the FEE BASIS routine. USAGE: Controlled Subscri ENTERED: JUL 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API builds the ZFE HL7 segments for a specified veteran. These segments contain FEE Authorization data. ROUTINE: FBHLZFE COMPONENT: EN(DFN,FBSTR,FBCUT) VARIABLES: DFN Type: Input internal entry number of the PATIENT (#2) file FBSTR Type: Input (Optional) Comma delimited sting of requested fields. DEFAULT: "1,2,3,4,5" (returns all fields). FBCUT Type: Input (Optional) Cutoff date (fileman format). Default: "2961001" (Oct 1, 1996). Authorizations with a TO DATE prior to the cutoff will not be considered. HLFS Type: Input HL7 field separator that should be used in the segment. HLQ Type: Input HL7 null field value. FBZFE(I) Type: Output An array of string(s) forming the ZFE segments for the patient's FEE authorizations that meet the criteria. (OR Undefined if no authorizations meet criteria.) Note: Only the latest authorization for each group is returned (where group is FEE PROGRAM + TREATMENT TYPE). Returns array of ZFE segments containing FEE BASIS Authorization data for a veteran. ******************** 2486 NAME: LOGGING PATIENTS FOR THE NIGHTLY TRANSMISSION CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: FEE BASIS REGISTRATION USAGE: Controlled Subscri ENTERED: JUL 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: IVMPLOG COMPONENT: EVENT(DFN) VARIABLES: DFN Type: Input The patient DFN. This is the internal entry number of the patient record in the Patient file. This tag is used to log a patient into the IVM PATIENT file for inclusion in the nightly IVM Full Data Transmission. ******************** 2487 NAME: CMOP MAILGROUP ACCESS CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: JUL 28,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.8 ROOT: XMB(3.8,0 DESCRIPTION: TYPE: File The Consolidated Mail Outpatient Pharmacy (CMOP) package requires access to the "B" cross reference in the Mailgroup (3.8) File. This access will be limited to CMOP V 2.0 software and the routine PSXPOST. ROUTINE: ******************** 2488 NAME: IA2488 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: AUG 4,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 772 ROOT: HL(772 DESCRIPTION: TYPE: File The Lab requests a DBIA from HL7 for the following reference: ^HL(772,176674,"P") = 4^2980419.101639^EventProtocol not found^13 Using the code: S LRSTATUS=+$G(^HL(772,LRMID,"P")) I plan to use this during the acknowledgement process of NCH messages from Austin. REFERENCE FORUM MESSAGE: 27535419 ^HL(772,DA,0) 20 STATUS P;0 Direct Global Read & w ROUTINE: ******************** 2491 NAME: DBIA 16B CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: AUG 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File This amends DBIA #16 to include file reference used for OP and NON-OP Health Summary. ^SRF( .22 TIME OPERATION BEGIN .2;2 Read w/Fileman .23 TIME OPERATION ENDS .2;3 Read w/Fileman .205 TIME PAT IN OR .2;10 Read w/Fileman .31 PRINC ANESTHETIST .3;1 Read w/Fileman 17 CANCEL DATE 30;1 Read w/Fileman 10 SCHEDULED START DATE 31;4 Read w/Fileman 66 PRIN DIAGNOSIS CODE 34;2 Read w/Fileman 118 NON-OR PROCEDURE NON;1 Read w/Fileman 120 DATE OF PROCEDURE NON;3 Read w/Fileman 123 PROVIDER NON;6 Read w/Fileman 134 ATTEND PROVIDER NON;7 Read w/Fileman 125 MEDICAL SPECIALTY NON;8 Read w/Fileman 26 PRINCIPLE PROCEDURE OP;1 Read w/Fileman 36 REQUESTED REQ;1 Read w/Fileman 33 PRINCIPAL DIAGNOSIS 33;2 Read w/Fileman ^SRF(D0,12, .01 SURGEON'S DICTATION 0;1 Read w/Fileman ^SRF(D0,38, .01 OPERATIVE FINDINGS 0;1 Read w/Fileman ^SRF(D0,40, .01 INDICATIONS FOR OPER 0;1 Read w/Fileman ^SRF(D0,'OPMOD', .01 PRIN. PROCEDURE CPT 0;1 Read w/Fileman ^SRF(D0,13,D1,'MOD', .01 OTHER PROCEDURE CPT 0;1 Read w/Fileman ROUTINE: ******************** 2492 NAME: DBIA2492 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 17,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File CIRN needs read access to ^DGPT to calculate the Master of Record Score Global Reference: ^DGPT('B', The "B" cross-reference is used to find a specific PTF record for a patient. The RGVCCMR2 routine orders through the 'B' cross-reference $O(^DGPT("B",+DFN,NXPTF to order through the ^DGPT(NXPTF,0 for admission dates. It compares the admission dates to current year, and past two years to calculate the CMOR score. ^DGPT(D0,'S',0 Direct Read orders through ^DGPT(NXPTF,"S",0 for the surgury/procedure dates. ^DGPT(D0,0 2 Admission Date 0;2 Direct Global Read CIRN is looking for patient(s) activity over a three-year period. ^DGPT( 2 ADMISSION DATE 0;2 Direct Global Read & w ROUTINE: ******************** 2494 NAME: DBIA-2494 PDM-Delete bad field global CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: DD(50,0,ID DESCRIPTION: TYPE: File To resolve NOIS # EKH-0798-41058, we are inserting a line of code to delete the impartial field data found in File #50. We believe that the ^DD(50,0,"ID",534016) global is a local site-specific field. We do not have a zero node that identifies the field name. We are adding a line of code to routine PSSPCH13 that checks for the zero node. If not there, it will delete the data related to the field number 534016. Example. I '$D(^DD(50,534016)) K ^DD(50,0,"ID",534016). This change is included in patch PSS*1*13. ^DD(50,0,ID 534016 DRUG FIL Direct Global Write & ROUTINE: ******************** 2495 NAME: DBIA2495 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 7 ROOT: DIC(7, DESCRIPTION: TYPE: File Pharmacy Benefits Management needs to extract the name and abbrev from the Provider Class File #7. The provider pointer (#200) will be obtained from various pharmacy files. The new person provider class field #53.5 will be then be used to extract the name and abbrev from the Provider Class File. ^DIC(7, .01 NAME 0;1 Direct Global Read & w 1 Abbrev. TITLE 0;2 Direct Global Read & w ROUTINE: ******************** 2496 NAME: MAILMAN SITE PARAMETERS CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT MENTAL HEALTH Mental Health has permission to read both fields 8.3 and 8.31 with FileMan, to ensure that messages are under the send/receive line limits of particular sites. USAGE: Private ENTERED: AUG 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.3 ROOT: XMB(1, DESCRIPTION: TYPE: File Pharmacy Benefits Managment is an extract program. It will extract Pharmacy IV, Unit dose, prescription, Controlled substance and ward stock order information along with Procurement and a limited amount of laboratory data. The data will be sent via MailMan message to Pharmacy Benefits Management section at Hines and incorporated into their national database. These messages will be very long and we wanted to make sure that the PBM software 'honored' the sites wishes to limit their message line #. If we do not find a number in the NETWORK -MAX LINES @ SEND TO field, the program will limit the message to 10,000 lines. ^XMB(1,D0,'NETWORK-LIMIT') 8.3 NETWORK - MAX LINES NETWORK- Read w/Fileman 8.31 NETWORK - MAX LINES NETWORK- Read w/Fileman ROUTINE: ******************** 2497 NAME: DBIA2497 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: AUG 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 55 ROOT: PS(55 DESCRIPTION: TYPE: File This agreement will be retired on 12/31/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*101. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. All fields and x-refs in file 55 have global read access by the subscribing packages. This DBIA retirement only applies to non-pharmacy packages. Pharmacy packages are still allowed to utilize this agreement past the expiration date of December 31, 2006. Pharmacy Benefits Management extracts data from the following Pharmacy Patient File #55 fields. ^PS(55,'AUDS',X,D0,D1) This cross reference is used to identify active unit dose orders for a specified reporting period and the patients for which the orders are written for. ^PS(55,D0,5, .01 Order Number 0;1 Read w/Fileman .5 Patient Name 0;15 Read w/Fileman 1 Provider 0;2 Read w/Fileman 68 Last ward 0;23 Read w/Fileman 3 MED ROUTE 0;3 Read w/Fileman ^PS(55,D0,5,D1,2) 26 Schedule 2;1 Read w/Fileman 10 Start date/time 2;2 Read w/Fileman 34 Stop date/time 2;4 Read w/Fileman 9 Original ward 2;10 Read w/Fileman ^PS(55,D0,5,D1,1,D2,0) .01 Dispense drug 0;1 Read w/Fileman .02 Units Per Dose 0;2 Read w/Fileman .03 Inactive Date 0;3 Read w/Fileman Program will $O through the dispense drug multiple to identify all dispense drugs associated with a particular unit dose order. ^PS(55,D0,5,D1,11,D2,0) .01 Dispense date/time 0;1 Read w/Fileman $O on the "B" x-ref is also covered, plus global reads on the subscripts after "B", .02 DISPENSE DRUG 0;2 Read w/Fileman .05 How 0;5 Read w/Fileman .03 AMOUNT 0;3 Read w/Fileman .04 COST 0;4 Read w/Fileman .06 USER 0;6 Read w/Fileman .07 WARD 0;7 Read w/Fileman .08 PROVIDER 0;8 Read w/Fileman $O permitted through the dispense drug multiple. $D may be performed on ^PS(55,D0,5,D1,11,D2) ^PS(55,D0,"IV", .01 Order Number 0;1 Read w/Fileman .02 Start Date/time 0;2 Read w/Fileman .03 Stop date/time 0;3 Read w/Fileman .04 Type 0;4 Read w/Fileman 108 Intermittent Syring 0;5 Read w/Fileman .06 Provider 0;6 Read w/Fileman .08 Infusion rate 0;8 Read w/Fileman .09 Schedule 0;9 Read w/Fileman 104 Ward 0;22 Read w/Fileman 106 CHEMOTHERAPY TYPE 0;23 Read w/Fileman 132 MED ROUTE .2;3 Read w/Fileman .22 IV ROOM 2;2 Read w/Fileman ^PS(55,D0,'IV',D1,AD,D2,0) .01 Additive 0;1 Read w/Fileman .02 Strength 0;2 Read w/Fileman Program will $O through the Additive multiple to identify all additives associated with an IV order. ^PS(55,D0,'IV',D1,SOL,D2,0) .01 Solution 0;1 Read w/Fileman 1 Volume 0;2 Read w/Fileman The program will $O through the solution multiple to identify all solutions associate with an IV order. ^PS(55,D0,'IV',D1,LAB,D2,0) 1 Date 0;2 Read w/Fileman 2 Action 0;3 Read w/Fileman 4 Labels 0;5 Read w/Fileman 6 Daily Usage 0;7 Read w/Fileman The program will $O through the label tracking multiple to identify dispensing occurrences within a specified time period. ^PS(55,'AIVS',X,D0,D1) The program will utilize the "AIVS" cross reference to identify active IV orders for a specific time period and the patients for which the orders are written for. ^PS(55,'AUD',X,D0,D1) The "AUD" x-ref is to identify active Unit Dose orders for a specific time period and patients for which the orders are written. ROUTINE: ******************** 2498 NAME: DBIA2498 CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.4 ROOT: PS(59.4 DESCRIPTION: TYPE: File Pharmacy Benefits Managment will extract the inpatient name from the Inpatient Site file #59.4. ^PS(59.4,D0,0) .01 Name 0;1 Read w/Fileman ROUTINE: ******************** 2499 NAME: DBIA2499 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.5 ROOT: PS(59.5 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts the following fields from the IV Room file #59.5: .02 Division .104 LVP'S GOOD FOR HOW MANY DAYS .111 HYPERAL GOOD FOR HOW MANY DAYS .112 PB'S GOOD FOR HOW MANY DAYS 17 SYRN'S GOOD FOR HOW MANY DAYS 18 CHEMO'S GOOD FOR HOW MANY DAYS ^PS(59.5,D0,0) .02 Division 0;4 Read w/Fileman ^PS(59.5,D0,1) .104 LVP'S GOOD FOR HOW M 1;4 Read w/Fileman .111 HYPERAL GOOD FOR HOW 1;17 Read w/Fileman .112 PB'S GOOD FOR HOW MA 1;18 Read w/Fileman ^PS(59.5,D0,5) 17 SYRN'S GOOD FOR HOW 5;1 Read w/Fileman 18 CHEMO'S GOOD FOR HOW 5;2 Read w/Fileman ROUTINE: ******************** 2500 NAME: DBIA 2500 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Requesting approval to use DOLRO^%ZOSV. This entry is in every Kernel %ZOSV and only requires the variable X as input as to where the user wants to store a list of the variables in the partition. This functionality is desired and it is located within the Kernel for each platform that Kernel runs on. Its use is requested so that seperate hardcoded routines for each platform do not have to be written to achieve the same functionality. This request is made in behalf of the Pharmacy Benefits Program (PSU) and McKinley Enterprises | WesTech Computer Group (BTW) who is coding PBM| under contract with EDS through the VA - EDS Partnership. ROUTINE: %ZOSV COMPONENT: DOLRO VARIABLES: X Type: Input The global or variable root of where the uses wishes to store the names of the partition variables. Existing entry point providing a listing of partition variable names in a location that is user specified. ******************** 2501 NAME: DBIA2501 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 17,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 40.7 ROOT: DIC(40.7, DESCRIPTION: TYPE: File CIRN needs read access to ^DIC(40.7,'C' to calculate the Master of Record Score ^DIC(40.7,'C',105, ^DIC(40.7,'C',105 Direct Read - IEN of XRAY Stop Code ^DIC(40.7,'C',108, Direct read - IEN of LAB Stop Code The xray and lab stop codes (^DIC(40.7,'C',105 and ^DIC(40.7,'C',108) are not counted to avoid duplication since lab & xray are counted separately. The RGPRPST routine does a Direct Read of ^DIC(40.7 and uses it with the fileman lookup routine ^DIC to set primary care clinics to file 991.8 PRIMARY CARE CLINIC STOPS field (#17) The subfield that points to file 40.7 is PRIMARY CARE CLINIC STOPS field (#.01). ^DIC(40.7,'C',108, Same as for DIC(40.7,'C',105, ... ^DIC(40.7, .01 NAME 0;1 Pointed to ROUTINE: ******************** 2502 NAME: DBIA2502 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: AUG 18,1998 STATUS: Active EXPIRES: DEC 31,1999 DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine An integration agreement is needed with the PCE package for the Scheduling data conversion project. The PCE package's standard filer entrypoints require that all providers added to PCE for a visit have a valid provider class. The problem is that some of the encounters that the Scheduling conversion can convert will consist of old provider data where the provider class for the provider does not exist. As a result, many many providers will not be able to be converted with their visits/encounters because they do not have a valid provider class. Denis Eaton was consulted about this and he concluded the only way to store these old providers in PCE would be to pre-set the global array that PCE uses to file the data to what it would look like after all the edit checks were done, and call the filer directly. Since the affected provider data is old and its corresponding visit will be flagged as historical in PCE, there should not be a data integrity issue with storing a provider without a valid provider class. It also makes the conversion more consistent and complete. This exemption is requested specifically for filing the new provider data and would be a one-time exemption to be used only when new visits are created as a result of the conversion. All other data added to PCE via this project would flow through the normal PCE edits. The agreement would only exist for the life of the conversion. The array definition follows: ^TMP("PXK",$J,"SOR") = Source ien ^TMP("PXK",$J,"VST",1,0,"BEFORE") = the 0-node of the visit file ^TMP("PXK",$J,"VST",1,0,"AFTER") = the same as "BEFORE" ^TMP("PXK",$J,"VST",provider counter,"IEN") = "" ^TMP("PXK",$J,"PRV",provider counter,0,"BEFORE") = "" ^TMP("PXK",$J,"PRV",provider counter,0,"AFTER") = Provider id^DFN^Visit ien^P/S for primary/secondary ^TMP("PXK",$J,"PRV",provider counter,"IEN") = "" ^TMP("PXK",$J,"PRV",provider counter,"BEFORE") = "" ^TMP("PXK",$J,"PRV",provider counter,"AFTER") = ^Package ien^Source ien The entrypoint to call for the post-edit filer is EN1^PXKMAIN ROUTINE: PXKMAIN COMPONENT: EN1 VARIABLES: PXKNOEVT Type: Input We need approval to set the variable PXKNOEVT before making the calls to EN1^PXKMAIN and $$DATA2PCE^PXAPI. Setting this variable prevents the PXK VISIT DATA EVENT driver protocol from being executed. Since the data is coming from Scheduling initially and it is old 'historical' information, there is no need to notify Scheduling when the encounter data has been added to the PCE database. Also, by not executing this event driver, conversion processing is faster and less complicated. ******************** 2503 NAME: USE OF LR7OR1 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING MENTAL HEALTH CLINICAL REMINDERS CARE MANAGEMENT VBECS MRSA INITIATIVE REPORTS NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD TEXT INTEGRATION UTILITIES VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: AUG 18,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA formalizes the documentation for calls to LR7OV1 as documented in the OE/RR Interface Specification document. ROUTINE: LR7OR1 COMPONENT: RR(DFN,ORDER,BEG,END,SUB,TEST,FLAG,MAX) VARIABLES: DFN Type: Input IEN of PATIENT file (#2) (REQUIRED) ORDER Type: Input Lab order number BEG Type: Input Beginning date for results search (OPTIONAL) END Type: Input Ending date for results search (OPTIONAL) SUB Type: Input Lab subsection of CH,MI,AP or ALL (OPTIONAL - default is ALL) TEST Type: Input Pointer to LABORATORY TEST file (#60) (OPTIONAL - if nothing passed, gets all results) FLAG Type: Input L for LOCAL or N for NATIONAL. Denotes test ID used. (OPTIONAL) MAX Type: Input Maximum number of results to return (OPTIONAL) TMP('LRRR' Type: Output TMP("LRRR",$J,DFN,SUB,inverse date/time,sequence #) set to: = Test^result^L/N flag^units^reference range^result status^^^Nat'l Code^Name^System^Verified by^^Ther flag^Print Name^Accession^Order# Note: Test is a pointer to the LABORATORY TEST file (#60). This call returns lab results in the format: ^TMP("LRRR",$J,DFN,SUB,inverse d/t,sequence #) = Test^result^L/N flag^ units^reference range^result status^^^Nat'l Code^Name^System^Verified b y^^Therapeutic flag^Print Name^Accession^Order# (where Test is a ptr to the Lab Test file #60) COMPONENT: $$LRDFN(IFN,FILEROOT) VARIABLES: IFN Type: Input Internal File Number FILEROOT Type: Input Root of file to get LRDFN (optional) "DPT(" is default $$LRDFN Type: Output Internal file number of the entry in the LAB RESULTS file Get LRDFN ******************** 2504 NAME: DBIA2504 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: AUG 19,1998 STATUS: Active EXPIRES: JAN 1,1999 DURATION: Next Version VERSION: FILE: 21 ROOT: DIC(21 DESCRIPTION: TYPE: File Lab is requesting a temporary aggreement to read the following: ;NOW GET PERIOD OF SERVICE K VAEL D ELIG^VADPT S:$G(VAEL(2))'="" $P(MSG,HLFS,28)=$P($G(^DIC(21,+VAEL(2),0)),U,3) K VAEL ^DIC(21,D0,0 2 ABBREVIATION Read w/Fileman ROUTINE: ******************** 2505 NAME: INPATIENT SITE CUSTODIAL PACKAGE: CONTROLLED SUBSTANCES SUBSCRIBING PACKAGE: DRUG ACCOUNTABILITY USAGE: Private ENTERED: AUG 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.4 ROOT: PS(59.4,D0,0) DESCRIPTION: TYPE: File In the DRUG ACCOUNTABILITY STATS file (#58.8), there is a field called INPATIENT SITE (#2). This field is a pointer to the NAME field (.01) of the INPATIENT SITE file (#59.4). To obtain the external value of this pointer, a direct global read is used. ^PS(59.4,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2507 NAME: DBIA2507 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: LAB SERVICE CLINICAL INFO RESOURCE NETWORK CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: AUG 20,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: 771.6 ROOT: HL(771.6 DESCRIPTION: TYPE: File Lab requests permission to read file 771.6 as follows: I $G(LRSTATUS) S LRTXT(LRX)="Message: "_LRX_$P(^HL(771.6,+LRSTATUS,0),U) This call will be converted in the next version of the extract. ^HL(771.6, .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2508 NAME: 2508 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: AUG 20,1998 STATUS: Active EXPIRES: JAN 1,1999 DURATION: Next Version VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File The lab requests a DBIA to perform a direct read on the following: S:$D(^DIC(4,"D",SITE)) ISITE=$O(^DIC(4,"D",SITE,0)) I +ISITE>0,$G(^DIC(4,ISITE,0))'="" S SITE=$P(^DIC(4,SITE,0),U,1) ^DIC(4,D0,0, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2509 NAME: DBIA2509 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: SURGERY USAGE: Private ENTERED: AUG 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File Surgery requests permission to $O through the OPTION file (#19) "B" cross reference to identify options in the SR namespace. Surgery further requests READ access by VA FileMan to the ENTRY ACTION field (#20) and WRITE access to the XQUIT EXECUTABLE field (#22). The purpose of this request is to allow Surgery to issue a patch that will identify the Surgery options that may potentially set the XQUIT variable and to update these options with code to process the XQUIT. ^DIC(19,IEN,20) 20 ENTRY ACTION 20;E1,24 Read w/Fileman ^DIC(19,IEN,22) 22 XQUIT EXECUTABLE 22;E1,24 Write w/Fileman ROUTINE: ******************** 2510 NAME: DBIA2510 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59 ROOT: PS(59 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts data from the division fields of the prescription file (#52) and outpatient site field of the drug accountability stats file (#58.8). These fields point to the Outpatient site file #59 from which the outpatient site name and number can be extracted. ^PS(59,D0,0) .01 Name 0;1 Read w/Fileman .06 Site Number 0;6 Read w/Fileman ROUTINE: ******************** 2514 NAME: ACCESS TO DRUG INGREDIENTS FILE (#50.606) CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 24,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50.606 ROOT: PS(50.606, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. National Drug File has need to do a direct global read to the zero node of file 50.606. ^PS(50.606,DA,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2515 NAME: DBIA2515 CUSTODIAL PACKAGE: AUTO REPLENISHMENT/WARD STOCK SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.1 ROOT: PSI(58.1 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts the following fields from File #58.1, Pharmacy AOU Stock in order to attempt to breakdown the AR/WS statistical data by division. Various portions of the program $O through ^PSI(58.1,D0,0), ^PSI(58.1,D0,2,0 and ^PSI(58.1,"ASITE",in order to use various Area of Uses (AOU) to map an inpatient site to a specific division by using the ward/location (for percentage) field. ^PSI(58.1,D0,2, .01 WARD/LOCATION (FOR P 0;1 Read w/Fileman ^PSI(58.1, 3 INACTIVE DATE I;1 Read w/Fileman 4 INPATIENT SITE SITE;1 Read w/Fileman ROUTINE: ******************** 2516 NAME: DBIA2516 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK SCHEDULING INTEGRATED BILLING USAGE: Controlled Subscri ENTERED: AUG 24,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 8.1 ROOT: DIC(8.1 DESCRIPTION: TYPE: File ^DIC(8.1,D0,0) .01 NAME 0;1 Direct Global Read 6 INACTIVE 0;7 Direct Global Read One of the CIRN pre-implementation steps is to compare the entries in the ELIGIBILITY CODE file (#8) and the MAS ELIGIBILITY CODE file (#8.1). This is to insure that all the entries in File 8 link to a corresponding entry in File 8.1. The CIRN ELIGIBILITY CODE REVIEW report, routine RGPRELIG, displays these links. ROUTINE: ******************** 2517 NAME: FILE405 ADFN X-REF CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: AUG 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File The Women Veterans Health (WVH) package requests permission to loop through the ADFN cross-reference to determine if a patient has an entry within a user selected date range. The WVH package does not want to look at the entry itself, but is merely interested in whether the patient has a record. ^DGPM('ADFN'_DFN The cross-reference consists of the letters ADFN concatenated to the patient's DFN value followed by the movement date in FileMan format and the internal entry number of the record. For example: ^DGPM("ADFN346",2870225.13,2246) ROUTINE: ******************** 2518 NAME: OUTPATIENT DRUG INTERACTION CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: AUG 25,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy V 6.0 package (OP) requests the ability to re-route the Drug-Drug interaction function to the National Drug File's (NDF) routine PSNDINT. Upcoming new functionality by NDF will eventually replace the OP Drug-Drug interaction functionality. During the installation period this would allow the users a painless introduction to the new functionality. After a period of time the OP options will be removed. OP ROUTINE/LINETAG ADD+1^PSOHELP Add local drug interactions CRI+1^PSOHELP Change interaction severity Both call PSNDINT at the top. No variables are passed or returned. ROUTINE: PSNDINT COMPONENT: PSNDINT VARIABLES: This is a stand-alone NDF option used to add or change drug interactions. ******************** 2519 NAME: DBIA2519 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.8 ROOT: PSD(58.8 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts the following fields from the Drug Accountability Stats file #58.8 on a montly basis. ^PSD(58.8,D0,0) .01 Pharmacy Location 0;1 Read w/Fileman 1 Location type 0;2 Read w/Fileman 2 Inpatient site 0;3 Read w/Fileman 3 Primary dispensing s 0;4 Read w/Fileman 20 Outpatient site 0;10 Read w/Fileman 4 INACTIVE DATE I;1 Read w/Fileman ^PSD(58.8,D0,1,D1,0) .01 Drug 0;1 Read w/Fileman 7 Breakdown Unit 0;8 Read w/Fileman 8 Package Size 0;9 Read w/Fileman ^PSD(58.8,D0,3.5,D1,0) .01 IV Room 0;1 Read w/Fileman ^PSD(58.8,D0,3,D1,0) .01 Ward 0;1 Read w/Fileman ^PSD(58.8,"B", "B" x-ref, direct global read access permitted. ROUTINE: ******************** 2520 NAME: DBIA2520 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.81 ROOT: PSD(58.81 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts data from the Drug Accountability Transaction file #58.81 on a monthly basis. The program uses the ^PSD(58.81,"AF" cross reference on the date/time field to identify certain types of controlled substance and procurement transactions. ^PSD(58.81,D0,0) .01 Transaction Number 0;1 Read w/Fileman 1 Type 0;2 Read w/Fileman 2 Pharmacy Location 0;3 Read w/Fileman 3 Date/time 0;4 Read w/Fileman 4 Drug 0;5 Read w/Fileman 5 Quantity 0;6 Read w/Fileman 8 Purchase Order Numbe 0;9 Read w/Fileman 12 Manufacturer 0;13 Read w/Fileman 17 NAOU 0;18 Read w/Fileman ^PSD(58.81,D0,4) 48 Edit Verified Order 4;1 Read w/Fileman 50 New Quantity 4;3 Read w/Fileman ^PSD(58.81,D0,5) 55 Cancelled Verified O 5;1 Read w/Fileman ^PSD(58.81,D0,8) 71 Prime Vendor Invoice 8;1 Read w/Fileman 106 Prime Vendor Order N 8;2 Read w/Fileman ^PSD(58.81,D0,9) 73 Patient 9;1 Read w/Fileman ROUTINE: ******************** 2521 NAME: DBIA2521 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.811 ROOT: PSD(58.811 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts data from the Drug Accountability Order file #58.811 on a monthly basis. The program utilizes the ^PSD(58.811,"ADATE", cross reference to identify prime vendor invoices for a specific time period. ^PSD(58.811,D0,0) 1 Vendor name 0;2 Direct Global Read & w .01 ORDER NUMBER 0;1 Direct Global Read & w ^PSD(58.811,D0,1,D1,0) .01 Invoice Number 0;1 Direct Global Read & w 2 INVOICE STATUS 0;3 Direct Global Read & w 4 Pharmacy Location 0;5 Direct Global Read & w 13 Master Vault 0;12 Direct Global Read & w 1 INVOICE DATE 0;2 Direct Global Read & w 3 ORDER DATE 0;4 Direct Global Read & w 7 DELIVERY DATE 0;6 Direct Global Read & w ^PSD(58.811,D0,1,D1,1,D2,0) 1 Drug 0;2 Direct Global Read & w 2 Quantity Invoiced 0;3 Direct Global Read & w 3 Order unit 0;4 Direct Global Read & w 4 Price per Order Unit 0;5 Direct Global Read & w 7 Date verified 0;8 Direct Global Read & w 13 NDC 0;11 Direct Global Read & w 14 VSN 0;12 Direct Global Read & w 15 UPC 0;13 Direct Global Read & w .01 LINE ITEM NUMBER 0;1 Direct Global Read & w 5 DATE PROCESSED 0;6 Direct Global Read & w 6 PROCESSOR 0;7 Direct Global Read & w 8 VERIFIER 0;9 Direct Global Read & w 12 CONTROLLED SUBSTANCE 0;10 Direct Global Read & w ^PSD(58.811,D0,1,D1,1,D2,1,D3,0) .01 Adjusted field 0;1 Direct Global Read & w 5 Verifier Adjustment 0;6 Direct Global Read & w 1 PROCESSOR ADJUSTMENT 0;2 Direct Global Read & w 2 PROCESSOR'S REASON 0;3 Direct Global Read & w 3 PROCESS DATE 0;4 Direct Global Read & w 4 PROCESSOR 0;5 Direct Global Read & w 6 VERIFIER'S REASON 0;7 Direct Global Read & w 7 VERIFICATION DATE 0;8 Direct Global Read & w 8 VERIFIER 0;9 Direct Global Read & w ^PSD(58.811,D0,1,D1,1,D2,2) 10 Dispense Units Per O 2;1 Direct Global Read & w 16 Synonym Node 2;3 Direct Global Read & w 11 REORDER LEVEL 2;2 Direct Global Read & w 17 STOCK LEVEL 2;4 Direct Global Read & w ^PSD(58.811,D0,1,D1,1,0) 5 LINE ITEM DATA 1;0 Direct Global Read & w ^PSD(58.811,D0,1,D1,1,D2,1,0) 9 ADJUSTMENTS 1;0 Direct Global Read & w ^PSD(58.811,D0,1,0) 2 INVOICE DATA 1;0 Direct Global Read & w ROUTINE: ******************** 2522 NAME: DBIA2522 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 64 ROOT: LAM( DESCRIPTION: TYPE: File Pharmacy Benefits Management utilizes the Wkld Code file #64 to identify national laboratory tests with a specific wkld code and then which local laboratory tests are linked. The ^LAM("C" cross reference will be used to identify national laboratory test with a specific wkld code. The ^LAM(D0,7,"B", cross refernce on the associated name field will be used to identify all local laboratory tests linked to specific wkld codes. ^LAM(D0,7,D1,0) .01 Associated Names 0;1 Direct Global Read & w ROUTINE: ******************** 2523 NAME: DBIA2523 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60 DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts data from the Laboratory test file #60. Only local laboratory tests with a site/specimen that contains 'plasma', 'serum' or 'blood'. The name, units and the location of the test result data can then be extracted. ^LAB(60, .01 Name 0;1 Read w/Fileman 5 Location (Data Name) 0;5 Read w/Fileman ^LAB(60,D0,1, .01 SITE/SPECIMEN 0;1 Read w/Fileman 6 Units 0;7 Read w/Fileman 1 REFERENCE LOW 0;2 Read w/Fileman 2 REFERENCE HIGH 0;3 Read w/Fileman 3 CRITICAL LOW 0;4 Read w/Fileman 4 CRITICAL HIGH 0;5 Read w/Fileman 7 TYPE OF DELTA CHECK 0;8 Read w/Fileman 8 DELTA VALUE 0;9 Read w/Fileman 9 DEFAULT VALUE 0;10 Read w/Fileman 9.2 THERAPEUTIC LOW 0;11 Read w/Fileman 9.3 THERAPEUTIC HIGH 0;12 Read w/Fileman ROUTINE: ******************** 2524 NAME: DBIA2524 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: AUG 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Pharmacy Benefits Management extracts test results (^LR(D0,CH,0)=^63.04^^ for certain laboratory tests, the hi/lo flag and the date/time the specimen was taken. The program will go back one year and pull the most recent result for a particular lab test. ^LR(D0,CH,D1,0) .01 Date/time Specimen T 0;1 Read w/Fileman .05 Specimen Type 0;5 Read w/Fileman .03 Date report complete 0;3 Read w/Fileman ^LR(D0,CH,LRIDT,DATANAME) The program extracts all data stored on this node, but only the test results, hi/lo flag and whether or not the test was verified is used. The above fields are found in the first 3 pieces of the DATANAME node. ROUTINE: ******************** 2526 NAME: PRCHUTL CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: SEP 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement will allow Accounts Receivable to call two functions in this routine. $$VENSEL will return the internal number of a user selected Vendor from the IFCAP Vendor file. $$VEN will return the Vendor ID number when the internal number of a Vendor is sent to this function. ROUTINE: PRCHUTL COMPONENT: $$VENSEL() VARIABLES: $$VENSEL Type: Output The following is returned from the IFCAP Vendor File: CONDITION RETURNED VALUE ^DIC VALUE LOOKUP FAILED -1 Y=-1 TIMED OUT -2 DTOUT UP-ARROW -3 DUOUT SUCCESSFUL IEN^.01 FIELD Y=N^S SUCCESSFUL & NEW IEN^.01 FIELD^1 Y=N^S^1 The call to get a vendor entry is $$VENSEL^PRCHUTL(). This function does 3 things. First, it asks the user for their site. Second, it allows the user to select an IFCAP vendor record. And third, it returns the following: CONDITION RETURNED VALUE ^DIC VALUE LOOKUP FAILED -1 Y=-1 TIMED OUT -2 DTOUT UP-ARROW -3 DUOUT SUCCESSFUL IEN^.01 FIELD Y=N^S SUCCESSFUL & NEW IEN^.01 FIELD^1 Y=N^S^1 COMPONENT: $$VEN(A) VARIABLES: $$VEN Type: Output The call to get the FMS VENDOR CODE + ALTERNATE ADDRESS INDICATOR is $$VEN^PRCHUTL(A). This function does one thing. It requires the internal entry number of the vendor record that the data will be from. It returnes the FMS VENDOR CODE and, if available, the ALTERNATE ADDRESS INDICATOR as 9 or 11 characters. A Type: Input A = internal entry number of the vendor record that the data will be from. The call to get the FMS VENDOR CODE + ALTERNATE ADDRESS INDICATOR is $$VEN^PRCHUTL(A). This function does one thing. It requires the internal entry number of the vendor record that the data will be from. It returnes the FMS VENDOR CODE and, if available, the ALTERNATE ADDRESS INDICATOR as 9 or 11 characters. ******************** 2527 NAME: DBIA2527 CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT CMOP USAGE: Controlled Subscri ENTERED: SEP 1,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50.612 ROOT: PSNTRAN( DESCRIPTION: TYPE: File ^PSNTRAN(D0, 10 END END;1 Direct Global R/W & w/ 11 LAST UNMATCHED DRUG END;3 Direct Global R/W & w/ The field name entered is correct but is "clipped" in some print-outs. The full field name is: LAST UNMATCHED DRUG CLASSED ROUTINE: ******************** 2528 NAME: DBIA2528 CUSTODIAL PACKAGE: PROSTHETICS SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: SEP 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 660 ROOT: RMPR(660 DESCRIPTION: TYPE: File DSS needs to reference the following fields to extract Prosthetics information for the DSS Program. Additionally, DSS Extracts need to $Order through the ^RMPR(660,"CT") cross-reference to pull the Delivery date from the prosthetics entries. the 'C' cross-reference is on the Delivery Date field (#10). ^RMPR(660,DA) .02 PATIENT NAME 0;2 Direct Global Read & w The name is a pointer to the PROSTHETIC PATIENT file which has the same internal entry number as the main patient database. 2 TYPE OF TRANSACTION 0;4 Direct Global Read & w This set of codes will tell what kind of transaction this request is. 5 QTY 0;7 Direct Global Read & w This is the number of units that was issued or repaired for this transaction. 8 STATION 0;10 Direct Global Read & w The station is the Veterans Affairs site where this transaction is to come to completion. It is the station that is ultimately responsible for the issue and payment for the prosthetic device. This is the station reporting the workload. 10 DELIVERY DATE 0;12 Direct Global Read & w This is the date that the appliance was delivered and accepted by the patient. 11 FORM REQUESTED ON 0;13 Direct Global Read & w The FORM REQUESTED ON is based on current VA regulations. 12 SOURCE 0;14 Direct Global Read & w This set of codes denotes which two possible sources were used for the acquisition of the appliance. The sources are grouped into either VA sources or commercial sources. 14 TOTAL COST 0;16 Direct Global Read & w This field contains the total cost of the transaction. 6 SHIP/DEL 0;17 Direct Global Read & w This is the charge associated with shipping. 4.1 HCPCS 0;22 Direct Global Read & w This field should have the HCPCS code for the prosthetics item. 6.5 PICKUP/DEL 0;26 Direct Global Read & w This field is a set of codes to identify pickup/delivery charges on VAF 10-2319. 40 REQUESTING STATION LB;1 Direct Global Read & w This is the station requesting services or appliances. 70 RECEIVING STATION LB;4 Direct Global Read & w This field contains the institution that will receive the VAF 10-2529-3 request for processing. 46 TOTAL LABOR COST LB;7 Direct Global Read & w The total cost of the labor to perform this job. 47 TOTAL MATERIAL COST LB;8 Direct Global Read & w The total cost of all the materials to perform the job. 48 TOTAL LAB COST LB;9 Direct Global Read & w The Prosthetic Laboratory Total Cost calculated by AMIS. 81 NO ADMIN COUNT AM;2 Direct Global Read & w This field will be set if the Item will not count on the Administrative AMIS or the Orthotic Laboratory AMIS. 62 PATIENT CATEGORY AM;3 Direct Global Read & w This is the Prosthetic Patient Category used for counting AMIS. 68 AMIS GROUPER AMS;1 Direct Global Read & w A number pulled from the Pros. Site Parameter file, used in AMIS calculations. 15 HISTORICAL DATA 0;15 Direct Global Read & w If this field contains an asterisk (*), then this transaction has been counted by the AMIS option, or is considered to be a historical transaction. This Global holds the Prosthetics order information. ROUTINE: ******************** 2529 NAME: DBIA2529 CUSTODIAL PACKAGE: PROSTHETICS SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: SEP 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 669.9 ROOT: RMPR(669.9 DESCRIPTION: TYPE: File DSS Extracts has permission to $Order through the 'C' Cross-Reference on the Prosthetics Site Parameters file (#669.9). [^RMPR(669.9,"C")] The 'C' Cross-Reference is on the Station field (#1) which points to the Institution file (#4). ^RMPR(669.9 This file holds the list of parameters which controls the operation of the prosthetics package at a site. ROUTINE: ******************** 2530 NAME: IB INSURANCE BUFFER ACCEPT/REJECT UPDATES CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: SEP 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing calls the IVM function $UPDATE^IVMLINS4 when an IB Insurance Buffer file entry that originated in IVM is either accepted or rejected. With patch IVM*2*135, IVMREPTR and IVMSUPPR variables were added to the API. ROUTINE: IVMLINS4 COMPONENT: $$UPDATE(DFN,STAT,ID,IVMREPTR,IVMSUPPR) VARIABLES: DFN Type: Input Patient associated with the insurance record updated. STAT Type: Input Change in insurance record status: 1 - accepted, 0 - rejected. ID Type: Input Three pieces of data that identify which of the patients IVM insurance records is being updated: Insurance Co Name ^ Street Add [Line1] ^ Group #. Type: Output Function returns: 1 if update successful, 0 otherwise IVMREPTR Type: Input This is the IVM REASONS FOR NOT UPLOADING (#301.91) Internal Entry Number when an Insurance Segment is rejected. This variable will be stored in the REASON NOT UPLOADING INSURANCE (#.08) field of the IVM PATIENT (#301.5) file. This variable should be us ed in conjunction with the IVMSUPPR variable when an insurance entry is rejected and the calling application already has the IVM REASONS FOR NOT UPLOADING. This is an optional variable. IVMSUPPR Type: Input When this is input with a positive value, any writes to the screen are suppressed and the interactive read of the IVM REASON FOR NOT UPLOADING (#301.91) file is not done. This is an option variable. This variable should be used in conjunction with the IVMREPTR variable. Inform IVM when an insurance policy that originated in the IVM upload is either rejected or accepted into the permanent insurance records. ******************** 2531 NAME: Application Programmer Interfaces (APIs) CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 4,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Since the National Drug File is being redesigned, these APIs are designed to allow other applications to make a smooth transition to the new file structure. ROUTINE: PSNAPIS COMPONENT: PSA VARIABLES: S X=$$PSA^PSNAPIS(ndc,.array) where ndc is a 12 digit National Drug Code and array is an array defined by the calling application returns array(p50)=Drug name from the DRUG file (#50) and p50 is the internal entry number in that file for every drug which has the same product name as the name of the drug identified by the ndc. Returns X as the number of entries in array. COMPONENT: PSJING VARIABLES: S X=$$PSJING^PSNAPIS(p1,p3,.array) where p1 and p3 are the first and third "^" pieces of the "ND" node in the DRUG File (#50) for a selected drug and array is a array defined by the calling application returns array(ien)=ien^ingredient^strength^unit where ien is the internal entry number in the DRUG INGREDIENTS file (#50.416) and ingredient is the name of the ingredient, strength, and unit for each ingredient in the selected drug. Returns X as the number of entries in array. COMPONENT: PSJDF VARIABLES: S X=$$PSJDF^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns X=ien^dose where ien is the internal entry number in the DOSAGE FORM file (#50.606) and dose is the name of the dosage form for the selected drug. COMPONENT: PSJST VARIABLES: S X=$$PSJST^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for the selected drug returns X=1^strength where strength is the strength in the VA PRODUCT file (#50.68). COMPONENT: CLASS VARIABLES: S X=$$CLASS^PSNAPIS(class) where class is a five character VA Drug Classification Code (e.g. CN103) returns X=1 if class is a valid code or 0 if it is not. COMPONENT: DRUG VARIABLES: S X=$$DRUG^PSNAPIS(drug name) returns X=1 if drug name is either a valid Name entry in the VA GENERIC File (#50.6) or a valid Trade Name entry in the NDC/UPN File (#50.67). Returns X=0 otherwise. COMPONENT: PROD0 VARIABLES: S X=$$PROD0^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns product information from the NATIONAL DRUG file (#50.6). X=VA PRODUCT NAME^DOSAGE FORM ENTRY^STRENGTH ENTRY^UNITS ^^^GCNSEQNO^PREVIOUS GCNSEQNO COMPONENT: PROD2 VARIABLES: S X=$$PROD2^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns additional product information. X=VA PRINT NAME^VA PRODUCT IDENTIFIER^TRANSMIT TO CMOP^VA DISPENSE UNIT COMPONENT: DCLASS VARIABLES: S X=$$DCLASS^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 returns the VA DRUG CLASSIFICATION for the selected drug (e.g. CYANIDE ANTIDOTES). COMPONENT: DCLCODE VARIABLES: S X=$$DCLCODE^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns the 5 character class code for the selected drug (e.g. AD200). COMPONENT: VAGN VARIABLES: S X=$$VAGN^PSNAPIS(p1) where p1 is the first piece of the "ND" node in File #50 for a selected drug returns X=VA GENERIC NAME for the selected drug. COMPONENT: DFSU VARIABLES: S X=$$DFSU^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns dose, strength, and units X=DFIEN^DOSE^STIEN^STRENGTH^UNIEN^UNITS where DFIEN is the internal entry number of the dosage form, DOSE is the name of the dosage from, STIEN is the internal entry number of the strength, STRENGTH is the strength, UNIEN is the internal entry number of the units and UNITS is the unit. COMPONENT: VAP VARIABLES: S X=$$VAP^PSNAPIS(da,.array) where da is an internal entry number in the VA GENERIC file (#50.6) and array is an array defined by the calling application returns array(ien)=ien^VA PRODUCT NAME^dfien^DOSE^clien^ CLASS^INACTIVE^COPAY TIER where ien is the internal entry number of the product, dfien is the internal entry number of the DOSAGE FORM, clien is the internal entry number of the class, CLASS is the five character class code for all products associated with the selected drug, inactivation date, and COPAY TIER is the IEN for the COPAY TIER multiple (#45) of VA Product file (#50.68). COMPONENT: PSPT VARIABLES: S X=$$PSPT^PSNAPIS(p1,p3,.array) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug and array is defined by the calling application returns array(psien^ptien)=psien^psize^ptien^ptype where psien is the internal entry number of the package size, ptien is the internal entry number of the package type, psize is the package size, and ptype is the package type for each package size and type combination for the selected drug. Returns X equals the number of entries in array. COMPONENT: DSS VARIABLES: S X=$$DSS^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns x equals the five or seven digit DSS identifier for the selected drug. COMPONENT: CPRS VARIABLES: S X=$$CPRS^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in File #50 for a selected drug returns X=DOSAGE FORM^CLASS CODE^STRENGTH^UNITS for the selected drug. COMPONENT: CIRN VARIABLES: D CIRN^PSNAPIS(ndc,.array) where ndc is a 12 digit National Drug Code and array is defined by the calling application returns array=ndc array(0)=internal entry number in file 50.6 array(1)=VA GENERIC NAME array(2)=dose form ien^^class ien array(3)=strength array(4)=units ien array(5)=package size ien array(6)=package type pointer array(7)=NDC^MANUFACTURER^TRADE NAME^VA PRODUCT NAME POINTER^ROUTE OF ADMINISTRATION If ndc is not a valid entry array is returned as "000000000000" and the seven elements of array are returned as null. COMPONENT: B VARIABLES: S X=$$B^PSNAPIS returns the closed global root of the "B" cross reference on the VA Generic Name. COMPONENT: T VARIABLES: S X=$$T^PSNAPIS returns the closed global root of the "T" cross reference on the Trade Name in the NDC/UPN file (#50.67). COMPONENT: OVRIDE VARIABLES: S X=$$OVRIDE^PSNAPIS(p1,p3) where p1 and p3 are the first and third pieces of the "ND" node in the DRUG File (#50) for the selected drug. Returns the value of the OVERRIDE DF DOSE CHK EXCLUSION Field (#31) from the VA PRODUCT File (#50.68). This field should always be populated with a '1' for 'YES' or a '0' for 'NO', but if the data is not populated, a null will be returned. COMPONENT: FDAMG VARIABLES: S X=$$FDAMG^PSNAPIS(ien) where ien is the internal entry number in the VA PRODUCT file (#50.68), and returns the URL for the medication guide if one exists or null if it does not. COMPONENT: POSDOS VARIABLES: S X=$$POSDOS^PSNAPIS(ien) where ien is the internal entry number in the VA PRODUCT file (#50.68). It returns the values from the following three fields for the VA Product, separated by up-arrow (^): CREATE DEFAULT POSSIBLE DOSAGE (#40) POSSIBLE DOSAGES TO CREATE (#41) PACKAGE (#42) Example: "N^O^O" COMPONENT: DRGCLS VARIABLES: S X=$$DRGCLS^PSNAPIS(IEN) where IEN = (required) internal entry number of National Drug Code (NDC) in NDC/UPN file (#50.67). Returns CODE (#.01) and PARENT CLASS (#2) from VA DRUG CLASS file (#50.605) for a National Drug Code (NDC). X=Drug Class code^Parent Class COMPONENT: INTRAN VARIABLES: D INTRAN^PSNAPIS(SCR) where SCR = M code for value of DIC("S"). Provides input transform lookup functionality for fields that store NDC codes. If SCR is not defined, all active entries will be returned. X=NDC field (#1) if input is valid. If no valid input is available, X will be undefined. COMPONENT: QLIST VARIABLES: D QLIST^PSNAPIS(SCR) where SCR = M code for value of DIC("S"). Provides executable help ("?" or "??") for fields that store NDC codes. If SCR is not defined, all active entries will be returned. Output: List of selectable codes (NDC field (#1)) COMPONENT: CPTIER VARIABLES: VAR1 Type: Input IEN FOR VA PRODUCT file (#50.68) VAR2 Type: Input Date to be verified for Copay Tier VAR3 Type: Input IEN for DRUG file (#50) VAR4 Type: Input VAR4 equal to 1 indicates that the API will return the stored value for copay tier information to be displayed for options such as Drug Enter/Edit, Lookup into Dispensed Drug file, etc. A null value for VAR4 means the calling application will use the returned information for billing purposes. The API will return the copay exempt value of 0 (zero) for products with DEA Special Handling field that contains S for Supply Items, I for Investigational Drugs or N for Nutritional Supplement. The DEA Special Handling supercedes the copay tier field and zero is returned regardless of the copay tier defined on the product. TIER Type: Output COPAY TIER LEVEL field (#.01) from VA PRODUCT file (#50.68) EFFECTIVE Type: Output EFFECTIVE DATE field (#1) from VA PRODUCT file (#50.68) END DATE Type: Output End Date field (#2) from VA PRODUCT field (#50.68) S X=$$CPTIER^PSNAPIS(VAR1,VAR2,VAR3,VAR4) Where: VAR1 = IEN FOR VA PRODUCT file (#50.68) VAR2 = Date to be verified for Copay Tier VAR3 = IEN for DRUG file (#50) VAR4 = 1 for display or null for billing The data returned by this API varies based on the data passed: - VAR1 and/or VAR3 or both can be passed but VAR3 takes precedence. - VAR4 equal to 1 indicates that the API will return the stored value for copay tier information to be displayed for options such as Drug Enter/Edit, Lookup into Dispensed Drug file, etc. - A null value for VAR4 means the calling application will use the returned information for billing purposes. The API will return the copay exempt value of 0 (zero) for products with DEA Special Handling field that contains S for Supply Items, I for Investigational Drugs or N for Nutritional Supplement. The DEA Special Handling supercedes the copay tier field and zero is returned regardless of the copay tier defined on the product. The Pharmacy Product System - National (PPS-N) package is used to define copay tier information for VA Products. A check for the DEA Special Handling code for the drug/product is an additional check made in Pharmacy to determine if a drug is exempt from copay. The copay exempt DEA Special Handling codes are: I = Investigational Drug, N = Nutritional Supplement and S for Supply Item. Copay Tier determination criteria in order of precedence: 1. For NDF and PDM display screens (i.e. PSNACT, PSNLOOK, PSSDEE, PSS LOOK), this API will return null if the copay tier is not defined or will return the defined copay tier for the given date. If the drug is not matched to NDF, null is returned. If the tier is null, the selection of drug or product screens will not display the Tier field; however, the body of the display will show the Tier and effective date as null. 2. For billing purposes, this API will return different values based on the DEA Special Handling Code and copay tier defined as well as whether the drug is matched to NDF. a. If the DEA Special Handling Code is exempt from copay and regardless of the copay tier value, this API will return zero. For example, Outpatient Pharmacy (OP) calls this API to determine if a prescription is billable. In this case, the prescription is not billable and would not be sent to IB for a copay charge. The DEA Special Handling Code overrides the nationally defined copay tier. b. The product is matched to NDF: - If the copay tier is 1, 2, or 3 and the DEA code is NOT exempt from copay, this API will return the defined copay tier. For example, OP would send the prescription to IB for a copay charge. - If the copay tier is 0 (zero), this API will return 0 (zero). For example, OP would not would not send the prescription for copay billing charges. - If no copay tier is defined and the product is NOT exempt from copay, this API will return null. For example, OP would send the prescription to IB to charge copay. c. The product is not matched to NDF: - If the DEA special handling code is NOT exempt from copay, this API will return null. For example, OP would send the prescription to IB to charge copay. COMPONENT: CMOP VARIABLES: S X=$$CMOP^PSNAPIS(CODE) Returns the 5 character NAME field (#.01) for the VA PRODUCT file (#50.68) where CODE = 5-character CMOP ID. Returns $$CMOP equals corresponding VA Product Name if the CODE is valid or null if the CODE is not valid. ******************** 2532 NAME: DBIA2532 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: SEP 4,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 15 ROOT: VA(15, DESCRIPTION: TYPE: File In routine RGMTDPCT, CIRN counts duplicate entries for the PATIENT file (#2) in the DUPLICATE RECORD file (#15) by STATUS or MERGE STATUS It then counts the match percentile for the following: For STATUS it matches on (P) potential duplicates, (N) verified, notduplicate, (V) verified duplicate, (X) verified in progress, and (R) required review. For MERGE STATUS the matches are counted on (0) not ready, (1) ready, (2) merged, and (3) in progress. In routine RGMTDPSC, CIRN searches file #15 for duplicate pairs and displays this information by the CIRN Master of Record (CMOR) activity score range. The ranges are in 100'2 with a separate range for pairswhere both members have no score and where both members have zero score or one member has a zero score and the other has no score. The reports will give sites an idea of the active patients (with a CMOR score, incl 0) that are deemed duplicates. File: DUPLICATE RECORD (#15) ^VA(15,D0,0) .01 RECORD1 0;1 Direct Global Read .02 RECORD2 0;2 Direct Global Read .03 STATUS 0;3 Direct Global Read .05 MERGE STATUS 0;5 Direct Global Read ROUTINE: ******************** 2533 NAME: DBIA2533 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX Request permission for use of this function from the Kernel development team. ORDER ENTRY/RESULTS REPORTING VA CERTIFIED COMPONENTS - DSSI LAB SERVICE OUTPATIENT PHARMACY VISTA INTEGRATION ADAPTOR MYHEALTHEVET USAGE: Controlled Subscri ENTERED: SEP 8,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DSS has permission to use the Kernel function DIV4^XUSER according to the following: XUSER New file 200 API for DSS. The call is S X=$$DIV4^XUSER(.ZZ[,duz]) Input: The first parameter is a local variable that is passed by reference. The second is an optional IEN to the New Person file. If not passed it defaults to the current DUZ. Output: Returns a 1 if the user has a Division entry in the New Person file, else returns 0. If it returns a 1 then the first parameter is an array of IEN's for file 4 that have been assigned to the user. ROUTINE: XUSER COMPONENT: DIV4 VARIABLES: Receives two parameters, the first is an Array name passed by reference and the second is an optional DUZ. DIV4^XUSER returns 1 to indicate that the array of pointers to the Institution file has been defined and 0 to indicate that the array of pointers to the Institution file has NOT been defined. The array will be defined and left in the applications partition if the user indicated by the value of the DUZ received has divisions defined in the respective New Person file entry. The format is ARRAY([^DIC(4 IEN]). DUZ is an optional parameter. If DUZ is not passed as a parameter, the function will default to the value of DUZ in the application's partition. An example of the function's use is: S X=$$DIV4^XUSER(.ZZ,duz) ******************** 2534 NAME: DBIA2534 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: SEP 8,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement provides CPRS two entry points to call that will return flags that indicate whether or not to ask various Copay-related questions concerning the Outpatient order being entered through CPRS. Prior to the effective date of the Veterans Millennium Health Care and Benefits Act, the only question that should be asked in CPRS is the Service Connected question. After the effective date of the Bill, seven additional questions can potentially be asked during the medication order process in CPRS. ROUTINE: PSOCP COMPONENT: $$SC(X,Y) VARIABLES: X Type: Input The internal entry number of the Patient. (required) Y Type: Input The internal entry number of the Dispense Drug. (optional) $$SC Type: Output If returned as 1, then CPRS does not have to ask the Service Connected question. If returned as 0, then the question must be asked. This entry point will be used by CPRS to determine whether or not to ask the Service Connected question for an Outpatient order. If this entry point is called after the effective date of the Veterans Millennium Health Care and benefits Act, a "1" will always be returned, because at this point the SCNEW^PSOCP call should be used. COMPONENT: SCNEW(PSOTG,PSOPT,PSODR,PSORN) VARIABLES: PSOTG Type: Input This is the target array, passed by reference. (required) PSOPT Type: Input This is the internal entry number of the Patient. (required) PSODR Type: Input This is the internal entry number of the Dispense Drug. (optional) PSORN Type: Input If the order is a Renewal, this is the internal entry number of the prescription that is being renewed from the PRESCRIPTION (#52) file. If defined, and there are questions returned in the array, and the question was asked on the original order, the response to that question will be returned as a default. (optional) PSOTG() Type: Output This is the array returned in the call, subscripted with whatever variable name is passed into the call. Up to six entries can be returned. If no entries are returned, then no questions need to be asked in CPRS for the order. The values that can be returned are: PSOTG("SC") for Service Connected. PSOTG("MST") for Military Sexual Trauma. PSOTG("AO") for Agent Orange. PSOTG("IR") for Ionizing Radiation. PSOTG("EC") for Environmental Contaminant. PSOTG("HNC") for Head or Neck Cancer. PSOTG("CV") for Combat. PSOTG("SHAD") for PROJ 112/SHAD If any of these are returned, then the question needs to be asked in CPRS. If the value is equal to null, then there is no default response. If the value is equal to '0', then the default response should be 'NO'. If the value is equal to '1', then the default response should be 'YES'. This entry point will return an array to CPRS that contains questions that need to be asked during the Outpatient medication order entry process. If this call is made prior to the effective date of the Veterans Millennium Health Care and Benefits Act, nothing will be returned in the array. ******************** 2535 NAME: DBIA2535 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 8,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine GAF API'S The purpose of this patch is the creation of two API's for use with Mental Health system's Global Assessment of Function (GAF) Scores. The API's will be used to (1) return the most recent GAF score and diagnosis date the score was assessed and (2) store a new GAF score and date in the Diagnostics Results file (627.8). These two API's have been added to routine YSGAF. 10/30/13: The recently released Diagnostic and Statistical Manual of Mental Disorders, Fifth Edition, abbreviated as DSM-5, eliminates the use of the Global Assessment of Functioning (GAF) score. Starting with patch YS*5.01*108, new GAF scores for patients will no longer be saved in the Mental Health package. Historical data will continue to be available. The UPD call will set the YSERR variable equal to 1 and write an informational message. ^YSD(627.8,D0,60) 66 Patient Type 60;4 Both R/W w/Fileman Patient Type indicates that the patient is either an 'I'n-Patient or 'O'ut-Patient. ROUTINE: YSGAF COMPONENT: RET(YSX) VARIABLES: YSX Type: Input Contains the internal entry number. YSZ Type: Output Contains the result. Entry point RET^YSGAF(YSX) returns the most recent GAF score and diagnosis date. The internal entry number is passed into the call as variable YSX. The latest occurrence of the GAF score and GAF date are then passed back in the form of a concatenated string. If there is no GAF score entry then the API will pass back "-1" to indicate this situation. COMPONENT: UPD(YSPN,YSGN,YSGD,YSGC,YSPT) VARIABLES: YSPN Type: Input Patient name - Pointer to the patient name file (#2). YSGN Type: Input GAF score (Axis 5). YSGD Type: Input Date/Time of diagnosis. YSGC Type: Input Diagnosis by - Pointer to the new person file (#200). YSPT Type: Input Patient type - 'I'npatient or 'O'utpatient YSERR Type: Output The output variable will always be equal to one (i.e., YSERR=1) to indicate a new record was not created. An informational message will also be displayed to the user. Entry point UPD^YSGAF(YSPN,YSGN,YSGD,YSGC,YSPT) is designed to store patient GAF score information in the DIAGNOSTIC RESULTS - MENTAL HEALTH file (627.8). The information passed into the call includes patient name, GAF score (Axis 5), date/time of diagnosis, name of person giving diagnosis and patient type. ******************** 2536 NAME: Prosthetics IA With the PAID Employee File (#450) CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Private ENTERED: SEP 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 450 ROOT: PRSPC DESCRIPTION: TYPE: File Prosthetics is requesting read access to the following fields in the PAID Employee File (#450): Field (#8) SSN, (#19) Pay Basis, (#28) Salary ^PRSPC(450 8 SSN 0;9 Read w/Fileman 19 PAY BASIS 0;20 Read w/Fileman 28 SALARY 0;29 Read w/Fileman ROUTINE: ******************** 2537 NAME: DBIA2537 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH USAGE: Private ENTERED: SEP 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The IVM package requests use of the function $$ADDSTF^IBCNBES to add a new entry to the INSURANCE BUFFER file (#355.33). This data was received at the site from HEC (IVM Center). ROUTINE: IBCNBES COMPONENT: $$ADDSTF VARIABLES: 3 Type: Input The 3 indicates that the source of information is IVM. DFN Type: Input Patient's IEN in the PATIENT file. IVMIBDAT Type: Input Data, to be filed in the IB buffer, in an array subscripted by field number of the data field in the INSURANCE BUFFER file (#355.33) The IVM package uses $$ADDSTF^IBCNBES to add a new entry to the INSURANCE BUFFER file (#355.33). ******************** 2538 NAME: DBIA2538 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: SEP 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Registration package requests use of REG^IBCNBME to add/edit a INSURANCE BUFFER file (#355.33) entry for registration and use of PREG^IBCNBME to add/edit a INSURANCE BUFFER file (#355.33) entry for pre-registration. ROUTINE: IBCNBME COMPONENT: PREG VARIABLES: DFN Type: Input Patient's IEN in the PATIENT file. The Registration package uses PREG^IBCNBME to add/edit a INSURANCE BUFFER file (#355.33) entry for pre-registration. COMPONENT: REG VARIABLES: DFN Type: Input Patient's IEN in the PATIENT file. The Registration package uses REG^IBCNBME to add/edit a INSURANCE BUFFER file (#355.33) entry for registration. ******************** 2539 NAME: DELETE OPTIONS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: SEP 21,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 19 ROOT: DIC(19, DESCRIPTION: TYPE: File This integration agreement is only for Registration. Permission to loop through the "B" xref on the option file to delete all 'DG172' namespaced options created by the DG*5.3*172 patch. ^DIC(19,'B', .01 NAME 0;1 Direct Global R/W & w/ ROUTINE: ******************** 2540 NAME: BROWSER SWITCHING CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: HEALTH LEVEL SEVEN USAGE: Private ENTERED: SEP 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this DBIA is to provide a temporary method for switching between 'documents' without the user having to mentally resolve pointers between records in two different files. The needed functionality is currently planned by the VA Fileman developers to released in a patch. When that patch is released, the HL7 developers will modify the Transmission Log code to use the released functionality. See IA# 3594. ROUTINE: DDBR2 COMPONENT: SAVEDDB VARIABLES: Used to save variables before 'switching' between documents. COMPONENT: USAVEDDB VARIABLES: Used to 'unsave' variables befor switching between documents. COMPONENT: WP VARIABLES: Used to display a specific Browser screen without user interaction. (This API is used in conjunction with a call to PSR^DDBRO covered by IA# 3594.) ******************** 2541 NAME: DBIA2541 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents the supported calls to XUPARAM to get some KERNEL SYSTEM parameters fields. ROUTINE: XUPARAM COMPONENT: $$KSP VARIABLES: $$KSP Type: Output Some value from the Kernel system parameter file. parameter Type: Input This is a string to request a value from the Kernel System Parameter file. Currently supported values: "SPOOL LINE" returns the max number of lines in one spool document. "SPOOL DOC" returns the max number of spool documents the user may have. "WHERE" returns the local domain name. "INST" returns the IEN of the default institution entry. This entry point will return several items of site parameter data to the calling routine. Currently supported values: SPOOL LINE returns the max number of lines in one spool document. SPOOL DOC returns the max number of spool documents the user may have. WHERE returns the local domain name. INST returns the IEN of the default institution entry. ******************** 2542 NAME: DBIA2542 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 21,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are calls to set or get simple parameters from a file that the site can edit. The file is KERNEL PARAMETERS (#8989.2) ROUTINE: XUPARAM COMPONENT: $$GET VARIABLES: $$GET Type: Output Returns user defined data. parameter Type: Input This is a user defined namespaced name. style Type: Input This optional input controls what is returned if there isn't a replacement value or a default value. Valid values are "N" to return the call name. "V" to return "" missing returns 0. The call is $$GET^XUPARAM([,style]) where 'parameter name' is a namespaced name for the parameter to lookup and return the REPLACEMENT value or DEFAULT. The style parameter controls the return value if both of these are empty. Where 'style' controls how missing parameter entries are retuened, Valid value are: "N" to return call name. "V" to return "". missing returns 0. Kernel uses this to allow sites to select local edit templates. i.e. S DR="["_$$GET^XUPARAM("XUEDIT CHARACTERISTICS","N")_"]" COMPONENT: SET VARIABLES: parameter Type: Input This is a user defined namespaced name. value Type: Input This is the replacement value. This entry point allows the setting of the REPLACEMENT value in the file for a given entry. COMPONENT: LKUP VARIABLES: $$LKUP Type: Output Returns -1 if the lookup was unsuccessful. Returns a positive value for success. parameter Type: Input This is a user defined namespaced name. This entry point allows the creation of a entry. S X=$$LKUP^XUPARAM("XUEDIT PARAM","A") ******************** 2543 NAME: DBIA2543 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: OCT 7,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File ^DIC(1, .01 FILE 0;1 Read w/Fileman ROUTINE: ******************** 2544 NAME: DBIA2544 CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: OCT 8,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 301.5 ROOT: IVM(301.5, DESCRIPTION: TYPE: File When the AMIE package deletes entries from the PATIENT file (#2) it also needs to delete entries from the IVM PATIENT file (#301.5). ^IVM(305.1,"B" is used to determined which entries are to be deleted in the IVM PATIENT file. A cleanup is done to delete current entries in the IVM PATIENT file which point to non-existing or non-veterans in the PATIENT file. These entries are deleted using a DIK call. ^IVM(301.5,D0,0 is used to determine if IVM PATIENT file entries should be deleted. ^IVM(301.5,D0 When specified conditions are met, the entry will be deleted using a DIK call. ^IVM(301.5,'B', This reference is used to find an entry in the IVM PATIENT file. ^IVM(301.5,D0,0 .01 PATIENT 0;1 Direct Global Read & w This field is used to find the entry in the PATIENT file that needs to be checked to determine if the entry in 301.5 needs to be deleted. ROUTINE: ******************** 2545 NAME: ALLERGY DATA FOR NDF CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: APR 26,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8, DESCRIPTION: TYPE: File The data structure of the National Drug File changes with version 4. Allergy Tracking uses a variable pointer to NDF. These data elements must be converted when NDF version 4 is installed. Pharmacy also needs to be able to directly access the DRUG INGREDIENTS multiple in order to update any non-primary ingredients to their associated primary ingredient. Direct global access to ^GMR(120.8,D0,2 is necessary in order to perform this update. ^GMR(120.8,IEN,0) 1 GMR ALLERGY 0;3 Direct Global Write & 120.8 DRUG INGREDIENTS Direct Global R/W & w/ 2 DRUG INGREDIENTS ^GMR(120.8,DA(1),2,DA,0) .01 DRUG INGREDIENTS 0;1 Direct Global R/W & w/ ROUTINE: ******************** 2546 NAME: ACRP INTERFACE TOOLKIT (AIT) CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The ACRP Interface Toolkit (AIT) is a set of programmer tools that provides access to outpatient encounter data. The toolkit contains Application Programmer Interfaces (APIs) and Remote Procedure Calls (RPCs) that provide access to procedure, diagnosis, provider, and general data related to an encounter. This AIT provides Class I packages, Class III software, and other local code with one highly structured interface to the encounter data. Note: For detail information on each specific API call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm ROUTINE: SDOE COMPONENT: GETDX(encounter,dx_list[,errors]) VARIABLES: encounter Type: Input Encounter IEN dx_list Type: Output List of V POV Entries errors Type: Output Error Array [optional] Returns diagnoses for an encounter. COMPONENT: GETPRV(encounter,provider_list[,errors]) VARIABLES: encounter Type: Input Encounter IEN provider_l Type: Output List of V PROVIDER Entries errors Type: Output Error Array [optional] Returns providers for an encounter. COMPONENT: GETCPT(encounter,cpt_list[,errors]) VARIABLES: encounte Type: Input Encounter IEN cpt_list Type: Output List of V CPT Entries errors Type: Output Error Array [optional] Returns procedures for an encounter. COMPONENT: $$PRV(encounter[,errors]) VARIABLES: $$PRV Type: Output 1 - Yes, at least one provider is associated with encounter 0 - No, no providers are associated with encounter encounter Type: Input Encounter IEN errors Type: Output Error Array [optional] Is at least one provider assigned to an encounter? COMPONENT: $$CPT(encounter[,errors]) VARIABLES: $$CPT Type: Output 1 - Yes, at least one procedure is associated with encounter 0 - No, no procedures are associated with encounter encounter Type: Input Encounter IEN errors Type: Output Error Array [optional] Is at least one procedure assigned to an encounter? COMPONENT: $$DX(encounter[,errors]) VARIABLES: $$DX Type: Output 1 - Yes, at least one diagnosis is associated with encounter 0 - No, no diagnoses are associated with encounter encounter Type: Input Encounter IEN errors Type: Output Error Array [optional] Is at least one diagnosis assigned to an encounter? COMPONENT: $$FINDPRV(encounter,provider[,errors]) VARIABLES: $$FINDPRV Type: Output 1 - Yes, specific provider is associated with encounter 0 - No, provider is not associated with encounter encounter Type: Input Encounter IEN provider Type: Output Practitioner ID errors Type: Output Error Array [optional] Is a specific provider assigned to an encounter? COMPONENT: $$FINDDX(encounter,diagnosis[,errors]) VARIABLES: $$FINDDX Type: Output 1 - Yes, specific diagnosis is associated with encounter 0 - No, diagnoisis is not associated with encounter encounter Type: Input Encounter IEN diagnosis Type: Output Diagnosis IEN errors Type: Output Error Array [optional] Is a specific diagnosis assigned to an encounter? COMPONENT: $$FINDCPT(encounter,cpt[,errors]) VARIABLES: $$FINDCPT Type: Output 1 - Yes, specific procedure is associated with encounter 0 - No, procedure is not associated with encounter encounter Type: Input Encounter IEN cpt Type: Output CPT IEN errors Type: Output Error Array [optional] Is a specific procedure assigned to an encounter? COMPONENT: $$EXAE(dfn,begin_date,end_date[,flags][,errors]) VARIABLES: $$EXAE Type: Output Outpatient Encounter IEN for first standalone encounter found in date range if no encounter exists dfn Type: Input Patient ID begin_date Type: Input Begin Date/Time end_date Type: Input End Date/Time flags Type: Input Search Flags errors Type: Output Error Array [optional] Returns the first standalone add/edit encounter for a patient in a date range. COMPONENT: $$GETPDX(encounter[,errors]) VARIABLES: $$GETPDX Type: Output ien to ^ICD9 for primary dx 0 no primary dx found for encounter encounter Type: Input Encounter IEN errors Type: Output Error Array [optional] Returns the primary diagnosis for an encounter. COMPONENT: $$EXOE(dfn,begin_date,end_date[,flags][,errors]) VARIABLES: $$EXOE Type: Output Outpatient Encounter ID for first encounter found in date range if no encounter exists dfn Type: Input Patient ID begin_date Type: Input Begin Date/Time end_date Type: Input End Date/Time flags Type: Input Search Flags errors Type: Output Error Array [optional] Returns the first encounter for a patient in a date range. COMPONENT: $$GETLAST(dfn,begin_date[,flags][,errors]) VARIABLES: $$GETLAST Type: Output Outpatient Encounter ID for last standalone encounter found after date if no encounter exists dfn Type: Input Patient ID begin_date Type: Input Begin Date/Time flags Type: Input Search Flags errors Type: Output Error Array [optional] Returns the last standalone add/edit encounter for a patient from a specified begin date. COMPONENT: GETGEN(encounter,encounter_data[,errors]) VARIABLES: encounter Type: Input Encounter IEN encounter_ Type: Output Encounter Data errors Type: Output Error Array [optional] Returns the zeroth and other nodes of an outpatient encounter entry. COMPONENT: PARSE(.encounter_data,format,parsed_data[,errors]) VARIABLES: encounter_ Type: Input Encounter Data format Type: Input Encounter Parse Format parsed_dat Type: Output Encounter Parsed Data errors Type: Output Error Array [optional] Parses the data returned from the GETGEN supported call. COMPONENT: $$GETOE VARIABLES: Returns the zeroth node of an Outpatient Encounter record. ******************** 2547 NAME: DBIA2547 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: REGISTRATION PIMS needs to be able to determine if the Clinical Reminders MST synchronization has taken place. This API provides a method to get the data and time and number of updates made both for the initial synchronization and the most recent daily synchronization. USAGE: Private ENTERED: SEP 19,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PXRMMST COMPONENT: GSYINFO VARIABLES: TYPE Type: Input This extrinsic function returns Clinical Reminders MST synchronization data. It takes one argument called TYPE. If TYPE is passed as "I" then data for the initial synchronization is returned. For any other value of TYPE, including null, data for the most recent daily synchronization is returned. The format of the returned data is date/time^number of updates. Here is an example of how to use this API: S X=$$GSYINFO^PXRMMST("I") for initial synchronization data S X=$$GSYINFO^PXRMMST for most recent daily synchronization data ******************** 2548 NAME: ACRP INTERFACE TOOLKIT (AIT) CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The ACRP Interface Toolkit (AIT) is a set of programmer tools that provides access to outpatient encounter data. The toolkit contains Application Programmer Interfaces (APIs) and Remote Procedure Calls (RPCs) that provide access to procedure, diagnosis, provider, and general data related to an encounter. This AIT provides Class I packages, Class III software, and other local code with one highly structured interface to the encounter data. Note: For detail information on each specific API call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm ROUTINE: SDQ COMPONENT: OPEN(.query[,errors]) VARIABLES: query Type: Output Encounter Query Handle errors Type: Output Error Array [optional] Open a Query Object instance. COMPONENT: CLOSE(.query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Close a Query Object instance. COMPONENT: PAT(query,.dfn,action[,errors]) VARIABLES: query Type: Input Encounter Query Handle dfn Type: Input Patient ID action Type: Input Action errors Type: Output Error Array [optional] Set or retrieve Patient property of a Query Object instance. COMPONENT: DATE(query,.begin_date,.end_date,action[,errors]) VARIABLES: query Type: Input Encounter Query Handle begin_date Type: Input Begin Date/Time end-date Type: Input End Date/Time action Type: Input Action errors Type: Output Error Array [optional] Set or retrieve Date Range property of a Query Object instance. COMPONENT: FILTER(query,.filter,action[.errors]) VARIABLES: query Type: Input Encounter Query Handle filter Type: Both Encounter Query Filter action Type: Input Action errors Type: Output Error Array [optional] Y Type: Output current encounter entry number Y0 Type: Output zeroth node of current encounter entry (only supported fields) Set or retrieve Filter property of a Query Object instance. COMPONENT: VISIT(query,.visit,action[,errors]) VARIABLES: query Type: Input Encounter Query Handle visit Type: Input Visit IEN action Type: Input Action errors Type: Output Error Array [optional] Set or retrieve Visit property of a Query Object instance. COMPONENT: INDEX(query,.index,action[,errors]) VARIABLES: query Type: Input Encounter Query Handle index Type: Input Encounter Query Index action Type: Input Action errors Type: Output Error Array [optional] Set or retrieve Index property of a Query Object instance. COMPONENT: $$EOF(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] $$EOF Type: Output 1 - Yes, query cursor is at the last record or no records exist for query 0 - No, query cursor is not at last record Is cursor positioned on the last encounter record in the Query Object result set? COMPONENT: $$BOF(query[,errors]) VARIABLES: $$BOF Type: Output 1 - Yes, query cursor is at the first record or no records exist for query 0 - No, query cursor is not at first record query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Is cursor positioned on the first encounter record in the Query Object result set? COMPONENT: ACTIVE(query,.status,action[,errors] VARIABLES: query Type: Input Encounter Query Handle status Type: Input Encounter Query Active Status action Type: Input Action errors Type: Output Error Array [otional] Set or retrieve Active property of a Query Object instance. COMPONENT: $$COUNT(query[,errors]) VARIABLES: $$COUNT Type: Output count of records in query's result set 0 no records in the query's result set invalid query or query not active query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Returns the number of encounter records in a Query Object result set. COMPONENT: FIRST(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Positions the cursor at the first encounter record in the Query Object result set. COMPONENT: LAST(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Positions the cursor at the last encounter record in the Query Object result set. COMPONENT: NEXT(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Positions the cursor at the next encounter record in the Query Object result set. COMPONENT: PRIOR(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Positions the cursor at the previous encounter record in the Query Object result set. COMPONENT: REFRESH(query[,errors]) VARIABLES: query Type: Input Encounter Query Handle errors Type: Output Error Array [optional] Refresh the Query Object result set. COMPONENT: $$GETENTRY(query[,errors]) VARIABLES: $$GETENTRY Type: Output ID for entry if no entries in result set query Type: Input Encounter Query Handle errors Type: Output Error Array [optinal] Returns the internal entry number of the Outpatient Encounter (#409.68) file for the encounter record at the current cursor position of the Query Object result set. COMPONENT: SCAN(query[,direction][,errors]) VARIABLES: query Type: Input Encounter Query Handle scan_direc Type: Input Direction [optional] errors Type: Output Error Array [optional] Scans encounter records that meet the criteria defined by the properties of the Query Object instance. COMPONENT: SCANCB(query,.callback,action[,errors]) VARIABLES: query Type: Input Encounter Query Handle callback Type: Input Scan Callback Logic action Type: Input Action errors Type: Output Error Array [optional] Set or retrieve Callback property of a Query Object instance. ******************** 2552 NAME: ACRP INTERFACE TOOLKIT (AIT) CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The ACRP Interface Toolkit (AIT) is a set of programmer tools that provides access to outpatient encounter data. The toolkit contains Application Programmer Interfaces (APIs) and Remote Procedure Calls (RPCs) that provide access to procedure, diagnosis, provider, and general data related to an encounter. This AIT provides Class I packages, Class III software, and other local code with one highly structured interface to the encounter data. Note: For detail information on each specific API call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm ROUTINE: SDQUT COMPONENT: $$ERRCHK([errors]) VARIABLES: $$ERRCHK Type: Output 1 - Yes, at least one error is in the error array 0 - No, no errors are in the error array errors Type: Output Error Array [optional] Does current error array contain any errors? ******************** 2553 NAME: SDOE ASSIGNED A DIAGNOSIS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether at least one diagnosis has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether at least one diagnoses has been associated with an encounter. ROUTINE: DX SDOERPC ******************** 2554 NAME: SDOE ASSIGNED A PROCEDURE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether at least one procedure has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether at least one procedure has been associated with an encounter. ROUTINE: CPT SDOERPC ******************** 2555 NAME: SDOE ASSIGNED A PROVIDER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether at least one provider has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether at least one provider has been associated with an encounter. ROUTINE: PRV SDOERPC ******************** 2556 NAME: SDOE FIND DIAGNOSIS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether a specific diagnosis has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether a specific diagnosis is associated with an encounter. ROUTINE: FINDDX SDOERPC ******************** 2557 NAME: SDOE FIND FIRST ENCOUNTER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the internal entry number of an Outpatient Encounter file (#409.68) entry for the first encounter for a patient in a specified date range. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the internal entry number of an OUTPATIENT ENCOUNTER file (#409.68) entry for the first encounter for a patient in a specified date range. ROUTINE: EXOE SDOERPC ******************** 2558 NAME: SDOE FIND FIRST STANDALONE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the internal entry number of an Outpatient Encounter file (#409.68) entry for the first standalone add/edit encounter for a patient in a specified date range. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the internal entry number of an OUTPATIENT ENCOUNTER file (#409.68) entry for the first the first standalone add/edit for a patient in a specified date range. Use same date for begin and end dates for specific (single) date check. Standalone encounter is an encounter with no parent and the originating process is 'Stop Code Addition'. ROUTINE: EXAE SDOERPC ******************** 2559 NAME: SDOE FIND LAST STANDALONE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the internal entry number of an Outpatient Encounter file (#409.68) entry for the last standalone add/edit encounter for a patient in a specified date range. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the internal entry number of an OUTPATIENT ENCOUNTER file (#409.68) entry for the last standalone add/edit for a patient in a specified date range. Standalone encounter is an encounter with no parent and the originating process is 'Stop Code Addition'. ROUTINE: GETLAST SDOERPC ******************** 2560 NAME: SDOE FIND PROCEDURE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether a specific procedure has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether a specific procedure is associated with an encounter. ROUTINE: FINDCPT SDOERPC ******************** 2561 NAME: SDOE FIND PROVIDER CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 22,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a boolean indicator on whether a specific provider has been associated with an encounter. --------------------------------------------------------------------- This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a boolean indicator on whether a specific provider is associated with an encounter. ROUTINE: FINDPRV SDOERPC ******************** 2563 NAME: Linked option to CIRN CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Registration patch DG*5.3*172 is transporting in a KIDS build the CIRN option, CIRN Pre-Implementation Menu (RGPR PRE-IMP MENU), as a link for menu items. ROUTINE: ******************** 2564 NAME: SDOE GET DIAGNOSES CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns an array of diagnoses for an encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns an array of diagnoses for an encounter. Note: For encounters before 10/1/96, only scheduling data in the OUTPATIENT DIAGNOSIS (#409.43) file may exist. It will only exist if the site required diagnoses as part of the check out process. This RPC will attempt to find this 'old' data, reformat the data to meet the V POV structure and return the list of diagnoses as described above. (Only the diagnosis code internal entry number is available for 'old' encounters.) ROUTINE: GETDX SDOERPC ******************** 2565 NAME: SDOE GET GENERAL DATA CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the zeroth and other nodes of an outpatient encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the Oth and other nodes of an Outpatient Encounter entry. ROUTINE: GETGEN SDOERPC ******************** 2566 NAME: SDOE GET PRIMARY DIAGNOSIS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the internal entry number of the primary diagnosis code (^ICD9) for an encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. These files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the internal entry number of the primary diagnosis code (ICD) for an encounter. Note: For encounters before 10/1/96, this RPC will always return 0. This primary diagnosis was not retrieved nor stored by the system for these 'old' encounters. ROUTINE: GETPDX SDOERPC ******************** 2567 NAME: SDOE GET PROCEDURES CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a subscripted array of procedures for an encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a subscripted array of CPTs for an encounter. Note: For encounters before 10/1/96, only scheduling data in the SCHEDULING VISITS (#409.5) file may exist. It will only exist if the site required procedures as part of the check out process. This RPC will attempt to find this 'old' data, reformat the data to meet the V CPT structure and return the list of procedures as described above. (Only the CPT code internal entry number and count are available for 'old' encounters.) ROUTINE: GETCPT SDOERPC ******************** 2568 NAME: SDOE GET PROVIDERS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a subscripted array of providers for an encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a subscripted array of providers for an encounter. Note: For encounters before 10/1/96, only scheduling data in the OUTPATIENT PROVIDER (#409.44) file may exist. It will only exist if the site required provider as part of the check out process. This RPC will attempt to find this 'old' data, reformat the data to meet the V PROVIDER structure and return the list of providers as described above. (Only the provider internal entry number is available for 'old' encounters.) ROUTINE: GETPRV SDOERPC ******************** 2569 NAME: SDOE GET ZERO NODE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns the zeroth node of an outpatient encounter. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns the zeroth node of an Outpatient Encounter. ROUTINE: GETOE SDOERPC ******************** 2570 NAME: SDOE LIST ENCOUNTERS FOR DATES CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a list of outpatient encounters for a date range. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a list of Outpatient Encounters for a specified date range. ROUTINE: LIST SDOERPC ******************** 2571 NAME: SDOE LIST ENCOUNTERS FOR PAT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a list of outpatient encounters for a specified patient and specified date range. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a list of Outpatient Encounters for a specified patient and specified date range. ROUTINE: LISTPAT SDOERPC ******************** 2572 NAME: SDOE LIST ENCOUNTERS FOR VISIT CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) returns a list of outpatient encounters for a specified PCE visit. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) returns a list of Outpatient Encounters for a specified visit. ROUTINE: LISTVST SDOERPC ******************** 2573 NAME: SDOE PARSE GENERAL DATA CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call (RPC) will parse the data returned by SDOE GET GENERAL DATA remote procedure call into individual field nodes. ------------------------------------------------------------------ This RPC is part of the ACRP Interface Toolkit (AIT). The AIT is a set of programmer tools that provides access to outpatient encounter data. Note: For detail information on this RPC call, see the following AIT documentation files: sd_53_p131_tooldoc.doc or sd_53_p131_tooldoc.pdf. Theses files are distributed as part of patch SD*5.3*131. Also, the documentation is available on-line at the following URL: http://152.127.1.95/softserv/mip/wr/acrpapi.htm This Remote Procedure Call (RPC) will parse the data returned by the 'SDOE GET GENERAL DATA' RPC into individual field nodes. ROUTINE: PARSE SDOERPC ******************** 2574 NAME: ADDITIONAL APIS FOR NDF CUSTODIAL PACKAGE: NATIONAL DRUG FILE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA describes additional Application Programmer Interfaces (APIs) for the National Drug File. APIs described here are in addition to those described in DBIA # 2531. ROUTINE: PSNAPIS COMPONENT: TTOG VARIABLES: S X=$$TTOG^PSNAPIS(TRADE,.LIST) where TRADE is a free text trade name and LIST is an array defined by the calling application returns LIST(IEN)=IEN^GENERIC NAME where IEN is the internal entry number in File #50.6 and GENERIC NAME is the .01 field of that file for every entry which has the given trade name. Also returns X as the number of entries in LIST. COMPONENT: CLIST VARIABLES: S X=$$CLIST^PSNAPIS(DA,.LIST) where DA is an internal entry number in File #50.6 and LIST is an array defined by the calling application returns LIST(IEN)=IEN^CLASS where IEN is the internal entry number in File #50.605 and CLASS is the 5 character class code for every class associated with that entry in File #50.6. Also returns X as the number of entries in LIST. COMPONENT: TGTOG VARIABLES: S X=$$TGTOG^PSNAPIS(NAME) where NAME is a free text entry returns X=IEN from the VA GENERIC file (#50.6) if NAME is either a valid Name from the VA GENERIC file (#50.6) or if NAME is a valid Trade Name from the NDC/UPN file (#50.67). Returns X=0 otherwise. COMPONENT: TGTOG2 VARIABLES: S X=$$TGTOG2^PSNAPIS(NAME,.LIST) returns LIST(IEN)=IEN^GENERIC NAME where IEN is the internal entry number in File #50.6 and GENERIC NAME is the .01 field of that entry for all entries for which NAME is a partial or exact match to either the trade name or the generic name. Also returns X as the number of entries in LIST. COMPONENT: CIRN2 VARIABLES: S X=$$CIRN2^PSNAPIS(P1,P3,.LIST) where P1 and P3 are the first and third pieces of the ND node in File #50 and LIST is an array defined by the calling application returns LIST(J)=NDC where J is a simple index and NDC is a twelve character National Drug Code (NDC) for all NDCs associated with the product specified by P1 and P3. Also returns X as the number of entries in LIST. COMPONENT: CLASS2 VARIABLES: S X=$$CLASS2^PSNAPIS(IEN) where IEN is an internal entry number in File #50.605 returns X as the first two pieces of the zero node in that entry. COMPONENT: FORMI VARIABLES: S X=$$FORMI^PSNAPIS(P1,P3) where P1 and P3 are the first and third pieces of the "ND" node in File #50 for a selected entry returns X=1 if the item is on the National Formulary, X=0 otherwise. COMPONENT: FORMR VARIABLES: S X=$$FORMR^PSNAPIS(P1,P3) where P1 and P3 are the first and third pieces of the "ND" node in File #50 for a selected entry returns X=1 if there are restrictions placed on the item, X=0 otherwise. COMPONENT: CMOP VARIABLES: S X=$$CMOP^PSNAPIS(CODE) where code is a five character CMOP identifier (e. g. A0105) returns X equal the corresponding product name if CODE is a valid identifier, null otherwise. COMPONENT: FORMRX VARIABLES: S X=$$FORMRX^PSNAPIS(DA,K,.LIST) where DA and K are the first and third pieces of the ND node in File #50 for the chosen drug returns X=1 if there are formulary restrictions, 0 if there are not. Also, if there are restrictions, returns LIST as the word-processing field describing these restrictions. COMPONENT: $$DDIEX(VAR1,VAR2) VARIABLES: VAR1 Type: Input piece one of the "ND" node of ^PSDRUG file 50 NATIONAL DRUG FILE ENTRY field 20 VAR2 Type: Input piece three of the "ND" node of ^PSDRUG file 50 PSNDF VA PRODUCT NAME ENTRY field 22 $$DDIEX Type: Output 1 indicates that a drug has been exempted from drug-drug interaction order checking. 0 indicates that a drug is not exempted from drug-drug interaction order checking. ******************** 2575 NAME: NATURE OF ORDER FILE ACCESS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Controlled Subscri ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.02 ROOT: ORD(100.02 DESCRIPTION: TYPE: File Reference to Nature of Order (100.02) file. This DBIA allows a direct global read of the NAME (.01) and CODE (.02) fields of the NATURE OF ORDER (100.02) file. ^ORD(100.02,DA,0) .01 NAME 0;1 Direct Global Read & w .02 CODE 0;2 Direct Global Read & w ROUTINE: ******************** 2576 NAME: DBIA2576 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE HEALTH MANAGEMENT PLATFORM This functionality is being released in HMP*2.0*2 ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: SEP 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.03 ROOT: ORD(100.03 DESCRIPTION: TYPE: File Reference to Order Reason (100.03) file. This DBIA allows a direct global read of the NAME (.01) field of the ORDER REASON (100.03) file. Access is also allowed to the "C" cross reference on the file to look for coded entries. ^ORD(100.03,DA,0) .01 NAME 0;1 Direct Global Read & w .06 CODE 0;6 Direct Global Read & w ^ORD(100.03,'C',CODE .06 CODE 0;6 Direct Global Read & w ROUTINE: ******************** 2581 NAME: SERVER ACTION edit during install CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Controlled Subscri ENTERED: SEP 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 19 ROOT: DIC(19 DESCRIPTION: TYPE: File This integration agreement is for setting the SERVER ACTION field (#221) of the OPTION file (#19) while a patch to the server logic is being installed. The SERVER ACTION field will be reset in a post-init to its original value. ^DIC(19 221 SERVER ACTION 220;2 Direct Global Write & SERVER ACTION (#221) field. OPTION file (#19) ROUTINE: ******************** 2586 NAME: OE/RR references to GMR(123, CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT MENTAL HEALTH added 5/26/2011 RADIOLOGY/NUCLEAR MEDICINE Added 11/6/19 for access to UNIQUE CONSULT ID (field 80 or GMR(123,DA,'UCID') global reference, effective with RA*5*161. USAGE: Controlled Subscri ENTERED: SEP 25,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123 ROOT: GMR(123, DESCRIPTION: TYPE: File This DBIA serves as documentation of references made from the OE/RR package to the REQUEST/CONSULTATION file (#123). Please note that the OE/RR v3 orders conversion also deletes entries in GMR(123,. ^GMR(123,DA,0) .01 FILE ENTRY DATE 0;1 Direct Global Read & w .02 PATIENT NAME 0;2 Direct Global Read & w .03 OE/RR FILE NUMBER 0;3 Direct Global Read & w 1 TO SERVICE 0;5 Direct Global Read & w 4 PROCEDURE/REQUEST TY 0;8 Direct Global Read & w 5 URGENCY 0;9 Direct Global Read & w 6 PLACE OF CONSULTATIO 0;10 Direct Global Read & w 11 ATTENTION 0;7 Direct Global Read & w 10 SENDING PROVIDER 0;14 Direct Global Read & w 13 REQUEST TYPE 0;17 Direct Global Read & w 14 SERVICE RENDERED AS 0:18 Direct Global Read & w 16 TIU RESULT NARRATIVE 0;20 Direct Global Read & w ^GMR(123,DA,20) 20 REASON FOR REQUEST 20 Direct Global Read & w Obtains word processing text from REASON FOR REQUEST field. ^GMR(123,DA,30) 30 PROVISIONAL DIAGNOSI 30;1 Direct Global Read & w ^GMR(123,DA,50) 50 ASSOCIATED RESULTS 50 Direct Global Read & w Obtains ASSOCIATED RESULTS data and references B index of multiple ^GMR(123,DA,50,'B' ^GMR(123,DA,51,'B' ^GMR(123,DA,'UCID') 80 UNIQUE CONSULT ID UCID;1 Direct Global Read & w ROUTINE: ******************** 2588 NAME: OR use of RADPT('AO' x-ref CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT VIRTUAL PATIENT RECORD Added 9/27/18 for VPR*1*8, to use the AO index to determine the case number from an order (for use in the supported RAO7PC1 api's). USAGE: Controlled Subscri ENTERED: SEP 25,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: OE/RR v3 FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File This reference is used by the OE/RR v3 orders conversion and the Care Management application, to link a case number to an order. ^RADPT('AO' The OE/RR v3 Orders Conversion performs a $D check on RADPT('AO', to see if a pointer exists from file 70 to the RAD/NUC MED ORDERS file (#75.1). Care Management also uses a $D check of this index to determine if the Radiology/Nuclear Medicine order whose results have just been viewed and acknowledged has an outstanding notification that may now be deleted; this index links the case number used by the alert to the order number available within Care Management. ROUTINE: ******************** 2589 NAME: NEW PERSON editing CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 31,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File With patch RG*1*21, Master Patient Index/Patient Demographics exports a new option, Add/Edit Point of Contact [RG UPDATE POINT OF CONTACT]. This option allows a facility to update the administrative, IRM and HL7 points of contact name and phone number. This information is sent to the MPI/PD Data Management staff so that they can update the website. The point of contact names reside in the CIRN SITE PARAMETER (#991.8) file and point to the NEW PERSON (#200) file. The option edits the OFFICE PHONE (#.132) field in the NEW PERSON (#200) file, via a FileMan ^DIE call for the identified point of contact. ^VA(200, .135 COMMERCIAL PHONE .13;5 Write w/Fileman ROUTINE: ******************** 2590 NAME: SD OUTPATIENT GAF SCORE UTILS CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of these API's is to facilitate the entry of Global Assessment of Function (GAF) scores to the Mental Health package from outpatient encounters. VHA Directive, 97-059, dated November 25, 1997, "Instituting Global Assessment of Function (GAF) Scores in Axis V Mental Health Patients", provides guidelines for the collection of these GAF scores. These API's will be used to (1) return whether a new GAF score is required for an outpatient and (2) whether the outpatient encounter clinic is a Mental Health clinic for which GAF scores must be collected. These API's have been added to the routine: SDUTL2. ROUTINE: SDUTL2 COMPONENT: NEWGAF(DFN) VARIABLES: DFN Type: Input Contains the Internal entry number of the patient in the PATIENT File, #2. SDGAF Type: Output Contains the results Entry point NEWGAF^SDUTL2(DFN) returns whether a GAF score is required for a patient, and if one is required, returns the date of the last score, the score, and the IEN of the provider who made the determination. The internal entry number is passed into the call as variable DFN. The determination and latest occurrence of the GAF data are then passed back in the form of a concatenated string in the following format: -1 : New GAF required and no previous data 1 : New GAF required and previous data, the second piece will contain the previous GAF score, the third piece will contain the date of the score, and the fourth piece will contain the IEN of the provider w determined the GAF score. 0 : A new GAF is not required COMPONENT: MHCLIN(SDCL,SDSC) VARIABLES: SDCL Type: Input Contains the internal entry number of the clinic SDSC Type: Input Contains the internal entry number of the CLINIC STOP File, #40.7 SDMH Type: Output Contains the results Entry point MHCLIN^SDUTL2(SDCL,SDSC) returns whether the clinic for the encounter is a mental health clinic or not. The current criterion for this determination is a stop code that starts with a "5", excluding the following codes: 526, 527, 528, 530, 536, 537, 542, 546, 579. Either a pointer to the HOSPITAL LOCATION File, #44, or a pointer to the CLINIC STOP File, #40.7, must be passed into the call. If neither is passed in, the default result will be "0". If the clinic or the clinics stop match the criterion, the call will pass back a "1" to indicate a mental health clinic, otherwise a "0" will be passed back. ******************** 2592 NAME: TRAVERSE DD FOR FILE CONVERSION CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: SEP 30,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: File The post-install routine in the Registration patch DG*5.3*172 is looping through the "PT" node in both the MARITAL STATUS file (#11) and RELIGION file (#13) to convert the non-standard entries into standard entries. The non-standard entries are deleted after the conversion. However, the conversion cannot convert entries within a subfile, so the patch identifies the subfile within the "PT" node and traverses back through the "UP" nodes looking at the subfile zero nodes to report the subfile NAMES that could not be converted. This information is placed in a mail message which is reported back to the installer of patch DG*5.3*172. ^DD(11,0,'PT',DO,D1) ^DD(13,0,'PT',DO,D1) ^DD(D0,0,'UP') ROUTINE: ******************** 2596 NAME: Audit File Reference to Protocol File CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX USAGE: Controlled Subscri ENTERED: OCT 27,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 101 ROOT: ORD(101, DESCRIPTION: TYPE: File CIRN made a request to the FileMan Development Team to add to the Audit File a field that would keep track of what menu Protocol was used to change the data being audited. ^ORD(101, .01 NAME 0;1 Direct Global Read & w 1 ITEM TEXT 0;2 Read w/Fileman 771 PROCESSING ROUTINE 771;1 Direct Global Read & w ROUTINE: ******************** 2597 NAME: DBIA2597 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK DESCRIPTION: TYPE: File The CIRN Skin Tests (PCE) data extraction routine (^RGHOSKN - HL7 Message Generation for Skin Tests Results), makes several references to fields in the SKIN TEST V file (#9000010.12), for the purpose of creating the HL7 transmission records. ^AUPNVSK(D0,0) .01 SKIN TEST 0,1 Read w/Fileman .02 PATIENT NAME 0,2 Read w/Fileman .03 VISIT 0,3 Read w/Fileman .04 RESULTS 0,4 Read w/Fileman .05 READING 0,5 Read w/Fileman .06 DATE READ 0,6 Read w/Fileman ROUTINE: ******************** 2598 NAME: DBIA2598 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT DESCRIPTION: TYPE: File For all CIRN PCE related packages, including: SKIN TESTS, IMMUNIZATIONS, HEALTH FACTORS, TREATMENTS, and MEASUREMENTS, the historical load routine (RGHOVFB - Historical Load of V File Data), makes a reference to the VISIT file (#9000010), for the purpose of setting an entry in the CIRN processing queue. ^AUPNVSIT(D0,0) .01 VISIT/ADMIT DATE&TIM 0,1 Read w/Fileman ROUTINE: ******************** 2599 NAME: DBIA2599 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF DESCRIPTION: TYPE: File ^AUPNVHF(D0,0) .01 HEALTH FACTOR 0,1 Read w/Fileman .02 PATIENT NAME 0,2 Read w/Fileman .03 VISIT 0,3 Read w/Fileman .04 LEVEL/SEVERITY 0,4 Read w/Fileman ^AUPNVHF(D0,12) 1201 EVENT DATE AND TIME 12,1 Read w/Fileman 1202 ORDERING PROVIDER 12,2 Read w/Fileman ROUTINE: ******************** 2600 NAME: DBIA2600 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.11 ROOT: AUPNVIMM DESCRIPTION: TYPE: File The CIRN Immunizations (PCE) data extraction routine (^RGHOIMM - HL7 Message Generation for Immunization Results), makes several references to fields in the IMMUNIZATION V file (#9000010.11), for the purpose of creating the HL7 transmission records. ^AUPNVIMM(D0,0) .01 IMMUNIZATION 0,1 Read w/Fileman .02 PATIENT NAME 0,2 Read w/Fileman .03 VISIT 0,3 Read w/Fileman .04 SERIES 0,4 Read w/Fileman 1201 EVENT DATE AND TIME 12,1 Read w/Fileman 1202 ORDERING PROVIDER 12,2 Read w/Fileman ROUTINE: ******************** 2602 NAME: READING AUDIT FILE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: NATIONAL DRUG FILE CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX OUTPATIENT PHARMACY REGISTRATION SCHEDULING ADDED 9/27/07 LAB SERVICE Added Lab as new Subscriber 08/15/13. Lab patch LR*5.2*425 needs to loop through the entries in the Audit file for file 60 (LABORATORY TEST). ORDER ENTRY/RESULTS REPORTING Effective with OR*3*250 (part of CPRSv30), Order Entry/Results Reporting (OE/RR) is a subscribing package to ICR #2602 READING AUDIT FILE. The DEA has a regulatory requirement that sites audit the logical access control of electronic prescribing of controlled substances (ePCS). The logical access control data is stored in the OE/RR EPCS PARAMETERS file (#100.7) and uses FileMan's audit functionality to audit changes within that file. Unfortunately, there are some sites that prevent clinical applications coordinator staff from accessing FileMan to view and report on this audit data. Therefore, OE/RR has a requirement to create a report that will display the audit data to the user regardless of whether the user has FileMan access or not. PCE PATIENT CARE ENCOUNTER Effective with patch PX*1*215, Patient Care Encounter will check the 'C' cross-reference to determine if any information in their files have been updated since a given date. This will allow PCE to quickly determine if their cached data is out of date. The following files are audited and locked down by STS: #920 VACCINE INFORMATION STATEMENT #920.1 IMMUNIZATION INFO SOURCE #920.2 IMM ADMINISTRATION ROUTE #920.3 IMM ADMINISTRATION SITE (BODY) #920.4 IMM CONTRAINDICATION REASONS #920.5 IMM REFUSAL REASONS #9999999.04 IMM MANUFACTURER #9999999.14 IMMUNIZATION #9999999.28 SKIN TEST If more information is needed from the AUDIT file, PCE will use documented FileMan APIs to retrieve that information. Effective with patch PX*1*216, Patient Care Encounter (PCE) will look at the audit data for the V IMMUNIZATION file (#9000010.11) to reconstruct how a record existed at a given point in time. PCE will use the 'B' cross-reference to quickly find all audit entries for a given V IMMUNIZATION record, and will then access those audits, using the approved methods in this ICR, to determine what changed. IMAGING The VistA Imaging application, with the release of MAG*3.0*183, is looking to identify when the Social Security Number (SSN) is changed in a patient record in the PATIENT (#2) file. The old SSN value and the new SSN value is broadcast in HL7 messages to keep the subscribers of those HL7 messages current with patient demographic and patient identifier changes. The lookup works as follows: For a known patient (file of interest: PATIENT #2) we look through the "B" cross-reference of the AUDIT file looking for Social Security Number (SSN) changes. When we find a SSN change, we note the DATE/TIME RECORDED (field: .02; node: 0; piece: 2), the old SSN value from ^DIA(2,DFN,2) computed and the new SSN value from ^DIA(2,DFN,3) also computed. KERNEL Added 04/09/21, effective with XU*8.0*743 in support of the ongoing Enterprise User Identity Work of the Master Veteran Index (MVI) team. This IA (#2602) in combination with IA (#7244) will allow MVI to retrieve the Audit Information for display for a given patient's DUZ. USAGE: Controlled Subscri ENTERED: OCT 2,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1.1 ROOT: DIA DESCRIPTION: TYPE: File The NDF Management System uses entries in the AUDIT file (#1.1) to track changes made to files involved with NDF and to send these changes to VAMCs using KIDS. To this end, the NDF Management System requests permission to do direct global reads of entries in File #1.1 ^DIA(File number,entry number .02 DATE/TIME RECORDED 0;2 Direct Global Read & w .03 FIELD NUMBER 0;3 Direct Global Read & w .01 INTERNAL ENTRY NUMBE 0;1 Direct Global Read & w 2 OLD VALUE ; Direct Global Read & w 2.1 OLD INTERNAL VALUE 2.1;1 Direct Global Read & w 3 NEW VALUE ; Direct Global Read & w 3.1 NEW INTERNAL VALUE 3.1;1 Direct Global Read & w .001 NUMBER Read w/Fileman .04 USER 0;4 Direct Global Read & w .05 RECORD ADDED 0;5 Direct Global Read & w 1 ENTRY NAME ; Read w/Fileman 1.1 FIELD NAME ; Read w/Fileman 2.2 DATATYPE OF OLD VALU 2.1;2 Read w/Fileman 3.2 DATATYPE OF NEW VALU 3.1;2 Read w/Fileman 4.1 MENU OPTION USED 4.1;1 Direct Global Read & w 4.2 PROTOCOL or OPTION U 4.1;2 Direct Global Read & w ^'C' DIRECT READ ACCESS TO THE 'C' CROSS-REFERENCE ^'B' Direct read access to the 'B' cross-reference ROUTINE: ******************** 2604 NAME: DBIA2604 CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: OCT 9,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 301.6 ROOT: IVM(301.6 DESCRIPTION: TYPE: File When the AMIE package deletes entries from the PATIENT file (#2) it also needs to delete entries from the IVM PATIENT file (#301.5). A cleanup is done to delete current entries in the IVM PATIENT file which point to non-existing or non-veterans in the PATIENT file. Corresponding entries in the IVM TRANSMISSION LOG file (#301.6) are also deleted. These entries are deleted using a DIK call. ^IVM(301.6,"B" is used to determine which IVM TRANSMISSION LOG file entries, if any, should be deleted. ^IVM(301.6,'B' ^IVM(301.6,"B" is used to determine which IVM TRANSMISSION LOG file entries, if any, should be deleted. ^IVM(301.6,D0 When applying conditions are met the entry will be deleted using a DIK call. ROUTINE: ******************** 2605 NAME: DBIA2605 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Controlled Subscri ENTERED: OCT 13,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.4 ROOT: DIC(9.4, DESCRIPTION: TYPE: File ^DIC(9.4,"C", cross reference - The software facilitating this DBIA, orders through the "C" cross reference which is a cross reference of the PREFIX field (#1) of the PACKAGE file (#9.4). If the PREFIX is "YS", the code then checks the SHORT DESCRIPTION field (#2) of the PACKAGE file (#9.4). If this field does NOT equal "Version 5.01 of Mental Health", the code either (1) deletes the entry from the package file or (2) renames the PREFIX from YS to YS_integer (beginning with 1, incremented by 1, i.e. YS1, YS2, YS3, etc.) depending on the number of Mental Health entries that are not version 5.01. User response to the 'Delete old PACKAGE file entries?' question determines which action will be performed by the code. ROUTINE: ******************** 2606 NAME: DBIA2606 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 440 ROOT: PRC(440 DESCRIPTION: TYPE: File ^PRC(440,D0,0) .01 Name 0;1 Read w/Fileman ROUTINE: ******************** 2607 NAME: Browser API CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Browser displays ASCII text on a terminal which supports a scroll region. ROUTINE: DDBR COMPONENT: EN VARIABLES: None Type: This is an interactive procedure that asks the user for: File Word Processing Field Entry and then displays the text. COMPONENT: WP() VARIABLES: FILE Type: Input (Required) File or subfile number. IENS Type: Input (Required) Standard IENS indicating internal entry number string. FIELD Type: Input (Required) Word processing field name or number. FLAGS Type: Input N No copy of the document is made. The Browser will use the source document. Useful for long static documents. R Restrict switching. TITLE Type: Input (Optional) Text that is centered in header. Document title. LINE Type: Input (Optional) The line in the document that would be at the bottom margin of the opening screen. TABS Type: Input (Optional) Closed array root, passed by value, that is used to scroll horizontally. If not set, the Browser provides default tab stops. TOP Type: Input (Optional) A number representing the location of the title bar of the Browser screen. BOTTOM Type: Input (Optional) A number representing the location of the status bar of the Browser screen. This procedure displays word processing fields, as well as allowing navigation throughout the text, in a FileMan-compatible database using FileMan's Browser facility. Format WP^DDBR(FILE,IENS,FIELD,FLAGS,TITLE,LINE,TABS,TOP,BOTTOM) COMPONENT: BROWSE() VARIABLES: SOURCE_ARR Type: Input (Required) Source array in a closed root format, passed by value which is the location of a sequential local or global array containing text. FLAGS Type: Input (Optional) Flags to control processing are described below: N No copy of the document is made. The Browser will use the source document. Useful for long static documents. R Restrict switching. TITLE Type: Input (Optional) Text centered in screen title. LINE Type: Input (Optional) The line in the document that would be at the bottom margin of the opening screen. TABS Type: Input (Optional) Closed array root, passed by value; used to scroll horizontally. If not set, the Browser provides default tab stops. TOP Type: Input (Optional) A number representing the location of the title bar of the Browser screen. BOTTOM Type: Input (Optional) A number representing the location of the status bar of the Browser screen. This procedure enables the user to utilize FileMan's Browser to view and navigate through a document stored in a sequential local or global array. Format BROWSE^DDBR(SOURCE_ARRAY,FLAGS,TITLE,LINE,TABS,TOP,BOTTOM) COMPONENT: DOCLIST() VARIABLES: SOURCE_ARR Type: Input (Required) Source array in a closed root format, passed by value which is subscripted by document titles and set to the source array of the document in a closed root format. FLAGS Type: Input (Optional) Flag to control processing is described below: R Restrict Switching to other documents not in current list. TOP Type: Input (Optional) A number representing the location of the title bar of the Browser screen. BOTTOM Type: Input (Optional) A number representing the location of the status bar of the Browser screen. This procedure call allows passing more than one document to the Browser facility. Format DOCLIST^DDBR(SOURCE_ARRAY,FLAGS,TOP,BOTTOM) ******************** 2608 NAME: Browser API CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function call returns a 1 or 0 (true or false) to determine if the CRT being used can support a scroll region and reverse index. ROUTINE: DDBRT COMPONENT: $$TEST VARIABLES: None Type: Function call to determine if a CRT can support scroll region and reverse index. Usage: S X=$$TEST^DDBRT 1 = YES 0 = NO ******************** 2609 NAME: Browser API CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Browser device handler functions. ROUTINE: DDBRZIS COMPONENT: CLOSE VARIABLES: None Type: This procedure executes $$REWIND^%ZISC(), to rewind the file, and copies the text from the host file into a scratch global. COMPONENT: OPEN VARIABLES: None Type: This procedure captures the text used in the Browser's title. COMPONENT: POST VARIABLES: None Type: This procedure initializes the Browser to display the text sent to the device. ******************** 2610 NAME: ScreenMan API: Form Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 14,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine $$GET() - This extrinsic function retrieves data from a form-only field or a computed field. PUT() - This procedure stuffs data into a form-only field. ROUTINE: DDSVALF COMPONENT: $$GET() VARIABLES: FIELD Type: Input (Required) The Field Order number, Caption, or Unique Name of the form-only field. BLOCK Type: Input (Required at the page and form levels) The Block Order or Block Name. The default is the current block. PAGE Type: Input (Required at the form level) The Page Number or Page Name. The default is the current page. FLAGS Type: Input (Optional) Controls whether the internal or external form is returned, as shown below: I Return the Internal form of the data. (Default) E Return the External form of the data. IENS Type: Input (Required at the page and form levels) The standard IENS that identifies the entry or subentry associated with the form-only field. The default is the current entry or subentry. This extrinsic function retrieves data from a form-only field or a computed field. Format $$GET^DDSVALF(FIELD,BLOCK,PAGE,FLAGS,IENS) COMPONENT: PUT() VARIABLES: FIELD Type: Input (Required) The Field Order number, Caption, or Unique Name of the form-only field. BLOCK Type: Input (Required at the page and form levels) The Block Order or Block Name. The default is the current block. PAGE Type: Input (Required at the form level) The Page Number or Page Name. The default is the current page. VALUE Type: Input (Required) The value to stuff into the form-only field. If FLAGS (described below) does not contain an "I", the value must be in the form of a valid, unambiguous user response. FLAGS Type: Input (Optional) Indicates whether VALUE is in internal or external form, as shown below: I VALUE is in Internal form; it is not validated. E VALUE is in External form (default). IENS Type: Input (Required at the page and form levels) The standard IENS that identifies the entry or subentry associated with the form-only field. The default is the current entry or subentry. This procedure stuffs data into a form-only field. Format PUT^DDSVALF(FIELD,BLOCK,PAGE,VALUE,FLAGS,IENS) ******************** 2611 NAME: TIME ZONE DIFFERENTIAL CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 20,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 4.4 ROOT: XMB(4.4, DESCRIPTION: TYPE: File CIRN would like an agreement to do a direct global read of the DIFFERENTIAL (#2) field in the MAILMAN TIME ZONE file (#4.4). This is used in conjunction with the CIRN REPOSITORY SITE PARAMETER file (#990.8) fields, (#10) STANDARD TIMEZONE and (#11) DST TIMEZONE, to automatically identify the current time and time differential for HL7 messaging. ^XMB(4.4,D0,0) 2 DIFFERENTIAL 0;3 Direct Global Read & w ROUTINE: ******************** 2612 NAME: DBIA2612 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 18,1998 STATUS: Active EXPIRES: SEP 1,2020 DURATION: Till Otherwise Agr VERSION: FILE: 50.3 ROOT: PS(50.3, DESCRIPTION: TYPE: File As of 9/1/20 the ICR Team were requested to change the custodial package to Pharmacy Data Management, instead of Inpatient Medications. This resulted from the alignment of file ranges under specific packages for the conversions from Rational to GitHub. Actual Description from prior to 9/1/20: National Drug File (NDF) request permission to look at the PRIMARY DRUG file (#50.3). Direct Global Read. Field Name Node & Piece .01 NAME 0;1 ^PS(50.3,D0,0) .01 NAME Direct Global Read & w ROUTINE: ******************** 2613 NAME: DBIA2613 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 18,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.7 ROOT: PS(59.7, DESCRIPTION: TYPE: File National Drug File (NDF) requests to look at the PHARMACY SYSTEM file (59.7). Direct Global R/W. ^PS(59.7, 10 NDF VERSION 10;1 Direct Global R/W & w/ 11 RESTART NUMBER 10;2 Direct Global R/W & w/ 12 CONVERSION REMATCH O 10;3 Direct Global R/W & w/ 10.1 LAST DRUG CONVERTED 10;4 Direct Global R/W & w/ 10.2 V4 CONVERSION COMPLE 10;5 Direct Global R/W & w/ 13 PIMS PRINTER 10;6 Direct Global R/W & w/ 14 PIMS LANGUAGE 10;7 Direct Global R/W & w/ 49.99 OUTPATIENT VERSION 49.99;1 Direct Global R/W & w/ .01 SITE NAME 0;1 Direct Global R/W & w/ 15 PMIS SECTION DELETE 10;8 Direct Global R/W & w/ 100 FDA MED GUIDE SERVER FDA;1 Direct Global Read & w ROUTINE: ******************** 2614 NAME: DBIA2614 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 18,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other National Drug File (NDF) requests permission to export templates to DRUG file (#50). Print Templates --------------- PSNFRMPRT PSNHEAD PSNLDG1 PSNRPT2 PSNRPT4 Sort Templates -------------- PSNFRMSRT ROUTINE: ******************** 2615 NAME: TERM OF VALM0 CUSTODIAL PACKAGE: LIST MANAGER SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: OCT 19,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 5.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications requests an integration agreement with List Manager to call TERM^VALM0. This call is to set the variables that determine terminal characteristics. ROUTINE: VALM0 COMPONENT: TERM VARIABLES: No variables are passed. ******************** 2616 NAME: DBIA2616 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES During the posting/releasing process in Controlled Substances, a check will be done on the status of the prescription. If the status of the prescription is DISCONTINUED, DELETED, DISCONTINUED BY PROVIDER, or DISCONTINUED (EDIT), the prescription will not be posted and released. If the fill is a refill, the call will be made to Outpatient Pharmacy to delete the refill information and add an Activity Log entry detailing why the refill was deleted. USAGE: Controlled Subscri ENTERED: OCT 19,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows the Controlled Substances package to call the Outpatient Pharmacy package to request that the last refill of a prescription be deleted. This will be for Outpatient Version 7.0 and greater. The Outpatient Pharmacy version check will be done by the Controlled Substances package. ROUTINE: PSOCAN COMPONENT: PSD VARIABLES: PSDRX Type: Input This is the internal entry number from the PRESCRIPTION File (#52). PSDRFDEL Type: Output This variable indicates whether or not the refill was deleted. 1 = Yes (refill deleted) 0 = No (refill not deleted) This entry point will delete the last refill of the prescription and add an Activity Log entry describing this action. ******************** 2617 NAME: DBIA2617 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 19,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT DESCRIPTION: TYPE: File The CIRN Visit Tracking data extraction routine (^RGHOPV1 - HL7 Message Generation for In-patient/Out-patient Visit Data) and the historical load routine (^RGHOPV1B - Historical Backload of Visits), make several references to nodes/fields in the VISIT file (#9000010), for the purpose of creating the HL7 transmission records. ^AUPNVSIT(D0,0) .01 VISIT/ADMIT DATE&TIM 0,1 Read w/Fileman .05 PATIENT NAME 0,5 Read w/Fileman .06 LOC. OF ENCOUNTER 0;6 Read w/Fileman .12 PARENT VISIT LINK 0;12 Read w/Fileman .18 CHECK OUT DAT&TIME 0;18 Read w/Fileman .22 HOSPITAL LOCATION 0;22 Read w/Fileman ^AUPNVSIT(D0,150) 15003 ENCOUNTER TYPE 150,3 Read w/Fileman 15001 VISIT ID 150;1 Read w/Fileman 15002 PATIENT STATUS IN/OU 150;2 Read w/Fileman ROUTINE: ******************** 2619 NAME: DBIA2619 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.15 ROOT: AUPNVTRT DESCRIPTION: TYPE: File The CIRN Treatments (PCE) data extraction routine (^RGHOVTX - HL7 Transmission of Non CPT Coded Procedures), makes several references to nodes/fields in the V TREATMENT file (#9000010.15), for the purpose of creating the HL7 transmission records. ^AUPNVTRT(D0,0) .01 TREATMENT 0,1 Read w/Fileman .02 PATIENT NAME 0,2 Read w/Fileman .03 VISIT 0,3 Read w/Fileman .04 HOW MANY 0,4 Read w/Fileman .06 PROVIDER NARRATIVE 0,6 Read w/Fileman ^AUPNVTRT(D0,12) 1201 EVENT DATE AND TIME 12,1 Read w/Fileman 1202 ORDERING PROVIDER 12,2 Read w/Fileman ROUTINE: ******************** 2620 NAME: DBIA2620 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.17 ROOT: AUTTTRT DESCRIPTION: TYPE: File The CIRN Treatments (PCE) data extraction routine (^RGHOVTX - HL7 Transmission of Non CPT Coded Procedures), makes a reference to a node in the TREATMENT file (#9999999.17), for the purpose of creating the HL7 transmission records. ^AUTTTRT(D0,0) .01 NAME 0,1 Read w/Fileman ROUTINE: ******************** 2622 NAME: DBIA2622 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 20,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Use of the XLFUTL APIs. ROUTINE: XLFUTL COMPONENT: $$CCD VARIABLES: Compute check digit. See Taylor report Computerworld 1975 Usage: S Y=$$CCD^XLFUTL(X) Input: an integer. Returns the input value with the check digit appended. COMPONENT: $$VCD VARIABLES: Verify check digit (last digit). Usage: IF $$VCD^XLFUTL(X) W "OK" Input: an integer with check digit, from $$CCD^XLFUTL Output: 1 if the check digit matches, 0 for non-match. COMPONENT: $$BASE VARIABLES: Converts the first parameter from the number base of the second parameter to the number base of the third parameter. Usage: W $$BASE^XLFUTL("1A",16,2) ==> 11010 Input 1: a string representing the number to convert. Input 2: a number from 2 to 16, the base of input 1. Input 3: a number from 2 to 16, the base for the output. The useful values for Input 2 and 2 are 2, 8, 10, 16 but other numbers can be used. e.g. W $$BASE("A",12,3) ==> 101 Because of the use of division, input is limited by the M vendor to the largest integer they handle, 15 digits. COMPONENT: $$DEC(NUMBER,FROMBASE) VARIABLES: NUMBER Type: Input Number to be converted to base 10 FROMBASE Type: Input Base to convert NUMBER from $$DEC Type: Output NUMBER converted to Base 10 COMPONENT: $$CNV(NUMBER,TOBASE) VARIABLES: NUMBER Type: Input Number to be converted from base 10 to TOBASE TOBASE Type: Input Base to convert NUMBER to $$CNV Type: Output NUMBER converted to TOBASE from base 10 ******************** 2623 NAME: DBIA2623 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 21,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.27 ROOT: AUTNPOV DESCRIPTION: TYPE: File The CIRN Treatments (PCE) data extraction routine (^RGHOVTX - HL7 Transmission of Non CPT Coded Procedures), makes a reference to a node in the PROVIDER NARRATIVE file (#9999999.27), for the purpose of creating the HL7 transmission records. ^AUTNPOV(D0,0) .01 NARRATIVE 0,1 Read w/Fileman ROUTINE: ******************** 2624 NAME: DBIA2624 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 23,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CIRN would like a DBIA with Registration to use the SEND^VAFHUTL function to identify the status of the PIMS ADT messaging or SEND PIMS HL7 V2.3 MESSAGES field (391.7013) within the MAS PARAMETERS file (#43). ROUTINE: VAFHUTL COMPONENT: $$SEND() VARIABLES: $$SEND Type: Output ;OUTPUTS 0 will indicate NOT to send ; 1 will indicate TO send ; 0 in second piece will indicate NOT to send HL7 v2.3 ; 1 in second piece will indicate to send HL7 v2.3 this function will test for the on/off parameter to send ADT messages. ******************** 2627 NAME: DBIA2627 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.18 ROOT: AUPNVCPT DESCRIPTION: TYPE: File The CIRN Procedures (PCE) data extraction routine (^RGHOCPT - HL7 Transmission of CPT Coded Procedures), makes several references to the nodes/fields in the V CPT file (#9000010.18), for the purpose of creating the HL7 transmission records. ^AUPNVCPT(D0,0) .01 CPT 0,1 Read w/Fileman .02 PATIENT NAME 0,2 Read w/Fileman .03 VISIT 0,3 Read w/Fileman .04 PROVIDER NARRATIVE 0,4 Read w/Fileman ^AUPNVCPT(D0,12) 1201 EVENT DATE AND TIME 12,1 Read w/Fileman 1202 ORDERING PROVIDER 12,2 Read w/Fileman ROUTINE: ******************** 2628 NAME: DBIA2628 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 6,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8, DESCRIPTION: TYPE: File CIRN Allergy/Adverse reaction data extraction routine ^RGHOALR/^RGHOALRB make numerous direct global reads of the PATIENT ALLERGY FILE(#120.8). The routines use this information to generate HL7 message for transmission of results and to do historical backloading of data. ^GMR(120.8, .01 PATIENT 0;1 Read w/Fileman .02 REACTANT 0;2 Read w/Fileman 1 GMR ALLERGY 0;3 Read w/Fileman 4 ORIGINATION DATE/TIM 0;4 Read w/Fileman 5 ORIGINATOR 0;5 Read w/Fileman 6 OBSERVED HISTORICAL 0;6 Read w/Fileman 20 VERIFICATION DATE/TI 0;17 Read w/Fileman 22 ENTERED IN ERROR ER;1 Read w/Fileman 23 DATE TIME ENTERED IN ER;2 Read w/Fileman 24 USER ENTERING IN ERR ER;3 Read w/Fileman ^GMR(120.8,D0,26,D1,2,D2, .01 COMMENTS 0;1 Read w/Fileman ROUTINE: ******************** 2629 NAME: EXPANSION FIELD FOR CIRN CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 9,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 51 ROOT: DIC(51, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. TO GENERATE HL7 PRESCRIPTION MESSAGING. ^DIC(51,D0, 1 EXPANSION 0;2 Direct Global Read & w ^DIC(51,'B', ROUTINE: ******************** 2630 NAME: DBIA2630 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: OCT 28,1998 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT DESCRIPTION: TYPE: File PCE Clinical Reminders needs to build a list of radiology procedures received by a patient. In order to do this we would like to use $O on the following cross-references. ^RADPT(D0,'DT','AP',PROCEDURE) This is used to obtain the list of radiology procedures for the patient. ^RADPT('B',DFN) This is used to find the entries in RADPT, i.e. the D0 for the patient. ^RADPT(DO,'DT,'D1,0) .01 EXAM DATE 0;1 Direct Global Read & w This is the exam date of the patient radiology procedure. DO is the patient DFN. D1 is the inverse date/time of the radiology procedure. ^RADPT(DO,'DT',D1,'P',D2,0) .01 CASE NUMBER 0;1 Direct Global Read & w This field contains the computer generated case number of the patient radiology exam. ROUTINE: ******************** 2631 NAME: DBIA2631 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER CONSULT/REQUEST TRACKING ORDER ENTRY/RESULTS REPORTING CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: OCT 27,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Knowledge of file and subfile hierarchies is sometimes required. The required information can be obtained from ^DD(D0,0,"UP"). ^DD(D0,O,'UP') ROUTINE: ******************** 2632 NAME: DBIA2632 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 27,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT DESCRIPTION: TYPE: File The CIRN Radiology/Nuclear Medicine data extraction routine (^RGHORAD - HL7 Message Generation for Radiology/Nuclear Results) and the historical load routine (^RGHORADB - Historical Load of Radiology/Nuclear Medicine Reports), make several references to radiology/nuclear related fields in the RAD/NUC MED PATIENT file (#70), for the purpose of creating the HL7 transmission records. ^RADPT(D0,DT,D1,P,D2,0) 2 PROCEDURE 0,2 Read w/Fileman 14 REQUESTING PHYSICIAN 0,14 Read w/Fileman ROUTINE: ******************** 2633 NAME: DBIA2633 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 27,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71, DESCRIPTION: TYPE: File The CIRN Radiology/Nuclear Medicine data extraction routine (^RGHORAD - HL7 Message Generation for Radiology/Nuclear Results) and the historical load routine (^RGHORADB - Historical Load of Radiology/Nuclear Medicine Reports), make several references to radiology/nuclear related fields in the RAD/NUC MED PROCEDURES file (#71), for the purpose of creating the HL7 transmission records. ^RAMIS(71,D0,0) .01 NAME 0,1 Read w/Fileman 9 CPT CODE 0,9 Read w/Fileman ROUTINE: ******************** 2635 NAME: DBIA2635 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: OCT 27,1998 STATUS: Active EXPIRES: NOV 9,1999 DURATION: Till Otherwise Agr VERSION: FILE: 60 ROOT: LAB(60 DESCRIPTION: TYPE: File Dietetics package displays Lab Test results by using Laboratory Test file #60. ^LAB(60,D0,0) .01 NAME 0;1 Direct Global Read & w (The look up on LABORATORY TEST file (#60) uses the DIC("S")="I $L($P(^(0),U,5))&(""BO""[$P(^(0),U ,3))") 5 LOCATION (DATA NAME) 0;5 Direct Global Read & w ^LAB(60,D0,.1) 51 PRINT NAME .1;1 Direct Global Read & w 53 PRINT CODE .1;3 Direct Global Read & w ^LAB(60,D0,1,D1,0) .01 SITE/SPECIMEN 0;1 Direct Global Read & w .01 SITE/SPECIMEN 0;1 Pointed to 1 REFERENCE LOW 0;2 Direct Global Read & w 2 REFERENCE HIGH 0;3 Direct Global Read & w 6 UNITS 0;7 Direct Global Read & w 9.2 THERAPEUTIC LOW 0;11 Direct Global Read & w 9.3 THERAPEUTIC HIGH 0;12 Direct Global Read & w (When displaying ther/normal values, therapeutic values override normal high/low.) ROUTINE: ******************** 2636 NAME: DBIA2636 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: DIETETICS USAGE: Private ENTERED: OCT 27,1998 STATUS: Active EXPIRES: NOV 9,1999 DURATION: VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File Dietetics package displays the Lab Test results by using the Lab Data file #63. ^LR(D0,'CH',D1,0) .01 DATE/TIME SPECIMEN T 0;1 Direct Global Read & w 2... TEST RESULT-FLAG 0;1-2 Direct Global Read & w .03 DATE REPORT COMPLETE 0;3 Direct Global Read & w .05 SPECIMEN TYPE 0;5 Direct Global Read & w ROUTINE: ******************** 2638 NAME: ORDER STATUS file direct access CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING CARE MANAGEMENT SCHEDULING FEE BASIS CLAIMS SYSTEM Fee Basis Claims system is using standard FileMan calls ($$FIND1^DIC) to locate the IEN for the ORDER STATUS (#100.01) file to relate that information into the ^GMR(123 file to pull only Active or Pending consults. VISTA INTEGRATION ADAPTOR CLINICAL PROCEDURES CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: OCT 29,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.01 ROOT: ORD(100.01, DESCRIPTION: TYPE: File The Consults package and CPRS are very tightly linked. The Consults package has direct access to the Order Status File, 100.01. Consult routines use the Order status to display the status and create lists of consults for use by the Consults package List Manager, CPRS List Manager Consults tab and the CPRS GUI Consults tab. The Consult package also uses the direct access of the order status to create the Notification text for consult alerts. The Consults package may have read only direct access to the ^ORD(100.01, global for the following information: ^ORD(100.01,D0,0)= (#.01) NAME [1F] ^ (#.02) SHORT NAME [2F] ^ ^ORD(100.01,D0,.1)= (#.1) ABBREVIATION [E1,245F] ^ ^ORD(100.01,"B",STATUS,D0) ^ORD(100.01,STATUS,0) .01 NAME Direct Global Read & w Names that represent an Orders Status. (e.g., DISCONTINUED, COMPLETE) This also allows for direct read of the "B" index to determine the list of possible statuses. .02 SHORT NAME Direct Global Read & w This is the SHORT NAME for an order status. This is used when the displays need to restrict the order status to 4 characters, or less. .1 ABBREVIATION Direct Global Read & w This is the ABBREVIATION for an order status. (e.g., pr is the abbreviation for PARTIAL RESULTS) ROUTINE: ******************** 2640 NAME: CIRN HEALTH SUMMARY DATA EXTRACT CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: OCT 29,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA concerns a call to the CIRN Health Summary extract routine. ROUTINE: RGDDHS00 COMPONENT: EXTRACT VARIABLES: DFN Type: Input A pointer to the Patient file (#2). OPT Type: Input A list of option flags used to control the extract process. Defaults to null if not passed in. A - Abnormal results only Cn - Set column width to n (default=10) Dn - Set detail level to n (default=0) Fn - First n results (default=1) I - Show institution information J - First or last for each institution Ln - Last n results (default=1) N - Show normal ranges O - Old results first Rn - Results stored within last n days U - Show units BEG Type: Input The beginning date for extracted data, in internal VA FileMan format. Defaults to the earliest date that the patient has data for if not passed in. END Type: Input The ending date for extracted data, in internal VA FileMan format. Defaults to the latest date that the patient has data for if not passed in. CLS Type: Input A single class name/pointer or array of class names/ pointers to the CIRN Object Dictionary (#990.9). May be passed by reference or by value. If an array is passed by reference, subscripts represent the class name/pointer values. Defaults to all classes if not passed in. INS Type: Input A single pointer or array of pointers to the Institution file (#4). May be passed by reference or by value. If an array is passed by reference, the subscripts represent the pointer values. Defaults to all institutions if not passed in. To include all institutions except a selected list, negate the pointer value, e.g., S INS(-123)="". TAX Type: Input A taxonomy name/pointer to the CIRN Object Taxonomy file (#990.91). Defaults to "CLINICAL SUMMARY" if not passed in. RETURN VAL Type: Output The output of this call is in the ^TMP("RGHS",$J, global. D EXTRACT^RGDDHS00(DFN,OPT,BEG,END,[.]CLS,[.]INS,TAX) ******************** 2641 NAME: KIDS VARIABLES CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 9,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Variable(s) available pre, during, and post KIDS installation. Variable: XPDPKG = Package file entry ien for build that is currently being processed. ROUTINE: ******************** 2642 NAME: Set Rad/Nuc Med data dictionary 'ID','WRITE' node. CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: NOV 12,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 0 ROOT: DD( DESCRIPTION: TYPE: File Radiology/Nuclear Medicine intends to modify the following data dictionary attribute: before: ^DD(71,0,"ID","WRITE") = W ?54,$$PRCCPT^RADD1() after: ^DD(71,0,"ID","WRITE") = D EN^DDIOL($$PRCCPT^RADD1(),"","?54") The intention of this correction is to eliminate the WRITE command from the data dictionary. To execute this action, I must hard set the data dictionary node in a post-init. At present, FileMan does not have a generic tool to export specific file wide data dictionary attributes. I do not wish to carry over the entire data dictionary for the Rad/Nuc Med Procedures file. ROUTINE: ******************** 2643 NAME: DBIA2643 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 3,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Since March 1994, the Integrated Billing package has retained full authority for the INSURANCE TYPE (#2.312) sub-file and the field COVERED BY HEALTH INSURANCE? (#.3192), both located in the PATIENT (#2) file. In addition the INS node references the INSURANCE - NON-POLICY INFO for each patient. Fields related to non-policy related insurance will be stored on this node. This authority includes development of the data dictionary (DD) for these fields, as well as responsibility for data entry into and data retrieval from these fields. This agreement is a "delegation of custody" of these fields from Registration to Integrated Billing. It provides Integrated Billing all rights and privileges to development and distribution for all DD elements and data in these fields. In addition, all DBIAs required for access to the DD and data for these fields will be between any subscriber and Integrated Billing as the custodian. ^DPT(D1,.312,D0) .3121 INSURANCE TYPE Direct Global R/W & w/ This field references the INSURANCE TYPE (#2.312) sub-file in this agreement. ^DPT(D0,.31) .3192 COVERED BY HEALTH IN .31;11 Direct Global R/W & w/ This field references the COVERED BY HEALTH INSURANCE? (#.3192) field in this agreement. ^DPT(D0,INS) 2001 DATE LAST EICD RUN INS;1 Direct Global R/W & w/ This field contains the date that the last EICD Identification inquiry was transmitted to the Financial Services Center (FSC) INSURANCE - NON-POLICY INFO Direct Global R/W & w/Fileman This node references the INSURANCE - NON-POLICY INFO for each patient. Fields related to non-policy related insurance will be stored on this node. ROUTINE: IBCNSU1 COMPONENT: $$VET VARIABLES: Input Tran Type: Output 1 - Set X = to Patient's Name 0 - User may enter/edit field ******************** 2644 NAME: DBIA2644 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK The CIRN Problem List data extraction routine (^RGHOPL - HL7 Transmission of Problem List Data), and the historical load routine (^RGHOPLB - Historical Load of Problem List), primarily call the GMPLUTL3 API, for the purpose of creating records. CLINICAL REMINDERS Clinical Reminders needs information from a patient's Problem List. This includes the most recent date the patient's Problem List was modified and the following fields: DATE LAST MODIFIED, CONDITION, STATUS, DIAGNOSIS, PROBLEM, and PROVIDER NARRATIVE. CLINICAL CASE REGISTRIES ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: AUPNPROB DESCRIPTION: TYPE: Routine ROUTINE: GMPLUTL3 COMPONENT: CALL0 VARIABLES: GMPLZ Type: Input IEN of problem GMPLICD Type: Output DIAGNOSIS GMPLPNAM Type: Output PATIENT NAME GMPLDLM Type: Output DATE LAST MODIFIED GMPLTXT Type: Output PROVIDER NARRATIVE GMPLODAT Type: Output Either DATE OF ONSET or DATE ENTERED GMPLSTAT Type: Output STATUS COMPONENT: CALL1 VARIABLES: GMPLZ Type: Input IEN of problem GMPLLEX Type: Output PROBLEM GMPLCOND Type: Output CONDITION GMPLPRV Type: Output Either RECORDING PROVIDER or RESPONSIBLE PROVIDER GMPLXDAT Type: Output DATE RESOLVED GMPLPRIO Type: Output the Priority (A=acute C=chronic) for a Problem List problem COMPONENT: CALL2 VARIABLES: Sets variables described in both CALL0 and CALL1, of this DBIA. COMPONENT: MOD VARIABLES: This entry point is called a a function and returns the date or date and time of the last time that a patients Problem List was modified. example: W $$MOD^GMPLUTL3(DFN) returns: 2990301 or 2990301.096523 If DFN is not one that has an entry in the problem list then a zero is returned. ******************** 2647 NAME: ADD CIRN COMPONENTS CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 18,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CIRN requests permission to add three (3) new components to the Health Summary Component file (#142.1) which will display CIRN information while respecting time and occurrence limits. These components will be exported in a disabled state by a Health Summary patch. The IEN range set aside for CIRN use in the Health Summary Component file (#142.1) will be 400-499. The sub-namespace used by the CIRN HS components will be GMTSRG*. A CIRN post-install routine will add the components to the Ad Hoc Health Summary type by calling the ENPOST^GMTSLOAD entry point. The variable INCLUDE will be set to zero (0) or one (1) by user input before the call to this entry point. ROUTINE: GMTSLOAD COMPONENT: ENPOST VARIABLES: INCLUDE Type: Input INCLUDE=0 Excludes disabled components in the Ad Hoc Health Summary type. INCLUDE=1 Includes disabled components in the Ad Hoc Health Summary type. Rebuild the Ad Hoc Health Summary type. ******************** 2648 NAME: Import Tool API CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This procedure imports data from ASCII host files into VA FileMan file entries. Format FILE^DDMP([FILE],[[.]FIELDS],[.CONTROL],.SOURCE,[.]FORMAT) ROUTINE: DDMP COMPONENT: FILE() VARIABLES: FILE Type: Input (Optional) File number into which imported data will be filed. Do not pass this parameter if the import file specifies the destination VA FileMan file and fields. The file must already exist. [.]FIELDS Type: Input (Optional) Array specifying the fields into which imported data will be filed. The array can either: Name an Import Template, or Directly specify the fields for import. Do not pass this parameter if the import file specifies the destination VA FileMan file and fields. If you have the import fields stored in an Import Template, simply set the top-level, unsubscripted node to the name of the template, surrounded by [brackets]. .CONTROL Type: Input (Optional) Pass this array by reference. You can control the behavior of FILE^DDMP by setting the following nodes in the CONTROL array: CONTROL("FLAGS") (Optional) Concatenated string of character flags to control processing of the import. E External values are contained in the import file. F Import File contains identity of destination FileMan file and fields. If F flag is not present, the FILE and FIELDS parameters are required and must contain file and field information. CONTROL("MSGS"): (Optional) Set to the root of an array (local or global) into which error messages should be returned. If a value is not passed, messages are returned in nodes descendant from ^TMP("DIERR",$J). CONTROL("MAXERR"): (Optional) Set to the number of errors encountered at which point to abort the import. Default is not to abort. CONTROL("IOP"): (Optional) Set to the name of the device (as stored in the DEVICE file) on which to print the Import Report. Default is to ask the user for output device. CONTROL("QTIME"): (Optional) Set to the time for queuing the data filing, and subsequent printing of the Import Results report. Default is to ask the user whether or not to queue, and for the queuing time. .SOURCE Type: Input (Required) An array that identifies the import file. Pass this array by reference. SOURCE("FILE") (Required) Set this node to the import file name. SOURCE("PATH") (Optional) Path or directory where the file can be found. If this node is not defined, the default path is used to locate the file. [.]FORMAT Type: Input (Required) Specifies the format of the incoming data. You can either: Pass the name of a FOREIGN FORMAT File entry in the top-level, unsubscripted node of this array, or Set individual nodes in this array to define the import format (pass by reference). If you set individual nodes in the array to define the format, you can set: FORMAT("FDELIM") Set this node to the field delimiter used for the imported data, if a field delimiter is used. FORMAT("FIXED") Set this node to "YES" if the incoming data is in fixed-length format. If not set to "YES", the default format is field-delimited. FORMAT("QUOTED") Set this node to "YES", if you would like VA FileMan to ignore the field delimiter in any quoted strings in the incoming data. This procedure imports data from ASCII host files into VA FileMan file entries. Each record (line of data) in the host file is stored as a new entry in a specified VA FileMan file. ******************** 2649 NAME: Classic FileMan API: Max. Routine Size CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 19,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This argumentless function returns the maximum routine size that should be used when compiling cross references, print templates, or input templates. ROUTINE: DILF COMPONENT: $$ROUSIZE VARIABLES: None Type: This argumentless function returns the maximum routine size that should be used when compiling cross references, print templates, or input templates. Format $$ROUSIZE^DILF ******************** 2650 NAME: DBIA2650 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: NOV 23,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management calls ADD^ORCMEDT1 to add a single quick order located in the ORDER DIALOG FILE (#101.41) to a menu for use in CPRS 1.0. On installation, CPRS loops through all the Add Orders menus in the Protocol file that are assigned to users as a default; all items on those menus are converted to a new entry in a new format in the Order Dialog file for use with CPRS. Utilities exist in both Pharmacy and CPRS to convert additional protocols that did not get processed [successfully] during installation; the entry point ADD^ORCMEDT1 being called here from the Pharmacy utility will simply loop through the Protocol file and find all menus that the protocol PITEM was attached to and add the corresponding converted dialog DITEM to the same menus in the Order Dialog file. This will help minimize the impact on the sites. ROUTINE: ORCMEDT1 COMPONENT: ADD VARIABLES: PITEM Type: Input IEN of the quick order in the PROTOCOL FILE (#101). DITEM Type: Input IEN of the quick order in the ORDER DIALOG FILE (#101.41). Variable PITEM is defined as the quick order IEN in the PROTOCOL FILE (#101). Variable DITEM is defined as the same quick order IEN in the ORDER DIALOG FILE (101.41). Entry point ADD finds the menu location for PITEM that was used in OERR 2.5 and places DITEM under the same menu location for use in CPRS 1.0. ******************** 2651 NAME: DBIA2651 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: NOV 23,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 3.0 FILE: ROOT: DESCRIPTION: TYPE: Routine Routine ORCONV2 is called by Pharmacy Data Management to pass quick order data from the PHARMACY QUICK ORDER FILE (#57.1) to OERR. In preparation for CPRS 1.0, these pharmacy quick orders are converted to entries in the ORDER DIALOG FILE (#101.41). Entry points UD^ORCONV2 and IV^ORCONV2 accomplish this task. ROUTINE: ORCONV2 COMPONENT: UD VARIABLES: This entry point is called to process a unit dose pharmacy quick order. The following array is built before the call is made. ^TMP("PSJQO",$J,1)=Quick Order Name^Type^Orderable Item IEN^Med Route IEN^ Schedule^Instructions^Infusion Rate^Provider Comments Prompt ^TMP("PSJQO",$J,"DD")=Dispense Drug IEN ^TMP("PSJQO",$J,"PC",0)=Last Entry^Number of Entries ^TMP("PSJQO",$J,"PC",x,0)=Provider Comments Line x ^TMP("PSJQO",$J,"AD",0)=Last Entry^Number of Entries ^TMP("PSJQO",$J,"AD",x,0)=Orderable Item IEN (for Additive)^Strength^Units ^TMP("PSJQO",$J,"SOL",0)="Last Entry^Number of Entries ^TMP("PSJQO",$J,"SOL",x,0)=Orderable Item IEN (for Solution)^Volume Where QUICK ORDER NAME = Free Text 3-30 characters TYPE = Set of codes 1:IV FLUID, 2:Inpatient Medications PROVIDER COMMENTS PROMPT = Set of Codes 1:Don't prompt,"""":prompt COMPONENT: IV VARIABLES: This entry point is called to process an IV fluid pharmacy quick order. The following array is built before the call is made. ^TMP("PSJQO",$J,1)=Quick Order Name^Type^Orderable Item IEN^Med Route IEN^ Schedule^Instructions^Infusion Rate^Provider Comments Prompt ^TMP("PSJQO",$J,"DD")=Dispense Drug IEN ^TMP("PSJQO",$J,"PC",0)=Last Entry^Number of Entries ^TMP("PSJQO",$J,"PC",x,0)=Provider Comments Line ^TMP("PSJQO",$J,"AD",0)=Last Entry^Number of Entries ^TMP("PSJQO",$J,"AD",x,0)=Orderable Item IEN (for Additive)^Strength^Units ^TMP("PSJQO",$J,"SOL",0)="Last Entry^Number of Entries ^TMP("PSJQO",$J,"SOL",x,0)=Orderable Item IEN (for Solution)^Volume Where QUICK ORDER NAME = Free Text 3-30 characters TYPE = Set of codes 1:IV FLUID, 2:Inpatient Medications PROVIDER COMMENTS PROMPT = Set of Codes 1:Don't prompt,"""":prompt ******************** 2652 NAME: DBIA2652 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY VISTA INTEGRATION ADAPTOR VIA will be referencing the Name (#.01) field in the Specialty (#42.4) file in VIAB BMS RPC. USAGE: Controlled Subscri ENTERED: NOV 25,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File The Surgery package needs to store the specialty associated with certain surgical admissions and requests permission to point to and read by FileMan the NAME field (#.01) of SPECIALTY file (#42.4). ^DIC(42.4,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2653 NAME: Rad/Nuc Med - CPRS Orderable Item cleanup CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: NOV 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this database integration agreement (DBIA) is to correct a discrepancy between the Rad/Nuc Med Common Procedure (#71.3) and the Orderable Items (#101.43) file. Rad/Nuc Med will use routine ORYRA to inactivate records in the Orderable Items file, then initiate a whole file update of the Rad /Nuc Med Procedure file. This final action will ensure that the two files are in synch. ROUTINE: ORYRA COMPONENT: EN VARIABLES: No input variables are needed for this call. ******************** 2654 NAME: CIRN access to PSDRUG file CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 30,1998 STATUS: Active EXPIRES: JUN 1,2006 DURATION: VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. CIRN needs a read access to the PSDRUG (file #50) to generate HL7 prescription messaging ^PSDRUG(D0,0) .01 GENERIC NAME 0;1 Direct Global Read & w ^PSDRUG(D0,2) 31 NDC 2;4 Direct Global Read & w ^PSDRUG(D0,ND) 23 PACKAGE SIZE ND;4 Direct Global Read & w 24 PACKAGE TYPE ND;5 Direct Global Read & w ROUTINE: ******************** 2655 NAME: DBIA2655 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: DEC 2,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File Direct Global access to ^DPT(DFN) For the purpose of locking a patient file while updating demographic information. The following code is used: L +^DPT(DFN):2 ROUTINE: ******************** 2656 NAME: DBIA2656 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: TOOLKIT USAGE: Private ENTERED: DEC 3,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 9.4 ROOT: DIC(9.4, DESCRIPTION: TYPE: File I would like to kill the "AMRG" cross reference (x-ref) for the 'Toolkit' entry in the Package File. The entry that created this x-ref was manually killed by XT*7.3*33 Post-Init routine, but the x-ref was inadvertently left. This would be a once time occurance to clean-up the 'Toolkit' entry in the Package File. The "AMRG" cross reference is a whole file x-ref made on the "File Affected" (Field .01) for the "Affects Record Merge Sub-File" (Field 20) in the Package File (#9.4). ROUTINE: ******************** 2657 NAME: CLOZAPINE USE OF LABS CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: MENTAL HEALTH The Clozapine Roll-Up software in Mental health uses the CH node of file 63 to determine the number of White Blood Count tests performed on a patient. An entry in the Drug file points to the test at the local site that points to the monitoring test. The "DATE/TIME SPECIMEN TAKEN" (field .01), "DATE REPORT COMPLETED" (field .03), and "SPECIMEN TYPE" (field .05) fields of the "CHEM, HEM, TOX, RIA, SER, etc." multiple in file 63 are used to validate the test before it is added to the count. S YSCLWBCT=0 F J=YSCLIED:0 S J=$O(^LR(YSCLLDFN,"CH",J)) Q:'J Q:J>X I $D(^(J,YSCLLDN)),$P(^(0),"^",5)=YSCLSP,$P(^(0),"^",3) ,$P(^(YSCLLDN),"^") S YSCLWBCT=YSCLWBCT+1 USAGE: Private ENTERED: SEP 15,1992 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File ROUTINE: ******************** 2658 NAME: REMOVAL OF ID NODE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ASISTS USAGE: Private ENTERED: DEC 10,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DD(2260,0,'ID' DESCRIPTION: TYPE: Other Deletion of "ID" node for identifier which is no longer required. ^DD(2260,0,'ID',1) ROUTINE: ******************** 2659 NAME: DISPOSITION HOSPITAL LOCATIONS CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING TEXT INTEGRATION UTILITIES USAGE: Controlled Subscri ENTERED: DEC 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 815 ROOT: PX(815 DESCRIPTION: TYPE: File Patch SD*5.3*137 allows the site to convert old Scheduling encounter information to the PCE/Visit Tracking database as 'historical' visits. Registration disposition information is part of this conversion effort. However, in order to create VISIT file entries for dispositions, the disposition must be associated with a valid clinic entry in the HOSPITAL LOCATION file. Furthermore, for old dispositions which are being conversion, this association does not exist. In order to link a disposition to valid disposition clinic, Scheduling needs to match the medical center division of the disposition with tne medical center division of a valid disposition clinc. The valid disposition clinics are stored in the PCE PARAMETERS file in the DISPOSITION HOSPITAL LOCATIONS multiple. Patch SD*5.3*137 needs 'read' access to this multiple in order to accomplish this mapping. ^PX(815,1,"DHL",,0) .01 DISPOSITION HOSPITAL 0;1 Direct Global Read & w Clinic HOSPITAL LOCATION file entry that can be asscoiated with disposition VISIT file entries. ROUTINE: ******************** 2660 NAME: SCHEDULING CONVERSION FIELDS CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: DEC 10,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File These two control fields are used to track whether the appointment or disposition have been converted as part of patch SD*5.3*137. This DBIA will allow Scheduling to distribute these fields in patch DG*5.3*207. DG*5.3*207 will be distributed to the sites with SD*5.3*137 in a KIDS host file. Also, this DBIA will allow the Scheduling conversion software to update these files via VA FileMan calls. ^DPT(DFN,'S',,0) 23.1 ENCOUNTER CONVERSION 0;23 Both R/W w/Fileman This field indicates whether or not this appointment was converted during the ACRP Database Conversion (SD*5.3*137). The field is set to '1' after the appointment has been converted by the conversion software. ^DPT(DFN,'DIS',,0) 19 ENCOUNTER CONVERSION 0;19 Both R/W w/Fileman This field indicates whether or not this disposition was converted during the ACRP Database Conversion (SD*5.3*137). The field is set to '1' after the disposition has been converted by the conversion software. ROUTINE: COMPONENT: PXKNOEVT VARIABLES: ******************** 2661 NAME: DIR Special variable CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: KERNEL TOOLKIT DIR(0)="SV" to keep DIR from talking during its evaluation of the set of codes. Also set is DIR("V"). USAGE: Controlled Subscri ENTERED: DEC 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Alert processor makes use of a special input parameter to Fileman DIR. This is done in XQALERT1, it makes a call with DIR(0)="LV^..." to get user input validated. ROUTINE: ******************** 2662 NAME: DBIA2662 CUSTODIAL PACKAGE: NETWORK HEALTH EXCHANGE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 11,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: AFJXNHEX REQUEST VARIABLES: Permission to use Option: NHE Network Health Exchange Options ... [AFJXNHEX REQUEST] ******************** 2663 NAME: DBIA2663 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: DG INPATIENT INQUIRY EXTENDED VARIABLES: Permission to use Option: [DG INPATIENT INQUIRY EXTENDED] Detatiled Inpatient Inquiry COMPONENT: DG PATIENT INQUIRY VARIABLES: Permission to use Option: [DG PATIENT INQUIRY] Patient Inquiry COMPONENT: DG REGISTRATION VIEW VARIABLES: Permission to use Option: [DG REGISTRATION VIEW] View Registration Data ******************** 2664 NAME: OBSERVATION API CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 24,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine DGPMOBS provides three entry points (MVT, PT, and SPEC) to determine if a patient's treating specialty for a specified movement or date/time is or was an observation specialty. ROUTINE: DGPMOBS COMPONENT: $$MVT VARIABLES: IFN Type: Input IFN = PATIENT MOVEMENT (#405) file internal entry number. (Required) OBS Type: Output If specialty associated with the specified PATIENT MOVEMENT (#405) entry is an observation treating specialty, function call returns: 1^FACILITY TREATING SPECIALTY (#45.7) file IEN^FACILITY TREATING SPECIALTY (#45.7) file name^SPECIALTY (#42.4) file IEN^SPECIALTY (#42.4) file name If specialty associated with the specified PATIENT MOVEMENT (#405) entry is not an observation treating specialty, function call returns: 0^FACILITY TREATING SPECIALTY (#45.7) file IEN^FACILITY TREATING SPECIALTY (#45.7) file name^SPECIALTY (#42.4) file IEN^SPECIALTY (#42.4) file name If PATIENT MOVEMENT (#405) file internal entry number not defined or invalid, function call returns: -1^Error condition $$MVT^DGPMOBS(IFN) returns the observation status based on the treating specialty associated with a specified PATIENT MOVEMENT (#405) file entry. COMPONENT: $$PT VARIABLES: DFN Type: Input DFN = PATIENT (#2) file DFN (Required) MVTDT Type: Input MVTDT = File Manager date/time (Optional) If date/time not defined, the current date/time will be used. OBS Type: Output If patient was in an observation treating specialty on the designated date/time, function call returns: 1^FACILITY TREATING SPECIALTY (#45.7) file IEN^FACILITY TREATING SPECIALTY (#45.7) file name^SPECIALTY (#42.4) file IEN^SPECIALTY (#42.4) file name If patient was not in an observation treating specialty on the designated date/time, function call returns: 0^FACILITY TREATING SPECIALTY (#45.7) file IEN^FACILITY TREATING SPECIALTY (#45.7) file name^SPECIALTY (#42.4) file IEN^SPECIALTY (#42.4) file name If PATIENT (#2) file internal entry number not defined or invalid, function call returns: -1^Error condition $$PT^DGPMOBS(DFN,MVTDT) returns the observation status for a patient based on the treating specialty on a designated date/time. If no date/time is specified, the current date/time is used. COMPONENT: $$SPEC VARIABLES: SPIFN Type: Input SPIFN = SPECIALTY (#42.4) file internal entry number. (Required) TX Type: Output 1 = Is an observation specialty 0 = Not an observation specialty -1^Error condition $$SPEC^DGPMOBS(SPIFN) determines if a SPECIALTY (#42.4) file entry is an observation treating specialty. ******************** 2665 NAME: DBIA2665 CUSTODIAL PACKAGE: FEE BASIS SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: FBCH PRINT 7078 VARIABLES: Permission to use Option: [FBCH PRINT 7078] 7078 Print COMPONENT: FBCNH AMIE VARIABLES: Permission to use Option: [FBCNH AMIE] Report of Admissions/Discharges for CNH ******************** 2666 NAME: DBIA2666 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: GMTS HS MENU VARIABLES: Permission to use Option: [GMTS HS MENU] Print Health Summary Menu ******************** 2667 NAME: DBIA2667 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: LRAPAUPT VARIABLES: Permission to use Option: [LRAPAUPT] Autopsy protocol/supplementary report COMPONENT: LRAPCYSGL VARIABLES: Permission to use Option: [LRAPCYSGL] Print cytopathology report for a patient COMPONENT: LRAPEMSGL VARIABLES: Permission to use Option: [LRAPEMSGL] Print electron microscopy report for a patient COMPONENT: LRAPSPSGL VARIABLES: Permission to use Option: [LRAPSPSGL] Print surgical pathology report for a patient ******************** 2670 NAME: DBIA2670 CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: SROSRPT VARIABLES: Permission to use Option: [SROSRPT] Operation Report ******************** 2671 NAME: DBIA2671 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Private ENTERED: DEC 17,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other AMIE II is an "umbrella" menu for VA Regional Office users on VistA systems. The IA is for the options included on the menu. ROUTINE: COMPONENT: TIU MAIN MENU REMOTE USER VARIABLES: Permission to use Option: [TIU MAIN MENU REMOTE USER] Text Integration Utilities (Remote User) ******************** 2672 NAME: DBIA2672 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: DEC 15,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.82 ROOT: GMRD(120.82, DESCRIPTION: TYPE: File ^GMRD(120.82,D0, .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2673 NAME: DBIA2673 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: DEC 16,1998 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 9000010.06 ROOT: AUPNVPRV DESCRIPTION: TYPE: File CIRN needs read access to ^AUPNVPRV('AD' ^AUPNVPRV(D0, FIELD .03 LOCATION 0;3 ^AUPNVPRV(D0, FIELD .04 LOCATION 0;4 ^AUPNVPRV('AD' ^AUPNVPRV(D0, .03 POINTER TO VISIT FIL 0;3 Read w/Fileman .04 PRIMARY/SECONDARY 0;4 Read w/Fileman ROUTINE: ******************** 2675 NAME: IA2675 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES OUTPATIENT PHARMACY ACCOUNTS RECEIVABLE USAGE: Private ENTERED: AUG 13,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File to determine the Medical Center Division IEN associated with the Hospital Location when Batch Printing Progress Notes. ^SC(D0, 3.5 DIVISION 0;15 Direct Global Read & w ROUTINE: ******************** 2676 NAME: Disable & Enable Rad/Nuc Med Order Dialog CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: DEC 22,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this database integration agreement (DBIA) is to allow the subscribing package to disable and enable Order Dialogs in CPRS. This would allow the specific package the ability to shut down their portion of the Order Dialog without impacting the functionality of other packages that interact with CPRS. This request is part of RA*5.0*6, whose goal is to synchronize the Orderable Items (#101.43) file and the Rad/Nuc Med Common Procedure file. This DBIA is dependent on OR*3.0*4, which exports the latest version of routine ORXD. ROUTINE: ORXD COMPONENT: DISABLE VARIABLES: PKG Type: Input PKG (req'd): package in question, the Order Dialogs for this package will be disabled. MSG Type: Input MSG (opt): package specific disable message. (40 chars maximum) If a message in not passed in by the subscribing package, a generic disable message is inserted. This entry point is called to disable Order Dialogs for a particular package. COMPONENT: ENABLE VARIABLES: PKG Type: Input PKG (req'd): package, the Order Dialogs for this package will be disabled. This entry point is called to enable Order Dialogs for a particular package. ******************** 2679 NAME: OE/RR calls RAO7MFN to populate radiology orderables CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 30,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OE/RR 2.5-3 FILE: ROOT: DESCRIPTION: TYPE: Routine ENALL^RAO7MFN is called from the post-installation processes of OR*2.5*49 and CPRS (Order Entry/Results Reporting v3.0) to populate radiology orderable items into OE/RR. ROUTINE: RA07MFN COMPONENT: ENALL VARIABLES: This entry point is called to run through all radiology orderables. It then calls OE/RR to populate those into the ORDERABLE ITEMS file (#101.43). ******************** 2681 NAME: OE/RR limited use of LAB(69.9 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 30,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OE/RR v2.5 FILE: 69.9 ROOT: LAB(69.9, DESCRIPTION: TYPE: File Patch OR*2.5*49 releases some setup functionality in advance of CPRS. This DBIA requests the listed access to LAB(69.9,1,7, for the period of time between the release of OR*2.5*49 and time when the last site installs CPRS. CPRS retrieves the information from calls to lab (which don't exist prior to installation of CPRS). ^LAB(69.6,1,7,division,0) .06 MINIMUM RESPONSE TIM 0;4 Direct Global Read & w ROUTINE: ******************** 2683 NAME: OE/RR calls to 2683 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 30,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79.2 ROOT: RA(79.2, DESCRIPTION: TYPE: File OE/RR references RA(79.2 as follows: 1. During order dialog a lookup is performed to select the IMAGING TYPE 2. The C index is used to loop through entries by ABBREVIATION of the IMAGING TYPE 3. The .01 and 3 fields are referenced via direct reads ^RA(79.2,'C' Used to look up entries with the same abbreviation. ^RA(79.2,DA,0) .01 TYPE OF IMAGING 0;1 Direct Global Read & w 3 ABBREVIATION 0;3 Direct Global Read & w ROUTINE: ******************** 2684 NAME: OE/RR needs to save/restore LM video attributes CUSTODIAL PACKAGE: LIST MANAGER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CONSULT/REQUEST TRACKING USAGE: Private ENTERED: DEC 31,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other List Manager maintains video attributes in ^TMP("VALM VIDEO". Within Order Entry/Results Reporting and Consult/Request Tracking, list manager is used extensively. One of the key features used is to have list manager actions which envoke other list manager displays. An example would be entering CPRS on the patient selection screen, selecting a patient and getting the cover sheet, selecting to change ot the orders tab (another screen), and adding orders (yet another screen). In order to maintain the video attributes of a particular display, it's necessary for OE/RR and Consults to save off the values in ^TMP("VALM VIDEO" prior to changing screens and kill existing values and restore them when returning. Saving/restoring of this data is done with the MERGE command. This DBIA requests authorization to access the ^TMP("VALM VIDEO",$J) data, kill it, and reset it based on previous values. ROUTINE: ******************** 2685 NAME: OE/RR direct reference to XTV(8989.51 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 31,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8989.51 ROOT: XTV(8989.51 DESCRIPTION: TYPE: File Within OE/RR, it's necessary to determine a parameter definitions IEN. To do this, the 'B' index of the PARAMETER DEFINITION file (#8989.51) is utilized. ^XTV(8989.51,'B' Used to lookup the IEN of a particular PARAMETER DEFINITION file entry. ROUTINE: ******************** 2686 NAME: OE/RR direct reference to XTV(8989.5 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING HEALTHEVET DESKTOP HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expires on 10/27/17 when HMP will be shutdown. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for sites to shut down the HMP application. On 3/30/16 a temporary ICR was approved by the Kernel team until 12/31/16 for HMP to modify their code to use Kernel API $$GETLST^XPAR() (Supported ICR #2263). DE4264 was entered to track this defect. As of 10/18/17, this defect has not been resolved. If HMP is reactivated in the future, a new expiration date should be discussed with the Kernel team. USAGE: Controlled Subscri ENTERED: DEC 31,1998 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8989.5 ROOT: XTV(8989.5, DESCRIPTION: TYPE: File Within OE/RR, it's necessary to determine if a parameter is in use. To do this, the parameter definition IEN is determined based on the 'B' index of the PARAMETER DEFINITION file (#8989.51) (see DBIA 2685). Using that IEN, the 'AC' x-ref in the PARAMETERS file (#8989.5) is utilized to determine if any parameter entity is set to a given value. If so, deletion of the item is prohibited. In addition, a one time patch post-install routine (ORY27) used this x-ref when populating a new parameter value based on an existing value. ^XTV(8989.5,'AC' Used to determine the parameter values set for a particular parameter definition. ROUTINE: ******************** 2687 NAME: OE/RR calls GMRCPOS1 to populate consult orderables CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 31,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OE/RR v2.5-3 FILE: ROOT: DESCRIPTION: TYPE: Routine During the OR*2.5*49 and OE/RR v3 (CPRS) post-install processes, EN^GMRCPOS1 is called. This routine loops through those consult services that can be selected and passes them back to OE/RR for population into the Orderable Items file. ROUTINE: GMRCPOS1 COMPONENT: EN VARIABLES: Used to populate consult orderables ******************** 2688 NAME: OE/RR calls LR7OV1 to populate lab orderables CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: DEC 31,1998 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OE/RR 2.5 FILE: ROOT: DESCRIPTION: TYPE: Routine During the OR*2.5*49 post-install process, EN^LR7OV1 is called. This routine takes values from lab files and uses them to populate LR namespaced parameters in Parameter Tools (XPAR*). These parameters are utilized from within CPRS. ROUTINE: LR7OV1 COMPONENT: EN VARIABLES: Populates lab parameters into Parameter Tools parameters for use by CPRS. ******************** 2689 NAME: OE/RR references to ALERT file CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT PATIENT REPRESENTATIVE USAGE: Controlled Subscri ENTERED: MAR 5,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8992 ROOT: XTV(8992, DESCRIPTION: TYPE: File OE/RR utilizes the alerting functionality extensively. While supported calls are often used, there are also direct references to the ALERT file (#8992) as described in this DBIA. ^XTV(8992,D0,'XQA', .02 ALERT ID 0;2 Direct Global Read & w .03 MESSAGE TEXT 0;3 Direct Global Read & w 1 DATA FOR ALERT 1;1 Direct Global Read & w .01 ALERT DATE/TIME 0;1 Direct Global Read & w ^XTV(8992,'AXQAN' Direct global read of the x-ref ^XTV(8992,'AXQA', ROUTINE: ******************** 2690 NAME: Consults calls to ORB3FUP1 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JAN 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Consults calls ORB3FUP1 to delete a CPRS-related alert after it has been processed. ROUTINE: ORB3FUP1 COMPONENT: DEL(.FLAG,XQAID) VARIABLES: FLAG Type: Output Passed by reference, this will contain the word TRUE if the deletion is valid or FALSE if not. XQAID Type: Input The ID information for the KERNEL alert. Used to delete an alert. ******************** 2692 NAME: ORQPTQ1 calls CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING calls TEAMPROV CLINICAL REMINDERS calls TEAMPTS GEN. MED. REC. - VITALS Calls TEAMS and TEAMPTS. KERNEL CLINICAL PROCEDURES MYHEALTHEVET added 9/15/08 HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** The Enterprise Health MGMT Platform (HMP) would like to subscribe to ICR 2692, ORQPTQ1 Calls in order to retrieve a list of patients for a specified list. Data returned is from the OE/RR List File (#100.21). USAGE: Controlled Subscri ENTERED: JAN 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ORQPTQ1 provides entry points to provide patient lists by providers, etc. This DBIA will include those calls being used by outside packages. ROUTINE: ORQPTQ1 COMPONENT: TEAMPROV(.ARRAY,TEAMIEN) VARIABLES: ARRAY Type: Output Return array as follows: ARRAY(#) = New Person IEN ^ New Person Name TEAMIEN Type: Input IEN of OE/RR LIST file (#100.21) Input an OE/RR team IEN and receive back an array of provides linked to the team. COMPONENT: TEAMS(.ARRAY) VARIABLES: ARRAY Type: Both Name of the array to return data in. Return array as follows: ARRAY(#) = FILE 100.21 IEN ^ FILE 100.21 NAME (.01) Input name of array and receive back all OE/RR LIST file (#100.21) IENS and names. If no entries in FILE 100.21, then return: ARRAY(1) = "^No teams found." COMPONENT: TEAMPTS(.ARRAY,TEAM) VARIABLES: ARRAY Type: Both Name of the array to return data in. Return array as follows: ARRAY(#) = DFN ^ FILE 2 NAME (.01) TEAM Type: Input IEN for a FILE 100.21 entry. Input name of array and OE/RR LIST file (#100.21) IEN. Receive back all patient DFNs and names associated with that FILE 100.21 entry. If no entries, then return: ARRAY(1) = "^No patients found." COMPONENT: TMSPT(ORY,PT) VARIABLES: ORY Type: Both The name of the array to return data in. Return array is as follows: ORY(#) = TEAM IEN ^ TEAM NAME ^ TEAM TYPE PT Type: Input IEN for FILE 2 entry. Input a patient DFN in PT to get a list TEAMS linked to a patient in variable ORY. ******************** 2693 NAME: TIULQ calls CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING LAB SERVICE SURGERY CLINICAL PROCEDURES ORDER ENTRY/RESULTS REPORTING VIRTUAL PATIENT RECORD Effective with VPR*1*0. HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JAN 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Entry points in this routine provide extract mechanisms for TIU records. ROUTINE: TIULQ COMPONENT: EXTRACT(TIUDA,TIUROOT,TIUERR,DR,TIULINE,TIUTEXT,FORMAT,OVRRIDE) VARIABLES: TIUDA Type: Input Internal entry number of note in TIU DOCUMENT file (#8925). [REQUIRED] TIUROOT Type: Input Root of the array in which data should be returned. [OPTIONAL] (set to "^TMP(""TIULQ"",$J)" if not defined on entry). TIUERR Type: Output Error message in format 1^message DR Type: Input List of field numbers to return values for. [OPTIONAL] (set to ".01:.1;1201:1701" if not defined on entry) TIULINE Type: Input Offset line number [OPTIONAL] TIUTEXT Type: Input 1 returns report text. [OPTIONAL] FORMAT Type: Input Set as input parameter for format as accepted by EN^DIQ1. [OPTIONAL] (set to "IE" if not defined on entry) OVRRIDE Type: Input Override ability of user to print record text. [OPTIONAL] Call to retrieve record and addenda ******************** 2694 NAME: TIURA1 calls CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CONSULT/REQUEST TRACKING Calls ADDEND1 only. USAGE: Controlled Subscri ENTERED: JAN 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls allowed to TIURA1. ROUTINE: TIURA1 COMPONENT: ADDEND1 VARIABLES: TIUDA Type: Input The IEN of the TIU DOCUMENT file (#8925) defining the note for which the addenda will be created. Provides call to interactively add an addenda to an existing TIU document. COMPONENT: SIGNER VARIABLES: IEN Type: Input IEN of TIU DOCUMENT file (#8925). Links a selected document to additional signers via user interaction (if user is allowed to assign additional signers). COMPONENT: $$CHARTONE VARIABLES: $$CHARTONE Type: Output 1 - document may be printed 0 - document may not be printed TIUDA Type: Input IEN of TIU DOCUMENT file (#8925) BOOLEAN extrinsic function. Evaluates whether a given document may be printed for the chart. ******************** 2695 NAME: DD AUDIT ACCESS CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: JAN 4,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DD(2,'AUDIT', DESCRIPTION: TYPE: File CIRN PD would like a DBIA for its direct global read of ^DD(2,"AUDIT". This direct global read is used to identify all of the top level PATIENT (#2) file fields that are currently marked for auditing. We realize this will not get subfile fields within the PATIENT (#2) and we are willing to disregard those fields in our report until an API is provided for all audited fields within the PATIENT (#2) file. ^DD(2,'AUDIT',D0) ROUTINE: ******************** 2696 NAME: RECOMPILATION OF PRINT TEMPLATES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION SCHEDULING USAGE: Controlled Subscri ENTERED: JAN 6,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: .4 ROOT: DIPT( DESCRIPTION: TYPE: File When installing a patch that includes changes to field definitions in a data dictionary, KIDS does not recompile the compiled print templates. Recompilation of print templates may involve the following steps: (1) Traverse the "AF" cross-reference of the ^DIPT global (file #.4) to obtain a list of compiled print templates for the affected fields. The structure of this cross-reference is ^DIPT("AF",file,field,template)="" Subfields would be treated like fields of their respective subfiles, i.e. ^DIPT("AF",subfile,subfield,template)="". (2) For each template that is being recompiled, access ^DIPT(template,"ROU") to determine the compiled routine. (3) Invoke EN^DIPZ to recompile that print template. ^DIPT(AF This cross-reference has the following structure: ^DIPT("AF",file,field,template)="" ^DIPT("AF",subfile,subfield,template)="" ^DIPT(D0,ROU) 1815 ROUTINE INVOKED ROU;E1,1 Direct Global Read & w ROUTINE: ******************** 2697 NAME: DBIA2697 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JAN 6,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 603.01 ROOT: YSCL(603.01 DESCRIPTION: TYPE: File The Outpatient and Inpatient Medications packages request permission for read access CLOZAPINE PATIENT LIST file (603.01). The packages also request read access to the ^YSCL(603.01,"B",$E(X,1,30),DA) and ^YSCL(603.01,"C",$E(X,1,30),DA) cross references. ^603.01 .01 CLOZAPINE REGISTRATI 0;1 Direct Global Read & w Clozapine Registration Number. Free Text. Read access to the cross reference: ^YSCL(603.01,"B",$E(X,1,30),DA) 1 CLOZAPINE PATIENT 0;2 Direct Global Read & w Clozapine Patient. Pointer to Patient file (#2). Read access to the cross reference: ^YSCL(603.01,"C",$E(X,1,30),DA) 2 DISPENSE FREQUENCY 0;3 Direct Global Read & w This filed identifies those patients that are eligible to get a 14 day supply of Clozapine medication. This is a file of patients authorized to receive Clozapine. This file is maintained by the National Clozapine Coordinating Center (NCCC) in Dallas. ROUTINE: ******************** 2698 NAME: Direct access to the Urgency File (101.42) CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING IMAGING RADIOLOGY/NUCLEAR MEDICINE Added 11/6/19 for access to NAME (.01 field of ORD(101.42,D0,0) global reference), effective with RA*5*161. USAGE: Private ENTERED: JAN 11,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.42 ROOT: ORD(101.42, DESCRIPTION: TYPE: File The Consults package uses the ORDER URGENCY file, 101.42 to convert the orders urgency to a protocol value. The Abbreviation field is used to determine which Protocol to use. The abbreviation is what is sent to Consults in an HL7 message. The use of the Protocol file for recording Urgency will be converted to using the ORDER URGENCY file in a future patch. Rather than storing the protocol pointer representing the Urgency, a pointer will be stored to the ORDER URGENCY file. Until the conversion, direct access is needed to the ABBREVIATION field in the ORDER URGENCY file. ^ORD(101.42,D0,0) .01 NAME Direct Global Read & w 2 ABBREVIATION Direct Global Read & w ROUTINE: ******************** 2699 NAME: Direct access to TIU(8925, CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JAN 11,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925, DESCRIPTION: TYPE: File TIU is used by the Consult package to store the signed notes resolving a Consult or Procedure request. Consults checks for the existing node in ^TIU(8925,D0,0) before calling TIU utilities. ^TIU(8925,D0,0) Zeroth node of the TIU Document file. ROUTINE: ******************** 2700 NAME: Direct access to the TIU CLASS file (8925.1) CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Private ENTERED: JAN 11,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: TIU(8925.1, DESCRIPTION: TYPE: File The Consults package uses the "B" cross-reference of the TIU Document Definition file (8925.1) to find the "CONSULTS" entry. The TYPE field, fourth piece of the zeroth node, of the consults entry is used to check for "CL" or "DC" (Class or Document Class Type). ^TIU(8925.1,'B','CONSULTS',D0 Lookup on "B" cross-reference for "CONSULTS" TIU Document Definition entry. ^TIU(8925.1,D0,0) .04 TYPE 0;4 Direct Global Read & w ROUTINE: ******************** 2701 NAME: MPIF001 CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 12,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Function APIs to return values on the MPI node in the Patient file. This DBIA documents some entry points for accessing the MPI node in the Patient file for use by the CIRN developers and others that may need this data. ROUTINE: MPIF001 COMPONENT: $$GETICN VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2) $$GETICN^MPIF001(DFN) This function returns the ICN, including checksum for a given DFN or -1^error message. COMPONENT: $$GETDFN VARIABLES: ICN Type: Input ICN - Integration Control Number (ICN) (not including checksum) for a given patient in the Patient file (#2). $$GETDFN^MPIF001(ICN) This function returns the IEN of the patient in the Patient file for a given ICN or -1^error message. COMPONENT: $$CMOR2 VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). $$CMOR2^MPIF001(DFN) This function returns the CMOR Site Name for a given DFN or -1^error message. COMPONENT: $$CMORNAME VARIABLES: CIEN Type: Input CIEN - IEN for entry in Institution file (#4). $$CMORNAME^MPIF001(CIEN) This function returns CMOR Site Name for a given Institution IEN or -1^error message. COMPONENT: $$GETVCCI VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). $$GETVCCI^MPIF001(DFN) This function returns CMOR Station Number for a given DFN or -1^error message. COMPONENT: $$IFLOCAL VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). $$IFLOCAL^MPIF001(DFN) This function is used to see if a patient has a Local ICN. Returning: 1 = patient has a Local ICN. 0 = patient does not exist, DFN is not defined or no MPI node OR Patient doesn't have a local ICN. COMPONENT: $$IFVCCI VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). $$IFVCCI^MPIF001(DFN) This function returns 1 if your facility is the CMOR for the given patient. Returning: 1 = your site is the CMOR. -1 = your site is NOT the CMOR. COMPONENT: $$HL7CMOR VARIABLES: DFN Type: Input DFN = IEN for patient in Patient file (#2). SEP Type: Input SEP = delimeter to separate station number and name. Not required. Defaults to ^ if not provided. $$HL7CMOR^MPIF001(DFN,SEP) This function returns the CMOR Station Number and Institution Name for a given patient. Returns: Station Number Institution Name or -1^error message. SEP defaults to ^ if not defined. COMPONENT: GETICN VARIABLES: See $$GETICN ******************** 2702 NAME: MPIFAPI CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 12,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Functions to return the MPI node, Subscriptioon Control Number from the MPI Node, the name of the HL7 Logical Link for the MPI and to return the next Local Integration Control Number. These APIs are provided for the CIRN developers and others that may need this data. ROUTINE: MPIFAPI COMPONENT: $$MPINODE VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). $$MPINODE^MPIFAPI(DFN) This function returns the MPI node for a given patient in the Patient file (#2). Returning: MPI node OR -1^error message. COMPONENT: $$SUBNUM VARIABLES: DFN Type: Input DFN = IEN of patient in the Patient file (#2). $$SUBNUM^MPIFAPI(DFN) This function returns the Subscription Control Number from the MPI node for a given patient in the Patient file (#2). Returns: Subscription Control Number OR -1^error message. COMPONENT: $$EN2 VARIABLES: $$EN2^MPIFAPI() This function creates and returns the next Local ICN (Integration Control Number) and ICN Checksum. Returns: ICN V ICN Checksum (no spaces). COMPONENT: $$MPILINK VARIABLES: This function returns the name of the MPI logical link from the HL Logical Link file. COMPONENT: GETADFN VARIABLES: ICN Type: Input This is the Integration Control Number that is being used to find a given patient. DFN Type: Output The IEN of the patient in the Patient (#2) file that currently has this ICN as the active ICN (stored in field 991.01). ICN is not found -1^error message is returned. This API will return the DFN for a given ICN ONLY if the ICN is the active ICN for a patient. ******************** 2703 NAME: $$CHANGE MPIF001 CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK REGISTRATION USAGE: Controlled Subscri ENTERED: JAN 12,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function updates the CIRN Master of Record (991.03) field in the Patient (#2) file on the MPI node. This is being provided for use by the CIRN developers. ROUTINE: MPIF001 COMPONENT: $$CHANGE VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2). VCCI Type: Input VCCI - IEN from the Institution file of the station that is to be the new CMOR. $$CHANGE^MPIF001(DFN,VCCI) This function updates the CIRN MASTER OF RECORD (#991.03) field in the Patient file (#2). Returning: 1 - successfully updated OR -1^error message - problem while updating. ******************** 2706 NAME: $$UPDATE MPIFAPI CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK REGISTRATION CORBA SERVICES USAGE: Controlled Subscri ENTERED: JAN 13,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API will allow the calling package to update the MPI node fields (991.01-991.05) in the Patient file (#2). This is being provided for the CIRN developers. ROUTINE: MPIFAPI COMPONENT: $$UPDATE VARIABLES: DFN Type: Input DFN - IEN of patient in the Patient file (#2). ARR Type: Input ARR - array of values for each field to be updated, where the subscript is the field number to be updated. $$UPDATE^MPIFAPI(DFN,ARR) This function update fields on the MPI node passed in ARR(field number) for a patient in the Patient file. Fields 991.01-991.05 only. Returning: -1^error message if unable to update fields OR 0 if successfully updated fields. ******************** 2707 NAME: MER MPIFMER CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JAN 13,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine will trigger the merge/change ICN message to be sent to the MPI and any sites subscribing to this patient via CIRN. This is being provided to the CIRN/DG developers to support the CIRN/MPI effort. ROUTINE: MPIFMER COMPONENT: MER VARIABLES: PDFN Type: Input DFN - IEN for patient in the Patient file (#2). OLD Type: Input OLD - the ICN value being replaced. ERROR Type: Both ERROR - is passed into the MER call by reference to return any error messages that may occur during the procedure. FLG Type: Input FLG - not required, if not defined is set to null. If the FLG field is not defined and your facility is not the CMOR, the change icn message will not be sent. MER^MPIFMER(PDFN,OLD,ERROR,FLG) this routine is triggered off a change to the Integration Control Number (991.01) field (ICN) in the Patient file (#2) when an old ICN, that is not a local ICN. It will create a Change/Merge ICN message to be sent to the MPI and CIRN subscribers for this patient. ******************** 2708 NAME: DELETE MPIFQ1 CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JAN 13,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine DELETE^MPIFQ1 is used to remove the entry in the Patient file that was just created. It is to be used when the direct connect to the MPI returned a list of patients that are potential matches and asked the user to select one. The user then selects as the match, a patient that is currently in the local Patient file. the Patient file entry that was just created would then be removed. This will only happen if the patient was just entered into the Patient file (#2). This is being supplied to support the MPI/CIRN effort. ROUTINE: MPIFQ1 COMPONENT: DELETE VARIABLES: DFN Type: Input DFN - IEN of patient in Patient file (#2) to be deleted. DELETE^MPIFQ1(DFN) - This line tag removes the stub Patient file entry that was just created (DFN), when the MPI returned a list of potnetial matches and the user selected a patient that is already in the local Patient file (#2). ******************** 2709 NAME: New Person file CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: APR 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200 DESCRIPTION: TYPE: File The Laboratory package is cleaning up a reference to the Person file (#16). We need read access only to the A16 cross reference of the New Person file (#200). This access is only for use with patch LR*5.2*237. ^VA(200,'A16' ROUTINE: ******************** 2710 NAME: CALC RGVCCMR2 CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA TOOLKIT REGISTRATION USAGE: Controlled Subscri ENTERED: JAN 13,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Function API to calculate the CIRN CMOR Activity Score for an individual patient. This is being provided for the MPI developers to allow for re-calculating the CIRN CMOR Activity Score during the CMOR Batch Comparision job. ROUTINE: RGVCCMR2 COMPONENT: CALC VARIABLES: RGDFN Type: Input RGDFN - IEN of the patient in the Patient file (#2). RGDFN is not passed as a formal parameter, but is defined before calling CALC. This entry point calculates the CIRN CMOR activity score for a given patient. The patient's ien from the Patient file is set in the variable RGDFN before making the call to CALC. The fields CMOR ACTIVITY SCORE (991.06) and SCORE CALCULATION DATE (991.07) in the Patient file (#2) are updated by CALC for patient RGDFN. ******************** 2711 NAME: DBIA2711 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: APR 28,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 58.8 ROOT: PSD(58.8 DESCRIPTION: TYPE: File This DBIA is to be used as an open agreement between Drug Accountability and Controlled Substances. The terms of this agreement are to allow Controlled Substances access to any field within the DRUG ACCOUNTABILITY STATS file (#58.8). The access method can be either Direct Read/Write access, or by using FileManager to obtain or create data. The reason for this agreement is that prior to the release of Version 3.0 of Drug Accountability, this file was the property of Controlled Substances. ROUTINE: ******************** 2712 NAME: DBIA2712 CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: JAN 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The function ISTERM offers an approved means of identifying whether a user is currently terminated, as supported by DBIA 10060, until such time as Kernel provides a comparable function. ROUTINE: USRLM COMPONENT: $$ISTERM(USER) VARIABLES: USER Type: Input This is the IEN of the user in question in file 200. This function evaluates whether the USER identified by the pointer to file 200 passed as its one required parameter is terminated at the time of the call. ******************** 2713 NAME: Consults calls to ORB3F1 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: JAN 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement will allow consults to call the following tag(s) in routine ORB3F1. ROUTINE: ORB3F1 COMPONENT: $$XQAKILL(ORN) VARIABLES: ORN Type: Input The IEN of the entry in the OE/RR NOTIFICATIONS denoting the notification being processed. This extrinsic function will return a 0 if a notification should be deleted for ALL recipients or a 1 if the notification should be deleted just for the current recipient (the one currently processing the alert). ******************** 2714 NAME: Input Template to CRIN Site Parameter 991.8 CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: JAN 19,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 991.8 ROOT: RGSITE(991.8, DESCRIPTION: TYPE: File MPIF is requesting to be able to create and utilize an input template to the CIRN Site Parameter file (#991.8) called MPIF SITE PARAMETERS to support in editing the CMOR Request related fields. ROUTINE: ******************** 2716 NAME: DG MST STATUS API'S CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of these API's is to facilitate the entry and retrieval of Military Sexual Trauma status information on veterans. The primary mechanism is within the Registration package, but data will be requested from, and eventually updated from Scheduling and Patient Care Encounters. VAH Directive 98-058 "Sexual Trauma Counseling Care and Services", provides the guidance on this data collection. ROUTINE: DGMSTAPI COMPONENT: $$NEWSTAT(DFN,DGSTAT,DGDATE,DGPROV,DGSITE,DGXMIT) VARIABLES: DFN Type: Input Internal entry number for patient in the PATIENT File (#2) DGSTAT Type: Input MST Status code, "Y,N,D,U" Y - Yes, Screened reports MST N - No, Screened does not report MST D - Screened, declines to answer U - Unknown, not screened DGDATE Type: Input Date of MST status change [Optional]. Defaults to NOW if parameter is NULL. DGPROV Type: Input Provider making MST status determiniation, pointer to ^VA(200) $$NEWSTAT Type: Output Returns either the IEN of the new file entry, or -1^error message if file update fails. DGXMIT Type: Input HL7 trasmit flag [Optonal]. 0 = don't queue a Z07 message. 1 = queue a Z07 message [Default]. DGSITE Type: Input Site Determining MST Status [Optional]. IEN pointer of the INSTITUTION file (#4) for a Station number. If this parameter is NULL, the current Primary Station number pointer to the INSTITUTION file (#4) will be filed. Will enter new or edited Military Sexual Trauma (MST) status data for a veteran into the MST HISTORY File (#29.11). This is an historical entry and will be added in addition to any previous entries. A verification check is made on the new or edited MST status entry before allowing any data to be filed to file (#29.11). If the verification check is successful and the DGXMIT variable equals a value of 1, an Enrollment Full Data Transmission (ORF/ORU~Z07) HL7 message will be triggered to the VistA Enrollment module for transmission to the Health Eligibility Center (HEC). The Internal Entry Number (IEN) of the new entry in File (#29.11) is returned if the entry was successful, else an error message is returned in the format: -1^error message. The HEC will transmit the new MST Status data to all sites of record for the patient via an Enrollment/Eligibility (ORF/ORU~Z11) HL7 message. No HL7 Z07 message will be triggered if the MST Status change event is the result of an update received from the HEC via an HL7 Z11 message. COMPONENT: $$GETSTAT(DFN,DGDATE) VARIABLES: DFN Type: Input IEN of patient in the PATIENT File (#2) DGDATE Type: Input Date to check MST status on, [Optional]. If not passed in, default of TODAY is used. $$GETSTAT Type: Output Piece 1 - IEN of entry in MST HISTORY File (#29.11) Piece 2 - Internal value of MST Staus ("Y,N,D,U") Piece 3 - Date of status change Piece 4 - IEN of provider making determination, NEW USER File (#200) Piece 5 - IEN of user who entered status, NEW USER File (#200) Piece 6 - External format of MST Status Piece 7 - IEN pointer of the INSTITUTION file (#4). If no MST history entry is found for the patient, a "0^U" will be returned. If an error occurred while retrieving the MST status, a "-1^^Error msg" will be returned. Entry point $$GETSTAT^DGMSTAPI(DFN,DGDATE) will return the current MST status for a patient from the MST HISTORY File (#29.11) AS OF THE DATE passed in as DGDATE. Any MST status entries after the date in DGDATE will be ignored. DGDATE is optional, if it is not passed in, a date of TODAY will be used. To return the most recent MST status for a patient, call GETSTAT^DGMSTAPI(DFN) only. ******************** 2718 NAME: Check TaskMan State CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: JAN 20,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSCH('WAIT') DESCRIPTION: TYPE: File FileMan KIDS Enviromental Check routines: DIENVWRN (Warn the installer, but allow the install to continue) and DIENVSTP (Stop the install) need to check TaskMan's enviroment to see if TaskMan is in a STOPed state or is in the "WAIT" state. There is a supported call to: $$TM^%ZTLOAD which returns whether or not TaskMan is running, but not if TaskMan is in a "WAIT" state. The following code is used in routines DIENVWRN and DIENVSTP to check for these conditions: TMCHK ; Check to see if TaskMan is still running S X=$$TM^%ZTLOAD I X,'$D(^%ZTSCH("WAIT")) D FileMan would like a temporary intergration agreement, with the Kernel, until such time as $$TM^%ZTLOAD can return all three conditions Running, Waiting, and Stopped. ROUTINE: ******************** 2719 NAME: Logons Inhibited CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: JAN 20,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZIS(14.5,'LOGON', DESCRIPTION: TYPE: File FileMan KIDS Enviromental Check routines: DIENVWRN (Warn the installer, but allow the install to continue) and DIENVSTP (Stop the install) need to check if Logons have been Inhibited and the following code is being used: LINH ; Check to see if Logons are Inhibited D GETENV^%ZOSV ; $P(Y,"^",2) = Installing Volume S X=+$G(^%ZIS(14.5,"LOGON",$P(Y,"^",2))) I 'X D Q ; Bail Out of Install FileMan would like a temporary intergration agreement, with the Kernel, until such time a single call can be developed that will return whether or not Logons have been Inhibited. ^%ZIS(14.5,'LOGON',) ROUTINE: ******************** 2722 NAME: DBIA2722 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: EVENT CAPTURE USAGE: Private ENTERED: JAN 21,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integration Agreement between PCE and EVENT CAPTURE for use of CLASS^PXBAPI21. After answering "No" to "Service Connected:", the user expects to see the prompt(s) for AO/IR/EC/CLV as appropriate for the patient (just as in Scheduling checkout), but these prompts are never seen for SC 50-100% vets. The reason being that Event Capture uses calls to SC^SDCO22, AO^SDCO22, EC^SDCO22, IR^SDCO22, and CLV^SDCO22 to determine which of the classification questions should be asked. (That takes place in ASKCLASS^ECUTL1 and GETCLASS^ECUTL1.) AO^SDCO22, EC^SDCO22, IR^SDCO22, and CLV^SDCO22 always return zero for an SC 50-100% vet -- therefore Event Capture never prompts for any of these classifications even though the encounter is not related to the patient's service connected disabilities. Looking into the Scheduling checkout functionality, it is CLASS^PXBAPI21 which allows this scenario to be properly handled (starting in INTV^PXAPI) -- it allows the user to answer AO/IR/EC/CLV for SC 50-100% vets after specifying that the encounter isn't service connected. Specifically, the call will be constructed as follows: N PBXDATA D NOW^%DTC S DATE=% D CLASS^PXBAPI21("",DFN,DATE,1,"") An example of user prompts for an SC 50-100% patient with exposure to AO, IR, EC, and CLV follows: --- Classification --- [Required] Was treatment for SC Condition? NO Was treatment related to Agent Orange Exposure? YES Was treatment related to Ionizing Radiation Exposure? YES Was treatment related to Environmental Contaminant Exposure? YES Was treatment related to Camp Lejeune Exposure? YES Data is returned as follows: PXBDATA(1)=0^1 <-- Agent Orange PXBDATA(2)=0^1 <-- Ionizing Radiation PXBDATA(3)=0^0 <-- Service Connected PXBDATA(4)=0^1 <-- Environmental Contaminants PXBDATA(5)=0^1 <-- Camp Lejeune where the 2nd piece indicates the user's answer to the classification prompt -- 0=NO, 1=YES ROUTINE: PXBAPI21 COMPONENT: CLASS VARIABLES: PXBOUTEN Type: Input EVENT CAPTURE will always set variable PXBOUTEN to null. PXBPAT Type: Input EVENT CAPTURE wil always place the internal entry number from the PATIENT file (#2) for the patient of interest into variable PXBPAT. PXBHLOC Type: Input EVENT CAPTURE will always set variable PXBHLOC to the value 1. PXBVST Type: Input EVENT CAPTURE will always set variable PXBVST to null. PXBVSTDT Type: Input EVENT CAPTURE will always place the current date/time in standard FileMan formart into variable PXBVSTDT. Subroutine with parameter list -- CLASS^PXBAPI21(PXBOUTEN,PXBPAT,PXBVSTDT,PXBHLOC,PXBVST) Prompts for patient encounter classifications for SC/AO/IR/EC/CLV. Results returned in local PXBDATA array. ******************** 2723 NAME: MAILBOX AND BASKET API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 25,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The APIs in this DBIA perform mailbox and basket actions. If any errors occur, the following variables will be defined: XMERR - The number of errors ^TMP("XMERR",$J,,"TEXT",)= Following is information on some common input parameters: XMDUZ - The user (DUZ or enough of the user's name, alias, initials, or nickname for a positive ID) for whom the API is being called. An FM lookup into the ^VA(200, NEW PERSON file will be performed. XMK - The basket (IEN or enough of its name for a positive ID) for which the API is being called. XMTROOT - (optional) The target root to receive the requested list. This quoted string must be a closed root. The node "XMLIST" will be added underneath it. This is an optional parameter. It defaults to ^TMP("XMLIST",$J). ROUTINE: XMXAPIB COMPONENT: CRE8MBOX VARIABLES: XMDUZ Type: Input The user for whom a mailbox should be created. User must already exist in ^VA(200,. See General Description for further information. XMDATE Type: Used (optional) Users who are being reinstated after not having worked here for a while may be restricted from seeing messages earlier than a certain date. If the user is a first-time user, then this parameter has no effect and shouldn't be used. Possible values: =0 or null (default) - The user may access any message on the system which was ever addressed to the user. =date - The user may not access any message addressed to the user on the system earlier than this date, unless it is already in the user's mailbox or if someone forwards it to the user. The date must be a FileMan date or any date format which FileMan recognizes. Create a mailbox for a user. That is, add the user to file ^XMB(3.7, MAILBOX. The user's IEN in this file is the same as the user's IEN in ^VA(200, NEW PERSON file, that is, the user's DUZ. Usage: D CRE8MBOX^XMXAPIB(XMDUZ,XMDATE) COMPONENT: FLTRMBOX VARIABLES: XMDUZ Type: Input See General Description. XMMSG Type: Output If filtering is completed successfully, contains the message, "Mailbox filtered". Filter all messages in a user's mailbox. Runs all messages in all baskets in the user's mailbox through any filters which may exist for the mailbox. Only the user or a surrogate may use this API. Usage: D FLTRMBOX^XMXAPIB(XMDUZ,.XMMSG) COMPONENT: QMBOX VARIABLES: XMDUZ Type: Input See General Description. XMMSG Type: Output String giving information on the user's new messages. If user has no new messages, string is 0 (zero). If user has new messages, string contains the following up-arrow delimited pieces of information: Piece 1: number of new messages in the mailbox Piece 2: does the user have priority mail (0=no; 1=yes) Piece 3: number of new messages in the IN basket Piece 4: date/time (FM format) that the last message was received Piece 5: have there been any new messages since the last time this API was called? (0=no; 1=yes) Query a mailbox for new messages. Only the user or a surrogate may use this API. Usage: D QMBOX^XMXAPIB(XMDUZ,.XMMSG) COMPONENT: TERMMBOX VARIABLES: XMDUZ Type: Input The user whose mailbox is to be terminated. User must still exist in ^VA(200,. See General Description for further information. Remove all traces of a user from MailMan globals. Only a Postmaster surrogate or XMMGR key holder may use this API. Usage: D TERMMBOX^XMXAPIB(XMDUZ) COMPONENT: CRE8BSKT VARIABLES: XMDUZ Type: Input The user for whom a basket is to be created. See General Description for more information. XMKN Type: Input The name of the basket to be created. It must be free text, from 2 to 30 characters. XMK Type: Output The IEN of the basket which was created. Create a basket. Only the user or a surrogate may use this API. If the user is SHARED,MAIL, then the surrogate must be a Postmaster surrogate or XMMGR key holder. Usage: D CRE8BSKT^XMXAPIB(XMDUZ,XMKN,.XMK) COMPONENT: DELBSKT VARIABLES: XMDUZ Type: Input The user for whom a basket is to be deleted. See General Description for more information. XMK Type: Input Basket to be deleted. See General Description for more information. XMFLAGS Type: Used (optional) Used to control processing. May contain any of the following: D - Delete this basket even if there are messages in it. Delete a basket. The special baskets (IN and WASTE) may not be deleted. Only empty baskets may be deleted, unless XMFLAGS contains "D". Only the user or a surrogate may use this API. If the user is SHARED,MAIL, then the surrogate must be a Postmaster surrogate or XMMGR key holder. Usage: D DELBSKT^XMXAPIB(XMDUZ,XMK,XMFLAGS) COMPONENT: FLTRBSKT VARIABLES: XMDUZ Type: Input The user whose basket is to be filtered. See General Description for more information. XMK Type: Input The basket to be filtered. See General Description for more information. XMMSG Type: Output If filtering is completed successfully, contains the message, "Basket filtered". Filter messages in a basket. Runs all messages in a basket through any filters which may exist for the mailbox. Only the user or a surrogate may use this API. If the user is SHARED,MAIL, then the surrogate must be a Postmaster surrogate or XMMGR key holder. Usage: D CRE8MBOX^XMXAPIB(XMDUZ,XMK,.XMMSG) COMPONENT: LISTBSKT VARIABLES: XMDUZ Type: Input The user for whom a basket list is to be compiled. See General Description for more information. XMFLAGS Type: Used (optional) Used to control processing. May be any combination of the following: B - Backwards alpha order (default is alpha order) N - List only those baskets with new messages. XMAMT Type: Used (optional) How many baskets should be in the list? Possible values: - This many. Upper case xref (under "BSKT") is NOT provided. * - All baskets (default). Upper case xref (under "BSKT") is provided. XMSTART Type: Both (optional) Provides a starting point from which to get the list. It is used to start the lister going. The calling routine does not need to set it. Default is to start with the lowest numbered basket IEN and to start, in each successive call, where the previous call left off. The lister will keep it updated from call to call. Note: This parameter is used if XMAMT is a number, and you intend to call this entry point repeatedly until there are no more baskets. XMPART Type: Used (optional) Get a list only of those baskets whose name starts with this string. XMTROOT Type: Used (optional) The target root to receive the message list. See General Description for more information. Get a list of baskets in a mailbox. Gets a list (similar in format to that produced by LIST^DIC) of a user's baskets, optionally restricting the list to only those baskets with new mail, and/or those baskets whose name starts with a certain string. Note: Regardless of the alphabetic order you request, lower-case names sort separately from upper-case names. Therefore, an all upper-case cross reference (under "BSKT") is provided if you do not limit the number of entries returned. Usage: D LISTBSKT^XMXAPIB(XMDUZ,XMFLAGS,XMAMT,.XMSTART,XMPART,XMTROOT) COMPONENT: LISTMSGS VARIABLES: XMDUZ Type: Input The user for whom a message list is to be compiled. See General Description for more information. XMK Type: Input The basket to look in. Possible values: IEN or name - look in this basket only * - look in all baskets ! - look in the Message file. XMFLDS Type: Used (optional) A string containing a list, separated by ';', of fields to retrieve. Default is none. Possible values include any combination of the following, separated by ';': (e.g., "SUBJ;DATE") BSKT - basket (default: ^) Optionally followed by ":" and I - for basket IEN only (no 2nd piece) X - adds basket name xref (If XMK="!", and the message is not in the user's mailbox, will be set to "0^* N/A *".) DATE - date sent (default:^
Optionally followed by ":" and I - for internal only (no 2nd piece) F - for FM date as the 2nd piece X - adds FM date xref FROM - message from (default: ^) Optionally followed by ":" and I - for internal only (no 2nd piece) X - adds external from xref LINE - number of lines in the message NEW - is the message new? (0=no; 1=yes; 2=yes, and priority, too) PRI - is the message priority? (0=no; 1=yes) READ - how much of the message has the user read? - has not read the message at all 0 - has read the message, but no responses - has read through this response RESP - how many responses does the message have? 0 - none - this many SEQN - sequence number in basket SUBJ - message subject (always external) Optionally followed by ":" and X - adds message subject xref XMFLAGS Type: Used (optional) Flags control processing. May be any combination of the following: B - backwards order (default is traverse forward) U - Ignore the file screen on file 3.9 so that all messages can be examined. (valid only if XMK="!" and the user possesses the XM SUPER SEARCH key) If XMK="!", the following flags are ignored: C - use basket C-xref (default is message IEN) N - new messages only (C flag ignored) P - new priority messages only (C, N flags ignored) XMAMT Type: Used (optional) How many messages should be returned? Possible values: - this many * - all (default) XMSTART Type: Both (optional) This may be used to start the lister going. The lister will keep it updated from call to call. This variable is usually used when XMAMT is set to a number, and multiple calls to this API may be required. This variable ensures that each successive call resumes where the previous call left off. (If XMK="!", FileMan handles XMSTART, and you should look at FM documentation for an explanation. Messing with XMSTART is not advised if XMK="!", unless you are sure you know what you're doing.) The following variables may updated, depending on how the API is called: XMSTART("XMK") - Start with this basket IEN (valid only if XMK="*"). Continues from there, with each successive call, to the end. (Default is to start with basket .5, the WASTE basket.) XMSTART("XMZ") - Start AFTER this message IEN (valid only if XMFLAGS'["C"). Continues from there, with each successive call, to the end. (Default is to start at the beginning (or end) of the basket.) XMSTART("XMKZ") - Start AFTER this message C-xref (valid only if XMFLAGS["C"). Continues from there, with each successive call, to the end. (Default is to start at the beginning (or end) of the basket.) XMCRIT Type: Used Get a list a messages in a mailbox or in the Message file. Gets a list (similar in format to that produced by LIST^DIC) of messages in one basket or all baskets, optionally based on certain criteria. Also can get a list of messages in the Message file which were sent to or by the user and are not necessarily still in the user's mailbox. The IENs of the messages (in the message file 3.9) are returned. Only the user or a surrogate may use this API. Also enables 'Super Search' of all messages in the message file, regardless of who sent them. This search should only be used in coordination with the site's ISO, and is intended to be used to gather evidence in cases such as EEO harassment. Only holders of the XM SUPER SEARCH key may use this capability. Usage: D LISTMSGS^XMXAPIB(XMDUZ,XMK,XMFLDS,XMFLAGS,XMAMT,.XMSTART,.XMCR IT,XMTROOT) COMPONENT: NAMEBSKT VARIABLES: XMDUZ Type: Input The user whose basket is to be renamed. See General Description for more information. XMK Type: Input The basket to be renamed. See General Description for more information. XMKN Type: Input The new name of the basket. It is free text, from 2 to 30 characters. Change the name of a basket. The IN and WASTE baskets may not be renamed. Only the user or a surrogate with 'write' privilege may use this API. If the user is SHARED,MAIL, then the surrogate must be a Postmaster surrogate or XMMGR key holder. Usage: D NAMEBSKT^XMXAPIB(XMDUZ,XMK,XMKN) COMPONENT: QBSKT VARIABLES: XMDUZ Type: Input The user whose basket is to be queried. See General Description for more information. XMK Type: Input The basket to be queried. See General Description for more information. XMMSG Type: Output String containing the following up-arrow-delimited pieces of information: Piece 1: basket IEN Piece 2: basket name Piece 3: number of messages in the basket Piece 4: number of new messages in the basket Get information about a basket. Only the user of a surrogate may use this API. Usage: D QBSKT^XMXAPIB(XMDUZ,XMK,.XMMSG) COMPONENT: RSEQBSKT VARIABLES: XMDUZ Type: Input The user whose basket messages are to be resequenced. See General Description for more information. XMK Type: Input The basket to be resequenced. See General Description for more information. XMMSG Type: Output If resequencing is completed successfully, string contains the message: "Resequenced from 1 to ". Resequence messages in a basket. Before any resequencing is done, a basket integrity check is performed, and any errors detected are corrected. Only the user or a surrogate may use this API. If the user is SHARED,MAIL, then the surrogate must be a Postmaster surrogate or XMMGR key holder. Usage: D RESEQBSKT^XMXAPIB(XMDUZ,XMK,.XMMSG) ******************** 2724 NAME: OR*2.5*49 EXPORTS LAB PARAMETERS CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 26,1999 STATUS: Active EXPIRES: DURATION: Next Version VERSION: OE/RR 2.5 FILE: ROOT: DESCRIPTION: TYPE: Other OR*2.5*49 sends out the following LR namespaced values for the PARAMETER DEFINITION file. These parameters were needed for part of the pre-CPRS setup activities. LR ASK URGENCY LR COLLECT FRIDAY LR COLLECT MONDAY LR COLLECT SATURDAY LR COLLECT SUNDAY LR COLLECT THURSDAY LR COLLECT TUESDAY LR COLLECT WEDNESDAY LR DEFAULT TYPE QUICK LR EXCEPTED LOCATIONS LR IGNORE HOLIDAYS LR MAX DAYS CONTINUOUS LR PHLEBOTOMY COLLECTION This is a one time request. ROUTINE: ******************** 2726 NAME: OE/RR calls GMPL1 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JAN 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine GMPL1. ROUTINE: GMPL1 COMPONENT: VERIFY VARIABLES: GMPIFN Type: Input IEN of PROBLEM file. VERIFY accepts a PROBLEM file (#9000011) IEN and records the user verifying the problem and the date/time of verification. Additionally, it maintains audit information and updates the DATE LAST MODIFIED field (#.03). ******************** 2727 NAME: OE/RR REFERENCES TO AUPNPROB CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING OE/RR and, in particular GUI CPRS, need to manually reference the PROBLEM LIST. DENTAL VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expires on 10/27/17 when HMP will be shutdown. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for sites to shut down the HMP application. HMP had temporary approval to ICR #2727 until 12/31/16. DE4685 was entered for HMP to modify their code to use the APIs in routine GMPLUTL2 (ICR #2741). However not all references were removed. Code in HMPDJ02 and HMPEVNT was out of scope for the defect. Remaining modifications may be part of HMP*2.0*4 which was not released prior to the shutdown of HMP. If HMP is reactivated, this ICR should be reviewed and a new expiration date discussed with the custodial package. USAGE: Controlled Subscri ENTERED: JAN 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File This DBIA documents OE/RR's use of the PROBLEM file (9000011). ^AUPNPROB(DA,0) .01 DIAGNOSIS 0;1 Direct Global Read & w .03 DATE LAST MODIFIED 0;3 Direct Global Read & w .12 STATUS 0;12 Direct Global R/W & w/ .13 DATE OF ONSET 0;13 Direct Global Read & w ^AUPNPROB(DA,1) 1.01 PROBLEM 1;1 Direct Global Read & w 1.02 CONDITION 1;2 Direct Global R/W & w/ 1.03 ENTERED BY 1;3 Direct Global Read & w 1.04 RECORDING PROVIDER 1;4 Direct Global Read & w 1.05 RESPONSIBLE PROVIDER 1;5 Direct Global Read & w 1.06 SERVICE 1;6 Direct Global Read & w 1.07 DATE RESOLVED 1;7 Direct Global Read & w 1.08 CLINIC 1;8 Direct Global Read & w 1.09 DATE RECORDED 1;9 Direct Global Read & w 1.1 SERVICE CONNECTED 1;10 Direct Global Read & w 1.11 AGENT ORANGE EXPOSUR 1;11 Direct Global Read & w 1.12 IONIZING RADIATION E 1;12 Direct Global Read & w 1.13 PERSIAN GULF EXPOSUR 1;13 Direct Global Read & w 1.14 PRIORITY 1;14 Direct Global Read & w 1.15 HEAD AND/OR NECK CAN 1;15 Direct Global Read & w 1.16 MILITARY SEXUAL TRAU 1;16 Direct Global Read & w ^AUPNPROB(DA(2),11,DA(1),11,DA,0) .04 STATUS 0;4 Direct Global Read & w .03 NOTE NARRATIVE 0;3 Direct Global Read & w ^AUPNPROB(DA(2),11,DA(1),11,'B' Traverses through B index of NOTE multiple to get NOTE NARRATIVE ^AUPNPROB('ACTIVE',DFN,STATUS Traverses through ACTIVE x-ref for patient and status. ^AUPNPROB(DA,10) 11 COMMENT 10;1 Direct Global Read & w 12 LAST EDITED 10;2 Direct Global Read & w 13 BY WHOM 10;3 Direct Global Read & w ROUTINE: ******************** 2728 NAME: USER ENVIRONMENT API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Create the MailMan environment in which the user will operate while in MailMan. Set up the user's XMV array, which contains vital user information, user preferences, and, if the user is a surrogate, the user's level of authorization. The information in this array is used throughout MailMan. If any errors occur, the following variables will be defined: XMERR - the number of errors ^TMP("XMERR",$J,,"TEXT",)= ROUTINE: XMVVITAE COMPONENT: INIT VARIABLES: DUZ Type: Input Set by KERNEL when the user logs in to the system, it is a unique user ID, and the IEN for the user in the NEW PERSON file. It is also the IEN for the user in the MAILBOX file. XMDUZ Type: Both (optional) If the user (as identified by DUZ) is acting as a surrogate for another user, XMDUZ should be set by the calling routine to the DUZ of the other user. If XMDUZ is not set by the calling routine, it is assumed that the user is acting for himself, and XMDUZ will be set to DUZ (default) by this routine. XMDISPI Type: Output String containing two up-arrow-delimited pieces of information: Piece 1: Any combination of the following: A - Ask basket, if user sends message to self I - Show institution T - Show title Piece 2: One of the following IN basket message action defaults: I - Ignore the message D - Delete the message NOTE: MailMan does not use this variable, as it duplicates information provided in XMV. XMDUN Type: Output Provides same information as XMV("NAME"). NOTE: MailMan does not use this variable, as it duplicates information provided in XMV. XMNOSEND Type: Output =1, if XMV("NOSEND")=1. Otherwise, not defined. NOTE: MailMan does not use this variable, as it duplicates information provided in XMV. XMPRIV Type: Output If the user is acting as a surrogate, then this string contains two pieces of up-arrow-delimited information, concerning the user's privileges: Piece 1: Does the user have read privilege? y - Yes n - No Piece 2: Does the user have send privilege? y - Yes n - No If the user is acting as a surrogate, then this variable is defined. Otherwise, it isn't. NOTE: MailMan does not use this variable, as it duplicates information provided in XMV. XMV Type: Output An array of values defining the user's MailMan environment, giving information about the user, the user's MailMan preferences, and, if the user's acting as a surrogate, what privileges the user has. The information in this array is used throughout MailMan. The following items will always be set: XMV("ASK BASKET") If user sends a message to himself, should MailMan ask, "which basket?" (0=yes; 1=no) XMV("DUZ NAME") The user's name. (DUZ) XMV("LAST USE") String, in external format, showing when was the last time the user entered MailMan, and if it was a surrogate, which one. If the user never entered MailMan, the string will be "Never". (XMDUZ) XMV("MSG DEF") The default action for a message in the IN basket (I=ignore; D=delete). (DUZ) XMV("NAME") The user's name. (XMDUZ) XMV("NETNAME") The user's network name. (XMDUZ) XMV("NEW MSGS") The number of new messages in the user's mailbox. (XMDUZ) XMV("NOSEND") May the user send messages in this session? (1=no; 0=yes) The user may not send messages in any but the first of multiple concurrent sessions. (XMDUZ) XMV("ORDER") Display the user's messages in which order? (-1=reverse; 1=forward) (DUZ) XMV("PREVU") In the Classic reader, should message previews be displayed? (0=no; 1=yes) (DUZ) XMV("RDR ASK") Ask the user which message reader to use? (N=no; Y=yes) (DUZ) XMV("RDR DEF") User's default message reader (C=classic; D=detailed full screen; S=summary full screen) (DUZ) XMV("SHOW DUZ") Show user's DUZ? (0=no; 1=yes) (site) XMV("SHOW INST") Show user's institution? (0=no; 1=yes) (site) XMV("SHOW TITL") Show user's title? (0=no; 1=yes) (DUZ) XMV("VERSION") What version of MailMan is at this site? "VA MailMan "_version # (site) The following items will be set only if conditions warrant: XMV("BANNER") The user's banner, if one exists; otherwise not defined. (XMDUZ) XMV("ERROR",1) "You do not have a DUZ" if '$D(DUZ). XMV("ERROR",2) "There is no person with DUZ "_XMDUZ_"." if bogus XMDUZ. XMV("ERROR",3) "There is no Access Code for DUZ "_XMDUZ_"." XMV("ERROR",4) "There is no Mailbox for DUZ "_XMDUZ_"." XMV("PRIV") If user is acting as a surrogate, contains the user's privilege(s). Any or all of the following: R - read W - write (send) XMV("SYSERR",i) If Domain incorrectly set up, contains text. (site) XMV("WARNING",1) "Priority Mail" if user has priority mail (XMDUZ) XMV("WARNING",2) "Message in Buffer" (XMDUZ) XMV("WARNING",3) "No Introduction" if user has no intro, but site requires one. (XMDUZ) XMV("WARNING",4) "Multiple Signon" if user is in MailMan in more than one session. (XMDUZ) XMV("WARNING",5) "POSTMASTER has "_I_" baskets." if more than 900 (Only if XMDUZ=.5) Set up the user's MailMan environment in array XMV, which contains vital user information, user preferences, and, if the user is a surrogate, the user's level of authorization. This entry point is meant to be called once, upon entry into MailMan. It should not be used at any other time. Many of the MailMan APIs assume that the information provided by this routine exists. They may abort if it doesn't. Usage: D INIT^XMVVITAE COMPONENT: OTHER VARIABLES: XMV Type: Output An array of values giving information about the user for whom the user is acting as a surrogate. Also specifies what surrogate privileges the user has. The information in this array is used throughout MailMan. The following items will always be set, as they pertain to the user for whom the user is acting as a surrogate. Please see entry INIT for a description of the variables. XMV("LAST USE") XMV("NAME") XMV("NETNAME") XMV("NEW MSGS") XMV("NOSEND") XMV("PRIV") The following items will be set only if conditions warrant: XMV("BANNER") XMV("ERROR",1) XMV("ERROR",2) XMV("ERROR",3) XMV("ERROR",4) XMV("WARNING",1) XMV("WARNING",2) XMV("WARNING",3) XMV("WARNING",4) XMV("WARNING",5) XMDUZ Type: Both OTHER^XMVVITAE is specifically designed for becoming a surrogate. Therefore, XMDUZ must be the DUZ of the user to become. It follows that XMDUZ should not equal DUZ. See the variable description for entry INIT for further information. DUZ Type: Input See the variable description for entry INIT. XMDUN Type: Output See the variable description for entry INIT. XMNOSEND Type: Output See the variable description for entry INIT. XMPRIV Type: Output See the variable description for entry INIT. Set up MailMan user environment when user becomes a surrogate. INIT^XMVVITAE should already have been called. If the XMV variable does not exist, control will be passed to INIT^XMVVITAE, instead. Usage: D OTHER^XMVVITAE COMPONENT: SELF VARIABLES: DUZ Type: Input See the variable description for entry INIT. XMDUZ Type: Output XMDUZ will be set equal to DUZ, as the first step in returning the user to his own identity. XMDUN Type: Output See the variable description for entry INIT. XMNOSEND Type: Output See the variable description for entry INIT. XMV Type: Output An array of values defining the user and the user's MailMan environment. The information in this array is used throughout MailMan. The following items will always be set. Please see entry INIT for a description of the variables. XMV("NAME") XMV("NETNAME") XMV("NEW MSGS") XMV("NOSEND") The following items will be set only if conditions warrant: XMV("BANNER") XMV("ERROR",1) XMV("ERROR",2) XMV("ERROR",3) XMV("ERROR",4) XMV("WARNING",1) XMV("WARNING",2) XMV("WARNING",3) XMV("WARNING",4) XMV("WARNING",5) Return to the user's own MailMan user environment after having finished acting as a surrogate. Usage: D SELF^XMVVITAE ******************** 2729 NAME: MESSAGE ACTION API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The APIs in this DBIA perform message actions. They are designed to be used individually or incorporated into a MailMan front end. For usage instructions, please refer to the Programmer Manual, available at the Infrastructure web site. When used as part of a MailMan front end, INIT^XMVVITAE should be called to create the MailMan environment in which the user will operate. Please see DBIA 2728 for information on the XMVVITAE APIs. When used individually, from a routine, the XMVVITAE APIs should not be called. After every API call, the calling routine should check for the existence of XMERR. If any errors occur, the following variables will be defined: XMERR - the number of errors ^TMP("XMERR",$J,,"TEXT",)= Parameter definitions: XMDUZ User's DUZ or enough of the name for a positive ID. XMINSTR (optional) Array of special instructions ("ADDR FLAGS") Special addressing instructions, any or all of the following: I Do not Initialize (kill) the ^TMP addressee global, because it already contains addressees for this message, as a result of a previous call to an API. R Do not Restrict message addressing: - Ignore 'domain closed' - Ignore 'keys required for domain' - Ignore 'may not forward to domain' - Ignore 'may not forward priority mail to groups' - Ignore 'message length restrictions to remote addressees' X Do not create the ^TMP addressee global, because addressees are only being checked for validity. ("FLAGS") Message is any or all of the following: P Priority I Information only (may not be replied to) X Closed message (may not be forwarded) C Confidential message (surrogate may not read) S Send to sender (make sender a recipient) R Confirm receipt (return receipt requested) ("FROM") String saying who the message is from (default is user, as identified by XMDUZ parameter). This string is placed in field 1 'from' in the message file. Must not be any real person, except for Postmaster. DUZ is not captured in field 1.1 'sender' of message file, thus making this option well-suited for messages from VISTA packages. ("FWD BY") String saying who forwarded the message (default is user, as identified by XMDUZ parameter). This string is placed in field 8 'forwarded by' in the recipient multiple of the message file. Must not be any real person, except for Postmaster. DUZ is not captured in field 8.01 'forwarded by (xmduz)' in the recipient multiple of message file, thus making this option well-suited for messages forwarded by VISTA packages. ("HDR") Print the messages with a header? (0=no; 1=yes) Default is yes. ("LATER") Date/time (any format understood by FM) on which to send this message. Default is now. ("NET REPLY") Should reply be sent over the network? (0=no; 1=yes) Default is no. Currently valid only if sender of original message is remote. ("NET SUBJ") Subject of reply to be sent over the network. Default is "Re: ". Ignored unless XMINSTR("NET REPLY")=1. ("RCPT BSKT") Basket to deliver to for all recipients. Default is IN basket. Recipients must have specified in their personal preferences that such targeted basket delivery is allowed. Otherwise, this option is ignored. ("RECIPS") Print recipients along with the message? 0 No (default) 1 Print summary recipients 2 Print detailed recipients ("RESPS") Print which responses? * Original message and all responses (default) 0 Original message only range list (e.g. 0-3,5,7-99) - Print this range of responses. Ignored if more than one message is printed. This parameter is not checked. It must be correct. Range list may also be open-ended (e.g. 1,2,5- means print responses 1 and 2 and responses 5 to the end). ("SCR KEY") Scramble key (implies that message should be scrambled). Must be 3-20 characters long. ("SCR HINT") Hint for scramble key (mandatory if message is to be scrambled). Must be 1-40 characters long. ("SELF BSKT") Basket to deliver to if sender is recipient. Default is IN basket. ("SHARE BSKT") Basket to deliver to if SHARED,MAIL is recipient. Default is IN basket. ("SHARE DATE") Date/time (any format understood by FM) to delete this message from SHARED,MAIL if SHARED,MAIL is recipient. ("STRIP") String containing characters to strip from the message text (XMBODY). Must be 1-20 characters long. ("TO PROMPT") During interactive message addressing, contains the suggested initial addressee. Default is the user identified by XMDUZ. ("TYPE") Message type is one of the following special types: D Document S Spooled Document X DIFROM O ODIF B BLOB (reserved for future use) K KIDS ("VAPOR") Date/time (any format understood by FM) on which to delete (vaporize) this message from recipient baskets. Recipients may override this date. Also used to set vaporize date/time for messages already in one's own baskets. ("WHEN") Date/time (any format understood by FM) on which to print messages. Default is now. [.]XMTO Addressee or addressee array (if array, must be passed by reference). May be or contain any of the following: User's DUZ, or enough of user's name for a positive ID eg: 1301 or "lastname,firs" or ARRAY(1301)="" ARRAY("lastname,firs")="" G.group name (enough for positive ID) S.server name (enough for positive ID) D.device name (enough for positive ID) You may prefix each addressee (except devices and servers) by: I: for 'information only' recipient (may not reply) eg: "I:1301" or "I:lastname,firs" C: for 'copy' recipient (not expected to reply) eg: "C:1301" or "C:lastname,firs" L@datetime: for when (in future) to send to this recipient (datetime may be anything accepted by FM) eg: "L@25 DEC@0500:1301" or "L@1 JAN:lastname,firs" or "L@2981225.05:1301" (may combine IL@datetime: or CL@datetime:) To delete recipient, prefix with - eg: -1301 or "-lastname,firs" Append "@" for any addressees at another site: eg: "I:G.group@site.med.va.gov" or "JOE,USER@site.med.va.gov" XMK and XMKZ for APIs which act on one message: XMK (optional, depending on XMKZ) Basket (IEN or name) containing the message. XMKZ Identifies the message. Must be one of the following: Message number (XMZ) in Message global (XMK must not be specified) Message number in the basket (XMK must be specified) XMK and XMKZA for APIs which act on groups of messages: XMK (optional, depending on XMKZA) Basket (IEN or name) containing the messages. XMKZA Identifies messages, using a list or list array, which may end in a comma. Must be one of the following: Message numbers (XMZ) in Message global (XMK must not be specified, AND ranges are not allowed): - List: "1234567" or "1234567,9763213" - List array: ARRAY(1234567)="" ARRAY(9763213)="" Message numbers in the basket (XMK must be specified, ranges are OK): - List: "1" or "1,3,5-7" - List array: ARRAY("1,3")="" ARRAY("5-7")="" ROUTINE: XMXAPI COMPONENT: ADDRNSND VARIABLES: XMDUZ Type: Input The user who is sending the message. See the General Description for more information. XMZ Type: Input Message IEN in the message file. XMTO Type: Input Addressee or array of addressees to whom to send the message. See the General Description for more information. XMINSTR Type: Used (optional) Array of special instructions for the message. Any or all of the following array items may be defined. See the General Description for more information on them. XMINSTR("ADDR FLAGS") Addressing instructions (I and/or R are appropriate, but X is not) XMINSTR("FLAGS") Special handling instructions XMINSTR("FROM") Make this the sender, instead of XMDUZ XMINSTR("LATER") Send later XMINSTR("RCPT BSKT") Delivery basket XMINSTR("SCR HINT") Scramble hint XMINSTR("SCR KEY") Scramble key XMINSTR("SELF BSKT") Sender delivery basket XMINSTR("SHARE BSKT") SHARED,MAIL delivery basket XMINSTR("SHARE DATE") SHARED,MAIL delete date XMINSTR("TYPE") Message type XMINSTR("VAPOR") Message delete date Address a message, add the sender and any special instructions, and send it. The message stub must have already been created, using, for instance, CRE8XMZ^XMXAPI (see elsewhere in this DBIA), and the text must already have been added to the message, using, for instance, TEXT^XMXEDIT (DBIA 2730). Usage: D ADDRNSND^XMXAPI(XMDUZ,XMZ,.XMTO,.XMINSTR) or D ADDRNSND^XMXAPI(XMDUZ,XMZ,XMTO,.XMINSTR) COMPONENT: ANSRMSG VARIABLES: XMDUZ Type: Input The user who is answering the message. See the General Description for more information. Answer a message. COMPONENT: CRE8XMZ VARIABLES: Create a message stub. COMPONENT: DELMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be deleted. See the General Description for more information. Delete one or more messages from a user's mailbox. COMPONENT: FLTRMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be filtered. See the General Description for more information. Filter one or more messages to a user's mailbox. COMPONENT: FWDMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be forwarded. See the General Description for more information. Forward message(s). COMPONENT: LATERMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be latered. See the General Description for more information. Later message(s). COMPONENT: MOVEMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be moved (saved). Move (save) message(s) to a basket. COMPONENT: PRTMSG VARIABLES: XMDUZ Type: Input The user whose messages are to be printed. See the General Description for more information. Print message(s). COMPONENT: PUTSERV VARIABLES: Put one message into a server basket. COMPONENT: REPLYMSG VARIABLES: XMDUZ Type: Input The user who is replying to a message. See the General Description for more information. Reply to a message. COMPONENT: SENDBULL VARIABLES: XMDUZ Type: Input The user who is sending the bulletin. See the General Description for more information. Send a bulletin message. COMPONENT: SENDMSG VARIABLES: XMDUZ Type: Input The user who is sending the message. See the General Description for more information. Send a message. COMPONENT: TASKBULL VARIABLES: XMDUZ Type: Input The user who is tasking the bulletin. See the General Description for more information. Task the sending of a bulletin for later. COMPONENT: TERMMSG VARIABLES: XMDUZ Type: Input The user whose messages are being terminated. See the General Description for more information. Terminate message(s). COMPONENT: TOWHOM VARIABLES: Check one addressee while addressing a message. COMPONENT: VSUBJ VARIABLES: Check a subject to make sure it's valid. COMPONENT: ZAPSERV VARIABLES: Delete one message from a server basket. COMPONENT: NTOGLMSG VARIABLES: Toggle message(s) new or not new. COMPONENT: VAPORMSG VARIABLES: Set (schedule) Vaporize date/time for message(s) in one's basket(s) to be automatically deleted. ******************** 2730 NAME: MESSAGE EDIT API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs are intended for use by MailMan front ends. They edit different parts of a message. They may only be used by the message sender, and, with the exception of INFO^XMXEDIT, may only be used before the message has been sent to anyone besides the sender. The APIs do not contain any checks to ensure that it was appropriate to call them. That is the responsibility of the calling routine. For these APIs, it is expected that: INIT^XMVVITAE has been called to set up the user's XMV array, with vital user information, user preferences, and, if the user is a surrogate, determine level of authorization. See DBIA 2728 for information on INIT^XMVVITAE. The calling routine has determined that the user is authorized to see the message. If the message is in the user's mailbox, then that's enough. Otherwise, $$ACCESS^XMXSEC should be used to determine authorization. See DBIA 2731 for information on $$ACCESS^XMXSEC. OPTMSG^XMXSEC2 has been called and has given its permission to edit the message or to toggle information only. (Note: $$EDIT^XMXSEC2 will also let you know whether the user may edit the message.) See DBIA 2733 for information on OPTMSG^XMXSEC2A and $$EDIT^XMXSEC2. OPTEDIT^XMXSEC2 has been called and has given its permission to edit the particular thing we are editing here. See DBIA 2733 for information on OPTEDIT^XMXSEC2. INMSG2^XMXUTIL2 has been called to set XMINSTR. These routines expect that XMINSTR has been correctly set. They will change XMINSTR according to the item being edited. See DBIA 2736 for information on INMSG2^XMXUTIL2. ROUTINE: XMXEDIT COMPONENT: CLOSED VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Both If the message is closed (XMINSTR("FLAGS")["X"), then make the message not closed: - Delete field 1.95 of the message in the Message file. - Remove the "X" from XMINSTR("FLAGS"). If the message is not closed (XMINSTR("FLAGS")'["X"), then make the message closed: - Set field 1.95 of the message in the Message file. - Append an "X" to XMINSTR("FLAGS"). XMMSG Type: Output An appropriate message, suitable for display to the user. Either "'Closed' flag removed" or "Message flagged 'Closed'". Toggle a message's 'closed' flag. The flag is toggled in field 1.95 of the message in the Message file, as well as in the parameter XMINSTR("FLAGS"). See the general description for important information. When a message is closed, it may not be forwarded by anyone, except the person who sent it. Note that messages addressed to SHARED,MAIL may not be closed. If a message is in the process of being addressed to SHARED, MAIL, and this API is called, XMERR and ^TMP("XMERR",$J) will be set. The calling routine should always check for $D(XMERR) after calling this API. Usage: D CLOSED^XMXEDIT(XMZ,.XMINSTR,.XMMSG) COMPONENT: CONFID VARIABLES: XMMSG Type: Output An appropriate message, suitable for display to the user. Either "'Confidential' flag removed" or "Message flagged 'Confidential'". XMINSTR Type: Both If the message is confidential (XMINSTR("FLAGS")["C"), then make the message not confidential: - Delete field 1.96 of the message in the Message file. - Remove the "C" from XMINSTR("FLAGS"). If the message is not confidential (XMINSTR("FLAGS")'["C"), then make the message confidential: - Set field 1.96 of the message in the Message file. - Append a "C" to XMINSTR("FLAGS"). XMZ Type: Input Message IEN in the MESSAGE file. Toggle a message's 'confidential' flag. The flag is toggled in field 1.96 in the Message file, as well as in the parameter XMINSTR("FLAGS"). See the general description for important information. When a message is confidential, it may not be read by a surrogate. Note that messages addressed to SHARED,MAIL may not be confidential. If a message is in the process of being addressed to SHARED, MAIL, and this API is called, XMERR and ^TMP("XMERR",$J) will be set. The calling routine should always check for $D(XMERR) after calling this API. Usage: D CONFID^XMXEDIT(XMZ,.XMINSTR,.XMMSG) COMPONENT: CONFIRM VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Both If the message is 'confirm receipt requested' (XMINSTR("FLAGS")["R"), then make the message not 'confirm receipt requested': - Delete field 1.3 of the message in the Message file. - Remove the "R" from XMINSTR("FLAGS"). If the message is not 'confirm receipt requested' (XMINSTR("FLAGS")'["R"), then make the message 'confirm receipt requested': - Set field 1.3 of the message in the Message file. - Append an "R" to XMINSTR("FLAGS"). XMMSG Type: Output An appropriate message, suitable for display to the user. Either "'Confirm Receipt Requested' flag removed" or "Message flagged 'Confirm Receipt Requested'". Toggle a message's 'confirm receipt requested' flag. The flag is toggled in field 1.3 of the message in the Message file, as well as in the parameter XMINSTR("FLAGS"). See the general description for important information. When a message is flagged 'confirm receipt requested', the first time each recipient reads the message, a message will be sent to the sender of the message informing the sender that the recipient has seen the message. Usage: D CONFIRM^XMXEDIT(XMZ,.XMINSTR,.XMMSG) COMPONENT: DELIVER VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. BASKET Type: Input Full name of the basket to which the message should be delivered. It must be a valid basket name. (Free text, 2-30 characters.) This API does not check to ensure that the basket name is valid. That is the responsibility of the calling routine. If BASKET="@", field 21 of the message in the Message file is deleted, and XMINSTR("RCPT BSKT") is killed. Otherwise, field 21 of the message in the Message file and XMINSTR("RCPT BSKT") are set to BASKET. XMINSTR Type: Output If BASKET="@", field 21 of the message in the Message file is deleted, and XMINSTR("RCPT BSKT") is killed. Otherwise, field 21 of the message in the Message file and XMINSTR("RCPT BSKT") are set to BASKET. XMMSG Type: Output An appropriate message, suitable for display to the user. Either "Delivery basket set" or "Delivery basket removed". Set or delete a message's 'delivery basket' in field 21 of the message in the Message file, as well as in the parameter XMINSTR("RCPT BSKT"). See the general description for important information. When a message specifies a delivery basket, it will be delivered to that basket for each recipient, as long as the recipient has allowed such targeted delivery (by so indicating under User Preferences). If the recipient does not allow such targeted delivery, then the message is delivered as usual. Usage: D DELIVER^XMXEDIT(XMZ,BASKET,.XMINSTR,.XMMSG) COMPONENT: INFO VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Both If the message is 'information only' (XMINSTR("FLAGS")["I"), then make the message not 'information only': - Delete field 1.97 of the message in the Message file. - Remove the "I" from XMINSTR("FLAGS"). If the message is not 'information only' (XMINSTR("FLAGS")'["I"), then make the message 'information only': - Set field 1.97 of the message in the Message file. - Append an "I" to XMINSTR("FLAGS"). XMMSG Type: Output An appropriate message, suitable for display to the user. Either "'Information only' flag removed" or "Message flagged 'Information only'". Toggle a message's 'Information only' flag. The flag is toggled in field 1.97 of the message in the Message file, as well as in the parameter XMINSTR("FLAGS"). See the general description for important information. When a message is flagged 'Information only', no one may reply to the message, except for the sender. Note that unlike the other APIs in this DBIA, this API may be used by the sender at any time to toggle the 'Information only' flag, even after the message has been sent to other users. Usage: D INFO^XMXEDIT(XMZ,.XMINSTR,.XMMSG) COMPONENT: PRIORITY VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Both If the message is priority (XMINSTR("FLAGS")["P"), then make the message not priority: - Remove the priority indicator from field 1.7 of the message in the Message file. (The parameter XMINSTR("TYPE") is used here.) - Remove the "P" from XMINSTR("FLAGS"). If the message is not priority (XMINSTR("FLAGS")'["P"), then make the message priority: - Add the priority indicator to field 1.7 of the message in the Message file. (The parameter XMINSTR("TYPE") is used here.) - Append a "P" to XMINSTR("FLAGS"). XMMSG Type: Output An appropriate message, suitable for display to the user. Either "'Priority' flag removed" or "Message flagged 'Priority'". Toggle a message's 'priority' flag. The flag is toggled in field 1.7 of the message in the Message file, as well as in the parameter XMINSTR("FLAGS"). See the general description for important information. When a message is priority, it is delivered normally, but each recipient is alerted to it at logon or when it is delivered, and, when reading new messages, priority messages are displayed first. In a message list, priority messages are marked by an "!". Usage: D PRIORITY^XMXEDIT(XMZ,.XMINSTR,.XMMSG) COMPONENT: SUBJ VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMSUBJ Type: Input New subject of the message. The subject must be valid. It must be 3-65 characters. It may also be null. It is the responsibility of the calling routine to ensure that the subject is valid. You may use the API VSUBJ^XMXAPI (DBIA 2729) to validate a subject. XMIM Type: Output XMIM("SUBJ") is set to the new message subject. Change the message subject. If the subject is null, the subject is set to "* No Subject *". If the subject is "* No Subject *", and the message is sent to a remote site, the subject in the "SUBJECT:" header record will be null. The subject is set in field .01 of the message in the Message file, as well as in the parameter XMIM("SUBJ"). See the general description for important information. Usage: D SUBJ^XMXEDIT(XMZ,XMSUBJ,.XMIM) COMPONENT: TEXT VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMBODY Type: Input The closed root of the array that contains the word processing data to be filed. The array itself must be in a format acceptable to FileMan's WP^DIE API. It is the responsibility of the calling routine to ensure that the root is correctly passed in and that the array itself is correctly formatted. This API does not check it. Replace the text in field 3 of the message in the Message file. Usage: D TEXT^XMXEDIT(XMZ,XMBODY) COMPONENT: VAPOR VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMVAPOR Type: Input Vaporize date/time. Must be in internal FileMan format. This API does not check to ensure that the date/time is valid. That is the responsibility of the calling routine. If XMVAPOR="@", field 1.6 of the message in the Message file is deleted, and XMINSTR("VAPOR") is killed. Otherwise, field 1.6 of the message in the Message file and XMINSTR("VAPOR") are set to XMVAPOR. XMINSTR Type: Output If XMVAPOR="@", field 1.6 of the message in the Message file is deleted, and XMINSTR("VAPOR") is killed. Otherwise, field 1.6 of the message in the Message file and XMINSTR("VAPOR") are set to XMVAPOR. XMMSG Type: Output An appropriate message, suitable for display to the user. Either "Vaporize Date set" or "Vaporize Date removed". Set or delete a message's 'vaporize date' in field 1.6 of the message in the Message file, as well as in the parameter XMINSTR("VAPOR"). See the general description for important information. When a message specifies a vaporize date, that date will be set in the Mailbox file for each recipient in field 5 of the message record in the message multiple of the basket to which the message is delivered as the message is delivered to each recipient. This holds true even when the message is forwarded. The vaporize date (from field 5 of the basket message multiple in the Mailbox file) is displayed to the recipient every time the recipient reads the message. Each recipient is free to delete or change the vaporize date (field 5...) of the message in his or her mailbox. Messages with vaporize dates in the user's mailbox are deleted from the user's mailbox when the vaporize date arrives. Usage: D VAPOR^XMXEDIT(XMZ,XMVAPOR,.XMINSTR,.XMMSG) Note that this API does not edit the message vaporize date in a user's basket. Use KVAPOR^XMXUTIL (DBIA 2734) to do that. COMPONENT: NETSIG VARIABLES: XMDUZ Type: Input The user whose network signature is to be added to the message. This is, of course, the user who created the message. The DUZ suffices, or enough of the name for a positive ID. XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Used If the message is not scrambled, then this variable is ignored. If the message is scrambled (locked with a key), then XMINSTR("SCR KEY") must contain the scramble key. If the key is not correct or is not supplied, then XMERR AND ^TMP("XMERR",$J) will be set. The calling routine should always check for $D(XMERR) after calling this API. XMMSG Type: Output Upon successful completion of this API, this variable contains an appropriate message, suitable for display to the user. "Network Signature added." Add the user's network signature to a message. See the general description for important information. This is not a toggle. MailMan has no way of checking to see if the user's network signature has already been added. Everytime this API is called, the network signature is added to the message, so if this API is called 3 times on the same message, the network signature will be added 3 times. Usage: D NETSIG^XMXEDIT(XMDUZ,XMZ,.XMINSTR,.XMMSG) COMPONENT: SCRAMBLE VARIABLES: XMZ Type: Input Message IEN in the MESSAGE file. XMINSTR Type: Both If the message is scrambled, the XMINSTR("SCR KEY") must contain the correct scramble key, otherwise XMERR and ^TMP("XMERR",$J) will be set. The calling routine should always check for $D(XMERR) after calling this API. XMINSTR("SCR HINT") is ignored as input. XMINSTR("SCR KEY") and XMINSTR("SCR HINT") are both killed upon successful completion of this API, and fields 1.8 and 1.85 of the message are deleted. If the message is not scrambled, XMINSTR("SCR KEY") must contain the key with which the message should be scrambled. It must be 3-20 characters, and case is ignored. XMINSTR("SCR HINT") is shown to the user when s/he receives the message, and is intended to be a hint to the user as to what the key might be. If supplied, it may be no more than 40 characters. The hint is optional. Field 1.8 of the message is set with the hint, and field 1.85 is set with the key. XMMSG Type: Output An appropriate message, suitable for display to the user. Either "Message text Scrambled" or "Message text UnScrambled". Scramble or unscramble a message's text. This API works as a toggle. If the text is scrambled, it will unscramble it. If it's not scrambled, it will scramble it. See the general description for important information. Usage: D SCRAMBLE^XMXEDIT(XMZ,.XMINSTR,.XMMSG) ******************** 2731 NAME: SECURITY, PERMISSIONS, & RESTRICTIONS API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs perform security and permission functions. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXSEC COMPONENT: $$ACCESS VARIABLES: Returns a value indicating whether the user may access a message or not. COMPONENT: $$ANSWER VARIABLES: Returns a value indicating whether the user may answer a message or not. COMPONENT: $$BCAST VARIABLES: Returns a value indicating whether a message was broadcast or not. COMPONENT: $$CLOSED VARIABLES: Returns a value indicating whether a message is "closed" or not. COMPONENT: $$CONFID VARIABLES: Returns a value indicating whether a message is "confidential" or not. COMPONENT: $$CONFIRM VARIABLES: Returns a value indicating whether a message is "confirm receipt requested" or not. COMPONENT: $$COPY VARIABLES: Returns a value indicating whether the user may copy a message or not. COMPONENT: $$DELETE VARIABLES: Returns a value indicating whether the user may delete (or terminate) a message or not. COMPONENT: $$FORWARD VARIABLES: Returns a value indicating whether the user may forward a message or not. COMPONENT: $$INFO VARIABLES: Returns a value indicating whether a message is "information only" or not. COMPONENT: $$LATER VARIABLES: Returns a value indicating whether the user may "later" a message or not. COMPONENT: $$MOVE VARIABLES: Returns a value indicating whether the user may save or filter a message or not. COMPONENT: $$ORIGIN8R VARIABLES: Returns a value indicating whether the user sent the message or not. COMPONENT: $$POSTPRIV VARIABLES: Returns a value indicating whether the user has Postmaster privileges or not, including whether or not the user may perform group message actions in SHARED,MAIL. COMPONENT: $$PRIORITY VARIABLES: Returns a value indicating whether a message is "priority" or not. COMPONENT: $$READ VARIABLES: Returns a value indicating whether the user may read a message or not. COMPONENT: $$REPLY VARIABLES: Returns a value indicating whether the user may reply to a message or not. COMPONENT: $$RPRIV VARIABLES: Returns a value indicating whether the surrogate has READ privileges or not. COMPONENT: $$RWPRIV VARIABLES: Returns a value indicating whether the surrogate has READ or SEND privileges or not. COMPONENT: $$SEND VARIABLES: Returns a value indicating whether the user may send a message or not. COMPONENT: $$SURRACC VARIABLES: Returns a value indicating whether the surrogate may access a message or not. COMPONENT: $$SURRCONF VARIABLES: Returns a value indicating whether a message is "confidential" or not, and if it is, whether the surrogate may access it. COMPONENT: $$WPRIV VARIABLES: Returns a value indicating whether the surrogate has SEND privileges or not. COMPONENT: $$ZCLOSED VARIABLES: Returns a value indicating whether a message is "closed" or not. COMPONENT: $$ZCONFID VARIABLES: Returns a value indicating whether a message is "confidential" or not. COMPONENT: $$ZCONFIRM VARIABLES: Returns a value indicating whether a message is "confirm receipt requested" or not. COMPONENT: $$ZINFO VARIABLES: Returns a value indicating whether a message is "information only" or not. COMPONENT: $$ZORIGIN8 VARIABLES: Returns a value indicating whether the user sent the message or not. COMPONENT: $$ZPOSTPRV VARIABLES: Returns a value indicating whether the user has Postmaster privileges or not, including whether or not the user may perform group message actions in SHARED,MAIL. COMPONENT: $$ZPRI VARIABLES: Returns a value indicating whether a message is "priority" or not. ******************** 2732 NAME: SECURITY, PERMISSIONS, & RESTRICTIONS API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs perform security and permission functions. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXSEC1 COMPONENT: $$COPYAMT VARIABLES: This function may be used when copying a message. It checks the total number of lines and responses to be copied. Returns a value indicating whether or not the amount is within site limitations. COMPONENT: $$COPYLIMS VARIABLES: This function may be used when copying a message. Returns the site's copy limits. COMPONENT: $$COPYRECP VARIABLES: This function may be used when copying a message. It returns a value indicating whether or not the copy may be sent to all the recipients of the original message. COMPONENT: $$PAKMAN VARIABLES: Returns a value indicating whether a message is a PackMan message or not. COMPONENT: CHKLINES VARIABLES: Checks whether a message is too long to be sent to a remote site. COMPONENT: CHKMSG VARIABLES: Checks whether or not the message is located where the calling routine says it is, and whether or not the user may access it. COMPONENT: GETRESTR VARIABLES: Returns assorted restrictions, if any, on sending or forwarding the message. COMPONENT: OPTGRP VARIABLES: Determines what the user may do at the basket or message group level. COMPONENT: $$SSPRIV VARIABLES: Returns a value (1 or 0) indicating whether the user is authorized to conduct a Super Search or not. If not, also sets XMERR and ^TMP("XMERR",$J). COMPONENT: $$ZSSPRIV VARIABLES: Returns a value (1 or 0) indicating whether the user is authorized to conduct a Super Search or not. If not, does NOT set XMERR and ^TMP("XMERR",$J). ******************** 2733 NAME: SECURITY, PERMISSIONS, & RESTRICTIONS API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs perform security and permission functions. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXSEC2 COMPONENT: $$EDIT VARIABLES: Returns a value indicating whether the user may edit a message or not. COMPONENT: OPTEDIT VARIABLES: If OPTMSG^XMXSEC2 (or $$EDIT^XMXSEC2) determines that the user may edit the message, then OPTEDIT determines what, exactly, the user may edit. COMPONENT: $$OPTMSG VARIABLES: Determines what the user may do with the message. ******************** 2734 NAME: MESSAGE & MAILBOX UTILITIES API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs are general message and mailbox utilities. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXUTIL COMPONENT: $$BMSGCT VARIABLES: Returns the number of messages in a user's basket. COMPONENT: $$BNMSGCT VARIABLES: Returns the number of new messages in a user's basket. COMPONENT: $$BSKTNAME VARIABLES: Returns the name of a user's basket. COMPONENT: $$NAME VARIABLES: Returns the name of the user (and, optionally, title and institution). COMPONENT: $$NETNAME VARIABLES: Returns the network name of the user, including @site name. COMPONENT: $$NEWS VARIABLES: Returns information about the new messages in a user's mailbox. COMPONENT: $$TMSGCT VARIABLES: Returns the total number of messages in a user's mailbox. COMPONENT: $$TNMSGCT VARIABLES: Returns the total number of new messages in a user's mailbox. COMPONENT: $$KVAPOR VARIABLES: Sets/Removes a message vaporize date on a message in a user's basket. COMPONENT: LASTACC VARIABLES: Records that the user has read the message. COMPONENT: MAKENEW VARIABLES: Makes a message new and updates the new message counts. COMPONENT: NONEW VARIABLES: Makes a message not new and updates the new message counts. COMPONENT: PAGE VARIABLES: Displays to the user: "Enter RETURN to continue or ^ to exit:" and waits until the user presses a key. COMPONENT: WAIT VARIABLES: Displays to the user: "Press RETURN to continue:" and waits until the user presses a key. COMPONENT: $$BPMSGCT VARIABLES: Returns the number of new priority messages in a user's basket. COMPONENT: $$TPMSGCT VARIABLES: Returns the total number of new priority messages in a user's mailbox. ******************** 2735 NAME: DATE & STRING UTILITIES API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs perform date and string manipulation. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXUTIL1 COMPONENT: $$CONVERT VARIABLES: Given an Internet date/time string, returns the VA FileMan date/time. COMPONENT: $$CTRL VARIABLES: Strip control characters from a string. COMPONENT: $$DECODEUP VARIABLES: Change all ~U~ to ^ in a string. COMPONENT: $$ENCODEUP VARIABLES: Change all ^ to ~U~ in a string. COMPONENT: $$GMTDIFF VARIABLES: Given the time zone, returns the difference (+-hhmm) from GMT. COMPONENT: $$INDT VARIABLES: Given the VA FileMan date/time, returns the Internet date/time string. COMPONENT: $$MAXBLANK VARIABLES: Reduce all three or more consecutive blanks in a string to two. COMPONENT: $$MELD VARIABLES: Combine a string and a number to form a new string of a given length. COMPONENT: $$MMDT VARIABLES: Given the VA FileMan date/time, returns MailMan date/time string. COMPONENT: $$SCRUB VARIABLES: Strip control characters and leading/trailing blanks from a string. COMPONENT: $$STRIP VARIABLES: Strip leading/trailing blanks from a string. COMPONENT: $$TIMEDIFF VARIABLES: Given the decimal time difference between time zones, returns +-hhmm. COMPONENT: $$TSTAMP VARIABLES: Return a timestamp. COMPONENT: ZONEDIFF VARIABLES: Given a time zone (or time difference from GMT), returns the number of hours and minutes difference between that and the local time zone. ******************** 2736 NAME: MESSAGE INFORMATION API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs return all kinds of information about a message. - Information that can be displayed. - Information that can be used to determine what may (and may not) be done with the message. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXUTIL2 COMPONENT: $$BSKT VARIABLES: Returns which basket a message is in for a user. COMPONENT: $$DATE VARIABLES: Returns the message sent date. COMPONENT: $$FROM VARIABLES: Returns the message From information. COMPONENT: $$KSEQN VARIABLES: Returns the sequence number fo a message in this user's basket. COMPONENT: $$LINE VARIABLES: Returns the number of lines in the text of a message. COMPONENT: $$NEW VARIABLES: Returns a value indicating whether or not a message is new for this user in this basket. COMPONENT: $$PRI VARIABLES: Returns a value indicating whether the message is priority or not. COMPONENT: $$QRESP VARIABLES: Determines whether a message is a response or not, and, optionally, if it is, which response to which message. COMPONENT: $$RESP VARIABLES: Returns the number of responses to a message. COMPONENT: $$SUBJ VARIABLES: Returns the message subject. COMPONENT: $$ZDATE VARIABLES: Returns the message sent date. COMPONENT: $$ZFROM VARIABLES: Returns the message From. COMPONENT: $$ZNODE VARIABLES: Returns the message zero node. COMPONENT: $$ZPRI VARIABLES: Returns a value indicating whether the message is priority or not. COMPONENT: $$ZREAD VARIABLES: Returns the number of responses to a message this user has read. COMPONENT: $$ZSUBJ VARIABLES: Returns the message subject. COMPONENT: INMSG VARIABLES: Sets arrays with message information. COMPONENT: INMSG1 VARIABLES: Sets arrays with message information, part 1. COMPONENT: INMSG2 VARIABLES: Sets arrays with message information, part 2. COMPONENT: INRESP VARIABLES: Sets an array with response information. COMPONENT: INRESPS VARIABLES: Sets arrays indicating how many responses a message has, and how many of them the user has read. ******************** 2737 NAME: MESSAGE INFORMATION API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 27,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs provide information about how a message was addressed and who has read it. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXUTIL3 COMPONENT: Q VARIABLES: Get a list of the addressees of this message. Optionally, find addressees which match a string. COMPONENT: QD VARIABLES: Get a list of the recipients of this message. Optionally, find recipients that match a string. COMPONENT: QL VARIABLES: Get a list of the "latered" addressees of this message. Optionally, find the "latered" addressees that match a string. COMPONENT: QN VARIABLES: Get the network header records from a message that originated at a remote site. COMPONENT: QX VARIABLES: Get a list of local recipients who have: - read the message and all responses - not read the message and all responses - terminated the message ******************** 2738 NAME: OE/RR references to GMR(120.8 CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.8 ROOT: GMR(120.8 DESCRIPTION: TYPE: File This DBIA documents OE/RR references to the PATIENT ALLERGIES file (#120.8). ^GMR(120.8,DA,0) 4 ORIGINATION DATE/TIM 0;4 Direct Global Read & w ROUTINE: ******************** 2739 NAME: OE/RR references to GMR(123.5 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Private ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123.5 ROOT: GMR(123.5, DESCRIPTION: TYPE: File This DBIA documents OE/RR references tothe REQUEST SERVICES file (#123.5). ^GMR(123.5,DA,0) .01 SERVICE NAME 0;1 Direct Global Read & w 2 SERVICE USAGE 0;2 Direct Global Read & w ^GMR(123.5,DA,.1) 1.11 PRINT NAME .1;1 Direct Global Read & w ^GMR(123.5,'APR', Loops through cross-reference by PROCEDURE TYPE. ROUTINE: ******************** 2740 NAME: OE/RR calls to GMRCSLM1 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING REGISTRATION CLINICAL PROCEDURES IMAGING Imaging added 2/15/2011 VIRTUAL PATIENT RECORD Effective with VPR*1*0 VA POINT OF SERVICE (KIOSKS) HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** The Enterprise Health MGMT Platform (HMP) subscribes to ICR 2740 in order to retrieve a list of consults/procedures. USAGE: Controlled Subscri ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to GMRCSLM1 as found in the OE/RR v3 interface specification document. ROUTINE: GMRCSLM1 COMPONENT: OER(DFN,SERVICE,BEG-DT,END-DT,STATUS) VARIABLES: DFN Type: Input IEN of the PATIENT file SERVICE Type: Input IEN of the REQUEST SERVICE file BEG-DT Type: Input Beginning date for search END-DT Type: Input End date for search STATUS Type: Input IEN of the ORDER STATUS file TMP('GMRCR Type: Output ^TMP("GMRCR",$J,"CS",#,0)=IEN^request date^order status^service^name of procedure or consult # is a sequential number Returns a list of consult/procedures. ******************** 2741 NAME: OE/RR calls to GMPLUTL2 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING MYHEALTHEVET NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD SURGERY VA POINT OF SERVICE (KIOSKS) TEXT INTEGRATION UTILITIES TIUWRIIS calls LIST^GMPLUTL2. Documenting with Patch TIU*1.0*286 - but the code actually was released in a prior patch. HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. GEN. MED. REC. - VITALS Added 03/03/20, effective with GMRV*5*40, to support a requirement to compare patient's weight gain/loss to the national weight gain/loss thresholds for vitals in CPRS. USAGE: Controlled Subscri ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine GMPLUTL2. ROUTINE: GMPLUTL2 COMPONENT: $$PARAM() VARIABLES: Returns the 0 node of the PROBLEM LIST SITE PARAMETERS file (#125.99) COMPONENT: DETAIL(IEN,.GMPL) VARIABLES: IEN Type: Input IEN of PROBLEM file (#9000011). GMPL Type: Output Array returned as follows (all are in external format except AUDIT data unless otherwise specified): Array: Field Returned GMPL("DIAGNOSIS") DIAGNOSIS (#.01) GMPL("ICDD") ICD DESCRIPTION GMPL("CSYS") CODING SYSTEM (#80202) GMPL("DTINTEREST") DATE OF INTEREST (#80201) GMPL("PATIENT") PATIENT NAME (#.02) GMPL("MODIFIED") LAST MODIFIED (#.03) GMPL("NARRATIVE") NARRATIVE (#.05) GMPL("ENTERED") DATE ENTERED (#.08) ^ ENTERED BY (#1.03) GMPL("STATUS") STATUS (#.12) GMPL("PRIORITY") PRIORITY (#1.14) or null if INACTIVE GMPL("ONSET") DATE OF ONSET (#.13) GMPL("PROVIDER") ENTERED BY (#1.03) GMPL("RECORDED") RECORDED (#1.09) ^ REC PROVIDER (#1.04) GMPL("CONDITION") PATIENT CONDITION (#1.02) GMPL("RESOLVED") DATE RESOLVED (#1.07) GMPL("CLINIC") CLINIC (#1.08) GMPL("SERVICE") SERVICE (#1.06) GMPL("FACILITY") FACILITY ID (#.06) ^ FACILITY NAME GMPL("SC") SERV CONNECTED(#1.1) (UNKNOWN if not 1/0) GMPL("SCTC") SNOMED-CT CONCEPT CODE (#80001) GMPL("SCTD") SNOMED-CT DESIGNATION CODE (#80002) GMPL("SCTT") SNOMED-CT PREFERRED TEXT GMPL("VHATC") VHAT CONCEPT CODE (#80003) GMPL("VHATD") VHAT DESIGNATION CODE (#80004) GMPL("VHATT") VHAT PREFERRED TEXT GMPL("ICD9MLTP") COUNT OF MAPPING TARGETS GMPL("ICD9MLTP",CNT) ICD-9/ICD-10 CODE (#80300.01) ^ ICD-9/ICD-10 DESCRIPTION ^ ICD CODING SYSTEM (#80300.02) GMPL("EXPOSURE") Count of exposures GMPL("EXPOSURE",#) Name of each exposure GMPL("COMMENT") Count of comments GMPL("COMMENT",#) DATE NOTE ADDED ^ AUTHOR ^ [NOTE TEXT] GMPL("COMMENT",#,n) Line of comment text GMPL("AUDIT") Count of changes GMPL("AUDIT",#) FIELD# ^ FIELD NAME ^ DATE MODIFIED ^ WHO MODIFIED ^ OLD VALUE ^ NEW VALUE ^ REASON ^PROVIDER Returns detailed data for a problem IEN. COMPONENT: LIST(.GMPL,DFN,STATUS,COMMENTS?) VARIABLES: GMPL Type: Output GMPL(0)=number of problems GMPL(#)=IEN^status^description^icd^onset^ last modified^SC^exposure^*^$ GMPL(#,C#) = comment lines * is returned if ACUTE, otherwise null $ is returned if CONDITION is TRANSCRIBED and VERIFY TRANSCRIBED PROBLEMS parameter is set to YES, otherwise null DFN Type: Input IEN of the PATIENT file STATUS Type: Input A for active, I for inactive, other for both statuses COMMENTS? Type: Input 1 to return comments. 0, null, or undefined for no comments. Returns a list of problems for a patient (DFN) COMPONENT: ADD(DFN,LOCATION,PROVIDER) VARIABLES: DFN Type: Input IEN of PATIENT file LOCATION Type: Input IEN of HOSPITAL LOCATION file PROVIDER Type: Input IEN of NEW PERSON file Interactive list manager action to add a new provider COMPONENT: EDIT(DFN,LOCATION,PROVIDER,PROBLEM) VARIABLES: DFN Type: Input IEN of PATIENT file LOCATION Type: Input IEN of HOSPITAL LOCATION file PROVIDER Type: Input IEN of NEW PERSON file PROBLEM Type: Input IEN of PROBLEM file Interactive list manager action to edit an existing problem COMPONENT: REMOVE(PROBLEM,PROVIDER,TEXT,.REPLY) VARIABLES: PROBLEM Type: Input IEN of PROBLEM file PROVIDER Type: Input IEN of NEW PERSON file TEXT Type: Input Text to store REPLY Type: Output REPLY = -1 if problem, IEN otherwise REPLY(0) = error message if problem, "" otherwise Removes a problem COMPONENT: VAF(DFN,SILENT) VARIABLES: DFN Type: Input IEN of PATIENT file SILENT Type: Input 1 if report to be silently captured to Host File Server, otherwise will prompt for device Prints a chartable Problem List report, with optional prompt for device if 'SILENT ******************** 2742 NAME: OE/RR calls to GMPLX CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) USAGE: Private ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents OE/RR calls to routine GMPLX. ROUTINE: GMPLX COMPONENT: $$PROBTEXT(IEN) VARIABLES: IEN Type: Input IEN of PROBLEM file. Returns external format of PROVIDER NARATIVE field (#.05) in PROBLEM file (#9000011). COMPONENT: DTMOD(IEN) VARIABLES: IEN Type: Input IEN of PROBLEM file Updates DATE LAST MODIFIED field (#.03) to value of system variable DT. Used by CPRS GUI only. COMPONENT: AUDIT(NODE0,NODE1) VARIABLES: NODE0 Type: Input 0 node to be placed in PROBLEM LIST AUDIT file (#125.8) NODE1 Type: Input 1 node to be placed in PROBLEM LIST AUDIT file (#125.8) Store data in AUDIT file (used by CPRS GUI) COMPONENT: $$DUPL(DFN,TERM,TEXT) VARIABLES: DFN Type: Input IEN of the PATIENT file TERM Type: Input The value for the PROBLEM field of the PROBLEM file (#9000011). TEXT Type: Input The value of the PROVIDER NARRATIVE (#.05) field of the PROBLEM file (#9000011). This entry point checks a patient's problem list and returns an IEN if there is already a matching entry on file. COMPONENT: $$CODESTS(PROB,ADATE) VARIABLES: PROB Type: Input This variable is a pointer to the PROBLEM (#9000011) file. ADATE Type: Input This variable is a FM date on which to check the status of the ICD9 code associated with the problem. This component accepts a pointer to the PROBLEM (#9000011) file and a VA Fileman date as input. The component checks the status of the ICD9 code attached to the problem on the date passed. The component returns a boolean value of 1 (one) if the code is active on the specified date, a 0 (zero) is returned if inactive. ******************** 2743 NAME: OE/RR calls to GMPLX1 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JAN 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will document calls made from OE/RR (CPRS GUI only) to routine GMPLX1. ROUTINE: GMPLX1 COMPONENT: $$VIEW(DUZ) VARIABLES: DUZ Type: Input IEN of NEW PERSON file for user utilizing CPRS GUI. Returns value for PROBLEM LIST PRIMARY VIEW field (#125) from NEW PERSON file (#200). COMPONENT: $$SERVICE(DUZ) VARIABLES: DUZ Type: Input IEN of NEW PERSON file for user utilizing CPRS GUI. Returns users service/section in internal^external format COMPONENT: VADPT(DFN) VARIABLES: DFN Type: Input IEN of PATIENT file GMPSC Type: Output Service Connected Indicator: 1 if yes, 0 if no, "" if unknown GMPAGTOR Type: Output Agent Orange Exposure Indicator: 1 if yes, 0 if no, "" if unknown GMPION Type: Output Ionizing Radiation Indicator: 1 if yes, 0 if no, "" if unknown GMPGULF Type: Output Persian Gulf indicator: 1 if yes, 0 if no, "" if unknown GMPHNC Type: Output Head and/or Neck Cancer Indicator: 1 if yes, 0 if no, "" if unknown GMPMST Type: Output Military Sexual Trauma Indicator: 1 if yes, 0 if no, "" if unknown GMPCV Type: Output Combat Veteran Indicator: 1 if yes, 0 if no, "" if unknown GMPSHD Type: Output Shipboard Hazard and Defense Indicator: 1 if yes, 0 if no, "" if unknown GMPCLV Type: Output Camp LeJeune Indicator: 1 if yes, 0 if no, "" if unknown Returns information on SC, Agent Orange, Ionizing Radiation, Camp LeJeune, Gulf War, Head and/or Neck Cancer, Military Sexual Trauma, Combat Veteran, and Shipboard Hazard and Defense. COMPONENT: SCCOND(DFN,.SC) VARIABLES: DFN Type: Input IEN of PATIENT file SC Type: Output Local array passed by reference containing a patient's exposure/condition indicators. SC("AO") = Agent Orange Exposure Indicator SC("CLV") = Camp LeJeune Indicator SC("CV") = Combat Veteran Indicator SC("DFN") = IEN of Patient File SC("HNC") = Head and/or Neck Cancer Indicator SC("IR") = Ionizing Radiation Indicator SC("MST") = Military Sexual Trauma Indicator SC("PG") = Persian Gulf Indicator SC("SC") = Service Connected Indicator SC("SHD") = Shipboard Hazard and Defense Indicator 1 if yes, 0 if no, "" if unknown Returns information on SC, Agent Orange, Ionizing Radiation, Camp LeJeune, Gulf War, Head and/or Neck Cancer, Military Sexual Trauma, Combat Veteran, and Shipboard Hazard and Defense in an array passed by reference. COMPONENT: SCS(PROB,.SC) VARIABLES: PROB Type: Input IEN of PROBLEM file 9000011 SC Type: Output Array containing combined strings of exposures and/or conditions that relate to the problem identified by input variable PROB. OUTPUT: SC(1) = AO/IR/EC/HNC/MST/CL/CV/SHD Delimited abbreviation SC(2) = A/I/E/H/M/L/C/S Delimited Initials SC(3) = AIEHMLCS Initials Returns a combined string of exposure/conditions in 3 formats, delimited abbreviation, delimited initials and initials. ******************** 2746 NAME: CIRN SITE PARAMETER 991.8 CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA The Master Patient Index developers requested access to the NEW REQUEST MAILGROUP (#.03) field in the CIRN SITE PARAMETER file (#991.8) via a direct global read. USAGE: Private ENTERED: FEB 3,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 991.8 ROOT: RGSITE(991.8, DESCRIPTION: TYPE: File ^RGSITE(991.8, .03 NEW REQUEST MAILGROU 0;3 Direct Global Read & w .04 LOCAL/MISSING DATE L 0;4 Direct Global R/W & w/ .01 PARAMETER NUMBER 0;1 Direct Global Read & w .02 CMOR REQUEST CHANGE 0;2 Direct Global Read & w 18 CMOR LAST PATIENT PR CMOR;1 Direct Global Read & w 19 CMOR INIT STARTED DA CMOR;2 Direct Global Read & w 20 CMOR INIT STOPPED DA CMOR;3 Direct Global Read & w 21 CMOR INIT MANUAL STO CMOR;4 Direct Global Read & w 22 CMOR DAILY START TIM CMOR;5 Direct Global Read & w 23 CMOR DAILY STOP TIME CMOR;6 Direct Global Read & w 24 CMOR INIT STATUS CMOR;7 Direct Global Read & w 25 CMOR RUN TYPE CMOR;8 Direct Global Read & w 26 CMOR LAST TASK# CMOR;9 Direct Global Read & w ROUTINE: ******************** 2747 NAME: ORCSAVE2 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE Uses component $$VALUE to retrieve order responses. CARE MANAGEMENT Uses $$VALUE to retrieve order responses, and COMP to complete orders. EMERGENCY DEPARTMENT ADDED 9/25/08 HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: JUL 28,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement permits access to data stored in the Orders file (#100) in OE/RR. ROUTINE: ORCSAVE2 COMPONENT: VALUE VARIABLES: IFN Type: Input IEN in the Orders file #100. ID Type: Input A name that identifies the desired value, corresponding to the ID field (#13) of the prompt in the Order Dialog file #101.41 that created the value. INST Type: Input The instance desired; 1 is assumed if not specified [Not Required]. Returns the value of a user's response within the order. COMPONENT: COMP VARIABLES: IFN Type: Input IEN in the Orders file #100. WHO Type: Input IEN in New Person file #200 of user that completed the order; DUZ is assumed if not specified. WHEN Type: Input Date/time when order was completed, in FileMan format; NOW is assumed if not specified. Marks an order as completed; fields COMPLETED (#66) and COMPLETED BY (#67) will be populated in the Orders file #100, and the status changed to COMPLETE. ******************** 2748 NAME: MPIQ(DFN) in MPIFAPI CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION MYHEALTHEVET AUTOMATED MED INFO EXCHANGE RPC - DVBAB MPI ASSIGN ICN from CAPRI GUI -- a silent call to the MPIQ entry point. USAGE: Controlled Subscri ENTERED: FEB 4,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MPI is providing support for the Registration package to provide real-time queries to the MPI for assignment of an ICN and CMOR. If the MPI is not available, a local ICN will be assigned instead. If the MPI does not already know of this patient, the patient will be added and assigned an ICN. The call to accomplish this task is MPIQ^MPIFAPI(DFN), where DFN is the IEN of the patient in the Patient file. This code is to be inserted after all the required data has been collected on a new patient (new to the Patient file (#2)). If the patient is already known, this code should be inserted after the patient has been selected. Interaction will only occur with the MPI if the patient does not have an ICN assignment. This API is NOT a silent one. It can be made silent by setting the variable MPIFS=1 prior to calling this API. The variable shouldn't be new'd prior to calling MPIQ^MPIFAPI but should be killed after the call has been made. NOTE: The following fields will be updated in the Patient file (#2) when a successful interaction with the MPI has occurred: INTEGRATION CONTROL NUMBER (#991.01), ICN CHECKSUM (#991.02), and CIRN MASTER OF RECORD (#991.03). If the MPI was unavailable, in addition to the fields noted above, the LOCALLY ASSIGNED ICN (#991.04) would be set to yes. ROUTINE: MPIFAPI COMPONENT: MPIFQ VARIABLES: DFN Type: Input DFN is the IEN of the patient in the Patient file (#2). MPIQ^MPIFAPI(DFN) is a procedure call that allows a real-time connection with the MPI to request/query for an Integration Control Number (ICN). DFN is passed as the IEN for the patient in the Patient file (#2). the following is the suggested coding for this API: N X S X="MPIFAPI" X ^%ZOSF("TEST") Q:'$T D MPIQ^MPIFAPI(DFN) K MPIFRTN If the call should be silent, MPIFS should be set to 1 prior to calling MPIQ^MPIFAPI and killed afterwards. ******************** 2750 NAME: GMTSADOR ROUTINE CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: FEB 8,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Women's Health package requests permission to call the Health Summary package routine GMTSADOR at the line label of MAIN. This entry point will allow Women's Health package users to create adhoc health summary reports from within the Women's Health package. ROUTINE: GMTSADOR COMPONENT: MAIN VARIABLES: DFN Type: Input Patient internal entry number ******************** 2751 NAME: DGCN(391.91 Treating Facility file CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: MAR 15,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 391.91 ROOT: DGCN(391.91 DESCRIPTION: TYPE: File The Master Patient Index - VistA package is requesting to add entries to the Treating Facility (#391.91) file via FILE^DICN call and to check the "APAT" cross reference for the existence of the entry. ^DGCN(391.91,'APAT' Checking for the existance of the ^DGCN(391.91,"APAT",,) so that an addition to the file won't occur if it already exists. ^DGCN(391.91, .02 INSTITUTION 0;2 Write w/Fileman This is the Institution that the patient was treated at. .01 PATIENT 0;1 Write w/Fileman This is a pointer to the patient in question that was seen at this treating facility. Adding an entry to the Treating Facilit file via FILE^DICN call populating .01 and .02 fields. ROUTINE: ******************** 2752 NAME: OUTPATIENT PHARMACY: DD UPDATES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: MAR 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Outpatient Pharmacy V. 7.0 has permission to kill the following ^DD entries in patch PSO*7*25. This is a one time agreement. ^DD(55,0,"P") ^DD(55,0,"PS") ROUTINE: ******************** 2755 NAME: $$GETSRVR VAFCMSG5 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: FEB 17,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MPIF is requesting to use $$GETSRVR^VAFCMSG5 to get the pointer to the HL7 server protocol for the A28 event type. ROUTINE: VAFCMSG5 COMPONENT: $$GETSRVR VARIABLES: EVNTTYPE Type: Input EVNTTYPE - Event type to build list for (Defaults to A08). Currently supported events: A04, A08, A28. $$GETSRVR Type: Output $$GETSRVR will return the pointer to HL7 Server Protocol (value for HLEID). Note: Zero (0) will be returned if the event does not have an associated HL7 Server Protocol or the HL7 Server Protocol can not be found in the PROTOCOL file (#101). $$GETSRVR^VAFCMSG5(EVNTTYPE) Gets the pointer to HL7 Server Protocol for a given event type. ******************** 2756 NAME: $$BLDMSG VAFCMSG1 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: FEB 17,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MPIF is requesting to use $$BLDMSG^VAFCMSG1 to build the HL7 ADT-A28 message for a given patient. ROUTINE: VAFCMSG1 COMPONENT: $$BLDMSG VARIABLES: DFN Type: Input DFN - Pointer to entry in PATIENT file (#2) for building message. EVNTHL7 Type: Input EVNTHL7 - HL7 ADT event to build message for (Defaults to A08) Currently supported event types: A04, A08, A28. EVNTDATE Type: Input EVNTDATE - Date/time event occurred in FileMan format - Defaults to current date/time (NOW) EVNTINFO Type: Input EVNTINFO - Array containing further event information needed when building HL7 segments/message. Use and subscripting of array is determined by segment and/or message being built. - Defaults to ^TMP("VAFCMSG",$J,"EVNTINFO") Current subscripts include: EVNTINFO("DFN") = Pointer to PATIENT file (#2) EVNTINFO("EVENT") = Event type EVNTINFO("DATE") = Event date/time EVNTINFO("PIVOT") = Pointer to ADT/HL7 PIVOT file (#391.71) EVNTINFO("REASON",X) = Event reason codes EVNTINFO("USER") = User associated with the event XMITARRAY Type: Both As Input: XMITARRY - Array to build message into (full global reference) - Defaults to ^TMP("HLS",$J) As Output: XMITARRY(N) = Line N of message XMITARRY(N,M) = Continuation number M of line N INSRTPNT Type: Input INSRTPNT - Line to begin inserting message text at - Defaults to 1 (can not be zero or less) $$BLDMSG Type: Output LastLine^TotalLine = ADT-Axx message was build Where LastLine = Last line number in message and TotalLine = Number of lines in message (this total includes continuation lines) OR -1^ErrorText = Error generating ADT-Axx message $$BLDMSG^VAFCMSG1(DFN,EVNTHL7,EVNTDATE,EVNTINFO,XMITARRY,INSRT PNT) This entry point builds HL7 ADT messages for a given patient. ******************** 2757 NAME: OE/RR calls to MCARPS2 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: FEB 18,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA authorizes OE/RR v3 calling EN^MCARPS2(DFN) ROUTINE: MCARPS2 COMPONENT: EN(DFN) VARIABLES: DFN Type: Input IEN of PATIENT file global Type: Output Global containing a list of procedures for display in OE/RR. Located at ^TMP("OR",$J,"MCAR", This temporary global is sorted by either inverse date or Procedure Name, based on input parameters. Subscripts S1 and S2 hold the sort values. The sorted version of the TMP global is used for selection of procedures. The second version is used as input to produce the report. $P(^TMP("OR",$J,"MCAR",S1,S2),U,1)=Gross Evaluation ...),U,2)=Pointer to Procedure ...),U,3)=Print Routine (Field #5 from file 697.2) ...),U,4)=Print Line (Field #6 from file 697.2) ...),U,5)=Print Name (Field #7 from file 697.2) ...),U,10)=Summary Title ...),U,11)=Procedure Name ...),U,12)=Print Name_"/"_Procedure Name $P(^TMP("OR",$J,"MCAR","OT",L),U,1)=Print Name ...),U,2)=Pointer to Procedure ...),U,3)=Print Routine ...),U,4)=Print Line ...),U,5)=Print Name ...),U,6)=Date/time of procedure ...),U,7)=Gross Evaluation ...),U,10)=Summary Title ...),U,11)=Inverse date or Procedure (depends on sort) ...),U,12)=Procedure or Inverse date (depends on sort)^ Note: The global ^TMP("MCAR",$J) should be killed before and after the call to EN^MCARPS2. S5 Type: Input S5 may be optionally set to return results from a single file. Values may be: "MCAR(691" for ECHO "MCAR(691.1" for CARDIAC CATHETERIZATION "MCAR(691.5" for ELECTROCARDIOGRAM "MCAR(691.6" for HOLTER "MCAR(691.7" for EXERCISE TOLERANCE "MCAR(691.8" for ELECTROPHYSIOLOGY "MCAR(694" for HEMATOLOGY "MCAR(698" for GENERAL IMPLANT "MCAR(698.1" for V LEAD IMPLANT "MCAR(698.2" for A LEAD IMPLANT "MCAR(698.3" for PACEMAKER SURVEILLANCE "MCAR(699" for ENDOSCOPY/CONSULT "MCAR(700" for PULMONARY FUNCTION TESTS "MCAR(701" for RHEUMATOLOGY Returns procedures for a patient. ******************** 2758 NAME: DBIA2758 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: FEB 22,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other REGISTRATION OPTIONS on CIRN namespaced menus. Patient Data Review [VAFC EXCEPTION HANDLER] option on the MPI/PD Patient Admin User Menu [RG ADMIN USER MENU] Purge Patient Data Reviews [VAFC PDR PURGE] option on the MPI/PD Patient Admin User Menu [RG ADMIN USER MENU] ROUTINE: ******************** 2761 NAME: ATTACH OR PROTOCOLS TO GMRC PROTOCOLS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: FEB 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other CONSULT/REQUEST TRACKING version 3.0 requests the ability to attach three new OR namespaced protocols to GMRC protocols. This is for the purpose of updating CPRS with staus updates to orders from CONSULT/REQUEST TRACKING and updating CPRS with new orderable items from CONSULT/REQUEST TRACKING. The specific protocol linkage: 1) Attach OR RECEIVE and ORDER CHECK HL7 RECIEVE to GMRC EVSEND OR 2) Attach OR ITEM RECEIVE to GMRC ORDERABLE ITEM UPDATE ROUTINE: ******************** 2762 NAME: minus 9 nodes CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA CLINICAL CASE REGISTRIES OUTPATIENT PHARMACY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 1,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File MPI needs to check for the -9 node on the Patient file. If the -9 node exists for a given entry, the MPI needs to not use this patient entry. NOTE: Duplicate Merge is responsible for setting the -9 node in the Patient (#2) file. The Patient (#2) file is part of the Registration package. However because Duplicate Merge is responsible for setting this node, it was decided Kernel should be the Custodial Package as recommended by the DBA. ^DPT(da,-9 The -9 node in the DPT global is being set by the Duplicate Record Merge software after a pair of records is merged. The FROM (record going away) record gets a -9 node entry to prevent the usage of this record. MPI wants to be sure not to get these patients and is checking for the existence of the node. ROUTINE: ******************** 2763 NAME: Read %ZTSK Global CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: VA FILEMAN USAGE: Private ENTERED: MAR 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSK( DESCRIPTION: TYPE: File Because Fileman supports both a non-VistA Kernel environment and a VistA Kernel environment, a test is necessary to determine which environment is present. A test that is used to determin if Queueing is Allowed, therefore a VistA Kernel environment, is by checking whether or not the %ZTSK global is present. ROUTINE: ******************** 2764 NAME: BACKWARD COMPATIBILITY FOR ALERT FOLLOW-UP CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: MAR 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Consult/Request Tracking version 3.0 requests the ability to call RPTCON^ORB3FUP2 from routine GMRCXQ. This will allow existing alerts at the time of Consult/Request Tracking version 3.0 installation to be processed correctly without conversion. This code would branch accordingly to the proper code in the GMRC namespace. This would be called as a result of processing three OE/RR NOTIFICATION types: CONSULT/REQUEST RESOLUTION CONSULT/REQUEST CANCEL/HOLD SERVICE CONSULT/REQUEST ROUTINE: ORB3FUP2 ******************** 2766 NAME: Formatted Lab Results CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These calls get formatted Lab Results output into a global array. These formats are based on definitions in the Lab Reports file (64.5) for CH subscripted tests. For AP, Micro and Blood Bank, the format is a hard coded traditional format. ROUTINE: LR7OSUM COMPONENT: EN VARIABLES: DFN Type: Input Patient ID SDATE Type: Input Start date to search for results (optional). EDATE Type: Input End date to search for results (optional). COUNT Type: Input Number of results to send (optional). GIOM Type: Input Right margin. Default is 80 (optional). SUBHEAD Type: Input Array of subheaders to include in report (optional). These are subheaders from file 64.5 for CH subscripted tests. For other lab areas, they are: SUBHEAD("MICROBIOLOGY") SUBHEAD("BLOOD BANK") SUBHEAD("MISCELLANEOUS TESTS") SUBHEAD("CYTOPATHOLOGY") SUBHEAD("SURGICAL PATHOLOGY") SUBHEAD("EM") SUBHEAD("AUTOPSY") No entry in this parameter gets everything. Y Type: Output This tells where the formatted output is (^TMP("LRC",$J)). This gets a 'silent', formatted report of lab results. COMPONENT: AP VARIABLES: DFN Type: Input Patient ID This entry point gets all Anatomic Pathology results in a formatted array. COMPONENT: GET64 VARIABLES: Y Type: Output Array containing the subheaders from file 64.5. This gets an array of minor headers from the Lab Reports file (64.5). ******************** 2767 NAME: Graph Lab Results CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are the entry points used by CPRS to display Lab results graph. ROUTINE: LRDIST4 COMPONENT: L2 VARIABLES: Prompts for values needed to graph results. COMPONENT: OERR VARIABLES: ORVP Type: Input OE/RR's patient ID. DFN;DPT( Sets up patient variables needed. COMPONENT: CLEAN VARIABLES: Cleans up variables used. ******************** 2768 NAME: Lab Results CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is used by CPRS to get selected Lab Results displayed. ROUTINE: LRGEN COMPONENT: SET VARIABLES: Set up variables needed prior to calling SET1. COMPONENT: SET1 VARIABLES: DFN Type: Input Patient ID. Prints patient report. ******************** 2769 NAME: Lab Results Interim Format CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is used by CPRS to get a display of lab results in interim format. ROUTINE: LRRP4 COMPONENT: SET VARIABLES: Setup variables needed by lab interim routines. COMPONENT: OERR VARIABLES: DFN Type: Input Patient ID. ~TMP("LR", Type: Output May be killed before and after call to OERR. Get display of Lab Results. COMPONENT: CLEAN VARIABLES: Clean-up variables used to obtain report. ******************** 2770 NAME: GMTSLRPE ROUTINE CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: WOMEN'S HEALTH MYHEALTHEVET ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Women's Health package requests permission to call the GMTSLRPE routine at the XTRCT line label. This routine returns cytology data extracted from the LAB DATA file (#63) of the Laboratory package. ROUTINE: GMTSLRPE COMPONENT: XTRCT VARIABLES: LRDFN Type: Input This is the internal entry number of a LAB DATA (#63) file entry that identifies the patient. It is not the variable DFN, rather it is the value of +^DPT(DFN,"LR"). GMTS1 Type: Input A reverse FileMan date/time (e.g., 7009695.8955) used as the start of a search of the LAB DATA (#63) file. GMTS2 Type: Input A reverse FileMan date/time (e.g., 7019695.8955) used as the end of a search of the LAB DATA (#63) file. MAX Type: Input An integer value which indicates the maximum number of entries to return. For example, if MAX=10 and more than 10 tests were found in the date/time range, then the 10 most recent test entries will be returned. TMP("LRCY" Type: Output The cytology data for all entries found will be returned in the temporary global ^TMP("LRA",$J). The data layout for that global is: S ^TMP("LRCY",$J,sub1,0)=DATE/TIME SPECIMEN TAKEN^CYTOPATH ACC# S ^TMP("LRCY",$J,sub1,1)="Site/Specimen" literal^REPORT RELEASE DATE/TIME S ^TMP("LRCY",$J,sub1,1,sub2)=Site/Specimen text S ^TMP("LRCY",$J,sub1,"AH",sub2)=Brief Clinical History text S ^TMP("LRCY",$J,sub1,"G",sub2)=Gross Description text S ^TMP("LRCY",$J,sub1,"MI",sub2)=Microscopic exam text S ^TMP("LRCY",$J,sub1,"SR",sub2,0)=Supplementa ry Report text S ^TMP("LRCY",$J,sub1,"SR",sub2,sub3)=Suppleme ntary Report text S ^TMP("LRCY",$J,sub1,"NDX",sub2)=Cytology Diagnosis ******************** 2771 NAME: GMTSLRAE ROUTINE CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: WOMEN'S HEALTH MYHEALTHEVET ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Women's Health package requests permission to call the GMTSLRAE routine at the XTRCT line label. This routine returns surgical pathology data extracted from the LAB DATA file (#63) of the Laboratory package. ROUTINE: GMTSLRAE COMPONENT: XTRCT VARIABLES: LRDFN Type: Input This is the internal entry number of a LAB DATA (#63) file entry that identifies the patient. It is not the variable DFN, rather it is the value of +^DPT(DFN,"LR"). GMTS1 Type: Input A reverse FileMan date/time (e.g., 7009695.8955) used as the start of a search of the LAB DATA (#63) file. GMTS2 Type: Input A reverse FileMan date/time (e.g., 7019695.8955) used as the end of a search of the LAB DATA (#63) file. MAX Type: Input An integer value which indicates the maximum number of entries to return. For example, if MAX=10 and more than 10 tests were found in the date/time range, then the 10 most recent test entries will be returned. TMP(LRA,$J Type: Output The surgical pathology data for all entries found will be returned in the temporary global ^TMP("LRA",$J). The data layout for that global is: S ^TMP("LRA",$J,sub1,0)=DATE/TIME SPECIMEN TAKEN^SURGICAL PATH ACC# S ^TMP("LRA",$J,sub1,.1)="Site/Specimen" literal^REPORT RELEASE DATE/TIME S ^TMP("LRA",$J,sub1,.1,sub2)=Site/Specimen text S ^TMP("LRA",$J,sub1,.2)="Brief Clinical HX" literal S ^TMP("LRA",$J,sub1,.2,sub2)=Brief Clinical History text S ^TMP("LRA",$J,sub1,1)="Gross Description" literal S ^TMP("LRA",$J,sub1,1,sub2)=Gross Description text S ^TMP("LRA",$J,sub1,1.1)="Microscopic Exam" literal S ^TMP("LRA",$J,sub1,1.1,sub2)=Microscopic Exam text S ^TMP("LRA",$J,sub1,1.2)="Supplementary Report" literal S ^TMP("LRA",$J,sub1,1.2,sub2)=Supplementary Report text S ^TMP("LRA",$J,sub1,1.2,sub2,sub3)=Supplement ary Report text S ^TMP("LRA",$J,sub1,1.3)="Frozen Section" literal S ^TMP("LRA",$J,sub1,1.3,sub2)=Frozen Section text S ^TMP("LRA",$J,sub1,1.4)="Surgical Path Dx" literal S ^TMP("LRA",$J,sub1,1.4,sub2)=Surgical Pathology Diagnosis text ******************** 2772 NAME: WVLRLINK ROUTINE CUSTODIAL PACKAGE: WOMEN'S HEALTH SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Women's Health (WH) package requests that the Lab package will notify the WH package whenever lab test results are released or changed for a cytology or surgical pathology test. ROUTINE: WVLRLINK COMPONENT: CREATE VARIABLES: DFN Type: Input Pointer to the PATIENT file (#2) LRDFN Type: Input Pointer to the LAB DATA file (#63) LRI Type: Input The reverse date/time subscript of a LAB DATA file (#63) entry for Cytology or Surgical Pathology. LRA Type: Input The zero node of a Cytology or Surgical Pathology entry in the LAB DATA file (#63). Specifically, the WH package is interested in: Piece #1: DATE/TIME SPECIMEN TAKEN #6: CYTOPATH ACC # or SURGICAL PATH ACC # #7: PHYSICIAN #8: PATIENT LOCATION #15: ORIGINAL RELEASE DATE LRSS Type: Input The two letter value that identifies the type of lab test (e.g., CY or SP). The Lab package will call this entry point when the results for a cytology or surgical pathology test are released. The WH package will store these values in order to track lab tests performed. Also, the WH package will use the values of LRDFN and LRI as input values in private IAs (#2770 and 2771) to the Health Summary (HS) package to display data from HS components for cytology and surgical pathology. COMPONENT: DELETE VARIABLES: DFN Type: Input Pointer to the PATIENT file (#2) LRDFN Type: Input Pointer to the LAB DATA file (#63) LRI Type: Input The reverse date/time subscript of a LAB DATA file (#63) entry for Cytology or Surgical Pathology. LRA Type: Input The zero node of a Cytology or Surgical Pathology entry in the LAB DATA file (#63). Specifically, the WH package is interested in: Piece #1: DATE/TIME SPECIMEN TAKEN #6: CYTOPATH ACC # or SURGICAL PATH ACC # #7: PHYSICIAN #8: PATIENT LOCATION #15: ORIGINAL RELEASE DATE LRSS Type: Input The two letter value that identifies the type of lab test (e.g., CY or SP). The Lab package will call this entry point when the lab results for a cytology or surgical pathology test are not to be viewed by other than lab personnel (e.g., the lab test results are being changed). COMPONENT: MOVE VARIABLES: DFN Type: Input Pointer to the PATIENT file (#2) LRDFN Type: Input Pointer to the LAB DATA file (#63) LRI Type: Input The reverse date/time subscript of a LAB DATA file (#63) entry for Cytology or Surgical Pathology. LRA Type: Input The zero node of a Cytology or Surgical Pathology entry in the LAB DATA file (#63). Specifically, the WH package is interested in: Piece #1: DATE/TIME SPECIMEN TAKEN #6: CYTOPATH ACC # or SURGICAL PATH ACC # #7: PHYSICIAN #8: PATIENT LOCATION #15: ORIGINAL RELEASE DATE LRSS Type: Input The two letter value that identifies the type of lab test (e.g., CY or SP). The Lab package will call this entry point when the Move anatomic path accession [LRAPMV] option is used by Lab personnel to move a lab accession from one patient to another patient for a cytology or surgical pathology test. ******************** 2773 NAME: DBIA2773 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: MAR 9,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 774 ROOT: HLS(774 DESCRIPTION: TYPE: File CIRN Option RG SUBSCRIPT STAT INQ uses a Read with FileMan to file ^HLS(774 (SUBSCRIPTION CONTROL) to do a lookup on a patient. This allows users to identify which sites are currently receiving CIRN patient information. It is display only. ^HLS(774,D0, .01 NUMBER 0;1 Read w/Fileman ^HLS(774,D0,'TO',D1, .01 DESTINATION 0;1 Read w/Fileman 3 LOGICAL LINK 0;4 Read w/Fileman 4 TYPE 0;5 Read w/Fileman 5 CREATION DATE/TIME 0;6 Read w/Fileman 6 ACTIVATION DATE/TIME 0;7 Read w/Fileman ROUTINE: ******************** 2774 NAME: INTERACTIVE API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 9,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs are interactive. Please see the Programmer Manual on the Infrastructure web site for further information about the APIs and how to use them. ROUTINE: XMXAPIU COMPONENT: READ VARIABLES: Interactive Read/Manage messages in your mailbox. COMPONENT: READNEW VARIABLES: Interactive read new messages in your mailbox. COMPONENT: SEND VARIABLES: Interactive send a message. COMPONENT: TOWHOM VARIABLES: Interactive address a message. COMPONENT: SUBJ VARIABLES: XMSUBJ Type: Both If XMSUBJ is set by the calling program, then it is displayed as the default response to the prompt. The response of the user is returned in XMSUBJ. Ask the user what the subject of a message should be. It includes all necessary checking to ensure that the subject conforms to the restrictions in the DD. Usage: D SUBJ^XMXAPIU(.XMSUBJ) ******************** 2777 NAME: MODIFY ONCOLOGY PACKAGE ENTRIES CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: MAR 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.4 ROOT: DIC(9.4, DESCRIPTION: TYPE: File The ONCOLOGY package has two PACKAGE file entries. The correct entry contains in incorrect PREFIX value which causes the KIDS "Required Build" feature to function incorrectly. The incorrect entry contains PATCH APPLICATION HISTORY data which belongs in the correct entry. We would like to 1) modify the PREFIX values of both PACKAGE entries, 2) move the PATCH APPLICATION HISTORY data from the incorrect entry to the correct entry and 3) delete the PATCH APPLICATION HISTORY data from the incorrect entry. These modifications will be achieved via standard FileMan calls. ROUTINE: ******************** 2778 NAME: CIRN HL7 DYNAMIC ADDRESSING CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: REGISTRATION This is only called from the VistA HL7 package byway of the PROTOCOL (#101) File, ROUTING LOGIC (#774) field. USAGE: Private ENTERED: MAR 19,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows the REGISTRATION protocol, VAFC MFU-TFL CLIENT, to contain the following routing logic: N X S X="RGRSDYN1" X ^%ZOSF("TEST") Q:'$T D EN^RGRSDYN1("VAFC MFU-TFL CLIENT",0) This routing logic builds a dynamic link list of subscribering sites for the patient being processed in the inbound HL7 message. ROUTINE: RGRSDYN1 COMPONENT: EN(CLIENT,CLASS) VARIABLES: CLIENT Type: Input (Required) HL7 Client protocol, as it appears in the .01 field of the PROTOCOL (#101) file. Ex. "VAFC MFU-TFL CLIENT" CLASS Type: Input (Optional) 0 - Patient Demographic 1 - (default) Patient Demographic and Clinical 2 - other (locally defined) This entry point builds an HL7 package dynamic link list for a patient. ******************** 2779 NAME: DBIA2779 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: MAR 22,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function will indentify that a given patient is either a dead patient, test patient, an employee, a non-veteran, or a Psuedo patient. It will return a 1 if it meets the given parameter or a 0 if it does not meet the given parameter. ROUTINE: VAFCUTL1 COMPONENT: SEND2 VARIABLES: DFN,PARAMS Type: Input DFN - IEN of PATIENT (#2) file PARAMS - "D"ead Patient "T"est Patient "E"mployee "V"eteran (Non) "P"suedo 0 or 1 Type: Output The function will return a 1 if the patient is a Dead patient, Test patient, an Employee, a Non-Veteran or psuedo. Otherwise, the function will return a 0. Will identify that a given patient is either a dead patient, test patient, an employee, a non-veteran, or a Psuedo patient. COMPONENT: $$SEND2 VARIABLES: $$SEND2 Type: Output if the PARAM variable contains: "D", the function will return a 1 if the patient is a Dead patient. "T", the ...................... 1 ................. a Test patient "E", the ...................... 1 ................. an Employee. "V", the ...................... 1 ................. a Non-Veteran. "P", the ...................... 1 ................. Psuedo otherwise the function returns 0 PARAMS Type: Input "D" - Dead patient. "T" - Test patient "E" - an Employee. "V" - a Non-Veteran. "P" - Psuedo DFN Type: Input IEN from PATIENT (#2) file This function screens out certain types of patients. ******************** 2780 NAME: DBIA2780 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: PATIENT DATA EXCHANGE USAGE: Private ENTERED: MAR 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Integrated Billing allows PDX to read and write several patient insurance data elements to support the exchange of insurance information between facilities. Update: IB*2*497 increased the length of the SUBSCRIBER ID field and the NAME OF INSURED field to support the EDI New Standards and Operating Rules for VHA providers. This required length increase made it necessary to move the location of these 2 fields to new Data Dictionary nodes in the INSURANCE TYPE sub-file. To support this implementation, all subscribers to this ICR will need to make the necessary changes in their applications to reference the new fields and remove the references to the old fields. When all subscribers have implemented the use of the new fields, the old fields will be deleted with IB*2*518. New fields are noted in the field list detail of this ICR. ^DPT(D0,.31) .3192 COVERED BY HEALTH IN .31;11 Both R/W w/Fileman ^DPT(D0,.312,D1,0) .01 INSURANCE TYPE 0;1 Both R/W w/Fileman 1 *SUBSCRIBER ID 0;2 Both R/W w/Fileman Note: IB*2*497 - replaced by SUBSCRIBER ID field (7.02) 2 GROUP NUMBER 0;3 Both R/W w/Fileman 3 INSURANCE EXPIRATION 0;4 Both R/W w/Fileman 6 WHOSE INSURANCE 0;6 Both R/W w/Fileman 7 RENEWAL DATE 0;7 Both R/W w/Fileman 8 EFFECTIVE DATE OF PO 0;8 Both R/W w/Fileman 16 PT. RELATIONSHIP TO 0;16 Both R/W w/Fileman 17 *NAME OF INSURED 0;17 Read w/Fileman Note: IB*2*497 - replaced by NAME OF INSURED field (7.01) This agreement also allows PDX to $O through the insurance multiple. ^DPT(D0,.312,D1,7) 7.01 NAME OF INSURED 7;1 Read w/Fileman 7.02 SUBSCRIBER ID 7;2 Both R/W w/Fileman ROUTINE: ******************** 2781 NAME: DBIA2781 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: SCHEDULING CLINICAL MONITORING SYSTEM USAGE: Controlled Subscri ENTERED: MAR 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File This agreement allows certain applications to directly read the field 'Covered by Health Insurance?' for the purpose of display only. ^DPT(D0,.31) .3192 COVERED BY HEALTH IN .31;11 Direct Global Read & w ROUTINE: ******************** 2782 NAME: DBIA2782 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: MENTAL HEALTH USAGE: Private ENTERED: MAR 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File This agreement allows Mental Health to directly read specific patient insurance fields for the purpose of display only. Update: IB*2*497 increased the length of the SUBSCRIBER ID field to support the EDI New Standards and Operating Rules for VHA providers. This required length increase made it necessary to move the location of this field to a new Data Dictionary node in the INSURANCE TYPE sub-file. To support this implementation, all subscribers to this ICR will need to make the necessary changes in their applications to reference the new field and remove the reference to the old field. When all subscribers have implemented the use of the new field, the old field will be deleted with IB*2*518. The new field is noted in the field list detail of this ICR. ^DPT(D0,.312,D1,0) .01 INSURANCE TYPE 0;1 Direct Global Read & w 1 *SUBSCRIBER ID 0;2 Direct Global Read & w Note: IB*2*497 - replaced by SUBSCRIBER ID field (7.02) 2 GROUP NUMBER 0;3 Direct Global Read & w 3 INSURANCE EXPIRATION 0;4 Direct Global Read & w This agreement also allows Mental Health to $O through the insurance multiple. ^DPT(D0,.312,D1,7) 7.02 SUBSCRIBER ID 7;2 Direct Global Read & w ROUTINE: ******************** 2784 NAME: Patient File Edit CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK CLINICAL INFO RESOURCE NETWORK (RG*) will only pass the following fields to be edited: NAME (#.01), SEX (#.02), DATE OF BIRTH (#.03), SOCIAL SECURITY NUMBER (#.09), ALIAS (#1), MOTHER'S MAIDEN NAME (#.2403), PSEUDO SSN REASON (#.0906), and SSN VERIFICATION STATUS (#.0907). MASTER PATIENT INDEX VISTA MASTER PATIENT INDEX VISTA (MPIF*) will only pass the following fields to be edited: NAME (#.01), SEX (#.02), DATE OF BIRTH (#.03), SOCIAL SECURITY NUMBER (#.09), ALIAS (#1), MOTHER'S MAIDEN NAME (#.2403), PSEUDO SSN REASON (#.0906), and SSN VERIFICATION STATUS (#.0907). EMERGENCY DEPARTMENT 2/23/16 - The Emergency Department application was added as a subscriber to document an existing use of EDIT^VAFCPTED in routine PHONE^EDPUPD. The API has been used by EDIS since EDIS version 2.0/2.1.2 to update the Phone Number [Residence] (#.131), Phone Number [Cellular] (#.134) and K-Phone Number (#.219) in the Patient (#2) file. A new request should be submitted for review if the VAFCPTED API will be used in the future to update additional Patient (#2) file fields. HEALTH MANAGEMENT PLATFORM HMP v.2.0 contains calls to VAFCPTED to update the following fields: PHONE NUMBER [RESIDENCE] (#.131), PHONE NUMBER [WORK] (#.132), PHONE NUMBER [CELLULAR] (#.134), K-PHONE NUMBER (#.219) and E-PHONE NUMBER (#.339). HMP PUT DEMOGRAPHICS RPC was part of a feature in earlier versions of eHMP, and is no longer being used. Temporary approval to add HMP as a subscriber allowed until any calls to this API can be removed in a future patch. HMP's subscription to this ICR expires on 10/27/17 when HMP will be shutdown. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated, this ICR should be reviewed and a new expiration date set with the custodial application if the call to VAFCPTED was not removed prior to the HMP shut down. VIRTUAL PATIENT RECORD VPR added as a subscriber for VPR*1*3. This patch was installed at 3 test sites but later backed out at these sites. However the patch was released to OSEHRA. VPR*1*3 code calls VAFCPTED to update the Phone Number [Residence] (#.131), Phone Number [Work] (#.132), Phone Number [Cellular] (#.134), K-Phone Number (#.219) and E-Phone Number (#.339) fields in the Patient (#2) file. USAGE: Controlled Subscri ENTERED: MAR 23,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This private routine agreement allows packages to update certain PATIENT (#2) file fields identified by each subscribing package. ROUTINE: VAFCPTED COMPONENT: EDIT(DFN,ARRAY,STRNGDR) VARIABLES: DFN Type: Input DFN - IEN in the PATIENT (#2) file ARRAY Type: Input Array value which contains fields to be edited. The value should be passed as shown, "ARRAY(2)" and the array should be in the following form: Ex. ARRAY(.111)="123 STREET" or ARRAY(2,.111)="123... STRNGDR Type: Input This is a string of PATIENT (#2) file fields separated by semicolons which match the fields passed in the ARRAY variable. This routine is used to edit an existing patient. ******************** 2786 NAME: DBIA2786 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: MAR 24,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File This agreement allows the DSS EXTRACTS application to directly read specific patient insurance information for extraction by VISN 19. ^DPT(D1,.312,D0,0) .01 INSURANCE TYPE 0;1 Direct Global Read & w This agreement also allows DSS Extracts to $O through the insurance multiple. ROUTINE: ******************** 2787 NAME: DBIA2787 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: MAR 24,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File In order to calculate the total number of in-patient deaths in a given time period, the Laboratory package must utilize the DATE OF DEATH cross-reference ^DPT("AEXP1" of the PATIENT file (#2). This is a cross-reference of the DATE OF DEATH field (#.351). This a read-only usage of this file. ROUTINE: ******************** 2788 NAME: XQALBUTL CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA lists and defines supported references within the routine XQALBUTL. AHISTORY(XQAID,ROOT) - Returns info on alert XQAID in ROOT in global format $$PENDING(XQAID,XQAUSER) - Indicates whether alert XQAID is pending for user XQAUSER (1=YES, 0=NO). $$PKGPEND(XQAUSER,XQAPKG) - Returns 1 if the user indicated by XQAUSER has any pending alerts in which the first ';'-piece of XQAID contain the package identifier indicated by XQAPKG. ALERTDAT(XQAID,ROOT) - Returns info on alert XQAID in ROOT by field and values (if ROOT is not specified, returned in local variable XQALERTD) USERLIST(XQAID,ROOT) - Returns list of users who received alert XQAID in array under ROOT (if ROOT is not specified, returned in local variable XQAUSRS) USERDATA(XQAID,XQAUSER,ROOT) - Returns info on user XQAUSER for alert XQAID in ROOT by field and values (if ROOT is not specified, returned in local variable XQALUSER). ROUTINE: XQALBUTL COMPONENT: AHISTORY VARIABLES: XQAID Type: Input This is the value XQAID which is the alert identifier. It is passed to the routine or option which is run when the alert is selected. It can also be obtained from a listing of all of the XQAIDs for a specified user and/or patient. ROOT Type: Input This argument is a closed reference to a local or global root. The information associated with the desired entry in the alert tracking file is returned descendent from the specified root. The data returned reflects the global structure of the Alert Tracking file. A more user (developer) friendly call would be ALERTDAT described within this same unit which returns the data in an array with the field numbers and names as the subscripts and the internal and external (if different) values as the value. Returns information from the alert tracking file for alert with XQAID as its alert ID. The data is returned desendent from the closed root passed in ROOT. Usually, XQAID will be known based on alert processing. The following example illustrates the use of this call and the format of the data returned. S XQAID="NO-ID;20;2990212.11294719" D AHISTORY^XQALBUTL(XQAID,"XXXROOT") ZW XXXROOT XXXROOT(0)=NO-ID;20;2990212.11294719^2990212.112947^NO-ID^^20 XXXROOT(1)=TEST MESSAGE (ROUTINE) 20^^^XM XXXROOT(20,0)=^8992.11^20^1 XXXROOT(20,1,0)=20^2990212.112954^2990212.145609^2990212.14562 1^2990212.145621 XXXROOT(20,"B",20,1)= This is in the basic structure of the nodes taken from the global for this entry, which can be seen from a global map view of file 8992.1 ^XTV(8992.1,D0,0)= (#.01) NAME [1F] ^ (#.02) DATE CREATED [2D] ^ (#.03) PKG ==>ID [3F] ^ (#.04) PATIENT [4P] ^ (#.05) GENERATED BY [5P] ^ ==>(#.06) GENERATED WHILE QUEUED [6S] ^ (#.07) STATUS [7S] ^ ==>(#.08) RETENTION DATE [8D] ^ ^XTV(8992.1,D0,1)= (#1.01) DISPLAY TEXT [1F] ^ (#1.02) OPTION FOR PROCESSING ==>[2F] ^ (#1.03) ROUTINE TAG [3F] ^ (#1.04) ROUTINE FOR ==>PROCESSING [4F] ^ ^XTV(8992.1,D0,2)= (#2) DATA FOR PROCESSING [E1,245F] ^ ^XTV(8992.1,D0,20,0)=^8992.11PA^^ (#20) RECIPIENT ^XTV(8992.1,D0,20,D1,0)= (#.01) RECIPIENT [1P] ^ (#.02) ALERT FIRST DISPLAYED ==>[2D] ^ (#.03) FIRST SELECTED ALERT [3D] ^ (#.04) ==>PROCESSED ALERT [4D] ^ (#.05) DELETED ON [5D] ^ ==>(#.06) AUTO DELETED [6D] ^ (#.07) FORWARDED BY [7P] ==>^ (#.08) DATE/TIME FORWARDED [8D] ^ (#.09) DELETED ==>BY USER [9P] ^ A set of newer entry points are available for returning this information in a more user (developer) friendly form which may be more desirable than this format. ALERTDAT - returns basic information about the alert USERLIST - returns the list of users who have received the alert USERDATA - returns information about one user with respect to the specified alert COMPONENT: PENDING VARIABLES: XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the desired user. XQAID Type: Input This is the value XQAID which is the alert identifier. It is passed to the routine or option which is run when the alert is selected. It can also be obtained from a listing of all of the XQAIDs for a specified user and/or patient. Returns whether the user specified has the alert indicated by the argument XQAID pending. (1=YES, 0=NO). Usage is as $$PENDING^XQALBUTL(XQAUSER,XQAID) S XQAID="NO-ID;20;2990212.11294719" W $$PENDING^XQALBUTL(20,XQAID) 0 <===== Not pending S XQAID="NO-ID;20;2990212.15540723" W $$PENDING^XQALBUTL(20,XQAID) 1 <===== Pending COMPONENT: ALERTDAT VARIABLES: XQAID Type: Input This is the value XQAID which is the alert identifier. It is passed to the routine or option which is run when the alert is selected. It can also be obtained from a listing of all of the XQAIDs for a specified user and/or patient. ROOT Type: Input This argument is a closed reference to a local or global root. The desired information is returned descendent from the specified root. Returns information from alert tracking file for alert with XQAID in array specified by ROOT. If ROOT is not specified, then the data is returned in an array XQALERTD. If the specified alert is not present, the array root is returned with a NULL value. Usage: D ALERTDAT^XQALBUTL(XQAID,ROOT) S XQAID="NO-ID;20;2990212.11294719" D ALERTDAT^XQALBUTL(XQAID,$NA(^TMP($J,"A"))) D ^%G Global ^TMP($J,"A" TMP($J,"A" ^TMP(539056198,"A",.01) = NO-ID;20;2990212.11294719 ^TMP(539056198,"A",.01,"NAME") = ^TMP(539056198,"A",.02) = 2990212.112947^FEB 12, 1999@11:29:47 ^TMP(539056198,"A",.02,"DATE CREATED") = ^TMP(539056198,"A",.03) = NO-ID ^TMP(539056198,"A",.03,"PKG ID") = ^TMP(539056198,"A",.04) = ^TMP(539056198,"A",.04,"PATIENT") = ^TMP(539056198,"A",.05) = 20^USER,XXX ^TMP(539056198,"A",.05,"GENERATED BY") = ^TMP(539056198,"A",.06) = ^TMP(539056198,"A",.06,"GENERATED WHILE QUEUED") = ^TMP(539056198,"A",.07) = ^TMP(539056198,"A",.07,"STATUS") = ^TMP(539056198,"A",.08) = ^TMP(539056198,"A",.08,"RETENTION DATE") = ^TMP(539056198,"A",1.01) = TEST MESSAGE (ROUTINE) 20 ^TMP(539056198,"A",1.01,"DISPLAY TEXT") = ^TMP(539056198,"A",1.02) = ^TMP(539056198,"A",1.02,"OPTION FOR PROCESSING") = ^TMP(539056198,"A",1.03) = ^TMP(539056198,"A",1.03,"ROUTINE TAG") = ^TMP(539056198,"A",1.04) = XM ^TMP(539056198,"A",1.04,"ROUTINE FOR PROCESSING") = ^TMP(539056198,"A",2) = ^TMP(539056198,"A",2,"DATA FOR PROCESSING") = The data elements at the top level of the Activity Tracking file are returned subscripted by the field numbers. This subscript is sufficient to obtain the data. The values are shown as internal^external if the internal and external forms are different. The next subscript after the field number will provide the field names if they are desired. COMPONENT: USERLIST VARIABLES: XQAID Type: Input This is the value XQAID which is the alert identifier. It is passed to the routine or option which is run when the alert is selected. It can also be obtained from a listing of all of the XQAIDs for a specified user and/or patient. ROOT Type: Input This argument is a closed reference to a local or global root. The desired information is returned descendent from the specified root. If this value is not specified, the data will be returned in the local array XQALUSRS. Returns recipients of alert with ID of XQAID from alert tracking file in the array specified by ROOT. If ROOT is not specified, then the data is returned in the array XQALUSRS. If the specified alert is not present, the array root is returned with a NULL value. Usage: D USERLIST^XQALBUTL(XQAID,ROOT) or Usage: D USERLIST^XQALBUTL(XQAID) (DATA RETURNED IN XQALUSRS) D USERLIST^XQALBUTL(XQAID) ZW XQALUSRS XQALUSRS(1)=20^USER,XXX COMPONENT: USERDATA VARIABLES: XQAID Type: Input This is the value XQAID which is the alert identifier. It is passed to the routine or option which is run when the alert is selected. It can also be obtained from a listing of all of the XQAIDs for a specified user and/or patient. XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the desired user. ROOT Type: Input This argument is a closed reference to a local or global root. The desired information is returned descendent from the specified root. If this value is not specified, the data will be returned in the local array XQALUSER Returns information from alert tracking file related to alert with ID of XQAID for user specified by XQAUSER. Data is returned descendent from the closed root specified by ROOT (or if ROOT is not passed, under the array XQALUSER). If the specified alert is not present, the array root is returned with a NULL value. Usage: D USERDATA^XQALBUTL(XQAID,XQAUSER,ROOT) or Usage: D USERDATA^XQALBUTL(XQAID,XQAUSER) (data returned in local array XQALUSER) D USERDATA^XQALBUTL(XQAID,20,"XXX") ZW XXX XXX(.01)=20^USER,XXX XXX(.01,"RECIPIENT")= XXX(.02)=2990212.112954^FEB 12, 1999@11:29:54 XXX(.02,"ALERT FIRST DISPLAYED")= XXX(.03)=2990212.145609^FEB 12, 1999@14:56:09 XXX(.03,"FIRST SELECTED ALERT")= XXX(.04)=2990212.145621^FEB 12, 1999@14:56:21 XXX(.04,"PROCESSED ALERT")= XXX(.05)=2990212.145621^FEB 12, 1999@14:56:21 XXX(.05,"DELETED ON")= XXX(.06)= XXX(.06,"AUTO DELETED")= XXX(.07)= XXX(.07,"FORWARDED BY")= XXX(.08)= XXX(.08,"DATE/TIME FORWARDED")= XXX(.09)= XXX(.09,"DELETED BY USER")= COMPONENT: PKGPEND VARIABLES: XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the desired user. XQAPKG Type: Input This variable is the package identifier portion of the alert identifier (XQAID). It is a textual identifier for the package which created the alert and is the first ';'-piece of the XQAID. It can be used in this context to determine whether the user specified by XQAUSER has any alerts pending containing the specified package identifier. The return value of one indicates one or more pending alerts for the user containing the specified package string in the package part of the XQAID. Returns whether the user specified has an alert with XQAID containing the first ';'-piece (PACKAGE identifier) indicated by the argument XQAPKG pending. (1=YES, 0=NO). If a value of 1 is returned, it indicates one or MORE alerts pending containing the specified package identifier. The package identifier used can be a complete package identifier (e.g., XU-TSK) or a more general part (e.g., XU) to find users with any XU package alert. Usage is as $$PKGPEND^XQALBUTL(XQAUSER,XQAPKG) S XQAPKG="XU" W $$PKGPEND^XQALBUTL(20,XQAPKG) 0 <===== Not pending S XQAPKG="XU" W $$PKGPEND^XQALBUTL(20,XQAPKG) 1 <===== Pending (one or more) ******************** 2789 NAME: DBIA2789 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY VENDOR - AUDIOFAX, INC. CMOP VENDOR - TECHPRO SYSTEMS INC USAGE: Controlled Subscri ENTERED: MAR 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This is the common lock routine for patient locks in Inpatient Medications and Outpatient pharmacy. It also contains the entry points for single order locks between Inpatient/Outpatient and Computerized Patient Record System (CPRS). ROUTINE: PSSLOCK COMPONENT: $$L VARIABLES: DFN Type: Input Patient internal entry number. DIS Type: Input This variable controls the printing of the unsuccessful lock message. A value of '1' will display the message of who has the patient locked. A value of '0' will cause the message to not be printed. $T Type: Output If the patient was successfully locked, the value of "1" will be returned. If the patient is already locked by another user, the value of "0^User Name^Date/time user locked patient (external form). Pharmacy patient lock entry point. COMPONENT: UL VARIABLES: DFN Type: Input Patient internal entry number. Pharmacy patient unlock entry point. COMPONENT: LS VARIABLES: DFN Type: Input Patient internal entry number. X Type: Input Inpatient order number. Inpatient Medications single order lock entry point. COMPONENT: UNL VARIABLES: DFN Type: Input Patient internal entry number. X Type: Input Inpatient order number. Inpatient Medications single order Unlock entry point. COMPONENT: PSOL VARIABLES: X Type: Input Outpatient order number. PSOMSG Type: Output Returned as 1 for successful lock, 0 for non-successful lock. Outpatient Pharmacy single order lock entry point. COMPONENT: PSOUL VARIABLES: X Type: Input Outpatient order number. Outpatient Pharmacy single order unlock entry point. ******************** 2790 NAME: XQALSURO CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA describes supported references in the routine XQALSURO which may be used to obtain information on, set, or remove a surrogate for alerts for a user. ROUTINE: XQALSURO COMPONENT: CURRSURO VARIABLES: XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the user that the surrogate inquiry is for. This reference is used to obtain the current surrogate for alerts (if any for the user with DUZ specified by XQAUSER. Usage is $$CURRSURO^XQALSURO(XQAUSER) The value returned is the DUZ of the surrogate or -1 if there is no surrogate specified. COMPONENT: SETSURO VARIABLES: XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the user that the surrogate is to be set for. XQALSURO Type: Input This is the internal entry number in file 200 for the NEW PERSON entry who is to act as surrogate and receive the alerts instead of the user XQAUSER. XQALSTRT Type: Input This is an optional date-time value for when the surrogate activity is to start, if this value is not specified, then the surrogate will become active at the time it is set. XQALEND Type: Input This is an optional date-time value for when the surrogate activity is to stop. When an alert is sent that is after the specified date-time, the surrogate will be removed and alerts will be sent to the user specified instead of the surrogate. If this value is not specified, the surrogate will remain active until the removed or another surrogate specified. This entry point is used to establish (or replace) a surrogate for the user specified by XQAUSER. The Surrogate is specified by passing the value of DUZ in the variable XQALSURO. XQALSTRT is an optional date/time for the surrogate to become active. If XQALSTRT is not specified, the surrogate becomes active immediately. XQALEND is an optional date/time when the surrogate would be removed. If XQALEND is not specified, the surrogate will remain active until removed. During a period with an active surrogate, all alerts for the user (XQAUSER) are directed towards the surrogate (XQALSURO). COMPONENT: REMVSURO VARIABLES: XQAUSER Type: Input This is the internal entry number in file 200 (DUZ value) for the desired user. This entry point is used to remove any surrogates for alerts for the specified user. COMPONENT: ACTVSURO VARIABLES: XQAUSER Type: Input This is the DUZ value of the user for whom the currently active alert recipient is desired. This entry point provides a method to determine who is currently the active recipient for a specified user. This may be the DUZ of the user, or the DUZ of a surrogate designated for the user, or if the user is no longer an active user, a value of -1. Usage is $$ACTVSURO^XQALSURO(XQAUSER) ******************** 2795 NAME: DBIA2795 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: APR 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.51 ROOT: SCTM(404.51 DESCRIPTION: TYPE: File The Clinical Reminder Package would like to reference the following file directly : TEAM #404.51 - Determine team's institution As corresponding APIs are planned, this IA will be in effect until the appropriate APIs are released. ^SCTM(404.51, .07 INSTITUTION Direct Global Read & w .01 NAME 0;1 Read w/Fileman ^SCTM(404.51,"AINST", Cross Reference by Institution ROUTINE: ******************** 2796 NAME: RGHLLOG line Tags CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA REGISTRATION TOOLKIT USAGE: Controlled Subscri ENTERED: APR 6,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MPIF is requesting to utilize entry piotns EXC, START and STOP of RGHLLOG to take advantage of the CIRN Exception Handling. ROUTINE: RGHLLOG COMPONENT: EXC VARIABLES: RGEXC Type: Input RGEXC is the .01 NUMBER from the CIRN HL7 EXCEPTION TYPE FILE for the exception you are attempting to log. RGERR Type: Input RGERR is the text message to be included in the Exception message generated. EXC^RGHLLOG(RGEXC,RGERR) would be called to log the exception type of RGEXC with a textual message included in RGERR. RGEXC is the .01 of the exception being logged. MPIF will only pass .01s that are in the 200-299 number range. COMPONENT: START VARIABLES: RGMSG Type: Input RGMSG - is the HL7 message number of the message being processed, This can be 0 also. RGDC Type: Input RGDC is used to update the COUNT field in the file. MPI will not be utilizing this field, but instead allow the counting to occur within RGHLLOG functionality. RGPARAM Type: Input RGPARAM - this varibale holds the name of the routine that would be used to reprocess the message. MPI will not be utilizing this functionality. START^RGHLLOG(RGMSG,RGDC,RGPARAM) which allow the exceptions to be logged for a particular HL7 message that is being processed. COMPONENT: STOP VARIABLES: RGQUIT Type: Input RGQUIT is the HL7 message number being processed, that was specified when START^RGHLLOG was called. This can be null or 0 also. STOP^RGHLLOG(RGQUIT) to stop exceptions being logged for a HL7 message specified in RGQUIT. ******************** 2801 NAME: Notification/Alert Follow-up Access to GMRCEDIT CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Allows subscribing package(s) access into the following routine for Consult/Request Tracking notification/alert follow-up actions: EN^GMRCEDIT ROUTINE: GMRCEDIT COMPONENT: EN VARIABLES: NXQADATA Type: Input NXQADATA is the Consult/Request number. XQAID Type: Input XQAID is the alert identifier in the form: OR,,;; ******************** 2802 NAME: Notification/Alert Follow-up Access to GMRCALRT CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: APR 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Allows subscribing package(s) access into the following routine for Consult/Request Tracking notification/alert follow-up actions: EN^GMRCALRT ROUTINE: GMRCALRT COMPONENT: EN VARIABLES: NXQADATA Type: Input NXQADATA is the Consult/Request number. XQAID Type: Input XQAID is the alert identifier in the form: OR,,;; ******************** 2804 NAME: DBIA2804 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: DEC 21,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 44 ROOT: SC( DESCRIPTION: TYPE: File The Clinical Reminder Package would like to reference the HOSPITAL LOCATION file #44 directly to determine the CLINIC GROUP and STOP CODE NUMBER for a location and all patients with APPOINTMENTS at a clinic on a given date. ^SC(DO,0 31 CLINIC GROUP 31 Direct Global Read & w 8 STOP CODE NUMBER 7 Direct Global Read & w ROUTINE: ******************** 2805 NAME: DBIA2805 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: APR 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.6 ROOT: PS(59.6, DESCRIPTION: TYPE: File Pharmacy Benefits Management retrieves a data field from FILE: INPATIENT WARD PARAMETERS GLOBAL: ^PS(59.6, FILE #: 59.6 FIELD .03 DAYS UNTIL STOP DATE/TIME ^PS(59.6,D0,0) .03 DAYS UNTIL STOP DATE 0;3 Read w/Fileman ROUTINE: ******************** 2806 NAME: RAD/NUC MED PATIENT PROCEDURE STATUS CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: APR 21,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CLIN^RAO7PC2 can be used to return information on the most recent date that a list of procedures was completed for a given patient, and if the procedure is currently in progress the appropriate date. Information is also returned if a procedure was cancelled or if there is no record of the procedure for the patient. ROUTINE: RAO7PC2 COMPONENT: CLIN VARIABLES: RADFN Type: Input RADFN = Internal entry number (ien) of the patient in the Rad/Nuc Med Patient file #70. (Note: this is the same ien as used in the Patient file #2. File 70 is DINUMED to file 2. RADFN is also known as the patient ien. PROCLIST Type: Input PROCLIST = List of internal entry numbers (iens) of procedures on the Rad/Nuc Med Procedures file #71. The list is delimited by the '^' character. CLIN^RAO7PC2(RADFN,.PROCLIST) Input: RADFN = ien of patient in the Rad/Nuc Med Patient File #70 PROCLIST = list of iens of procedures in the Rad/Nuc Med Procedures File #71. This list is delimited by '^'. Output: ^TMP($J,"RADPROC",patient ien,procedure ien,order)= Date/Time^Status^Provider Subscripts ---------- patient ien: same as RADFN input variable procedure ien: an individual ien taken from PROCLIST input variable order: free-text, either "NONE", "CANCELLED", "IN PROGRESS" or "COMPLETE". If the procedure has never been applied to the patient identified by RADFN then an order of NONE will be returned. There will be no other nodes for this procedure. If the procedure has ever been cancelled or completed or is currently in progress then "CANCELLED", "COMPLETED" and "IN PROGRESS" nodes will exist respectively. An order of CANCELLED is returned if EXAM STATUS=0. An order of COMPLETE is returned is EXAM STATUS=9. All other EXAM STATUS values result in an order of "IN PROGRESS". EXAM STATUS is taken from the multiple file #70.03 Array Values ------------ Date/Time: the date and time derived from EXAM DATE on the Registered Exams multiple of the Rad/Nuc Med Patient File #70.02. It is held in FileMan date/time format. e.g. 2990421.1422 Status: derived from the EXAM STATUS on Examinations multiple of the Rad/Nuc Med Patient file #70.03 It is stored as the description taken from STATUS on the Examination Status file #72. Provider: derived from either PRIMARY INTERPRETING RESIDENT or PRIMARY INTERPRETING STAFF on the Examinations multiple of the Rad/Nuc Med Patient file #70.03. PRIMARY INTERPRETING RESIDENT is returned only if no STAFF exists. It is stored as the description taken from NAME on the New Person File #200. Null is returned if the order is "NONE" as there is no information to hold. ******************** 2807 NAME: OE/RR sets ID WRITE node CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: APR 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DD( DESCRIPTION: TYPE: File This DBIA documents hard setting of the 'ID','WRITE' node for a multiple in the ORDER DIALOG file. We would like to make this a generic request, however, for OE/RR to set 'ID','WRITE' nodes as apporpriate. The only alternative to hard setting this node is to send the entire DD of a file out. Within a patch, sending the whole file can create an unnecessarily large distribution which can cause us to move to an HFS file rather than exporting the build via the National Patch Module. The specific instance that generated this DBIA sends out post-installation code in routine ORY46 as follows: ; -- Reset ID WRITE node for Items S ^DD(101.412,0,"ID","WRITE")="N OR0,ORNM S OR0=^(0) I $P(OR0,U,2) S ORNM=$P($G(^ORD(101.41,+$P(OR0,U,2),0)),U) D:$L(ORNM) EN^DDIOL(ORNM,,""? 10"")" ^DD(fn,0,'ID','WRITE') Allows hard setting of node for file or subfile. ROUTINE: ******************** 2808 NAME: DBIA2808 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: APR 29,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 58.81 ROOT: PSD(58.81 DESCRIPTION: TYPE: File This is an open agreement between Drug Accountability and Controlled Substances. The terms of this agreement are to allow Controlled Substances access to any field in the DRUG ACCOUNTABILITY TRANSACTION file (#58.81). The method of access can be either Direct Read/Write or by using Filemanager. The reason for this agreement is that prior to the release of Drug Accountability 3.0, this file was the property of Controlled Substances. ROUTINE: ******************** 2809 NAME: DBIA2809 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: APR 29,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 58.811 ROOT: PSD(58.811 DESCRIPTION: TYPE: File This is an open agreement between Drug Accountability and Controlled Substances. The terms of this agreement are to allow Controlled Substances access to any field in the DRUG ACCOUNTABILITY ORDER file (#58.811). The method of acccess can be either Direct Read/Write or by using Filemanager. The reason for this agreement is that prior to the release of Drug Accountability 3.0, this file was the property of Controlled Substances. ROUTINE: ******************** 2810 NAME: DBIA2810-A CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: APR 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.57 ROOT: SCTM(404.57 DESCRIPTION: TYPE: File The Clinical Reminder Package would like to reference the following file directly : TEAM POSITION #404.57 - Determine associated Clinic for Team Position As corresponding APIs are planned, this IA will be in effect until the appropriate APIs are released. ^SCTM(404.57,0 .09 ASSOCIATED CLINIC Direct Global Read & w ROUTINE: ******************** 2811 NAME: DBIA2810-B CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: APR 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.43 ROOT: SCPT(404.43, DESCRIPTION: TYPE: File The Clinical Reminder Package would like to reference the following files directly : PATIENT TEAM POSITION ASSIGNMENT #404.43 - Determine Team Position As corresponding APIs are planned, this IA will be in effect until the appropriate APIs are released. ^SCPT(404.43,0 .02 TEAM POSITION Direct Global Read & w ROUTINE: ******************** 2812 NAME: TIU GET DOCUMENT COUNT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING SCHEDULING USAGE: Controlled Subscri ENTERED: APR 30,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIUSRVLV ^TMP("TIULIST",$J) may be killed before and after use. ROUTINE: TIUSRVLV COMPONENT: DOCCNT(TIUY,DFN,VSTR,VSIT) VARIABLES: TIUY Type: Output The number of TIU documents, this value is returned to the calling routine. DFN Type: Input Internal number of the patient as stored in ^DPT(DFN VSTR Type: Input A Visit string representing an encounter in the form of "Location";"date/tame";"service category" where "location", "date/time" and "service category" would be replaced with the actual values. VSIT Type: Input Optional value containing the Visit number. This entry point returns the number of TIU documents for a visit. The Visit may be identified by DFN and visit string or visit. COMPONENT: NOTES(.ARRAY,VISIT,STATUS) VARIABLES: .ARRAY Type: Both Passed by reference as name of array to receive output. Receives list of notes for visit (and optionally only a certain status of notes). Return array is in the following format: Return array is in the following format: ^TMP("TIULIST",$J,9999999-VERIFICATION DATE/TIME,COUNTER)=record data from record is as follows Piece: Data 1 IEN of TIU DOCUMENT file (#8925) 2 Display name of document class 3 Reference date (internal format) 4 Patient Name in format (LAST, FIRST MI) followed by space followed by last 4 5 Signature name of author/dictator 6 Name of Hospital Location associated with note 7 Name of TIU STATUS in lower case 8 'Adm: ' if type of location is a ward or 'Visit: ' otherwise appeneded with EPISODE BEGIN DATE/TIME in format MM/DD/YY 9 If EPISODE END DATE/TIME exists, returns 'Dis: " appended to the date in MM/DD/YY format. VISIT Type: Input Pointer to the VISIT file (#9000010). STATUS Type: Input Optional: Internal value of the TIU STATUS file denoting the status of notes you want returned. If not passed, all notes for visit are returned. Returns a list of notes COMPONENT: SUMMARY(.ARRAY,VISIT,STATUS) VARIABLES: .ARRAY Type: Both Passed by reference as name of array to receive output. Receives list of summaries for visit (and optionally only a certain status of summaries). Return array is in the following format: ^TMP("TIULIST",$J,9999999-VERIFICATION DATE/TIME,COUNTER)=record data from record is as follows Piece: Data 1 IEN of TIU DOCUMENT file (#8925) 2 Display name of document class 3 Reference date (internal format) 4 Patient Name in format (LAST, FIRST MI) followed by space followed by last 4 5 Signature name of author/dictator 6 Name of Hospital Location associated with note 7 Name of TIU STATUS in lower case 8 'Adm: ' if type of location is a ward or 'Visit: ' otherwise appeneded with EPISODE BEGIN DATE/TIME in format MM/DD/YY 9 If EPISODE END DATE/TIME exists, returns 'Dis: " appended to the date in MM/DD/YY format. VISIT Type: Input Pointer to the VISIT file (#9000010). STATUS Type: Input Optional: Internal value of the TIU STATUS file denoting the status of summaries you want returned. If not passed, all summaries for visit are returned. Returns list of summaries ******************** 2813 NAME: TIU REMOVE TYPE AS IDENTIFIER FROM DOC DEF FILE (#8925.1) CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: APR 30,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: DD(8925.1,0,'ID' DESCRIPTION: TYPE: File In initial test versions of TIU the .04 TYPE field of the DOCUMENT DEFINITIONS FILE (#8925.1) was defined as an identifier. This was changed prior to the release of TIU, but initial test sites still have the .04 field defined as an identifier. To remove this relationship, TIU requests permission to directly kill the Data Dictionary node defining this field as an identifier, i.e. K ^DD(8925.1,0,"ID",.04). This kill will be performed during the installation routine of TIU*1.0*38, which could not install properly without removal of the identifier status. ^DD(8925.1,0,'ID',.04) .04 TYPE Write w/Fileman ROUTINE: ******************** 2816 NAME: CPT MODIFIERS FILE CUSTODIAL PACKAGE: CPT/HCPCS CODES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 81.3 ROOT: DIC(81.3, DESCRIPTION: TYPE: File This will allow other packages to conduct FileMan lookups and to point to the CPT MODIFIERS file #81.3. Direct read of the "B", "BA" and "ACT" cross-references will be permitted. Direct read of any node in file 81.3 by the Lexicon Environment Check Routines will also be permitted. ^DIC(81.3,DA .01 MODIFIER 0;1 Pointed to May be pointed to by other files. ^DIC(81.3,'B', Direct global read of the "B" cross reference. ^DIC(81.3,'BA', Direct global read of the "BA" cross reference. ^DIC(81.3,'ACT', Direct global read of the "ACT" cross reference. ROUTINE: ******************** 2817 NAME: OE/RR looks at 'AD' x-ref in DG(40.8 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING ACCOUNTS RECEIVABLE OUTPATIENT PHARMACY E CLAIMS MGMT ENGINE SURGERY VBECS INTEGRATED BILLING CLINICAL PROCEDURES ADDED 9/28/2009 BAR CODE MED ADMIN ADDED 5/2/2011 MENTAL HEALTH Added 10/19/2020. USAGE: Controlled Subscri ENTERED: MAY 17,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File OE/RR would like permission to reference the 'AD' x-ref in file 40.8 (MEDICAL CENTER DIVISION). We need this to get the INSTITUTION file pointers associated with a medical center. ALL^VASITE returns the pointers to 40.8 and not file 4. ^DG(40.8,'AD',DIV) ROUTINE: ******************** 2818 NAME: OE/RR References to Alert Tracking File CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING OE/RR will use this DBIA until the code in ORB3REG can be patched to use apis provided in XU*8.0*114. Once ORB3REG is patched and released, the direct access of XTV(8992.1 will be eliminated and this DBIA will no longer be necessary. USAGE: Private ENTERED: MAY 17,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8992.1 ROOT: XTV(8992.1 DESCRIPTION: TYPE: File OE/RR utilizes the alert tracking file to obtain information from existing alerts to process new alerts. The routine ORB3REG directly accesses the XTV(8992.1 (Alert Tracking) global to obtain information from existing alerts. ^XTV(8992.1,D0,0) .01 NAME 0;1 Read w/Fileman ^XTV(8992.1,D0,2) 2 DATA FOR PROCESSING 2;E1,245 Read w/Fileman ^XTV(8992.1,D0,20) 20 RECIPIENT 20;0 Read w/Fileman ^XTV(8992.1,'B', .01 NAME 0;1 Read w/Fileman ^XTV(8992.1,'R', 20 RECIPIENT 20;0 Direct Global Read & w ROUTINE: ******************** 2819 NAME: ACCESS TO PTF RELEASE (#45.83) FILE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 18,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.83 ROOT: DGP(45.83 DESCRIPTION: TYPE: File In one of the routines for the IB Billing Lag Time Report (IBJDB11), the ^DGP(45.83 global for the PTF RELEASE file is being accessed for the PTF Transmission Date. ^DGP(45.83,D0,0) 1 TRANSMISSION DATE 0;2 Direct Global Read & w This is the date the PTF record was transmitted to Austin. This is the main global node for the PTF RELEASE file. ^DGP(45.83,D0,'P',D1,0) 1 DATE TRANSMITTED 0;2 Direct Global Read & w This is the date the PTF record was transmitted to Austin. This is the PTF RECORD sub-file global node for the PTF RELEASE file. ^DGP(45.83,'C', The 'C' cross reference is used to look up the PTF records associated with the PTF Release (#45.83) file.The 'C' cross reference is a whole file cross reference on the Record (#.01) field in the PTF Record (#10) subfile in the PTF Release (#45.83) file. ROUTINE: ******************** 2820 NAME: DBIA2820 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 18,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.84 ROOT: DGP(45.84 DESCRIPTION: TYPE: File In the IB Billing Lag Time Report, global ^DGP(45.84 is being accessed for the PTF Transmission Date. In one of the routines for the IB Billing Lag Time Report (IBJDB11), the ^DGP(45.84 global for the PTF CLOSE OUT file is being accessed for the Release Date, which is used as the IEN of the PTF RELEASE entry which has the PTF Transmission Date. ^DGP(45.84,D0,0) 4 RELEASE DATE 0;4 Direct Global Read & w This is the date the PTF record was released for transmission to Austin. This is the main global node for the PTF CLOSE OUT file. ROUTINE: ******************** 2821 NAME: DIALOG File CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 9,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: .84 ROOT: DESCRIPTION: TYPE: Other To qantify supported DIALOG entries in the DIALOG file #.84 ROUTINE: COMPONENT: 201 VARIABLES: DIALOG NUMBER: 201 TYPE: ERROR INTERNAL PARAMETERS NEEDED: YES PACKAGE: VA FILEMAN DESCRIPTION: The specified input variable is either 1) required but not defined or 2) not valid. TEXT: The input variable |1| is missing or invalid. PARAMETER SUBSCRIPT: 1 PARAMETER DESCRIPTION: Variable name. ******************** 2823 NAME: DBIA2823 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8932.1 ROOT: USC(8932.1, DESCRIPTION: TYPE: File IB is using a pointer to the Person Class file (#8932.1) to define types of providers. ^USC(8932.1, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2824 NAME: DBIA2824 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: NURSING SERVICE USAGE: Private ENTERED: MAY 24,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200 DESCRIPTION: TYPE: File Nursing requires direct global read access to the following fields in the New Person (#200) file which contain the telephone data used in the nursing End of Shift Report: .131 PHONE (HOME) .132 OFFICE PHONE .133 PHONE #3 .134 PHONE #4 .135 COMMERCIAL PHONE .136 FAX NUMBER .137 VOICE PAGER .138 DIGITAL PAGER ^VA(200,DUZ,.13 .131 PHONE (HOME) .13;1 Direct Global Read & w .132 OFFICE PHONE .13;2 Direct Global Read & w .133 PHONE #3 .13;3 Direct Global Read & w .134 PHONE #4 .13;4 Direct Global Read & w .135 COMMERCIAL PHONE .13;5 Direct Global Read & w .136 FAX NUMBER .13;6 Direct Global Read & w .137 VOICE PAGER .13;7 Direct Global Read & w .138 DIGITAL PAGER .13;8 Direct Global Read & w ROUTINE: ******************** 2825 NAME: GMTSADH5 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Used for the GUI Adhoc Health Summary. USAGE: Private ENTERED: JUL 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are the API's used to get information for the Adhoc Health Summary. ROUTINE: GMTSADH5 COMPONENT: COMP(Y) VARIABLES: Y Type: Output Y(i)=(1)I;IFN^(2)Component Name [Abb]^(3)Occ Limit^(4)Time Limit^ (5)Header Name^(6)Hosp Loc Disp^(7)ICD Text Disp^(8)Prov Narr Disp (9)CPT Modifier Disp^(10)Summary Order Gets Adhoc Health Summary components from file 142.1 COMPONENT: COMPSUB(Y,GMTSUB) VARIABLES: Y Type: Output Y(i)=ifn of pointed to file entry^name GMTSUB Type: Input Desired Adhoc subcomponent Get subcomponents from a predefined ADHOC component COMPONENT: FILES(Y,GMTSCP) VARIABLES: Y Type: Output Array of files for selection. GMTSCP Type: Input Internal entry number of component in file 142.1 to retrieve files from. Get Files to select from for a component COMPONENT: FILESEL(GMTSRT,GMTSFI,GMTSFM,DIR) VARIABLES: GMTSRT Type: Output Output array: ^TMP("ORDATA",$J, GMTSFI Type: Input File number to select from. GMTSFM Type: Input Last ifn listed in long list box. This is where to start listing from. DIR Type: Input Direction to go in the file. Forward is the default (1). Get file entries for selected component. COMPONENT: REPORT(GMTSEG,GMTSEGC,GMTSEGI,GMTSCPS,DFN) VARIABLES: GMTSEG Type: Output Output array for report. GMTSEGC Type: Output Set to the last ifn of the GMTSCPS array. GMTSGI Type: Output Array of component names defined in the Adhoc component from file 142. GMTSCPS Type: Input Array of selected components to build the Adhoc report. DFN Type: Input Builds Adhoc report COMPONENT: SUBITEM(Y,GMTSTEST) VARIABLES: Y Type: Output Array of tests included in a lab panel. GMTSTEST Type: Input Internal file number of Laboratory Test from file 60. Get Subitems for a Lab Test panel ******************** 2828 NAME: RETURN ACTIVE ORDERS TO BCMA CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: MAY 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN^PSJBCMA is provided by Inpatient Medications package to return patient active orders to Bar Code Med Admin to be used in administering medications at patient's bedside. ROUTINE: PSJBCMA COMPONENT: EN VARIABLES: DFN Type: Input Patient Internal File Number (required). BDT Type: Input Data used to start searching for order stop after this date (optional). If BDT is not included, NOW is used as the time to start searching for active orders. OTDATE Type: Input Include One-Time orders from this date (optional). If OTDATE="" 30 days from today is used. If OTDATE is not included, 30 days from the current date is used. OUTPUT DEFINITION ^TMP("PSJ",$J,Index,0) = DFN ^ ON (Order number from Inpatient Medications V. 5.0 package)^ ON_V/U/P ^ PREVIOUS ORDER ^ FOLLOWING ORDER ^ IV TYPE ^ INTERMITTENT SYRINGE ^ CHEMOTHERAPY TYPE ^ ORDERS FILE ENTRY ^TMP("PSJ",$J,Index,1) = MED ROUTE expansion ^ SCHEDULE TYPE CONVERSION ^ SCHEDULE ^ START DATE ^ STOP DATE ^ ADMIN TIMES ^ STATUS ^ NOT TO BE GIVEN FLAG ^ Original SCHEDULE TYPE ^ Auto Cancel/DC flag ^TMP("PSJ",$J,Index,1,0) = PROMPT FOR INJECTION SITE IN BCMA^MED ROUTE name ^ DSPLY ON IVP/IVPB TAB IN BCMA ^TMP("PSJ",$J,Index,2) = DOSAGE ORDERED ^ INFUSION RATE ^ SELF MED ^ HOSPITAL SUPPLIED SELF MED ^TMP("PSJ",$J,Index,3) = ORDERABLE ITEM [P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE FORM ^TMP("PSJ",$J,Index,4) = SPECIAL INSTRUCTONS (U/D) or OTHER PRINT INFO (IV) ^TMP("PSJ",$J,Index,5) = NOTIFICATION ^ FLAGGED [S] ^PHARMACY/CPRS ^ FLAG COMMENTS Notificaton will be a 1, if the order should trigger a stat/now notification. It will be 0 if no notification should be done. Piece 3 will contain PHARMACY if the flag was initiated by Pharmacy or CPRS if it was initiated by CPRS. ^TMP("PSJ",$J,Index,700,0) = Number of DISPENSE DRUG return (exists only if order is a Unit Dose order) ^TMP("PSJ",$J,Index,700,Index,0) = DISPENSE DRUG [P] ^ DISPENSE DRUG NAME ^ UNITS PER DOSE [N] ^ INACTIVE DATE ^TMP("PSJ",$J,Index,850,0) = Number of additive(s) return (exists only if IV order) ^TMP("PSJ",$J,Index,850,D0,0) = ADDITIVE [P] ^ ADDITIVE NAME ^ STRENGTH ^ BOTTLE ^^ ORDERABLE ITEM [P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE FORM ^TMP("PSJ",$J,Index,950,0) = Number of solution(s) return (exists only if IV order) ^TMP("PSJ",$J,Index,950,D0,0) = SOLUTION [P] ^ SOLUTION NAME ^ VOLUME ^ PRINT NAME {2} [F] ^^ ORDERABLE ITEM [P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE FORM Unique ID# is the Bar Code Identification Number for this label. Format: DFN_"V"_Seq, where Seq is a sequential number. ^TMP(PTMP,$J,Index,800,Unique ID#,0) = Number of additives(s) return (exists only if order is an IV order) ^TMP(PTMP,$J,Index,800,Unique ID#,Index) = ADDITIVE[P] ^ ADDITIVE NAME ^ STRENGTH [F] ^ BOTTLE ^TMP(PTMP,$J,Index,900,Unique ID#,0) = Number of solution(s) return (exists only if order is an IV order) ^TMP(PTMP,$J,Index,900,Unique ID#,Index) = SOLUTION[P] ^ SOLUTION NAME ^ VOLUME NOTE: - ^TMP("PSJ",J,1,0) = -1 will be returned if no active orders are found. ******************** 2829 NAME: RETURN DETAIL INFO ON PATIENT'S ORDER FOR BCMA CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: BAR CODE MED ADMIN DSS - DECISION SUPPORT SYSTEM EX ADDED 11/16/2010 USAGE: Controlled Subscri ENTERED: MAY 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN^PSJBCMA1 is provided by Inpatient Medications package to return the detail information on a patient's order for Bar Code Med Admin to use. ROUTINE: PSJBCMA1 COMPONENT: EN VARIABLES: DFN Type: Input Patient Internal File Number (required). ON_V/U/P Type: Input Inpatient Medications Package V. 5.0 Order Number (required). PSJTMP Type: OUTPUT DEFINITION ^TMP(PTMP,$J,0) = DFN^ON^ ON_V/U/P ^ PREVIOUS ORDER ^ FOLLOWING ORDER ^ IV TYPE ^ INTERMITTENT SYRINGE ^ CHEMOTHERAPY TYPE ^ ORDERS FILE ENTRY ^TMP(PTMP,$J,1) = PROVIDER [P] ^ PROVIDER NAME ^ MED ROUTE [P] ^ MR abbreviation ^ SELF MED [S] ^ Expand to YES/NO ^ HOSPITAL SUPPLIED SELF MED [S] ^ Expand to YES/NO ^ NOT TO BE GIVEN FLAG [S] ^ STATUS [S] ^ STATUS expansion ^ Auto Cancel/DC flag ^TMP(PTMP,$J,1,0) = PROMPT FOR INJECTION SITE ^ DSPLY ON IVP/IVPB TAB IN BCMA ^TMP(PTMP,$J,2) = ORDERABLE ITEM [1P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE ORDERED ^ INFUSION RATE [F] ^ SCHEDULE ^ DOSAGE FORM ^TMP(PTMP,$J,3) = SPECIAL INSTRUCTIONS(U/D)[F] or OTHER PRINT INFO (IV) [F] ^TMP(PTMP,$J,4) = SCHEDULE TYPE Conversion [S]^SCHEDULE TYPE expansion (from Original Schedule Type for U/D and from Schedule Type Conversion for IV orders) ^ LOG-IN DATE[D]^Expand to MM/DD/YYYY HH:MM^START DATE [D]^Expand to MM/DD/YYYY HH:MM^STOP DATE [D]^Expand to MM/DD/YYYY HH:MM^ADMIN TIMES (in four digit format) ^ Original SCHEDULE TYPE ^ FREQUENCY (Unit Dose order) or SCHEDULE INTERVAL (IV order) ^TMP(PTMP,$J,5) = VERIFYING NURSE [P]^ NURSE NAME ^ NURSE INIT^VERIFYING PHARMACIST [P] ^ PHARMACIST NAME ^ PHARMACIST INIT ^TMP(PTMP,$J,6) = REMARKS(IV)[F] ^TMP("PSJ",$J,7) = NOTIFICATION ^ FLAGGED [S] ^ PHARMACY/CPRS ^ FLAG COMMENTS Notification will be a 1 if the order should trigger a stat/now notification. It will be a 0 if no notification should be done. Piece 3 will contain PHARMACY if the flag was initated by Pharmacy or CPRS if it was initated by CPRS. ^TMP(PTMP,$J,700,0) = Number of DISPENSED DRUG return (exists only if order is a Unit Dose order) ^TMP(PTMP,$J,700,Index,0) = DISPENSED DRUG [P] ^ DISPENSED DRUG NAME ^ UNITS PER DOSE [N] ^ INACTIVE DATE [D] ^TMP("PSJ1",$J,850,0) = Number of additives(s) return (exists only if IV order) ^TMP("PSJ1",$J,850,D0,0) = ADDITIVE[P] ^ ADDITIVE NAME ^ STRENGTH [F] ^ BOTTLE ^^ ORDERABLE ITEM [P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE FORM ^TMP("PSJ1",$J,950,0) = Number of solution(s) return (exists only if IV order) ^TMP("PSJ1",$J,950,D0,0) = SOLUTION[P] ^ SOLUTION NAME ^ VOLUME [F] ^ PRINT NAME {2} [F] ^^ ORDERABLE ITEM [P] ^ ORDERABLE ITEM NAME_" "_DOSAGE FORM ^ DOSAGE FORM Unique ID# is the Bar Code Identification Number for this label. Format: DFN_"V"_Seq, where Seq is a sequential number. ^TMP(PTMP,$J,800,Unique ID#,0) = Number of additives(s) return (exists only if order is an IV order) ^TMP(PTMP,$J,800,Unique ID#,Index) = ADDITIVE[P] ^ ADDITIVE NAME ^ STRENGTH [F] ^ BOTTLE ^TMP(PTMP,$J,900,Unique ID#,0) = Number of solution(s) return (exists only if order is an IV order) ^TMP(PTMP,$J,900,Unique ID#,Index) = SOLUTION[P] ^ SOLUTION NAME ^ VOLUME [F] ^TMP(PTMP,$J,1000,Unique ID#,0) = Number of label(s) return (exists only if order is an IV order) ^TMP(PTMP,$J,1000,Unique ID#,Index) = LABEL PRINT DATE / TIME ^ BAG # ^ LABEL STATUS (set of codes) NOTE: - ^TMP(PTMP,J,0) = -1 will be returned if no detail data are found. ******************** 2830 NAME: DBIA2830 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: MAY 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN^PSJBCMA2 is provided by Inpatient Medications package to return a patient order's activity logs for Bar Code Med Admin to use. ROUTINE: PSJBCMA2 COMPONENT: EN VARIABLES: INPUT DEFINITION DFN: Patient Internal File Number (required) ON_V/U/P: Inpatient Medications Package V. 5.0 Order Number (required) PSJTMP: Flag to indicate what the first subscript (PTMP) to ^TMP should be (optional). If PSJTMP is not supplied or is 0, ^TMP will be subscripted by PSJ. If PSJTMP is 1, ^TMP will be subscripted by PSJ2. This flag will be removed in the future. It is provided for backward compatibility. OUTPUT DEFINITION ^TMP(PTMP,$J,0) = DFN ^ ON ^ ON_V/U/P ^ Number of activities returned ^TMP(PTMP,$J,INDEX,1) = ACTIVITY DATE ^ USER NAME ^ FIELD CHANGE ^ ACTION (U/D) / TYPE OF ACTIVITY (IV) ^ USER IEN (U/D) ^TMP(PTMP,$J,INDEX,2) = OLD DATA ^TMP(PTMP,$J,INDEX,3) = REASON FOR ACTIVITY (IV) NOTE: ^TMP(PTMP,J,0) = -1 will be returned if patient data are not found. ******************** 2831 NAME: Calls to ORQPT2 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consult/Request Tracking calls $$CWAD^ORQPT2(DFN). INPATIENT MEDICATIONS REGISTRATION HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA is a controlled subscription for calls to routine ORQPT2. ROUTINE: ORQPT2 COMPONENT: $$CWAD(DFN) VARIABLES: DFN Type: Input IEN of PATIENT file STRING Type: Output STRING=$$CWAD^ORQPT2(DFN) STRING can be null or up to six letters. It will contain a C if the patient has crisis notes, a W if the patient has warnings, A if the patient has allergies, D if the patient has advance directives, P if the patient is pregnant and L if the patient is breastfeeding. Returns letters C, W, A, D, P, L depending on whether patient has warnings, allergies, etc. ******************** 2832 NAME: Calls to TIUSRV CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consult/Request Tracking calls RPC^TIUSRV(.ARRAY,IEN). This call is made to retrieve the TIU narrative for use in the detailed display of the consult for the List Manger interface. ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will act as a controlled subscription for calls to TIUSRV. ROUTINE: TIUSRV COMPONENT: RPC(.ARRAY,IEN) VARIABLES: ARRAY Type: Both Output array contains global location of narrative text. (pass by reference) Default is ^TMP("TIUAUDIT",$J, and may be killed before and after use. IEN Type: Input IEN of the TIU DOCUMENT file (#8925) indicating the record for which the narrative text is required. Returns TIU Narrative. ******************** 2833 NAME: Calls to TIUBR1 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consults calls EXSTNOTE^TIUBR1(DFN,IEN). It is used to display existing TIU documents belonging to the CONSULTS class or document class for an existing patient. Selection of a note allows linking of a consult request with the chosen TIU document. This call assumes that the user is using List Manager (List Manager variables are present). USAGE: Controlled Subscri ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will act as a controlled subscription for calls to TIUBR1. ROUTINE: TIUBR1 COMPONENT: EXSTNOTE(DFN,IEN) VARIABLES: DFN Type: Input IEN of PATIENT file. IEN Type: Input IEN of TIU DOCUMENT file (#8925). Displays existing TIU documents for a patient that belong to CONSULTS class or document class. ******************** 2834 NAME: Calls to TIUSRVLO CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consults calls $$RESOLVE^TIUSRVL0(IEN) to retrieve selected information from TIU for a TIU document which is linked to a consult request. ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT CLINICAL REMINDERS VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will act as a controlled subscription for calls to TIUSRVLO. ROUTINE: TIUSRVLO COMPONENT: $$RESOLVE(IEN) VARIABLES: IEN Type: Input IEN of tiu DOCUMENT file STRING Type: Output see component description Returns data that is related to a TIU document. Output string returns (number represents ^ piece position): 1 Display name of TIU Title 2 REFERENCE DATE from TIU DOCUMENT file (internal format) 3 Patient name in format LAST, FIRST MI followed by space followed by last 4 of patient SSN 4 AUTHOR/DICTATOR from TIU DOCUMENT file as IEN;SIGNATURE BLOCK TITLE 5 External format of HOSPITAL LOCATION from TIU DOCUMENT file 6 STATUS from TIU DOCUMENT file (external format in lower case) 7 String_": "_EPISODE BEGIN DATE/TIME where String is "Adm" for ward locations and "Visit" for all other location types. Date/time is in MM/DD/YY format. 8 String_" "_EPISODE END DATE/TIME where string is null if no date/time or "Dis: " if date/time exists. Date/time is in MM/DD/YY format. 9 REQUESTING PACKAGE REFERENCE field from TIU DOCUMENT file (internal format) 10 Number of images associated with TIU DOCUMENT entry 11 SUBJECT (OPTIONAL description) field from TIU DOCUMENT file (note that characters are limited to ensure returned string is not longer than 255 characters). (this piece was added with TIU*1*63) ******************** 2835 NAME: Access to file 101.43 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: LAB SERVICE CARE MANAGEMENT RADIOLOGY/NUCLEAR MEDICINE "time to live" --> 1 Sep 2004 VISTA INTEGRATION ADAPTOR VIABDX SAVE RPC will be accessing the ID (#2) field in the Orderable Items (#101.43) file. USAGE: Controlled Subscri ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.43 ROOT: ORD(101.43 DESCRIPTION: TYPE: File This is to document the use of the Orderable Items file (101.43) in CPRS by the Laboratory Interface. ^ORD(101.43,D0,0) 2 ID 0;2 Direct Global Read & w ROUTINE: ******************** 2836 NAME: Consults use of S.CSLT and S.PROC x-refs CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: JUN 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.43 ROOT: ORD(101.43, DESCRIPTION: TYPE: File This is a private DBIA between Consults and OE/RR to allow use of teh S.CSLT and S.PROC x-refs on the ORDERABLE ITEMS file. ^ORD(101.43,'S.CSLT' Gets consult type orderable items ^ORD(101.43,'PROC', Gets procedure type orderable items. Loops directly through index and also calls DIC with D="S.PROC". ROUTINE: ******************** 2839 NAME: CPRS USE OF XPAR MENU CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUN 3,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other CPRS is requesting the ability to attach the XPAR MENU TOOLS menu to the CPRS Configuration (IRM) menu. This will allow IRM users to get to the tools menu for XPAR when editing using other CPRS-related IRM tools. ROUTINE: COMPONENT: XPAR MENU TOOLS VARIABLES: This menu contains several tools for displaying and editing parameter definitions and values. We are requesting the capability to add this to the CPRS IRM config menu. ******************** 2840 NAME: Use of TIU ACTION CWAD DISPLAY CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consults uses the TIU ACTION CWAD DISPLAY protocol on the hidden action when using the Consult Service Tracking menu. It's used to allow a user to check on the types of allergies, directives, warnings, etc. that a patient might have. USAGE: Controlled Subscri ENTERED: JUN 4,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The TIU ACTION CWAD DISPLAY protocol is exported with the TIU package. This controlled subscription DBIA will allow other packages to utilize this protocol. ROUTINE: COMPONENT: TIU ACTION CWAD DISPLAY VARIABLES: This protocol displays the CWAD indicators for a patient. ******************** 2841 NAME: TIU MEDICATION OBJECTS READ DRUG FILE CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 15,1999 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. TIU's medication objects now allow for the sorting of medications by drug class, including pending orders for medications that may not yet have a dispense drug. They also allow for the exclusion of supply items from medication lists, if desired. To accomodate this functionality, TIU requests direct global read access to the following pharmacy file: ^PSDRUG( - DRUG FILE (#50): "B" cross reference "ASP" cross reference Node 0, piece 2 - VA CLASSIFICATION FIELD (#2). Node 0, piece 3 - DEA, SPECIAL HDLG FIELD (#3) ^PSDRUG 2 VA CLASSIFICATION Direct Global Read & w B "B" CROSS REFERENCE Direct Global Read & w ASP "ASP" CROSS REFERENC Direct Global Read & w 3 DEA, SPECIAL HDLG Direct Global Read & w ROUTINE: ******************** 2842 NAME: DBIA2842 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL REMINDERS Clinical Reminders needs to obtain information about a patient's orders. USAGE: Controlled Subscri ENTERED: JUN 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORX8 COMPONENT: LATEST VARIABLES: ORPAT Type: Input Pointer to the Patient file #2. ORIT Type: Input Pointer to the Orderable Items file #101.43. ORY Type: Both This is an array passed by reference. On return ORY = total number of orders found or 0 if none are found. If orders are found then ORY(ORSTS)=ORIFN^Ord'd By^Entered^StartDT^StopDT^Loc^sts where ORSTS - the ien in the Order Status file #100.01 ORIFN - the ien of the Orderable Item file #101.43 Ord'd By - Ordered By, pointer to file #200 Entered - the date/time the ordered was entered StartDT - the start date/time StopDT - the stop date/time Loc - the location, a variable pointer to file #44 sts - the status name in lowercase ******************** 2843 NAME: DBIA2843 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL REMINDERS Clinical Reminders needs to display the name, id, and the inactivated fields of an Orderable Item. VIRTUAL PATIENT RECORD Added for use with VPR*1*1 HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. VISTA INTEGRATION ADAPTOR LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE Added 11/6/19 for access to NAME (.01 field of ORD(101.43,D0,0) global reference, effective with RA*5*161. USAGE: Controlled Subscri ENTERED: JUN 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.43 ROOT: ORD(101.43, DESCRIPTION: TYPE: File This agreement allows read access to the Orderable Items file #101.43. ^ORD(101.43,D0,0) .01 NAME 0;1 Direct Global Read & w 2 ID 0;2 Direct Global Read & w 3 CODE 0;3 Direct Global Read & w 4 CODING SYSTEM 0;4 Direct Global Read & w ^ORD(101.43,D0,.1) .1 INACTIVATED .1;1 Direct Global Read & w ROUTINE: ******************** 2844 NAME: DBIA 2844 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT Pharmacy Data Management can do a direct global read to get the PLACER NUMBER from the PENDING OUTPATIENT ORDERS (#52.41) file for locking purposes. USAGE: Private ENTERED: JUN 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.41 ROOT: PS(52.41, DESCRIPTION: TYPE: File This agreement gives the Pharmacy Data Management package access to the PLACER NUMBER (#.01) field in the PENDING OUTPATIENT ORDERS (#52.41) file. This access will be needed every time an action is taken on a pending Outpatient order, for the purpose of locking the order in Outpatient Pharmacy and in Computerized Patient Record System (CPRS). ^PS(52.41, .01 PLACER NUMBER 0;1 Direct Global Read & w A numeric field that represents the Computerized Patient Record System (CPRS) number of the order. 1.1 PATIENT LOCATION 0;13 Direct Global Read & w 2 ORDER TYPE 0;3 Direct Global Read & w 100 RELATED INSTITUTION INI;1 Direct Global Read & w ROUTINE: ******************** 2845 NAME: DBIA 2845 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT Pharmacy Data Management can do a direct global read to get the PLACER ORDER # from the PRESCRIPTION (#52) file for locking purposes. USAGE: Private ENTERED: JUN 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52 ROOT: PSRX( DESCRIPTION: TYPE: File This agreement gives the Pharmacy Data Management package access to the PLACER ORDER # (#39.3) field in the PRESCRIPTION (#52) file. This access will be needed every time an action is taken on a prescription, for the purpose of locking the order in Outpatient Pharmacy and in Computerized Patient Record System (CPRS). ^PSRX( 5 CLINIC 0;5 Direct Global Read & w 26 EXPIRATION DATE 2;6 Direct Global Read & w 39.3 PLACER ORDER # OR1;2 Direct Global Read & w A numeric field that represents the Computerized Patient Record System (CPRS) number of the order. 100 STATUS STA;1 Direct Global Read & w ROUTINE: ******************** 2846 NAME: DBA2846 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER USAGE: Private ENTERED: JUN 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Broker uses $$BAT^XUPARAM in two situations to retrieve the value of the Broker Activity Timeout, which is stored in the Kernel System Parameters file: 1)to set the timeout on READs waiting for client requests. 2) to pass the tiemout value back to the client in order to determine the frequency of polling from client to server. ROUTINE: XUPARAM COMPONENT: BAT() VARIABLES: ******************** 2847 NAME: ALLOW DIE CALL WITHIN ANOTHER DIE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP Presently we are using this IA within Purchase Order templates. The template calls PRCHNPO3. Within PRCHNPO3, a call is made to PRCHSP1. In PRCHSP1 is the second DIE call. Here is where the NEWed list of variables is placed. USAGE: Private ENTERED: JUN 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement is between IFCAP and FileMan. IFCAP is calling templates through a DIE programmer call. In the templates a routine is called. Within that routine a call is made to both DIC and DIE programmer calls to add a new sub-record entry and fill in additional data. This second DIE call is a recursive call. FileMan needs to save a group of variables to prevent the second DIE call from interfering with the first DIE call, the one handling the template. To properly call DIE the following variables need to be NEWed. DIAA,I,J,X,DO,DC,DA,DE,DG,DIE,DR,DIC,D,D0,D1,D2,D3,D4,D5,D6,DI,DH, DIA,DICR,DK,DIK,DL,DLAYGO,DM,DP,DQ,DU,DW,DIEL,DOV,DIOV,DIEC,DB, DV,DIFLD Any place within IFCAP that a recursive call to DIC/DIE needs to be done will be allowed by this agreement. This intregration agreement will stay in effect until FileMan DIC and DIE programmer calls become recursive. ROUTINE: ******************** 2848 NAME: GETALL API CALL CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: SCAPMCA COMPONENT: $$GETALL(DFN[,SCDATE][,SCARR]) VARIABLES: DFN Type: Input Internal entry of the PATIENT file (#2). SCDATE Type: Input Array of Dates (Default=DT) SCDATE("BEGIN")=beginning date SCDATE("END")=ending date SCDATE("INCL")= 1: only reference practitioners that were on team for entire date range. 0: anytime in date range (Default = 1) SCARR Type: Output Name of array to return data. (Default is ^TMP("SC",$J) Function: $$GETALL^SCAPMCA(DFN) Input: DFN - This is a required parameter that is the internal entry number of the PATIENT file. Output: HIERARCHICAL FORMAT (This format will exist only if there are assignments that exist.) @SCARR@(DFN,"TM",a,b)=team data @SCARR@(DFN,"TM",a,b,"POS",c)=position data @SCARR@(DFN,"TM",a,b,"POS",c,"PROV",d)=provider data @SCARR@(DFN,"TM",a,b,"POS",c,"PPOS",e)=preceptor position data @SCARR@(DFN,"TM",a,b,"POS",c,"PPROV",f)=preceptor provider data where: a = TEAM file (#404.51) ifn b = PATIENT TEAM Assignment file (#404.42) ifn c = PATIENT TEAM POSITION Assignment file (#404.43) ifn d = POSITION Assignment HISTORY file (#404.52) ifn e = TEAM POSITION file (#404.57) ifn f = POSITION Assignment HISTORY file (#404.52) ifn Output: FLAT FORMAT (The zero nodes of this format are always returned. They are equal to zero if no assignments exist.) @SCARR@(DFN,"NPCPOS",0)=non-PC position count @SCARR@(DFN,"NPCPOS",n)=non-PC position data @SCARR@(DFN,"NPCPPOS",0)=non-PC preceptor position count @SCARR@(DFN,"NPCPPOS",n)=non-PC preceptor position data @SCARR@(DFN,"NPCPPR",0)=non-PC preceptor provider count @SCARR@(DFN,"NPCPPR",n)=non-PC preceptor provider data @SCARR@(DFN,"NPCPR",0)=non-PC provider count @SCARR@(DFN,"NPCPR",n)=non-PC provider data @SCARR@(DFN,"NPCTM",0)=non-PC team count @SCARR@(DFN,"NPCTM",n)=non-PC team data @SCARR@(DFN,"PCAP",0)=PC associate provider count @SCARR@(DFN,"PCAP",n)=PC associate provider data @SCARR@(DFN,"PCPOS",0)=PC position count @SCARR@(DFN,"PCPOS",n)=PC position data @SCARR@(DFN,"PCPPOS",0)=PC preceptor position count @SCARR@(DFN,"PCPPOS",n)=PC preceptor position data @SCARR@(DFN,"PCPR",0)=PC provider count @SCARR@(DFN,"PCPR",n)=PC provider data @SCARR@(DFN,"PCTM",0)=PC team count @SCARR@(DFN,"PCTM",n)=PC team data where: n = incrementing number from 1 to 'n'. Output: ARRAY DATA STRINGS (This outlines the various pieces of data that are returned for the Team, Position and Provider.) TEAM Information Data String: Piece Description 1 IEN of TEAM file entry 2 Name of Team 3 IEN of file #404.42 (Patient Team Assignment) 4 Current Effective Date 5 Current Inactive Date (if any) 6 Pointer to #403.47 (purpose) 7 Name of Purpose 8 Is this the Patient's PC Team? POSITION Information Data String: Piece Description 1 IEN of TEAM POSITIONfile (#404.57) 2 Name of Position 3 IEN of Team #404.51 4 IEN of file #404.43 (Patient/Team/Position Assignment) 5 Current Effective Date 6 Current Inactive Date (if any) 7 Pointer to Standard Role (#403.46) 8 Name of Standard Role 9 Pointer to User Class (#8930) 10 Name of User Class 11 Pointer to Patient Team Assignment (#404.42) 12 IEN of Preceptor Position (#404.57) PROVIDER Information Data String: Piece Description 1 IEN of NEW PERSON file entry (#200) 2 Name of Person 3 IEN of Team Position file (#404.57) 4 Name of Position 5 IEN of User Class (#8930) of Position (#404.57) 6 User Class Name 7 IEN of Standard Position (#403.46) 8 Standard Role (Position) Name 9 Activation Date for #404.52 (not 404.59!) 10 Inactivation Date for #404.52 11 IEN of Position Assignment History (#404.52) 12 IEN of Preceptor Position 13 Name of Preceptor Position ******************** 2849 NAME: Use of ORDERS file (#100) CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING DSS - DECISION SUPPORT SYSTEM EX USAGE: Controlled Subscri ENTERED: JUN 18,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100 ROOT: OR(100, DESCRIPTION: TYPE: File ^OR(100,DA,0) 1 CURRENT AGENT/PROVID 0;4 Read w/Fileman ROUTINE: ******************** 2851 NAME: TIU use of SD(409.63,'ACO',1,STATUS) CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: AUG 5,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.63 ROOT: SD(409.63, DESCRIPTION: TYPE: File TIU uses a global read of ^SD(409.63,"ACO",1,STATUS) cross-reference on the 'Check Out Allowed?' field (#.06) of the Appointment Status file (#409.63) to determine if the appointment is allowed for check-out. STATUS := appt status as determined by $$STATUS^SDAM1. ^SD(409.63,'ACO',1,STATUS) .06 CHECK OUT ALLOWED? 0;6 Direct Global Read & w ROUTINE: ******************** 2853 NAME: FILE USE OVERLAP CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: INCOME VERIFICATION NAT'L DB USAGE: Private ENTERED: JUN 24,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Since IVM has custody of the numberspace from 300 to 304, the following files are delegated to the custody of INCOME VERIFICATION NAT'L DB 300.1 IVM FACILITY 300.11 VETERANS ID VERIFICATION ACCESS 300.111 DEATH TRANSMISSIONS 300.113 AAC TRANSMISSIONS STATISTICS 300.114 IVM AUSTIN TRANSMISSION STATUS 300.12 IVM MASTER CLIENT 300.121 IVM ADJUDICATION 300.122 IVM VERIFIED INSURANCE 300.124 IVM CLOSED CASE CODES 300.13 IVM CLIENT INCOME 300.1311 SITE COMPLETED MT STATISTICS 300.132 ENROLLMENT 300.133 IVM REVIEW RECORDS 300.15 SSA EARNINGS REPORT TYPE 300.16 IRS DOCUMENT TYPE - UNEARNED INCOME 300.17 IVM REFERENCE 300.18 IVM EMPLOYER 300.19 FINANCIAL INSTITUTION 300.2 IVM ELIGIBILITY STATUS 300.21 IVM HL7 SEGMENTS USED 300.22 IRS SUB DOCUMENT TYPE 300.3 IVM EQUIPMENT 300.4 IVM DEVICE TYPE 300.6 IVM LOCATION 300.7 IVM ADDRESS FILE 300.8 IVM ADJUDICATION LETTERS/FORMS 300.899 IVM CASE ASSIGNMENT 300.9 IVM COUNTY CODES 300.999 IVM CASE STATUS 301.1 DCD FINANCIAL/INCOME TEST DATA 301.11 DCD LETTERS 301.12 IVM BILLING TRANSACTIONS 301.13 IVM ELIGIBILITY THRESHOLDS 301.15 PRIORITIZATION REASONS 301.2 DCD CORRESPONDENCE 301.3 DCD CONTACT REPRESENTATIVE/CASE ASSIGNMENT 301.4 DCD DEPENDENTS ROUTINE: ******************** 2854 NAME: DBIA2854 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: JUN 24,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 59.7 ROOT: PS(59.7, DESCRIPTION: TYPE: File Pharmacy Benefits Managment requests the usage of the PSU PBM JOB field (#90) in the PHARMACY SYSTEM file (#59.7) for monitoring the status of current and previous extracts of the PSU PBM software. ^PS(59.7,D0,90) 90 PSU PBM JOB 90;1 Both R/W w/Fileman ^PS(59.7,D0,90.01,D1,0) 90.01 PBM AR/WS AOU MAPPIN .01 AR/WS AOU 0;1 Both R/W w/Fileman .02 DIVISION 0;2 Both R/W w/Fileman .03 OUTPATIENT SITE 0;3 Both R/W w/Fileman ^PS(59.7,D0,90.02,D1,0) 90.02 PBM CS NAOU MAPPING .01 CS NAOU 0;1 Both R/W w/Fileman .02 DIVISION 0;2 Both R/W w/Fileman .03 OUTPATIENT SITE 0;3 Both R/W w/Fileman ^PS(59.7,D0,90.03,D1,0) 90.03 PBM DA PHARM LOC MAP .01 DA PHARMACY LOCATION 0;1 Both R/W w/Fileman .02 DIVISION 0;2 Both R/W w/Fileman .03 OUTPATIENT SITE 0;3 Both R/W w/Fileman ROUTINE: ******************** 2856 NAME: DBIA2856 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JUN 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine AR $Orders thru ^XMB(3.9,"B",XMSUBJ,XMZ) to retrieve mail messages. AR references a messages first line in global ^XMB(3.9,XMZ,2,1,0). AR calls D KILL^XMA32A(XMZ,.XMKILL,XMABORT) to delete a message. ROUTINE: XMA32A COMPONENT: KILL VARIABLES: XMABORT Type: Input Preset to ZERO. XMKILL(MSG Type: Both Preset to ZERO. (MSG is the subscript) Every time KILL^XMA32A is called to delete a message, it is incremented by 1 by this entry point. XMKILL(RES Type: Both Preset to ZERO. (RESP is the subscript) Every time KILL^XMA32A is called, it is incremented by the number of responses purged. XMZ Type: Input Preset XMZ to the message number to be deleted. This message and all response to the message XMZ will be deleted. This entry point purges a message and all of its responses from the Message file 3.9, and also deletes the message from any user mailboxes in the Mailbox fie 3.7. S XMABORT=0,(XMKILL("MSG"),XMKILL("RESP"))=0,XMZ=msgien D KILL^XMA32A(XMZ,.XMKILL,XMABORT) ******************** 2857 NAME: XUS GET USER INFO CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RPC BROKER JOINT LEGACY VIEWER ADVANCED PROSTHETICS ACQUISITION Added 8/4/18. WEB VISTA REMOTE ACCESS MANAGEME Added 9/27/19 USAGE: Private ENTERED: JUN 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This rpc is used by BROKER to maintain a User object in the Delphi environment. Returns information about a user after logon. ROUTINE: USERINFO XUSRB2 ******************** 2858 NAME: DBIA2858 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CLINICAL REMINDERS Clinical Reminders supports findings based on VA Drug Class and VA GENERIC. These need to be related to a list of entries in the Drug file #50. USAGE: Controlled Subscri ENTERED: FEB 17,2000 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. ^PSDRUG('AND', ^PSDRUG('VAC' ^PSDRUG('B' The API OCL^PSOORRL returns a drug which can be an entry in the Drug file or the Pharmacy Orderable item file. We would like to use the "B" cross-reference to determine if the returned drug is from the Drug file or the Pharmacy Orderable item file. ROUTINE: ******************** 2859 NAME: TAXID FIELDS IN 440 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE A EN1^DIQ reference is used to pull data from fields 38 and 39 in file 440. This is done in RCTOP1. USAGE: Private ENTERED: JUL 21,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 440 ROOT: PRC(440 DESCRIPTION: TYPE: File Accounts Receivable needs to pull data from fields 38 and 39 in IFCAP file 440. This is necessary to place the Tax ID number on the TOP (Treasury Offset Program) documents. ^PRC(440,DA, 38 TAX ID/SSN 3;8 Read w/Fileman 39 SSN/TAX ID INDICATOR 3;9 Read w/Fileman ROUTINE: ******************** 2860 NAME: DBIA2860-A CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE The DATE ENTERED value will be determined from a GET1^DIQ call. USAGE: Private ENTERED: JUL 7,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.9 ROOT: XMB(3.9 DESCRIPTION: TYPE: File The Radiology/Nuclear Medicine package requests permission to lookup the DATE ENTERED value for a message in file 3.9 of the Mailman package. ^XMB(3.9,D0,0) 1.4 DATE ENTERED 0;3 Read w/Fileman ROUTINE: ******************** 2861 NAME: DBIA2860-B CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE The IEN for the bulletin will be determined from a FIND^DIC call, and the IEN for the mail group will be determined from a GETS^DIQ call. USAGE: Private ENTERED: JUL 7,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.6 ROOT: XMB(3.6 DESCRIPTION: TYPE: File The Radiology/Nuclear Medicine package requests permission to lookup the IEN of a bulletin and the ien of the mail group that's linked to the same bulletin. ^XMB(3.6,D0,2,0) 4 MAIL GROUP 2;0 Read w/Fileman ^XMB(3.6,'B' .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2862 NAME: DBIA2860-C CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE The type of mail group will be determined from a GET1^DIQ call. The Radiology package can recommend that all its mail groups be made public; however, the site can still change the TYPE of a mail group. If the mail group (that will be sent a message re duplicate addenda) is private, the Radiology package must skip the call to ^XMD, in order to avoid an error which adversely affects the HL7 interface. USAGE: Private ENTERED: JUL 7,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.8 ROOT: XMB(3.8 DESCRIPTION: TYPE: File The Radiology/Nuclear Medicine package requests permission to lookup the type of a mailgroup. ^XMB(3.8,D0,0) 4 TYPE 0;2 Read w/Fileman ROUTINE: ******************** 2863 NAME: Calls to TIULE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING LAB SERVICE added 3/24/2008 USAGE: Controlled Subscri ENTERED: JUL 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIULE ROUTINE: TIULE COMPONENT: $$PERSPRF(USER) VARIABLES: USER Type: Input This is the pointer to the NEW PERSON FILE (#200) for the user in question...Ordinarily, it will be the current user (i.e., DUZ), but in the case where a transcriber is entering a document on another user's behalf, it will be the author of the document being entered. This extrinsic function returns a circumflex-delimited string of personal preferences specified by the user indicated in the formal parameter USER. The return string has the following pieces: '^'-piece Preference ========= ========== 1 (#.01) USER NAME [1P] 2 (#.02) DEFAULT LOCATION [2P] 3 (#.03) REVIEW SCREEN SORT FIELD [3S] 4 (#.04) REVIEW SCREEN SORT ORDER [4S] 5 (#.05) DISPLAY MENUS [5S] 6 (#.06) PATIENT SELECTION PREFERENCE [6S] 7 (#.07) ASK 'Save changes?' AFTER EDIT [7S] 8 (#.08) ASK SUBJECT FOR PROGRESS NOTES [8S] 9 (#.09) DEFAULT COSIGNER [9P] 10 (#.1) NUMBER OF NOTES ON REV SCREEN [10N] 11 (#.11) SUPPRESS REVIEW NOTES PROMPT [11S] 12 (#.12) ASK WORKLOAD ON ALL OP VISITS [12S] Descriptions of these fields can be found in the data dictionary of the TIU PERSONAL PREFERENCES FILE (#8926). 8926. COMPONENT: SETPARM VARIABLES: DUZ(2) Type: Input The division associated with the user (system wide KERNEL variable). TIUPRM0 Type: Output 0 node of TIU PARAMETERS file (#8925.99). TIUPRM1 Type: Output 1 node of TIU PARAMETERS file (#8925.99). Gets parameters for a user's division. COMPONENT: $$PERSLOC(USER) VARIABLES: This extrinsic function returns the encounter location (#44) from the LOCATION BY DAY OF WEEK multiple field (#1) in the file TIU PERSONAL PREFERENCES (#8926) for a user based upon the current day of the week. If there is no location for that specific day, the function will return the value from the field DEFAULT LOCATION (#.02). The extrinsic function value returned will be in the format: 0 -or- [file_44_ien] ^ [Hospital Location Name] ******************** 2864 NAME: DBIA2864 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CLINICAL PROCEDURES Clinical Procedures is using this API to indicate that a directive may exist. They are using it with the understanding that users need to review the note title and text before concluding that a directive in fact exists. IMAGING VA POINT OF SERVICE (KIOSKS) VIRTUAL PATIENT RECORD Added 11/19/18 for VPR*1.0*8. USAGE: Controlled Subscri ENTERED: JUL 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call evaluates whether the specified patient has any postings (i.e., (C)risis Notes, Clinical (W)arnings, (A)llergies, or Advanced (D)irectives on file, and returns a list of such documents, including the dates and times on which addenda may have been entered for them. Note that the existence of an Advance Directive posting does NOT necessarily indicate that the patient has an Advance Directive. That an Advance Directive exists can only be determined by reading the text of the 'D' postings, which may (or may not) indicate that a Directive exists, ROUTINE: TIUPP3 COMPONENT: ENCOVER(DFN) VARIABLES: DFN Type: Input This is the pointer to the PATIENT FILE (#2). This procedure receives the parameter DFN (pointer to PATIENT FILE (#2)), and returns the local variable MSG along with the ^TMP("TIUPPCV",$J) array. The MSG variable is returned as follows: Patient has postings on file: MSG=0^Patient Postings on file Patient DOES NOT have postings on file: MSG=-1^No Patient Postings on file while the ^TMP("TIUPPCV",$J) array looks like this: Patient has postings on file: ^TMP("TIUPPCV",$J,n)=IEN^INDICATOR^PRINT NAME^SUBJECT^DATE/TIME^ADDENDUM where IEN = Internal Entry of the posting in the TIU DOCUMENT FILE (#8925) INDICATOR = C for CRISIS NOTE W for CLINICAL WARNING A for ALLERGY/ADR NOTE D for ADVANCED DIRECTIVE PRINT NAME = the PRINT NAME (#.03) field in file 8925 SUBJECT = the optional Free text subject of the note. DATE/TIME = the Date/time of the note ADDENDUM = indicator of last addendum w/date and time. Patient DOES NOT have postings on file: ^TMP("TIUPPCV",$J) is UNDEFINED. ^TMP("TIUPPCV",$J) may be killed before and after use. ******************** 2865 NAME: DBIA2865 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: JUL 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point (CONTEXT) allows the calling application to fetch lists of TIU Documents that satisfy various criteria (e.g., All signed, unsigned by author, uncosigned notes, signed by author, signed by date range). ROUTINE: TIUSRVLO COMPONENT: CONTEXT(.TIUY,CLASS,CONTEXT,DFN,EARLY,LATE,PERSON,OCCLIM,SEQUENCE ,...) VARIABLES: TIUY Type: Input Passed by reference. This is the name of the array in which the data are returned. CLASS Type: Input This is the IEN of the Class of TIU documents for which the user is issuing the query (e.g., PROGRESS NOTES, DISCHARGE SUMMARIES, CONSULTS, etc.). CONTEXT Type: Input Integer code indicating the context of the query, as: - 1=All Signed (by PT), - 2=Unsigned (by PT&(AUTHOR!TANSCRIBER)) - 3=Uncosigned (by PT&EXPECTED COSIGNER - 4=Signed notes (by PT&selected author) - 5=Signed notes (by PT&date range) DFN Type: Input Pointer to the PATIENT FILE (#2) indicating the patient for whom the user is issuing the query. EARLY Type: Input This is the Date (and time) from which to begin searching for documents that satisfy the other search criteria. LATE Type: Input This is the inclusive upper bound Date (and time) for the search. PERSON Type: Input Optional pointer to file 200 for searches by author (DUZ will be assumed if this parameter is not passed). OCCLIM Type: Input Optional occurrence limit for the search (i.e., the number of documents to return). SEQUENCE Type: Input This is the sequence (i.e., "A"=ascending or "D"=decending) in which the data will be sorted in the return array. SHOWADD Type: Input Optional,determines order of returned documents "A" or "D", where "A"=ascending (Regular date/time) "D"=descending (Reverse date/time) (dflt) INCUND Type: Input Optional. Boolean 1 - Include Undictated and Untranscribed documents along with Unsigned documents, when the CONTEXT is 2. 0 - Don't include them Call with: TIUY - RETURN ARRAY pass by reference CLASS - Pointer to TIU DOCUMENT DEFINITION #8925.1 CONTEXT - 1=All Signed (by PT), - 2=Unsigned (by PT&(AUTHOR!TANSCRIBER)) - 3=Uncosigned (by PT&EXPECTED COSIGNER - 4=Signed notes (by PT&selected author) - 5=Signed notes (by PT&date range) DFN - Pointer to Patient (#2) [EARLY] - FM date/time to begin search [LATE] - FM date/time to end search [PERSON] - Pointer to file 200 (DUZ if not passed) [OCCLIM] - Occurrence Limit (optional) [SEQUENCE]- "A"=ascending (Regular date/time) - "D"=descending (Reverse date/time) (dflt) [SHOWADD] - BOOLEAN. Include addenda in the return array, when their parent documents are identified by the search [INCUND] - BOOLEAN. Include Undictated and Untranscribed documents along with Unsigned documents, when the CONTEXT is 2. Returns: ^TMP("TIUR",$J,n)='^'-Delimited records as shown below: "^"-Piece Description ========= =========== 1 DOCUMENT IEN 2 PRINT NAME 3 NOTE DATE/TIME 4 PATIENT NAME_" "_LAST4 5 AUTHOR 6 LOCATION 7 STATUS 8 EPISODE BEGIN DATE/TIME 9 EPISODE END DATE/TIME 10 REQUESTING PACKAGE VARIABLE POINTER 11 IMAGE COUNT 12 SUBJECT 13 HAS CHILDREN 14 IEN OF PARENT DOCUMENT ******************** 2866 NAME: DDR DELETE ENTRY CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to the DDR DELETE ENTRY rpc. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR DELETE ENTRY remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. This function deletes an entry in a FileMan file using ^DIK. ROUTINE: DIKC DDR1 ******************** 2867 NAME: DDR FILER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to the DDR FILER rpc. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR FILER remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. Generic call to file edits into FM file. ROUTINE: FILEC DDR3 ******************** 2868 NAME: DDR FIND1 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to DDR FIND1 remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR FIND1 remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. This function returns the internal entry number of a record using $$FIND1^DIC. ROUTINE: FIND1C DDR2 ******************** 2869 NAME: DDR FINDER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to the DDR FINDER remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR FINDER remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. ROUTINE: FINDC DDR0 ******************** 2870 NAME: DDR GET DD HELP CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to DDR GET DD HELP remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR GET DD HELP remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. ROUTINE: GETHLPC DDR2 ******************** 2871 NAME: DDR GETS ENTRY DATA CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to DDR GETS ENTRY DATA remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR GETS ENTRY DATA remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. Calls database server at GETS^DIQ. ROUTINE: GETSC DDR2 ******************** 2872 NAME: DDR LISTER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to DDR LISTER remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR LISTER remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. ROUTINE: LISTC DDR ******************** 2873 NAME: DDR LOCK/UNLOCK NODE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to the DDR LOCK/UNLOCK NODE remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR LOCK/UNLOCK NODE remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. This function will lock or unlock an M global node. Also, this function allows the calling application to specify the timeout (in seconds) for a 'lock' command. ROUTINE: LOCKC DDR1 ******************** 2874 NAME: DDR VALIDATOR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: FILEMAN DELPHI COMPONENTS Access to the DDR VALIDATOR remote procedure call. USAGE: Private ENTERED: JUL 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure The Filemanager Delphi Components (FMDC) package requests a private integration agreement with the FileManager package for access to the DDR VALIDATOR remote procedure call. This request is necessary since FMDC is now a separate package with a different namespace and still needs to access the DDR remote procedure calls which are the basis for the functioning of the FMDC components. This function allows the application to validate user input to a field before filing data. The call uses the database server VAL^DIE call. ROUTINE: VALC DDR3 ******************** 2875 NAME: DBIA2875 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: CLINICAL REMINDERS In order to support Mental Instruments as a findings type Clinical Reminders needs read access to the following globals. USAGE: Controlled Subscri ENTERED: JUL 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 601 ROOT: YTT(601 DESCRIPTION: TYPE: File ^YTT(601,D0,"S", .01 SCALE NUMBER 0;1 Direct Global Read & w .5 SCALE NAME 0;2 Direct Global Read & w ^YTT(601, .01 NAME Direct Global Read & w Clinical Reminders would like to be able to read the name of the Mental Instrument to setup the call the LISTONE^YSAPI API and to be able to display the name in the Clinical Maintenance component. ROUTINE: ******************** 2876 NAME: DBIA2876 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING CLINICAL REMINDERS ORDER ENTRY/RESULTS REPORTING IMAGING CLINICAL PROCEDURES ADDED 8/26/09 USAGE: Controlled Subscri ENTERED: JUL 21,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine APIs for Document Definition File (#8925.1) ROUTINE: TIUSRVD COMPONENT: BLRPLT VARIABLES: TIUY Type: Output TIUY is passed by reference, and is returned as the name of the array in which the results are available (i.e., ^TMP("TIUBOIL",$J)). TITLE Type: Input This is the OPTIONAL pointer to the TIU DOCUMENT DEFINITION file (#8925.1) where the boilerplate text is defined for boilerplated TITLES in TIU. Applications which define their boilerplates outside of the TIU DOCUMENT DEFINITION File should pass this as a NULL string. DFN Type: Input This is the pointer to the patient in the PATIENT FILE (#2). VSTR Type: Input This is the VISIT STRING, which together with DFN defines the patient's encounter in terms of place and time. It is formatted as follows: ;; ROOT Type: Input This is the closed root reference to the array where the boilerplate to be resolved is to be found. It may be either an M global or local variable name (glvn). Examples might have the format: ROOT="^ORD(101.41,1263,6,4,2)" in the event that an Order Dialog entry #1263 included boilerplate text defined in its TEXT Field, or ROOT="BPTEXT(""DATA"")" in the event that a local array contained the data to be resolved. The procedure BLRPLT^TIUSRVD may be called with the following parameters, to resolve any TIU OBJECTS embedded in boilerplate text (i.e., pre-defined word-processing forms), regardless of the location of that text in DHCP: D BLRPLT^TIUSRVD(.TIUY,TITLE,DFN,VSTR,ROOT) COMPONENT: CNSLCLAS VARIABLES: Y Type: Both Returns either the Consults class IEN in the TIU Document file (#8925.1) or 0. Gets the IEN for entry CLINICAL PROCEDURES in the TIU Document Definition file (#8925.1) COMPONENT: SURGCLAS(Y,CLNAME) VARIABLES: Y Type: Both Returns either the record number of the class identified by the CLNAME parameter in the TIU DOCUMENT DEFINITION file (#8925.1), or 0. CLNAME Type: Input CLNAME = "SURGICAL REPORTS" or "PROCEDURE REPORTS (NON-O.R.)" Gets the record number of the class identified by the CLNAME parameter in the TIU DOCUMENT DEFINITION file (#8925.1). COMPONENT: LONGLIST(Y,CLASS,FROM,DIR,IDNOTE) VARIABLES: Y Type: Output This is an array of the 44 titles nearest to the title name or text indicated in FROM, in the direction DIR. Array entries have form Y(n)=DA^TitleName CLASS Type: Input This is a pointer to the CLASS in the Document Definition File (#8925.1) from which the application intends to allow selection of TITLES. FROM Type: Input This is the name of the reference title from which the longlist is scrolling (or the text to $ORDER from). DIR Type: Input This is the direction in which the longlist is scrolling from the reference title, i.e., the $ORDER direction. IDNOTE Type: Input This BOOLEAN Flag should be passed when the call is being made to select a title for an Interdisciplinary Entry. Gets the active titles which the current user is authorized to enter notes under, for a particular class in the TIU DOCUMENT DEFINITION file (#8925.1). ******************** 2877 NAME: DBIA2877 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 6,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Either EN3^RAO7PC3 or EN30^RAO7PC3 can be used to return an entire Radiology/NM report, the same report that is automatically e-mailed to the requesting physician when a report has been verified. ROUTINE: RAO7PC3 COMPONENT: EN3(X) VARIABLES: X Type: Input X can be either: Patient's DFN^inverse exam date^Case IEN -or- Patient's DFN^inverse exam date^ The first will retrieve a single report for a single exam. The second will retrieve all reports for a set of exams that were ordered on the same order. Returns: ^TMP($J,"RAE3",Patient IEN,Case IEN,Procedure Name,n)=line n of report The first line of the report passes the patient name (truncated to 20 chars max), the SSN, and the age of the patient (at the time the software is executed). Example: ^TMP(539390038,"RAE3",21,1,"CHEST 2 VIEWS PA&LAT",1) = OUTPATIENT,SIXTEEN B 000-00-0000 72 yr. old male Subscripts ---------- Patient ien: Internal entry number of the patient in both the Rad/Nuc Med Patient file #70 and the Patient file #2. Case IEN: Internal entry number of the exam that this date is extracted from. Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure prior to the exam reaching a 'COMPLETE' status. n: sequential number that corresponds to the nth line of the report from Radiology/NM. Additional output ----------------- For subscript definitions, check the section called 'subscripts' listed above. ^TMP($J,"RAE3",Patient IEN,"PRINT_SET") Array Value ----------- Null (exists if and only if this is a printset). ^TMP($J,"RAE3",Patient IEN,"ORD") Array Value ----------- Name of ordered procedure for examsets and printsets. ^TMP($J,"RAE3",Patient IEN,"ORD",Case IEN) Array Value ----------- Name of ordered procedure, this may differ from the procedure registered. This global will be defined when the ordered procedure is not a parent procedure. (Not an examset or printset). COMPONENT: EN30(X) VARIABLES: X Type: Input X is the internal entry number (ien) of the record in the RAD/NUC MED REPORTS (#74) file. Returns: ^TMP($J,"RAE3",Patient IEN,Case IEN,Procedure Name,n)=line n of report Subscripts ---------- Patient ien: Internal entry number of the patient in both the Rad/Nuc Med Patient file #70 and the Patient file #2. Case IEN: Internal entry number of the exam that this date is extracted from. Procedure Name: Name of the procedure in the Rad/Nuc Med Procedure file #71. It is possible for users to change the procedure prior to the exam reaching a 'COMPLETE' status. n: sequential number that corresponds to the nth line of the report from Radiology/NM. Additional output ----------------- For subscript definitions, check the section called 'subscripts' listed above. ^TMP($J,"RAE3",Patient IEN,"PRINT_SET") Array Value ----------- Null (exists if and only if this is a printset). ^TMP($J,"RAE3",Patient IEN,"ORD") Array Value ----------- Name of ordered procedure for examsets and printsets. ^TMP($J,"RAE3",Patient IEN,"ORD",Case IEN) Array Value ----------- Name of ordered procedure, this may differ from the procedure registered. This global will be defined when the ordered procedure is not a parent procedure. (Not an examset or printset). ******************** 2878 NAME: DELETE TRIGGER X-REF IN FILE 6926.01 FIELD .01 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ENGINEERING USAGE: Private ENTERED: JUL 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD(6926.01,.01,1 DESCRIPTION: TYPE: File This IA permits patch EN*7*62 to delete the TRIGGER cross-reference (#2) of field #.01 in subfile #6926.01. Code similar to the following will be placed in a pre-install routine of the patch to perform the deletion. N DA,DIK S DIK="^DD(6926.01,.01,1," ;this is the root of "xref multiple" S DA(2)=6926.01,DA(1)=.01,DA=2 ;DA(2) = subfile# ;DA(1) = field# ;DA = xref# D ^DIK ;this deletes the xref definition Patch EN*7*62 will bring in a new #2 cross-reference (regular, whole-file) on the .01 field of #6926.01 during the install. The cross-reference deletion performed during the pre-install will ensure that all the trigger logic is completely removed. ROUTINE: ******************** 2879 NAME: DBIA2879 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: JUL 28,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 51.1 ROOT: PS(51.1, DESCRIPTION: TYPE: File ^PS(51.1, .01 NAME 0;1 Read w/Fileman Direct global read access to the "B" x-ref is also allowed. 2 FREQUENCY (IN MINUTE 0;3 Read w/Fileman ROUTINE: ******************** 2880 NAME: DBIA2880 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: JUL 28,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 50.7 ROOT: PS(50.7, DESCRIPTION: TYPE: File ^PS(50.7, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 2882 NAME: DBIA2882 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: BAR CODE MED ADMIN JAL FEDERAL HEALTH CARE CENTER 20110303 JSHARVEY - JAL ADDED AS SUBSCRIBER USAGE: Controlled Subscri ENTERED: AUG 4,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine XUSRB contains some API's that can be used by other application to check user access. ROUTINE: XUSRB COMPONENT: $$CHECKAV VARIABLES: This API will check a Access/Verify code pair and return if it is valid. The call is S X=$CHECKVA() The is the users . The return is the users IEN if the codes were OK, or zero otherwise. ******************** 2883 NAME: DBIA2883 CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: MENTAL HEALTH The Mental Health package will perform direct global reads from the DSS MH TESTS file (#727.5). These direct reads are used only within the routine YSDSS, which has been designed for use as an interface between DSS Extracts and Mental Health. Direct global reads are done on three cross-references in file #727.5: (1) "B" cross-reference - whole file index on the TEST NAME field (#.01). (2) "AC" cross-reference - whole file index on the ACTIVATION DATE sub-field (#.01) of the ACTIVATION DATE multiple field (#1). (3) "AX" cross-reference - whole file index on the INACTIVATION DATE sub-field (#.02) of the ACTIVATION DATE multiple field (#1). USAGE: Private ENTERED: AUG 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 727.5 ROOT: ECX(727.5, DESCRIPTION: TYPE: File The purpose of DBIA #2883 is to allow the VistA Mental Health package to perform direct global reads on the DSS MH TESTS file (#727.5). ^ECX(727.5, Direct read of cross-references only -- ^ECX(727.5,"B", ^ECX(727.5,"AC", ^ECX(727.5,"AX", ROUTINE: ******************** 2884 NAME: DBIA2884 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX VistA DSS Extracts will call UPD^YSDSS exclusively from routine ECXMTL, which is the DSS Mental Health extract routine. USAGE: Private ENTERED: AUG 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of DBIA #2884 is to allow the VistA DSS Extracts package to call routine YSDSS at tag UPD. The call to UPD^YSDSS will return Mental Health data to be placed in the DSS Mental Health extract. ROUTINE: YSDSS COMPONENT: UPD VARIABLES: YSFILE Type: Input This is the file number for the DSS Mental Health extract file. YSFRN Type: Both Input: This is the last internal record number used in the Mental Health extract file before the current extract. Output: This is the last internal record number used for the current Mental Health extract. YSYRMO Type: Input A 6-digit numeric of format YYYYMM. YSEXTN Type: Input The unique extract number for the current Mental Health extract. YSSITE Type: Input May be numeric or alpha-numeric; the Station Number of the facility performing the Mental Health extract. YSSD Type: Input The start date for the data extraction process in standard FileMan internal format. YSEND Type: Input The ending date for the data extracttion process in standard FileMan internal format. YSERR Type: Output Returns "0" if no problems were encountered which would cause the extraction process to abort. Returns "1" if some problem is found which prevents the extraction process from occurring; e.g., missing files. Subroutine UPD in YSDSS must be called with parameters as follows: UPD(YSFILE,YSFRN,YSYRMO,YSEXTN,YSSITE,YSSD,YSEND,YSERR), where YSFILE - MENTAL HEALTH EXTRACT file # (required) YSFRN - last IEN used in the MENTAL HEALTH EXTRACT file (required) YSYRMO - YearMonth of the extract (YYYYMM) (required) YSEXTN - Extract # (required) YSSITE - Facility identifier (required) YSSD - Start date for extract (required) YSEND - End date for extract (required) YSERR - passed by reference; returnes "1", if error; otherwise "0" ******************** 2885 NAME: DBIA2885 CUSTODIAL PACKAGE: DSS - DECISION SUPPORT SYSTEM EX SUBSCRIBING PACKAGE: MENTAL HEALTH VistA Mental Health will place data into the MENTAL HEALTH EXTRACT file (#727.812) using direct global writes. This will occur from within the YSDSS routine, which is the interface between DSS Extracts and the Mental Health packages for the purpose of extracting Mental Health data. Data will be placed in the following locations: (1) ^ECX(727.812,D0,0) - piece 1 - field #.01 (SEQUENCE NUMBER) (2) ^ECX(727.812,D0,0) - piece 2 - field #1 (YEAR MONTH) (3) ^ECX(727.812,D),0) - piece 3 - field #2 (EXTRACT NUMBER) (4) ^ECX(727.812,D0,0) - piece 4 - field #4 (FACILITY) (5) ^ECX(727.812,D0,0) - piece 9 - field #8 (DAY) (6) ^ECX(727.812,D0,0) - piece 18 - field #17 (PROVIDER) (7) ^ECX(727.812,D0,0) - piece 21 - field #20 (TEST NAME) (8) ^ECX(727.812,D0,0) - piece 22 - field #21 (TEST IEN) (9) ^ECX(727.812,D0,0) - piece 23 - field #22 (SCALE NUMBER) (10) ^ECX(727.812,D0,0) - piece 24 - field #23 (SCALE NAME) (11) ^ECX(727.812,D0,0) - piece 25 - field #24 (TEST SCORE) (12) ^ECX(727.812,D0,1) - piece 5 - field #32 (CLASS FOR ASI) (13) ^ECX(727.812,D0,1) - piece 6 - field #33 (SPECIAL FOR ASI) USAGE: Private ENTERED: AUG 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 727.812 ROOT: ECX(727.812, DESCRIPTION: TYPE: File The purpose of DBIA #2885 is to allow the VistA Mental Health package to place data directly into the ^ECX(727.812, global. This global is the storage location of the DSS MENTAL HEALTH EXTRACT file (#727.812). ^ECX(727.812,DO,0) .01 SEQUENCE NUMBER 1 Direct Global Write & A sequential number for this extract record. It is used to DUNUM the file; i.e., internal entry number is the value of the .01 field. 1 YEAR MONTH 2 Direct Global Write & The year and month for which data is being extracted from the Mental Health files. This is a 6-digit numeric of format YYYYMM. 2 EXTRACT NUMBER 3 Direct Global Write & This is the unique number which identifies this specific extract. 3 FACILITY 4 Direct Global Write & The Station Number for the facility performing the extract. 4 PATIENT NO. - DFN 5 Direct Global Write & The internal entry number in the PATIENT file (#2) for the patient associated with the Mental Health data. 8 DAY 9 Direct Global Write & This is the date associated with the Mental Health data. Data is initially placed here in the usual FileMan internal date format. It is later converted by the DSS Extracts package to an 8-digit numeric of format YYYYMMDD. 17 PROVIDER 18 Direct Global Write & This is the value of the pointer to the NEW PERSON file (#200) for the Provider associated with the Mental Health data. 20 TEST NAME 21 Direct Global Write & This is the name of the Mental Health test for which data is being extracted. This may be "ASI", "GAF", or one of several tests in the MH INSTRUMENT file (#601). 21 TEST IEN 22 Direct Global Write & The internal entry number in the MH INSTRUMENT file (#601) of the test. 22 SCALE NUMBER 23 Direct Global Write & If the Mental Health test is described by a series of scales, the Scale Number is placed here. 23 SCALE NAME 24 Direct Global Write & If the Mental Health test is described by a series of scales, the Scale Name is placed here. 24 TEST SCORE 25 Direct Global Write & The patient's overall numeric score for the Mental Health test. 25 SCALE SCORE 26 Direct Global Write & The patient's subscore on the specific scale, if the test is described in terms of several scales. This is the 0-node of the extract record for the Mental Health extract. There are a total of twenty-eight data elements stored at this location. ^ECX(727.812,D0,1) 32 CLASS FOR ASI 5 Direct Global Write & If the test associated with the Mental Health data is ASI, then this field is its classification code: 1 = FULL 2 = LITE 3 = FOLLOW-UP 33 SPECIAL FOR ASI 6 Direct Global Write & If the test associated with the Mental Health data is ASI, then this field is its completion code: 1 = PATIENT TERMINATED 2 = PATIENT REFUSED 3 = UNABLE TO RESPOND N = INTERVIEW COMPLETED This is the 1-node of the extract record for the Mental Health extract. There are a total of six data elements stored at this location. ROUTINE: ******************** 2887 NAME: Application Parameter Inquire CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 30,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This public API returns the Mail Group and the "active/inactive" flag for an HL7 Application. ROUTINE: HLCS2 COMPONENT: $$GETAPP(HLAPP) VARIABLES: HLAPP Type: Input APPLICATION NAME OR IEN OF FILE 771 Returns: MAIL GROUP NAME^'a' or 'i' (active or inactive) ******************** 2888 NAME: DBIA2888 CUSTODIAL PACKAGE: ONCOLOGY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: AUG 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 165.5 ROOT: ONCO(165.5, DESCRIPTION: TYPE: File The Health Summary package has permission to extract and display the following data from the ONCOLOGY PRIMARY (165.5) file: 3 DATE DX 20 ICDO-TOPOGRAPHY 22 HISTOLOGY 24 GRADE/DIFFERENTIATION 29 SIZE OF TUMOR 37.1 CLINICAL T 37.2 CLINICAL N 37.3 CLINICAL M 38 CLINICAL STAGE GROUP 85 PATHOLOGIC T 86 PATHOLOGIC N 87 PATHOLOGIC M 88 PATHOLOGIC STAGE GROUP 58.1 NON CANCER-DIRECTED SURGERY 58.3 NON CANCER-DIRECTED SURG DATE 58.2 SURGERY OF PRIMARY SITE 50 SURGERY OF PRIMARY SITE DATE 51.2 RADIATION 51 RADIATION DATE 442 REGIONAL DOSE:cGy 125 RADIATION TREATMENT VOLUME 127 INTENT OF RADIATION 128 RADIATION COMPLETION STATUS 53.2 CHEMOTHERAPY 53 CHEMOTHERAPY DATE 54.2 HORMONE THERAPY 54 HORMONE THERAPY DATE 55.2 IMMUNOTHERAPY (BRM) 55 IMMUNOTHERAPY DATE 346 PROTOCOL ELIGIBILITY STATUS 560 PROTOCOL PARTICIPATION 91 ABSTRACT STATUS ^ONCO(165.5,D0,0) 3 DATE DX 0;16 Read w/Fileman The diagnosis date refers to the first diagnosis of this cancer by any recognized medical practitioner. ^ONCO(165.5,D0,2) 20 ICDO-TOPOGRAPHY 2;1 Read w/Fileman The Topography section of the International Classification of Diseases for Oncology (ICD-O, 1990) is used for coding the Primary Site of all cancers reported to SEER. 22 HISTOLOGY 2;3 Read w/Fileman Histology is a six-digit code consisting of three parts: A Histologic type (4 digits) B Behavior (1 digit) C Grading or differentiation; or for lymphomas and leukemias designation of T-cell, B-cell, and null cell (1 digit) 24 GRADE/DIFFERENTIATIO 2;5 Read w/Fileman "Grade or Differentiation" of the tumor describes the tumor's resemblance to normal tissue. Well differentiated (grade I) is the most like normal tissue. 29 SIZE OF TUMOR 2;9 Read w/Fileman SIZE OF TUMOR is the largest dimension, or the diameter of the primary tumor, and is always recorded in millimeters. 38 CLINICAL STAGE GROUP 2;20 Read w/Fileman CLINICAL STAGE GROUP defines the anatomic extent of disease based on the previously coded T, N, and M elements. 37.1 CLINICAL T 2;25 Read w/Fileman CLINICAL T evaluates the primary tumor and reflects tumor size and/or extension. 37.2 CLINICAL N 2;26 Read w/Fileman CLINICAL N identifies the absence or presence of regional lymph node metastases and describes the extent of regional lymph node metastases. 37.3 CLINICAL M 2;27 Read w/Fileman CLINCIAL M records the presence or absence of distant metastases. ^ONCO(165.5,D0,2.1) 85 PATHOLOGIC T 2.1;1 Read w/Fileman PATHOLOGIC T evaluates the primary tumor and identifies tumor size and/or extension. 86 PATHOLOGIC N 2.1;2 Read w/Fileman PATHOLOGIC N identifies the absence or presence of regional lymph node metastases and describes the extent of regional lymph node metastases. 87 PATHOLOGIC M 2.1;3 Read w/Fileman PATHOLOGIC M records the presence or absence of distant metastases. 88 PATHOLOGIC STAGE GRO 2.1;4 Read w/Fileman PATHOLOGIC STAGE GROUP defines the anatomic extent of disease based on the T, N, and M elements. ^ONCO(165.5,D0,3) 50 SURGERY OF PRIMARY S 3;1 Read w/Fileman SURGERY OF PRIMARY SITE DATE is the date that cancer-directed surgery was performed. 51 RADIATION DATE 3;4 Read w/Fileman RADIATION DATE is the date the first course of radiation therapy was started. 51.2 RADIATION 3;6 Read w/Fileman RADIATION is the type of radiation administered to the primary site or any metastatic site. 53 CHEMOTHERAPY DATE 3;11 Read w/Fileman CHEMOTHERAPY DATE is the date the first course of chemotherapy was started. 53.2 CHEMOTHERAPY 3;13 Read w/Fileman CHEMOTHERAPY is the type of chemotherapy administered as the first course of treatment. 54 HORMONE THERAPY DATE 3;14 Read w/Fileman HORMONE THERAPY DATE is the date hormone therapy was started. 54.2 HORMONE THERAPY 3;16 Read w/Fileman HORMONE THERAPY is the type of hormone therapy the patient received as part of the first course of treatment. 55 IMMUNOTHERAPY DATE 3;17 Read w/Fileman IMMUNOTHERAPY DATE is the date immunotherapy was started. 55.2 IMMUNOTHERAPY (BRM) 3;19 Read w/Fileman IMMUNOTHERAPY (BRM) is the type of immunotherapy the patient received as part of the first course of treatment. 125 RADIATION TREATMENT 3;21 Read w/Fileman RADIATION TREATMENT VOLUME is intended primarily to provide a simple expression of the most common radiation volumes treated. 58.1 NON CANCER-DIRECTED 3;27 Read w/Fileman NON CANCER-DIRECTED SURGERY is a surgical procedure performed to diagnose/stage disease (exploratory) or for relief of symptoms (palliative). 127 INTENT OF RADIATION 3;29 Read w/Fileman INTENT OF RADIATION is the intent of the radiation treatment. This item is useful in assessing the appropriateness of the treatment and correlating the outcome with the original intent of the treatment. 58.3 NON CANCER-DIRECTED 3;31 Read w/Fileman NON CANCER-DIRECTED SURG DATE is the date that non cancer-directed surgery was performed. 58.2 SURGERY OF PRIMARY S 3;38 Read w/Fileman SURGERY OF PRIMARY SITE modifies, controls, removes, or destroys proliferating cancer tissue. 128 RADIATION COMPLETION 3;39 Read w/Fileman RADIATION COMPLETION STATUS indicates whether the patient's radiation therapy was completed as outlined in the initial treatment plan. ^ONCO(165.5,D0,7) 91 ABSTRACT STATUS 7;2 Read w/Fileman ABSTRACT STATUS is the status of the abstract data entry. ^ONCO(165.5,D0,'BLA2') 346 PROTOCOL ELIGIBILITY BLA2;1 Read w/Fileman PROTOCOL ELIGIBILITY STATUS is the eligibility status of the patient to be entered into a protocol. ^ONCO(165.5,D0,'STS2') 560 PROTOCOL PARTICIPATI STS2;31 Read w/Fileman PROTOCOL PARTICIPATION records whether the patient was enrolled in and treated on a protocol. ^ONCO(165.5,D0,'THY1') 442 REGIONAL DOSE:cGy THY1;43 Read w/Fileman REGIONAL DOSE:cGy is used to code the dominant or most clinically significant dose delivered. ROUTINE: ******************** 2889 NAME: DBIA2889 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 16,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: YTAPI COMPONENT: LISTALL VARIABLES: DFN Type: Input Internal Entry number for patient name in the PATIENT file (#2). BEGIN Type: Input Inclusive date in %DT acceptable format (11/11/2011) to begin search [optional]. Example: YS("BEGIN")="10/01/89" END Type: Input Inclusive date in %DT acceptable format (11/11/2011) to end search [optional]. Example: YS("END")="11/11/2011" YSDATA Type: Output Array= internal administration date^external administration date^test code Data is sorted in order of most recent administration to the oldest administration. If no administrations are found Array(2) will not be returned. If patient has no If patient has no PSYCH INSTRUMENT PATIENT file (#601.2) data, Array(1) will return [ERROR] with an explanation. Example: YSDATA(1)=[DATA] YSDATA(2)=2901120^11/20/1990^AOR YSDATA(3)=2900730^07/30/1990^ALCO YSDATA(4)=2900730^07/30/1990^HX2 YSDATA(5)= 2900730^07/30/1990^MROS YSDATA(6)= 2900730^07/30/1990^PSOC YSDATA(7)= 2900730^07/30/1990^TRMT This API returns all psychological test administrations for a specified patient during a specified time period. No scoring is returned. COMPONENT: LISTONE VARIABLES: DFN Type: Input This is the Patient's name, a pointer value to the Patient file #2. CODE Type: Input Test code from the MH INSTRUMENT file (#601) or "ASI" e.g. "CAGE", "BDI". BEGIN Type: Input Inclusive date in %DT acceptable format (11/11/2011) to begin search [optional]. END Type: Input Inclusive date in %DT acceptable format (11/11/2011) to end search [optional]. LIMIT Type: Input Constrains to the last N administrations [optional] SCALE Type: Input Scale number from the MH INSTRUMENT file (#601) or 1-7 on ASI [optional] YSDATA Type: Output Array= internal administration date ^ external administration date^test code [^scale name^raw score^transformed score] Data is sorted in order of most recent administration to the oldest administration. If no administrations are found Array(2) will not be returned. If patient has no PSYCH INSTRUMENT PATIENT file (#601.2) data, Array(1) will return [ERROR] with an explanation. EXAMPLE: Input ----- YS("DFN")=83 YS("CODE")=MMPI2 YS("SCALE")=2 Output ------ YSDATA(1)=[DATA] YSDATA(2)=2940509^05/09/1994^MMPI2^F Infrequency^19^95 YSDATA(3)=2920925^09/25/1992^MMPI2^F Infrequency^26^116 YSDATA(4)=2920924^09/24/1992^MMPI2^F Infrequency^25^113 This API returns all psychological test administrations for a specified patient during a specified time period for a specified test. If a scale is also specified, scoring for that scale is returned. User must have adequate privileges to receive this information (i.e. often the YSP KEY). ******************** 2891 NAME: DBIA2891 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API returns all scoring information for a specified patient given a specified administration date for a specified test or instrument. User must have adequate privileges to receive this information (i.e. often the YSP KEY). ROUTINE: YTAPI2 COMPONENT: SCOREIT VARIABLES: DFN Type: Input Patient internal identifier CODE Type: Input Test code from MH INSTRUMENT file (#601) or "ASI" (e.g. "CAGE", "BDI") ADATE Type: Input Inclusive administration date in %DT acceptable format (11/11/2011) YSDATA Type: Output Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External Admin Date ^Ordered by Array(3)=R1^Responses 1-200 undelimited Array(4)=R2^ Responses 201-400 undelimited (even if less than 200) Array(5)=R3^ Responses 401-600 undelimited Array(6)=S1^Scale Name^Raw Score^Transformed Score Array(7)=S2^ Scale Name^Raw Score^Transformed Score And onward as needed Example: Input ----- YS("DFN")=83 YS("CODE")=MMPI2 YS("ADATE")=05/09/1994 Output ------ YSDATA(1)=[DATA] YSDATA(2)=CAPP,ANDY W^MMPI2^--- Minnesota Multiphasic Personality Inventory-2 -- -^2940509^05/09/1994^CAULFIELD,MARY A YSDATA(3)=R1^TTTFTTFTTTFTTFFFFFFTTFFFFFFFTFF FFFFFFFFFFFFFFFFFFFFTFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFTTTTTTFFFFFFFF FFFFFFFFFFFFFFFFFFFFFTTTTFFFTTFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFF YSDATA(4)=R2^FFFFFFFFFFFFFFFFFFFFFFFFFTTTTTT TTTTTTTTTTFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFTTT YSDATA(5)=R3^TTTTTTTTTTTTTTTTTTTTTTTFFFFFFFF FFFFFFFFFFFFTTFFFTFTFTFTFTFTFTFTFTFF FTFTFTFTFTFTFTFTFTFTFTFTTFTFTFTFFFFTFFTFTFTF TFTFTFFTFTFTFTFTFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFF YSDATA(6)=S1^L Lie^12^87 YSDATA(7)=S2^F Infrequency^19^95 . . . YSDATA(89)=S84^Ma-S Hypomania, Subtle^10^50 YS Type: Input ******************** 2893 NAME: DBIA2893 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API allows saving of patient responses to a test or interview in the PSYCH INSTRUMENT PATIENT file (#601.2). The patient ien, the test code, and administration date is required along with the responses. All responses are checked for validity. No scoring is returned but successful addition to the PSYCH INSTRUMENT PATIENT file (#601.2) is indicated. ROUTINE: YTAPI1 COMPONENT: SAVEIT VARIABLES: DFN Type: Input Patient internal identifier CODE Type: Input Test code from MH INSTRUMENT file (#601) or "ASI" (e.g. "CAGE", "BDI") ADATE Type: Input Inclusive administration date in %DT acceptable format (11/11/2011) STAFF Type: Input DUZ of professional ordering the test R1 Type: Input String of patient responses 1-200 R2 Type: Input String of patient responses 201-400 [as needed] R3 Type: Input String of patient responses 401-600 [as needed] YSDATA Type: Output Array(1)=[DATA] indicates successful call Example: Input ----- YS("DFN")=6 YS("ADATE")="T" YS("CODE")="ZUNG" YS("STAFF")=67 YS("R1")="12121212121212121212" Output ------ YSDATA(1)=[DATA] YSDATA(2)=saved ******************** 2895 NAME: DBIA2895 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: YTAPI3 COMPONENT: SHOWIT VARIABLES: CODE Type: Input Test code from in the MH INSTRUMENT file (#601) (e.g. "CAGE", "BDI") ITEM Type: Input A positive whole number between 1 and the highest item number for the specified test. YSDATA Type: Output Array(1)=[DATA] ;indicates successful call Array(2)=MMPI2 item: 1 ;SECOND LINE IS TEST CODE AND ITEM NUMBER Array(3)=[BEGIN ITEM]; BEGINS EACH ITEM Array(4)=MMPI2^1 ;CODE^ITEM NUMBER Array(5)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(12)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(14)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(18)=[RESPONSE] ];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(21)=[END ITEM]; ENDS EACH ITEM Example: Input ----- YS("CODE")="MMPI2" YS("ITEM")=1 Output ------ YSDATA(1)=[DATA] YSDATA(2)=[BEGIN ITEM] YSDATA(3)=MMPI2^1 YSDATA(4)=[INTRO] YSDATA(5)=Please read each statement carefully and decide whether it is true YSDATA(6)=as applied to you or false as applied to you. YSDATA(7)= YSDATA(8)=If a statement is true or mostly true, as applied to you, answer 'T'. YSDATA(9)=If a statement is false or not usually true, as applied to you, answer YSDATA(10)='F'. YSDATA(11)= YSDATA(12)=Remember to give your own opinion of yourself. YSDATA(13)=[TEXT] YSDATA(14)=I like mechanics magazines. YSDATA(15)=[BOTTOM] YSDATA(16)=T= True YSDATA(17)=F= False YSDATA(18)=Answer= YSDATA(19)=[RESPONSE] YSDATA(20)=TFX YSDATA(21)=[END ITEM] This API returns the text, bottom, introduction and possible correct responses for a specified test item in MH INSTRUMENT file (#601). It will work only for tests as opposed to interviews or batteries. The ASI is not supported. COMPONENT: SHOWALL VARIABLES: CODE Type: Input Test code from the MH INSTRUMENT file (#601). ( e.g. "CAGE", "BDI") YSDATA Type: Output Array(1)=[DATA] ;indicates successful call Array(2)=MMPI2 item: 1 ;SECOND LINE IS TEST CODE AND ITEM NUMBER Array(3)=[BEGIN ITEM]; BEGINS EACH ITEM Array(4)=MMPI2^1 ;CODE^ITEM NUMBER Array(5)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(12)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(14)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(18)=[RESPONSE] ];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(21)=[END ITEM]; ENDS EACH ITEM . . . Array(1003)=[BEGIN ITEM]; BEGINS EACH ITEM Array(1004)=MMPI2^567 ;CODE^ITEM NUMBER Array(1005)=[INTRO];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(1012)=[TEXT];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(1014)=[BOTTOM];HEADER ALWAYS PRESENT OPTIONALY FOLLOWED BY TEXT Array(1018)=[RESPONSE] ];HEADER ALWAYS PRESENT ALWAYS FOLLOWED BY TEXT Array(1021)=[END ITEM]; ENDS EACH ITEM Example: Input ----- YS("CODE")="MMPI2" YS("ITEM")=1 Output ------ YSDATA(1)=[DATA] YSDATA(2)=[BEGIN ITEM] YSDATA(3)=MMPI2^1 YSDATA(4)=[INTRO] YSDATA(5)=Please read each statement carefully and decide whether it is true YSDATA(6)=as applied to you or false as applied to you. YSDATA(7)= YSDATA(8)=If a statement is true or mostly true, as applied to you, answer 'T'. YSDATA(9)=If a statement is false or not usually true, as applied to you, answer YSDATA(10)='F'. YSDATA(11)= YSDATA(12)=Remember to give your own opinion of yourself. YSDATA(13)=[TEXT] YSDATA(14)=I like mechanics magazines. YSDATA(15)=[BOTTOM] YSDATA(16)=T= True YSDATA(17)=F= False YSDATA(18)=Answer= YSDATA(19)=[RESPONSE] YSDATA(20)=TFX YSDATA(21)=[END ITEM] . . . YSDATA(6950)=[BEGIN ITEM] YSDATA(6951)=MMPI2^567 YSDATA(6952)=[INTRO] YSDATA(6953)=[TEXT] YSDATA(6954)=Most married couples don't show much affection for each other. YSDATA(6955)=[BOTTOM] YSDATA(6956)=T= True YSDATA(6957)=F= False YSDATA(6958)=Answer= YSDATA(6959)=[RESPONSE] YSDATA(6960)=TFX YSDATA(6961)=[END ITEM] This API returns the text, bottom, introduction and possible correct responses for all items in a test in the MH INSTRUMENT file (#601). It will work only for tests as opposed to interviews or batteries. The ASI is not supported. ******************** 2896 NAME: DBIA2896 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JUN 4,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API returns the GAF scores for a specified patient. It can be constrained by both date range and occurrence limit. Please note that data for this API comes from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8). ROUTINE: YSGAFAPI COMPONENT: GAFHX VARIABLES: DFN Type: Input Patient internal identifier BEGIN Type: Input Inclusive date in %DT acceptable format (11/11/2011) to begin search [optional] END Type: Input Inclusive date in %DT acceptable format (11/11/2011) to end search [optional] LIMIT Type: Input Constrains to the last N diagnoses [optional] YSDATA Type: Output Array(1)=[DATA] ;indicates successful call Array(1)=GAF Score^Internal Date^External Date^Provider^Comment . . Array(N)=GAF Score^Internal Date^External Date^Provider^Comment Example: Input ----- YS("DFN")=29601 YS("LIMIT")=3 Output ------ YSDATA(1)=[DATA] YSDATA(2)=100^2981209.1105^12/09/1998@11:05^ JONES,MARK^ YSDATA(3)=99^2981209.092^12/09/1998@09:20^JO NES,MARK^ YSDATA(4)=66^2981124.1406^11/24/1998@14:06^J ONES,MARK^ ******************** 2897 NAME: DBIA2897 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS Prosthetics Package uses the routine PRCH7D to add, edit and obligate purchase card transactions. USAGE: Private ENTERED: AUG 25,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine PRCH7D is used as an interface between Prosthetics Package, Administrative Home Oxygen Module and IFCAP for purchase card transactions. ROUTINE: PRCH7D COMPONENT: ADD VARIABLES: PRCA Type: Both Input variable Station Number and Vendor. Output variable if PRCA is <0, unsuccessful. Type: Add Administrative Home Oxygen purchase card transaction to File 442, PROCUREMENT & ACCOUNTING TRANSACTIONS. COMPONENT: EDITIC VARIABLES: PRCA Type: Input Total monthly amount PRCB Type: Input Internal Entry Number of File 442, PROCUREMENT & ACCOUNTING TRANSACTIONS PRCC Type: Input An array of the Control Point, DFN, and monthly amount. Edit existing purchase card transaction. COMPONENT: OBL VARIABLES: PRCA Type: Input Null X Type: Output If X="^" obligation is unsuccessful PRCB Type: Input Internal Entry Number of File 442, PROCUREMENT & ACCOUNTING TRANSACTIONS PRCC Type: Input Total Monthly Amount Obligation of the transaction. ******************** 2900 NAME: DBIA2900 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: AUG 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771 ROOT: HL(771, DESCRIPTION: TYPE: File A one time update to set the site number in HL7's table for the Application entry in file 771. ^HL(771, 3 FACILITY NAME 0;3 Write w/Fileman ROUTINE: ******************** 2901 NAME: GMRCASF CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: AUG 31,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will allow calling routine GMRCASF. ROUTINE: GMRCASF COMPONENT: SF VARIABLES: IEN Type: Input IEN of entry in file 123 Call to designate a consult as having significant findings. ******************** 2902 NAME: TIU/Health Summary by Visit Date CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY MYHEALTHEVET USAGE: Controlled Subscri ENTERED: SEP 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The routine TIULAPIC controls the branching for extracting documents by occurrence, date or type for a given patient. ROUTINE: TIULAPIC COMPONENT: VISIT(DFN,TIUDOC,TIME1,TIME2,OCCLIM,TEXT) VARIABLES: DFN Type: Input The IEN of the patient file (#2) (required) TIUDOC Type: Input TIU document class, IEN of the TIU DOCUMENT DEFINITION file (#8925.1) (required) TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input The number of occurrences of teh type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) This entry point is used to extract TIU documents by Visit Date for the Visit Patient Health Summary. COMPONENT: MAIN(DFN,TIUDOC,TIME1,TIME2,OCCLIM,TEXT) VARIABLES: DFN Type: Input The IEN of the Patient file (#2) (required) TIUDOC Type: Input TIU document class, IEN of the TIU DOCUMENT DEFINITION file (#8925.1) (required) TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input The number of occurrences of the type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) This is entry point is used to extract TIU documents by document Reference Date for the Discharge Summary Component of Health Summary. ******************** 2903 NAME: CHANGING WRITE IDENTIFIERS CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE The code is in the routine PRCAI78 which is a post in it for patch PRCA*4.5*78. The code looks like: ; set write identifiers for file 433 (removes old id that references calm) S ^DD(433,0,"ID","WR1")="I +$P(^(0),U,4)<2 D EN^DDIOL("" TRANSACTION STATUS: INCOMPLETE"","""",""?0"")" K ^DD(433,0,"ID","WR2") USAGE: Private ENTERED: SEP 8,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This integration agreement allows the Accounts Receivable package to change the write identifiers on the AR TRANSACTION File #433. ROUTINE: ******************** 2907 NAME: TIU MEDICATION OBJECTS READ PHARMACY FILE CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 53.1 ROOT: PS(53.1, DESCRIPTION: TYPE: File TIU's medication objects now allow for the sorting of medications by drug class, including pending orders for medications that may not yet have a dispense drug. They also allow for the exclusion of supply items from medication lists, if desired. To accomodate this functionality, TIU requests direct global read access to the following pharmacy file: ^PS(53.1, - NON-VERIFIED ORDERS FILE (#53.1) Node .2, piece 1 - ORDERABLE ITEM FIELD (#108) ^PS(53.1,DA,1 - DISPENSE DRUG SUB-FILE (#53.11) Node 0, piece 1 - DISPENSE DRUG FIELD (#.01) ^PS(53.1, 108 ORDERABLE ITEM Direct Global Read & w ^PS(53.1,DA,1, .01 DISPENSE DRUG Direct Global Read & w ROUTINE: ******************** 2909 NAME: TIU MEDICATION OBJECTS READ PHARMACY FILE CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 15,1999 STATUS: Active EXPIRES: JUN 1,2006 DURATION: Till Otherwise Agr VERSION: FILE: 52.6 ROOT: PS(52.6, DESCRIPTION: TYPE: File This agreement will be retired on 6/1/2006. Please do not add any additional code that utilizes this Integration Agreement. APIs have been created that can be used in place of any code needing to make use of this agreement. These APIs were released with patch PSS*1*91. Documentation information can be found in the patch description. In addition, any code that currently utilizes this Integration Agreement must be converted to use the new API's. If any part of this Integration Agreement cannot be satisfied with the APIs, please contact the PRE development team mail group at VHA OI SDD PHARM REENG DEV using Microsoft Outlook. TIU's medication objects now allow for the sorting of medications by drug class, including pending orders for medications that may not yet have a dispense drug. They also allow for the exclusion of supply items from medication lists, if desired. To accomodate this functionality, TIU requests direct global read access to the following pharmacy file: ^PS(52.6, - IV ADDITIVES FILE (#52.6) Node 0, piece 2 - GENERIC DRUG FIELD (#1) ^PS(52.6, 1 GENERIC DRUG Direct Global Read & w ROUTINE: ******************** 2910 NAME: Delete Read Protection on Files CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: OCT 5,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 1 ROOT: DIC( DESCRIPTION: TYPE: File E3R PSN-4-12347 asked that the read protection on files related to National Drug File be removed. To meet this request, NDF requests a one time agreement with VA FileMan to KILL the global nodes ^DIC(50.6,0,"RD"), ^DIC(50.64,0,"RD"), ^DIC(50.67,0,"RD"), and ^DIC(50.68,0,"RD") ^DIC(50.6,0,'RD') ^DIC(50.64,0,'RD') ^DIC(50.67,0,'RD') ^DIC(50.68,0,'RD') ROUTINE: ******************** 2911 NAME: TREATING FACILITY LIST (#391.91): relationship with CIRN PD CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK The CIRN package would like to loop through ^DGCN(391.91,"B",#.01,D0) to get the (#.02)INSTITUTION field. CIRN PD intends to use the "APAT", "AINST" cross-references in some of its applications. The use of these cross-references will determine the internal entry number (ien) of the TREATING FACILITY LIST (TFL) entry. CIRN PD intends to check the DATE LAST TREATED (#.03) field for data. A direct global read is being requested for the DATE LAST TREATED (node: 0 ; piece: 3) field. CIRN PD intends to write data to the TFL file for the following fields: DATE LAST TREATED and ADT/HL7 EVENT REASON (#.07). Write access with FileMan is requested. USAGE: Private ENTERED: JAN 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 391.91 ROOT: DGCN(391.91, DESCRIPTION: TYPE: File The CIRN PD package would like to use the TREATING FACILITY (#391.91) file for the following functions: 1) Loop through "B" cross- reference in the TREATING FACILITY (#391.91) file getting the INSTITUTION (#4) file IEN or the (#.02) INSTITUTION [2P] field. 2) Take each IEN and translate into a HL LOGICAL LINK (#870) file entry 3) Using the known SUBSCRIPTION CONTROL IEN, call GET^HLSUB, to get the DESTINATIONS for that IEN. 4) Compare the logical links identified by the entries in the TREATING FACILITY to the links returned by GET^HLSUB. If there is not a one-to-one relationship add an entry to the SUBSCRIPTION CONTROL (#774) file for the missing entry. The missing entry is added using $$ACT^HLSUB and UPD^HLSUB. 5) Utilize the "APAT" cross-reference to determine the internal entry number (ien) of the TREATING FACILITY LIST (TFL) record. If an ien does not exist, we add to the TFL file. 6) Utilize the "AINST" cross-reference to check for patients within a given facility. 7) A direct global read for the DATE LAST TREATED field (#.03 ; node: 0 ; piece: 3) to determine if the data on file is valid. 8) Write access with FileMan for the following fields: DATE LAST TREATED and ADT/HL7 EVENT REASON (field: .07 ; node: 0 ; piece: 7). ADT/HL7 EVENT REASON is a pointer data type pointing to the ADT/HL7 EVENT REASON (#391.72) file. At this time we are only concerned about missing subscriptions and not missing treating facilities. ^DGCN(391.91, .02 INSTITUTION 0;2 Direct Global Read & w .03 DATE LAST TREATED 0;3 Direct Global Read & w .07 ADT/HL7 EVENT REASON 0;7 Write w/Fileman .01 PATIENT 0;1 Read w/Fileman ^DGCN(391.91,'APAT') This is a M type cross-reference. It builds the cross-reference from PATIENT (#.01) and INSTITUTION (#.02) field data. The structure is as follows: ^DGCN(391.91,"APAT", PATIENT (#2) file pointer , INSTITUTION (#4) file pointer , internal entry number)="" ^DGCN(391.91,'AINST') This is a M type cross-reference. It builds the cross-reference from PATIENT (#.01) and INSTITUTION (#.02) field data. The structure is as follows: ^DGCN(391.91,"AINST", INSTITUTION (#4) file pointer , PATIENT (#2) file pointer , internal entry number)="" ^DGCH(391.91,'C', x-ref build from INSTITUTION (#.02) and PATIENT (#.01) fields. ROUTINE: ******************** 2913 NAME: SUPPORT TIU'S UPLOAD OF C&P EXAMS CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 20,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 396.3 ROOT: DVB(396.3, DESCRIPTION: TYPE: File This DBIA, along with #2914 and #2915, is intended to support the upload of Compensation and Pension Exam Results into AMIE, using TIU's batch upload facility. ^+DVB(396.3,D0,0) .01 NAME 0;1 Direct Global Read & w This field is accessed in a read-only manner to determine whether the incoming data was transcribed for the same patient that the corresponding 2507 REQUEST entry refers to. If the patient associated with the incoming data does NOT match the one for whom the REQUEST was entered, a FILING ERROR will be raised. When such a FILING ERROR is corrected the NAME Field is also used to display the NAME and SSN of the patient for each open request (as specified by DIC("W")) in the FIX^TIUPUTA subroutine. ROUTINE: ******************** 2914 NAME: SUPPORT TIU'S UPLOAD OF C&P EXAMS CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 20,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 396.4 ROOT: DVB(396.4, DESCRIPTION: TYPE: File This DBIA, along with #2913 and #2915, is intended to support the upload of Compensation and Pension Exam Results into AMIE, using TIU's batch upload facility. ^DVB(396.4,D0,0) .02 2507 REQUEST 0;2 Direct Global Read & w Given the transcribed record number in file 396.4, this field is read in order to identify the corresponding 2507 Request and thereby determine which patient the request was entered for. .04 STATUS 0;4 Write w/Fileman This field is set to COMPLETED by the FOLLOWUP^TIUPUTA when the record is successfully filed. 70 EXAM RESULTS RES;0 Direct Global Write & The plain text for the CP Exam is filed in this word-processing field. ROUTINE: ******************** 2915 NAME: SUPPORT TIU'S UPLOAD OF C&P EXAMS CUSTODIAL PACKAGE: AUTOMATED MED INFO EXCHANGE SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 20,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 396.6 ROOT: DVB(396.6, DESCRIPTION: TYPE: File This DBIA, along with #2913 and #2914, is intended to support the upload of Compensation and Pension Exam Results into AMIE, using TIU's batch upload facility. ^DVB(396.6,D0,0) 6 PRINT NAME 0;2 Direct Global Read & w This field is accessed in a read-only manner for the DIC("W") code specified in FIX^TIUPUTA to display the Exam Type for the user who is resolving a FILING ERROR for a case where the look-up method failed to confirm a match between the exam and the patient identified by the incoming transcription. ROUTINE: ******************** 2916 NAME: Data Base Server API: DD Modification Utilities CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 20,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DDMOD COMPONENT: DELIX VARIABLES: FILE Type: Input (Required) File or subfile number. FIELD Type: Input (Required) Field number. CROSS_REF Type: Input (Required) Cross-reference number. Traditional cross-references are defined in the data dictionary under: ^DD(file#,field#,1,cross reference number) FLAGS Type: Input (Optional) Flags to control processing. The possible values are: K For Regular, KWIC, Mnemonic, and Soundex-type cross-references, delete the data in the index. For MUMPS and Trigger-type cross-references, execute the kill logic of the cross-reference for all entries in the file. For Bulletin-type cross-references, the "K" flag is ignored; the kill logic for Bulletin-type cross-references is never executed by this procedure. W Write messages to the current device as the index is deleted and cross-references and input templates are recompiled. OUTPUT_ROO Type: Both (Optional) Input: The name of the array that should receive information about input templates and cross-references that may have been recompiled and a flag to indicate that the deletion was audited in the DD Audit file (#.6). This must be a closed root, either local or global. Output: If the field on which the deleted cross-reference was defined is used in any compiled input templates, those input templates are recompiled. Information about the recompiled input templates is stored descendant from OUTPUT_ROOT("DIEZ"): OUTPUT_ROOT("DIEZ",input template #) = input template name ^ file # ^ compiled routine name If cross-references for the file are compiled, they are recompiled, and the compiled routine name is stored in OUTPUT_ROOT("DIKZ"): OUTPUT_ROOT("DIKZ") = compiled routine name If the data dictionary for the file is audited, an entry is made in the DD Audit file (#.6) and OUTPUT_ROOT("DDAUD") is set to 1: OUTPUT_ROOT("DDAUD") = 1 MSG_ROOT Type: Both (Optional) The name of the array that should receive any error messages. This must be a closed root, either local or global. If not passed, errors are returned descendent from ^TMP("DIERR",$J). This procedure deletes a Traditional Cross-Reference definition from the data dictionary. Optionally, it deletes the data in the index or executes the kill logic for all entries in the file. Compiled input templates that contain the field on which the cross-reference is defined are recompiled. If cross-references on the file are compiled, they are recompiled. Format: DELIX^DDMOD(FILE,FIELD,CROSS_REF,FLAGS,OUTPUT_ROOT,MSG_ROOT) Examples -------- 1. In this example, regular cross-reference #4 (the "C" index), defined on field #12 in file #16200, is deleted. The "K" flag indicates that the entire ^DIZ(16200,"C") index is removed from the file. >D DELIX^DDMOD(16200,12,4,"K","MYOUT") >ZW MYOUT MYOUT("DDAUD")=1 MYOUT("DIEZ",100)=ZZTEST EDIT^16200^ZZIT MYOUT("DIKZ")=ZZCR The MYOUT output array indicates that the deletion was recorded in the DD Audit file (#.6). Field #12 is included in the compiled input template ZZTEST EDIT (#100), which is compiled into the ZZIT namespaced routines. Cross-references on file #16200 are compiled under the ZZCR namespace. 2. In this example, the whole-file regular cross-reference #7 (the "N" index), defined on field #15 within subfile #16200.075, is deleted. The "K" flag indicates that the entire ^DIZ(16200,"N") index should be removed, and the "W" flag indicates that messages should be printed to the current device. >D DELIX(16200.075,15,7,"KW") Removing index ... Deleting cross-reference definition ... Compiling ZZ TEST CR Input Template of File 16200... 'ZZIT1' ROUTINE FILED.. 'ZZIT' ROUTINE FILED.... 'ZZIT2' ROUTINE FILED. Compiling Cross-Reference(s) 16200 of File 16200. ...SORRY, HOLD ON... 'ZZCR1' ROUTINE FILED. 'ZZCR2' ROUTINE FILED. 'ZZCR3' ROUTINE FILED. 'ZZCR4' ROUTINE FILED. 'ZZCR5' ROUTINE FILED. 'ZZCR' ROUTINE FILED. Error Codes Returned -------------------- 202 The specified parameter is missing or invalid. 301 The passed flags are incorrect. 401 The file does not exist. 406 The file has no .01 definition. 407 A word-processing field is not a file. 501 The file does not contain the specified field. COMPONENT: DELIXN VARIABLES: FILE Type: Input (Required) File or subfile number. For whole-file indexes, this is the number of the file at the upper level where the data in the index resides. INDEX Type: Input (Required) Index name. FLAGS Type: Input (Optional) Flags to control processing. The possible values are: K For Regular indexes, delete the data in the index. For MUMPS indexes, execute the kill logic for all entries in the file. W Write messages to the current device as the index is deleted and cross-references and input templates are recompiled. OUTPUT_ROO Type: Both (Optional) Input: The name of the array that should receive information about input templates and cross-references that may have been recompiled. This must be a closed root, either local or global. Output: If a field used in the index is used in any compiled input templates, those input templates are recompiled. Information about the recompiled input templates is stored descendant from OUTPUT_ROOT("DIEZ"): OUTPUT_ROOT("DIEZ",input template #) = input template name ^ file # ^ compiled routine name If cross-references for the file are compiled, they are recompiled, and the compiled routine name is stored in OUTPUT_ROOT("DIKZ"): OUTPUT_ROOT("DIKZ") = compiled routine name MSG_ROOT Type: Both (Optional) The name of the array that should receive any error messages. This must be a closed root, either local or global. If not passed, errors are returned descendent from ^TMP("DIERR",$J). This procedure deletes a New-Style Index definition from the Index file. Optionally, it deletes the data in the index or executes the kill logic for all entries in the file. Compiled input templates that contain one or more of the fields defined in the index are recompiled. If cross-references on the file are compiled, they are recompiled. Format: DELIXN^DDMOD(FILE,INDEX,FLAGS,OUTPUT_ROOT,MSG_ROOT) Examples -------- 1. In this example, the new-style "G" index defined on file #16200 is deleted. The "K" flag indicates that the entire ^DIZ(16200,"G") index should be removed from the file. >D DELIXN^DDMOD(16200,"G","K","MYOUT") >ZW MYOUT MYOUT("DIEZ",94)=ZZ TEST^16200^ZZIT MYOUT("DIEZ",100)=ZZ TEST A^16200^ZZITA MYOUT("DIKZ")=ZZCR The MYOUT output array indicates that a field or fields defined in the deleted index are used in the compiled input templates ZZ TEST (#94) and ZZ TEST 2 (#100). Those two input templates were recompiled. Cross-references on file #16200 were also recompiled under the ZZCR namespace. 2. In this example, the whole-file regular index (the "J" index) is deleted. The fields in the index come from fields in a multiple, subfile #16200.075, but the whole-file index resides at the top-level file #16200. The "K" flag indicates that the entire ^DIZ(16200,"J") index should be removed, and the "W" flag indicates that messages should be printed to the current device. >D DELIXN^DDMOD(16200,"J","KW","MYOUT") Removing index ... Deleting index definition ... Compiling ZZ TEST Input Template of File 16200.... 'ZZIT' ROUTINE FILED.... 'ZZIT1' ROUTINE FILED. Compiling ZZ TEST A Input Template of File 16200.... 'ZZITA' ROUTINE FILED.... 'ZZITA' ROUTINE FILED. Compiling Cross-Reference(s) 16200 of File 16200. ...SORRY, JUST A MOMENT PLEASE... 'ZZCR1' ROUTINE FILED. 'ZZCR2' ROUTINE FILED. 'ZZCR3' ROUTINE FILED. 'ZZCR4' ROUTINE FILED. 'ZZCR5' ROUTINE FILED. 'ZZCR6' ROUTINE FILED. 'ZZCR7' ROUTINE FILED. 'ZZCR8' ROUTINE FILED. 'ZZCR9' ROUTINE FILED. 'ZZCR10' ROUTINE FILED. 'ZZCR' ROUTINE FILED. Error Codes Returned -------------------- 202 The specified parameter is missing or invalid. 301 The passed flags are incorrect. COMPONENT: FILESEC VARIABLES: FILE Type: Both (Required) File number. (Cannot be less than 2.) .SECURITY_ Type: Both (Required) Array of new security access codes: SECURITY_CODES("AUDIT") = Audit Access SECURITY_CODES("DD") = Data Dictionary Access SECURITY_CODES("DEL") = Delete Access SECURITY_CODES("LAYGO") = LAYGO Access SECURITY_CODES("RD") = Read Access SECURITY_CODES("WR") = Write Access MSG_ROOT Type: Both (Optional) The root of an array into which error messages are returned. If this parameter is not included, errors are returned in the default array: ^TMP("DIERR",$J). Set File Protection Security Codes FORMAT FILESEC^DDMOD(FILE,.SECURITY_CODES,MSG_ROOT) This entry point sets the security access codes for a file, which are stored in the following nodes: ^DIC(filenumber,0,"AUDIT") -- Audit Access ^DIC(filenumber,0,"DD") -- Data Dictionary Access ^DIC(filenumber,0,"DEL") -- Delete Access ^DIC(filenumber,0,"LAYGO") -- LAYGO Access ^DIC(filenumber,0,"RD") -- Read Access ^DIC(filenumber,0,"WR") -- Write Access Error Code: 401 File does not exist or the File Number that was passed was Less Than 2. COMPONENT: CREIXN VARIABLES: .RESULTS Type: Both (Optional) Local variable that receives the IEN of the entry that was created in the INDEX file (#.11), if the call is successful, and the Name of the new index. If the cross-reference could not be created, a value of null ("") is returned. RESULT = IEN in Index file ^ cross-reference name or RESULT = "" if cross-reference could not be created .XREF Type: Input (Required) This input array contains information about the new-style cross-reference to be created. The elements in this array are as follows: XREF("FILE") = The number of the file or subfile on which the index physically resides. For whole-file indexes, this should be the file number of the upper level file, not the subfile that contains the fields in the index. For MUMPS cross-references that don't set an index, XREF("FILE") should be the file that contains the fields in the cross-reference. (Required) XREF("TYPE") = "R" or "REGULAR" for regular indexes; or "MU" or "MUMPS" for MUMPS-type cross-references. (Required) XREF("NAME") = The name of the cross-reference. If XREF("NAME") is not passed, CREIXN^DDMOD gets the next available name based on the XREF("FILE") and XREF("USE"). In most cases, however, you should explicitly give your new cross-reference a name. (Required if XREF("USE") is not passed.) XREF("ROOT FILE") = For whole-file indexes, the number of the file or subfile that contains the fields in the cross-reference. This is the subfile number, not the upper level file number where the index physically resides. XREF("ROOT FILE") should only be set for whole-file indexes. (Required for whole-file indexes.) XREF("SHORT DESCR") = Short description of the cross-reference (Required) XREF("DESCR",1) = Line 1 of the cross-reference description. XREF("DESCR",n) = Line n of the cross-reference description. (Optional) XREF("USE") = "LS" or "LOOKUP & SORTING" for indexes used for both lookup and sorting; "S" or "SORTING ONLY" for indexes used for sorting only; or "A" or "ACTION" for MUMPS cross-reference that do not set an index. "LS" ("LOOKUP & SORTING") - The cross-reference sets an index and the index name must start with "B" or a letter that alphabetically follows "B". Calls to Classic FileMan lookup (^DIC) or the Finder (FIND^DIC or $$FIND1^DIC) where the index is not specified will include this index in the search. The index will be available for use by the FileMan Sort and Print (EN1^DIP). "S" ("SORTING ONLY") - The cross-references sets an index, and the index name must start with "A". Calls to Classic FileMan lookup (^DIC) or the Finder (FIND^DIC or $$FIND1^DIC) will not use this index unless it is specified in the input parameters to those calls. The index will be available for use by the FileMan Sort and Print (EN1^DIP). "A" ("ACTION") -This is used for MUMPS cross-references that perform some action(s) other than building an index. The cross-reference name must start with "A". If XREF("USE") is not passed, CREIXN^DDMOD assumes a value based on the cross-reference name and type. If the name starts with "A", XREF("USE") is assumed to be "S" (Sorting Only) for Regular indexes, and "A" (Action) for MUMPS cross-references. If the name doesn't start with an "A", XREF("USE") is assumed to be "LS" (Lookup & Sorting). Note that for clarity, however, it is recommended that you explicitly set XREF("USE"). (Required if XREF("NAME") is not passed.) XREF("EXECUTION") = "F" or "FIELD" for field-level execution; or "R" or "RECORD" for record-level execution. This indicates whether the cross-reference logic should be executed after a field in the cross-reference changes, or only after all fields in a record are updated in an editing session. The logic for most simple (single-field) cross-references should be executed immediately after the field changes, and so should have an Execution of "F". The logic for most compound (multi-field) cross-references should be executed only once after a transaction on the entire record is complete, and so should have an Execution of "R". (Optional) (Defaults to "F" for simple cross-references, and "R" for compound cross-references.) XREF("ACTIVITY") = One or both of the following codes: I = Installing an entry at a site R = Re-cross-referencing this index If Activity contains an "I", FileMan fires the cross-references during a KIDS installation. If Activity contains an "R", FileMan fires the cross-reference during a re-cross-referencing operation. Note that FileMan automatically fires cross-references during an edit, regardless of Activity, although you can control whether a cross-reference is fired by entering set and kill conditions. Also, if you explicitly select a cross-reference in an EN^DIK, EN1^DIK, or ENALL^DIK call, or in the UTILITY FUNCTIONS/RE-INDEX FILE option on the VA FileMan menu, that cross-reference will be fired whether or not its Activity contains an "R". (Optional) (Defaults to "IR") XREF("SET CONDITION") = MUMPS code that sets the variable X. The set logic of the cross-reference is executed only if the set condition, if present, sets X to Boolean true, according the M rules for Boolean interpretation. The MUMPS code can assume the DA array describes the record to be cross-referenced, and that the X(order#) array contains values after the transform for storage is applied, but before the truncation to the maximum length. The variable X also equals X(order#) of the lowest order number. When fields that make up a cross-reference are edited and the kill and set conditions are executed, the X1(order#) array contains the old field values, and the X2(order#) array contains the new field values. If a record is being added, and there is an X1(order#) array element that corresponds to the .01 field, it is set to null. When a record is deleted, all X2(order#) array elements are null. (Optional) XREF("KILL CONDITION") = MUMPS code, that sets the variable X. The kill logic of the cross-reference is executed only if the kill condition, if present, sets X to Boolean true, according the M rules for Boolean interpretation. See XREF("SET CONDITION") above for a description of the DA, X, X1, and X2 arrays that can be used in the MUMPS code. (Optional) For MUMPS cross-references, you can also set the following nodes in the XREF array. (For Regular Indexes, the set and kill logic is determined automatically for you, and so these nodes, if passed in, are ignored.) The code can also make use of the DA, X, X1, and X2 arrays as described in XREF("SET CONDITION") above. XREF("SET") = M code that FileMan should be executed when the values of fields that make up the cross-reference are set or changed. (Optional) (Defaults to "Q") XREF("KILL") = M code that FileMan should be executed when the values of fields that make up the cross-reference are changed or deleted. (Optional) (Defaults to "Q") XREF("WHOLE KILL") = M code that can be executed to remove an entire index for all records in a file. When an entire fire is reindexed, FileMan executes this code rather than looping through all the entries in the file and executing the kill logic once for each entry. (Optional) Each value in the cross-reference is described in the XREF("VAL",order#) portion of the XREF array. The order numbers must be positive integers starting from 1, and determine the order in which FileMan evaluates the cross-reference values to place in the X(order#) array during cross-reference execution. XREF("VAL",order#) = The field number (for field-type xref values); or M code that sets X to the cross-reference value (for computed-type xref values). For computed-type cross-reference values, the X(order#) array is available for those cross-reference values with lower order numbers, and the DA array describes the IEN of the current record. (Required) XREF("VAL",order#,"SUBSCRIPT") = The subscript position number in the index, if this cross-reference value is used as a subscript in the index. The first subscript to the right of the index name is subscript number 1. All subscripts must be consecutive integers starting from 1. (Optional) XREF("VAL",order#,"LENGTH") = The maximum length of the cross-reference value FileMan should use when storing the value as a subscript in the index. (Optional). XREF("VAL",order#,"COLLATION") = "F" for "forwards"; "B" for "backwards". This indicates the direction FileMan's lookup utilities should $ORDER through this subscript when entries are returned or displayed to the user. (Optional) (Defaults to "F".) XREF("VAL",order#,"LOOKUP PROMPT") = Text that becomes the prompt to the user when this index is used for lookup, and a value is requested for this subscript. (Optional) For field-type cross-reference values only, the following nodes can also be set: XREF("VAL",order#,"XFORM FOR STORAGE") = M code that sets the variable X to a new value. X is the only variable guaranteed to be defined and is equal to the internal value of the field. The Transform for Storage can be used to the transform the internal value of the field before it is stored as a subscript in the index. XREF("VAL",order#,"XFORM FOR LOOKUP") = M code that sets the variable X to a new value. X is the only variable guaranteed to be defined and is equal to the lookup value entered by the user. During lookup, if the lookup value is not found in the index, FileMan executes the Transform for Lookup code to transform the lookup value X and tries the lookup again. XREF("VAL",order#,"XFORMFOR DISPLAY") = M code that sets the variableX to a new value. X is the only variable guaranteed to be defined and isset equal to the value of the subscript of in the index. During lookup, ifa match or matches are ma de to the lookup value, the Transform for Display code is executed before displaying the index value to the user. FLAGS Type: Used (Optional) Flags to control processing. The possible values are: k - When CREIXN^DDMOD calls DELIXN^DDMOD to initially delete the old cross-reference with the same name as the one it is creating, don't kill the data in the old index if it is a Regular indexes, and don't execute the old Kill logic if it is a MUMPS cross-references. Whether or not this flag is passed, CREIXN^DDMOD deletes the old cross-reference definition, if it exists, before bringing in the new definition. S - For Regular indexes, set the data in the index. For MUMPS cross-references, execute the Set logic for all entries in the file. W - Write messages to the current device as the index is created and cross-references and input templates are recompiled. MSG_ROOT Type: Both (Optional) The name of the array that should receive any error messages. This must be a closed root, either local or global. If not passed, errors are returned descendent from ^TMP("DIERR",$J). OUTPUT_ROO Type: Both (Optional) The name of the array that should receive information about input templates and cross-references that may have been recompiled. See Output below. This must be a closed root, either local or global. This procedure creates a new-style cross-reference definition in the INDEX file (#.11). Optionally, it builds the data in the index (for Regular cross-references) or executes the set logic (for MUMPS cross-references) for all entries in the file. Compiled input templates that contain one or more of the fields defined in the cross-reference are recompiled. If cross-references on the file are compiled, they are recompiled. One use of CREIXN^DDMOD is in the pre-install or post-install routine of a KIDS (Kernel Installation and Distribution System) Build to create a new-style cross-reference at the installing site. If you pass in the cross-reference name in the XREF("NAME") input parameter, before CREIXN^DDMOD creates the new-index it automatically makes a call to DELIXN^DDMOD to delete the cross-reference with the same name, and optionally executes the kill logic for that cross-reference. See ^DIKCBLD for information on a programmer mode utility that can be used to help create a routine that calls CREIXN^DDMOD. Format: ------ CREIXN^DDMOD(.XREF,FLAGS,.RESULT,OUTPUT_ROOT,MSG_ROOT) ******************** 2919 NAME: Patients enrolled/preferred facility CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 25,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Looks up a patients enrolled/preferred faility: ROUTINE: DGENPTA COMPONENT: $$PREF(DFN,FACNAME) VARIABLES: DFN Type: Input IEN of a record in the PATIENT file. FACNAME Type: Both Optional parameter, pass by refernce - returns institution name. $$PREF Type: Output IEN for the record in the INSTITUTION file that is the patient's preferred facility, NULL if the prefereed facility cannot be determined. ******************** 2923 NAME: ASISTS use of $Order of File 450 CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: ASISTS USAGE: Private ENTERED: OCT 8,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 450 ROOT: PRSPC( DESCRIPTION: TYPE: File Use of $Order of through the top level of ^PRSPC(I) is needed in ASISTS. ASISTS needs to get a count of the number of PAID employees at each facility who are not separated. That information will be used in statistical analysis for blood-borne pathogen reporting. After getting the IEN of each PAID employee, the routine will use a FileMan read to determine whether the employee is separated. The routine will be executed on a monthly basis. ROUTINE: ******************** 2924 NAME: DBIA2924 CUSTODIAL PACKAGE: ONCOLOGY SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: OCT 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 160 ROOT: ONCO(160, DESCRIPTION: TYPE: File The Health Summary package has permission to do a "Direct Global Read" of the ONCOLOGY PATIENT (160) file's "B" cross-reference. ^ONCO(160,'B', The ONCOLOGY PATIENT (160) file "B" cross-reference is used to look up a patient in the ONCOLOGY PATIENT file. If the look-up is successful, the patient's ONCOLOGY PRIMARY (165.5) data is retrieved. (See DBIA 2888) ROUTINE: ******************** 2925 NAME: GMRCSLM2 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING PROSTHETICS CARE MANAGEMENT CLINICAL PROCEDURES USAGE: Controlled Subscri ENTERED: OCT 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to GMRCSLM2 as found in the OE/RR v3 interface specification document. ROUTINE: GMRCSLM2 COMPONENT: DT(IEN) VARIABLES: IEN Type: Input IEN of request in the REQUEST/CONSULTATION file (#123) TMP("GMRCR Type: Output ^TMP("GMRCR",$J,"DT",#,0)=line of report text Returns narrative for a consult report ******************** 2926 NAME: GMRCGUIA CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING PROSTHETICS CARE MANAGEMENT CLINICAL PROCEDURES Permitted to use the RT entry point component only. FEE BASIS CLAIMS SYSTEM USAGE: Controlled Subscri ENTERED: OCT 13,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to GMRCGUIA. ROUTINE: GMRCGUIA COMPONENT: RT(IEN,ARRAY) VARIABLES: IEN Type: Input IEN of request in the REQUEST/CONSULTATION file (#123) ARRAY Type: Both Name of the array in which to return the text of the report as ARRAY(#,0)=line of text Returns narrative for a consult result report COMPONENT: $$DC(IEN,PROVIDER,DATETIME,STATUS,.COMMENT) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123) PROVIDER Type: Input Pointer to NEW PERSON file (#200) denoting provider who discontinued or denied the consult request. DATETIME Type: Input Date/time the actual activity (discontinuation or denial) took place. STATUS Type: Input DY if Cancelled (previously 'deny') DC if Discontinued .COMMENT Type: Input Array of comment containing explanation of denial or discontinuation. OUTPUT Type: Output Extrinsic function returns: ErrorFlag^ErrorMessage ErrorFlag is 0 if no error found or 1 if an errror occured. ErrorMessage is null for no error or descriptive of error if one occurred. Entry point to discontinue or deny a consult request. COMPONENT: $$FR(IEN,SERVICE,PROVIDER,ATTENTION,URGENCY,.COMMENT,DATETIME) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123) SERVICE Type: Input Pointer to REQUEST SERVICES file (#123.5) indicating service consult request should be forwarded to. PROVIDER Type: Input Pointer to NEW PERSON file (#200) indicating provider responsible for the forwarding action. ATTENTION Type: Input Pointer to NEW PERSON file (#200) indicating the person to whose attention the forwarded consult should be directed. URGENCY Type: Input Value of the URGENCY from the PROTOCOL file (#101) .COMMENT Type: Input Array of comments that explains the reason the request was forwarded. DATETIME Type: Input The date/time the request was forwarded OUTPUT Type: Output Extrinsic function returns: ErrorFlag^ErrorMessage ErrorFlag is 0 if no error found or 1 if an errror occured. ErrorMessage is null for no error or descriptive of error if one occurred. Call to forward an existing consult to a different service. COMPONENT: $$RC(IEN,RECEIVER,DATETIME,.COMMENTS,ENTERER) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123) RECEIVER Type: Input Pointer to NEW PERSON file (#200) denoting person who received the consult request. DATETIME Type: Input Actual date/time the consult was received by the service COMMENTS Type: Input Array of comments entered for request ENTERER Type: Input IEN of NEW PERSON file (#200) indicating person who entered consult as being received. OUTPUT Type: Output Extrinsic function returns: ErrorFlag^ErrorMessage ErrorFlag is 0 if no error found or 1 if an errror occured. ErrorMessage is null for no error or descriptive of error if one occurred. Call to receive a consult into a service ******************** 2927 NAME: POINTERS TO IMAGE FILE (#2005) CUSTODIAL PACKAGE: IMAGING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES A many-to-many linkage between TIU Documents, stored in file 8925, and Images (stored in file #2005) is maintained by a pointer to the IMAGE FILE from the TIU EXTERNAL LINK FILE (#8925.91). USAGE: Controlled Subscri ENTERED: OCT 14,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2005 ROOT: MAG(2005, DESCRIPTION: TYPE: File To support many-to-many linkages between Images (stored in file #2005) and other patient-oriented data (e.g., Documents, Orders, Reports, etc.) the subscribing packages may retain POINTERS to file 2005. ^MAG(2005,D0,0) IEN Internal Entry Numbe Pointed to This is the Internal Entry number of the record in the IMAGE FILE. ROUTINE: ******************** 2928 NAME: Delete Read Protection on PDM Files CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: OCT 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DIC( DESCRIPTION: TYPE: File E3R PSN-4-12347 asked that the read protection on files related to and shared by National Drug File and Pharmacy Data Management be removed. To meet this request, PDM requests a one time agreement with VA Fileman to KILL the global nodes ^DIC(51.2,0,"RD") and ^DIC(50.606,0,"RD"). This this agreement is simular to and requested in conjunction with DBIA# 2910. ^DIC(51.2,0,'RD') ^DIC(50.606,0,'RD') ROUTINE: ******************** 2929 NAME: Health Summary/NDBI A7RHSM CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: HEALTH SUMMARY The Health Summary package makes calls into the National Database Integration routine A7RHSM. This routine is used to extract patient health data from the legacy site in an integrated system. Calls into NDBI routine A7RHSM from Health Summary are contingent on: 1) the presence of the routine A7RDUP 2) the presence of the global ^A7RCP converted pointers 3) the presence of the called extract/format routine A7RHSM If any one of these three conditions is not met, then Health Summary will not make the call to the legacy site data extraction routine A7RHSM. USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine National Database Integration routine A7RHSM contains entry points that extract patient data from the legacy site in an integrated system. ROUTINE: A7RHSM COMPONENT: BT VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display of Lab Blood Transfusion data from a legacy site (called by GMTSLRT). COMPONENT: CH VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Point to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Lab Chemistry and Hematology data from the legacy site (called by GMTSLRC). COMPONENT: CVP VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display MAS Past Clinic Visits from the legacy site (called by GMTSDA). COMPONENT: CY VARIABLES: DFN Type: Input Pointer to Patien File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Lab Cytopathology data from the legacy site (called by GMTSLRCP). COMPONENT: DSP(ADM) VARIABLES: ADM Type: Input Inverted Begin Date (same as GMTS1) GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components A7RHS() Type: Input Display Array Display selected admissions data from the legacy site (called by GMTSDGA and GMTSDGH). COMPONENT: LST(DFN,.A7RHS) VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components A7RHS() Type: Output Display Array Extract/list admissions data from the legacy site (called by GMTSDGA, GMTSDGH, GMTSLRM, and GMTSLRMB). COMPONENT: MIC2(IX) VARIABLES: DFN Type: Input Pointer to Patient File IX Type: Input Inverted Begin Date (same as GMTS1) A7RHS() Type: Input Display Array Extract/display Lab Microbiology data from the legacy site (called by GMTSLRM). COMPONENT: MIC3(IX) VARIABLES: DFN Type: Input Pointer to Patient File IX Type: Input Inverted Begin Date (same as GMTS1) A7RHS() Type: Input Display Array Extract/display Lab Microbiology (Brief) data from the legacy site (called by GMTSLRMB). COMPONENT: $$NAM(TYPE,COMP) VARIABLES: TYPE Type: Input Pointer to HS Type File 142 COMP Type: Input Pointer to HS Component File 142.1 Extract/display Component Subscript (Name.Abbr) from the legacy site (called by GMTSLRS, GMTSLRS7 and GMTSLRSC). COMPONENT: OPC VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display MAS Surgeries ICD Codes from the legacy site (called by GMTSDGP). COMPONENT: PRC VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display MAS Procedure ICD Codes from the legacy site (called by GMTSDGP). COMPONENT: $$PRTNAM(FLD,DFL) VARIABLES: FLD Type: Input Lab Test Name DFL Type: Input Default Name Extract/display Laboratory Test Print Name from the legacy site (called by GMTSLRS7 and GMTSLRSC). COMPONENT: SCL VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HSS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Lab Cumulative Selected data from the legacy site (called by GMTSLRS7). COMPONENT: SCLU VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Lab Cumulative Selected data from the legacy site (called by GMTSLRSC). COMPONENT: SLT VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Lab Tests Selected data from the legacy site (called by GMTSLRS). COMPONENT: SP VARIABLES: DFN Type: Input Pointer to Patient File GMTSEG() Type: Input Local Array of HS Components GMTSEGN Type: Input Pointer to Local Array of HS Components GMTS1 Type: Input Inverted Begin Date GMTS2 Type: Input Inverted End Date GMTSNDM Type: Input Occurrence Limit Extract/display Surgical Pathology data from the legacy site (called by GMTSLRA). COMPONENT: SW VARIABLES: DFN Type: Input Pointer to Patient File Extract/display Social Work data from the legacy site (called by GMTSSOWK). ******************** 2930 NAME: DBIA2930 CUSTODIAL PACKAGE: QUASAR SUBSCRIBING PACKAGE: DSS - DECISION SUPPORT SYSTEM EX USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 509850.5 ROOT: ACK(509850.5, DESCRIPTION: TYPE: File In order to obtain CPT Modifier data, DSS EXTRACTS must obtain a pointer value from file #509850.5, A&SP MODIFIER. ^ACK(509850.5,D0,0) .01 NAME 0;1 Direct Global Read & w The #.01 field is a pointer to the CPT MODIFIER file (#81.3). ROUTINE: ******************** 2931 NAME: Health Summary/NDBI A7RPSOHS CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: HEALTH SUMMARY The Health Summary package makes a call into three National Database Integration routine A7RPSOHS. This routine is used to extract patient health data (Rx) from the legacy site in an integrated system. Calls into NDBI routine A7RPSOHS from Health Summary are contingent on: 1) the presence of the routine A7RDUP 2) the presence of the global ^A7RCP converted pointers 3) the presence of the called extract/format routine A7RPSOHS If any one of these three conditions is not met, then Health Summary will not make the call to the legacy site data extraction routine A7RPSOHS. USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine National Database Integration routine A7RPSOHS contains an entry point that extracts patient data (Rx) from the legacy site in an integrated system. ROUTINE: A7RPSOHS COMPONENT: HS(DFN) VARIABLES: DFN Type: Input Pointer to Patient File Extract/display Out Patient Pharmacy data from the legacy site (called by GMTSPSO). ******************** 2932 NAME: Health Summary/NDBI A7RHSE CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary calls into routine A7RHSE for the purpose of retrieving the Laboratory Patient number (LRDFN) at the legacy site on an integrated system to extract laboratory data from the legacy site to be displayed with the primary site in a combined and integrated Health Summary. Calls into NDBI routine A7RHSE from Health Summary are contingent on: 1) the presence of the routine A7RDUP 2) the presence of the global ^A7RCP converted pointers 3) the presence of the called extract/format routine A7RHSE If any one of these three conditions is not met, then Health Summary will not make the call to the legacy site data extraction routine A7RHSE. USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine National Database Integration routine A7RHSE contains an entry point that extracts patient data from the legacy site in an integrated system. ROUTINE: A7RHSE COMPONENT: LRDFN(DFN) VARIABLES: DFN Type: Input Pointer to Patient File Get the Lab Patient pointer (LRDFN)from the legacy site (called by GMTSLRA, GMTSLRC, GMTSLRCP, GMTSLRM, GMTSLRMB, GMTSLRS, GMTSLRS7, and GMTSLRSC). ******************** 2933 NAME: DBIA2933 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Reading of this file is needed to produce a modality worklist from all active Radiology orders. A worklist can be provided by specific modality. Each radiology order request has a RAD/NUC MED PROCEDURE defined and each of these procedures may have one or more modality defined. It is possible for a procedure to be performed on more than one modality (radiology equipment). In addition, we are requesting permission to read the "B" cross reference to match the modality code sent by a query during the testing of the worklist. The query is performed using the modality defined term, i.e., XA, DR, etc. Imaging is requesting direct reads to these global. Our experience in processing large volume of images (example: a CT request can be 500+ images and an image is processes in less than a second) is that using direct reads gives us a better system response time than a FM read. USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 73.1 ROOT: RAMIS(73.1 DESCRIPTION: TYPE: File Imaging requires to read the RAD MODALITY DEFINED TERMS file to build a Modality worklist for a commercial PACS system, commercial gateway or radiology modality. ^RAMIS(73.1,DA,0 .01 MODALITY ABBREVIATIO 0;1 Direct Global Read & w Contains the abbreviation of the modality (CT, CR, MRI, etc.). 1 MODALITY NAME 0;2 Direct Global Read & w Contains the full name of the modality. Global node contains the name of modality defined term as well as the abbreviation for the modality as defined in the DICOM Standards PS 3.3 - 1998 under section General Series Attribute Descriptions (C.7.3.1.1). ^RAMIS(73.1,'B' Cross reference on the modality defined term. ROUTINE: ******************** 2934 NAME: Health Summary/NDBI Global CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: HEALTH SUMMARY The Health Summary package references a National Database Integration global A7RHS(). Global A7RHS is used to store legacy site patient health care data. References to the NDBI global from Health Summary are contingent on: 1) the presence of the routine A7RDUP 2) the presence of the global ^A7RCP converted pointers 3) the presence of the called extract/format routine A7RHSM If any one of these three conditions is not met, then Health Summary will not reference global ^A7RHS for retrieval of the legacy site's patient data. USAGE: Private ENTERED: OCT 22,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: A7RHS DESCRIPTION: TYPE: File The National Database Integration software contains globals that store patient data from the legacy site in an integrated system. ^A7RHS('SP',DFN) Contains the Surgical Pathology data for the legacy site for patient DFN (Pointer to the Patient File). ^A7RHS('CH',DFN) Contains the Chemistry and Hematology data for the legacy site for patient DFN (Pointer to the Patient File). ^A7RHS('CY',DFN) Contains the Cytopathology data for the legacy site for patient DFN (Pointer to the Patient File). ^A7RHS('MIC',DFN) Contains the Microbiology data for the legacy site for patient DFN (Pointer to the Patient File). ^A7RHS('BMIC',DFN) Contains the Microbiology (Brief) data for the legacy site for patient DFN (Pointer to the Patient File). ^A7RHS('SUB',DFN) Contains the Selected Laboratory data for the legacy site for patient DFN (Pointer to the Patient File). ROUTINE: ******************** 2935 NAME: DRUG TEXT file CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: FEB 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 51.7 ROOT: PS(51.7, DESCRIPTION: TYPE: File National Drug File (NDF) requests permission to do direct global reads on the Pharmacy Data Management's DRUG TEXT file (#51.7). This file stores rapidly changing drug restrictions, guidelines, and protocols to help assure medications are being used according to formulary specifications. ^PS(51.7,D0,0) .01 NAME 0;1 Direct Global Read & w 2 INACTIVATION DATE 0;2 Direct Global Read & w ^PS(51.7,D0,1,D1,0) .01 SYNONYM 0;1 Direct Global Read & w ^PS(51.7,D0,2,D1,0) .01 TEXT 0;1 Direct Global Read & w ROUTINE: ******************** 2936 NAME: GMTS/SCTM Team CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: OCT 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.51 ROOT: SCTM(404.51, DESCRIPTION: TYPE: File Health Summary extracts references the following data from the TEAM file (#404.51). The Demographic component of Health Summary prints the Team Name and and Team Phone Number of the Primary Care Team. ^SCTM(404.51,D0,0) .01 NAME 0;1 Read w/Fileman .02 TEAM PHONE NUMBER 0;2 Read w/Fileman ROUTINE: ******************** 2937 NAME: OE/RR references to TIU DOCUMENT file CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT CLINICAL REMINDERS IMAGING ADDED 11/10/2010 USAGE: Controlled Subscri ENTERED: OCT 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925, DESCRIPTION: TYPE: File This DBIA documents references from OR* routines to the TIU DOCUMENT file (#8925). ^TIU(8925, .01 DOCUMENT TYPE 0;1 Direct Global Read & w .02 PATIENT 0;2 Direct Global Read & w .03 VISIT 0;3 Direct Global Read & w .05 STATUS 0;5 Direct Global Read & w .06 PARENT 0;6 Direct Global Read & w .07 EPISODE BEGIN DATE/T 0;7 Direct Global Read & w .11 CREDIT STOP CODE ON 0;11 Direct Global Read & w .13 VISIT TYPE 0;13 Direct Global Read & w 1202 AUTHOR/DICTATOR 12;2 Direct Global Read & w 1204 EXPECTED SIGNER 12;4 Direct Global Read & w 1208 EXPECTED COSIGNER 12;8 Direct Global Read & w 1211 VISIT LOCATION 12;11 Direct Global Read & w 1506 COSIGNER NEEDED 15;6 Direct Global Read & w 1201 ENTRY DATE/TIME 12;1 Direct Global Read & w 1301 REFERENCE DATE 13;1 Direct Global Read & w ^TIU(8925,'AAU', ^TIU(8925,'ASUP', ^TIU(8925,'APT', ^TIU(8925,'ACLPT', ROUTINE: ******************** 2938 NAME: OE/RR calls to GMRCGUIC CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Private ENTERED: OCT 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls from OE/RR to routine GMRCGUIC. ROUTINE: GMRCGUIC COMPONENT: FILE(IEN,GLOBAL) VARIABLES: IEN Type: Input The IEN of the entry in the REQUEST/CONSULTATION file (#123). GLOBAL Type: Input The TMP global location where the subscripted data exists for storage back into file 123 after edit. Files changes made in CPRS GUI into consults files. COMPONENT: SEND(IEN,GLOBAL) VARIABLES: IEN Type: Input The IEN of the entry in the REQUEST/CONSULTATION file (#123). GLOBAL Type: Input The TMP global location where the subscripted data will be stored. Sends data in a subscripted TMP global to calling application for further editing by the application (in this case CPRS GUI). ******************** 2939 NAME: OE/RR direct views of DIC(49 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 28,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49, DESCRIPTION: TYPE: File This DBIA documents direct global references made by OE/RR to the SERVICE/SECTION file (#49). These references are mainly used by CPRS GUI to retrieve and display a list of selectable entries from file 49. ^DIC(49,DA,0) .01 NAME 0;1 Direct Global Read & w 1.7 TYPE OF SERVICE 0;9 Direct Global Read & w ^DIC(49,'B' Used by CPRS GUI to loop through available entries and ensure that the TYPE OF SERVICE is PATIENT CARE. The entries are then presented to the user in the graphical interface. ROUTINE: ******************** 2941 NAME: DBIA2941 CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK REGISTRATION USAGE: Controlled Subscri ENTERED: OCT 28,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CIRN PD uses this call to allow users to do a Display Only Query to the MPI through the CIRN Exception Handling option. ROUTINE: MPIFSAQ COMPONENT: VTQ VARIABLES: .MPIVAR Type: Input The MPIVAR array consists of the following demographic data: MPIVAR("DFN") - DFN - IEN of Patient file (#2) MPIVAR("SSN") - Social Security Number (.09) field of Patient file (#2) MPIVAR("DOB") - Date of Birth (.03) field of Patient file (#2) MPIVAR("NM") - Name (.01) field of Patient file (#2) ******************** 2942 NAME: DBIA2942 CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: OCT 28,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CIRN PD uses this call to allow users to do a Single Patient Initialization to the MPI from the CIRN Exception Handling option. ROUTINE: MPIFQ0 COMPONENT: CIRNEXC VARIABLES: DFN Type: Used IEN of patient in Patient File (#2) This entry point assumes the DFN is known and does not prompt the user for Patient Name. ******************** 2944 NAME: Calls to TIUSRVR1 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING IMAGING CONSULT/REQUEST TRACKING SURGERY CLINICAL PROCEDURES CARE MANAGEMENT VA CERTIFIED COMPONENTS - DSSI LAB SERVICE added 10/21/2008 MENTAL HEALTH ADDED 7/25/07 NATIONAL HEALTH INFO NETWORK VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: OCT 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to TIUSRVR1. ROUTINE: TIUSRVR1 COMPONENT: TGET(.GLOBAL,IEN,ACTION) VARIABLES: GLOBAL Type: Both The global location of the returned data (^TMP("TIUVIEW",$J)) is returned in this variable which is passed by reference. ^TMP("TIUVIEW",$J) may be killed before and after use. IEN Type: Input The IEN of the record from the TIU DOCUMENT file. ACTION Type: Input This optional String type parameter identifies the action (e.g., PRINT, or VIEW) that the user is attempting to execute (DEFAULT: VIEW). This API returns the textual portion of a TIU document Record. It's also callable via RPC TIU GET RECORD TEXT. ******************** 2945 NAME: Use of calls in PSIVSP CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING OE/RR calls ORINF USAGE: Controlled Subscri ENTERED: OCT 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to PSIVSP. ROUTINE: PSIVSP COMPONENT: ORINF VARIABLES: X Type: Both X is passed in as the value to be passed through the input transform. If X is returned, it is a valid infusion rate. If X is not returned, the input was rejected. This entry point acts as an input transform for infusion rate. ******************** 2946 NAME: Calls to PSSGSGUI CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR Access to EN^PSSGSGUI for VIAB DFLTSPLY RPC and OrderMgmtSvc - isDrugScheduleValid service USAGE: Controlled Subscri ENTERED: OCT 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call provides a Schedule validation check for medication orders entered through Computerized Patient Record System (CPRS). ROUTINE: PSSGSGUI COMPONENT: EN(X,PSSGUIPK) VARIABLES: X Type: Input This variable is passed by reference. It is the Schedule entered for the medication order. PSSGUIPK Type: Input This variable is the pharmacy package for which the order is being entered. "O" will be for Outpatient orders, "I" will be for Inpatient orders. X Type: Output If the Schedule passed the validation checks, the value will be the Schedule, as it was passed in. If the Schedule did not pass the validation checks, this variable will be undefined. This call is used by CPRS GUI to validate a Schedule that is entered for a medication order. This call is non-interactive (silent). ******************** 2947 NAME: Calls to LR7OGO CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Routine ORWLRR makes calls to the following linetags in LR7OGO: ALLTESTS ATESTS ATG ATOMICS CHEMTEST PARAM SPEC TG USERS UTGA UTGD UTGR The matching linetags in ORWLRR are called by RPCs for use in CPRS GUI. CLINICAL CASE REGISTRIES USAGE: Controlled Subscri ENTERED: OCT 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine LR7OGO. ROUTINE: ORWLRR COMPONENT: ALLTESTS(.ARRAY,FROM,DIRECTION) VARIABLES: ARRAY Type: Both Passed in as the name of an array and returned with the lab test names. FROM Type: Input Starting point for loop through LABORATORY TEST file by name. DIRECTION Type: Input -1 for reverse order or "" for forward order Returns 45 test names beginning with the value FROM in either forward or reverse alphabetical order. COMPONENT: ATESTS(.ARRAY,IEN) VARIABLES: ARRAY Type: Both Input as name of array and receives array of panels for test specified. IEN Type: Input IEN of the LABORATORY TEST file (#60). Returns an array of lab tests included in a panel. COMPONENT: ATG(.ARRAY,TESTGROUP,USER) VARIABLES: USER Type: Input Pointer to NEW PERSON file (#200). TESTGROUP Type: Input Value of LAB TEST GROUP field from LAB SECTION PRINT file (69.2) Returns an array of chemistry tests in a group for a particular user. COMPONENT: ATOMICS(.ARRAY,FROM,DIR) VARIABLES: ARRAY Type: Both see description for ALLTESTS FROM Type: Input see description in ALLTESTS DIR Type: Input See description in ALLTESTS Returns an array of atomic lab tests (tests without panels). COMPONENT: CHEMTEST(.ARRAY,FROM,DIR) VARIABLES: ARRAY Type: Both See description under ALLTESTS. FROM Type: Input See description under ALLTESTS. DIR Type: Input See description under ALLTESTS. Returns an array of test names from the CHEM, HEM, TOX, SER, RIA, ETC. areas of lab. COMPONENT: PARAM(.VALUE) VARIABLES: VALUE Type: Output 1 node from LABORATORY SITE file currently defined as: ^LAB(69.9,D0,1)= (#100) DEFAULT BLOOD SPECIMEN [1P] ^ (#101) DEFAULT URINE SPECIMEN [2P] ^ (#102) DEFAULT SERUM SPECIMEN [3P] ^ ==>(#103) DEFAULT PLASMA SPECIMEN [4P] ^ (#104) DEFAULT UNKNOWN SPECIMEN [5P] ^ ^ (#210) DOWNLOAD FULL DATA [7S] ^ ==>(#530) STANDARD LOCATIONS ONLY [8S] ^ (#18) *GRACE PERIOD FOR STATISTICS [9N] ^ (#203) MICRO DEFAULT TEMPLATE ==>[10F] ^ (#204) MICRO OTHER TEMPLATE [11F] ^ Returns the Laboratory Site parameters found in the LABORATORY SITE (#69.9) file at the global location ^LAB(69.9,1,1). COMPONENT: SPEC(.ARRAY,FROM,DIR) VARIABLES: ARRAY Type: Both Passed in as the name of the array to receive data. Data returned as ARRAY(COUNTER)=IEN^NAME FROM Type: Input Starting name for search. A maximum of 45 entries are returned at a time. DIR Type: Input See ALLTESTS for description of this variable. Returns an array of lab specimens from the TOPOGRAPHY FIELD (#61) file in the format IEN^NAME. COMPONENT: TG(.ARRAY,USER) VARIABLES: ARRAY Type: Both See description under ALLTESTS USER Type: Input IEN of NEW PERSON file (#200) Returns a list of chemistry test groups associated with a user with the print names (or name if print name is not available) of the lab tests in the panel separated by commas. So, output would look like: ARRAY(COUNT)=TESTGROUP IEN^TESTGROUP) PRINT NAME, PRINT NAME Or actual example: ARRAY(1)=1^1) WBC, RBC, HCT, HB, PLT COMPONENT: USERS(.ARRAY,FROM,DIR) VARIABLES: ARRAY Type: Both See description under ALLTESTS FROM Type: Input Name of NEW PERSON from which to begin search. DIR Type: Input See description under ALLTESTS Loops through the NEW PERSON file an returns up to 18 users that have chemistry LAB TEST GROUPS defined. Format ARRAY(COUNT)=IEN^USERNAME Where IEN is the IEN of the USER REQUEST LIST multiple in the LAB SECTION PRINT file (#69.2). COMPONENT: UTGA(.Y,TESTS) VARIABLES: Y Type: Input Placeholder for RPC usage TESTS Type: Input Array of data to be filed in USER REQUEST LIST multiple Places entries in the USER REQUEST LIST multiple of the LAB SECTION PRINT file (#69.2). COMPONENT: UTGD(.Y,TESTGROUP) VARIABLES: Y Type: Input Placeholder for RPC usage TESTGROUP Type: Input IEN of LAB TEST GROUP multiple of LAB SECTION PRINT file (#69.2) Deletes data from the USER REQUEST LIST multiple for a specified TEST GROUP. COMPONENT: UTGR(.Y,TESTS,TESTGROUP) VARIABLES: TESTS Type: Input Array of tests to be entered into TESTS subfield of LAB TEST GROUP multiple. TESTGROUP Type: Input IEN of TEST GROUP multiple for which TEST entries will be replaced. Updates TEST multiple under LAB TEST GROUP multiple in file 69.2. ******************** 2950 NAME: DBIA2950 CUSTODIAL PACKAGE: LEXICON UTILITY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Supported ENTERED: APR 16,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point is silent and intended to support Graphical User Interface (GUI) development. The lookup returns an array of information on the expressions found. The lookup includes reordering the selection list with the most frequently used at the top, and places any exact match at the top of the list. ROUTINE: LEXA COMPONENT: LOOK(LEXX,LEXAP,LEXLL,LEXSUB,DATE) VARIABLES: LEXX Type: Input Equivalent to Fileman's variable X and contains the text to search for. LEXAP Type: Input This is the aplication identification and may be in the form of a name, namespace, or a pointer (Internal Entry Number - IEN) from an application definition in the Subset Definition file (#757.2). The default value for this parameter, if it is not supplied, is the one (1), pointing to the Lexicon application definition. Included in this application definition are a number of applications defaults which assist in searching the Lexicon. Application defaults included the global root, index, filter, display format, vocabulary, shortcuts, user default flag, overwrite user default flag, and the unresolved narrative flag. These are described in the Special Variable section of the Lexicon Utility V. 2.0 Technical Manual. At this time, there are six (6) application definitions. Name Namspace IEN ---- -------- -- - Lexicon LEX 1 Problem List GMPL 4 ICD Diagnosis ICD 12 CPT Procedures CPT 13 Mental Health DSM 14 ICD, CPT, and DSM Terminology VAC 15 To conduct a search of the Lexicon using the application defaults for the Problem List, you may pass this parameter as: Name "PROBLEM LIST" - This form is not case sensitive, and can be found either the "B" or "C" index of file 757.2. Namespace "GMPL" - Namespace - This form is not case sensitive, and can be found in the "AN" index of file 757.2. Pointer 4 - This form is numeric, and is an Internal Entry Number (IEN) of file 757.2. LEXLL Type: Input This is a numeric value which controls the returning list length in the local array LEX("LIST"). The default value for this parameter when not supplied is five (5). LEXSUB Type: Input This parameter represent the vocabulary subset to use during the search. These subsets are defined in the Subset Definition file (#757.2). This parameter may be in one of three forms. To use the "Nursing" subset you may pass the parameter as: Name "NURSING" - This form is not case sensitive and may be found in either the "B" or "C" index of file 757.2. Mnemonic "NUR" - This form is not case sensitive and the mnemonic may be found in either the "AA" or "AB" index of file 757.2. Pointer 2 - This form is numeric, and is an Internal Entry Number (IEN) of file 757.2. TMP Type: Output ^TMP("LEXFND",$J,,) This global array contains all of the entries found during the search. The is a negative number based on the frequency of use for a given term. is the internal entry number in the Lexicon Expression file (757.01). ^TMP("LEXHIT",$J,) This global array contains the entries reviewed by the user. The Lexicon Utility reorders the list based on frequency of use and assigns a sequence number representing where on the list this entry is located. LEX Type: Output LEX("LIST") This local array contains only those entries on the list which are currently being reviewed by the user. The third parameter to the look-up defines the length of this list. DATE Type: Input This is a date in Fileman format used to check if a code is active or inactive on a specified date. If not supplied, it will default to TODAY. Only active codes can be displayed and returned during a lookup. ******************** 2951 NAME: LR7OSBR CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: NOV 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to LR7OSBR to retrieve the formatted text of a Blood Bank report for a patient. ROUTINE: LR7OSBR COMPONENT: EN1(DFN) VARIABLES: DFN Type: Input Pointer to Patient file #2 TMP('LRC' Type: Output ^TMP("LRC",$J,#,0)=line of report text Returns formatted text of a Blood Bank report. ******************** 2952 NAME: LR7OSMZ0 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: NOV 1,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to LR7OSMZ0 to retrieve the formatted text of a Microbiology report for a patient. ROUTINE: LR7OSMZ0 COMPONENT: EN(DFN) VARIABLES: DFN Type: Input Pointer to Patient file #2 TMP('LRC' Type: Output ^TMP("LRC",$J,#,0)=line of report text Returns formatted text of a Microbiology report. ******************** 2953 NAME: STATUS OF PATIENT IN THE OUTPATIENT ENCOUNTER FILE CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK REGISTRATION USAGE: Controlled Subscri ENTERED: NOV 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 409.68 ROOT: SCE( DESCRIPTION: TYPE: File This database integration agreement (DBIA) is needed to track a particular status of a patient in the OUTPATIENT ENCOUNTER (#409.68) file. The input variable is the DFN of the patient, so our application needs to roll down the 'ADFN' M cross-reference (Patient field) in file 409.68. Our application intends to read, with FileMan, the STATUS (field .12) of the patient in the OUTPATIENT ENCOUNTER (#409.68) file. We are looking for a private subscription that would allow our application to walk down the 'ADFN' cross-reference and then read, with FileMan, the STATUS field in the OUTPATIENT ENCOUNTER file. ^SCE('ADFN', .02 PATIENT 0;2 Direct Global Read & w This field is named Patient and points to the PATIENT (#2) file. This DBIA is concerned with traversing the 'ADFN' M cross-reference to find an OUTPATIENT ENCOUNTER record with a status of CHECKED OUT. ROUTINE: ******************** 2954 NAME: Calls to LR7OGG CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 4,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine LR7OGG ROUTINE: LR7OGG COMPONENT: GRID(.ROOT,DFN,END,START,SPECTYPE,.TESTS) VARIABLES: .ROOT Type: Output Returns root of output data. DFN Type: Input IEN of PATIENT file START Type: Input Start date END Type: Input End date SPECTYPE Type: Input Specimen type to be returned .TESTS Type: Input Array of tests to be on grid display ~TMP("LR7O Type: Output Array may be killed prior to GRID call as well as after. ~TMP("LR7O Type: Output Array may be killed prior to GRID call as well as after. Returns data for display of labs on grid controls within CPRS lab tab. Data returned: ^TMP("LR7OGX",$J,"INPUT",1)=DFN^END DATE^START DATE^SPECTYPE ,2-n)=lab test number ^TMP("LR7OGX",$J,"OUTPUT",n)=TestSequence^TestNumber^TestName^ PrintCode followed by specifics of tests such as comments or indications ******************** 2955 NAME: Calls to LR7OU1 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: NOV 3,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine LR7OU1 ROUTINE: LR7OU1 COMPONENT: $$COL(PKGREF,IEN) VARIABLES: PKGREF Type: Input Value as stored in the PACKAGE REFERENCE field in the ORDER file (#100). IEN Type: Input Optional: IEN of ORDER file (#100) OUTPUT Type: Output Extrinsic function returns NAME (#.01)_(space)_TUBE TOP COLOR (#3) fields from COLLECTION SAMPLE file (#62). Returns collection sample with tube type for print fields. COMPONENT: $$LU(PKGREF,IEN) VARIABLES: PKGREF Type: Input Value as stored in the PACKAGE REFERENCE field in the ORDER file (#100). IEN Type: Input Optional: IEN of ORDER file (#100) OUTPUT Type: Output Extrinsic function returns external value of URGENCY file (#62.05). Extrinsic function returns urgency for print fields. COMPONENT: EXPAND(TEST,ARRAY) VARIABLES: TEST Type: Input IEN of panel in LAB TEST file (#60) ARRAY Type: Both Array passed by reference, that returns the IEN of LAB TEST file (#60) for each atomic test as a list subscript, i.e. ARRAY(IEN)="" Expand a lab panel into its atomic tests ******************** 2956 NAME: Calls to LR7OGC CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 3,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine LR7OGC. ROUTINE: LR7OGC COMPONENT: CHART(.ARRAY,DFN,END,START,SPECTYPE,TESTNUM) VARIABLES: .ARRAY Type: Both Passed by reference to receive output array location. DFN Type: Input IEN of PATIENT file (#2) START Type: Input Start date/time for search. END Type: Input End date/time for search. SPECTYPE Type: Input Optional: if a particular speciment type is desired, it is passed in. Otherwise all specimen types are returned. TESTNUM Type: Input IEN of LABORATORY TEST file. ~TMP("LR7O Type: Output Array may be killed prior to CHART call as well as after. ~TMP("LR7O Type: Output Array may be killed prior to CHART call as well as after. Returns ^TMP("LR7OGX",$J,"OUTPUT",counter) Data varies as top of the array contains DATE/TIME SPECIMEN TAKEN^RESULT Later, external format of the date/time is shown along with comments, interpretations, or other notes. Here are some examples of what might appear: ^TMP("LR7OGX",539019167,"OUTPUT",1) = 44^SERUM^123^60^mg/dL ^TMP("LR7OGX",539019167,"OUTPUT",2) = 2991026.150931^500 ^TMP("LR7OGX",539019167,"OUTPUT",3) = 2990914.07205^105 ^TMP("LR7OGX",539019167,"OUTPUT",4) = 2990914.071727^85 ^TMP("LR7OGX",539019167,"OUTPUT",5) = 2990914.071648^65 ^TMP("LR7OGX",539019167,"OUTPUT",6) = 2990914.071522^45 ^TMP("LR7OGX",539019167,"OUTPUT",7) = 2990907.074908^325 ^TMP("LR7OGX",539019167,"OUTPUT",8) = 2990907.074728^345 ^TMP("LR7OGX",539019167,"OUTPUT",9) = 2990824.154928^302 ^TMP("LR7OGX",539019167,"OUTPUT",10) = 2990824.154643^301 ^TMP("LR7OGX",539019167,"OUTPUT",11) = 2990729.112056^329 ^TMP("LR7OGX",539019167,"OUTPUT",12) = 2990729.110217^325 ^TMP("LR7OGX",539019167,"OUTPUT",13) = 2990729.110003^300 ^TMP("LR7OGX",539019167,"OUTPUT",14) = 2990525.105108^123 ^TMP("LR7OGX",539019167,"OUTPUT",15) = 2990525.10134^234 ^TMP("LR7OGX",539019167,"OUTPUT",16) = 2990525.091542^156 ^TMP("LR7OGX",539019167,"OUTPUT",17) = 2990111.143859^98 ^TMP("LR7OGX",539019167,"OUTPUT",18) = 2990111.143854^443 ^TMP("LR7OGX",539019167,"OUTPUT",19) = 2990111.143851^89 ^TMP("LR7OGX",539019167,"OUTPUT",20) = 2990111.143846^143 ^TMP("LR7OGX",539019167,"OUTPUT",21) = 2990111.143841^153 ^TMP("LR7OGX",539019167,"OUTPUT",22) = 2990111.143837^62 ^TMP("LR7OGX",539019167,"OUTPUT",23) = 2990111.143832^155 ^TMP("LR7OGX",539019167,"OUTPUT",24) = 2990111.143829^15 ^TMP("LR7OGX",539019167,"OUTPUT",25) = 2990111.143824^90 ^TMP("LR7OGX",539019167,"OUTPUT",26) = 2990111.14382^66 ^TMP("LR7OGX",539019167,"OUTPUT",27) = 2990111.143816^166 ^TMP("LR7OGX",539019167,"OUTPUT",28) = 2990111.143809^431 ^TMP("LR7OGX",539019167,"OUTPUT",29) = 2990111.143805^312 ^TMP("LR7OGX",539019167,"OUTPUT",30) = 2990111.1438^98 ^TMP("LR7OGX",539019167,"OUTPUT",31) = 2990111.143756^234 ^TMP("LR7OGX",539019167,"OUTPUT",32) = 2990111.143751^170 ^TMP("LR7OGX",539019167,"OUTPUT",33) = 2990111.143747^55 ^TMP("LR7OGX",539019167,"OUTPUT",34) = 2990111.143742^155 ^TMP("LR7OGX",539019167,"OUTPUT",35) = 2990111.143737^144 ^TMP("LR7OGX",539019167,"OUTPUT",36) = 2990111.143732^980 ^TMP("LR7OGX",539019167,"OUTPUT",37) = 2990111.143725^89 ^TMP("LR7OGX",539019167,"OUTPUT",38) = 2990111.143719^52 ^TMP("LR7OGX",539019167,"OUTPUT",39) = 2990111.143708^87 ^TMP("LR7OGX",539019167,"OUTPUT",40) = 2990111.143701^133 ^TMP("LR7OGX",539019167,"OUTPUT",41) = 2990111.143653^156 ^TMP("LR7OGX",539019167,"OUTPUT",42) = 2990111.143644^99 ^TMP("LR7OGX",539019167,"OUTPUT",43) = 2990111.143628^153 ^TMP("LR7OGX",539019167,"OUTPUT",44) = 2990111.14362^155 ^TMP("LR7OGX",539019167,"OUTPUT",45) = 2990111.143559^133 ^TMP("LR7OGX",539019167,"OUTPUT",46) = ^TMP("LR7OGX",539019167,"OUTPUT",47) = Sep 07, 1999@07:49 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",48) = This specimen was not drawn from above th e IV site. ^TMP("LR7OGX",539019167,"OUTPUT",49) = ^TMP("LR7OGX",539019167,"OUTPUT",50) = Sep 07, 1999@07:47 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",51) = ~For Test: GLUCOSE ^TMP("LR7OGX",539019167,"OUTPUT",52) = ~NO ORDER COMMENT AT THIS TIME ^TMP("LR7OGX",539019167,"OUTPUT",53) = TESTING COMMENTS ON THE GUI LAB TAB ^TMP("LR7OGX",539019167,"OUTPUT",54) = ^TMP("LR7OGX",539019167,"OUTPUT",55) = May 25, 1999@10:52 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",56) = ^TMP("LR7OGX",539019167,"OUTPUT",57) = May 25, 1999@10:15 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",58) = ^TMP("LR7OGX",539019167,"OUTPUT",59) = May 25, 1999@10:11 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",60) = ^TMP("LR7OGX",539019167,"OUTPUT",61) = May 24, 1999@11:37 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",62) = ^TMP("LR7OGX",539019167,"OUTPUT",63) = May 24, 1999@11:32 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",64) = ^TMP("LR7OGX",539019167,"OUTPUT",65) = May 21, 1999@09:45 -- result 'canc' could not be graphed. ^TMP("LR7OGX",539019167,"OUTPUT",66) = ^TMP("LR7OGX",539019167,"OUTPUT",67) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",68) = 1507 ^TMP("LR7OGX",539019167,"OUTPUT",69) = ^TMP("LR7OGX",539019167,"OUTPUT",70) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",71) = PATETS ^TMP("LR7OGX",539019167,"OUTPUT",72) = ^TMP("LR7OGX",539019167,"OUTPUT",73) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",74) = 134 ^TMP("LR7OGX",539019167,"OUTPUT",75) = ^TMP("LR7OGX",539019167,"OUTPUT",76) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",77) = 09878312 ^TMP("LR7OGX",539019167,"OUTPUT",78) = ^TMP("LR7OGX",539019167,"OUTPUT",79) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",80) = ASDPTW ^TMP("LR7OGX",539019167,"OUTPUT",81) = ^TMP("LR7OGX",539019167,"OUTPUT",82) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",83) = 134 ^TMP("LR7OGX",539019167,"OUTPUT",84) = ^TMP("LR7OGX",539019167,"OUTPUT",85) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",86) = ABOUT HTERE ^TMP("LR7OGX",539019167,"OUTPUT",87) = ^TMP("LR7OGX",539019167,"OUTPUT",88) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",89) = VLOW ^TMP("LR7OGX",539019167,"OUTPUT",90) = ^TMP("LR7OGX",539019167,"OUTPUT",91) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",92) = BET ^TMP("LR7OGX",539019167,"OUTPUT",93) = ^TMP("LR7OGX",539019167,"OUTPUT",94) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",95) = LO ^TMP("LR7OGX",539019167,"OUTPUT",96) = ^TMP("LR7OGX",539019167,"OUTPUT",97) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",98) = PATPE ^TMP("LR7OGX",539019167,"OUTPUT",99) = ^TMP("LR7OGX",539019167,"OUTPUT",100) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",101) = HILT EI TAT ^TMP("LR7OGX",539019167,"OUTPUT",102) = ^TMP("LR7OGX",539019167,"OUTPUT",103) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",104) = ADSFGAHQRET ^TMP("LR7OGX",539019167,"OUTPUT",105) = ^TMP("LR7OGX",539019167,"OUTPUT",106) = Jan 11, 1999@14:38 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",107) = MAUT ^TMP("LR7OGX",539019167,"OUTPUT",108) = ^TMP("LR7OGX",539019167,"OUTPUT",109) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",110) = ASDFREQ ^TMP("LR7OGX",539019167,"OUTPUT",111) = ^TMP("LR7OGX",539019167,"OUTPUT",112) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",113) = APOET ^TMP("LR7OGX",539019167,"OUTPUT",114) = ^TMP("LR7OGX",539019167,"OUTPUT",115) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",116) = ADSF ^TMP("LR7OGX",539019167,"OUTPUT",117) = ^TMP("LR7OGX",539019167,"OUTPUT",118) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",119) = 14 ^TMP("LR7OGX",539019167,"OUTPUT",120) = ^TMP("LR7OGX",539019167,"OUTPUT",121) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",122) = RECA ^TMP("LR7OGX",539019167,"OUTPUT",123) = ^TMP("LR7OGX",539019167,"OUTPUT",124) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",125) = HIGH ^TMP("LR7OGX",539019167,"OUTPUT",126) = ^TMP("LR7OGX",539019167,"OUTPUT",127) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",128) = 3414 ^TMP("LR7OGX",539019167,"OUTPUT",129) = ^TMP("LR7OGX",539019167,"OUTPUT",130) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",131) = 341 ^TMP("LR7OGX",539019167,"OUTPUT",132) = ^TMP("LR7OGX",539019167,"OUTPUT",133) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",134) = POT ^TMP("LR7OGX",539019167,"OUTPUT",135) = ^TMP("LR7OGX",539019167,"OUTPUT",136) = Jan 11, 1999@14:37 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",137) = 6579 ^TMP("LR7OGX",539019167,"OUTPUT",138) = ^TMP("LR7OGX",539019167,"OUTPUT",139) = Jan 11, 1999@14:36 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",140) = 125 ^TMP("LR7OGX",539019167,"OUTPUT",141) = ^TMP("LR7OGX",539019167,"OUTPUT",142) = Jan 11, 1999@14:36 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",143) = 90451 ^TMP("LR7OGX",539019167,"OUTPUT",144) = ^TMP("LR7OGX",539019167,"OUTPUT",145) = Jan 11, 1999@14:36 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",146) = RPAG ^TMP("LR7OGX",539019167,"OUTPUT",147) = ^TMP("LR7OGX",539019167,"OUTPUT",148) = Jan 11, 1999@14:36 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",149) = ASDF ^TMP("LR7OGX",539019167,"OUTPUT",150) = ^TMP("LR7OGX",539019167,"OUTPUT",151) = Jan 11, 1999@14:35 ** Comments: ^TMP("LR7OGX",539019167,"OUTPUT",152) = 134234 ^TMP("LR7OGX",539019167,"OUTPUT",153) = ******************** 2957 NAME: DBIA2957 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows the OE/RR package to call CLNLIST^GMRCTU in order to remove pointers in the CONSULTS package for terminated users. The calling routine is ORLPTU, which is triggered by a Kernel event when a user is terminated. ROUTINE: GMRCTU COMPONENT: CLNLIST VARIABLES: ORLTEAM Type: Input Inasmuch as the pointers being removed relate to Team List entries which might exist in file 123.5, the variable ORLTEAM specifies the IEN of the team to be processed. The CLNLIST tag utilizes code to remove pointers for terminated users in the file 123.5. The pointers are to file 100.21, the Team List file. ******************** 2958 NAME: Calls to LR7OGM CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING MYHEALTHEVET VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: NOV 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine LR7OGM. ^TMP("LR7OG",$J) and ^TMP("LR7OGX",$J) may be killed before and after any component call. ROUTINE: LR7OGM COMPONENT: INTERIM(.ROOT,DFN,END,START) VARIABLES: ROOT Type: Output Global root in which data is returned. This variable will be set to ^TMP("LR7OGX",$J,"OUTPUT") DFN Type: Input Internal entry number of the PATIENT file START Type: Input Start date range END Type: Input Ending date range Returns data for interim report to be displayed in CPRS GUI. The following shows the output beginning with teh line counter and closing paren. The root is TMP("LR7OGX",$J,"OUTPUT",COUNTER): (NOTE: global root was left off display to have it display appropriately) ---- MICROBIOLOGY ---- Accession: MICRO 99 6 Received: Oct 28, 1999 13:03 Collection sample: SPUTUM Collection date: Oct 28, 1999 13:03 Provider: ANDERSON,CURTIS Test(s) ordered: GRAM STAIN CULTURE & SUSCEPTIBILITY AFB SMEAR ============================================================== ============ Provider : ANDERSON,CURTIS Specimen: SERUM. CH 1026 1 10/26/1999 15:09 Test name Result units Ref. range GLUCOSE 500 H* mg/dL 60 - 123 PROTEIN,TOTAL 110 H g/dL 6.2 - 7.7 ============================================================== ============ COMPONENT: INTERIMG(.ROOT,DFN,END,DIRECTION,FORMAT) VARIABLES: ROOT Type: Output Root of output data (set to ^TMP("LR7OGX",$J,"OUTPUT")) DFN Type: Input IEN of the PATIENT file (#2) Returns interim report for CPRS GUI display. Allows more paratemeters for the direction (forward/reverse) of the date range and the format of the report. Ouptut is in TMP("LR7OGX",$J,"OUTPUT") as described in INTERIM call within this DBIA. COMPONENT: END VARIABLES: DIRECTION Type: Input Direction for search (1 goes forward, -1 goes in reverse) FORMAT Type: Input OPTIONAL (default=1) 1 - standard format (as INTERIM returns) 2 - returns micro labs 3 - returns chemistry labs only End date for search COMPONENT: INTERIMS(.ROOT,DFN,END,START,.TESTS) VARIABLES: ROOT Type: Output Root of output data (set to ^TMP("LR7OGX",$J,"OUTPUT")) DFN Type: Input IEN of PATIENT file (#2) START Type: Input Start date for search END Type: Input End date for search TESTS Type: Input Array of tests for which results should be returned. Format of input should be TESTS(number)=IEN of file 60 (LABORATORY TEST file) Returns interim report for CPRS GUI display. Allows for results from specific tests to be returned. Ouptut is in TMP("LR7OGX",$J,"OUTPUT") as described in INTERIM call within this DBIA. COMPONENT: MICRO(.ROOT,DFN,END,START) VARIABLES: ROOT Type: Output Root of output data (set to ^TMP("LR7OGX",$J,"OUTPUT")) DFN Type: Input IEN of PATIENT file (#2) END Type: Input end date for search START Type: Input Start date for search Returns micros results in interim report format for CPRS GUI display. Ouptut is in TMP("LR7OGX",$J,"OUTPUT") as described in INTERIM call within this DBIA. ******************** 2959 NAME: Calls to LR7OGMU CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine LR7OGMU. ROUTINE: LR7OGMU COMPONENT: NEWOLD(.VALUE,DFN) VARIABLES: VALUE Type: Output Newest Date^Oldest Date Dates are in internal FM format. Example of output: 2991028.130321^2920428.1044 DFN Type: Input IEN of PATIENT file (#2) Returns most recent and oldest lab tests for a patient (date only) ******************** 2960 NAME: Calls to TIULX CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: NOV 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine TIULX ROUTINE: TIULX COMPONENT: $$HASDS(DFN,VISIT) VARIABLES: DFN Type: Input IEN of the PATIENT file (#2) VISIT Type: Input IEN of the VISIT file (#9000010). Returns a string based on whether a discharge summary exists for the given PATIENT and VISIT file pointers. If no summary found, output is 0^0 If summary is found, output is: IEN of TIU DOCUMENT file (#8925)^context 'context; is based on the TIU STATUS file (#8925.6) pointer from the TIU DOCUMENT file. If no valid status is found, a 0 is returned, if the status is UNSIGNED, the context is set to 2, for all other valid discharge summary statuses, the value returned is 1. COMPONENT: NEEDSIG(.TIUY,USER,CLASS) VARIABLES: TIUY Type: Both This variable is passed by reference and it is returned with a reference to a global array that contains the list of TIU documents for which the user has been identified as an additional signer. USER Type: Input Pointer to the NEW PERSON (#200) file. CLASS Type: Input Pointer to TIU DOCUMENT DEFINITION (#8925.1) file. This component allows the gathering of a list of TIU documents for which USER is an additional signer ******************** 2961 NAME: OE/RR use of HEALTH SUMMARY TYPE file CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 9,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File This DBIA documents CPRS's use of the Health Summary Type file (#142). This file is used to allow displaying of health summaries via the CPRS interface. ^GMT(142,'B' 'B' index is used to get list of health summary types for look-up in CPRS GUI. ^GMT(142,DA,0) .01 NAME 0;1 Direct Global Read & w 1 STRUCTURE GMT(142, Direct Global Read & w Checks for entry in this multiple. Prevents selection if there are no components included in the summary type. Uses data on the node to assist with presentation to the CPRS GUI user. The following fields are in the STRUCTURE multiple: .01 SUMMARY ORDER 1 COMPONENT NAME 2 OCCURRENCE LIMIT 3 TIME LIMIT 4 HEADER NAME 5 HOSPITAL LOCATION DISPLAYED 6 ICD TEXT DISPLAYED 8 PROVIDER NARRATIVE DISPLAYED. 4 SELECTION ITEM Direct Global Read & w Unable to enter submultiples apporpriately, but CPRS uses the SELECTION ITEM multiple to get multiple of SELECTION ITEMS. ^GMT(142,DA,'T') .02 TITLE T;1 Direct Global Read & w ROUTINE: ******************** 2962 NAME: Calls to GMPLHIST CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to rotuine GMPLHIST. ROUTINE: GMPLHIST COMPONENT: DT VARIABLES: AIFN Type: Input IEN of PROBLEM LIST AUDIT TRAIL file (#125.8). LCNT Type: Input Line count after which you want audit information to appear. GMPDT(LCNT Type: Output Array of autidt information returned beginning with LCNT+1. GMPDT(LCNT,0)=Audit information Shows auditing trail so detailed displays can show historical ihformation. ******************** 2963 NAME: Direct access to %ZIS(1 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CPRS GUI utilizes device parameters to handle printing from within the GUI environment. USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.5 ROOT: %ZIS(1, DESCRIPTION: TYPE: File This DBIA documents direct access to fields in the DEVICE file (#3.5). ^%ZIS(1,DA,0) .01 NAME 0;1 Direct Global Read & w 1 0;2 Direct Global Read & w 5.5 QUEUING 0;12 Direct Global Read & w ^%ZIS(1,DA,1) .02 LOCATION OF TERMINAL 1;1 Direct Global Read & w ^%ZIS(1,DA,90) 6 OUT-OF-SERVICE DATE 90;1 Direct Global Read & w ^%ZIS(1,DA,91) 9 MARGIN WIDTH 91;1 Direct Global Read & w 11 PAGE LENGTH 91;3 Direct Global Read & w ^%ZIS(1,DA,95) 15 SECURITY 95;E1,99 Direct Global Read & w ^%ZIS(1,DA,'TIME') 2009 PROHIBITED TIMES FOR TIME;1 Direct Global Read & w ^%ZIS(1,DA,'TYPE') 2 TYPE TYPE;1 Direct Global Read & w ROUTINE: ******************** 2964 NAME: Direct access to %ZIS(2 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2, DESCRIPTION: TYPE: File This DBIA documents direct access to the TERMINAL TYPE file (#3.2). ^%ZIS(2,DA,0) .01 NAME 0;1 Direct Global Read & w ^%ZIS(2,DA,5) 14 REVERSE VIDEO ON 5;4 Direct Global Read & w 15 REVERSE VIDEO OFF 5;5 Direct Global Read & w ^%ZIS(2,DA,7) 27 HIGH INTENSITY (BOLD 7;1 Direct Global Read & w 28 LOW INTENSITY (UNBOL 7;2 Direct Global Read & w 29 NORMAL INTENSITY (RE 7;3 Direct Global Read & w ROUTINE: ******************** 2965 NAME: Direct access to file 405.2 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING INCOMPLETE RECORDS TRACKING GEN. MED. REC. - VITALS USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405.1 ROOT: DG(405.1, DESCRIPTION: TYPE: File This DBIA documents references to the FACILITY MOVEMENT TYPE file (#405.1). ^DG(405.1,DA,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2966 NAME: Use of TYPE OF PATIENT file CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING This reference is needed to mimic code found in DIS^DGRPDB which displays rated disabilities. The code in DIS^DGRPD is not silent and can't be used by CPRS GUI. CPRS uses only the field IGNORE VETERAN CHECKS? (#.02) USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 391 ROOT: DG(391, DESCRIPTION: TYPE: File This DBIA documents access to the TYPE OF PATIENT file (#391) ^DG(391,DA,0) .02 IGNORE VETERAN CHECK 0;2 Direct Global Read & w ROUTINE: ******************** 2967 NAME: References to DISABILITY CONDITION file CUSTODIAL PACKAGE: HINQ SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING This reference is needed to mimic code found in DIS^DGRPDB which displays rated disabilities. The code in DIS^DGRPD is not silent and can't be used by CPRS GUI. CPRS uses only the field NAME (#.01). HEALTH SUMMARY CONSULT/REQUEST TRACKING ADDED 5/25/10 USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 31 ROOT: DIC(31, DESCRIPTION: TYPE: File This DBIA documents references to the DISABILITY CONDITION file (#31). ^DIC(31,DA,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 2968 NAME: Direct access to file 34 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR VIA will be referencing the fields in the Contract/Sharing Agreement (#34) file in VIAB RADSRC RPC. USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 34 ROOT: DIC(34, DESCRIPTION: TYPE: File This DBIA documents references to the CONTRACT/SHARING AGREEMENTS file (#34). ^DIC(34,DA,0) .01 AGREEMENT NAME 0;1 Direct Global Read & w 2 TYPE OF AGREEMENT 0;2 Direct Global Read & w ^DIC(34,DA,'I') 3 INACTIVATION DATE I;1 Direct Global Read & w ROUTINE: ******************** 2969 NAME: DBIA2969 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File To support CIRN Exception Handling, CIRN PD needs to allow user editing of patient name, date of birth, social security number and date of death fields. All appropriate security checking is done. ^DPT(D0 .01 NAME 0;1 Write w/Fileman Patient Name .03 DATE OF BIRTH 0;3 Write w/Fileman Patient Date of Birth .09 SOCIAL SECURITY NUMB 0;9 Write w/Fileman Patient Social Security Number .351 DATE OF DEATH .35;1 Write w/Fileman Patient Date of Death .353 SOURCE OF NOTIFICATI .35;3 Write w/Fileman Patient Source of Notification ROUTINE: ******************** 2970 NAME: Access to Problem List Parameters CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 125.99 ROOT: GMPL(125.99, DESCRIPTION: TYPE: File This DBIA documents access to the PROBLEM LIST SITE PARAMETER file (#125.99). ^GMPL(125.99,DA,0) 1 VERIFY TRANSCRIBED P 0;2 Direct Global Read & w 2 PROMPT FOR CHART COP 0;3 Direct Global Read & w 3 USE LEXICON 0;4 Direct Global Read & w 4 DISPLAY ORDER 0;5 Direct Global Read & w ROUTINE: ******************** 2971 NAME: Access to PROBLEM SELECTION LIST file CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: JUL 21,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 125 ROOT: GMPL(125, DESCRIPTION: TYPE: File This DBIA documents access made to the PROBLEM SELECTION LIST file (#125). ^GMPL(125,'C', ^GMPL(125, .01 NAME 0;1 Direct Global Read & w .02 DATE LAST MODIFIED 0;2 Direct Global Read & w Effective with OR*3.0*429, access to these fields are utilized in determining which clinic default selection lists to migrate to the new default selection list parameter if a clinic has been assigned to more than one list. ROUTINE: ******************** 2972 NAME: References to file 125.1 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 125.1 ROOT: GMPL(125.1, DESCRIPTION: TYPE: File This DBIA documents references made to the PROBLEM SELECTION LIST CONTENTS file (#125.1). ^GMPL(125.1,DA,0) 2 CATEGORY 0;3 Direct Global Read & w 3 SUBHEADER 0;4 Direct Global Read & w 4 SHOW PROBLEMS 0;5 Direct Global Read & w ^GMPL(125.1,'C' ROUTINE: ******************** 2973 NAME: References to file 125.12 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 125.12 ROOT: GMPL(125.12, DESCRIPTION: TYPE: File This DBIA documents references to the PROBLEM SELECTION CATEGORY CONTENTS file (#125.12). ^GMPL(125.12,DA,0) 2 PROBLEM 0;3 Direct Global Read & w 3 DISPLAY TEXT 0;4 Direct Global Read & w 4 CODE 0;5 Direct Global Read & w ^GMPL(125.12,'C' ROUTINE: ******************** 2974 NAME: Access to PROBLEM LIST AUDIT file CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HEALTH MANAGEMENT PLATFORM (HMP) will use the GMPL(125.8,"AD", cross reference to get the Problem List Audit in reverse chronological order with seconds.This data is used in displaying patient data to the user in the HMP UI. USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 125.8 ROOT: GMPL(125.8, DESCRIPTION: TYPE: File This DBIA documents references to the PROBLEM LIST AUDIT file (#125.8). ^GMPL(125.8,'B' ^GMPL(125.8,'AD' ROUTINE: ******************** 2975 NAME: Use of REQUEST ACTION TYPES file CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING SCHEDULING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123.1 ROOT: GMR(123.1, DESCRIPTION: TYPE: File This DBIA documents references to the REQUEST ACTION TYPES file (#123.1). ^GMR(123.1,'AC' .01 ACTION TYPE 0;1 Direct Global Read & w ROUTINE: ******************** 2976 NAME: Access to Allergy Parameters File CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 10,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.84 ROOT: GMRD(120.84, DESCRIPTION: TYPE: File This DBIA documents references made to the GMR ALLERGY SITE PARAMETERS file (#120.84). ^GMRD(120.84,DA(1),1,DA,0) .01 REACTIONS 0;1 Direct Global Read & w CPRS GUI uses the TOP 10 REACTIONS multiple (#120.841) and gets the first 10 entries (mimicking the ART module in the roll and scroll environment). ROUTINE: ******************** 2977 NAME: Calls to GMPLEDT3 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CLINICAL CASE REGISTRIES VIRTUAL PATIENT RECORD Added 9/27/18 for VPR*1*3 to use the GETFLDS^GMPLEDT3 api for retrieving internal and external forms of the data. USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine GMPLEDT3. ROUTINE: GMPLEDT3 COMPONENT: GETFLDS(DA) VARIABLES: DA Type: Input Internal entry number of the PROBLEM file (#9000011). AUPROV Type: Input Pointer to the NEW PERSON file defining the provider for which comments can be returned. AUPVAMC Type: Input Pointer to the LOCATION file (#9999999.06) which is a DINUMed file to the INSTITUTION. This defines the division for which comments should be returned. GMPFLD Type: Output Array, subscripted by field number, containing the internal^external value of data stored for the PROBLEM entry requested. Comments are stored in GMPORIG(10,n) where GMPORIG(10,0) is set to the number of comments and GMPORIG(10,1-n) are the comments returned. Example output: GMPFLD(.01)=9041^413.0 GMPFLD(.03)=2991006^10/6/99 GMPFLD(.05)=305^Angina Decubitus GMPFLD(.08)=2991006^10/6/99 GMPFLD(.12)=A^ACTIVE GMPFLD(.13)= GMPFLD(1.01)= GMPFLD(1.02)=P GMPFLD(1.05)=1364^MERRILL,JEREMY GMPFLD(1.06)=1^MEDICINE GMPFLD(1.07)= GMPFLD(1.08)=16^PULMONARY CLINIC GMPFLD(1.09)= GMPFLD(1.1)= GMPFLD(1.11)= GMPFLD(1.12)= GMPFLD(1.13)= GMPFLD(1.14)= GMPFLD(1.15)= GMPFLD(1.16)= GMPFLD(1.17)= GMPFLD(1.18)= GMPFLD(1.19)= GMPFLD(10,0)=1 GMPFLD(10,1)=1^1^Angina^A^2991006^1364 GMPORIG Type: Output Array returned exactly as the GMPFLD array is returned. Returns arrays of values stored in PROBLEM file (#9000011). ******************** 2978 NAME: Calls to GMPLSAVE CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HEALTH MANAGEMENT PLATFORM (HMP) will use the following API: NEW^GMPLSAVE USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine GMPLSAVE. ROUTINE: GMPLSAVE COMPONENT: EN VARIABLES: GMPORIG Type: Input Array, subscripted by field number, giving values in internal^external format. The array defines how the entry in the PROBLEM file was previous to edit. GMPFLD Type: Input Array, subscripted by field number, giving values in internal^external format. The array defines how the entry in the PROBLEM file was after editing. Saves changes made to PROBLEM file (#9000011) and tracks changes in the PROBLEM LIST AUDIT file (#125.8). COMPONENT: NEW VARIABLES: GMPFLD Type: Input Array, subscripted by field number, giving values in internal^external format. The array defines how the entry in the PROBLEM file should be stored. GMPVAMC Type: Input Pointer to the LOCATION file (#9999999.06) which is a DINUMed file to the INSTITUTION. This defines the division for which comments should be associated. GMPDFN Type: Input Internal entry number of the PATIENT file (#2). DA Type: Output Internal entry number assigned to the PROBLEM file entry. GMPSAVED Type: Output Set to 1 if the entry was successfully saved. Adds a new PROBLEM file (#9000011) entry. COMPONENT: NEWNOTE VARIABLES: GMPIFN Type: Input IEN of PROBLEM file GMPROV Type: Input Pointer to NEW PERSON file denoting provider associated with the comment. GMPVAMC Type: Input Pointer to the LOCATION file (#9999999.06) which is a DINUMed file to the INSTITUTION. This defines the division for which comments should be associated.. GMPFLD Type: Input Array GMPFLD(10,"NEW",n) which contains comments to add to the file. Creates a new note for an existing PROBLEM file (#9000011) entry. ******************** 2979 NAME: Calls to GMPLMGR1 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to GMPLMGR1. ROUTINE: GMPLMGR1 COMPONENT: GETPLIST(.LIST,.TOTAL,.VIEW) VARIABLES: LIST Type: Output Output array where LIST(counter)=IEN and LIST("B",IEN)=counter. TOTAL Type: Output Total number of problems returned. VIEW Type: Input VIEW is an array of input parameters determining which PROBLEM file entries are returned: VIEW("ACT") = "A" for active problems only "I" for inactive problems only Anything else for both active and inactive problems VIEW("PROV") = Pointer to the new person file for the provider to be associated with the returned list of PROBLEMs. Null to get all provider's entries. VIEW("VIEW") = X\n\n\n\... where X is C for Clinic or S for Service and n denotes the related file IENs. Less than 2 characters returns all clinic or service entries. Build list of entry numbers from the PROBLEM file meeting requested criteria. ******************** 2980 NAME: Calls to GMRCGUIB CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING PROSTHETICS CLINICAL PROCEDURES SCHEDULING IMAGING VIRTUAL PATIENT RECORD FEE BASIS CLAIMS SYSTEM HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** The Enterprise Health MGMT Platform (HMP) would like to subscribe to ICR 2980 to call DOCLIST~GMRCGUIB API to retrieve a list of TIU documents that are linked to a specified consult. ADVANCED PROSTHETICS ACQUISITION APAT will be using $$SFILE - propagate Suspense Note updates into the Consult when creating a Request for Quote, Orthotic Lab Work Order, Purchase Card Order, and GIP Stock Issue and $$CMT - adds a comment to the Consult when creating a Request for Quote, Orthotic Lab Work Order, Purchase Card Order, and Stock Issue. USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine GMRCGUIB. ROUTINE: GMRCGUIB COMPONENT: CMT(IEN,.COMMENTS,.RECIPIENTS,DATE,WHO) VARIABLES: IEN Type: Input IEN of the REQUEST/CONSULTATION file (#123) COMMENTS Type: Input Array of commnets in format COMMENTS(1)="xxxx",COMMENTS(2)="xxx", etc. RECIPIENTS Type: Input Array of alert recipients who should be alerted of comment addition. (optional) DATE Type: Input Date/time of activity in internal FM format. WHO Type: Input IEN of the NEW PERSON who is responsible for the comment (OPTIONAL) Entry point to add a comment to a consult record. COMPONENT: $$SFILE(IEN,TYPE,SIGFIND,PROVIDER,WHO,.COMMENTS,FLAG,WHOGETS,DATE ) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123). TYPE Type: Input Pointer to the REQUEST ACTION TYPES file (#123.1) (10=complete, 4=significant findings) SIGFIND Type: Input Y for significant finding N for no significant finding U for unknown significant finding PROVIDER Type: Input IEN of NEW PERSON file (#200) denoting provider responsible for the action. WHO Type: Input Pointer to the NEW PERSON file (#200) denoting person actually performing the action. COMMENTS Type: Input Array of comments describing the action in format COMMENTS(1)="xxxx", COMMENTS(2)="xxx" FLAG Type: Input Flag to signal whether alerts should be sent (Y for yes, N for no). WHOGETS Type: Input Comma-delimited string of NEW PERSON file IENs denoting who should receive an alert. DATE Type: Input Date/time the activity took place. RESULT Type: Output Result of extrinsic function returned as Error Flag^Error Message Error Flag=1 if error, otherwise 0. Error Message is null if Error Flag is set to 0. This entry point was written for CPRS GUI to process various file update functions including administrative completion and significant findings. COMPONENT: DOCLIST(GMRCAR,GMRCDA) VARIABLES: GMRCAR Type: Both Passed in as the array to return results in. The array will be returned as follows with multiple 50 nodes for every TIU document number: GMRC(0) = zero node of the record. GMRC(50,1) = "ien;TIU(8925," GMRC(50,2) = "ien;TIU(8925," GMRCDA Type: Input IEN of consult to provide array of TIU documents. Returns a list of TIU documents linked to the selected consult COMPONENT: SCH(IEN,WHO,DATE,RECIPIENTS,COMMENTS) VARIABLES: IEN Type: Input IEN of the REQUEST/CONSULTATION file (#123) WHO Type: Input IEN of the NEW PERSON who is responsible for the comment (OPTIONAL) DATE Type: Input Date/time of activity in internal FM format. RECIPIENTS Type: Input Array (passed by reference) of alert recipients who should be alerted of comment addition. (OPTIONAL) COMMENTS Type: Input Array (passed by reference) of comments (OPTIONAL) in format: COMMENTS(1)="xxxx",COMMENTS(2)="xxx", etc. Entry point to move a consult record to scheduled status ******************** 2981 NAME: Calls to GMRCP5 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING PROSTHETICS CLINICAL PROCEDURES SCHEDULING USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine GMRCP5. ROUTINE: GMRCP5 COMPONENT: GUI(.ROOT,IEN) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123) for which report should be returned. Returns SF513 report for display in GUI environment. Root will be set to ^TMP("GMRC",$J,"SF513"). COMPONENT: EN(IEN,COPYTYPE,DEVICE,.STATUS) VARIABLES: IEN Type: Input IEN of REQUEST/CONSULTATION file (#123). COPYTYPE Type: Input C for Chart Copy W for Working Copy null for not applicable DEVICE Type: Input Device to be passed to %ZTLOAD as ZTIO. STATUS Type: Output Returned as: 0^Queued as task # n (if successful) -1^Not Queued (if unsuccessful) Entry point to send a copy of the SF513 to a printer device. ******************** 2982 NAME: Calls to GMRCPR0 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 12,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine GMRCPR0 ROUTINE: GMRCPR0 COMPONENT: GETSVC(.LIST,PROC) VARIABLES: LIST Type: Output LIST=total returned LIST(counter)=internal^external format of REQUEST SERVICES file PROC Type: Input Pointer to the PROTOCOL file (#101) which is based on the PROCEDURE TYPE multiple of the REQUEST SERVICES file (#123.5). Returns a list of services for a particular procedure type (GMRCR protocol entry). ******************** 2983 NAME: LR7OSOS1 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine produces a formatted patient report of Lab order status. ROUTINE: LR7OSOS1 COMPONENT: EN1(Y,ORVP,START,END,DTRANGE) VARIABLES: Y Type: Output Where the formatted report is stored: ^TMP("ORDATA",$J,... ORVP Type: Input Variable pointer to patient. START Type: Input Starting date/time to get orders. END Type: Input Ending date/time to get orders. DTRANGE Type: Input Can be used as instead of START and END dates. This is a number of days to go back for data. ******************** 2984 NAME: LR7OSBB1 CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine is used to get Blood Bank patient information for disiplay in CPRS. It is a 'silent' version of the routine LRBLPD. ROUTINE: LR7OSBB1 COMPONENT: SET VARIABLES: Sets up environmental variables. COMPONENT: OERR VARIABLES: DFN Type: Input Patient identifyer Gets a patient report. COMPONENT: CLEAN VARIABLES: Does clean-up ******************** 2985 NAME: LR7OSOS CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine produces a lab status report for a pre-selected patient. This report is interactive. ROUTINE: LR7OSOS COMPONENT: OERR(X,ALPHA,OMEGA) VARIABLES: X Type: Input Patient identifier in variable pointer format (dfn;file) ALPHA Type: Input Starting date/time to get report OMEGA Type: Input Ending date/time to get report ******************** 2986 NAME: OE/RR calls to MCARP CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 15,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine is used to get parameters needed to produce a report of Patient Procedures. This DBIA is only to be used for CPRS Reporting and does not include any procedures for editing the Medicine database. ROUTINE: MCARP COMPONENT: MCPPROC VARIABLES: MCPRO Type: Input Used in conjunction with the option name to determine which report is produced. Gets parameters necessary to get Summary of Patient Procedures. This call is used in conjunction with other calls to MC routines: EN^MCARPS2 => gets patient related data, sets up ^TMP("OR",$J,"MCAR" MCPPROC^MCARP => gets additional data for report. ***^MC**** => produces report, call depends on data from EN^MCARPS2 ******************** 2988 NAME: IAs for VAFCTFU utilities CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA CLINICAL INFO RESOURCE NETWORK CORBA SERVICES USAGE: Controlled Subscri ENTERED: NOV 19,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine MPI Vista is requesting a DBIA with Registration to call DELALLTF^VAFCTFU to remove all associated treating facilities for a patient who's ICN has been inactivated. DELALLTF(PAT) ;Entry point to delete all Treating Facilities for a single patient. ;INPUT PAT - The patient's ICN ;OUTPUT 0 (zero) - If no errors ; 1^error description if an error MPI/PD is requesting an IA with Registration to call FILE^VAFCTFU. This subroutine is used to file data into the TREATING FACILITY LIST (TFL - #391.91) file (via the ADT/HL7 PIVOT file) under certain conditions. FILE(PDFN,FSTRG,TICN) ;this module files the individual entry input: PDFN - patient dfn FSTRG- string, three pieces delimited by an '^' 1st piece: treating facility 2nd piece: last treatment date for the patient 3rd piece: Event Reason (ADT/HL7 EVENT REASON #391.72) file TICN - boolean flag, do not update the TFL file (via the PIVOT file) if TICN equals one. MPI/PD needs to expand this DBIA to include a call to DELETE^VAFCTFU. This call is necessary to address the issue of duplicate treating facilities assigned to a patient, therefore the variable being passed is the internal entry number in TREATING FACILITY LIST FILE (#391.91) not the IEN for a site that the other calls are using. DELETE(TFIEN) ;the actual deletion code ; K DIK,DA S DIK="^DGCN(391.91," S DA=TFIEN D ^DIK K DIK,DA Q ROUTINE: VAFCTFU COMPONENT: DELALLTF VARIABLES: PAT Type: Input PAT = ICN for the given patient RETURNS Type: Output This function returns either: 0 (zero) - If no errors 1^error description if an error $$DELALLTF(PAT) ;Entry point to delete all Treating Facilities for a single patient. ;INPUT PAT - The patient's ICN ;OUTPUT 0 (zero) - If no errors ; 1^error description if an error COMPONENT: FILE VARIABLES: PDFN Type: Input The internal entry number of the patient in the PATIENT (#2) file. FSTRG Type: Input This variable is three piece string delimited by an '^' 1st piece: treating facility 2nd piece: last treatment date for the patient 3rd piece: Event Reason (ADT/HL7 EVENT REASON #391.72) file TICN Type: Input This variable acts as a boolean flag. Do not update the TFL file (via the PIVOT file) if TICN equals one. This subroutine is used to file data into the TREATING FACILITY LIST (TFL - #391.91) file (via the ADT/HL7 PIVOT file) under certain conditions. COMPONENT: $$DELETETF(PAT,INST) VARIABLES: PAT Type: Input ICN of the patient INST Type: Input IEN of the institution to be deleted $$DELETETF Type: Output 0 (zero) - If no errors 1^error description if there was a problem If the legacy site is on the treating facility list for a patient that it should be deleted. COMPONENT: DELETE(TFIEN) VARIABLES: TFIEN Type: Input Internal entry number of a specific record in the TREATING FACILITY LIST FILE (#391.91). Used to delete specific entries in the TREATING FACILITY LIST FILE (#391.91) when identification of the site is not enough. ******************** 2990 NAME: Treating Facility List CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine As part of the initative to share clinical information among VA facilities, a VA facility will have information about patients that were seen at other locations for health care. This routine will return (given an Integration Control Number or a DFN) a list of facilities the patient was seen for care. ROUTINE: VAFCTFU1 COMPONENT: $$QUERYTF(ICN,.ARRAY,INDX) VARIABLES: ICN Type: Input Patient Integration Control Number. ARRAY Type: Both This variable is an array variable that the function uses to store the results of the treating facility list. It will be in the structure of x(1), x(2), etc. E.g., X(1)=500^2960101 Where the first peice is the IEN of the institution and the second piece is the current date on record for that institution. INDX Type: Input The cross-reference to $O through. 'APAT' for patient information linked to treating facilities, 'AEVN' for patient info linked with an event reason. INDX will equal one if 'AEVN' is used, else 'APAT' is used. $$QUERYTF Type: Output 0 - If no error 1^error description - If error or no data in the array COMPONENT: TFL(.LIST,DFN) VARIABLES: LIST Type: Both LIST(1)=-1^error message Example error messages: parameter missing, no treating facility, missing DFN, missing ICN, etc. The only time LIST(1) will always be defined is if there is an error; the first piece will be a -1. OR an array of treating facilities; they may or may not be VAMCs: LIST(1)=500^ALBANY^3020513.092^3^VAMC LIST(2)=662^SAN FRANCISCO^3020311.14^3^VAMC LIST(3)=200^AUSTIN^^^DPC OR an array of treating facilities; may or may not be sequential: LIST(2)=500^ALBANY^3020513.092^3^VAMC LIST(3)=662^SAN FRANCISCO^3020311.14^3^VAMC DFN Type: Input DFN - required second input parameter equals the IEN in the PATIENT (#2) file. ******************** 2991 NAME: DBIA2991 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: NOV 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Variable pointer information is sometimes required. This information can be found in ^DD(file#,field#.,"V"). This DBIA provides for read-only access of the nodes ^DD(file#,field#,"V",. ^DD(file#,field#,'V',0 ^DD(file#,field#,'V',IND,0) ROUTINE: ******************** 2992 NAME: PARAMETER DEFINITIONS CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 23,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8989.51 ROOT: XTV(8989.51, DESCRIPTION: TYPE: File Parameter Tools is a generic method of handling parameter definition, assignment, and retrieval. A parameter may be defined for various entities where an entity is the level at which you want to allow the parameter defined (e.g. package level, system level, division level, location level, user level, etc.). A developer may then determine in which order the values assigned to given entities are interpreted. Parameter: ========== A parameter is the actual name which values are stored under. The name of the parameter must be namespaced and it must be unique. Parameters can be defined to store the typical package parameter data (e.g. the default add order screen in OE/RR), but they can also be used to store GUI application screen settings a user has selected (e.g. font or window width). When a parameter is defined, the entities that may set the parameter is also defined. The definition of parameters is stored in the PARAMETER DEFINITION file (#8989.51). KIDS exports them. ROUTINE: ******************** 2993 NAME: DBIA2993 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: NOV 24,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine RAI/MDS has requested Integrated Billing add cross references to 5 Insurance Type (#2.312) fields to monitor changes to the patient's insurance data. Execution of the cross reference will result in an entry in the ADT/HL7 PIVOT file (#391.71) and mark it as requiring transmission of an HL7 demographic A08 update message to the COTS interface. The local variable DGRUGA08 will be set to 1 if the cross reference is not to be executed as part of a re-indexing. Update: IB*2*497 increased the length of the SUBSCRIBER ID field to support the EDI New Standards and Operating Rules for VHA providers. This required length increase made it necessary to move the location of this field to a new Data Dictionary node in the INSURANCE TYPE sub-file. To support this implementation, all subscribers to this ICR will need to make the necessary changes in their applications. The ADGRU cross- reference cannot be implemented at the new field (2.312, 7.02) until the old field (2.312, 1) has been deleted. Therefore rather than IB*2*497, IB*2*518 will need to implement the ADGRU cross-reference at the new field and delete ADGRU cross-reference at the old field. The old and new field are noted in the field list detail of this ICR. Fields cross-referenced in the Patient File Insurance Type multiple: 2.312, .01 Insurance Type (x-ref #1) 2.312, .18 Group Plan (x-ref #1) 2.312, 1 *Subscriber ID (x-ref #1) Note: IB*2*497 - replaced by SUBSCRIBER ID field (7.02) 2.312, 7.02 Subscriber ID (x-ref to be determined by IB*2*518) 2.312, 3 Insurance Expiration Date (x-ref #1) 2.312, 8 Effective Date of Policy (x-ref #1) The following cross reference is added to all 5 fields: CROSS-REFERENCE: ADGRUxx TYPE: MUMPS SET: D:($T(ADGRU^DGRUDD01)'="") ADGRU^DGRUDD01(DA(1)) KILL: D:($T(ADGRU^DGRUDD01)'="") ADGRU^DGRUDD01(DA(1)) ROUTINE: DGRUDD01 COMPONENT: ADGRU(DFN) VARIABLES: DFN Type: Input IFN of patient's record in the Patient file (DFN). Call to monitor data field changes required by RAI/MDS. ******************** 2994 NAME: Calls to TIUU CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING AUTHORIZATION/SUBSCRIPTION USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine TIUU. ROUTINE: TIUU COMPONENT: $$READ(TYPE,PROMPT,DEFAULT,HELP,SCREEN) VARIABLES: TYPE Type: Input Type of reader call with qualifiers (as you would set DIR(0) for a ^DIR call). PROMPT Type: Input The text of the prompt to be presented to the user. DEFAULT Type: Input (OPTIONAL) Default if one should be presented to the user. HELP Type: Input (OPTIONAL) Help text for prompt. SCREEN Type: Input (OPTIONAL) Screen for DIR call. RESULT Type: Output RESULT=$$READ^TIUU(...) Returns "" for failed look-ups, internal^external value for one character returned values or just external otherwise. Generic call to FM Reader. ******************** 2995 NAME: Calls to TIURS CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIURS. ROUTINE: TIURS COMPONENT: $$ASKCSNR(DA,SIGNER) VARIABLES: DA Type: Input IEN of TIU DOCUMENT file (#8925). SIGNER Type: Input DUZ of person using system. It will look at the person's personal preferences to determine the co-signer to default. Prompts for a cosigner for the document. COMPONENT: ES(DA,DUZ) VARIABLES: DA Type: Input IEN of TIU DOCUMENT file (#8925). DUZ Type: Input DUZ of person who will enter the electronic signature. Calls to get electronic signature for document. COMPONENT: EDSIG(TIUDA,NULL,ASKPRINT) VARIABLES: DA Type: Input IEN of TIU DOCUMENT file (#8925). NULL Type: Input (OPTIONAL) Pass as null...appears to have no affect on call (variable internally always set to 1). ASKPRINT Type: Input (OPTIONAL) Pass as positive value if user should be prompted to print the note based on parameter settings. Call from edit action to sign document. ******************** 2996 NAME: Calls to TIURC CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIURC. ROUTINE: TIURC COMPONENT: COPY1 VARIABLES: TIUDA Type: Input IEN of TIU DOCUMENT file (#8925). Copies a document. ******************** 2997 NAME: Calls to TIURB CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIURB ROUTINE: TIURB COMPONENT: DEL(DA) VARIABLES: DA Type: Input IEN of TIU DOCUMENT file (#8925) which user wants to delete. Allow an entry to be deleted or, to quote Joel, "we don't hand out pencils without erasers". ******************** 2998 NAME: Calls to TIURA CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIURA. ROUTINE: TIURA COMPONENT: EDIT1 VARIABLES: TIUDA Type: Input IEN of TIU DOCUMENT file (#8925) denoting record to edit. Edit a TIU document. COMPONENT: PRNTDOC(METHOD,.ARRAY) VARIABLES: METHOD Type: Input PRINT METHOD field from the TIU DOCUMENT DEFINITION file (#8925.1). ARRAY Type: Input Array of documents to print in format: ARRAY(METHOD,DFN,COUNTER,TIUDA) where TIUDA is the IEN of the TIU DOCUMENT file (#8925) ^TMP("TIUPR",$J) may be killed before and after use. Call to print an array of documents of a single document type. COMPONENT: BROWS1(LISTTEMP) VARIABLES: Browse selected discharge summaries. Note this call expects list manager variables to be in place such as VALMY which is the array of documents to browse. ******************** 2999 NAME: Calls to TIUPRPN3 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING ORCNOTE kills ^TMP("TIUPR",$J) to make sure $$FLAG is starting with a clean slate. USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIUPRPN3. ROUTINE: TIUPRPN3 COMPONENT: $$FLAG() VARIABLES: $$FLAG Type: Output RESULT=$$FLAG^TIUPRPN3() Returns 1 if CHART copy, 0 if WORK copy, or NULL if '^' Asks whether a chart copy or work copy should be printed. ******************** 3000 NAME: Calls to TIULM CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to TIULM. ROUTINE: TIULM COMPONENT: FIXLST VARIABLES: TMP('TIUR' Type: Input Array that List Manager uses to display the entries on the list. Restores video attributes to List Manager list. ******************** 3001 NAME: Calls to TIULA1 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routine TIULA1. ROUTINE: TIULA1 COMPONENT: $$ASKSIG() VARIABLES: DUZ Type: Input Expected to exist as system-wide variable DUZ defining the entry of the user in the NEW PERSON file (#200). RESULT Type: Output RESULT=$$ASKSIG^TIULA1() Where result returns: 0 if no valid electronic signature information for user; or 1^EsigName^EsigTitle Returns 0 if no valid electronic signature for user. Otherwise returns 1^EsigName^EsigTitle. ******************** 3002 NAME: Calls to TIUDEV CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 26,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls to routien TIUDEV. ROUTINE: TIUDEV COMPONENT: $$DEVICE(.IO,DEFAULT,QUEUE,SCREEN,IOP) VARIABLES: IO Type: Output IO of device selected. DEFAULT Type: Input (OPTIONAL) Default device to present to user. QUEUE Type: Input (Optional) Defaults to allow queuing, pass as null to avoid allowing queuing. SCREEN Type: Input (OPTIONAL) Screen for %ZIS if desired. IOP Type: Input (Optional) Define as input documented for call to %ZIS: IOP=device name to force printing to a particular device IOP="Q" to force queuing, but ask user for device IOP="P" to force pritning to the closest printer. RESULT Type: Output RESULT=$$DEVICE(.IO,DEFAULT,QUEUE,SCREEN,IOP ) where result is set to ION or the name of the device. Prompts for device to print to. COMPONENT: QUE(ZTRTN,ZTIO) VARIABLES: ZTRTN Type: Input Callable entry point to generate output (as passed to %ZTLOAD). ZTIO Type: Input Device to print output to (as passed to %ZTLOAD). Queues output to print to specified device. ******************** 3003 NAME: Calls to routine TIULG CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING SURGERY USAGE: Controlled Subscri ENTERED: NOV 29,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA documents calls made to routine TIULG. ROUTINE: TIULG COMPONENT: $$PRNTGRP(IEN) VARIABLES: IEN Type: Input IEN of TIU DOCUMENT DEFINITION file (#8925.1). RESULT Type: Output RESULT=$$PRNTGRP^TIULG(IEN) and returns the PRINT GROUP (field #6.13) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. Returns PRINT GROUP (field #6.13) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. COMPONENT: $$PRNTHDR(IEN) VARIABLES: IEN Type: Input IEN of TIU DOCUMENT DEFINITION file (#8925.1). RESULT Type: Output RESULT=$$PRNTHDR^TIULG(IEN) and returns the PRINT FORM HEADER (field #6.1) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. Returns PRINT FORM HEADER (field #6.1) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. COMPONENT: $$PRNTMTHD(IEN) VARIABLES: IEN Type: Input IEN of TIU DOCUMENT DEFINITION file (#8925.1). O Type: Output RESULT=$$PRNTMTHD^TIULG(IEN) and returns the PRINT METHOD (field #6) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. Returns PRINT METHOD (field #6) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. COMPONENT: $$PRNTNBR(IEN) VARIABLES: IEN Type: Input IEN of TIU DOCUMENT DEFINITION file (#8925.1). RESULT Type: Output RESULT=$$PRNTNBR^TIULG(IEN) and returns the PRINT FORM NUMBER (field #6.12) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. Returns PRINT FORM NUMBER (field #6.12) for given TIU DOCUMENT DEFINITION file (#8925.1) entry. ******************** 3004 NAME: POINT TO DISPLAY GROUP (#100.98) FILE CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING RADIOLOGY/NUCLEAR MEDICINE Added 11/6/19, effective with RA*5*161. USAGE: Controlled Subscri ENTERED: NOV 30,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.98 ROOT: ORD(100.98, DESCRIPTION: TYPE: File ^ORD(100.98, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3005 NAME: POINT TO OE/RR LIST (#100.21) FILE CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: NOV 30,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100.21 ROOT: OR(100.21, DESCRIPTION: TYPE: File ^OR(100.21, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3006 NAME: MAIL GROUP API CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 30,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The APIs in this DBIA perform mail group functions and actions. If any errors occur, the following variables will be defined: XMERR - The number of errors ^TMP("XMERR",$J,,"TEXT",)= Following is information on some common input parameters: XMGROUP - Mail group IEN or name (exact, case-sensitive) ROUTINE: XMXAPIG COMPONENT: $$GOTLOCAL VARIABLES: XMGROUP Type: Input See General Description. XMDAYS Type: Used (optional) Active members of the group must have used MailMan within the past number of days specified by XMDAYS. If XMDAYS is 0 or null or is not supplied, it is ignored. XMMBRS Type: Used Optional requirement that the group must contain at least this many active local members. Default is 1. Find out whether or not a mail group has any active local members. Function returns 1 if it does; 0 if it doesn't. This can be important information. Just because a mail group may have local members, doesn't mean that any messages will be delivered to them. They must be active (have an access code and a mail box.) If the mail group does not exist or if there are no active local members, the function will return 0, XMERR will be defined, and there will be an appropriate error message in ^TMP("XMERR",$J), as noted above, in the General Description. Usage: I '$$GOTLOCAL^XMXAPIG(XMGROUP[,XMDAYS][,XMMBRS) D error Example: I '$$GOTLOCAL^XMXAPIG("GROUP") D error If the mail group named GROUP has no active local members, do an error routine to notify someone. Otherwise, go ahead and send the message. Optionally, you may specify an additional constraint, that at least one member must have used MailMan in the last few days. Example: I '$$GOTLOCAL^XMXAPIG("GROUP",9) D error If the mail group named GROUP doesn't have at least one active local member who has used MailMan in the last 9 days, do an error routine to notify someone. Otherwise, go ahead and send the message. Optionally, you may specify an additional constraint, that there must be not just 1, but at least XMMBRS active local members. Example: I '$$GOTLOCAL^XMXAPIG("GROUP","",3) D error There must be at least 3 active local members in the group. COMPONENT: ADDMBRS VARIABLES: XMDUZ Type: Input The user who is adding the members to the group(s). The user must be authorized to edit the mail groups. Group coordinators or organizers may edit their own groups. The following users may edit public groups or unrestricted private groups: - Clinical Application Coordinators - Anyone possessing the XMMGR key - Anyone possessing the XM GROUP EDIT MASTER key XMGROUP Type: Input The group(s) to be edited. May either be passed by value (for a single group) or by reference (for one or more groups). May be the ien(s) of the group(s) in the MAIL GROUP file 3.8, or their name(s) (full and exact). XMGROUP="GROUP A" - or - XMGROUP("GROUP A")="" XMGROUP("GROUP B")="" XMMBR Type: Input The new member(s). May be passed by value (for one member) or by reference (for one or more members). The same rules apply for specifying XMMBRs as apply when you're addressing a message. XMINSTR Type: Used Optional special instructions to forward past messages to the local members. XMINSTR("FLAGS") - May contain any combination of the following: "F" - Forward messages to users, if the users aren't already on the messages. XMINSTR("FDATE") - Add users to messages originating on or after this date. Must be any exact date recognized by FileMan. Default is from the beginning of time. Used in conjunction with FLAGS. XMINSTR("TDATE") - Add users to messages originating on or before this date. Must be any exact date recognized by FileMan. Default is the present. Used in conjunction with FLAGS. XMTSK Type: Output The number of the task which will find and forward past mail group messages to local users. Returned only if XMINSTR("FLAGS") is passed in. Add members to mail group(s). Local users, devices, server options, mail groups, and remote users may be added to mail groups using this API. (Distribution lists, fax recipients, and fax groups are not handled by this API.) Optionally, find and forward existing mail group messages to the local users. Usage: D ADDMBRS^XMXAPIG(XMDUZ,[.]XMGROUP,[.]XMMBR,.XMINSTR,.XMTSK) COMPONENT: JOIN VARIABLES: XMDUZ Type: Input The user who wants to join the group. XMGROUP Type: Input The group the user wants to join. See the General Description for more information. XMINSTR Type: Used Special instructions. See the description of the XMINSTR variable for entry ADDMBRS for more information. Additionally, if XMINSTR("FLAGS")=["F", may specify: XMINSTR("SELF BSKT") - the basket (name or ien) to which to deliver the messages XMTSK Type: Output Task number. See the description of XMTSK for entry ADDMBRS for more information. A user chooses to join one group, and optionally have past mail group messages forwarded. Usage: D JOIN^XMXAPIG(XMDUZ,XMGROUP,.XMINSTR,.XMTSK) COMPONENT: DROP VARIABLES: XMDUZ Type: Input The user who wants to drop from the mail group. XMGROUP Type: Input The group from which the user wants to drop. See the General Description for more information. User chooses to drop from one mail group. Usage: D DROP^XMXAPIG(XMDUZ,XMGROUP) COMPONENT: $$MEMBER VARIABLES: XMDUZ Type: Input The user in question. XMGROUP Type: Input The group to check. See the General Description for more information. XMCHKSUB Type: Used If the user isn't found in the group, should we check the member groups? 1=yes; 0=no. Default is no. Find out whether a user is a member of a mail group. Function returns 1 if yes; 0 if no. If the user isn't a direct member, optionally check to see if the user is a member of any of the group's member groups. Usage: I $$MEMBER^XMXAPIG(XMDUZ,XMGROUP[,XMCHKSUB]) D ... ******************** 3007 NAME: DBIA3007 CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: DEC 2,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 423.6 ROOT: PRCF(423.6, DESCRIPTION: TYPE: File This agreement allows AR to reference the IFCAP file ISMS/FMS TRANS #423.6. ^PRCF(423.6,B, .01 TRANSACTION ID 0;1 Read w/Fileman This is the B cross reference for the .01 field in the file. AR $orders through the B cross reference to locate the transactions that need to be processed. ^PRCF(423.6,DA,1, 1 TRANSACTION 1;0 Read w/Fileman This is the actual transactions received from FMS. This is a multiple field. This global stores the transactions received from FMS. AR $orders through these transactions and processes the data. ROUTINE: ******************** 3008 NAME: POINT TO USR CLASS (#8930) FILE CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: DEC 7,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930 ROOT: USR(8930, DESCRIPTION: TYPE: File ^USR(8930, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3009 NAME: XQALFWD CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 8,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point can be used to forward alerts (in most cases, for the current user only). It is a silent (no screen input or output) entry point, and so can be used for windowed applications. Example ; get open alerts for current user K A6AALRT D USER^XQALERT("A6AALRT") ; I +A6AALRT D ; if any current alerts... .; loop through A6AALRT array, parse alert id for each open alert .K A6AALRT1 S A6ASUB="",A6AI=0 .F S A6ASUB=$O(A6AALRT(A6ASUB)) Q:'$L(A6ASUB) D ..S A6AI=A6AI+1,A6AALRT1(A6AI)=$P(A6ASUB,"^",2) .; .;forward open alerts of current user to MAS CLERKS mailgroup .K A6AUSER S A6AUSER="G.MAS CLERKS" .D FORWARD^XQALFWD(.A6AALRT1,A6AUSER,"A","Forwarded Alert") Q ROUTINE: XQALFWD COMPONENT: FORWARD VARIABLES: [.]alerts Type: Input Array of alerts to be forwarded, each identified by its full alert identifier (the value of the ALERT ID field in the ALERT DATE/TIME multiple of the current user's entry in the ALERT file. Current user is identified by the value of the XQADUZ variable). The alert identifiers for a user's current open alerts can be obtained using the USER^XQALERT entry point. If only a single alert is to be forwarded, only the top node must be set (set it to the alert identifier of the alert to forward, and pass by value). If there are multiple alerts to forward, the value of each entry in the array should be one of the desired alert identifier. For example, A6AALRT(1)="NO-ID;92;2941215.100432" A6AALRT(2)="NO-ID;161;2941220.111907" A6AALRT(3)="NO-ID;161;2941220.132401" If using an array, the array must be passed by reference in the parameter list. [.]users Type: Input Users to forward alert to. For forwarding as an alert or as a mail message (when the type parameter is A or M), the variable may specify one or more users, and/or mailgroups. For users, specify by ien (in the NEW PERSON file). You do not need to precede the user's ien with an accent grave. For mail groups, specify in format G.MAILGROUP. If there is only a single user or mailgroup, just set the top node of the array to that value, and pass it by value. If there are multiple values to be passed, pass them as the values of numerically subscripted array nodes (and pass the array by reference). For example, A6AUSER(1)="G.MAS CLERKS" A6AUSER(2)="G.MAS OVERNIGHT" For forwarding to a printer (when the type parameter is P), there should be only a single value specifying the desired entry in the DEVICE file. You can specify the device either by name or by internal entry number (ien). If specifying by ien, precede the ien with an accent grave (e.g., `202). type Type: Input Indicates the method of forwarding desired. The options are the single characters 'A' (to forward as an Alert), 'M' (to forward as a Mail Message), and 'P' (to print a copy of the alert). If the value passed is not either A, M, or P, then no action will be taken. comment Type: Input A character string to use as a comment to accompany the alert when it is forwarded. Usage D FORWARD^XQALFWD([.]alerts,[.]users,type,comment) ******************** 3010 NAME: XQALBUTL CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 8,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: XQALBUTL COMPONENT: RECIPURG VARIABLES: DUZ Type: Input User whose alerts you want to delete Called by option ORB PURG RECIP - purge existing notifs: recipient/DUZ COMPONENT: PTPURG VARIABLES: DFN Type: Input DFN of patient whose alerts you want to delete called by option ORB PURG PATIENT - purge existing notifs: patient COMPONENT: NOTIPURG VARIABLES: NOT Type: Input IEN of Notification [#100.9] all instances of which will be deleted called by option ORB PURG NOTIF - purge existing notifs: notification ******************** 3011 NAME: XWB IS RPC AVAILABLE CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 8,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC allows an application to determine if a particular RPC is available on a server. INPUT PARAMETER: RPC PARAMETER TYPE: LITERAL SEQUENCE NUMBER: 1 (Required) DESCRIPTION: Name of the RPC to be tested. INPUT PARAMETER: RUN CONTEXT PARAMETER TYPE: LITERAL SEQUENCE NUMBER: 2 (Optional) DESCRIPTION: Specific context in which RPC will run. Possible values are: L = run Locally (on the server the user is logged on to) R = run Remotely (on a server the user is not logged on to) If this parameter is not sent, RPC is checked for both local and remote. The check is done against the value in the INACTIVE field in the Remote Procedure file. See that field's description for more details. INPUT PARAMETER: VERSION NUMBER PARAMETER TYPE: LITERAL SEQUENCE NUMBER: 3 (Optional) DESCRIPTION: Minimum version number of the RPC. This parameter is only used if the RUN CONTEXT parameter = "R". If a numeric value is in this parameter, the value must be less than or equal to the value in the VERSION field of the Remote Procedure file for the RPC is be marked available. Note: if the VERSION field is null, the check will fail for any numeric value in this parameter. RETURN VALUE DESCRIPTION: Boolean. 1 = RPC available. 0 = RPC not available. ROUTINE: ******************** 3012 NAME: XWB ARE RPCS AVAILABLE CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 8,1999 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC allows an application to determine if a list of RPCs are available for use on the server. INPUT PARAMETER: RUN CONTEXT PARAMETER TYPE: LITERAL SEQUENCE NUMBER: 1 (Optional) DESCRIPTION: Specific context in which RPCs will run. Possible values are: L = run Locally (on the server the user is logged on to) R = run Remotely (on a server the user is not logged on to) If this parameter is not sent, RPC is checked for both local and remote. The check is done against the value in the INACTIVE field in the Remote Procedure file. See that field's description for more details. INPUT PARAMETER: RPC PARAMETER TYPE: LIST SEQUENCE NUMBER: 2 (Required) DESCRIPTION: This 0-based array contains list of RPCs to be checked along with (optionally) a minimum acceptable version of the RPC. The format is: RPCName^RPCVersionNumber The RPCVersionNumber is only used if the RUN CONTEXT parameter = "R". If a numeric value is in the second ^-piece and the RUN CONTEXT ="R", the value must be less than or equal to the value in the VERSION field of the Remote Procedure file for the RPC to be marked available. Note: if the VERSION field is null, the check will fail for any numeric value. RETURN VALUE DESCRIPTION: A 0-based array. The index corresponds to the index of the RPC in the RPC Input Parameter. A value of 1 means the corresponding RPC is available; a value of 0 means it is not available. ROUTINE: ******************** 3013 NAME: DBIA3013 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: DEC 21,1999 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52.7 ROOT: PS(52.7 DESCRIPTION: TYPE: File Controlled Substances is given permission to reference the fields identified in this integration agreement. The refernces are made using the VA Fileman API ^DIC. GLOBAL MAP DATA DICTIONARY #52.7 -- IV SOLUTIONS FILE STORED IN ^PS(52.7, (3 ENTRIES) SITE: BIRMINGHAM ISC (#14) ^PS(52.7,D0,0)= (#.01) PRINT NAME [1F] Read w/Fileman ^PS(52.7,D0,0)= (#2) VOLUME [3F] Read w/Fileman ROUTINE: ******************** 3015 NAME: PID segment generation (CIRN PD) CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX VISTA CONSULT/REQUEST TRACKING INPATIENT MEDICATIONS 12/11/15-Added Inpatient Meds for Pharmacy Interface Automation (PIA) project USAGE: Controlled Subscri ENTERED: JAN 12,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this IA is to create a PID segment when a patient is: 1) admitted 2) discharged 3) checked out of a clinic This segment is part of a HL7 message used by CIRN PD to DATE LAST TREATED (#.03) and the ADT/HL7 EVENT REASON (#.07) fields in the TREATING FACILITY LIST (#391.91) file. This is patient/facility specific information. ROUTINE: VAFCPID COMPONENT: $$EN VARIABLES: DFN Type: Input ien of the patient in the Patient (#2) file VAFSTR Type: Input string of fields of the PID segment requested (separated by commas). VAFNUM Type: Input sequential number for SET ID (default=1) This entry point is passed three input parameters: 1) internal entry number of the PATIENT file 2) string of fields requested separated by commas 3) sequential number for SET ID (default=1) All three input parameters are used by this IA. ******************** 3016 NAME: EVN segment generation (CIRN PD) CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK INTEGRATED BILLING SCHEDULING INPATIENT MEDICATIONS 12/11/15-Added Inpatient Meds for Pharmacy Interface Automation (PIA) project USAGE: Controlled Subscri ENTERED: JAN 12,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this IA is to create a EVN segment when a patient is: 1) admitted 2) discharged 3) checked out of a clinic This segment is part of a HL7 message used by CIRN PD to DATE LAST TREATED (#.03) and the ADT/HL7 EVENT REASON (#.07) fields in the TREATING FACILITY LIST (#391.91) file. This is patient/facility specific information. ROUTINE: VAFHLEVN COMPONENT: $$EVN VARIABLES: TYPE Type: Input This variable represents the HL7 Event Type. FLAG Type: Input This variable represents the HL7 Event Reason Code. This entry point is passed two input parameters: 1) the HL7 Event Type 2) the HL7 Event Reason Code COMPONENT: $$EN(VAFEVTYP,VAFEVDT,VAFSTR,VAFHLQ,VAFHLFS) VARIABLES: VAFEVTYP Type: Input Event Type Code VAFEVDT Type: Input Event Date/Time. Date/Time Event Occurred (same as Encounter Date/Time) VAFSTR Type: Input String of fields requested separated by commas. VAFHLQ Type: Input Optional HL7 null variable. If not there, use default HL7 variable. VAFHLFS Type: Input Optional HL7 field separator. If not there, use default HL7 variable. EVN string Type: Output String containing desired components of the EVN segment. This entry point is used by Ambulatory Care Database Project This entry point is passed 5 input parameters: ******************** 3017 NAME: PD1 segment generator CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 12,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Supported call for building of HL7 PD1 segment (Patient Additional Demographics). ROUTINE: VAFHLPD1 COMPONENT: $$EN(DFN,VAFSTR) VARIABLES: DFN Type: Input Pointer to PATIENT file (#2) VAFSTR Type: Input String of fields requested seperated by commas HL7 variab Type: Input Call assumes that all HL7 variables returned from INIT^HLFNC2 are defined Result of Type: Output String of data forming the PD1 segment Main entry point for building of PD1 segment ******************** 3018 NAME: PV1 segment generator CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK LAB SERVICE USAGE: Supported ENTERED: JAN 12,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Supported calls for building of HL7 PV1 segment (Patient Visit) ROUTINE: VAFHLPV1 COMPONENT: $$EN(VAFENC,VAFDENC,VAFSTR,VAFNUM,VAFHLQ,VAFHLFS) VARIABLES: VAFENC Type: Input Pointer to Outpatient Encounter file (#409.68) VAFDENC Type: Input Pointer to Deleted Outpatient Encounter file (#409.74) VAFSTR Type: Input String of fields requested separated by commas VAFNUM Type: Input Value to use for Set ID (sequence #1). Defaults to 1. VAFHLQ Type: Input Optional HL7 null variable. (Default value is value of HLQ) VAFHLFS Type: Input Optional HL7 field separator. (Default value is value of HLFS) Result of Type: Output String of data forming the PV1 segment Entry point to build PV1 segment for [Deleted] Outpatient Encounter NOTE: Data for the PV1 segment will be retrieved from either the Outpatient Encounter file (#409.68) or Deleted Outpatient Encounter (#409.74) based on the pointer parameter passed in. COMPONENT: $$IN(DFN,VAFHDT,VAFSTR,IEN,PIVOT,SETID,.VAFDIAG) VARIABLES: DFN Type: Input Pointer to Patient file (#2) VAFHDT Type: Input Date/Time of movement VAFSTR Type: Input String of fields requested seperated by commas IEN Type: Input Pointer to Patient Movement file (#405). Optional - used for discharge movements since VADPT doesn't return enough information if only date/time (VAFHDT) is passed. ALTVISID Type: Input Value to use for Alternate Visit ID (sequence 50). Optional. SETID Type: Input Value to use for Set ID (sequence #1). Defaults to 1. VAFDIAG Type: Output Inpatient diagnosis returned in this variable. Result of Type: Output String of data forming the PV1 segment Entry point to build PV1 segment for inpatient movement. COMPONENT: $$OUT(DFN,EVT,EVDTS,VPTR,STRP,NUMP) VARIABLES: DFN Type: Input Pointer to Patient file (#2) EVT Type: Input Pivot number to build segment for. Value comes from the Pivot Number field (#.02) of ADT/HL7 Pivot file (#391.71). If passed, this value will also be used as the Alternate Visit ID (sequence #50). EVDTS Type: Input Event date/time in FileMan format. Only used if input parameter EVT is not passed/valid. VPTR Type: Input Variable pointer (FileMan format) to Patient file (#2), Patient Movement file (#405), or Outpatient Encounter file (#409.68). Only used if input parameter EVT is not passed/valid. STRP Type: Input String of fields requested seperated by commas. If value is "A" or null then all supported fields are returned. NUMP Type: Input Value to use for Set ID (sequence #1). Defaults to 1. Entry point to build PV1 segment for patient ******************** 3019 NAME: DG CHK BS5 XREF Y/N CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 20,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure CHECKS IF OTHER PATIENTS ON "BS5" XREF WITH SAME LAST NAME RETURNS 1 OR 0 IN 1ST STRING (OR -1 IF BAD DFN OR NO ZERO NODE) IF 1 RETURNS TEXT TO BE DISPLAYED ROUTINE: GUIBS5 DPTLK6 ******************** 3020 NAME: DG CHK BS5 XREF ARRAY CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure CHECKS IF OTHER PATIENTS ON 'BS5' XREF WITH SAME LAST NAME RETURN 1 OR 0 IN 1ST STRING (-1 IF BAD DFN OR NO ZERO NODE). RETURNS ARRAY NODES WHERE TEXT IS PRECEEDED BY 0 AND PATIENT DATA IS PRECEEDED BY 1. PATIENT DATA WILL BE IN FOLLOWING FORMAT: 1^DFN^PATIENT NAME^DOB^SSN ROUTINE: GUIBS5A DPTLK6 ******************** 3021 NAME: DG CHK MEANS TEST DIV DISPLAY CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure CHECKS DIVISION FILE FOR DIV USER IS IN IF MEANS TEST REQUIRED IS SET TO YES RETURNS 1 IN 1ST STRING AND MEANS TEST TEXT IN 2ND AND 3RD STRING (IF ANY) OTHERWISE RETURNS 0 IN 1ST STRING ROUTINE: GUIDMT DPTLK6 ******************** 3022 NAME: DG CHK PAT MEANS TEST REQUIRED CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure CHECKS WHETHER MEANS TEST IS REQUIRED FOR PATIENT RETURNS 1 OR 0 ROUTINE: GUIMT DPTLK6 ******************** 3023 NAME: DG CHK PAT/DIV MEANS TEST CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure CHECKS IF MEANS TEST REQUIRED FOR PATIENT AND CHECKS IF MEANS TEST DISPLAY REQUIRED FOR USER'S DIVISION RETURNS 1 IN 1ST STRING IF BOTH TRUE OTHERWISE 0 IF BOTH TRUE RETURNS TEXT IN 2ND AND 3RD STRING (IF ANY) ROUTINE: GUIMTD DPTLK6 ******************** 3027 NAME: Security/Sensitive Record access CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 31,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement provides 2 entry points in DGSEC4: PTSEC^DGSEC4 determines if patient's record is sensitive or if user is accessing his/her own Patient (#2) file record. NOTICE^DGSEC4 adds or updated the DG Security Log (#38.1) file and optionally generates the Sensitive Record Access mail message. ROUTINE: DGSEC4 COMPONENT: PTSEC VARIABLES: RESULT Type: Output The first parameter contains the name of the output array. DFN Type: Input DFN = Patient (#2) file IEN DGMSG Type: Input DGMSG = 1 - if message should be generated when a user's SSN is undefined. 0 - message will not be generated If not defined, defaults to 1. DGOPT Type: Input DGOPT is an optional variable containing the option name ^ menu text. If not defined, OP^XQCHK attempts to identify the option name. UNKNOWN will be entered in the DG Security Log file if option name not passed to call or not identified by OP^XQCHK. This entry point will: - verify user is not accessing his/her own PATIENT (#2) file record if Restrict Patient Record Access parameter in the MAS Parameter (#43) file is yes. - determine if record is sensitive - determine if patient's primary eligibility code is Employee. The following array is returned: RESULT(1)= -1 API failed Required variable not defined 0 No display and no action required Not an employee, not a sensitive record and user is not accessing his/her own Patient (#2) file record. 1 Display warning message Sensitive-inpatient or a DG SENSITIVITY key holder or an Employee and a DG SECURITY OFFICER key holder 2 Display warning message and require OK to continue Sensitive-not an inpatient and not a DG SENSITIVITY key holder or not an employee and not a DG SECURITY OFFICER key holder 3 Access to record denied Accessing own Patient (#2) file record 4 Access to Patient (#2) file records denied User's SSN not defined in New Person (#200) file RESULT(2-10)=error message or warning/Privacy Act message If RESULT(1)=1, an entry is added or updated to the DG SECURITY LOG (#38.1) file. If RESULT(1)=2 and user acknowledges they wish to access the restricted record, the calling application should call NOTICE^DGSEC4 to update DG Security Log (#38.1) file and generate the Sensitive Record Access mail message. COMPONENT: NOTICE VARIABLES: RESULT Type: Output RESULT=1 - Added/updated entry and generated sensitive record access msg 0 - unsuccessful DFN Type: Input DFN is a required parameter containing the Patient (#2) file IEN. DGOPT Type: Input DGOPT is an optional parameter containing the Option Name^Menu Text. If not defined, OP^XQCHK attempts to identify the option name. UNKNOWN will be entered in the DG SECURITY LOG file if option name not passed to call or not identified by OP^XQCHK. ACTION Type: Input ACTION = 1 - Set DG Security Log entry 2 - Generate Sensitive Record Access bulletin 3 - Both This is an optional parameter. If not defined, defaults to 3. This entry point adds or updates an entry to the DG SECURITY LOG (#38.1) file and optionally generate the sensitive record access bulletin depending on the value in the ACTION input parameter. If ACTION parameter is not defined, defaults to update DG Security Log file and generate Sensitive Record Access mail message. ******************** 3028 NAME: DBIA3028 CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: QUASAR Pointer to File #8930.3, USR Class Membership USAGE: Controlled Subscri ENTERED: JAN 31,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.3 ROOT: USR(8930.3 DESCRIPTION: TYPE: File QUASAR A&SP STAFF File, #509850.3, will point to USR CLASS MEMBERSHIP FILE, #8930.3. USR does not normally permit storing User Class memberships. Generally membership is checked on the fly using APIs to determine a permission, or checked and then a result is stored which does not point to the USR file. For example, the TIU document file has field COSIGNATURE NEEDED which stores the result of a lookup in the USR file and in TIU parameters. ^USR(8930.3 .01 MEMBER Pointed to ^USR(8930.3,0) .01 MEMBER Read w/Fileman ROUTINE: ******************** 3029 NAME: TRANSFER FACILITY CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY The information in this field will be used by the Continuous Improvement in Cardiac Surgery Program (CICSP). USAGE: Private ENTERED: FEB 3,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File This integration agreement grants permission to the subscribing package to read with FileMan the TRANSFER FACILITY field (#.05) in the PATIENT MOVEMENT file (#405). ^DGPM(D0,0) .05 TRANSFER FACILITY 0;5 Read w/Fileman ROUTINE: ******************** 3031 NAME: Remote RPCs CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 29,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This DBIA describes the Broker RPCs that provide the capability of running any application RPC on a remote system. They were developed to support the CPRS Remote Data Views project. NOTE: This 'Server to Server RPC' functionality is currently limited to sites that have implemented CIRN. CIRN makes it possible for an application to know a patient's current list of treating facilities. Furthermore, CIRN has assumed responsibility for supervising the proper configuration and activation of the VA network nodes that will be used for HL7 message exchange. XWB REMOTE RPC This is the RPC that is called to request that an application RPC be run on a remote system. The data is passed by HL7 to the remote system as is the return value. This RPC will return a HANDLE that can be used to check if the data has been sent back from the remote system. The HANDLE can be used in another RPC to check the status of the RPC. Parameters: (location,rpc name,[rpc version],[1 to 10 params to the RPC)) Return: The return value is always an array. The first node of the array is equal to a string that serves as a HANDLE. This is used to check the status of a RPC request and to retrieve the results of the RPC. In the case of an error condition, the first node of the array is equal to a string with the syntax "-1^error text". XWB REMOTE STATUS CHECK This RPC will return the status of a remote RPC. Parameters: The HANDLE from the XWB REMOTE RPC. Return: The return value is always an array. The first node of the array is equal to one of the following values: "-1^Bad Handle" - An invalid handle has been passed. "0^New" - The request has been sent. "0^Running" - HL7 indicates that the message is being processed. "1^Done" - RPC has completed and the data has returned to the local server. The data is not returned by this RPC. Use the XWB REMOTE GETDATA RPC to retrieve the data. The second node of the array is the status from the HL7 package. XWB REMOTE GETDATA This RPC will return an ARRAY with what ever data has been sent back from the remote site. Parameters: The HANDLE from the XWB REMOTE RPC. It is used to link the call to the data. Return: The return value is the array of data. In the event of an error condition, the first node of the array is equal to a string with the syntax "-1^error text". XWB REMOTE CLEAR This RPC is used to CLEAR the data under the HANDLE in the ^XTMP global. Parameters: The HANDLE from the XWB REMOTE RPC. Return: The return value is always an array. The first node of the array is equal to 1 ROUTINE: ******************** 3035 NAME: DBIA3035-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 29,2003 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 2 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V CPT (#9000010.18) file. The V CPT (#9000010.18) file is used to store CPT related services performed during a visit. ROUTINE: PXAAVCPT COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V CPT (#9000010.18) file with the patient visit IEN. $$GETIENS Type: Output If the value returned is equal to 0, no record was found in the V CPT (#9000010.18) file for the given visit IEN. If the value returned is equal to 1, one or more records were found in the V CPT (#9000010.18). Use this API to retrieve all Internal Entry Numbers (IEN) from the V CPT (#9000010.18) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. ARRAY Type: Input (required) All the field values of the V CPT (#9000010.18) file for the given record IEN such as; Patient Name, Diagnosis Field, Narrative Field, etc are loaded into this array variable. $$LOADFLDS Type: Output If the value returned is equal to 0, no record was found in the V CPT (#9000010.18) file for the given IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V CPT (#9000010.18) file. COMPONENT: $$CPT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$CPT Type: Output Returns the CPT code that most closely represents the clinical procedure performed on the patient during the encounter. This API returns field (#.01) - CPT, of the V CPT (#900018.10) file. The CPT code that most closely represents the clinical procedure performed on the patient during the encounter. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V CPT (#9000010.18) file. A pointer to the Patient Name to whom the procedure was performed. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file. This API returns field (#.03) - VISIT, of the V CPT (#9000010.18) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$PROVNARR(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$PROVNARR Type: Output A pointer to the Provider Narrative (#9999999.27) file. This API returns field (#.04) - PROVIDER NARRATIVE, of the V CPT (#9000010.18) file. A pointer to the Provider Narrative (#9999999.27) file. COMPONENT: $$DIAGNOSI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$DIAGNOSI Type: Output A pointer to the ICD Diagnosis (#80) file. This API returns field (#.05) - DIAGNOSIS, of the V CPT (#9000010.18) file. A pointer to the ICD Diagnosis (#80) file. COMPONENT: $$PRINPROC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$PRINPROC Type: Output Returns 'Y' if this procedure has been identified as the principal procedure done to the patient during the encounter. This API returns field (#.07) - PRINCIPAL PROCEDURE, of the V CPT (#9000010.18) file. A flag identifying whether this procedure was the principal procedure performed on the patient during the encounter. COMPONENT: $$QUANTITY(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$QUANTITY Type: Output The number of times this procedure was performed for the given visit. This API returns field (#.16) - QUANTITY, of the V CPT (#9000010.18) file. A number between 1 and 99 indicating how many times this procedure was performed. COMPONENT: $$CPTMODIF(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$CPTMODIF Type: Output A pointer to the CPT Modifier (#81.3) file. This API returns field (#1) - CPT MODIFIER, of the V CPT (#9000010.18) file. A pointer to the CPT Modifier (#81.3) file. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$EVENTDT Type: Output The Date and Time that the procedure took place. This API returns field (#1201) - EVENT DATE & TIME of the V CPT (#9000010.18) file, the date and time the procedure was performed. Note : This date and time may be different from the visit date and time. For example, for clinic appointment visits, the visit date and time is the date and time of the appointment, not the time the provider performed the clinical event. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$ORDEPROV Type: Output A value identifying the provider who ordered the procedure. This API returns field (#1202) - ORDERING PROVIDER of the V CPT (#9000010.18) file. Indicates identification of the provider who ordered the procedure. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$ENCOPROV Type: Output A value identifying the provider who performed the procedure. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V CPT (#9000010.18) file. Indicates the identification of the provider who performed the procedure. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$EDITFLAG Type: Output A value indicating if PCE detects that any original data as being edited. This API returns field (#80101) - EDITED FLAG, of the V CPT (#9000010.18) file. A value indicating if PCE detects that any original procedure data as being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V CPT (#9000010.18) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";". COMPONENT: $$PRONARCA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$PRONARCA Type: Output Returns a pointer to the Provider Narrative (#9999999.27) file which indicates the heading or category used to represent the provider narrative on the scanner form. This API returns field (#80201) PROVIDER NARRATIVE CATEGORY of the V CPT (#9000010.18) file. A pointer to the Provider Narrative (#9999999.27) file which is the heading or category used to represent the provider narrative on the scanner form. COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the procedure performed and entered manually. This API returns field (#81101) - COMMENTS, of the V CPT (#9000010.18) file. Any comments related to the procedure performed. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$VERIFIED Type: Output Returns '1' to indicate the record was Electronically Signed. Returns '0' to indicate that the record was Verified by the Package. This API returns field (#81201) - VERIFIED, of the V CPT (#9000010.18) file. A flag indicating whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V CPT (#9000010.18) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V CPT (#9000010.18) file. A pointer to the PCE Data Source (#839.7) file. COMPONENT: $$DIAGNOS2(IEN) VARIABLES: $$DIAGNOS2 Type: Output A pointer to the ICD Diagnosis (#80) file. IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns field (#.09) - DIAGNOSIS 2, of the V CPT (#9000010.18) file. A pointer to the ICD Diagnosis (#80) file. COMPONENT: $$DIAGNOS3(IEN) VARIABLES: $$DIAGNOS3 Type: Output Pointer to the ICD Diagnosis File (#80) IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns field (#.1) - DIAGNOSIS 3, of the V CPT (#9000010.18) file. A pointer to the ICD Diagnosis (#80) file. COMPONENT: $$DIAGNOS4(IEN) VARIABLES: $$DIAGNOS4 Type: Output Pointer to the ICD Diagnosis File (#80) IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns field (#.11) - DIAGNOSIS 4, of the V CPT (#9000010.18) file. A pointer to the ICD Diagnosis (#80) file. COMPONENT: $$SERVCONN(IEN) VARIABLES: $$SERVCONN Type: Output If this CPT code is treating a service connected problem IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns the Service Connected indicator, field (#80001), for this procedure. COMPONENT: $$AGENORAN(IEN) VARIABLES: $$AGENORAN Type: Output If this CPT code is treating an agent orange problem IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns the AGENT ORANGE EXPOSURE indicator, field (#80002), for this procedure COMPONENT: $$IONIRADI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$IONIRADI Type: Output If this CPT code is treating a problem related to an Ionizing Radiation Exposure This API returns the IONIZING RADIATION EXPOSURE indicator, field (#80003), for this procedure COMPONENT: $$ENVICONT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. $$ENVICONT Type: Output If this CPT code is treating a problem related to Environmental Contaminants This API returns the ENVIRONMENTAL CONTAMINANTS indicator, field (#80004), for this procedure COMPONENT: $$MILSXTRA(IEN) VARIABLES: $$MILSXTRA Type: Output If this CPT code is treating a problem related to Military Sexual Trauma IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns the MILITARY SEXUAL TRAUMA indicator, field (#80005), for this procedure COMPONENT: $$CANCERHN(IEN) VARIABLES: $$CANCERHN Type: Output If this CPT code is treating a problem related to Head/Neck Cancer IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V CPT (#9000010.18) file. This API returns the HEAD AND/OR NECK CANCER indicator, field (#80006), for this procedure ******************** 3036 NAME: HL7 APPLICATION PARAMETER LOOKUP CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: FEB 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 771 ROOT: HL(771, DESCRIPTION: TYPE: File This IA will allow MPI/PD to lookup an entry in the HL7 APPLICATION PARAMETER (#771) file using DBS FileMan calls. The IA is needed because of the release of two seperate but related patches. DG*5.3*261 exports the ADT/HL7 EVENT REASON (#391.72) file which has a field named HL7 APPLICATION PARAMETER (#.02). This field is a pointer to the HL7 APPLICATION PARAMETER (#771) file. Our data in ADT/HL7 EVENT REASON file is initially exported with the HL7 APPLICATION PARAMETER blank. The HL7 APPLICATION PARAMETER required for this field is being exported in RG*1.0*4. RG*1.0*4 adds the HL7 APPLICATION PARAMETER, and a post-install process adds that data to the ADT/HL7 EVENT REASON file. Our IA will permit our post-install process to lookup the new application with silent FileMan calls and subsequently add that data to the ADT/HL7 EVENT REASON file. ^HL(771,D0,0)=>Name (#.01) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3037 NAME: ADT/HL7 EVENT REASON (#391.72) file access CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: FEB 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 391.72 ROOT: VAT(391.72, DESCRIPTION: TYPE: File This IA allows the subscribing package to access the ADT/HL7 EVENT REASON (#391.72) file. ^VAT(391.72, .02 HL7 APPLICATION PARA 0;2 Both R/W w/Fileman This field, HL7 APPLICATION PARAMETER, is a pointer to the HL7 APPLICATION PARAMETER (#771) file. .01 EVENT REASON CODE 0;1 Read w/Fileman ROUTINE: ******************** 3038 NAME: DBIA3035-B CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V HEALTH FACTORS (#9000010.23) file. The V HEALTH FACTORS (#9000010.23) file is used for storing patient health factors identified during a visit. ROUTINE: PXAAVHF COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V HEALTH FACTORS (#9000010.23) file with the patient visit IEN, VSITIEN. $$GETIENS Type: Output If the value returned is equal to 0, no record was found in the V HEALTH FACTORS (#9000010.23) file for the given visit IEN. If the value returned is equal to 1, one or more records were found in the V HEALTH FACTORS (#9000010.23) file. Use this API to retrieve all Internal Entry Numbers (IEN) from the V HEALTH FACTORS (#9000010.23) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. ARRAY Type: Input (required) All the field values of the V HEALTH FACTORS (#9000010.23) file for the given record IEN such as; Patient Name, Health Factor, Event Date and Time, etc are loaded into this array variable. $$LOADFLDS Type: Output If the value returned is equal to 0, no record was found in the V HEALTH FACTORS (#9000010.23) file for the given IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given V HEALTH FACTORS (#9000010.23) record. COMPONENT: $$HEALFACT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$HEALFACT Type: Output A pointer to the Health Factor (#9999999.64) file. This API returns field (#.01) - HEALTH FACTOR, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the Health Factor (#9999999.64) file that most closely represents the patient's health factor status during the encounter for a given health factor category. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file. This API returns field (#.03) - VISIT, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$LEVESEVE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$LEVESEVE Type: Output 'M' - Minimal level of severity. 'MO' - Moderate level of severity. 'H' - Heavy/Severe level of severity. This API returns field (#.04) - LEVEL/SEVERITY, of the V HEALTH FACTORS (#9000010.23) file. This field indicates the Level/Severity of the patient's Health Factors identified during the visit. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$EVENTDT Type: Output The Date and Time that the procedure took place. This API returns field (#1201) - EVENT DATE & TIME, of the V HEALTH FACTORS (#9000010.23) fil. The date and time the health factor was recorded by the provider. Note : This date and time may be different from the visit date and time. For example, for clinic appointment visits, the visit date and time is the date and time of the appointment, not the time the provider performed the clinical event. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who ordered this health factor to be recorded. This API returns field (#1202) - ORDERING PROVIDER, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered this health factor to be recorded. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who recorded the health factor. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the NEW PERSON (#200) file identifying the provider who recorded the health factor. COMPONENT: $$EDITED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$EDITED Type: Output Returns '1' indicating if PCE detects that any original data is being edited. This API returns field (#80101) - EDITED FLAG, of the V HEALTH FACTORS (#9000010.23) file. A value indicating if PCE detects that any original health factor data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V HEALTH FACTORS (#9000010.23) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";". COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the patient's health factors. This API returns field (#81101) - COMMENTS, of the V HEALTH FACTORS (#9000010.23) file. Any comments related to the patient's health factors. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$VERIFIED Type: Output 1 - Electronically Signed. 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V HEALTH FACTORS (#9000010.23) file. A flag indicating whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V HEALTH FACTORS (#9000010.23) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V HEALTH FACTORS (#9000010.23) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3039 NAME: TIU GET STATUS LIST CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: FEB 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API returns the list of allowable signature statuses supported by TIU. ROUTINE: TIUSRVL COMPONENT: STATUS VARIABLES: Y Type: Output This array is passed by reference from the calling application as the only actual parameter to the subroutine. As such, it must be declared in the namespace () of the calling application (ref. SAC 2.3.1.10.1). The call from CPRS looks Like this: D STATUS^TIUSRVL(.ORY) and returns the ORY array with the following contents: ORY(2)=8^amended ORY(3)=7^completed ORY(4)=14^deleted ORY(6)=9^purged ORY(7)=15^retracted ORY(9)=6^uncosigned ORY(10)=1^undictated ORY(11)=3^unreleased ORY(12)=5^unsigned ORY(13)=2^untranscribed ORY(14)=4^unverified This subroutine may be called with an array, passed by reference, in which the list of statuses will be returned in alphabetical order. ******************** 3040 NAME: Direct set DD node CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION A limited integration agreement which allows the setting of the ^DD(file,0,"ACT") node for the PATIENT file (#2) directly from a post-init in a DG patch. Specifically, S ^DD(2,0,"ACT")="I '$G(DICR),$G(DIC(0))'[""I"" D ^DGSEC" This change will allow DIC lookups where DIC(0) contains "I" to avoid both the LOOK-UP PROGRAM and the POST-SELECTION ACTION defined for the file. USAGE: Private ENTERED: FEB 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Agreement allowing the direct setting of the ^DD(file,0,"ACT") node. ROUTINE: ******************** 3041 NAME: ACCESS TO FILE 20 NAME COMPONENTS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION INCOME VERIFICATION MATCH Used with HEC'S MASTER CLIENT file 300.12 VISTALINK SECURITY HEALTHEVET DESKTOP USAGE: Controlled Subscri ENTERED: FEB 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 20 ROOT: VA(20 DESCRIPTION: TYPE: File All fields can be accessed/edited using FileMan tools. Each entry in the NAME COMPONENTS file (#20) corresponds to a single source name field in another file. The following three fields in the NAME COMPONENTS file contain information about the source name field. These three fields comprise the Primary Key for the NAME COMPONENTS file. .01 File Number of file that contains source name field .02 Field Number of the field that contains the source name field .03 IENS (Internal Entry Number string) of the record that contains the name to which this entry corresponds. The name field in the source file should have cross-references that keep its value in synchronization with the corresponding entry in the NAME COMPONENTS file. For an example of this, see the .01 field of the NEW PERSON file. The following fields are normally available for editing by end-users. Field # Name 1 FAMILY (LAST) NAME 2 GIVEN (FIRST) NAME 3 MIDDLE NAME 4 PREFIX (ex., MR, MS) 5 SUFFIX (ex., JR, III, ESQ) 6 DEGREE (ex., PHD) (The DEGREE and PREFIX field are not part of the source name field (#.01) of the NEW PERSON file.) Kernel APIs that return the name components are available. When any of the following fields in the NAME COMPONENTS file are edited via FileMan tools: Field # Name .01 FILE .02 FIELD .03 IENS 1 FAMILY (LAST) NAME 2 GIVEN (FIRST) NAME 3 MIDDLE NAME 5 SUFFIX 7 SOURCE NAME FORMAT FLAGS the "ANAME" MUMPS cross-reference automatically updates the corresponding source name field in the source file to reflect the changes. To prevent this cross-reference from firing, you can NEW the variable XUNOTRIG and SET it to 1 before editing the any of the above fields. ^VA(20,D0,0) .01 FILE 0;1 Both R/W w/Fileman .02 FIELD 0;2 Both R/W w/Fileman .03 IENS 0;3 Both R/W w/Fileman ^VA(20,D0,1) 1 FAMILY (LAST) NAME 1;1 Both R/W w/Fileman 2 GIVEN (FIRST) NAME 1;2 Both R/W w/Fileman 3 MIDDLE NAME 1;3 Both R/W w/Fileman 4 PREFIX 1;4 Both R/W w/Fileman 5 SUFFIX 1;5 Both R/W w/Fileman 6 DEGREE 1;6 Both R/W w/Fileman 7 SOURCE NAME FORMAT F 1;7 Both R/W w/Fileman ^VA(20,D0,11) 11 NOTES ABOUT NAME 11;1 Both R/W w/Fileman ROUTINE: ******************** 3042 NAME: SINGLE PROCEDURE DISPLAY API CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: FEB 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA authorizes CONSULT/REQUEST TRACKING to call ^MCAPI for the purpose of retrieving a single patient procedure and displaying the selected procedure in the Consult/Request Tracking Package. ROUTINE: MCAPI COMPONENT: EN(RESULT,FLG) VARIABLES: RESULT Type: Input (required) = "IEN;ROOT" (e.g. "12;MCAR(691.5," IEN is the file number of the desired patient procedure. ROOT is the global root of the medicine file containing the desired Patient procedure. FLG Type: Input (required) =1 if report is to contain a modified header omitting the patient's information. Any other value in the variable FLG will result in the report containing the patient's information in the header. REPORT Type: Output = Modified display of a single patient procedure. The display is defined by the input variables and is to be displayed in the Consult/Request Tracking Package. Produces a modified display for a single patient procedure that omits the patient's information from the header. This call is used in conjunction with another call to a medicine routine. $$SINGLE^MCAPI => gets patient related data. COMPONENT: $$SINGLE(RESULT) VARIABLES: RESULT Type: Input (required) = "IEN;ROOT" (e.g. "12;MCAR(691.5," IEN is the file number of the desired patient procedure. ROOT is the global root of the medicine file containing the desired patient procedure. VARIABLE Type: Output Variable containing a single patient procedure for display by Consult/ Request Tracking. This reference is used as input for the modified patient display. $P(VARIABLE,U,1)=Print Name ...),U,2)=Pointer to Procedure ...),U,3)=Print Line ...),U,4)=Print Routine ...),U,5)=Print Name ...),U,6)=Date/Time of procedure ...),U,7)=Gross Evaluation ...),U,10)=Summary Title ...),U,11)=Procedure ...),U,12)=Pointer to Procedure ...),U,13)=Patient DFN Allows the retrieval of a single patient procedure. (e.g. S VARIABLE=$$SINGLE(RESULT)) ******************** 3043 NAME: DBIA3035-C CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V IMMUNIZATION (#9000010.11) file. The V IMMUNIZATION (#9000010.11) file is used to store immunizations specific to a particular visit for a particular patient. This file contains one record for each immunization. ROUTINE: PXAAVIMM COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V IMMUNIZATION (#9000010.11) file with the patient visit IEN. $$GETIENS Type: Output Returns '0' if no records were found in the V IMMUNIZATION (#9000010.11) file for the given visit IEN. Returns '1' if one or more records were found in the V IMMUNIZATION (#9000010.11) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V IMMUNIZATION (#9000010.11) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$LOADFLDS Type: Output Returns '0' if no records were found in the V IMMUNIZATION (#9000010.11) file for the given IEN. Returns '1' if the API has successfully loaded all the field values into the ARRAY variable. ARRAY Type: Input (required) All the field values of the V IMMUNIZATION (#9000010.11) file for the given record IEN such as; Patient Name, Immunization, Comments, etc are loaded into this array variable. This API loads all the field values for a given record IEN in the V IMMUNIZATION (#9000010.11) file. COMPONENT: $$IMMUNIZA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$IMMUNIZA Type: Output (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. This API returns field (#.01) - IMMUNIZATION, of the V IMMUNIZATION (#9000010.11) file. A pointer to the IMMUNIZATION (#9999999.14) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V IMMUNIZATION (#9000010.11) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file indicating the date and time when the immunization was given. This API returns field (#.03) - VISIT, of the V IMMUNIZATION (#9000010.11) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$SERIES(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$SERIES Type: Output P - Partially Complete, C - Complete, B - Booster, 1 - Series 1, 2 - Series 2, 3 - Series 3, 4 Series 4, 5 - Series 5, 6 - Series 6, 7 - Series 7, 8 -Series 8 This API returns field (#.04) - SERIES, of the V IMMUNIZATION (#9000010.11) file. This field specifies which series of immunization types were given to the patient. COMPONENT: $$REACTION(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$REACTION Type: Output 0 - NONE,1 - FEVER, 2 - IRRITABILITY, 3 - LOCAL REACTION OR SWELLING, 4 - VOMITING, 5 - RASH OR ITCHING, 6 - LETHARGY, 7 - CONVULSIONS, 8 - ARTHRITIS or ARTHRALGIAS, 9 - ANAPHYLAXIS or COLLAPSE, 10 - RESPIRATORY DISTRESS, 11 - OTHER This API returns field (#.06) - REACTION, of the V IMMUNIZATION (#9000010.11) file. This field represents the patients reaction to the immunization. COMPONENT: $$CONTRAIN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$CONTRAIN Type: Output Returns '0' to indicate that the immunization was not recorded as contraindicated. Returns '1' to indicate that the immunization was recorded as contraindicated. This API returns field (#.07) - CONTRAINDICATED, of the V IMMUNIZATION (#9000010.11) file. Indicates whether the immunization was recorded as contraindicated. COMPONENT: $$REMARKS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$REMARKS Type: Output Additional comments or remarks related to the immunization given to the patient. This API returns field (#1101) - REMARKS, of the V IMMUNIZATION (#9000010.11) file. Additional comments or remarks related to the immunization given to the patient. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$EVENTDT Type: Output The date and time the immunization was given. This API returns field (#1201) - EVENT DATE & TIME, of the V IMMUNIZATION (#9000010.11) file. The date and time the immunization was given. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who ordered this immunization. This API returns field (#1202) - ORDERING PROVIDER, of the V IMMUNIZATION (#9000010.11) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered this immunization. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who administered the immunization. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V IMMUNIZATION (#9000010.11) file. A pointer to the NEW PERSON (#200) file identifying the provider who administered the immunization. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original immunization data is being edited. This API returns field (#80101) - EDITED FLAG, of the V IMMUNIZATION (#9000010.11) file. This field indicates if PCE detects that any original immunization data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V IMMUNIZATION (#9000010.11) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the immunization. This API returns field (#81101) - COMMENTS, of the V IMMUNIZATION (#9000010.11) file. Any comments related to the procedure performed. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$VERIFIED Type: Output 1 - Electronically Signed, 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V IMMUNIZATION (#9000010.11) file. This field indictaes whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V IMMUNIZATION (#9000010.11) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V IMMUNIZATION (#9000010.11) file A pointer to the PCE Data Source (#839.7) file. ******************** 3044 NAME: DBIA3035-D CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V MEASUREMENT (#9000010.01) file. The V MEASUREMENT (#9000010.01) file is used to store measurements such as; weight, height, blood pressure, etc., taken by a health professional during an outpatient encounter. ROUTINE: PXAAVMSR COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V MEASUREMENT (#9000010.01) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V MEASUREMENT (#9000010.01) file for the given visit IEN. Returns 1 if one or more records were found in the V MEASUREMENT (#9000010.01) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V MEASUREMENT (#9000010.01) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. ARRAY Type: Input (required) All the field values of the V MEASUREMENT (#9000010.01) file for the given record IEN such as; weight, height, blood pressure, etc $$LOADFLDS Type: Output Returns 0 if no record was found in the V MEASUREMENT (#9000010.01) file for the given IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V MEASUREMENT (#9000010.01) file. COMPONENT: $$TYPE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$TYPE Type: Output A pointer to the MEASUREMENT TYPE (#9999999.07) file. This API returns field (#.01) - TYPE, of the V MEASUREMENT (#9000010.01) file. A pointer to the MEASUREMENT TYPE (#9999999.07) file which indicates the type of measurement taken on the patient. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V MEASUREMENT (#9000010.01) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file indicating the date and time the immunization was given. This API returns field (#.03) - VISIT, of the V MEASUREMENT (#9000010.01) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$VALUE(IEN) VARIABLES: $$VALUE Type: Output The value of the measurement taken on the patient. IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. This API returns field (#.04) - VALUE, of the V MEASUREMENT (#9000010.01) file. This field specifies the value of the measurement taken on the patient. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$EVENTDT Type: Output The date and time the measurement was taken by the provider. This API returns field (#1201) - EVTN DATE & TIME, of the V MEASUREMENT (#9000010.01) file. The date and time the measurement was taken by the provider. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who ordered the measurement to be taken. This API returns field (#1202) - ORDERING PROVIDER, of the V MEASUREMENT (#9000010.01) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the measurement. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who took the measurement. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V MEASUREMENT (#9000010.01) file. A pointer to the NEW PERSON (#200) file identifying the provider who took the measurement. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original measurement data is being edited. This API returns field (#80101) - EDITED FLAG, of the V MEASUREMENT (#9000010.01) file. This field indicates if PCE detects that any original measurement data is being edited. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#80102) - DATA SOURCE, of the V MEASUREMENT (#9000010.01) file. A pointer to the PCE Data Source (#839.7) file. COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V MEASUREMENT (#9000010.01) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the Measurements taken during the encounter. This API returns field (#81101) - COMMENTS, of the V HEALTH FACTORS (#9000010.23) file. Any comments related to the measurements taken during the encounter. ******************** 3045 NAME: DBIA3035-E CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V PATIENT ED (#9000010.16) file. The V PATIENT ED (#9000010.16) file is used to store stores the patient education given to a patient or his responsible care given. ROUTINE: PXAAVPED COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V PATIENT ED (#9000010.16) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V PATIENT ED (#9000010.16) file for the given visit IEN. Returns 1 if one or more records were found in the V PATIENT ED (#9000010.16) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V PATIENT ED (#9000010.16) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. ARRAY Type: Input (required) Loads all the field values of the V PATIENT ED (#9000010.16) file for the given record IEN such as; Patient Name, Topic, Level of Understanding. $$LOADFLDS Type: Output Returns 0 if no record was found in the V PATIENT ED (#9000010.16) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V PATIENT ED (#9000010.16) file. COMPONENT: $$TOPIC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$TOPIC Type: Output A pointer to the EDUCATION TOPICS (#9999999.09) file. This API returns field (#.01) - TOPIC, of the V PATIENT ED (#9000010.16) file. A pointer to the EDUCATION TOPICS (#9999999.09) file indicating the education given to the patient. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V PATIENT ED (#9000010.16) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file indicating the date and time when the immunization was given. This API returns field (#.03) - VISIT, of the V PATIENT ED (#9000010.16) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$LEVEOFUN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$LEVEOFUN Type: Output 1 - POOR, 2 - FAIR, 3 - GOOD, 4 - GROUP-NO ASSESSMENT, 5 - REFUSED. This API returns field (#.06) - LEVEL OF UNDERSTANDING, of the V PATIENT ED (#9000010.16) file. A number which best rates the patient's level of understanding of the education given. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$EVENTDT Type: Output The date and time the patient education was given. This API returns field (#1201) - EVENT DATE & TIME, of the V PATIENT ED (#9000010.16) file. The date and time the patient education was given. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who ordered the patient education. This API returns field (#1202) - ORDERING PROVIDER, of the V PATIENT ED (#9000010.16) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the patient education. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who gave the patient education. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V PATIENT ED (#9000010.16) file. A pointer to the NEW PERSON (#200) file identifying the provider who gave the patient education. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original exam data is being edited. This API returns field (#80101) - EDITED FLAG, of the V PATIENT ED (#9000010.16) file. This field indicates if PCE detects that any original exam data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V PATIENT ED (#9000010.16) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit _" "_DUZ of the person who entered the data_";" COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the patient's education. This API returns field (#81101) - COMMENTS, of the V PATIENT ED (#9000010.16) file. Any comments related to the patient's education. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$VERIFIED Type: Output 1 - Electronically Signed, 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V PATIENT ED (#9000010.16) file. This field flag indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V PATIENT ED (#9000010.16) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PATIENT ED (#9000010.16) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V PATIENT ED (#9000010.16) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3046 NAME: DBIA3035-F CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V POV (#9000010.07) file. The V POV (#9000010.07) file is used to store clinical data related to the "purpose of visit" or "problem of visit", (POV). ROUTINE: PXAAVPOV COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V POV (#9000010.07) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V POV (#9000010.07) file for the given visit IEN. Returns 1 if one or more records were found in the V POV (#9000010.07) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V POV (#9000010.07) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. ARRAY Type: Input (required) All the field values of the V POV (#9000010.07) file for the given record IEN such as; Patient Name Provider Narrative, Modifier, etc $$LOADFLDS Type: Output Returns 0 if no record was found in the V POV (#9000010.07) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V POV (#9000010.07) file. COMPONENT: $$POV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$POV Type: Output A pointer to the ICD DIAGNOSIS (#80) file which indicates the ICD Diagnosis code or text for the problem treated at the encounter. This API returns field (#.01) - PURPOSE OF VISIT, of the V POV (#9000010.07) file. A pointer to the ICD DIAGNOSIS (#80) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V POV (#9000010.07) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file. This API returns field (#.03) - VISIT, of the V POV (#9000010.07) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$PROVNARR(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PROVNARR Type: Output A pointer to the PROVIDER NARRATIVE (#9999999.27) file. This API returns field (#.04) - PROVIDER NARRATIVE, of the V POV (#9000010.07) file. A pointer to the PROVIDER NARRATIVE (#9999999.27) file indicating the providers text describing the diagnosis that was treated at the visit. COMPONENT: $$MODIFIER(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$MODIFIER Type: Output 'C' - CONSIDER, 'D' - DOUBTFUL, 'F' - FOLLOW UP, 'M' - MAYBE , POSSIBLE, PERHAPS, 'O' - RULE OUT, 'P' - PROBABLE, 'R' - RESOLVED, 'S' - SUSPECT, SUSPICIOUS, 'T' - STATUS POST This API returns field (#.06) - MODIFIER, of the V POV (#9000010.07) file. This field indicates how the provider may modify the diagnosis or problem treated to reflect the status of the diagnosis as of this visit. COMPONENT: $$PRIMSECO(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PRIMSECO Type: Output 'P' - PRIMARY, 'S' - SECONDARY This API returns field (#.12) - PRIMARY/SECONDARY, of the V POV (#9000010.07) file. This field represents the clinically pertinent ranking of problems treated. COMPONENT: $$DATEOFIN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$DATEOFIN Type: Output The date the injury occurred for the problem being treated. This API returns field (#.13) - DATE OF INJURY, of the V POV (#9000010.07) file. The date the injury occurred for the problem being treated. COMPONENT: $$CLINTERM(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$CLINTERM Type: Output A pointer to the EXPRESSIONS (#757.01) file. This API returns field (#.15) - CLINICAL TERM of the V POV (#9000010.07) file. A pointer to the EXPRESSIONS (#757.01) file which indicates the field in the clinical lexicon term which most closely represents the provider narrative of the problem treated. COMPONENT: $$PROLISEN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PROLISEN Type: Output A pointer to the PROBLEM (#9000011) file. This API returns field (#.16) - PROBLEM LIST ENTRY, of the V POV (#9000010.07) file. A pointer to the PROBLEM (#9000011) file which identifies the Problem List Entry related to the problem treated at the visit. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$EVENTDT Type: Output The date and time the problem was treated. This API returns field (#1201) - EVENT DATE AND TIME, of the V POV (#9000010.07) file. The date and time the problem was treated. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who ordered the problem to be treated. This API returns field (#1202) - ORDERING PROVIDER, of the V POV (#9000010.07) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the problem to be treated. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who treated the problem. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V POV (#9000010.07) file. A pointer to the NEW (#200) file identifying the provider who treated the problem. COMPONENT: $$SERVCONN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$SERVCONN Type: Output 1 - YES, 0 - NO This API returns field (#80001) - SERVICE CONNECTED, of the V POV (#9000010.07) file. This field indicates whether the problem treated was service connected. COMPONENT: $$AGEORAEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$AGEORAEX Type: Output 1 - YES, 0 - NO This API returns field (#80002) - AGENT ORANGE EXPOSURE, of the V POV (#9000010.07) file. This field indicates if the problem treated is related to Agent Orange exposure. COMPONENT: $$IONRADEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$IONRADEX Type: Output 1 - YES, 0 - NO This API returns field (#80003) - IONIZING RADIATION EXPOSURE, of the V POV (#9000010.07) file. This field indicates if the problem treated is related to Ionizing Radiation exposure. COMPONENT: $$PERGULEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PERGULEX Type: Output 1 - YES, 0 - NO This API returns field (#80003) - PERSIAN GULF EXPOSURE, of the V POV (#9000010.07) file. This field indicates if the problem treated is related to Persian Gulf exposure. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original exam data is being edited. This API returns field (#80101) - EDITED FLAG, of the V POV (#9000010.07) file. This field indicates if PCE detects that any original exam data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V POV (#9000010.07) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" COMPONENT: $$PRONARCA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PRONARCA Type: Output A pointer to the PROVIDER NARRATIVE (#9999999.27) file. This API returns field (#80201) - PROVIDER NARRATIVE CATEGORY, of the V POV (#9000010.07) file. A pointer to the PROVIDER NARRATIVE (#9999999.27) file indicating the category narrative related to the problem treated. COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the purpose of visit. This API returns field (#81101) - COMMENTS, of the V POV (#9000010.07) file. Any comments related to the purpose of visit. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$VERIFIED Type: Output 1 - Electronically Signed, 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V POV (#9000010.07) file. This field indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V POV (#9000010.07) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V POV (#9000010.07) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V POV (#9000010.07) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3047 NAME: DBIA3035-G CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V PROVIDER (#9000010.06) file. This file, along with a Purpose of Visit (POV), is required for each patient encounter at a facility. ROUTINE: PXAAVPRV COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V PROVIDER (#9000010.06) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V PROVIDER (#9000010.06) file for the given visit IEN. Returns 1 if one or more records were found in the V PROVIDER (#9000010.06) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V PROVIDER (#9000010.06) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. ARRAY Type: Input (required) All the field values of the V PROVIDER (#9000010.06) file for the given record IEN such as; Patient Name, Provider Narrative, Modifier, etc $$LOADFLDS Type: Output Returns 0 if no record was found in the V PROVIDER (#9000010.06) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V PROVIDER (#9000010.06) file. COMPONENT: $$PROVIDER(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$PROVIDER Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#.01) - PROVIDER, of the V PROVIDER (#9000010.06) file. A pointer to the NEW PERSON (#200) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V PROVIDER (#9000010.06) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file indicating the date and time when the immunization was given. This API returns field (#.03) - VISIT, of the V PROVIDER (#9000010.06) file. A pointer to the VISIT (#9000010) file. COMPONENT: $$PRIMSECO(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$PRIMSECO Type: Output Returns 'P' - PRIMARY or 'S' - SECONDARY This API returns field (#.04) - PRIMARY/SECONDARY, of the V PROVIDER (#9000010.06) file. This field indicates that the provider was the primary or secondary care giver for the encounter. COMPONENT: $$OPERATTE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$OPERATTE Type: Output Returns 'A' - ATTENDING or 'O' - OPERATING. This API returns field (#.05) - OPERATING/ATTENDING, of the V PROVIDER (#9000010.06) file. This field indicates whether the provider was Operating or Attending. COMPONENT: $$PERSCLAS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$PERSCLAS Type: Output A pointer to the PERSON CLASS (#8932.1) file. This API returns field (#.06) - PERSON CLASS, of the V PROVIDER (#9000010.06) file. This field indicates class of the provider at the time of the encounter and is a pointer to the PERSON CLASS (#8932.1) file. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$EVENTDT Type: Output The date and time the provider had the encounter with the patient. This API returns field (#1201) - EVENT DATE AND TIME, of the V PROVIDER (#9000010.06) file. The date and time the provider had the encounter with the patient. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original provider data is being edited. This API returns field (#80101) - EDITED FLAG, of the V PROVIDER (#9000010.06) file. This field indicates if PCE detects that any original provider data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V PROVIDER (#9000010.06) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" " _DUZ of the person who entered the data_";" COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the patient's provider. This API returns field (#81101) - COMMENTS, of the V PROVIDER (#9000010.06) file. Any comments related to the patient's provider. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$VERIFIED Type: Output Returns 1 - Electronically Signed or 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V PROVIDER (#9000010.06) file. This field indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V PROVIDER (#9000010.06) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V PROVIDER (#9000010.06) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3048 NAME: DBIA3035-H CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the VISIT (#9000010) file. The VISIT (#9000010) file contains a record of all patient visits at health care facilities or by health care providers, including direct outpatient and clinic visits, as well as inpatient encounters with providers of care. ROUTINE: PXAAVSIT COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. ARRAY Type: Input (required) All the field values of the VISIT (#9000010) file for the given record IEN such as; Patient Name, Provider Narrative, Modifier, etc. $$LOADFLDS Type: Output Returns 0 if no record was found in the VISIT (#9000010) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the VISIT (#9000010) file. COMPONENT: $$VISADDAT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$VISADDAT Type: Output The date and time of the visit. This API returns field (#.01) - VISIT/ADMIT DATE AND TIME, of the VISIT (#9000010) file. The date and time of the visit. COMPONENT: $$DATVISCR(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DATVISCR Type: Output The date and time of the visit was created. This API returns field (#.02) - DATE VISIT CREATED, of the VISIT (#9000010) file. COMPONENT: $$TYPE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$TYPE Type: Output Returns; 'I' - HIS, 'C' - CONTRACT, 'T' - TRIBAL, 'O' - OTHER, '6' - 638 PROGRAM, 'V' - VA This API returns field (#.03) - VISIT TYPE, of the VISIT (#9000010) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.05) - PATIENT NAME, of the VISIT (#9000010) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$LOCOFENC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$LOCOFENC Type: Output A pointer to the LOCATION (#9999999.06) file. This API returns field (#.06) - LOCATION OF ENCOUNTER, of the VISIT (#9000010) file. A pointer to the LOCATION (#9999999.06) file. COMPONENT: $$SERVCATE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$SERVCATE Type: Output Returns; 'A' - AMBULATORY, 'H' - HOSPITALIZATION, 'I' - IN HOSPITAL, 'C' - CHART REVIEW, 'T' - TELECOMMUNICATIONS, 'N' - NOT FOUND, 'S' - DAY SURGERY, 'O' - OBSERVATION, 'E' - EVENT (HISTORICAL), 'R' - NURSING HOME, 'D' - DAILY HOSPITALIZATION DATA, 'X' - ANCILLARY PACKAGE DAILY DATA This API returns field (#.07) - SERVICE CATEGORY, of the VISIT (#9000010) file. COMPONENT: $$DSSID(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DSSID Type: Output A pointer to the CLINIC STOP (#40.7) file. This API returns field (#.08) - DSS ID, of the VISIT (#9000010) file. A pointer to the CLINIC STOP (#40.7) file and indicates the organized clinic in which this visit took place. COMPONENT: $$DEPENTCO(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DEPENTCO Type: Output A number representing how many "V" file entries are pointing to this visit. This API returns field (#.09) - DEPENDENT ENTRY COUNT, of the VISIT (#9000010) file. A number representing how many "V" file entries are pointing to this visit. COMPONENT: $$DELEFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DELEFLAG Type: Output Returns; '1' - YES or '0' - NO. This API returns field (#.11) - DELETE FLAG, of the VISIT (#9000010) file. Flag set to signify that the visit has been deleted. COMPONENT: $$PARVISLI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PARVISLI Type: Output A pointer to the VISIT (#9000010) file. This API returns field (#.12) - PARENT VISIT LINK, of the VISIT (#9000010) file. A pointer to the VISIT (#9000010) file, the PARENT VISIT LINK field points back to the VISIT file. COMPONENT: $$DATLASMO(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DATLASMO Type: Output Date last modified. This API returns field (#.13) - DATE LAST MODIFIED, of the VISIT (#9000010) file. COMPONENT: $$CHEOUDAT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$CHEOUDAT Type: Output Check out date and time. This API returns field (#.18) - CHECK OUT DATE AND TIME, of the VISIT (#9000010) file. COMPONENT: $$ELIGIBIL(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$ELIGIBIL Type: Output A pointer to the ELIGIBILITY CODE (#8) file. This API returns field (#.21) - ELIGIBILITY, of the VISIT (#9000010) file. A pointer to the ELIGIBILITY CODE (#8) file which defines the patient's eligibility for this visit. COMPONENT: $$HOSPLOCA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$HOSPLOCA Type: Output A pointer to the HOSPITAL LOCATION (#44) file. This API returns field (#.22) - HOSPITAL LOCATION, of the VISIT (#9000010) file. A pointer to the HOSPITAL LOCATION (#44) file. COMPONENT: $$CREABYUS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$CREABYUS Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#.23) - CREATED BY USER, of the VISIT (#9000010) file. A pointer to the NEW PERSON (#200) file, indicating the name of the user who created this visit entry. COMPONENT: $$OPTUSTOC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$OPTUSTOC Type: Output A pointer to the OPTION (#19) file. This API returns field (#.24) - OPTION USED TO CREATE, of the VISIT (#9000010) file. A pointer to the OPTION (#19) file, indicating the option which was used to create the visit. COMPONENT: $$PROTOCOL(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PROTOCOL Type: Output A pointer to the PROTOCOL (#101) file. This API returns field (#.25) - PROTOCOL, of the VISIT (#9000010) file. A pointer to the PROTOCOL (#101) file, indicating the protocol which was used to create the visit. COMPONENT: $$OUTSLOCA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$OUTSLOCA Type: Output Free text indicating the location of service. This API returns field (#2101) - OUTSIDE LOCATION, of the VISIT (#9000010) file. COMPONENT: $$VISITID(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$VISITID Type: Output Visit ID. This API returns field (#15001) - VISIT ID, of the VISIT (#9000010) file. A unique visit id and is set by Visit Tracking and cannot be changed. COMPONENT: $$PATSTINO(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PATSTINO Type: Output Returns; '1' - IN or '0' - OUT. This API returns field (#15002) - PATIENT STATUS IN/OUT, of the VISIT (#9000010) file. An indicator of the patient's status at the time of the visit. COMPONENT: $$ENCOTYPE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$ENCOTYPE Type: Output Returns; 'P' - PRIMARY, 'O' - OCCASION OF SERVICE, 'S' - STOP CODE, 'A' - ANCILLARY, 'C' - CREDIT STOP This API returns field (#15003) - ENCOUNTER TYPE, of the VISIT (#9000010) file. COMPONENT: $$SERVCONN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$SERVCONN Type: Output Returns; 1 - YES or 0 - NO. This API returns field (#80001) - SERVICE CONNECTED, of the VISIT (#9000010) file. This field indicates whether the problem treated was service connected. COMPONENT: $$AGEORAEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$AGEORAEX Type: Output Returns; 1 - YES or 0 - NO. This API returns field (#80002) - AGENT ORANGE EXPOSURE, of the VISIT (#9000010) file. This field indicates if the problem treated is related to Agent Orange exposure. COMPONENT: $$IONRADEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$IONRADEX Type: Output Returns; 1 - YES or 0 - NO. This API returns field (#80003) - IONIZING RADIATION EXPOSURE, of the VISIT (#9000010) file. This field indicates if the problem treated is related to Ionizing Radiation Exposure. COMPONENT: $$PERGULEX(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PERGULEX Type: Output Returns; 1 - YES or 0 - NO. This API returns field (#80003) - PERSIAN GULF EXPOSURE, of the VISIT (#9000010) file. This field indicates if the problem treated is related to Persian Gulf Exposure. COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the purpose of visit. This API returns field (#81101) - COMMENTS, of the VISIT (#9000010) file. Any comments related to the purpose of visit. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the VISIT (#9000010) file. A pointer to the PCE Data Source (#839.7) file. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the VISIT (#9000010) file. A pointer to the Package (#9.4) file. COMPONENT: $$MLTYSXTR(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the VISIT (#9000010) file. $$MLTYSXTR Type: Output Returns; 1 - YES or 0 - NO This API returns field (#80005) - MILITARY SEXUAL TRAUMA, of the VISIT (#9000010) file. This field indicates if the problem treated is related to Military Sexual Trauma. ******************** 3049 NAME: DBIA3035-I CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V SKIN TEST (#9000010.12) file. The V SKIN TEST (#9000010.12) file stores record details for each type of skin test given to a patient on a given visit. ROUTINE: PXAAVSK COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V SKIN TEST (#9000010.12) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V SKIN TEST (#9000010.12) file for the given visit IEN. Returns 1 if one or more records were found in the V SKIN TEST (#9000010.12) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V SKIN TEST (#9000010.12) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. ARRAY Type: Input (required) All the field values of the V SKIN TEST (#9000010.12) file for the given record IEN such as; Patient Name, Skin Test, Readings, etc $$LOADFLDS Type: Output Returns 0 if no record was found in the V SKIN TEST (#9000010.12) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. This API loads all the field values for a given record IEN in the V SKIN TEST (#9000010.12) file. COMPONENT: $$SKINTEST(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$SKINTEST Type: Output A pointer to the SKIN TEST (#9999999.28) file. This API returns field (#.01) - SKIN TEST, of the V SKIN TEST (#9000010.12) file. A pointer to the SKIN TEST (#9999999.28) file which indicates the type of Skin Test that was given to the patient at the encounter. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V SKIN TEST (#9000010.12) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file. This API returns field (#.03) - VISIT, of the V SKIN TEST (#9000010.12) file. A pointer to the VISIT (#9000010) file, indicating the date and time when the immunization was given. COMPONENT: $$RESULTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$RESULTS Type: Output Returns; 'P' - POSITIVE, 'N' - NEGATIVE, 'D' - DOUBTFUL, 'O' - NO TAKE This API returns field (#.04) - RESULTS, of the V SKIN TEST (#9000010.12) file. A numeric value indicating if the test results were positive, negative, doubtful or no take, if known. COMPONENT: $$READING(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$READING Type: Output A numeric value representing the reading of the skin test. This API returns field (#.05) - READING, of the V SKIN TEST (#9000010.12) file. A value representing the reading of the skin test. COMPONENT: $$DATEREAD(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$DATEREAD Type: Output Date of the Reading. This API returns field (#.06) - DATE READ, of the V SKIN TEST (#9000010.12) file. The Date of the Reading. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$EVENTDT Type: Output The date and time the skin test was performed. This API returns field (#1201) - EVENT DATE AND TIME, of the V SKIN TEST (#9000010.12) file. The date and time the skin test was performed. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#1202) - ORDERING PROVIDER, of the V SKIN TEST (#9000010.12) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the skin test. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V SKIN TEST (#9000010.12) file. A pointer to the NEW (#200) file identifying the provider who performed the skin test. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original skin test data is being edited. This API returns field (#80101) - EDITED FLAG, of the V SKIN TEST (#9000010.12) file. This field indicates if PCE detects that any original skin test data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V SKIN TEST (#9000010.12) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the skin test. This API returns field (#81101) - COMMENTS, of the V SKIN TEST (#9000010.12) file. Any comments related to the skin test. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$VERIFIED Type: Output Returns; 1 - Electronically Signed or 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V SKIN TEST (#9000010.12) file. This field indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V SKIN TEST (#9000010.12) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V SKIN TEST (#9000010.12) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3050 NAME: DBIA3035-J CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V TREATMENT (#9000010.15) file. The V TREATMENT (#9000010.15) file stores a record for each treatment provided to a patient on a given patient visit. ROUTINE: PXAAVTRT COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V TREATMENT (#9000010.15) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V TREATMENT (#9000010.15) file for the given visit IEN. Returns 1 if one or more records were found in the V TREATMENT (#9000010.15) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V TREATMENT (#9000010.15) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$LOADFLDS Type: Output Returns 0 if no record was found in the V TREATMENT (#9000010.15) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. ARRAY Type: Input (required) All the field values of the V TREATMENT (#9000010.15) file for the given record IEN such as; Patient Name, Provider Narrative, Treatment type, etc. This API loads all the field values for a given record IEN in the V TREATMENT (#9000010.15) file. COMPONENT: $$TREATMEN(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$TREATMEN Type: Output A pointer to the TREATMENT (#9999999.17) file. This API returns field (#.01) - TREATMENT, of the V TREATMENT (#9000010.15) file. A pointer to the TREATMENT (#9999999.17) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V TREATMENT (#9000010.15) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file. This API returns field (#.03) - VISIT, of the V TREATMENT (#9000010.15) file. A pointer to the VISIT (#9000010) file indicating the date and time for the encounter when the treatment was given. COMPONENT: $$HOWMANY(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$HOWMANY Type: Output A numeric value indicating how many times the treatment was administered. This API returns field (#.04) - HOW MANY, of the V TREATMENT (#9000010.15) file. A numeric value indicating how many times the treatment was provided. COMPONENT: $$PROVNARR(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$PROVNARR Type: Output A pointer to the PROVIDER NARRATIVE (#9999999.27) file. This API returns field (#.06 - PROVIDER NARRATIVE, of the V TREATMENT (#9000010.15) file. A pointer to the PROVIDER NARRATIVE (#9999999.27) file indicating the provider's preferred text used to represent the treatment provided. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$EVENTDT Type: Output The date and time the treatment was provided. This API returns field (#1201) - EVENT DATE AND TIME, of the V TREATMENT (#9000010.15) file. Date and time the treatment was provided. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#1202) - ORDERING PROVIDER, of the V TREATMENT (#9000010.15) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the treatment. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200) file identifying the provider who gave the treatment. This API returns field (#1204) - ENCOUNTER PROVIDER, of the V TREATMENT (#9000010.15) file. A pointer to the NEW (#200) file identifying the provider who gave the treatment. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original treatment data is being edited. This API returns field (#80101) - EDITED FLAG, of the V TREATMENT (#9000010.15) file. This field indicates if PCE detects that any original treatment data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V TREATMENT (#9000010.15) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit _" "_DUZ of the person who entered the data_";" COMPONENT: $$PRONARCA(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$PRONARCA Type: Output A pointer to the PROVIDER NARRATIVE (#9999999.27) file. This API returns field (#80201) - PROVIDER NARRATIVE CATEGORY, of the V TREATMENT (#9000010.15) file. A pointer to the PROVIDER NARRATIVE (#9999999.27) file indicating the category narrative related to the treatment. COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the patient's treatment. This API returns field (#81101) - COMMENTS, of the V TREATMENT (#9000010.15) file. Any comments related to the patient's treatment. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$VERIFIED Type: Output 1 - Electronically Signed, 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V TREATMENT (#9000010.15) file. This field indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V TREATMENT (#9000010.15) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V TREATMENT (#9000010.15) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V TREATMENT (#9000010.15) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3051 NAME: DBIA3035-A CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 22,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The following is a description of the available APIs for the V EXAM (#9000010.13) file. The V EXAM (#9000010.13) file stores exam information, one record for each exam for each visit. ROUTINE: PXAAVXAM COMPONENT: $$GETIENS(VSITIEN,ARRAY) VARIABLES: VSITIEN Type: Input (required) This number represents the Internal Entry Number for a given patient visit. ARRAY Type: Input (required) This array variable is populated by the API with the Internal Entry Numbers of records found to be associated in the V EXAM (#9000010.13) file with the patient visit IEN. $$GETIENS Type: Output Returns 0 if no record was found in the V EXAM (#9000010.13) file for the given visit IEN. Returns 1 if one or more records were found in the V EXAM (#9000010.13) file for the given visit IEN. Use this API to retrieve all Internal Entry Numbers (IEN) from the V EXAM (#9000010.13) file associated with the given visit IEN, VSITIEN. COMPONENT: $$LOADFLDS(IEN,ARRAY) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$LOADFLDS Type: Output Returns 0 if no record was found in the V EXAM (#9000010.13) file for the given patient IEN. Returns 1 if the API has successfully loaded all the field values into the ARRAY variable. ARRAY Type: Input (required) All the field values of the V EXAM (#9000010.13) file for the given record IEN such as; Patient Name, Results, Exam type, etc. This API loads all the field values for a given record IEN in the V EXAM (#9000010.13) file. COMPONENT: $$EXAM(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$EXAM Type: Output A pointer to the EXAM (#9999999.15) file. This API returns field (#.01) - EXAM, of the V EXAM (#9000010.13) file. A pointer to the EXAM (#9999999.15) file. COMPONENT: $$PATINAME(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$PATINAME Type: Output A pointer to the PATIENT/IHS (#9000001) file. This API returns field (#.02) - PATIENT NAME, of the V EXAM (#9000010.13) file. A pointer to the PATIENT/IHS (#9000001) file. COMPONENT: $$VISIT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$VISIT Type: Output A pointer to the Visit (#9000010) file indicating the date and time for the encounter where the exam took place. This API returns field (#.03) - VISIT, of the V EXAM (#9000010.13) file. A pointer to the VISIT (#9000010) file indicating the date and time for the encounter where the exam took place. COMPONENT: $$RESULT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$RESULT Type: Output Returns; 'A' - ABNORMAL or 'N' - NORMAL This API returns field (#.04) - HOW MANY, of the V TREATMENT (#9000010.13) file. A value indicating the result of the exam. COMPONENT: $$EVENTDT(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$EVENTDT Type: Output The date and time the exam took place. This API returns field (#1201) - EVENT DATE AND TIME, of the V EXAM (#9000010.13) file. The date and time the exam took place. COMPONENT: $$ORDEPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$ORDEPROV Type: Output A pointer to the NEW PERSON (#200) file. This API returns field (#1202) - ORDERING PROVIDER, of the V EXAM (#9000010.13) file. A pointer to the NEW PERSON (#200) file identifying the provider who ordered the exam. COMPONENT: $$ENCOPROV(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$ENCOPROV Type: Output A pointer to the NEW PERSON (#200). This API returns field (#1204) - ENCOUNTER PROVIDER, of the V EXAM (#9000010.13) file. A pointer to the NEW (#200) file identifying the provider who gave the exam. COMPONENT: $$EDITFLAG(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$EDITFLAG Type: Output Returns 1 if PCE detects that any original exam data is being edited. This API returns field (#80101) - EDITED FLAG, of the V TREATMENT (#9000010.13) file. This field indicates if PCE detects that any original exam data is being edited. COMPONENT: $$AUDITRAI(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$AUDITRAI Type: Output A Free Text value in the format; Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" This API returns field (#80102) - AUDIT TRAIL, of the V EXAM (#9000010.13) file. This field is populated automatically by the PCE filing logic. The format of the field is as follows: Pointer to PCE data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the data_";" COMPONENT: $$COMMENTS(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$COMMENTS Type: Output A Free Text value indicating any comments related to the patient's exam. This API returns field (#81101) - COMMENTS, of the V EXAM (#9000010.13) file. Any comments related to the patient's exam. COMPONENT: $$VERIFIED(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$VERIFIED Type: Output 1 - Electronically Signed, 2 - Verified by the Package. This API returns field (#81201) - VERIFIED, of the V EXAM (#9000010.13) file. This field indicates whether the record was Electronically Signed or Verified by the Package. COMPONENT: $$PACKAGE(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$PACKAGE Type: Output Pointer to the Package (#9.4) file. This API returns field (#81202) - PACKAGE, of the V EXAM (#9000010.13) file. A pointer to the Package (#9.4) file. COMPONENT: $$DATASRC(IEN) VARIABLES: IEN Type: Input (required) This number represents the Internal Entry Number for a record in the V EXAM (#9000010.13) file. $$DATASRC Type: Output Pointer to the PCE Data Source (#839.7) file. This API returns field (#81203) - DATA SOURCE, of the V EXAM (#9000010.13) file. A pointer to the PCE Data Source (#839.7) file. ******************** 3052 NAME: Nursing Ward Location API CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 24,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Patch NUR*4*31 introduces a new supported Application Programming Interface(API). This API provides a "Query" and "Look-up" on the NURS LOCATION file (#211.4). This DBIA was developed as a way to provide access to File #211.4 and allow Nursing to retire two existing private DBIAs. ROUTINE: NURSUT5 COMPONENT: WARD(FUNCT,.ARRAY) VARIABLES: FUNCT Type: Input FUNCT = Piece1_^_Piece2 Piece1 must contain an "L" or "Q" Piece1 "L" means Look-up of specified entry in File 211.4, and Piece2 must contain the IEN for the entry in File 211.4. Piece1 "Q" means do a DIC style query on File 211.4, and Piece2 must contain "I","A" or ""(i.e., null). This will be the screen used on the look-up. The API will do a DIC style look-up for the ward. "I" means look-up only inactive wards. "A" means look-up only active wards. "" means look-up all wards. .ARRAY Type: Both .ARRAY = Recommend the return array should be namespaced. Return Values: ARRAY = -1 means that the Look-up or Query failed. ARRAY = IEN means that the Look-up or Query was successful. ARRAY can be any variable array that the developer chooses. When the API returns the data it will be placed into the variable array specified. If the data value is missing the array element for that value will not be returned. Return Array: ARRAY(IEN,.01) = Pointer to File 44 _"^"_ External value of Hospital Location file(44), Name field(.01) ARRAY(IEN,.02) = Facility pointer to File 4_"^"_ External name of facility ARRAY(IEN,.03) = Pointer to File 212.7 _"^"_ External value of NURS Product Line file(212.7), Name field(.01) ARRAY(IEN,1) = Patient care status internal value_"^"_ External value of Patient care status ARRAY(IEN,1.5) = Ward status Internal value_"^"_ External value of Ward status ARRAY(IEN,2) = Total number of MAS ward pointers X = the IEN of the entry within the MAS ward Multiple. ARRAY(IEN,2,X,.01) = Pointer to File 42 _"^"_ External value of Ward Location file(42), Name field(.01) ARRAY(IEN,2,X,1) = Pointer to File 213.3_"^"_External value of NURS AMIS Ward file(213.3), Bed Section field(.01) ARRAY(IEN,4) = Total number of AMIS ward pointers. Y = the IEN of the entry within the AMIS Bed section Multiple. ARRAY(IEN,4,Y,.01) = Pointer to file 213.3_"^"_External value of NURS AMIS Ward file(213.3), Bed Section field(.01) ARRAY(IEN,11) = Professional Percentage ARRAY(IEN,12) = Pointer to File 211.5_"^"_External value of NURS Clinical Background file(211.5), Description field(.01) ARRAY(IEN,37) = Indicates whether or not active staff is assigned to this ward. In the following examples the ARRAY is variable VAR. The first example is a query for all active wards. The second example is a look-up a specific entry in the NURS LOCATION file (#211.4). 1) Coding example of Query call: KILL VAR ; initialize VAR DO WARD^NURSUT5("Q^A",.VAR) ; Call to API User interface: Select NURSING UNIT NAME: ? NOTE: The letters NUR may be in front of the location name. This is not to be corrected under any circumstance. DO YOU WANT THE ENTIRE 26-ENTRY NURSING UNIT LIST? Y (Yes) CHOOSE FROM: 10E SUPPORT ISC 10W SUPPORT ISC 12E SUPPORT ISC 2AS SUPPORT ISC 3AS HINES ISC 3E SUPPORT ISC 4AS PSYCHIATRY SUPPORT ISC 5NP HINES ISC Select NURSING UNIT NAME: 4AS PSYCHIATRY 2) Coding example of Look-up call: KILL VAR ; initialize VAR DO WARD^NURSUT5("L^5",.VAR) ; Call to API In both cases when the API returns the data it will be placed into the variable array specified. If the data value is missing the array element for that value will not be returned. The following is an example of the return array. Example of Return Array: VAR=5 VAR(5,.01)="30^4AS PSYCHIATRY" VAR(5,.02)="499^SUPPORT ISC" VAR(5,.03)="1^NURSING" VAR(5,1)="A^ACTIVE" VAR(5,1.5)="A^ACTIVE" VAR(5,2)=1 VAR(5,2,1,.01)="4^4AS" VAR(5,2,1,1)="1^PSYCHIATRIC" VAR(5,4)=1 VAR(5,4,1.01)="1^PSYCHIATRIC" VAR(5,11)="60" VAR(5,12)="8^PSYCHIATRY" VAR(5,37)="YES" ******************** 3053 NAME: Obtain Description for PAID Code CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: ASISTS USAGE: Private ENTERED: FEB 29,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA allows the ASISTS package to call routine PRSDUTIL to obtain a description of a code from the following tables in the PAID CODE FILES (#454). Use OT^PRSDUTIL for the following tables: Table Subscript ---------- --------- PAY BASIS PB PAY PLAN PP RETIREMENT RET EDUCATION EDU Use OST^PRSDUTIL for the OCCUPATION SERIES/TITLE table. ROUTINE: PRSDUTIL COMPONENT: OT VARIABLES: Y Type: Both Y should be set to the value of the code before calling OT. If the code is found in the table then Y will be changed to it's description. SUB454 Type: Input Variable SUB454 must be set to the subscript of the table. For example, set SUB454="PB" to look up a code in the PAY BASIS table. Returns the description of a code for several PAID tables. COMPONENT: OST VARIABLES: Y Type: Both Y should be set to the value of the code before calling OST. If the code is found in the table then Y will be changed to it's description. Returns the description for an occupation series & title code. ******************** 3054 NAME: DBIA3054 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: FEB 29,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000001 ROOT: AUPNPAT( DESCRIPTION: TYPE: File DG namespaced routine deletes PATIENT/IHS entries when the patients that these entries point to in the PATIENT file are being deleted. ROUTINE: ******************** 3055 NAME: GET CODE MAPPING CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: MAR 1,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 811.1 ROOT: PXD(811.1, DESCRIPTION: TYPE: File ^PXD(811.1,D0, .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3056 NAME: DNS lookup CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 1,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Call a DNS to resolve Domain names. ROUTINE: XLFNSLK COMPONENT: $$ADDRESS(domain_name[,type]) VARIABLES: domain_nam Type: Input domain_name is a fully qualified domain name like FORUM.VA.GOV type Type: Input This is input is optional. Type is from the set A: address (the default), CNAME: alias. $$ADDRESS Type: Output Returns a coma-separated list of IP address's that are associated with the domain. $$ADDRESS^XLFNSLK(domain_name[,type]) This call will call a DNS to convert the domain name into IP address's. The IP address of the DNS is in the Kernel System Parameter file, field DNS IP. Example: W $$ADDRESS^XLFNSLK("FORUM.VA.GOV") =>> 152.128.1.25 COMPONENT: MAIL(RETURN, domain_name) VARIABLES: domain_nam Type: Input domain_name is a fully qualified domain name like FORUM.VA.GOV RETURN Type: Output Pass by reference a local variable to hold the return array. The data is subscripted by priority. domain_name is a full domain name like FORUM.VA.GOV Example: K ZX D MAIL(.ZX,"ISC-SF.MED.VA.GOV") ZW ZX ZX=2 ZX(30)=a2.isc-sf.med.va.gov.^152.132.1.57 ZX(50)=gateway.forum.va.gov.^152.128.1.2 MAIL^XLFNSLK(RETURN, domain_name) This call will call a DNS to get the MX records for a domain name with their IP address. ******************** 3057 NAME: SET~XUS1A CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 6,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The is a API for use by code called from the XU USER SIGN-ON protocol to pass text back to the user. ROUTINE: XUS1A COMPONENT: SET(T) VARIABLES: T Type: Input Line of text to be displayed. The line of text passed in will be displayed to the user after all the XU USER SIGN-ON protocol have completed. If the first character is a "!" the text will start on a new line. The "@" as a first character is reserved for future use. ******************** 3058 NAME: TIULX Document Class CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY Used to determine document class (silently) for the GUI Ad Hoc Health Summary. ORDER ENTRY/RESULTS REPORTING IMAGING VIRTUAL PATIENT RECORD Effective with VPR*1*0. HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: MAR 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Text Integration Utilities Cross-reference library functions. ROUTINE: TIULX COMPONENT: $$ISA(DA,CLASS) VARIABLES: DA Type: Input Record number in file 8925.1, represents a document type. CLASS Type: Input Record number in file 8925.1, represents a document class. This entry point is used to evaluate whether a given document type is a member of a particular document class. ******************** 3059 NAME: TIU(8925.1 Health Summary CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY Access TIU(8925.1 to obtain a list of document types in a class (silent) used in GUI AD Hoc Health Summary. USAGE: Controlled Subscri ENTERED: MAR 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: TIU(8925.1 DESCRIPTION: TYPE: File Access TIU DOCUMENT DEFINITION file #8925.1 ^TIU(8925.1,DA,0) Used to select document types belonging to the Class of Progress Notes. ^TIU(8925.1,'B') B-cross reference used to loop throught document types looking for those types belonging to the document class Progress Notes. ROUTINE: ******************** 3060 NAME: Reference to variable DICR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION Establishing an agreement covering pre-existing references to the variable DICR in the 'post-selection action' of the PATIENT file and the PATIENT file special lookup routine DPTLK. USAGE: Private ENTERED: MAR 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Reference to undocumented variable, DICR, for the purpose of determining if lookup by patient is originating in a file other than the PATIENT file. ROUTINE: ******************** 3062 NAME: TIULAPIS Selected Prog Note CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY Used for the Health Summary Selected Progress Notes Component. ORDER ENTRY/RESULTS REPORTING Added 3/23/20 to find completed PDMP notes. USAGE: Controlled Subscri ENTERED: MAR 9,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The routine TIULAPIS controls the branching for extracting selected Progress Notes by occurrence, date or type for a given patient. ROUTINE: TIULAPIS COMPONENT: MAIN VARIABLES: DFN Type: Input The IEN of the patient file (#2) (required) TIUDOC Type: Input Array of selected document types to extract, including the IEN of the TIU DOCUMENT DEFINITION file (#8925.1) (required) STATUS Type: Input Document status, i.e., signed, unsigned, not released, etc. TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input The number of occurrences of teh type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) Extract selected documents from Text Integration Utility. ******************** 3063 NAME: PXRHS08 Patient Education CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: HEALTH SUMMARY Used to support Patient Education Health Summary Component. USAGE: Controlled Subscri ENTERED: MAR 9,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Patient Education data extract. ROUTINE: PXRHS08 COMPONENT: EDUC(DFN,ENDDT,BEGDT,OCCLIM,CATCODE) VARIABLES: DFN Type: Input The IEN of the patient file (#2) (required) ENDDT Type: Input Ending date/time in internal FileMan format (optional, default is today's date at 11:59 pm) BEGDT Type: Input Beginning date/time in internal FileMan format (optional, default is one year prior to today's date) OCCLIM Type: Input Maximum number of days for which data is returned (If multiple visits on a given day, all data for these visit will be returned) or an "R" for only the most recent occurrence of each topic. (optional, default is 999) CATCODE Type: Input Pattern Match which controls visit data that is returned (can include multiple codes). (required) A = AMBULATORY H = HOSPITALIZATION I = IN HOSPITAL C = CHART REVIEW T = TELECOMMUNICATIONS N = NOT FOUND S = DAY SURGERY O = OBSERVATION E = EVENT (HISTORICAL) R = NURSING HOME D = DAILY HOSPITALIZATION DATA X = ANCILLARY PACKAGE DAILY DATA ~TMP("PXPE Type: Output Data from V Patient Education (9000010.16) file ^TMP("PXPE",$J,InvDt,TOPIC,IFN,0) = TOPIC [E;.01] ^ EVENT DATE/TIME or VISIT/ADMIT DATE&TIME [I;1201 or .03] ^ LEVEL OF UNDERSTANDING [E;.06] ^ ORDERING PROVIDER [E;1202] ^ ENCOUNTER PROVIDER [E;1204] ^TMP("PXPE",$J,InvDt,TOPIC,IFN,1) = HOSPITAL LOCATION [E;9000010;.22] ^ HOSP. LOC. ABBREVIATION [E;44;1] ^ LOC OF ENCOUNTER [E;9000010;.06] ^ OUTSIDE LOC [E;9000010;2101] ^TMP("PXPE",$J,InvDt,TOPIC,IFN,"S") = DATA SOURCE [E;80102] [] = [I(nternal)/E(xternal); Optional file #; Record #] Subscripts: InvDt - Inverse FileMan date of DATE OF event or visit TOPIC - Patient Education Topic IFN - Internal Record # ^TMP("PXPE",$J) should be killed by the calling application before EDUC is called and after the array is used. Extracts by education topic, the event date and time (or visit/admit date and time), patient's level of understanding, encounter provider, hospital location (or outside location), and data source. ******************** 3064 NAME: CONTROLLED SUBSTANCE API CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: MAR 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When a prescription is returned to stock in Outpatient Pharmacy 7.0, the entry is deleted from the prescription file. If the prescription was a controlled substance, the pharmacy location's balance is not updated. This API will check the prescription when it is being returned. If the prescription is for a controlled substance, the user will be asked if they want to update the balances for the associated pharmacy location. ROUTINE: PSDOPT0 COMPONENT: PSDRTS(PSDRX,PSDNUM,PSDSITE,PSDQTY) VARIABLES: PSDRX Type: Input The name of the prescription PSDNUM Type: Input The refill number PSDSITE Type: Input The pharmacy location the prescription is being returned to. PSDQTY Type: Input The quantity being returned to stock. This entry point is called directly in routine PSDOPT0. The call returns no values to Outpatient Pharmacy. ******************** 3065 NAME: Name Standardization APIs CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAR 15,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Supported Name Standardization APIs. ROUTINE: XLFNAME COMPONENT: STDNAME(.NAME,FLAGS,.AUDIT) VARIABLES: NAME Type: Both (Required) NAME is the name to be converted to standard format. It is assumed that the name is in the general format: Family_name,Given_name(s) Middle_name Suffix(es) If the "F" flag is not used, and the name contains no comma, it is assumed the name is in the general format: Given_name(s) Middle_name Family_name Suffix(es) The standard form of the name is returned in the NAME variable. If the "C" flag is passed in, the components of the name are returned in nodes descendent from NAME. Output: ------ NAME is set to the name that was input converted to standard format. If the FLAGS input parameter contains a "C", the component parts of the name are returned in the NAME array: NAME("FAMILY) = Family (Last) Name NAME("GIVEN") = Given (First) Name(s) NAME("MIDDLE") = Middle Name NAME("SUFFIX") = Suffix(es) FLAGS Type: Input Flags to control processing. Possible values are:. C - Return name components in the NAME array. F - If the name passed in the NAME input parameter does not contain a comma, assume it is the Family Name only. For example, if the name input is "ST JAMES", return the name as "STJAMES" instead of "JAMES,ST" G - Don't return AUDIT("GIVEN") even if the Given Name is missing. P - Remove text in parentheses (), brackets [], or braces {} from the name. If such text is actually removed, return AUDIT("STRIP"). AUDIT Type: Both If provided, this is an array that STDNAME^XLFNAME returns if there are any ambiguities or possible problems in stardardizing the name or parsing the name into component parts. Output: ------ AUDIT is set to the original name that was passed in NAME. In addition, if there were any problems in the interpretation of the NAME being standardized, descendents of AUDIT are set: AUDIT("subscript") = "" where "subscript" can be one of the following: AUDIT("FAMILY") The Family Name starts with ST. (The period and space are removed from the Family Name. For example, the name "ST. JOHN" is converted to "STJOHN".) AUDIT("GIVEN") Returned if there is no Given Name and the "G" flag isn't passed in. AUDIT("MIDDLE") Returned if there are three or more names between the first comma and the Suffix(es). (All name parts except the last are assumed to be part of the Given Name. Only the last part is assumed to be the Middle Name.) AUDIT("NM") Returned if NMI or NMN appears to be used as the Middle Name. (NMI and NMN are removed from the standard name, and the Middle Name component is returned as null.) AUDIT("NOTE") Returned if the name appears to contain a note or flag that may not actually be part of the name. For example, the name starts with "C-" or "EEE," or has "FEE" at the end. AUDIT("NUMBER") Returned if a name part (other than a valid numeric Suffix) contains a number. AUDIT("PERIOD") Returned if periods were removed. AUDIT("PUNC") Returned if punctuation was removed. AUDIT("SPACE") Returned if spaces were removed from the Family Name. AUDIT("STRIP") Returned if text in parentheses (), brackets [], or braces {} were removed from the Name. (This is done only if the "P" flag is passed.) AUDIT("SUFFIX") Returned if: - Suffix(es) are found immediately to the left of the 1st comma.7 I, V, or X, and nothing else except valid suffixes, appear immediately after the Given Name. (It is interpreted as the Middle Name.) - The name immediately after the Given Name appears to be a non-numeric suffix (except I, V, and X), and everything after that also appear to be suffixes. (It is assumed there are a Given Name and Suffix(es), but no Middle Name.) - M.D. or M D is found at the end of the name, or before any valid suffixes at the end of the name. (It is assumed that M and D are initials in the Given or Middle Name rather than a Suffix.) - The name part before any recognizable suffixes is more than one character in length and doesn't contain any vowels or Y. It is interpreted as a suffix. - A Suffix is found between commas immediately after the Family Name. Name Standardization Routine ============================ This procedure parses a name and converts it into the following standard format: Family_name,Given_nameMiddle_nameSuffix A name in standard format is entirely in upper-case, and contains no Arabic numerals. The Family_name (last name) portion of a standard name appears to the left of the comma and contains no spaces and no punctuation except hyphens (-). The other parts of a standard name (the portion to the right of the comma) contain no punctuation except for hyphens and spaces. NMI and NMN are not used for the Middle_name. STDNAME^XLFNAME optionally returns in an array the component parts of the name. It also optionally returns information in an array about possible problems encountered during the conversion of the name to standard form and the parsing of the name into its component parts. Details: ------- In forming the standard name, the following changes are made: 1. The name is converted to uppercase. 2. In the Family Name: a. Semicolons (;) and colons (:) are converted to hyphens (-). b. Spaces and all other punctuation except hyphens are removed. 3. In the other name parts (Given Name, Middle Name, and Suffix). a. Semicolon, colons, commas (,), and periods (.) are converted to spaces. b. All punctuation except hyphens and spaces are removed. 4. Hyphens and spaces at the beginning and end of the name are removed. 5. Two or more consecutive hyphens/spaces are replaced with a single hyphen/space. 6. Any suffixes immediate preceding the comma are moved to the end. 7. The suffixes indicating birth positions 1st, 2nd, 3rd, ..., 10th are converted to their Roman numeral equivalents I, II, III, X. 8. DR immediately after the comma (or if there is no comma, at the beginning of the name), is assumed to be a suffix and moved to the end of the name. 9. Any suffixes between two commas immediate after the Family Name are moved to the end of the name. 10. NMI or NMN used as a Middle Name is deleted. In forming the component parts of the name, only the following changes are mode: 1. The name component is converted to uppercase. 2. In the Family Name, semicolons (;) and colons (:) are converted to hyphens (-). 3. In the other name parts (Given Name, Middle Name, and Suffix), semicolons, colons, and commas (,) are converted to spaces. 4. Hyphens and spaces at the beginning and end of the name are removed. 5. Two or more consecutive hyphens/spaces are replaced with a single hyphen/space. 6. A Middle Name of NMI or NMN is changed to null. 7. Spaces after periods are removed. 8. Accent graves (`) and up-arrows (^) are removed. In parsing the name into its component parts, if the name contains a comma or the "F" flag is passed, STDNAME^XLFNAME looks for suffixes immediately to the left of the first comma, and at the very end of the name. The suffixes it recognizes are 1ST through 10TH, JR, SR, DR, MD, ESQ, DDS, RN and Roman numerals I through X. If a name part before any recognizable suffixes is more than one character in length, and contains no vowel or 'Y', it is also assumed to be a suffix. The Name Standardization looks for the DR suffix immediately after the first comma, and for any suffix between two commas immediately after the Family Name. The portion of the name to the left of the comma, less any suffixes, is assumed to be the Family Name. After STDNAME^XLFNAME accounts for all Suffixes, it looks at the portion of the name after the comma. It assumes that the first space-delimited piece is the Given Name. If any other pieces are left, the last one (rightmost) is assumed to be the Middle Name, and anything else is appended to the end of the Given Name. If the name contains no comma, and the "F" flag is not passed, STDNAME^XLFNAME looks for suffixes at the very end of the name. The last space-delimited piece before any suffixes is assumed to be the Family Name. The first space-delimited piece is assumed to be the Given Name. If any other pieces are left, the last one (rightmost) is assumed to be the Middle Name, and anything else is appended to the end of the Given Name. Example: ------- In this example, the variable MYNAME is set to the name to be standardized. The "C" flag indicates that the name components should be returned in the MYNAME array, and the "P" flag indicates that parenthetical text should be removed from the name. STDNAME^XLFNAME sets MYAUD to original name passed in and sets nodes in the MYAUD array to flag changes and possible problems. >S MYNAME="VAN DOREN,JOHN A. B. 2ND (TEST)" >D STDNAME^XLFNAME(.MYNAME,"CP",.MYAUD) >ZW MYNAME MYNAME=VANDOREN,JOHN A B II MYNAME("FAMILY")=VAN DOREN MYNAME("GIVEN")=JOHN A. MYNAME("MIDDLE")=B. MYNAME("SUFFIX")=2ND >ZW MYAUD MYAUD=VAN DOREN,JOHN A. B. 2ND (TEST) MYAUD("MIDDLE")="" MYAUD("PERIOD")="" MYAUD("SPACE")="" MYAUD("STRIP")="" STDNAME^XLFNAME returned the standard form of the name in MYNAME as VANDOREN,JOHN A B II. It interpreted JOHN A. as the given (first) name and B. as the middle name. Since this may not be correct, MYAUD("MIDDLE") is set. Periods were removed and spaces were removed to form the standard name, therefore MYAUD("PERIOD") and MYAUD("SPACE") were set. Finally, since the parenthetical text (TEST) was removed, MYAUD("STRIP") was set. COMPONENT: $$CLEANC(COMP,FLAGS) VARIABLES: COMP Type: Input (Required) The name component to be converted to standard format. FLAGS Type: Input Flags to control processing. Possible values are: F - If the name component to be converted is the FAMILY (LAST) NAME, pass the "F" flag. With the "F" flag, colons (:), semicolons (;), and commas (,) are converted to hyphens (-). Spaces and all punctuation except hyphens are removed. Leading and trailing spaces and hyphens are removed. Two or more consecutive spaces or hyphens are replaced with a single space or hyphen. Without the "F" flag, the component is converted to upper case. Colons, semicolons, commas, and periods (.) are converted to spaces. All punctuation except for hyphens and spaces are removed. Leading and trailing spaces and hyphens are removed. Two or more consecutive spaces or hyphens are replaced with a single space or hyphen. Birth position indicators 1ST through 10TH are changed to their Roman numeral equivalents. Name Component Standardization Routine ====================================== This extrinsic function takes a single name component and returns that name in standard format. Examples: -------- 1. Standardize family (last) name: $$CLEANC^XLFNAME("O'BRIEN-DE LA ROSA","F) --> OBRIEN-DELAROSA $$CLEANC^XLFNAME("ST. JAMES","F") --> STJAMES 2. Standardize other (non-family) name components: $$CLEANC^XLFNAME("E.C.) --> E C $$CLEANC^XLFNAME("RENEE'") --> RENEE $$CLEANC^XLFNAME("MARY ANN") --> MARY ANN $$CLEANC^XLFNAME("JO-ANNE") --> JO-ANNE COMPONENT: NAMECOMP(.NAME) VARIABLES: NAME Type: Both (Required) NAME is the name in standard format to be parsed. NAMECOMP^XLFNAME returns the component parts of the name in nodes descendent from NAME. Output: ------ The component parts of the name are returned in the NAME array passed in. NAME("FAMILY) = Family (last) Name NAME("GIVEN") = Given (first) Name NAME("MIDDLE") = Middle Name NAME("SUFFIX") = Suffix(es) Component Parts from Standard Name ================================== This procedure takes a name in standard format and returns in an array the component parts of that name. Example: ------- In this example, the variable MYNAME is set to the standard name, and the NAMECOMP^XLFNAME call is made to return in the MYNAME array the component parts of that name: >S MYNAME="MCDONALD-STJAMES,MARY ANN S MD" >D NAMECOMP^XLFNAME(.MYNAME) >ZW MYNAME MYNAME=MCDONALD-STJAMES,MARY ANN S MD MYNAME("FAMILY")=MCDONALD-STJAMES MYNAME("GIVEN")=MARY ANN MYNAME("MIDDLE")=S MYNAME("SUFFIX")=MD COMPONENT: $$NAMEFMT(.NAME,FORMAT,FLAGS) VARIABLES: NAME Type: Input (Required) An array that contains the component parts of the name: NAME("FAMILY) = Family (Last) Name (required) NAME("GIVEN") = Given (First) Name(s) (optional) NAME("MIDDLE") = Middle Name(s) (optional) NAME("SUFFIX") = Suffix(es) (optional) NAME("PREFIX") = Prefix (optional) NAME("DEGREE") = Degree (optional) Alternatively, this array can contain the file number, IENS, and field number of the field that contains the name. If the name has a corresponding entry in the NAME COMPONENTS file (#20), then the name components are obtained from that entry. Otherwise, the name is obtained directly from the file, record, and field specified, and the name components are obtained by making a call to STDNAME^XLFNAME. NAME("FILE") = Source file number (required) NAME("IENS") = IENS of entry in the source file (required) NAME("FIELD") = Source field number (required) FORMAT Type: Input Controls the general formatting of the output. (Default = G) Possible values are: F - Return Family (Last) Name first G - Return Given (First) Name first O - Return Only the Family (Last) Name FLAGS Type: Input Flags to controls processing. Possible values are: C - If the "F" format is used, return a Comma between the Family (Last) and Given (First) Names. Otherwise, the Family (Last) Name and the Given (First) Name are separated by a space. (Ignored if the "F" format is not used.) D - Return the Degree. Dc - Return the Degree preceded by a comma and space. L# - Truncate the returned name to a maximum Length of # characters, where # is an integer between 1 and 256. M - Return the name in Mixed case, with the first letter of each name component capitalized. P - Return the Prefix. S - Standardize the name components before building formatted name. Xc - Precede the SuffiX with a comma and space. Formatted Name from Name Components =================================== This extrinsic function returns a name converted to a form useful for display. Details: ------- If the L# flag is used, and the resulting name is longer than #, the following pruning algorithm is performed to shorten the name: 1. Drop Degree; 2. Drop Prefix; 3. Truncate Middle Name from the right-most position until only the initial character is left; 4. Drop suffix; 5. Truncate Given Name from the right-most position until only the initial character is left; 6. Truncate Family Name from the right-most position; 7. Truncate the name from the right. Examples: -------- 1. Suppose the MYNAME array contains the following elements: MYNAME("PREFIX") = "MR." MYNAME("GIVEN") = "JOHN" MYNAME("MIDDLE") = "K." MYNAME("FAMILY") = "O'BRIEN" MYNAME("SUFFIX") = "JR" MYNAME("DEGREE") = "PHD" Calls to $$NAMEFMT^XLFNAME will return the name as follows: $$NAMEFMT^XLFNAME(.MYNAME,"F") --> O'BRIEN JOHN K. JR $$NAMEFMT^XLFNAME(.MYNAME,"F","C") --> O'BRIEN,JOHN K. JR $$NAMEFMT^XLFNAME(.MYNAME,"F","CS") --> OBRIEN,JOHN K JR $$NAMEFMT^XLFNAME(.MYNAME,"F","CSD") --> OBRIEN,JOHN K JR PHD $$NAMEFMT^XLFNAME(.MYNAME,"F","CDcXc") --> O'BRIEN,JOHN K., JR, PHD $$NAMEFMT^XLFNAME(.MYNAME,"F","CSL12") --> OBRIEN,JOH K $$NAMEFMT^XLFNAME(.MYNAME,"F","CMD") --> O'Brien,John K. Jr PhD $$NAMEFMT^XLFNAME(.MYNAME,"G") --> JOHN K. O'BRIEN JR $$NAMEFMT^XLFNAME(.MYNAME,"G","D") --> JOHN K. O'BRIEN JR PHD $$NAMEFMT^XLFNAME(.MYNAME,"G","Dc") --> JOHN K. O'BRIEN JR, PHD $$NAMEFMT^XLFNAME(.MYNAME,"G","P") --> MR. JOHN K. O'BRIEN JR $$NAMEFMT^XLFNAME(.MYNAME,"G","Xc") --> JOHN K. O'BRIEN, JR $$NAMEFMT^XLFNAME(.MYNAME,"G","PDcXc") --> MR. JOHN K. O'BRIEN, JR, PHD $$NAMEFMT^XLFNAME(.MYNAME,"G","PDcXcM") --> Mr. John K. O'Brien, Jr, PhD $$NAMEFMT^XLFNAME(.MYNAME,"G","S") --> JOHN K OBRIEN JR $$NAMEFMT^XLFNAME(.MYNAME,"G","SL12") --> JOH K OBRIEN $$NAMEFMT^XLFNAME(.MYNAME,"O") --> O'BRIEN $$NAMEFMT^XLFNAME(.MYNAME,"O","S") --> OBRIEN $$NAMEFMT^XLFNAME(.MYNAME,"O","M") --> O'Brien $$NAMEFMT^XLFNAME(.MYNAME,"O","L3") --> O'B 2. If an entry in the NAME COMPONENTS stores the components of a name stored in the NAME field (#.01) of record number 32 in the NEW PERSON file (#200), and the data in the corresponding record in the NAME COMPONENT file is: FILE = 200 FIELD = .01 IENS = "32," PREFIX = "MR." GIVEN NAME = "JOHN" MIDDLE NAME = "K." FAMILY NAME = "O'BRIEN" SUFFIX = "JR" DEGREE = "PHD" you can set: MYNAME("FILE") = 200 MYNAME("FIELD") = .01 MYNAME("IENS") = "32," and call $$NAMEFMT^XLFNAME as in Example 1, listed previously, to return the name in various formats. COMPONENT: $$BLDNAME(.NAME,MAX) VARIABLES: NAME Type: Input (Required) The component parts of the name: NAME("FAMILY") = Family (Last) Name NAME("GIVEN") = Given (First) Name(s) NAME("MIDDLE") = Middle Name(s) NAME("SUFFIX") = Suffix(es) Alternatively, this array can contain the file number, IENS, and field number of the file field that contains the name. If the name has a corresponding entry in the NAME COMPONENTS file, then the name components are obtained from that entry. Otherwise, the name is obtained directly from the file, record, and field specified, and the name components are obtained by making a call to STDNAME^XLFNAME. NAME("FILE") = Source file number (required) NAME("IENS") = IENS of entry in the source file (required) NAME("FIELD") = Source field number (required) MAX Type: Input The maximum length of the Name to be returned. (Default = 256) Build Name from Component Parts =============================== This extrinsic function takes the component parts of a name and returns the name, truncated if necessary, in the following format: Family_name,Given_nameMiddle_nameSuffix(es) Details: ------- If the MAX input parameter is used, and the resulting name is longer than MAX, the following pruning algorithm is performed to shorten the name: 1. Truncate Middle Name from the right-most position until only the initial character is left; 2. Drop suffix; 3. Truncate Given Name from the right-most position until only the initial character is left; 4. Truncate Family Name from the right-most position; 5. Truncate the name from the right. Examples: -------- 1. Suppose the MYNAME array contains the following elements: MYNAME("FAMILY") = "O'BRIEN" MYNAME("GIVEN") = "JOHN" MYNAME("MIDDLE") = "K." MYNAME("SUFFIX") = "JR" Calls to $$BLDNAME^XLFNAME will return the name as follows: $$BLDNAME^XLFNAME(.MYNAME) --> OBRIEN,JOHN K JR $$BLDNAME^XLFNAME(.MYNAME,12) --> OBRIEN,JOH K 2. If an entry in the NAME COMPONENTS stores the components of a name stored in the NAME field (#.01) of record number 32 in the NEW PERSON file, and the data in the corresponding record in the NAME COMPONENT file is: FILE = 200 FIELD = .01 IENS = "32," GIVEN NAME = "JOHN" MIDDLE NAME = "K." FAMILY NAME = "O'BRIEN" SUFFIX = "JR" you can set: MYNAME("FILE") = 200 MYNAME("FIELD") = .01 MYNAME("IENS") = "32," and call $$BLDNAME^XLFNAME as in Example 1, listed previously: $$BLDNAME^XLFNAME(.MYNAME) --> OBRIEN,JOHN K JR $$BLDNAME^XLFNAME(.MYNAME,12) --> OBRIEN,JOH K COMPONENT: $$HLNAME([.]NAME,FLAGS,DELIM) VARIABLES: NAME Type: Input (Required) The component parts of the name to be converted: NAME("FAMILY) = Family (Last) Name (required) NAME("GIVEN") = Given (First) Name(s) (optional) NAME("MIDDLE") = Middle Name(s) (optional) NAME("SUFFIX") = Suffix(es) (optional) NAME("PREFIX") = Prefix (optional) NAME("DEGREE") = Degree (optional) Alternatively, this array can contain the file number, IENS, and field number of the file field that contains the name. If the name has a corresponding entry in the NAME COMPONENTS file (#20), then the name components are obtained from that entry. Otherwise, the name is obtained directly from the file, record, and field specified, and the name components are obtained by making a call to STDNAME^XLFNAME. NAME("FILE") = Source file number (required) NAME("IENS") = IENS of entry in the source file (required) NAME("FIELD") = Source field number (required) Another alternative is to pass in the unsubscripted NAME parameter the name to be converted. $$HLNAME^XLFNAME obtains the components parts of that name by making a call to STDNAME^XLFNAME. This alternative is recommended only for names that do not have associated entries on the NAME COMPONENTS file. FLAGS Type: Input Flags to controls processing. Possible values are: L# - Truncate the returned name to a maximum Length of # characters, where # is an integer between 1 and 256. S - Return the name components in the HL7 formatted name in Standardized form. DELIM Type: Input The delimiter to use in the HL7 string. (Default = "^") Convert Name to HL7 Formatted Name ================================== This extrinsic function converts a name to HL7 format. Details: ------- If the L# flag is used, and the resulting name is longer than #, the following pruning algorithm is performed to shorten the name: 1. Truncate Middle Name from the right-most position until only the initial character is left; 2. Drop suffix; 3. Truncate Given Name from the right-most position until only the initial character is left; 4. Truncate Family Name from the right-most position; 5. Truncate the name from the right. Examples: -------- 1. Suppose the MYNAME array contains the following elements: MYNAME("PREFIX") = "MR." MYNAME("GIVEN") = "JOHN" MYNAME("MIDDLE") = "K." MYNAME("FAMILY") = "O'BRIEN" MYNAME("SUFFIX") = "JR" MYNAME("DEGREE") = "PHD" Calls to $$HLNAME^XLFNAME will return the name as follows: $$HLNAME^XLFNAME(.MYNAME) --> O'BRIEN^JOHN^K.^JR^MR.^PHD $$HLNAME^XLFNAME(.MYNAME,"","~") --> O'BRIEN~JOHN~K.~JR~MR.~PHD $$HLNAME^XLFNAME(.MYNAME,"S","~") --> OBRIEN~JOHN~K~JR~MR~PHD $$HLNAME^XLFNAME(.MYNAME,"L12S") --> OBRIEN^JOH^K 2. If an entry in the NAME COMPONENTS stores the components of a name stored in the NAME field (#.01) of record number 32 in the NEW PERSON file, and the data in the corresponding record in the NAME COMPONENT file is: FILE = 200 FIELD = .01 IENS = "32," PREFIX = "MR." GIVEN NAME = "JOHN" MIDDLE NAME = "K." FAMILY NAME = "O'BRIEN" SUFFIX = "JR" DEGREE = "PHD" you can set: MYNAME("FILE") = 200 MYNAME("FIELD") = .01 MYNAME("IENS") = "32," and call $$HLNAME^XLFNAME as in Example 1, listed previously, to return the name in various formats. 3. Convert a name passed by value to HL7 format: $$HLNAME^XLFNAME("O'BRIEN,JOHN HOWARD II") --> O'BRIEN^JOHN^HOWARD^II $$HLNAME^XLFNAME("O'BRIEN,JOHN HOWARD II","S") --> OBRIEN^JOHN^HOWARD^II $$HLNAME^XLFNAME("O'BRIEN,JOHN HOWARD II","SL10","~") --> OBRIEN~J~H COMPONENT: $$FMNAME(NAME,FLAGS,DELIM) VARIABLES: NAME Type: Both (Required) NAME is the HL7 name to be converted. If the "C" flag is used, the name components are returned in nodes descendent from NAME. FLAGS Type: Input Flags to controls processing. Possible values are: C - Return name components in the NAME array. (See "Output:" just after this table.) L# - Truncate the returned name to a maximum Length of # characters, where # is an integer between 1 and 256. M - Return the name in Mixed case, with the first letter of each name component capitalized. S - Return the name in Standardized form. DELIM Type: Input The delimiter used in the HL7 formatted name. (Default = "^") Convert HL7 Formatted Name to Name ================================== This extrinsic function converts an HL7 formatted name to a name in VISTA format. Details: ------- If the L# flag is used, and the resulting name is longer than #, the following pruning algorithm is performed to shorten the name: 1. Truncate Middle Name from the right-most position until only the initial character is left; 2. Drop suffix; 3. Truncate Given Name from the right-most position until only the initial character is left; 4. Truncate Family Name from the right-most position; 5. Truncate the name from the right. Examples: -------- 1. Convert an HL7 formatted name to a VISTA name: $$FMNAME^XLFNAME("O'BRIEN^JOHN^K.^JR^MR.^PHD") --> O'BRIEN,JOHN K. JR $$FMNAME^XLFNAME("O'BRIEN^JOHN^K.^JR^MR.^PHD","S") --> OBRIEN,JOHN K JR $$FMNAME^XLFNAME("O'BRIEN^JOHN^K.^JR^MR.^PHD","M") --> O'Brien,John K. Jr $$FMNAME^XLFNAME("O'BRIEN^JOHN^K.^JR^MR.^PHD","SL12") --> OBRIEN,JOH K 2. Convert an HL7 formatted name where "~" is the delimiter to a standard name: $$FMNAME^XLFNAME("O'BRIEN~JOHN~K.~JR~MR","S","~") --> OBRIEN,JOHN K JR 3. Convert an HL7 formatted name to a standard name, and return the components of that name in the MYNAME array: >S MYNAME="O'BRIEN^JOHN^K.^JR^MR.^PHD" >W $$FMNAME^XLFNAME(.MYNAME,"CS") OBRIEN,JOHN K JR >ZW MYNAME MYNAME=O'BRIEN^JOHN^K.^JR^MR.^PHD MYNAME("FAMILY")=O'BRIEN MYNAME("GIVEN")=JOHN MYNAME("MIDDLE")=K. MYNAME("SUFFIX")=JR ******************** 3066 NAME: NAME COMPONENTS UPDATE CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INCOME VERIFICATION MATCH Used with HEC'S MASTER CLIENT file 300.12 REGISTRATION USAGE: Controlled Subscri ENTERED: MAR 15,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Controlled Subscription Name Standardization APIs. ROUTINE: XLFNAME2 COMPONENT: UPDCOMP(FILE,[.]RECORD,FIELD,[.]NAME,PTRFIELD,PTRVAL,FMTFLAGS) VARIABLES: FILE Type: Input (Required) The number of the file or subfile (the "source file") that contains the name. RECORD Type: Input (Required) The IENS or the internal entry number array (that looks like the DA array) of the record in the source file that contains the name. FIELD Type: Input (Required) The number of the field in the source file that contains the name. NAME Type: Input (Required) An array that contains the component parts of the name to store in the NAME COMPONENTS file entry: NAME("FAMILY) = Family Name (required) NAME("GIVEN") = Given Name(s) (optional) NAME("MIDDLE") = Middle Name(s) (optional) NAME("SUFFIX") = Suffix(es) (optional) NAME("PREFIX") = Prefix (optional) NAME("NOTES") = optional free text string Alternatively, a name in standard format can be passed in the NAME input parameter. If the NAME input parameter has no descendents (that is, $D(NAME)=1), UPDCOMP^XLFNAME2 will make a call to NAMECOMP^XLFNAME to build the NAME array for you. PTRFIELD Type: Input The number of the pointer field in the source file that points to the NAME COMPONENTS file. Only if this parameter is passed will the value of this pointer field be updated with the entry number of the record in the NAME COMPONENTS file that was added or edited. PTRVAL Type: Input The current value of the pointer field specified by the PTRFIELD input parameter. This parameter can be used to save processing time. If both PTRFIELD and PTRVAL are passed, the pointer field will be updated only if this value is different from the entry number of the record in the NAME COMPONENTS file that was added or edited. FMTFLAGS Type: Input This contents of this parameter, if passed, is filed into the SOURCE NAME FORMAT FLAGS (#7) field of the NAME COMPONENTS file. See the DESCRIPTION of field for more information. Update Name Components Entry ============================ This procedure updates an entry in the NAME COMPONENTS file. Optionally, the pointer in the source file that points to the name components entry is also updated. This API is designed to be used in the SET logic of a MUMPS cross-reference on the name field in a source file, to keep the name field and the associated name components in sync. For an example of its use, see the ANAME cross-reference in the NEW PERSON file (#200). The ANAME cross-reference is a MUMPS cross-reference with the .01 NAME field of the NEW PERSON file as its only cross-reference value. If an entry's NAME field is edited, the ANAME cross-reference updates the associated entry in the NAME COMPONENTS file. Note that existing MUMPS cross-references on the NAME COMPONENTS file already exist to update the associated name field on the source file if the components are edited. In the SET and KILL logic, you should check and set the variable XUNOTRIG as follows: I '$G(XUNOTRIG) N XUNOTRIG S XUNOTRIG=1 This prevents the ANAME cross-reference in the NAME COMPONENTS file from circularly updating the source name field. Example: ------- Suppose the .01 field of File #1000 contains a person's name, and the component parts of the name in entry 132 should be updated as follows: Family (last) name: O'BRIEN Given (first) name: JOHN HENRY Middle name: A. Suffix: JR. Field #1.1 is defined as a pointer to the NAME COMPONENTS file (#20) and has a value of 42, the IEN of a record in the NAME COMPONENTS file. To update the NAME COMPONENTS file with this name, you can do the following: >S MYNAME("FAMILY")="O'BRIEN" >S MYNAME("GIVEN")="JOHN HENRY" >S MYNAME("MIDDLE")="A." >S MYNAME("SUFFIX")="JR." >D UPDCOMP^XLFNAME2(1000,132,.01,.MYNAME,1.1,42) If there is an entry in the NAME COMPONENTS file that corresponds to File #1000, Field #.01, IEN #132, that entry is updated with the name components passed in the MYNAME array. Otherwise a new entry is added to the Name Components with this information. If the entry in the Name Components that was updated or added is record #42, no change is made to the value of the pointer field #1.1, since 42 was passed in the 6th parameter. MUMPS cross-references on the NAME COMPONENTS file updates the name in the Field #.01 of File #1000 to "OBRIEN,JOHN HENRY A JR" if it doesn't already contain that name. COMPONENT: DELCOMP(FILE,[.]RECORD,FIELD,PTRFIELD) VARIABLES: FILE Type: Input (Required) The number of the file or subfile (the "source file") that contains the name. RECORD Type: Input (Required) The IENS or the internal entry number array (that looks like the DA array) of the record in the source file that contains the name. FIELD Type: Input (Required) The number of the field in the source file that contains the name. PTRFIELD Type: Input The number of the pointer field in the source file that points to the NAME COMPONENTS file. Only if this parameter is passed will the value of this pointer field be deleted. Delete Name Components Entry ============================ This procedure deletes an entry in the NAME COMPONENTS file, and optionally, the value of the pointer in the source file that points to the name components entry. (This call is designed to be used in the KILL logic for the MUMPS cross-reference mentioned in the description of UPDCOMP^XLFNAME2.) Example: ------- Suppose that you have a NAME COMPONENTS file entry that contains the components of a name stored in File #1000, Record #132, Field #.01. Pointer field #1.1 of that File #1000 is a pointer to the NAME COMPONENTS file. To delete the entry in the NAME COMPONENTS file, and the value of the pointer field, you can do the following: >D DELCOMP^XLFNAME(1000,132,.01,1.1) ******************** 3067 NAME: DISPLAY CONSULT PROCEDURE ORDER INFO CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: MAR 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123 ROOT: GMR(123, DESCRIPTION: TYPE: File PURPOSE: Provide Clinical Procedures with a way to display Consult Procedure order information. ^GMR(123, 5 URGENCY 0;9 Read w/Fileman 20 REASON FOR REQUEST 20;0 Read w/Fileman 30.1 PROVISIONAL DIAGNOSI 30.1;1 Read w/Fileman 8 CPRS STATUS 0;12 Read w/Fileman 4 PROCEDURE/REQUEST TY 0;8 Both R/W w/Fileman 13 REQUEST TYPE 0;17 Both R/W w/Fileman .04 PATIENT LOCATION 0;4 Read w/Fileman 1 TO SERVICE 0;5 Both R/W w/Fileman 1.01 CLINICAL PROCEDURE 1;1 Both R/W w/Fileman ^GMR(123,D0,50, .01 ASSOCIATED RESULTS 0;1 Read w/Fileman ROUTINE: ******************** 3068 NAME: DBIA3068 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: MAR 22,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Primary Care Management Module (PCMM) in Scheduling requests permission to update the 'PCMM' entry in the HL7 APPLICATION PARAMETER (#771) file. The following action will be performed during the post initialization process of patch SD*5.3*210: 1. The Name (#.01) field of this entry will be changed from 'PCMM' to 'PCMM-210'. ROUTINE: ******************** 3070 NAME: SCAPMC Clinic List CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Team Lists use the call to $$PTCL^SCAPMC to retrieve lists of enrolled patients in clinics. USAGE: Controlled Subscri ENTERED: MAR 22,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: SCAPMC COMPONENT: PTCL VARIABLES: SC44 Type: Input Pointer to Hospital Location file #44. SCDATES Type: Input Date array (begin, end, incl). SCLIST Type: Both Name of output array. Array of practitioners (users) - pointers to file #200. If not defined, ^TMP("SC TMP LIST",$J, gets used. May be killed before and after calling. SCERR Type: Both Array NAME to store error messages [ex. ^TMP("ORXX",$J]. List of patients for a clinic. ******************** 3071 NAME: ORX8 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: PROSTHETICS CLINICAL PROCEDURES CP ADDED 7/9/07 HEALTH SUMMARY VIRTUAL PATIENT RECORD Effective with VPR*1*0. CLINICAL REMINDERS HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: MAR 22,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This documents the function $$PKGID^ORX8(ORIFN), which returns a package's order number or identifier given the CPRS order number. ROUTINE: ORX8 COMPONENT: $$PKGID(ORIFN) VARIABLES: ORIFN Type: Input The IEN of the ORDER file (#100) Result Type: Output The result of the extrinsic function is a string as defined by the package that identifies the order in the ancillary package files. Returns the package's order number or identifier for an order ******************** 3072 NAME: Return new or existing ICN CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION Registration uses this call to get an ICN local or national to be passed in an HL7 message. CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: MAR 31,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API will return an ICN if one exists or create and return a Local ICN and updating the appropriate fileds if a Local was created. ROUTINE: MPIF001 COMPONENT: $$ICNLC(DFN) VARIABLES: DFN Type: Input DFN= Patient IEN $$ICNLC Type: Output Returns ICN (local or National including checksum) OR -1^ error message -- couldn't create local or that patient is a test patient with 5 leading 0s for SSN or has been ZZ'd. DFN is the IEN from the Patient (#2) file for that patient that the ICN is to be returned on. ******************** 3073 NAME: determine the LAST TREATMENT DATE for a patient CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: APR 4,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This Integration Agreement (IA) will allow an application to determine the LAST TREATMENT DATE for a single patient. The events that define treatment are: patient admissions, patient discharges and clinic checkouts. This subroutine will trigger Master File Update (MFU) messages that update the DATE LAST TREATED (#.07) field for the TREATING FACILITY LIST (#391.91) file. The CIRN Master of Record (CMOR) and subscribers will have their TREATING FACILITY LIST files updated. ROUTINE: RGADT2 COMPONENT: EN1 VARIABLES: RGDFN Type: Input The internal entry number (ien) of the patient in the PATIENT (#2) file. Patient ien is also referred to as the patient's dfn. RGSUP Type: Input This is a boolean, if not true then a TREATING FACILTY UPDATES Type of Event is added to the ADT/HL7 PIVOT (#391.71) file. If true, the add is suppressed. ******************** 3074 NAME: RAD/NUC MED ORDERS FILE W/PROC. MODS CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Radiology gives Imaging permission to read the PREGNANT field (#13) in the RAD/NUC MED ORDERS file (75.1). Information will be sent in DICOM format messages to commercial PACS, modality worklists for commercial gateways or individual modalities. Radiology also gives Imaging permission to read additional fields to be used during the importing of 'outside' images. VA POINT OF SERVICE (KIOSKS) The VistA RADIOLOGY/NUCLEAR MEDICINE (RA) application version 5.0 allows the VA POINT OF SERVICE (KIOSKS) application access to the RAD/NUC MED ORDERS (#75.1) file. USAGE: Controlled Subscri ENTERED: APR 5,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 75.1 ROOT: RAO(75.1, DESCRIPTION: TYPE: File The following fields are being read from and written to by subscribers to obtain and update patient specific radiology order data. Please look carefully at the fields documented below to determine which can be read from and written to. ^RAO(75.1,D0,0 .01 NAME 0;1 Read w/Fileman The name of the patient. 2 PROCEDURE 0;2 Read w/Fileman This field points to the 'RAD/NUC MED PROCEDURES' file (#71) to indicate the imaging procedure associated to the patient. 5 REQUEST STATUS 0;5 Read w/Fileman This field is a set type field and corresponds to the OE/RR 'ORDER STATUS' file (#100.01). 6 REQUEST URGENCY 0;6 Direct Global Read & w The urgency of the request; '1' for STAT, '2' for URGENT, '9' for ROUTINE. 12 PRE-OP SCHEDULED DAT 0;12 Direct Global Read & w The date/time if a patient has a pre-op scheduled. 13 PREGNANT 0;13 Direct Global Read & w Pregnancy status of patient. (Yes,No,Unknown) 16 REQUEST ENTERED DATE 0;16 Read w/Fileman The date and time the request was entered. 20 IMAGING LOCATION 0;20 Both R/W w/Fileman The imaging location for the study. The data for 'RAD/NUC MED ORDERS' file is stored in the ^RAO(75.1,global.. ^RAO(75.1,D0,.1 1.1 REASON FOR STUDY .1;1 Read w/Fileman The reason for the study is often a short patient history summarizing the condition of the patient and giving background information as to why the study has been initiated. ^RAO(75.1,DO,'M',D1,0 .01 PROCEDURE MODIFIERS 0;1 Read w/Fileman This multiple field is used to provide rad/nuc med procedure modifiers for the exam. ROUTINE: ******************** 3076 NAME: ORQQPX SEARCH ITEMS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: APR 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Read access to the XPAR Parameter ORQQPX SEARCH ITEMS. ROUTINE: ******************** 3078 NAME: DBIA3078 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Calls to PXRMRPCA USAGE: Controlled Subscri ENTERED: APR 11,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are the entry points for the PXRMRPCA routine: 1) ALIST^PXRMRPCA(.ORY,ORPT,.LIST) - Evaluate a list of reminders 2) APPL^PXRMRPCA(.ORY,ORPT,.LIST) - Evaluate reminders for CPRS cover sheet 3) CATEGORY^PXRMRPCA(.ORY,ORPT,ORLOC) - List of categories 4) LIST^PXRMRPCA(.ORY,ORPT,ORLOC) - List of reminders (unevaluated) 5) REMDET^PXRMRPCA(..ORY,ORPT,ORREM) - Clinical Maintenance display 6) WEB^PXRMRPCA(.ORY,ORREM) - Web sites for a reminder Output is returned in ORY array ROUTINE: PXRMRPCA COMPONENT: ALIST VARIABLES: ALIST^PXRMRPCA(.ORY,ORPT.LIST) - Evaluate a list of reminders for a patient Allows evaluation of a list of reminders. Returns a list of clinical reminders due/applicable or not applicable to the patient. INPUT: ORPT Patient identifier from the patient file [#2] INPUT: LIST List of reminders in format : LIST(1) = reminder ien1 (from #811.9) LIST(2) = reminder ien2 etc OUTPUT: ORY List of reminders in format: ORY(CNT)=IEN^PRINT NAME^DUE DATE/TIME^LAST OCCURRENCE DATE/TIME^PRIORITY^DUE DUE=0 - Applicable DUE=1 - Due DUE=2 - Not Applicable COMPONENT: APPL VARIABLES: APPL^PXRMRPCA(.ORY,ORPT,.LIST) - Evaluate reminders for CPRS cover sheet Returns a list of clinical reminders due/applicable or not applicable to the patient. INPUT: ORPT Patient identifier from the patient file [#2] INPUT: LIST List of reminders in format : LIST(1) = reminder ien1 (from #811.9) LIST(2) = reminder ien2 etc OUTPUT: ORY List of reminders in format: ORY(CNT)=IEN^PRINT NAME^DUE DATE/TIME^LAST OCCURRENCE DATE/TIME^PRIORITY^DUE DUE=0 - Applicable DUE=1 - Due COMPONENT: CATEGORY VARIABLES: CATEGORY^PXRMRPCA(.ORY,ORPT,ORLOC) - List of categories Returns list of all CPRS lookup categories and associated reminders INPUT: ORPT Patient Identifier from Patient file [#2] INPUT: ORLOC Patient's HOSPITAL LOCATION [#44]. May be null. OUTPUT: ORY Returns array of categories and reminders based on CPRS lookup categories for this patient service/location. FORMAT OF OUTPUT ORY(1)=identifier^type^name^parent identifier^reminder ien ORY(2)=identifier^type^name^parent identifier^reminder ien type C = category R = reminder COMPONENT: REMDET VARIABLES: REMDET^PXRMRPCA(..ORY,ORPT,ORREM) - Clinical Maintenance display Returns the details of a clinical reminder for a patient INPUT: ORPT Patient identifier from Patient file [#2] INPUT: ORREM Clinical reminder (ien) from CLINICAL REMINDER DEFINITION file [#811.9] OUTPUT: ORY Formatted details of the clinical reminder ORY(1)=text ORY(2)=text COMPONENT: WEB VARIABLES: WEB^PXRMRPCA(.ORY,ORREM) - Web sites for a reminder Web addresses for selected reminder INPUT: ORREM Clinical reminder (ien) from CLINICAL REMINDER DEFINITION file [#811.9] OUTPUT: ORY Formatted list of web addresses ORY(1)=description^address E.G. ORY(0)=4 ORY(1)=Influenza Directive^http://www.va.gov/publ/direct/194026.htm ORY(2)=Medical Home Pages^http://www.va.gov/bookmark/Medhome.htm ORY(3)=National Guideline Clearinghouse^http://www.guideline.com ORY(4)=VISN01 Web Page^http://vaww.visn1.med.va.gov COMPONENT: LIST VARIABLES: LIST^PXRMRPCA(.ORY,ORPT,ORLOC) - List of reminders (unevaluated) Returns list of CPRS reminders for patient/location (no evaluation is done) INPUT: ORPT Patient identifier from the patient file [#2] INPUT: ORLOC Patients location from HOSPITAL LOCATION [#44]. May be null OUTPUT: ORY List of reminder iens [#811.9]. ORY(1)=ien1 ORY(2)=ien2 COMPONENT: $$DLG(IEN) VARIABLES: IEN Type: Input the IEN of the Reminder definition from file #811.9 $$DLG Type: Output 0 == if the reminder does no have a dialog assigned or is disabled. 1 == if the reminder has an active dialog assigned. Determine if the Reminder has a Reminder dialog associated with the reminders and the dialog is not disabled. If the reminder has an active dialog assigned to it a value of 1 is return. If the reminder does not have a dialog assign to it or if the dialog is disabled the then a value of 0 is returned. COMPONENT: $$DLGWIPE(IEN) VARIABLES: IEN Type: Input the IEN of the Reminder definition from file #811.9 $$DLGWIPE Type: Output 0 == if the reminder does not have an associated dialog or if the field #112 (Patient Specific) of file 801.41 is false. 1 == if the reminder has an associated dialog and if field #112 is set to true. Check to see if the reminder has an associated dialog. If it does then it checks to see if field #112 (Patient Specific) of file 801.41 is set to true, if so the function returns a value of 1. If the reminder does not have an associated dialog or if the field #112 (Patient Specific) is not set to true then the function returns a value of 0. ******************** 3079 NAME: DBIA3079 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Calls to PXRMRPCB USAGE: Controlled Subscri ENTERED: APR 11,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are the entry points for the PXRMRPCB routine: 1) EDL^PXRMRPCB(.ORY,ORREM) - List education topics for a reminder 2) EDS^PXRMRPCB(.ORY,OREDU) - List sub-topics for an education topic 3) EDU^PXRMRPCB(.ORY,OREDU) - Display an education topic Output is returned in ORY array ROUTINE: PXRMRPCB COMPONENT: EDL VARIABLES: EDL^PXRMRPCB(.ORY,ORREM) - List education topics for a reminder INPUT: ORREM Clinical reminder (ien) from CLINICAL REMINDER DEFINITION file [#811.9] OUTPUT: ORY List of education topics for this reminder in format ORY(1)=ien1^name1^print name1 ORY(2)=ien2^name2^print name2 COMPONENT: EDS VARIABLES: EDS^PXRMRPCB(.ORY,OREDU) - List sub-topics for an education topic INPUT: OREDU Education topic (ien) from EDUCATION TOPIC file [#9999999.09] OUTPUT: ORY List of education sub-topics in format: ORY(1) = ien1^name1^print name1^sequence number1 ORY(2) = ien2^name2^print name2^sequence number2 COMPONENT: EDU VARIABLES: EDU^PXRMRPCB(.ORY,OREDU) - Display an education topic INPUT: OREDU Education topic (ien) from EDUCATION TOPIC file [#9999999.09] OUTPUT: ORY Detailed description of education topic as formatted text ORY(1) = Display text line 1 ORY(2) = Display text line 2 ******************** 3080 NAME: CPRS REMOTE PROCEDURE CALLS CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Calls to PXRMRPCC USAGE: Controlled Subscri ENTERED: APR 11,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These are the entry points for routine PXRMRPCC: 1) ACTIVE^PXRMRPCC(.ORY,.LIST) - List active dialogs for selected reminders 2) DIALOG^PXRMRPCC(.ORY,ORREM) - Load a reminder dialog 3) HDR^PXRMRPCC(.ORY,ORLOC)- Progress Note Header by location/service/user 4) MH^PXRMRPCC(.ORY,ORTEST) - Load MH test details 5) MHR^PXRMRPCC(.ORY,ORMHR,.ORES) - Get MH test score and result (P/N text) 6) MHS^PXRMRPCC(.ORY,.ORES) - Save MH test results to MH package 7) MST^PXRMRPCC(.ORY,ORPT,ORDATE,ORSTAT,ORPROV,ORFTYP,ORFIEN,ORRES) - Update MST 8) PROMPT^PXRMRPCC(.ORY,ORDLG,ORDCUR,ORFTYP,ORIEN) - Load additional prompts 9) RES^PXRMRPCC(.ORY,ORREM) - Display reminder inquiry 10) WH^PXRMRPCC(.ORY,ORRESULT) - Save WH Exam Results to the WV package Output is returned in the ORY array ROUTINE: PXRMRPCC COMPONENT: ACTIVE VARIABLES: ACTIVE^PXRMRPCC(.ORY,.LIST) - List active dialogs for selected reminders For a list of reminders [#811.9] returns same list with status to indicate if an active dialog exists for the reminder. INPUT: LIST List of reminders in format : LIST(1) = reminder ien1 (from #811.9) LIST(2) = reminder ien2 OUTPUT: ORY Array of clinical reminders in format ORY(1)=Reminder_U_Status ORY(2)=Reminder_U_Status Where status: 0 - No active dialog 1 - Active dialog COMPONENT: DIALOG VARIABLES: DIALOG^PXRMRPCC(.ORY,ORREM) - Load a reminder dialog Dialog for a given reminder INPUT: ORREM Clinical reminder (ien) from CLINICAL REMINDER DEFINITION file [#811.9] OUTPUT: ORY For each dialog item in the reminder dialog for the reminder : Type 1 records - Initial states 1^dialog item ien[#801.41]^dialog ien [#801.412]^^^^ Type 2 records - Question text 2^dialog item ien[#801.41]^dialog ien [#801.412]^text COMPONENT: MH VARIABLES: MH^PXRMRPCC(.ORY,ORTEST) - Load MH test details Returns array for given mental health instrument INPUT: ORTEST Name of the mental health instrument OUTPUT: ORY Returns array of mental health instrument questions/answers (variable format) COMPONENT: MHR VARIABLES: MHR^PXRMRPCC(.ORY,ORMHR,.ORES) - Get MH test score and result (P/N text) Returns progress note text based on the results of the test. INPUT: ORMHR This is the pointer to the result group for the test [#801.41,.01]. INPUT: ORES Test results in YS array format(R1,R2,DFN,DUZ,ADATE etc). OUTPUT: ORY Returns array of progress note text as multiple type 7 records. COMPONENT: MHS VARIABLES: MHS^PXRMRPCC(.ORY,.ORES) - Save MH test results to MH package Stores test result responses from a reminder dialog. INPUT: ORES Test results in YS array format(R1,R2,DFN,DUZ,ADATE etc). OUTPUT: ORY Returns either [DATA]saved ok or -1^[ERROR]description of error COMPONENT: PROMPT VARIABLES: PROMPT^PXRMRPCC(.ORY,ORDLG,ORDCUR,ORFTYP,ORIEN) - Load additional prompts Additional prompts for a given dialog element INPUT: ORDLG Reminder dialog element identifier (ien) from REMINDER DIALOG file [#801.41] INPUT: ORCUR Used only for taxonomy dialogs. 0 - Current Diagnosis/Procedure 1 - Historical Diagnosis/Procedure INPUT: ORFTYP For taxonomy dialog the type of finding (POV/CPT) for this dialog line INPUT: ORIEN Reminder dialog identifier (IEN) from REMINDER DIALOG file [#801.41] of the dialog that contains the element identified in parameter ORDLG. OUTPUT: ORY For a selected dialog element type 3 - Resolutions 3^dialog item ien[#801.41]^line id^resolution type code^ien[#various] type 4 - Additional prompts 4^dialog item ien[#801.41]^line id^prompt text type 5 - Listbox items (cpt/pov) 5^dialog item ien[#801.41]^line id^cpt/pov ien^code/desc COMPONENT: RES VARIABLES: RES^PXRMRPCC(.ORY,ORREM) - Display reminder inquiry INPUT: ORREM Clinical reminder (ien) from CLINICAL REMINDER DEFINITION file [#811.9] OUTPUT: ORY Detailed description of clinical reminder as formatted text ORY(1) = Display text line 1 ORY(2) = Display text line 2 ORY(3) = etc COMPONENT: MST VARIABLES: MST^PXRMRPCC(ORY,ORPT,ORDATE,ORSTAT,ORPROV,ORFTYP,ORFIEN,ORRES ) - update MST from reminder dialog. INPUT: ORPT Patient DFN INPUT: ORDATE Date/time of encounter INPUT: ORSTAT MST status code (Y, N or D) - Null if finding is an exam INPUT: ORPROV Primary provider IEN INPUT: ORFTYP Finding type code (from PCE) INPUT: ORFIEN Finding IEN INPUT: ORRES Exam result - Optional. Only required for EXAM type findings OUTPUT: ORY ORY(1) = IEN - successfull update of MST or ORY(1) = -1^ERROR MESSAGE - failure to update and reason COMPONENT: HDR VARIABLES: ORY Type: Output Returned the PXRM Progress Note Header to CPRS. ORLOC Type: Input ORLOC is the Hospital Location. Returned the PXRM Progress Note Header by location/service/user COMPONENT: WH VARIABLES: ORY Type: Output ORRESULT Type: Input ORRESULT is an array containing the unformatted WH Result data from CPRS. This entry point will format the data received from CPRS. Once the data is format this entry point will send the data to the WH package. ******************** 3081 NAME: DBIA3081 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Calls to $$GET^XPAR are allowed USAGE: Controlled Subscri ENTERED: APR 12,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Read access to the following XPAR Parameter Definitions: PXRM GUI REMINDERS ACTIVE PXRM MENTAL HEALTH ACTIVE ROUTINE: ******************** 3082 NAME: PROTOCOL Distribution CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: APR 17,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Clinical Information Resource Network (CIRN) is establishing this integration agreement to include the following Registration PROTOCOLS in CIRN builds, distributed as MERGE MENU ITEMS. The purpose of including these event driver PROTOCOLS is to attach our subscriber PROTOCOLS that are exported in the build. Registration event driver PROTOCOLS CIRN subscriber PROTOCOLS ------------------------------------------------ VAFC ADT-A04 SERVER RG ADT-A04 TRIGGER VAFC ADT-A08 SERVER RG ADT-A08 TRIGGER ROUTINE: ******************** 3083 NAME: Health Factors in Clinical Reminders and Health Summary CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS HEALTH SUMMARY Health Summary needs the ability to read and display fields from Health Factors. Added 04/21/2021, effective with patch GMTS*2.7*122. USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.64 ROOT: AUTTHF( DESCRIPTION: TYPE: File Health Factors are used as a finding in Clinical Reminders. The Clinical Reminder Exchange Utility allows sites to exchange Clinical Reminder definitions and all the associated components. Therefore Clinical Reminders needs to read and write all fields in the file. ^AUTTHF( .01 FACTOR 0;1 Direct Global R/W & w/ .03 CATEGORY 0;3 Direct Global R/W & w/ .04 SHORT NAME 0;4 Direct Global R/W & w/ .05 USE ONLY WITH SEX 0;5 Direct Global R/W & w/ .06 LOWER AGE 0;6 Direct Global R/W & w/ .07 UPPER AGE 0;7 Direct Global R/W & w/ .08 DISPLAY ON HEALTH SU 0;8 Direct Global R/W & w/ .09 SYNONYM 0;9 Direct Global R/W & w/ .1 ENTRY TYPE 0;10 Direct Global R/W & w/ .11 INACTIVE FLAG 0;11 Direct Global R/W & w/ ^AUTTHF(D0,11,D1) .01 NOT USED WITH 11,D1;1 Direct Global R/W & w/ ^AUTTHF("B", Direct global read access permitted. ^AUTTHF("D", Direct global read access permitted. ^AUTTHF(D0,100) 100 CLASS 100;1 Direct Global R/W & w/ 101 SPONSOR 100;2 Direct Global R/W & w/ ^AUTTHF(D0,200) 200 PRINT NAME 200 Direct Global R/W & w/ ^AUTTHF(D0,201) 201 DESCRIPTION 201 Direct Global R/W & w/ ^AUTTHF(D0,210,D1) .01 CODING SYSTEM 210,D1;1 Direct Global R/W & w/ 1 CODE 210,D1;2 Direct Global R/W & w/ 2 DATE MAPPED 210,D1;3 Direct Global R/W & w/ ^AUTTHF(D0,220) 220 MINIMUM VALUE 220;1 Direct Global R/W & w/ 221 MAXIMUM VALUE 220;2 Direct Global R/W & w/ 222 MAXIMUM DECIMALS 220;3 Direct Global R/W & w/ 223 UCUM CODE 220;4 Direct Global R/W & w/ ^AUTTHF(D0,230,D1) .01 CODING SYSTEM 230;1 Direct Global R/W & w/ 1 CODE 230;2 Direct Global R/W & w/ 2 DATE DELETED 230;3 Direct Global R/W & w/ 3 USER 230;4 Direct Global R/W & w/ 4 MSE REMOVAL COMPLETI 230;5 Direct Global R/W & w/ ROUTINE: ******************** 3084 NAME: DBIA3084 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS VISUAL IMPAIRMENT SERVICE TEAM ADDED 6/8/09 VA POINT OF SERVICE (KIOSKS) MENTAL HEALTH Added 10/1/19, effective with YS*5.01*135. USAGE: Controlled Subscri ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.23 ROOT: AUPNVHF( DESCRIPTION: TYPE: File Health Factors are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVHF('AA', ^AUPNVHF(D0,0) .03 VISIT 0;3 Direct Global Read & w .04 LEVEL/SEVERITY 0;4 Direct Global Read & w .01 HEALTH FACTOR 0;1 Direct Global Read & w ^AUPNVHF('C', ^AUPNVHF('AED', ROUTINE: ******************** 3085 NAME: EDUCATION TOPICS IN CLINICAL REMINDERS AND HEALTH SUMMARY CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS HEALTH SUMMARY Health Summary needs the ability to read and display fields from Education Topics. Added 04/21/2021, effective with patch GMTS*2.7*122. USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.09 ROOT: AUTTEDT( DESCRIPTION: TYPE: File Education Topics are used as a finding in Clinical Reminders. The Clinical Reminder Exchange Utility allows sites to exchange Clinical Reminder definitions and all the associated components. Therefore Clinical Reminders needs to read and write all fields in the file. ^AUTTEDT(D0,0) .01 NAME 0;1 Direct Global R/W & w/ .04 PRINT NAME 0;4 Direct Global R/W & w/ .03 INACTIVE FLAG 0;3 Direct Global R/W & w/ ^AUTTEDT(D0,10) .01 SUBTOPIC 0;1 Direct Global R/W & w/ 3 SEQUENCE 0;3 Direct Global R/W & w/ ^AUTTEDT(D0,11) .01 EDUCATIONAL OUTCOME 0;1 Direct Global R/W & w/ ^AUTTEDT(D0,12) .01 EDUCATIONAL STANDARD 0;1 Direct Global R/W & w/ ^AUTTEDT(D0,100) 100 CLASS 100;1 Direct Global R/W & w/ 101 SPONSOR 100;2 Direct Global R/W & w/ ^AUTTEDT(D0,201) 201 DESCRIPTION 201 Direct Global R/W & w/ ^AUTTEDT(D0,210,D1) .01 CODING SYSTEM 210,D1;1 Direct Global R/W & w/ 1 CODING SYSTEM 210,D1;2 Direct Global R/W & w/ 2 DATE MAPPED 210,D1;3 Direct Global R/W & w/ ^AUTTEDT(D0,220) 220 MINIMUM VALUE 220;1 Direct Global R/W & w/ 221 MAXIMUM VALUE 220;2 Direct Global R/W & w/ 222 MAXIMUM DECIMALS 220;3 Direct Global R/W & w/ 223 UCUM CODE 220;4 Direct Global R/W & w/ ^AUTTEDT(D0,230,D1) .01 CODE 230;1 Direct Global R/W & w/ 1 CODING SYSTEM 230;2 Direct Global R/W & w/ 2 DATE DELETED 230;3 Direct Global R/W & w/ 3 USER 230;4 Direct Global R/W & w/ 4 MSE REMOVAL COMPLETI 230;5 Direct Global R/W & w/ ROUTINE: ******************** 3086 NAME: DBIA3086 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.16 ROOT: AUPNVPED( DESCRIPTION: TYPE: File Education Topics are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVPED('AA', ^AUPNVPED(D0,0) .01 TOPIC 0;1 Direct Global Read & w .03 VISIT 0;3 Direct Global Read & w .06 LEVEL OF UNDERSTANDI 0;6 Direct Global Read & w ROUTINE: ******************** 3087 NAME: EXAMS IN CLINICAL REMINDERS AND HEALTH SUMMARY CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS HEALTH SUMMARY Health Summary needs the ability to read and display fields from Education Topics. Added 04/21/2021, effective with patch GMTS*2.7*122. USAGE: Private ENTERED: MAY 19,2000 STATUS: Under Revision EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.15 ROOT: AUTTEXAM( DESCRIPTION: TYPE: File Exams are used as a finding in Clinical Reminders. The Clinical Reminder Exchange Utility allows sites to exchange Clinical Reminder definitions and all the associated components. Therefore Clinical Reminders needs to read and write all fields in the file. ^AUTTEXAM(D0,0) .01 NAME 0;1 Direct Global R/W & w/ .03 SEX SPECIFIC 0;3 Direct Global R/W & w/ .04 INACTIVE FLAG 0;4 Direct Global R/W & w/ ^AUTTEXAM(D0,100) 100 CLASS 100;1 Direct Global R/W & w/ 101 SPONSOR 100;2 Direct Global R/W & w/ ^AUTTEXAM(D0,200) 200 PRINT NAME 200;1 Direct Global R/W & w/ ^AUTTEXAM(D0,201) 201 DESCRIPTION 201 Direct Global R/W & w/ ^AUTTEXAM(D0,210,D1) .01 CODING SYSTEM 210,D1;1 Direct Global R/W & w/ 1 CODE 210,D1;2 Direct Global R/W & w/ 2 DATE MAPPED 210,D1;3 Direct Global R/W & w/ ^AUTTEXAM(D0,220) 220 MINIMUM VALUE 220;1 Direct Global R/W & w/ 221 MAXIMUM VALUE 220;2 Direct Global R/W & w/ 222 MAXIMUM DECIMALS 220;3 Direct Global R/W & w/ 223 UCUM CODE 220;4 Direct Global R/W & w/ ^AUTTEXAM(D0,230,D1) .01 CODING SYSTEM 230;1 Direct Global R/W & w/ 1 CODE 230;2 Direct Global R/W & w/ 2 DATE DELETED 230;3 Direct Global R/W & w/ 3 USER 230;4 Direct Global R/W & w/ 4 MSE REMOVAL COMPLETI 230;5 Direct Global R/W & w/ ROUTINE: ******************** 3088 NAME: DBIA3088 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.13 ROOT: AUPNVXAM( DESCRIPTION: TYPE: File Exams are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVXAM('AA', ^AUPNVXAM(D0,0) .03 VISIT 0;3 Direct Global Read & w .04 RESULT 0;4 Direct Global Read & w ROUTINE: ******************** 3089 NAME: DBIA3089 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: JUL 15,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.14 ROOT: AUTTIMM( DESCRIPTION: TYPE: File Immunizations are used as a finding in Clinical Reminders. The Clinical Reminder Exchange Utility allows sites to exchange Clinical Reminder definitions and all the associated components. Therefore Clinical Reminders needs to read and write all fields in the file. ^AUTTIMM(D0,0) .01 NAME 0;1 Direct Global R/W & w/ .02 SHORT NAME 0;2 Direct Global R/W & w/ .05 MAX # IN SERIES 0;5 Direct Global R/W & w/ .07 INACTIVE FLAG 0;7 Direct Global R/W & w/ ^AUTTIMM(D0,88) 1 MNEMONIC 88;1 Direct Global R/W & w/ ROUTINE: ******************** 3090 NAME: DBIA3090 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.11 ROOT: AUPNVIMM( DESCRIPTION: TYPE: File Immunizations are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVIMM('AA', ^AUPNVIMM(D0,0) .03 VISIT 0;3 Direct Global Read & w .04 SERIES 0;4 Direct Global Read & w .06 REACTION 0;6 Direct Global Read & w .07 CONTRAINDICATED 0;7 Direct Global Read & w ROUTINE: ******************** 3091 NAME: DBIA3091 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.28 ROOT: AUTTSK( DESCRIPTION: TYPE: File Skin Tests are used as a finding in Clinical Reminders. The Clinical Reminder Exchange Utility allows sites to exchange Clinical Reminder definitions and all the associated components. Therefore Clinical Reminders needs to read and write all fields in the file. ^AUTTSK(D0,0) .01 NAME 0;1 Direct Global R/W & w/ .03 INACTIVE FLAG 0;3 Direct Global R/W & w/ ^AUTTSK(D0,88) 1 MNEMONIC 88;1 Direct Global R/W & w/ ROUTINE: ******************** 3092 NAME: DBIA3092 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.12 ROOT: AUPNVSK( DESCRIPTION: TYPE: File Skin Tests are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVSK('AA', ^AUPNVSK(D0,0) .03 VISIT 0;3 Direct Global Read & w .04 RESULTS 0;4 Direct Global Read & w .05 READING 0;5 Direct Global Read & w ROUTINE: ******************** 3093 NAME: DBIA3093 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.18 ROOT: AUPNVCPT( DESCRIPTION: TYPE: File CPT procedures are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVCPT('AA', ^AUPNVCPT(D0,0) .03 VISIT 0;3 Direct Global Read & w .04 PROVIDER NARRATIVE 0;4 Direct Global Read & w ROUTINE: ******************** 3094 NAME: DBIA3094 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS PHARMACY BENEFITS MANAGEMENT LAB SERVICE RADIOLOGY/NUCLEAR MEDICINE HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** The Enterprise Health MGMT Platform (HMP) is accessing the V POV file (#9000010.07) to retrieve the POV (.01), Visit (.03), Provider Narrative (.04) and the Primary/Secondary (.12) fields. USAGE: Controlled Subscri ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.07 ROOT: AUPNVPOV( DESCRIPTION: TYPE: File V POV diagnoses are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNVPOV('AA', ^AUPNVPOV(D0,0) .01 POV 0;1 Direct Global Read & w .03 VISIT 0;3 Direct Global Read & w .04 PROVIDER NARRATIVE 0;4 Direct Global Read & w .12 PRIMARY/SECONDARY 0;12 Direct Global Read & w ROUTINE: ******************** 3095 NAME: DBIA3095 CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000011 ROOT: AUPNPROB( DESCRIPTION: TYPE: File Problem List diagnoses are used as a finding in Clinical Reminders. Therefore Clinical Reminders needs to read the following fields. ^AUPNPROB('AC' ^AUPNPROB(D0,0) .05 PROVIDER NARRATIVE 0;5 Direct Global Read & w ROUTINE: ******************** 3096 NAME: DBIA3096 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9999999.27 ROOT: AUTNPOV( DESCRIPTION: TYPE: File A Provider Narrative entry is associated with Problem List, V POV, and V CPT entries. Each of these are used as a finding in Clinical Reminders. The Provider Narrative is displayed in the Clinical Maintenance output for each of this finding types. Therefore Clinical Reminders needs to read the following field. ^AUTNPOV(D0,0) .01 NARRATIVE 0;1 Direct Global Read & w ROUTINE: ******************** 3097 NAME: DBIA3097 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY CMOP USAGE: Controlled Subscri ENTERED: APR 21,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File ^DPT(D0,'NHC') 148 CNH CURRENT NHC;1 Direct Global Read & w This field is used to denote when a patient is in a contract nursing home. Answer yes if the patient is in a contract nursing home currently. Otherwise, answer no. ROUTINE: ******************** 3098 NAME: HL7 APIs CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 24,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine APIs for HL7 package. These APIs are available after patch HL*1.6*64. ROUTINE: HLUTIL COMPONENT: $$MSGSTAT(msg id) VARIABLES: msg id Type: Input The message identifier that uniquely identifies the message. This function will return the message status for the given message id. input value: X = message id return value: status^status updated^error msg.^error type pointer^queue position or # of retries^# open failed^ack timeout status: 0 = message doesn't exist 1 = waiting in queue 1.5 = opening connection 1.7 = awaiting response, # of retries 2 = awaiting application ack 3 = successfully completed 4 = error 8 = being generated 9 = awaiting processing COMPONENT: $$MSGACT(msg id, action) VARIABLES: msg id Type: Input The message identifier that uniquely identifies the message in file 773, HL7 MESSAGE ADMINISTRATION file. action Type: Input The action to perform on the message. 1 = cancel, 2 = requeue. Take an action on an outgoing HL7 message. Only works on messages going out on a TCP Logical Link. Actions: 1 = cancel, 2 = requeue. Returns: 1 = sucess, 0 = failed COMPONENT: $$CHKLL(institution) VARIABLES: institutio Type: Input This is the institution name or number. This function checks the setup of the Logical Link identified by the institution name or number. This will only work with TCP Logical Links. Returns: 1 = Link is setup correctly, 0 = Link is not setup correctly. ******************** 3099 NAME: HL7 APIs CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 24,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine HL7 APIs for the routine HLCSUTL. These are available after patch HL*1.6*64. ROUTINE: HLCSUTL COMPONENT: $$FLD(.HLNODE, field) VARIABLES: HLNODE Type: Input This variable contains a message segment. It is defined when processing a HL7 message and executing HLNEXT. field Type: Input A number that defines the position in the segment for the value you want. This function will return the value for the field in a HL7 message segment. input value: HLNODE = HLNODE from the HLNEXT call, passed by reference field = number, field position in segment note: HL("FS") must be defined return value: value for the field in this segment COMPONENT: $$MSG(msg id, return ref) VARIABLES: msg id Type: Input The message identifier that uniquely identifies the message. return ref Type: Input A closed local or global reference to put the HL7 message. This function puts the complete HL7 message, including header, into the close reference, return ref. This is only for TCP tcp messages. input: msg id = message identifier return ref = closed local or global reference output: return 1 for success and 0 if message doesn't exist The message is returned with blank line between each segment, example: ref(1)=MSH^~ |\&VOICERAD^^RADIOLOGY^^20000110145151-0800^^ORU~R01^1231^T^2. 2| ref(2)= ref(3)=PID^^^100~10~M11^^JONES~JOHN^^19421111^M^^^^^^^^^^12345 6789 ref(4)= ******************** 3100 NAME: MPI-AUSTIN.VA.GOV domain set to send CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: MAR 22,2001 STATUS: Active EXPIRES: AUG 1,2001 DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2, DESCRIPTION: TYPE: File CIRN Patient Demographics has an agreement to do a read with FileMan on the NAME (#.01) and FLAGS (#1) fields in the DOMAIN (#4.2) file, as well as the TRANSMISSION SCRIPT (#4) multiple, the TRANSMISSION SCRIPT (#.01) field, NETWORK ADDRESS (MAILMAN HOST) (#1.4) field and OUT OF SERVICE (#1.5) field. This is used in environment check routine, RGP13ENV, to ensure that the instructions in informational patch XM*DBA*144 have been followed for domain "MPI-AUSTIN.VA.GOV". The environment check routine will not allow patch RG*1.0*13 to be installed in the production environment unless the FLAGS field (#1) has been set to "S", the NETWORK ADDRESS (MAILMAN HOST) (#1.4) field contains the correct address and the OUT OF SERVICE (#1.5) field is null. ^DIC(4.2, .01 NAME 0;1 Read w/Fileman 1 FLAGS 0;2 Read w/Fileman ^DIC(4.2,D0,1, .01 TRANSMISSION SCRIPT 0;1 Read w/Fileman 1.4 NETWORK 0;6 Read w/Fileman 1.5 OUT OF SERVICE 0;7 Read w/Fileman ROUTINE: ******************** 3101 NAME: DBIA3101 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAY 3,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File PCE name-spaced routine references $D(^DPT(IEN)) in order to do a one-time file clean up. ^DPT(IEN)) ROUTINE: ******************** 3102 NAME: DBIA3102 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: MAY 3,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925 DESCRIPTION: TYPE: File PCE name-spaced routine references $D(^TIU(8925,"C",IEN)) in order to do a one-time file clean up. ^TIU(8925,'C' ROUTINE: ******************** 3103 NAME: RESOURCE FILE MANAGEMENT CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CMOP The CMOP transmission process relies on the PSX resource device to ensure that only one CMOP job runs at a time. As long as the sites keep the AVAILABLE SLOTS field set to one there is never a problem. However, despite many efforts at training we continually discover the AVAILABLE SLOTS set to more than one. Because two CMOP jobs running simultaneously has resulted in merged data and involves patient safety, the CMOP package requests the ability to monitor the PSX resource device and, if necessary, reset the available slots field to one. GLOBAL REFERENCE: ^%ZISL(3.54,0 .01 NAME 0;1 Read with Fileman 1 AVAILABLE SLOTS 0;2 Read with Fileman ^%ZISL(3.54,D0,1,0 .01 SLOT IN USE 1;1 R/W with Fileman 3 TASK # 1;4 Read with Fileman USAGE: Private ENTERED: MAY 4,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.54 ROOT: %ZISL(3.54 DESCRIPTION: TYPE: File To prevent multiple jobs from running simultaneously through a resource device, the device must be monitored. Also, if a job that is utilizing a resource device fails, the device must be cleared manually. This IA will allow the CMOP package to manage the PSX resource device and prevent potentially harmful results from data merging. ROUTINE: ******************** 3104 NAME: Direct Read of USR ACTION FILE (#8930.8) CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.8 ROOT: USR(8930.8 DESCRIPTION: TYPE: File TIU frequently sends "You may not..." messages such as "You may not ATTACH this UNSIGNED TELEPHONE NOTE TO AN ID NOTE." In order to create such messages, TIU reads the B cross-reference of file 8930.8 to get the record number of a given action, and then reads pieces 5 and 7 of the 0 node to get the USER VERB and the USER VERB MODIFIER for the given action, for use in feedback messages such as the one above. ^USR(8930.8,'B', ^USR(8930.8,DO,0) .05 USER VERB 0;5 Direct Global Read & w .07 USER VERB MODIFIER 0;7 Direct Global Read & w ROUTINE: ******************** 3105 NAME: TASK FILE LOOKUP CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CMOP USAGE: Private ENTERED: MAY 4,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSCH DESCRIPTION: TYPE: File The CMOP package requests the ability to perform a check against a lock being held on ^%ZTSCH("TASK",ZTSK) to enable a background reset of the resource device PSX. ROUTINE: ******************** 3106 NAME: Problem List direct views of DIC(49 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: PROBLEM LIST USAGE: Private ENTERED: MAY 4,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 49 ROOT: DIC(49 DESCRIPTION: TYPE: File This DBIA documents direct global references made by Problem List to the SERVICE/SECTION file (#49). These references are used by Problem List to retrieve the service abbreviation from file 49. This data is then provided to Health Summary for display. ^DIC(49,D0,0) 1 ABBREVIATION 0;2 Direct Global Read & w This field contains the accepted abbreviation for this service or section. ROUTINE: ******************** 3107 NAME: DBIA3107 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: NATIONAL DRUG FILE When a Dispense Drug is matched, re-matched or un-matched to and from an NDF VA Product through the National Drug File (NDF) application a few updates must be performed to the DRUG file (#50) such as updates to the POSSIBLE DOSAGES sub-file (#903) and setting of some related fields in the "ND" node. USAGE: Private ENTERED: MAY 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine National Drug File requests permission to call entry points in the Pharmacy Data Management package to perform updates related to matching, re-matching and un-matching Dispense Drugs in the DRUG file (#50) to and from NDF VA Products in the VA PRODUCT file (#50.68). Note: These entry points should only be used for approved drug matching, re-matching and un-matching functions. ROUTINE: PSSUTIL COMPONENT: EN1(PSSDIEN,PSSTALK) VARIABLES: PSSDIEN Type: Input This is the pointer to the DRUG (#50) File entry. PSSTALK Type: Input This variable determines whether or not this call is interactive. If this variable is '0', then Possible Dosages and Local Possible Dosages will be deleted. If this variable is '1', the Possible Dosages are deleted, and if Local Possible Dosages exist, the user will be shown these entries, then prompted on whether these entries should be deleted. This entry point is used to delete dosage information in the DRUG (#50) File. COMPONENT: EN2(PSSDIEN,PSSTALK) VARIABLES: PSSTALK Type: Input This variable determines whether or not this call is interactive. This variable should always be passed as a '0' for this call. This entry point is used to create dosage information in the DRUG (#50) File from the National Drug File (NDF) match. COMPONENT: UNMDRUG(DRUGIEN) VARIABLES: DRUGIEN Type: Input This is the pointer to the DRUG (#50) File for the entry that is being un-matched from an NDF VA Product. This entry point is used to perform a few updates related to un-matching a Dispense Drug from an NDF VA Product. It will delete the content of the following fields in the DRUG file (#50): NATIONAL DRUG FILE ENTRY (#20) VA PRODUCT NAME (#21) PSNDF VA PRODUCT NAME ENTRY (#22) PACKAGE SIZE (#23) PACKAGE TYPE (#24) CMOP ID (#27) NATIONAL FORMULARY INDICATOR (#29) It will also kill all the corresponding cross-references ("VAPN", "AQ1", "APN", "AND" and "APR"). ******************** 3108 NAME: DGMST ENTER NEW MST CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: WOMEN'S HEALTH USAGE: Private ENTERED: MAY 10,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The Women's Health (WH) package requests permission to add the MST Status Add/Edit [DGMST ENTER NEW MST] option onto any WH menu. This option will permit WH users to add/edit Military Sexual Trauma (MST) data directly into the MST module of the Registration package without having to exit the WH package menu structure. Screening veterans for MST is required by the Veterans Millennium Health Care and Benefits Act (PL 106-117). Adding the MST Status Add/Edit [DGMST ENTER NEW MST] option to a WH package menu will aid the WH users to enter the screening data for their patients. The WH package will use a supported KERNEL API ($$ADD^XPDMENU) to add the facility's copy of the option onto the WH menu. The WH pacakge will not export a copy of the DGMST ENTER NEW MST option. ROUTINE: ******************** 3109 NAME: DBIA3109 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 12,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other IB requests permission to check for the DG ELIGIBILITY security key. This check is used to allow the updating of fields Date of Birth, Sex, Marital Status, Veteran(Y/N), and Primary Eligibility while creating a bill. ROUTINE: ******************** 3110 NAME: DBIA3110 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL REMINDERS Clinical Reminders need to pass the type of an order dialog to CPRS GUI. USAGE: Controlled Subscri ENTERED: MAY 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.41 ROOT: ORD(101.41, DESCRIPTION: TYPE: File ^ORD(101.41,D0,0) => TYPE 4 TYPE 0;4 Direct Global Read & w Type of order dialog. ROUTINE: ******************** 3112 NAME: DBIA3112 CUSTODIAL PACKAGE: GEN. MED. REC. - VITALS SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 17,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.51 ROOT: GMRD(120.51 DESCRIPTION: TYPE: File GMRV VITAL TYPE entries are used as findings in Clinical Reminders. Therefore Clinical Reminders needs to point to GMRV VITAL TYPE entries. It also needs the PCE ABBREVIATION for reminder dialogs. ^GMRD(120.51,D0,0 .01 NAME 0;1 Pointed to 7 PCE ABBREVIATION 0;7 Read w/Fileman ROUTINE: ******************** 3113 NAME: DBIA3113 CUSTODIAL PACKAGE: MENTAL HEALTH SUBSCRIBING PACKAGE: CLINICAL REMINDERS The clinical reminders package needs to reference file 601.6 to determine if a mental health instrument/test may be performed as part of a reminder dialog in the CPRS GUI. USAGE: Controlled Subscri ENTERED: MAY 17,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 601.6 ROOT: YTT(601.6, DESCRIPTION: TYPE: File ^YTT(601.6,D0,0) 4 APPROPRIATE FOR GUI 0;4 Direct Global Read & w ROUTINE: ******************** 3114 NAME: DBIA3114 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 18,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Clinical Reminders is being split out of PCE. As part of the split the reminder disclaimer is being moved from the PCE parameter file to the Clinical Reminders parameter file. This makes the PCE options to manage the disclaimer obsolete. As a service to PCE the Clinical Reminders installation will clean up the obsolete options. The specific actions are: Re-distributing the following PX prefixed options. 1 PX HS DISCLAIMER EDIT Distributed as Delete Site 2 PX HS/RPT PARAMETER MENU Changed the description text, removing text about the disclaimer. 3 PX HS/RPT PARAMETERS PRINT Changed the description text 4 PX REPORT PARAMETER EDIT Distributed as Attach to Menu Redistributing the print template option PCE HS/RPT PARAMETERS PRINT used by the PX HS/RPT PARAMETER PRINT option. Display of the disclaimers was removed, and added text to refer to the new option to manage the disclaimer. ROUTINE: ******************** 3115 NAME: DBIA3115 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other When a reminder manager is creating a Clinical Reminder definition they may often need access to certain options from other packages. As a convenience for users, Clinical Reminders would like to offer the PXRM OTHER SUPPORTING MENUS option to provide easy access to these useful options. Clinical Reminders would like to include the option GMTS COORDINATOR on this menu. ROUTINE: COMPONENT: Option: GMTS COORDINATOR VARIABLES: ******************** 3116 NAME: DBIA3116 CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other When a reminder manager is creating a Clinical Reminder definition they may often need access to certain options from other packages. As a convenience for users, Clinical Reminders would like to offer the PXRM OTHER SUPPORTING MENUS option to provide easy access to these useful options. Clinical Reminders would like to include the option IBDF PRINT BLNK ENCOUNTER FORM on this menu. ROUTINE: COMPONENT: Option: IBDF PRINT BLNK ENCOUNTER FORM VARIABLES: ******************** 3117 NAME: DBIA3117 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other When a reminder manager is creating a Clinical Reminder definition they may often need access to certain options from other packages. As a convenience for users, Clinical Reminders would like to offer the PXRM OTHER SUPPORTING MENUS option to provide easy access to these useful options. Clinical Reminders would like to include the option ORCM QUICK ORDERS on this menu. ROUTINE: COMPONENT: Option: ORCM QUICK ORDERS VARIABLES: ******************** 3118 NAME: DBIA3118 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Private ENTERED: MAY 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other When a reminder manager is creating a Clinical Reminder definition they may often need access to certain options from other packages. As a convenience for users, Clinical Reminders would like to offer the PXRM OTHER SUPPORTING MENUS option to provide easy access to these useful options. Clinical Reminders would like to include the options PX PCE COORDINATOR MENU and PXTT TABLE MAINTENANCE on this menu. ROUTINE: COMPONENT: Option: PX PCE COORDINATOR MENU VARIABLES: COMPONENT: Option: PXTT TABLE MAINTENANCE VARIABLES: ******************** 3119 NAME: Consult Default Reason for Request CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Controlled Subscri ENTERED: MAY 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMRCDRFR COMPONENT: GETDEF VARIABLES: GMRCARR Type: Output array to return containing default RFR GMRCSRV Type: Input IEN from file 123.5 GMRCDFN Type: Input patient identifier if to return resolved RESOLV Type: Input 1 or 0 ; if RESOLV=1 GMRCARR will be returned resolved Retrieves a default reason for request for any consult service entered in the REQUEST SERVICES file 123.5 This is used during order placement in CPRS COMPONENT: REAF(OI_REF) VARIABLES: OI_REF Type: Input reference to file 123.5 (ien;99CON) or file 123.3 (ien;99PRC) Integer Type: Output 0 - unrestricted 1 - ask on edit only 2 - no editing Determine editing status of default reason for request ******************** 3120 NAME: UNLINK RESULTS CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CLINICAL PROCEDURES USAGE: Controlled Subscri ENTERED: MAY 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMRCDIS COMPONENT: DIS VARIABLES: GMRCO Type: Input IEN from REQUEST/CONSULTATION (#123) file Consult/Request Tracking provides an API to CPRS to allow a previously associated Medicine result to be disassociated from a Consult procedure request. COMPONENT: REMOVE(IEN,RSLT,DATE,PERSON) VARIABLES: IEN Type: Input IEN from REQUEST/CONSULTATION (#123) file. RSLT Type: Input Variable pointer form of a Medicine or Clinical Procedure result. Example: "19;MCAR(691.5," "19;MDD(702," DATE Type: Input Fileman date/time the activity took place in the calling application. PERSON Type: Input DUZ of the person responsible for the action. This entry point provides a silent API for removing a previously associated Medcine procedure or Clincial Procedure result from a Consult request. ******************** 3121 NAME: Consult Ordering Utilities CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM VISTA INTEGRATION ADAPTOR VIA will be using PROVDX^GMRCUTL1 for VIAB PROVDX RPC USAGE: Controlled Subscri ENTERED: MAY 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Consult/Request Tracking provides utilities to CPRS for the purpose of retrieving information about certaing consult orderables during the ordering process. ROUTINE: GMRCUTL1 COMPONENT: PROVDX VARIABLES: SERV Type: Input IEN from REQUEST SERVICES (#123.5) file This extrinsic function is used to retrieve the ordering parameters for the PROVISIONAL DIAGNOSIS when ordering a consult. Output: string A^B A = O (optional), R (required) or S (suppress) B = F (free-text) or L (lexicon) COMPONENT: PREREQ VARIABLES: GMRCARR Type: Output array to return containing pre-requisite GMRCSRV Type: Input IEN from file 123.5 GMRCDFN Type: Input patient identifier if array is to be returned resolved UNRESOLV Type: Input 1 or 0 ; if UNRESOLV=1 GMRCARR will be returned unresolved This entry point is called to retrieve any information regarding pre-requisites to ordering a consult to a particualr service. This is called during the ordering process in CPRS. COMPONENT: $$ORIFN(GMRCDA) VARIABLES: GMRCDA Type: Input This variable is the internal entry number from the REQUEST/CONSULTATION (#123) file. $$ORIFN Type: Output This will return the internal entry number of the ORDER associated with a particular consult/procedure record. This entry point returns the OE/RR order number from the ORDER (#100) file that corresponds to a particular consult record. ******************** 3122 NAME: GUI resulting utilities for consults CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAY 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Consult/Request Tracking provides utlities for retrieving result information about a particular consult request. These utilities are called by the CPRS GUI during the resulting of Consult procedure requests. ROUTINE: GMRCGUIU COMPONENT: GETMED VARIABLES: GMRCIFN Type: Input IEN from REQUEST/CONSULTATION (#123) file GMRCRES Type: Output Returned as an array as follows: GMRCRES(x) = result_ref^result_name^date^summary example: GMRCRES(1)="19;MCAR(691.5,^EKG^JUN 30,1999@15:52^ABNORMAL" This entry point is called to retrieve a list of available Medicine results that may be associated with a Consult procedure request. COMPONENT: GETRES VARIABLES: GMRCO Type: Input IEN from REQUEST/CONSULTATION (#123) file GMRCAR Type: Output Returned as an array as follows: GMRCAR(x)=result_ref^result_name^date^impres sion Example: GMRCAR(1)="19;MCAR(691.5,^EKG^JUN 30,1999@15:52^ABNORMAL" This entry point is provided to retrieve a list of all Medicine results currently associated with a given Consult procedure request. COMPONENT: DISPMED VARIABLES: GMRCRES Type: Input Variable pointer form of a Medicine package result (e.g. "19;MCAR(691.5") GMRCAR Type: Output Array returned containing the text of a Medicine package report. Example: GMRCAR(1)=" PROCEDURE DATE/TIME: 06/30/99 15:52" GMRCAR(2)=" CONFIDENTIAL ECG REPORT" GMRCAR(3...)= This entry point is provided to allow the display of a particular Medicine result that is being associated or disassociated with a Consult procedure request. ******************** 3123 NAME: DBA3123 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: JUN 8,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 774 ROOT: HLS(774 DESCRIPTION: TYPE: File Ability to delete subscription record (file 774) with FileMan when deleting the pointer to that record in the MPI node of the Patient file (#2). This is necessary for duplicate record merge. ^HLS(774 .01 NUMBER 0;1 Write w/Fileman ROUTINE: ******************** 3124 NAME: DBIA3124 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: MAY 23,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine call to return ^TMP("IBRBT",$J,IBIFN,n and ^TMP("IBRBF",$J,IBIFN,n arrays which contain third party bill information and first party bill information respectively. The purpose of this call is to find associated Third and First Party bills. The call returns arrays containing Third and First Party bills that cover the same episodes of care as the Third Party bill that is passed in as input. ROUTINE: IBRFN COMPONENT: RELBILL VARIABLES: IBIFN Type: Input The pointer value to the bill entry in file 399 (also 430 same number) that will be used to find associated third party and first party charges based upon the episode of care covered by the bill entry that is passed in IBIFN. ~TMP Type: Output Returns ^TMP("IBRBT",$J,IBIFN)= 1 if patient has any RX coverage null if not ^TMP("IBRBT",$J,IBIFN,associated third party bill ifn)= 1^2^3^4^5^6^7 where Piece Value ----- ----- 1 From date 2 To date 3 1 for cancelled in IB null if not 4 AR bill number 5 Sequence of insurance coverage - p for primary, s for secondary and t for tertiary 6 Payer is medicare supplemental 1 for yes 7 Payer name ^TMP("IBRBF",$J,IBIFN,associated first party charge ifn)= 1^2^3^4^5^6^7 where Piece Value ----- ----- 1 From 2 To 3 Cancelled in IB 1 for yes null for no 4 AR bill number 5 Total charge 6 Action type (short) 7 Days on hold ******************** 3125 NAME: RADIOLOGY EXAM DATA RETURN (SLC) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY SPINAL CORD DYSFUNCTION PCE PATIENT CARE ENCOUNTER Patient Care Encounter (PCE) was added as a subscriber for patch PX*1.0*211. USAGE: Controlled Subscri ENTERED: MAY 24,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 70 ROOT: RADPT( DESCRIPTION: TYPE: File This Integration Agreement (IA) allows access to the ^RADPT global at the EXAMINATIONS (#70.03) sub-file level to obtain radiology exam specific data for a patient within a date range or for a patient with a PCE visit. ^RADPT(D0,'DT','AP') This is a cross reference used to Loop through the RAD/NUC MED PATIENT (file 70) looking for selected exams for a patient. This is used in Health Summary Component RADIOLOGY IMPRESSION SELECTED (SRI). ^RADPT(D0,'DT',D1) Loop through RAD/NUC MED PATIENT (file 70) REGISTERED EXAMS (sub-file 70.02) looking file entries within a date range. This is used by Health Summary components RADIOLOGY IMPRESSION SELECTED (SRI), RADIOLOGY IMPRESSION (RI) and RADIOLOGY PROFILE (RP). ^RADPT(D0,'DT',D1,'P',D2) Loop through RAD/NUC MED PATIENT (file 70) REGISTERED EXAMS (sub-file 70.02), EXAMINATIONS (sub-file 70.03) for radiology exams within a date range. This is used by Health Summary components RADIOLOGY IMPRESSION (RI) and RADIOLOGY PROFILE (RP). ^RADPT(D0,'DT',D1,'P',D2, 2 PROCEDURE 0;2 Read w/Fileman 3 EXAM STATUS 0;3 Read w/Fileman 12 PRIMARY INTERPRETING 0;12 Read w/Fileman 13 PRIMARY DIAGNOSTIC C 0;13 Read w/Fileman 15 PRIMARY INTERPRETING 0;15 Read w/Fileman 17 REPORT TEXT 0;17 Read w/Fileman 25 MEMBER OF SET 0;25 Read w/Fileman 135 CPT MODIFIERS CMOD;0 Read w/Fileman 175 TECHNOLOGIST TC;0 Read w/Fileman 400 CLINICAL HISTORY FOR WP Read w/Fileman Extract examination data from EXAMINATIONS sub-file 70.03. ^RADPT(D0,'DT',D1,'P',D2,'TC', .01 TECHNOLOGIST 0;1 Read w/Fileman Extract technologist name from TECHNOLOGIST sub-file 70.12. ^RADPT(D0,'DT',D1,'P',D2,'CMOD', .01 CPT MODIFIER 0;1 Read w/Fileman Loop through RAD/NUC MED PATIENT (file 70) REGISTERED EXAMS (sub-file 70.02), EXAMINATIONS (sub-file 70.03), CPT MODIFIERS (sub-file 70.3135) for the modifiers to the CPT procedure. This is used by Health Summary components RADIOLOGY IMPRESSION SELECTED (SRI), RADIOLOGY IMPRESSION (RI) and RADIOLOGY PROFILE (RP). ^RADPT(D0,'DT',D1,'P',D2,'M', .01 PROCEDURE MODIFIERS 0;1 Read w/Fileman Loop through RAD/NUC MED PATIENT (file 70) REGISTERED EXAMS (sub-file 70.02), EXAMINATIONS (sub-file 70.03), PROCEDURE MODIFIERS (sub-file 70.1) for the modifiers to the radiology procedure. This is used by Health Summary components RADIOLOGY IMPRESSION SELECTED (SRI), RADIOLOGY IMPRESSION (RI) and RADIOLOGY PROFILE (RP). ^RADPT('AVIST' 27 VISIT 0;27 Direct Global Read & w This field links the patient specific radiology exam to a specific visit (PCE). LIST FILE ATTRIBUTES data: sub-file field # data type (expanded) -------- ------- ----------- --------- 70.03 27 POINTER: VISIT FILE (#9000010) 'AVSIT' is the RAD/NUC MED PATIENT file-wide index on the VISIT field. ROUTINE: ******************** 3127 NAME: DBIA3127 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: VA CERTIFIED COMPONENTS - DSSI USAGE: Controlled Subscri ENTERED: JUN 1,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 8989.51 ROOT: XTV(8989.51, DESCRIPTION: TYPE: File Requesting read access/fileman to all fields in the PARAMETER DEFINITION FILE (#8989.51) to retrieve the Clinical Procedures Parameter definitions. Clinical Procedures is a strictly GUI application and includes a Manager executable to setup and maintain site files and system parameters. Additionally a lookup on the parameter definition file by name screening by Entity Type allow for retrieval of all parameters for a specific entity (i.e. Division) and display/update of these values. With the information retrived from file 8989.51 this application dynamically configures input screens for the user and sends data back to the server for the XPAR API's to add/edit/delete parameter values in the XPAR utilities. Access is read-only via GETS^DIQ, GET1^DIQ, FIND^DIC, and FIND1^DIC and is programmed to only allow access to parameters in the subscribing package namespace. ROUTINE: ******************** 3128 NAME: Direct Read of USR ROLE FILE (#8930.2) CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.2 ROOT: USR(8930.2, DESCRIPTION: TYPE: File In evaluating whether a user can perform a particular action on a given TIU document, TIU needs the record number in the USER ROLE FILE of each role played by that person with respect to the document. These roles are determined by examining various fields of the document, and then the role record number is read from the B cross-reference of the USER ROLE FILE. ^USR(8930.2,'B') ROUTINE: ******************** 3129 NAME: Direct Read of USR AUTHORIZATION/SUBSCRIPTION FILE CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: MAR 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.1 ROOT: USR(8930.1, DESCRIPTION: TYPE: File Document Definition titles for Interdisciplinary Notes may not be used for both ID parent and ID child notes. If there are rules permitting a title to be used for ID parent notes, any existing rules allowing it to be used for ID child notes are ignored. Therefore, ID notes needs to know if rules exist permitting a title to be used as an ID parent. To evaluate this, TIU reads the AR and AC cross-references of the AUTHORIZATION/SUBSCRIPTION FILE (#8930.1). ^USR(8930.1,'AR', ^USR(8930.1,'AC', ROUTINE: ******************** 3130 NAME: DBIA3130 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: JUN 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function returns the primary division associated with the care on a Third Party bill. ROUTINE: IBJDF2 COMPONENT: $$DIV VARIABLES: IBX Type: Input IBX is a pointer to a claim in file #399 BILL/CLAIMS FILE. IBY Type: Output IBY is a pointer to the MEDICAL CENTER DIVISION file #40.8. ******************** 3132 NAME: DBIA3132 CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING REGISTRATION USAGE: Controlled Subscri ENTERED: JUN 20,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Call HXDATA^A7RDPAGU from inside an RPC. This routine is already being called by CPRS. It is similar to the call of A7RDPACT by DGSEC whenever a patient is looked up. Both A7RDPAGU and A7RDPACT refer to National Database Integration routines which check whether a patient has historical data on a Legacy system. ROUTINE: A7RDPAGU COMPONENT: HXDATA(.LST,DFN) VARIABLES: DFN Type: Input LST Type: Output Output array that returns legacy data message. ******************** 3134 NAME: DBIA3134 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Controlled Subscri ENTERED: JUN 23,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: PXRMXX COMPONENT: PATS(START,END,OUTPUT) VARIABLES: START Type: Input Start date for outpatient visit and inpatient admission selection. FileMan Date format. END Type: Input End date for outpatient visit and inpatient admission selection. FileMan Date format. OUTPUT Type: Input A list of patients is assembled in global ^TMP(OUTPUT,$J) sorted by facility and patient ien: ^TMP(OUTPUT,$J,FACILITY,DFN) = "" This call returns a list of patients including: Current inpatients Outpatient visits Inpatient admissions ******************** 3135 NAME: OR EVSEND GMRC CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING The subscribing protocol is: GMRC RECEIVE PROSTHETICS The subscribing protocols are: RMPR RECEIVE RMPR RECEIVE GMRC SURGERY CLINICAL PROCEDURES CP ADDED 7/9/07 Listener protocol for Clinical Procedures is MD RECEIVE OR. EMERGENCY DEPARTMENT EDIS protocol is EDP OR MONITOR. VIRTUAL PATIENT RECORD Listener protocol for VPR is VPR NA EVENTS to be added by VPR*1*3. HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** The protocol for HMP is HMP NA EVENTS USAGE: Controlled Subscri ENTERED: JUN 27,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This is the event invoked by CPRS when a new order, or action to an order, is placed to the Consult/Request Tracking package. Actions from any application area that are dependent on this event may be added as Items upon approval. The array XQORMSG(#) will be available for all subscribers to read only, containing the HL7 message with the order to Consults as defined in the 'OE/RR Version 3 Package Interface Specifications' document. ROUTINE: ******************** 3137 NAME: ORUS List Processor CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary uses this uitlity to select from multiple items when a unique entry/item can not be found. USAGE: Private ENTERED: JUN 28,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ORUS is a utility, which presents a user with a list of entries in a columnar format and allows selection from this list. It is possible to allow multiple items to be selected at one time. Selections made are returned in Y. Since the selections are returned in Y, M code used for screens, display actions, etc., must not change Y. Y(n) may not be sequential, so Y should be processed with $O when returned. Note: In order to allow multiple selections, the characters comma (,), dash (-), equal (=), and apostrophe(') are reserved. Items presented on this list should not contain these characters. Items should also be displayed in uppercase. Upon entry ORUS and ORUS(0) must be defined. All other ORUS variables are optional. ROUTINE: ORUS COMPONENT: EN VARIABLES: ORUS Type: Input ORUS GLOBAL REFERENCE 1000 or "^GLO(1000," May be any Fileman compatible file (number or reference from which items will be selected. This may also be any global (^TMP($J,), for example) in a Fileman format. ORUS(0) Type: Input ORUS(0) COL WIDTH & PARAMS "40MN" This is the parameter string which determines how the list is to be displayed and how items are to be selected. Possible values include: Number - sets the display column width and must be at the beginning of the string. "A" - causes the list to be displayed alphabetically. This is not needed if the list is to be presented in entry order of if ORUS("F") is defined. "N" - causes the items displayed to be numbered sequentially. Not needed if mnemonics are used with each item or if no 'short' way of selecting an item is desired. "M" - causes the menu of items to be displayed automatically. Otherwise, the list is displayed only when typing a question mark. "Q" - causes OTHER ITEM (where ITEM is the file or field name) to be prompted for. If OTHER ITEM is selected, OROTHER is defined. "S" - allows the user to select a single item only, rather than sets or ranged of items. ORUS(L) Type: Input ORUS(L) LOOKUP X-REF "^GLO(1000,""B""," This is the cross reference used when looking up selections entered. Normally a standard "B" cross-reference may be used. This cross- reference should include the names of items as they are presented on the list and also any mnemonic identifiers presented. Lookup values in this cross-reference should be in uppercase, as selections made are always converted to uppercase before being looked up. If ORUS(0) contains "N", items may also be selected by number but it is not necessary to include the numbers in the cross-reference. The cross reference should be structured: ^GLO(1000,"B",VALUE,DA). ORUS(F) Type: Input ORUS(F) DISPLAY ORDER "^GLO(1000,""C""," This is the cross reference used if it is desired to present the items in a special order. For instance, lists may often be presented in alphabetical order by using the "B" cross reference here. If this is not defined and ORUS(0) does not contain an "A", the entry order of the file is used. The cross reference should be structured: ^GLO(1000,"C",VALUE,DA). ORUS(S) Type: Input ORUS(S) SCREENING ACTION "I $P(^(0),""^"",2)=1" This is M code, which screens items from being presented on (and selected from) the list. When executing a screen, it may be assumed that ORDA is set to the internal entry number of the entry and the naked is set to the zeroth node of the entry. ORUS(W) Type: Input ORUS(W) DISPLAY ACTION "S X=$P(^(0),""^"",3)" This is M code, which should set X to the text that should be displayed for a particular item. If not defined, the .01 field of the entry is displayed. If it is a pointer, the external value of the pointer is looked up and displayed. When executing a display action, it may be assumed that ORDA is set to the internal entry number of the entry and the naked is set to the zeroth node of the entry. NOTE: What is displayed should be the same as what is looked up in the cross- reference if ORUS("L") is defined. ORUS(M) Type: Input ORUS(M) MNEUMONIC "0;3" This may be used to identify the subscript and piece position of a mnemonic. If defined, the mnemonic(which should be less than 5 characters) is displayed with the item. ORUS(T) Type: Input ORUS(T) HEADER ACTION "W @IOF,?35,""-PATIENT LIST"" This may be used to write a header or title for the list. The header should include a W # so as to reset $Y. ORUS(ALT) Type: Input ORUS(ALT) ALTERNATE LOOKUP On look-up failure, an alternate lookup can be invoked by putting M code in this variable. $T will be checked to determine if the lookup was successful. ORUS(A) Type: Input ORUS(A) PROMPT "Select Items(s): " This allows a selection prompt to be defined. If not defined, the prompt is "Select "_FILENAME_": ". ORUS(B) Type: Input ORUS(B) DEFAULT RESPONSE "OTHER" This allows a default response to be defined. ORUS(H) Type: Input ORUS(H) HELP ACTION "W !,""Equal sign delimits modifiers."",! This is M code to display help other than the help normally given by the ORUS routine. ORUS(900,n Type: Input ADDITIONAL ITEMS Items other than those in the file may be put on the list of selections. These are usually special items such as "SELECT A NEW LIST". These items may have identifiers but are usually numbered between 900 and 990. They may be passed in the array ORUS(900,n) where n is a number. This number is used as the offset to 900 when displaying the selections. When an item is selected, M code is executed (generally to set or reset a flag). The format of this array is as follows: ORUS(900,n)=display text^mneumonic^executable code Y Type: Output This is the return array of values selected. Y number of items selected Y(0) same as Y Y(n) internal entry number^.01 field^display text^value entered Displays a list of items for selection. ******************** 3139 NAME: DBIA3139 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Field .04 CLINICAL PROCEDURES of GMRC Procedure file #123.3 can point to CP Definition file 702.01. It uses the screen S DIC("S")="I $F(""OP"",$P(^MDS(702.01,+Y,0),U,2))>1&($P(^(0),U,9))" to list all active procedures and orderable items. File 123 also has a field pointing to file 702.01. USAGE: Controlled Subscri ENTERED: JUN 28,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 702.01 ROOT: MDS(702.01, DESCRIPTION: TYPE: File ^MDS(702.01, .01 NAME 0;1 Pointed to Name of the procedure. ROUTINE: ******************** 3140 NAME: GMRC EVSEND OR CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: IMAGING PROSTHETICS Protocol RMPR RECEIVE GMRC CLINICAL PROCEDURES added 3/19/2008 VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: AUG 10,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other The protocol name GMRC EVSEND OR is exported as USE AS LINK FOR MENU ITEMS. This linkage will allow packages to monitor order activity messages. ROUTINE: ******************** 3142 NAME: DBIA3142 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: CLINICAL REMINDERS This entry point is designed to return specific prescription information, based on a set of medication criteria defined by the subscribing package. USAGE: Controlled Subscri ENTERED: JUL 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows the Clinical Reminders package to call the Outpatient Pharmacy package for patient and prescription information, based on a specified date range and a specified list of medications. ROUTINE: PSOORAPI COMPONENT: EN(PSOB,PSOE,PSOX,PSODT,PSON) VARIABLES: PSOB Type: Input This is the beginning date to search by, in VA FileMan format. PSOE Type: Input This is the ending date for the search, in VA FileMan format. PSOX Type: Input This is the medication array for the search. It can be in two types. PSOX("123;PSDRUG(") where 123 is the internal entry number, and PSDRUG( indicates that the entry number corresponds with an entry in the DRUG file (#50). PSOX("321;PSNDF(50.6,") where 321 is the internal entry number, and PSNDF(50.6, indicates that the entry number corresponds with an entry in the VA GENERIC file (#50.6). PSODT Type: Input This variable determines how the search is to be conducted. "F" for Fill Date, "R" for Release Date. PSON Type: Input This is the first subscript of the TMP global that is returned. TMP(PSON,$ Type: Output This is returned in the format ^TMP(PSON,$J,DFN,#,0). This node contains the medication criteria of the finding. This would be in the format of the PSOX input array. TMP(PSON,$ Type: Output This is returned in the format ^TMP(PSON,$J,DFN,#,1). This node contains 4 pieces. Piece 1 is the Fill Date if the search criteria is by Fill Date. It will be the Fill Date of the released fill, if the search criteria is by Release Date. Piece 2 is the Release Date if the search criteria is by Release Date. It will be Release Date or null, if the search criteria is by Fill Date, so if the fill in this case has not yet been released, a null will be returned. Piece 3 is the name (#01) of the Drug from the DRUG file (#50), regardless of whether the finding was based on the DRUG file (#50) or VA GENERIC file (#50.6) criteria. Piece 4 is the Days Supply of the fill. This entry point returns patient and prescription information in a TMP global to the subscribing package, based on the criteria passed into the call. ******************** 3143 NAME: DBIA3143 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: JUL 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows the Clinical Reminders package to call the Inpatient Medications V.5.0 package for patient and order information, based on a specified date range and a specified list of medications. ROUTINE: PSJORAPI COMPONENT: EN(PSJB,PSJE,PSJX,PSJDT,PSJN) VARIABLES: PSJB Type: Input This is the beginning date to search by, in VA FileMan format. PSJE Type: Input This is the ending date for the search, in VA FileMan format. PSJX Type: Input This is the medication array for the search. It can be two types. PSJX("123;PSDRUG(") where 123 is the internal entry number, and PSDRUG indicates that the entry number corresponds with an entry in the DRUG file (#50). PSJX("321;PSNDF(50.6,") where 321 is the internal entry number, and PSNDF(50.6, indicates that the entry number corresponds with an entry in the VA GENERIC file (#50.6). PSJDT Type: Input This variable is not used by the Inpatient Medications package. It is included to make it easier for the Clinical Reminders package to make the call in the same format to both the Inpatient Medications and the Outpatient Pharmacy packages. PSJN Type: Input This is the first subscript of the TMP global that is returned. It may be "PSI". The TMP global may be killed before and after use. TMP(PSJN,$ Type: Output This is returned in the format ^TMP(PSJN,$J,DFN,#,0). This node contains the medication criteria finding. This would be in the format of the PSJX input array. TMP(PSJN,$ Type: Output This is returned in the format ^TMP(PSJN,$J,DFN,#,1). This node contains 5 pieces. Piece 1 is the Start Date/Time of the order. Piece 2 is always null. Piece 3 is the name (#.01) of the Drug from the DRUG file (#50), regardless of whether the finding was based on the DRUG file (#50) or VA GENERIC file (#50.6) criteria. Piece 4 is always null. Piece 5 is the Stop Date/Time of the order. Pieces 2 and 4 are left null in order to make the call correspond with the Outpatient Pharmacy call. Piece 2 in the Outpatient Pharmacy call is the Release Date, Inpatient Medications doesn't have any data that corresponds with that data so we leave this piece null. Piece 4 in the Outpatient Pharmacy call is the Days Supply, again Inpatient Medications has no data that corresponds to this so we leave it null. Type: This entry point return patient and order information in a TMP global to the subscribing package, based on the criteria passed into the call. ******************** 3144 NAME: DIRECT RPC CALL CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: INTEGRATED BILLING Integrated Billing is to call ONLY IB RPCs to view patient data and to send insurance data between VA sites. REGISTRATION For use with the Smart Card. MASTER PATIENT INDEX MPI is to call ONLY its own RPCs, with the following exceptions allowed: MPIF ACK CHECK MPIF EXP PDAT REMOTE MPIF INACTIVATE MPIF REMOTE SPI MPIF REMOTE ICN UPDATE MPIF CHANGE CMOR RG REM ACTIVITY RG REMOTE HL7 TASK MPIF SSN DUPS CONSULT/REQUEST TRACKING Consult/Request Tracking is to call ONLY its own RPCs. CLINICAL INFO RESOURCE NETWORK CIRN is to call ONLY its own RPCs. MASTER PATIENT INDEX VISTA Master Patient Index VistA is to call ONLY its own RPCs. CORBA SERVICES INCOME VERIFICATION MATCH BENEFICIARY TRAVEL AUTOMATED MED INFO EXCHANGE Added 9/22/20: The Capri CLAIMS server is calling the MPI remote procedure "MPI GETCORRESPONDINGIDS", which only exists on the MPI environment. This API will be used to determine if a patient has an Active Cerner Correlation. This determination will then be used to alert VBA employees in the Capri GUI to check Cerner for new patient data. USAGE: Controlled Subscri ENTERED: OCT 27,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call is to make a RPC call on a remote facility. Users of this API should be prepared to modifiy their calls to support support strong authentication when made available by Infrastructure. ROUTINE: XWB2HL7 COMPONENT: DIRECT(RET,LOC,RPC,RPCVER,P1,P2,P3,P4,P5,P6,P7,P8,P9,P10) VARIABLES: RET Type: Output This is the return value. LOC Type: Input This is the Institution name or VISN name or ien of where to send the RPC call to. RPC Type: Input This is the name of the RPC to run on the remote system. RPCVER Type: Input version number in Remote Procedure file. (optional) P1 Type: Input 1st RPC paramater on remote system. P2 Type: Input 2nd RPC paramater on remote system. P3 Type: Input 3rd RPC paramater on remote system. P4 Type: Input 4th RPC paramater on remote system. P5 Type: Input 5th RPC paramater on remote system. P6 Type: Input 6th RPC paramater on remote system. P7 Type: Input 7th RPC paramater on remote system. P8 Type: Input 8th RPC paramater on remote system. P9 Type: Input 9th RPC paramater on remote system. P10 Type: Input 10th RPC paramater on remote system. Use of the DIRECT connect whether it is done through DIRECT^XWB2HL7 or with DIRECT^HLMA is susceptible to encountering network errors. This was first noticed with the Institution File Redesign patch and the Integrated Billing patch(RX Copay). Susequently, HL7 issued patches HL*1.6*76 and HL*1.6*77 to address these network errors and return the status of failure back to the calling application. With the DIRECT connect, VistA HL7 only tries to send the message once. If it encounters an network error while attepting to send a message, it does not attempt to resend. When using this API, you should check the returned value of subscript zero of the first parameter. This parameter is passed by reference. For example, if you made a call like D DIRECT^XWB2HL7(.MYRET,... You should check the value of MYRET(0). If there was a problem with sending the message or receiving a response, MYRET(0) will have a value of -1^error message The -1 is both MYRET and MYRET(0), so one can use: I $P(MYRET(0),"^")=-1!(-1=+MYRET) S ERROR=1 Q See code below: DIRECT(RET,LOC,RPC,RPCVER,P1,P2,P3,P4,P5,P6,P7,P8,P9,P10) ;Call a remote RPC N X,I,INX,N,XWBHL7,XWBPAR,XWBPCNT,XWBDVER,XWBESSO,XWBHDL,PMAX N XWBMSG,XWBSEC,RPCIEN ;Protect caller from HL7 N HLMTIEN,HLDOM,HLECH,HLFS,HLINSTN,HLNEXT,HLNODE,HLPARAM,HLQ,HLQ UIT D SETUP(1) I $G(RET(1))'="" Q ;(procedurename, query tag, error return, destination, Parameter array) D DIRECT^XWB2HL7A("ZREMOTE RPC",XWBHDL,.XWBMSG,LOC,.XWBPAR) I $P(XWBMSG,U,2) S RET(0)="-1^"_$P(XWBMSG,"^",3) Q I 'HLMTIEN S RET(0)="-1^No Message returned" Q D RETURN,RTNDATA^XWBDRPC(.RET,XWBHDL) Q COMPONENT: EN1(RET,LOC,RPC,RPCVER,P1,P2,P3,P4,P5,P6,P7,P8,P9,P10) VARIABLES: RET Type: Output This variable is passed by reference. If RET(0) is empty, then RET(1) will have some error text. Otherwise RET(0) will have the HANDLE that is used in follow-up calls. This entry point is used by CPRS Remote Data Views. It places the HL7 message into the HL7 message queue for deferred transfer. See the DIRECT entry for parameter descriptions. The return from this call is a HANDLE that is used in the follow-up calls. COMPONENT: RPCCHK(RET,HDL) VARIABLES: HDL Type: Input This is the Handle that was returned from the EN1^XWB2HL7 call. This entry point is used after a call to EN1^XWB2HL7 to check the status of the call. When it returns "1^Done" a call can be made to RTNDATA^XWBDRPC to get the data. When it returns "-1^text" there is a problem with the call. ******************** 3145 NAME: Health Summary Admissions Treating Spec CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary needs to retrieve/display the specialty associated with Admissions. To save on screen width, the shorter of either the NAME or PRINT NAME will be displayed. USAGE: Private ENTERED: JUL 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42.4 ROOT: DIC(42.4, DESCRIPTION: TYPE: File Retrieval and display of recognized PTF treating specialties. ^DIC(42.4,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the name of the specialties allowable. 1 PRINT NAME 0;2 Direct Global Read & w This field will contain an abbreviated name of this specialty. This print name will be printed on outputs where the full name of the specialty would not fit. ROUTINE: ******************** 3146 NAME: TIU use of PXUTL1 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: SEP 27,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine TIU calls $$APPOINT^PXUTL1, when the Visit IEN is not available, to check if a Visit is associated with an appointment. ROUTINE: PXUTL1 COMPONENT: $$APPOINT VARIABLES: PXUTLDFN Type: Input Patient file (#2) IEN PXUTLDT Type: Input Visit Date/Time HLOC Type: Input Hospital Location file (#44) IEN Value Type: Output Returns 1 if the patient has an appointment. Type: Returns 1 if the patient has an appointment. ******************** 3147 NAME: Health Summary Facility Treating Specialty CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary needs to access the Facility Treating Specialty to get the treating speciaty and print name used in Admissions components. USAGE: Private ENTERED: JUL 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45.7 ROOT: DIC(45.7, DESCRIPTION: TYPE: File ^DIC(45.7,D0,0) .01 NAME 0;1 Direct Global Read & w Contains the name of the facility treating specialty. Types of treating specialties may vary between facilities. 1 SPECIALTY 0;2 Direct Global Read & w This field contains a pointer to the Specialty file #42.4, containing the specialty name and print name. ROUTINE: ******************** 3148 NAME: Health Summary Reminders/Maint Items (GUI) CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary needs to access the "B" index and the INACTIVE FLAG Field 1.6 (0;6) to to retrieve a listing of Active' REMINDER/MAINTENANCE ITEMs (NAMES, field .01) for the Adhoc Health Summary Type (GUI RPC). USAGE: Private ENTERED: JUL 20,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 811.9 ROOT: PXD(811.9, DESCRIPTION: TYPE: File ^PXD(811.9,'B',X,D0) .01 NAME 0;1 Direct Global Read & w The software loops through the "B" index, on the NAME field (.01), gathering the internal entry numbers of those clinical reminder maintenance items which are active. ^PXD(811.9,D0,0) .01 NAME 0;1 Direct Global Read & w This field contains the name of a clinical reminder/maintenance item which may be selected for use in the Health Summary components "PCE CLINICAL REMINDERS" and "PCE CLINICAL MAINTENANCE". 1.6 INACTIVE FLAG 0;6 Direct Global Read & w When a reminder is inactive (1) it cannot be selected for inclusion on a Health Summary. ROUTINE: ******************** 3149 NAME: XWBDRPC CUSTODIAL PACKAGE: RPC BROKER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING Used by CPRS Remote Data Views. INTEGRATED BILLING Integrated Billing is to call ONLY IB RPCs to view patient data. MASTER PATIENT INDEX MPI is to call ONLY its own RPCs, with the following exceptions allowed: MPIF ACK CHECK MPIF EXP PDAT REMOTE MPIF INACTIVATE MPIF REMOTE SPI MPIF REMOTE ICN UPDATE MPIF CHANGE CMOR RG REM ACTIVITY RG REMOTE HL7 TASK MPIF SSN DUPS CLINICAL INFO RESOURCE NETWORK CIRN is to call ONLY its own RPCs. MASTER PATIENT INDEX VISTA MPIF is to call ONLY its own RPCs. CORBA SERVICES ENROLLMENT APPLICATION SYSTEM INCOME VERIFICATION MATCH BENEFICIARY TRAVEL USAGE: Controlled Subscri ENTERED: JUL 26,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine contains API's for deferred RPC's used by HL7 utilities. ROUTINE: XWBDRPC COMPONENT: RTNDATA(RET,HDL) VARIABLES: RET Type: Output Return array. HDL Type: Input Handle of data to retrieve. Returns data retrieved from a remote site. COMPONENT: CLEAR(RET,HDL) VARIABLES: RET Type: Both This call was setup to be used by RPC Broker this is the return. It will always be set like this: RET(0)=1 HDL Type: Input This is the Handle for the data that you want cleared. This call will clear the data (in XTMP) connected with the handle that is passed in. COMPONENT: CLEARALL(RET) VARIABLES: HDL Type: Both This call was setup to be used by RPC Broker this is the return. It will always be set like this: RET(0)=1 This call will clear ALL Remote or Deferred data for the current job. ******************** 3151 NAME: ONCOLOGY DISEASE INDEX CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ONCOLOGY USAGE: Private ENTERED: JUL 28,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.07 ROOT: AUPNVPOV( DESCRIPTION: TYPE: File ONCOLOGY needs to read with FileMan the following V POV (9000010.07) fields for its [Disease Index] option: ^AUPNVPOV(D0,0) .01 POV 0;1 Read w/Fileman .02 PATIENT NAME 0;2 Read w/Fileman .03 VISIT 0;3 Read w/Fileman ROUTINE: ******************** 3152 NAME: TIU use of PXBUTL2 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: JUL 31,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine TIU calls PRV^PXBUTL2 to get the default provider. ROUTINE: PXBUTL2 COMPONENT: PRV VARIABLES: CLINIC Type: Input ifn of clinic in file 44 PXBPMT Type: Output Array subscripted as follows: Default Provider: PXBPMT("DEF",NAME,+X)="" All Providers associated with a Clinic: PXBPMT("PRV",NAME,+X)="" Subscripts: NAME is the Name field (#.01) in New Person file (#200) +X is the ifn of New Person in New Person file (#200) PRV(CLINIC) ;Get default provider and all providers associated with a clinic ******************** 3154 NAME: Health Summary Current Orders CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: HEALTH SUMMARY CARE MANAGEMENT ADVERSE REACTION TRACKING EMERGENCY DEPARTMENT ADDED 9/25/08 VIRTUAL PATIENT RECORD Effective with VPR*1*0. CLINICAL REMINDERS HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. USAGE: Controlled Subscri ENTERED: AUG 1,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORQ1 COMPONENT: EN VARIABLES: PAT Type: Input This is a variable pointer to the patient in the format "DFN;DPT(" GROUP Type: Input This is the Display Group (file 100.98), allowing orders to be clustered into groups other than by package. FLG Type: Input Indicates orders to display: 1. All => 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 2. Active/Current => 3,4,5,6, 8,9, 11, 15 Includes CONTEXT HRS 1,2,7,13 & Action Status=13 Orders in ^OR(100,"AC",PAT,TM,IFN,ACTION) 3. Discontinued => 1 12,13 4. Completed/Expired => 2, 7 5. Expiring => 3,4,5,6, 8,9 6. Recent Activity => 1,2,3,4,5,6,7,8,9, 12, 15 Orders in ^OR(100,"AR",PAT,TM,IFN,ACTION) 7. Pending => 5 8. Unverified => 1, 3,4,5,6, 8,9, 15 9. Unverified/Nurse => 1, 3,4,5,6, 8,9, 15 10. Unverified/Clerk => 1, 3,4,5,6, 8,9, 15 11. Unsigned => 1,2,3,4,5,6,7,8,9,10,11, 13,14,15 Orders in ^OR(100,"AS",PAT,TM,IFN) 12. Flagged => 1,2,3,4,5,6,7,8,9, 12,13,14,15 13. Verbal/Phoned => 1,2,3,4,5,6,7,8,9, 13,14,15 Nature of order of verbal or phoned 14. Verb/Phn unsigned => 1,2,3,4,5,6,7,8,9, 13,14,15 Nature of order V or P & unsigned 15. Admission => 10 16. Discharge => 10 17. Transfer => 10 Orders in ^OR(100,"AEVNT",PAT,,IFN) 18. On Hold => 3 19. New Orders => 10,11 Orders in ^TMP("ORNEW",$J,ORIFN) 20. Chart Review => 1, 3,4,5,6, 8,9, 15 21. Chart Copy Summary=> same as All w/screen on Nature of order 22. Lapsed => 14 23. Active status => 6 EXPAND Type: Input Internal entry number of parent order, used to expand child orders. SDATE Type: Input Start date (FM format). EDATE Type: Input End date (FM format). DETAIL Type: Input Level of detail to be returned (optional, default=0) 0 => ^TMP("ORR",$J,ORLIST,i) = order # 1 => ^TMP("ORR",$J,ORLIST,i) = order #^display group^when entered^ start d/t^stop d/t^status^sts abbrv ^TMP("ORR",$J,ORLIST,i,"TX",j) = order text MULTI Type: Input Multiple order flag: 0 = Don't allow multiple occurances of order 1 = Allow multiple occurances TMP('ORR', Type: Output Returns data about current orders depending on the value of the input variable DETAIL: DETAIL=0 ^TMP("ORR",$J,ORLIST,i) = order # DETAIL=1 ^TMP("ORR",$J,ORLIST,i) = order #^display group^when entered^ start d/t^stop d/t^status^sts abbrv ^TMP("ORR",$J,ORLIST,i,"TX",j) = order text This entry point retrieve a list of current orders and returns results in ^TMP("ORR",$J,ORLIST,i). ******************** 3155 NAME: TIU/Health Summary by Visit Date CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY USAGE: Private ENTERED: AUG 1,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The routine TIULAPI controls the branching for extracting documents by occurrence, date or type for a given patient. ROUTINE: TIULAPI COMPONENT: MAIN VARIABLES: DFN Type: Input Pointer to the patient file (#2) (required) TIUDOC Type: Input TIU document class, IEN of the TIU DOCUMENT DEFINITION file (#8925.1) (required) TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input The number of occurrences of teh type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) This entry point is used to extract TIU documents by Visit Date for the Clinical Warnings Component (CW). ******************** 3156 NAME: XLFCRC CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 4,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine has two API's, CRC32 and CRC16. SET CRC=$$CRC32^XLFCRC(string) A check-sum can also be calculated over multiple strings. SET (I,C)=0 FOR SET I=$ORDER(X(I)) QUIT:'I DO . SET C=$$CRC16^XLFCRC(X(I),C) or SET I=0,C=4294967295 FOR SET I=$ORDER(X(I)) QUIT:'I DO . SET C=$$CRC32^XLFCRC(X(I),C) as long as the save method is used all the time. These have been approved for inclusion in a future ANSI M[UMPS] language standard as part of the library. ROUTINE: XLFCRC COMPONENT: $$CRC32(string[,seed]) VARIABLES: string Type: Input String to compute the CRC32 on. seed Type: Input Optional seed value, Needed to compute the CRC32 over multiple strings. This function computes a Cyclic Redundance Code of the 8-bit character string string, using X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 + X^8 + X^7 + X^5 + X^4 + X^2 + X + 1 as the polynominal. The optional parameter seed may supply an initial value, which allows for running CRC calculations on multiple strings. If the parameter seed is not specified, a default value of 4,294,967,295 (2^32-1) is assumed. The value of seed is limited to 0 <= seed <= 2^32. The function value will be between 0 and 2^32. COMPONENT: $$CRC16(string[,seed]) VARIABLES: string Type: Input String to compute the CRC16 on. seed Type: Input Optional seed value. Needed to compute the CRC16 over multiple strings. This function computes a Cyclic Redundance Code of the 8-bit character string string, using X^16 + X^15 + X^2 + 1as the polynominal. The optional parameter seed may supply an initial value, which allows for running CRC calculations on multiple strings. If the parameter seed is not specified, a default value of 0 is assumed. The value of seed is limited to 0 <= seed <= 2^16. The function value will be between 0 and 2^16. ******************** 3157 NAME: PATIENT TREATMENT FILE DATA CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL CASE REGISTRIES USAGE: Supported ENTERED: AUG 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call (RPC^DGPTFAPI) will return data from the Patient Treatment (#45) file. (This IA# is for the API and IA# 3164 is for the RPC). Input: ------ PTFNUMBR - The Patient Treatment IFN (.001 of the #45 file record) RESULTS - Results array (passed by reference) Output: ------- RESULTS - Results array (passed by reference) with the following nodes. RESULTS(0) - 1 (entry found) OR -1 (error) RESULTS(1) - Type of Disposition (#72)^Place of Disposition (#75)^ Principal Diagnosis (#79)^Coding System Version (pointer to ICD Coding Systems #80.4 file) RESULTS(2) - DX 2^DX 3^...^DX 24 (Secondary Diagnosis 2 through Secondary Diagnosis 24) RESULTS(3) - POA 1^POA 2^...^POA 25 (Present on Admission indicators for Principal Diagnosis and Secondary Diagnosis 2 through Secondary Diagnosis 24) ROUTINE: DGPTFAPI COMPONENT: RPC(.RESULTS,PTFNUMBR) VARIABLES: RESULTS Type: Output RESULTS - Results array (passed by reference) with the following nodes. RESULTS(0) - 1 (entry found) OR -1 (error) RESULTS(1) - Type of Disposition (#72)^Place of Disposition (#75)^ Principal Diagnosis (#79)^Coding System Version (pointer to ICD Coding Systems #80.4 file) RESULTS(2) - DX 2^DX 3^...^DX 24 (Secondary Diagnosis 2 through Secondary Diagnosis 24) RESULTS(3) - POA 1^POA 2^...^POA 25 (Present on Admission indicators for Principal Diagnosis and Secondary Diagnosis 2 through Secondary Diagnosis 24) PTFNUMBER Type: Input PTFNUMBR - The Patient Treatment IFN (.001 of the #45 file record) ******************** 3158 NAME: $$CHECKDG CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK REGISTRATION USAGE: Controlled Subscri ENTERED: AUG 8,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine $$CHECKDG^MPIFSPC calculates the checksum for a given 10 digit Integration Control Number (ICN). ROUTINE: MPIFSPC COMPONENT: $$CHECKDG(NUM) VARIABLES: NUM Type: Input 10 digit ICN (without check digits) $$CHECKDG Type: Output 6 digit checksum for the ICN ******************** 3160 NAME: PROCEDURE RESULTING CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CLINICAL PROCEDURES USAGE: Controlled Subscri ENTERED: AUG 9,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: GMRCMED COMPONENT: MEDCOMP VARIABLES: GMRCDA Type: Input IEN from REQUEST/CONSULTATION (#123) file GMRCRSLT Type: Input Varible pointer form of a procedure result from a Medicine data file or Clinical Procedures. e.g. 19;MCAR(691.5, 21;MDD(702, GMRCAD Type: Input FM date/time of action (optional) GMRCORNP Type: Input DUZ of person taking action GMRCALRT Type: Input Array of users to receive alert in format ARR(DUZ)="" This entry point provides a mechanism for CPRS and Clinical Procedures to associate a procedure result with a Consult Procedure request. COMPONENT: CPROC VARIABLES: PROC Type: Input IEN from GMRC PROCEDURE (#123.3) file This entry point is provided for use by Clinical Procedures to determine if a Procedure ordered in CPRS is linked to a Clinical Procedure. COMPONENT: CPLINK VARIABLES: PROC Type: Input IEN from CP DEFINITION (#702.01) file. Entry point provided for Clinical Procedures to determine if a particular entry in the CP DEFINITION (#702.01) file is linked to an entry in the GMRC PROCEDURE (#123.3) file. ******************** 3161 NAME: Point to OR(100) CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DIETETICS CONSULT/REQUEST TRACKING LAB SERVICE INPATIENT MEDICATIONS OUTPATIENT PHARMACY RADIOLOGY/NUCLEAR MEDICINE PROSTHETICS VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: AUG 9,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100 ROOT: OR(100, DESCRIPTION: TYPE: File This agreements documents the clinical packages that have permission to point to the Orders file #100 from within their own package files. ^OR(100,D0) .01 ORDER # 0;1 Read w/Fileman This is the internal number of the order. ROUTINE: ******************** 3162 NAME: POINT TO REQUEST/CONSULTATION (#123) FILE CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES PROSTHETICS CLINICAL PROCEDURES MENTAL HEALTH Added 6/4/20 for MHA USAGE: Controlled Subscri ENTERED: AUG 9,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123 ROOT: GMR(123, DESCRIPTION: TYPE: File This Integration Agreement documents the clinical packages that have permission to point to the REQUEST/CONSULTATION (#123) file. ROUTINE: ******************** 3164 NAME: DG PATIENT TREATMENT DATA CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This call (RPC^DGPTFAPI) will return data from the Patient Treatment (#45) file. (This IA# is for the RPC and IA# 3157 is for the API). Input: ------ PTFNUMBR - The Patient Treatment IFN (.001 of the #45 file record) RESULTS - Results array (passed by reference) Output: ------- RESULTS - Results array (passed by reference) with the following nodes. RESULTS(0) - 1 (entry found) OR -1 (error) RESULTS(1) - Type of Disposition (#72)^Place of Disposition (#75)^ Principal Diagnosis (#79)^Coding System Version (pointer to ICD Coding Systems #80.4 file) RESULTS(2) - DX 2^DX 3^...^DX 24 (Secondary Diagnosis 2 through Secondary Diagnosis 24) RESULTS(3) - POA 1^POA 2^...^POA 25 (Present on Admission indicators for Principal Diagnosis and Secondary Diagnosis 2 through Secondary Diagnosis 24) Returns data from Patient Treatment file (#45). Results(0)=1 (-1 if error) (1)=type of disposition^place of disposition^primary ICD code^Coding System (p80.4) (2)=2nd thru 10th ICD codes (uses "^" as delimiter) (3)=Present On Admission for DX and 2nd thru 10 ICD codes (more data may be added later) ROUTINE: RPC DGPTFAPI ******************** 3165 NAME: DRUG FILE ACTIVITY LOG ADD/EDIT BY OUTPATIENT PHARMACY CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: AUG 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 50 ROOT: PSDRUG( DESCRIPTION: TYPE: File CMOP functionality in the Outpatient Pharmacy application has a need to enter comments into the ACTIVITY LOG field (# 214) multiple of the Drug file (# 50). This functionality also reads and sets the CMOP DISPENSE field (# 215) and its index "^PSDRUG("AQ"," within the Drug file (# 50). The node ^PSDRUG(D0,4,D1) is looped through to find the last entry in the Activity Log multiple prior to inserting a new comment. If the header node for the Activity Log field multiple is not present a header node is inserted into the database. ^PSDRUG(D0,4,0) Activity Log multiple global header node. Insert and update the counters of the header node. ^PSDRUG(D0,4,D1,0) .01 ACTIVITY LOG 0;1 Direct Global R/W & w/ 1 REASON 0;2 Direct Global R/W & w/ 2 INITIATOR OF ACTIVIT 0;3 Direct Global R/W & w/ 3 FIELD EDITED 0;4 Direct Global R/W & w/ 4 VALUE 0;5 Direct Global R/W & w/ ^PSDRUG(D0,3) 213 CMOP DISPENSE 3;1 Direct Global R/W & w/ ROUTINE: ******************** 3166 NAME: CALL FOR PSSDIN - NFI TEXT AVAIL. FOR ORD.ITEM/DISP.DRUG CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VISTA INTEGRATION ADAPTOR VIABDX SAVE RPC references PSSDIN routine. USAGE: Controlled Subscri ENTERED: AUG 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Outpatient Pharmacy, Inpatient Medications and Computerized Patient Record System all request permission to call the function provided by the Pharmacy Data Management package - routine name ^PSSDIN. This call builds the temporary global ^TMP("PSSDIN" with the National Formulary Indicator text for both orderable items and dispense drugs that are marked as restricted items. Sending input of either orderable items or dispense drugs is optional and the routine will only return text where it receives either or both variables. The text may be displayed upon request. ROUTINE: PSSDIN COMPONENT: EN VARIABLES: PSSOI Type: Input Orderable item - This is the Orderable Item internal entry number in the global ^PS(50.7,# (PHARMACY ORDERABLE ITEM file #50.7). PSSDD Type: Input Dispense Drug - This is the Drug internal entry number in the global ^PSDRUG(# (DRUG file #50). TMP Type: Output The call builds all of the NFI text. If entries exist in the global ^PSDRUG(PSSDD,9, (DRUG TEXT ENTRY SUB-FILE #50.037 of DRUG file #50) which points to various drug text entries (dtien), located in the DRUG TEXT file (#51.7) then the global ^TMP("PSSDIN",$J,"DD",PSSDD,dtien,index) is built. If entries exist in the global ^PS(50.7,PSSOI,1 (OI-DRUG TEXT ENTRY SUB-FILE #50.76 of PHARMACY ORDERABLE ITEM file # 50.7) which points to various drug text entries (dtien), located in the DRUG TEXT file (#51.7) then the global ^TMP("PSSDIN",$J,"OI",PSSOI,dtien,index) is built. This entry point builds the temporary global ^TMP("PSSDIN", with National Formulary Indicator text for both orderable items and dispense drugs that are marked as restricted items. The syntax of this call is D EN^PSSDIN(PSSOI,PSSDD). COMPONENT: PROMPT VARIABLES: This entry point checks for the existance of the ^TMP("PSSDIN" global and prompts the user accordingly with the message: Restriction/Guideline(s) exist. Display? O - Orderable Item text available, D - Dispense Drug text available, B - both Orderable Item text and Dispense Drug text are available, N - NO the default not to display any text. If the ^TMP("PSSDIN" global is not found nothing is prompted. If "B" is selected the function will return "Y" as "Y" was used initially not "B". The syntax of this call is S var=$$PROMPT^PSSDIN. ******************** 3167 NAME: PSJORPOE API CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR Access to RESOLVE and SCHREQ in routine PSJORPOE for VIABDPS2 OISLCT RPC and OrderMgmtSvc - getMedOrderableItemDefaults. VIA will also use the STARTSTP entry point for VIAB ADMIN RPC. USAGE: Private ENTERED: AUG 25,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Inpatient Medications is providing 3 entry points to Computerized Patient Record System (CPRS) as a part of the Pharmacy Order Enhancements project. 1) Entry point $$STARTSTP returns to CPRS the setting for the DEFAULT START DATE CALCULATION for the ward the patient is on, Default Start Date/Time based on the parameter, and the number of days or hours the order would last. 2) Entry Point $$RESOLVE returns the parameter passed by CPRS to be resolved and the Date/Time it was resolved to. 3) Entry point $$SCHREQ returns a 1 if a schedule should be required for the order being placed via the Inpatient Medications dialogue through CPRS or a 0 if no schedule is required. ROUTINE: PSJORPOE COMPONENT: $$STARTSTP VARIABLES: PSGP Type: Input This is the IEN of the patient from the PATIENT file (#2). It is required. SCH Type: Input This is the schedule for the order being placed. OI Type: Input This is the IEN of the Orderable Item from the PHARMACY ORDERABLE ITEM file (#50.7). PSJPWD Type: Input This is the IEN of the ward location. It is optional. PSGORD Type: Input This is the IEN of the order with the U or V if the order being placed is a renewal of another order. It is optional. $$STARTSTP Type: Output $$STARTSTP=WARD PARAMETER^DEFAULT START DATE/TIME^#_D(NUMBER OF DAYS ORDER LASTS) OR #_H(NUMBER OF HOURS ORDER LASTS) OR 0. PSJADM Type: Input This is the admin times. (Optional) STARTDT Type: Input This is the date upon which calculations are based instead of doing all calculations against NOW. If nothing is passed in, it will default to NOW. (Optional) Entry point $$STARTSTP(PSGP,SCH,OI,PSJPWD,PSGORD,PSJADM,STARTDT) returns to CPRS the setting for the DEFAULT START DATE CALCULATION for the ward the patient is on, Default Start Date/Time based on the parameter, and the number of days or hours the order would last. COMPONENT: $$RESOLVE VARIABLES: PSGP Type: Input This is the IEN of the patient from the PATIENT file (#2). It is required. SCH Type: Input This is the schedule for the order being placed. It is required. OI Type: Input This is the IEN of the Orderable Item from the PHARMACY ORDERABLE ITEM file (#50.7). PCH Type: Input This is the provider's choice of time for the order to start. Allowable choices are NOW, NEXT, and CLOSEST. PSJPWD Type: Input This is the IEN of the ward location. It is optional. $$RESOLVE Type: Output $$RESOLVE=PCH_^_Resolved Start Date/Time. Entry Point $$RESOLVE(PSGP,SCH,OI,PCH,PSJPWD) returns the parameter passed by CPRS to be resolved and the Date/Time it was resolved to. COMPONENT: $$SCHREQ VARIABLES: MR Type: Input Medication Route from MEDICATION ROUTES file (#51.2). Required. OI Type: Input Orderable Item IEN from PHARAMACY ORDERABLE ITEM file (#50.7). Optional. DD Type: Input Dispense Drug IEN from DRUG file (#50). Optional. $$SCHREQ Type: Output $$SCHREQ will equal 1 if a schedule is required or a 0 if no schedule is required. Entry point $$SCHREQ(MR,OI,DD) returns a 1 if a schedule should be required for the order being placed via the Inpatient Medications dialogue through CPRS or a 0 if no schedule is required. ******************** 3168 NAME: DBIA3168 CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: AUG 16,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CIRN needs to use the Toolkit routine call RMOVPAIR^XDRDVAL1 to remove pairs from the merge process based on CIRN Exceptions. ROUTINE: XDRDVAL1 COMPONENT: RMOVPAIR VARIABLES: FROM Type: Input DFN of patient record merging from. TO Type: Input DFN of patient record file (#2) merging into. IEN Type: Input IEN of Duplicate Record file (#15), where record pairs are listed. array Type: Input Array of records to be merged. This call is used to remove a pair of duplicate records from the merge process. ******************** 3169 NAME: GLOBAL READ OF FILE 101.43 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING USAGE: Private ENTERED: AUG 21,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 101.43 ROOT: ORD(101.43, DESCRIPTION: TYPE: File Consult/Request Tracking utilizes global reads of the global ^ORD(101.43, to facilitate a data conversion included in patch GMRC*3*15. This conversion only reads those orderable items of the Procedure type by utilizing the "S.PROC" cross-reference. ^ORD(101.43,'S.PROC',NAME,DA) This cross-reference holds those records that are of the PROCEDURE type. ^ORD(101.43,DA,0) 2 ID 0;2 Read w/Fileman This fields holds the IEN and a descriptor for the source file from which the entry was created. .01 NAME 0;1 Direct Global Read & w This field contains the name of the ORDERABLE ITEM. ^ORD(101.43,DA,.1) .1 INACTIVATED .1;1 Direct Global Read & w This field is used to indicate that an ORDERABLE ITEM has been inactivated and is no longer in use for ordering in CPRS. ^ORD(101.43,DA(1),2,DA,0) 101.432 SYNONYM 0;1 Direct Global Read & w This multiple field contains the list of synonyms for the particular ORDERABLE ITEM. ROUTINE: ******************** 3170 NAME: CHANGE ORDERABLE ITEM ID CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING During the post-install of GMRC*3*15, the source file for PROCEDURE type orderable items is converted from the PROTOCOL (#101) file to the GMRC PROCEDURE (#123.3) file. Upon conversion of an entry the ID field of the corresponding ORDERABLE ITEM is changed to reference file 123.3. USAGE: Controlled Subscri ENTERED: AUG 21,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORDD43 COMPONENT: ID(CURRENTID,NEWID) VARIABLES: CURRENTID Type: Input The current ID of an orderable item. NEWID Type: Input The ID to which the ORDERABLE ITEM should be changed. When the source file of ORDERABLE ITEMS for an interfacing package changes, the ID field of file 101.43 must be changed to reference an entry within the new file. ******************** 3171 NAME: PRINT REPORT TO GLOBAL ARRAY CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consult/Request Tracking utilizes this routine to produce a global array of a report from the Medicine package utilizing the EN^MCAPI(result) entry point. AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: AUG 21,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The START^ORWRP call allows the opening of the OR WORKSTATION device and printing of a report to that device, thereby returning the text of the report in a global array descendant from ^TMP("ORDATA",$J,. ROUTINE: ORWRP COMPONENT: START(MWIDTH,CALL) VARIABLES: MWIDTH Type: Input This is the margin width to which the report should be formatted. CALL Type: Input This variable contains a line tag and routine in the format "TAG^ROUTINE(PARAM)" that will be executed to produce the report output. TMP('ORDAT Type: Output The output from the linetag and routine executed in the variable CALL will be directed to the global array ^TMP("ORDATA",$J, The START^ORWRP call allows the opening of the OR WORKSTATION device and printing of a report to that device, thereby returning the text of the report in a global array descendant from ^TMP("ORDATA",$J,. ******************** 3172 NAME: Special Printer Variables CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 28,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Entry points for special printer variables. ROUTINE: %ZISP COMPONENT: PKILL VARIABLES: Use PKILL^%ZISP to kill printer-specific Device Handler variables. All output variables defined by the PSET^%ZISP entry point are killed. COMPONENT: PSET VARIABLES: IOST(0) Type: Input Pointer to the TERMINAL TYPE entry for the printer in question, as set up by the Device Handler. IOBAROFF Type: Output Bar code off IOBARON Type: Output Bar code on IOCLROFF Type: Output Color off IOCLRON Type: Output Color on IODPLXL Type: Output Duplex, long edge binding IODPLXS Type: Output Duplex, short edge binding IOITLOFF Type: Output Italics off IOITLON Type: Output Italics on IOSMPLX Type: Output Simplex IOSPROFF Type: Output Superscript off IOSPRON Type: Output Superscript on IOSUBOFF Type: Output Subscript off IOSUBON Type: Output Subscript on Use PSET^%ZISP to define a set of variables that toggle special printer modes. The corresponding fields in the TERMINAL TYPE file entry for the terminal type in question must be correctly set up, however; that is where PSET^%ZISP retrieves its output values. To toggle a printer mode with one of PSET^%ZISP's output variables, write the variable to the printer using indirection, as follows: D PSET^%ZISP W @IOBARON ******************** 3173 NAME: XGF Function Library CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 28,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This XGF Function Library supports terminals that are ANSI-compatible and at least VT100-compatible. As a result, this software does not support QUME QVT102/QVT102A terminals. Programmer Tools > D ^XGFDEMO: Demo Program To run an interactive demonstration showing the capabilities provided by the XGF Function Library, you can run the XGF demo program. From the programmer prompt, type the following: >D ^XGFDEMO Functional Division of XGF Function Library Cursor/Text Output: IOXY^XGF, SAY^XGF, SAYU^XGF. Keyboard Reader: $$READ^XGF. Setup/Cleanup: CLEAN^XGF, INITKB^XGF, PREP^XGF, RESETKB^XGF. Text Window: CLEAR^XGF, FRAME^XGF, RESTORE^XGF, SAVE^XGF, WIN^XGF. Video Attribute: CHGA^XGF, SETA^XGF. ROUTINE: XGF COMPONENT: CHGA VARIABLES: B1 Type: Input Blink on B0 Type: Input Blink off I1 Type: Input Intensity high I0 Type: Input Intensity normal R1 Type: Input Reverse video on R0 Type: Input Reverse video off G1 Type: Input Graphics on G0 Type: Input Graphics off U1 Type: Input Underline on U0 Type: Input Underline off E1 Type: Input Turn all off XGCURATR Type: Output This variable always holds the current screen attribute coded as a single character, and is updated when you call CHGA^XGF. Usage D CHGA^XGF(atr_codes) Changes individual video attributes for subsequent screen writes. Use this entry point to change individual video attributes for subsequent output. This entry point is different from SETA^XGF in that individual video attributes can be set without affecting all video attributes at once. A call to PREP^XGF must be made at some point prior to calling CHGA^XGF. The attribute codes are not case sensitive. You can append them if you want to set more than one attribute. If you include more than one attribute, their order is not important. B0 and B1 turn off and on the blink attribute; I0 and I1 turn off and on the intensity attribute; R0 and R1 turn off and on the reverse attribute; U0 and U1 turn off and on the underline attribute. E1 turns off all attributes. G0 and G1 turn off and on recognition of an alternate graphics character set so that you can use special graphic characters, in particular those set up by Kernel's GSET^%ZISS entry point. To use graphics characters, be sure you turn on graphics first (with G1) and turn graphics off afterwards (with G0). The change in attribute remains in effect until another CHGA^XGF, PREP^XGF or SETA^XGF CALL is made. COMPONENT: CLEAN VARIABLES: Use CLEAN^XGF to exit the XGF screen and keyboard environments. It removes XGF screen and keyboard variables and tables, turns all video attributes off, turns echo on, turns the cursor on, and sets the keypad to numeric mode. COMPONENT: CLEAR VARIABLES: top Type: Input Top screen coordinate for box left Type: Input Left screen coordinate for box bottom Type: Input Bottom screen coordinate for box right Type: Input Right screen coordinate for box. $X,$Y Type: Output Set to right and bottom specified as parameters Usage D CLEAR^XGF(top,left,bottom,right) Clears a rectangular region of the screen. This entry point is useful to clear a portion of the screen. The CLEAR function works by printing spaces using the current screen attribute in the specified region. If the screen attribute is changed and then the CLEAR function used, the rectangular region is cleared in the new attribute. Acceptable values for the top and bottom parameters range from 0 to IOSL-1. Acceptable values for the left and right parameters range from 0 to IOM-1. COMPONENT: FRAME VARIABLES: top Type: Input Top screen coordinate for box. left Type: Input Left screen coordinate for box bottom Type: Input Bottom screen coordinate for box. right Type: Input Right screen coordinate for box. $X,$Y Type: Output Set to the right and bottom specified as parameters. Usage D FRAME^XGF(top,left,bottom,right) Draws a box frame on the screen. Use this entry point to display boxes on the screen. The FRAME function does not clear or otherwise change the region that it encompasses. If you need to open an empty framed window you should use WIN^XGF entry point instead. Acceptable values for the top and bottom parameters range from 0 to IOSL-1. Acceptable values for the left and right parameters range from 0 to IOM-1.E COMPONENT: INITKB VARIABLES: term_str Type: Input String of characters that should terminate the read. Usage D INITKB^XGF([term_str]) Sets up the XGF keyboard environment only. You should call INITKB^XGF once, before you start making calls to the $$READ^XGF function. This entry point turns on escape processing and any terminators that are passed. Use this entry point only if you are using XGF's Keyboard Reader independently from XGF's screen functions. Otherwise, a call to PREP^XGF does everything to set up keyboard processing that INITKB^XGF does, and aseparate call to INITKB^XGF is not necessary. Unlike PREP^XGF, INITKB^XGF does not set the keypad to application mode. INITKB does not call %ZISS. Thus, documented Kernel variables such as IOKPAM and IOKPNM are not available for use without a separate call to ENS^%ZISS. COMPONENT: IOXY VARIABLES: row Type: Input Row position to move cursor to. col Type: Input Column position to move cursor to. $X,$Y Type: Output Set to the row and column specified as parameters. Usage D IOXY^XGF(row,col) Positions cursor on the screen at a screen coordinate. This entry point is similar to Kernel's X IOXY function. The row parameter must be between 0 and IOSL-1; the column parameter must be between 0 and IOM- 1. A call to PREP^XGF must be made at some point prior to calling IOXY^XGF. You can specify row and column parameters relative to the current $X and $Y by specifying "+" or "-" to increment or decrement $X or $Y by 1. You can increment or decrement by more than one if you add a number as well, such as "-5" or "+10". Note that you must use quotes to pass a "+" or "-". Otherwise, to specify exact locations for row and column, pass numbers. COMPONENT: PREP VARIABLES: XGCURATR Type: Output One-character variable containing state of current video attribute. Usage D PREP^XGF Sets up the XGF screen and keyboard environments. Before using any XGF screen functions, you must call the PREP^XGF entry point. PREP^XGF sets up screen control variables and tables. It also turns off all video attributes, turns echo off, turns the cursor off, sets the keypad to application mode, and clears the screen. In addition, PREP^XGF does everything that INITKB^XGF does to set up the XGF keyboard environment, including turning escape processing and terminators on. If you call PREP^XGF, a call to INITKB^XGF would be redundant. COMPONENT: $$READ VARIABLES: no_of_char Type: Input [optional] Maximum # of characters to read. timeout Type: Input [optional] Maximum duration of read, in seconds. return_val Type: Output The string read from the user. Set to the mnemonic of the key that terminated the read; see list below or the table in routine XGKB for list of possible values. DTOUT Type: Output If defined, signifies that the read timed out. Usage S ZYXSTR=$$READ^XGF([no_of_char][,timeout]) $$READ^XGF provides a way to perform reads using escape processing. Reads, when escape processing is turned on, are terminated by , , , , , and other special keystrokes. $$READ^XGF is a low-level reader compared to the VA FileMan reader. In some respects it is as simple as using the M read command. This read function incorporates escape processing which puts the burden on the operating system to read the arrow, function, and all other keys. A call to INITKB^XGF or PREP^XGF must be made at some point prior to calling $$READ^XGF. If the number of characters you request with the first parameter is not entered, the read does not terminate until some terminating character is pressed (or the timeout period is reached). If you don't pass the timeout parameter, DTIME is used for the timeout period. If the read times out, ^ is returned and DTOUT is left defined. COMPONENT: RESETKB VARIABLES: Usage D RESETKB^XGF Exits the XGF keyboard environment. You should use the RESETKB^XGF call once you finish making calls to the $$READ^XGF function. The RESETKB^XGF entry point turns terminators and escape processing off and removes any XGF keyboard environment variables. Subsequent reads are processed normally. Use this entry point only if you are using XGF's Keyboard Reader independently from XGF's screen functions. Otherwise, a call to CLEAN^XGF does everything to clean up keyboard processing that RESETKB^XGF does, and a separate call to RESETKB^XGF is not necessary. Unlike CLEAN^XGF, RESETKB^XGF does not set the keypad to numeric mode. COMPONENT: RESTORE VARIABLES: save_root Type: Input Global/local array node, closed root form. $X,$Y Type: Output Set to the bottom right coordinate of the restored window. Usage D RESTORE^XGF(save_root) Use RESTORE^XGF to restore a previously saved screen region. You can save screen regions using the WIN^XGF and SAVE^XGF entry points. RESTORE^XGF restores the saved screen region in the same screen position as the screen region was saved from. A call to PREP^XGF must be made at some point prior to calling RESTORE^XGF. Specify the array node under which to save the overlaid screen region in closed root and fully resolved form: that is, closed right parenthesis and with variable references such as $J fully resolved. Using M $NAME function is a quick way to pass fully resolved node specifications. COMPONENT: SAVE VARIABLES: top Type: Input Top screen coordinate for box. left Type: Input Left screen coordinate for box. bottom Type: Input Bottom screen coordinate for box. right Type: Input Right screen coordinate for box. save_root Type: Input Global/local array node, closed root form. Usage D SAVE^XGF(top,left,bottom,right,save_root) Use this entry point to save a screen region. In order to save and restore screen regions, you must do all screen output using calls in the XGF Function Library output. If you instead use the M write command for output, the screen contents cannot be saved and restored. Also, a call to PREP^XGF must be made at some point prior to calling SAVE^XGF. Specify the array node under which to save the overlaid screen region in closed root and fully resolved form: that is, closed right parenthesis and with variable references such as $J fully resolved. Using M $NAME function is a quick way to pass fully resolved node specifications. COMPONENT: SAY VARIABLES: row Type: Input [optional] Row position to start write. col Type: Input String to write. str Type: Input [optional] Video attribute to write string with. atr Type: Input See CHGA^XGF for description of atr codes. $X,$Y Type: Output Set to position of the last character output. Usage D SAY^XGF([row],[col],str[,atr]) Outputs a string to the screen (with optional positioning and attributecontrol). Use this entry point rather than the M write command to output strings to the screen. The row and column parameters specify where to print the string. If omitted, the current row and column positions are used. If specified, the row must be between 0 and IOSL-1, and the column must be between 0 and IOM-1. A call to PREP^XGF must be made at some point prior to calling SAY^XGF. COMPONENT: SAYU VARIABLES: row Type: Input [optional] Row position to start write. col Type: Input [optional] Column position to start write. str Type: Input String to write ("&" underlines next character). atr Type: Input [optional] Video attribute to write string with (see CHGA^XGF for description of atr codes). $X,$Y Type: Output Set to the position of the last character output. Usage D SAYU^XGF([row],[col],str[,atr]) Outputs a string to the screen (with optional position and attribute control), including the ability to underline an individual character. This entry point is similar to SAY^XGF. The difference is that the first ampersand ("&") character has a special meaning in the output string; it acts as a flag to indicate that the next character should be underlined. You are only allowed one underlined character per call. Typically you would use SAYU^XGF when writing a menu option's text, in order to underline that option's speed key.A call to PREP^XGF must be made at some point prior to calling SAYU^XGF. COMPONENT: SETA VARIABLES: atr_code Type: Input Single character containing the states of all video attributes as the bit values. This argument itself should be derived from a previous call to PREP^XGF, CHGA^XGF, or SETA^XGF. XGCURATR Type: Output This variable always holds the current screen attribute coded as a single character, and is updated when you call SETA^XGF. Usage D SETA^XGF(atr_code) SETA^XGF sets all video attribute simultaneously, for subsequent screen output. This entry point is different from CHGA^XGF in that it takes a different form of the attribute argument, and, unlike CHGA^XGF, sets all attributes. The change in attribute remains in effect until you make another CHGA^XGF, CLEAN^XGF or SETA^XGF call. If you want only a temporary change in attribute, SAY^XGF may be a better function to use. A call to PREP^XGF must be made at some point prior to calling SETA^XGF. The value of the attribute parameter uses one bit for the value of each video attribute. The format of the bits is not documented. The current setting of all video attributes is accessible via the variable XGCURATR, however. Rather than trying to use SETA^XGF to control an individual video attribute's setting, you should use it mainly to restore the screen attributes based on a previously saved value of XGCURATR. COMPONENT: WIN VARIABLES: top Type: Input Top screen coordinate for box. left Type: Input Left screen coordinate for box. bottom Type: Input Bottom screen coordinate for box. right Type: Input Right screen coordinate for box. save_root Type: Both [optional] Global/local array node, closed root form. $X,$Y Type: Output If you specify a node as a fifth parameter for save_root, WIN^XGF saves the screen region you overlay in an array at that node. Set to the right and bottom coordinates you specify as parameters. Usage D WIN^XGF(top,left,bottom,right[,save_root]) Use this entry point to open a text window on the screen and optionally remember what it overlays. If the save root parameter is not passed, you cannot restore the screen behind the window. In order to save the screen region that the window overlays it is absolutely necessary that screen output is done using only the functions in the XGF Function library. If you use the M write command for output, the screen contents cannot be saved. A call to PREP^XGF must be made at some point prior to calling WIN^XGF. Specify the array node under which to save the overlaid screen region in closed root and fully resolved form: that is, closed right parenthesis and with variable references such as $J fully resolved. Using M $NAME function is a quick way to pass fully resolved node specifications. To restore screens you save with the WIN^XGF function, use the RESTORE^XGF entry point. ******************** 3174 NAME: DBIA3174 CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: AUG 31,2000 STATUS: Active EXPIRES: JAN 2003 DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point EN^PSBIPM is provided by the Bar Code Medication Administration (BCMA) package to provide information to Inpatient Medications to be used in determining the start date for a renewed order. The MOB entry point is used by Inpatient Medications to get information obtained from the BCMA/CPRS Med Order function. The MOBR is used by Inpatient Medications to notify BCMA that the order has been accepted and processed by Inpatient Pharmacy. ROUTINE: PSBIPM COMPONENT: $$EN VARIABLES: DFN Type: Input The patients internal entry number from the PATIENT FILE, 2. PSBORDX Type: Input The pharmacy order number. PSBSTUS Type: Output This is the status of the last action. PSBLAST Type: Output A FileMan date/time. This is the date of the last action. PSBADMDT Type: Output A FileMan date/time. This is the scheduled administration time. Provides Inpatient Medications with the type, date, and status of a patients last BCMA action. COMPONENT: MOB VARIABLES: DFN Type: Input The patients internal entry number from the PATIENT FILE, 2. PSBCORN Type: Input The CPRS order number. ARRAY Type: Output ^TMP("PSB",$J,0) $P(1) = DFN $P(2) = CPRS order number $P(3) = Schedule ^TMP("PSB",$J,700,0) = Total number of dispense drugs ^TMP("PSB",$J,700,#) = IEN from file 50 ^TMP("PSB",$J,800,0) = Total number of additives ^TMP("PSB",$J,800,#) = IEN from file 52.6 ^TMP("PSB",$J,900,0) = Total number of solutions ^TMP("PSB",$J,900,#) = IEN from file 52.7 Provides Inpatient Medications with an array of data returned by the BCMA/CPRS Med Order function. COMPONENT: MOBR VARIABLES: DFN Type: Input The internal entry number from PATIENT FILE, 2. PSBCORN Type: Input The CPRS order number. PSBORDN Type: Input The Inpatient Medications order number if processed, null if rejected. This entry point is used by Inpatient Medications to notiy BCMA that the order has been processed or rejected. There is no return from this entry point. ******************** 3176 NAME: DBIA3176-A CUSTODIAL PACKAGE: VBECS SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: SEP 16,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point TRAN^VBECA4 is provided by the Blood Bank package to collect transfusion record data based on the patient identifier (DFN) value provided in the call. The API will create entries in the ^TMP global for every record found by the function. This API will replace the use of XTRCT^GMTSLRTE by Health Summary. ROUTINE: VBECA4 COMPONENT: TRAN VARIABLES: INPUT DEFINITION: DFN = Internal entry number from the PATIENT file (#2) (Passed as a parameter) TMPLOC = The first subscript location in the ^TMP global (Passed as a parameter) GMTS1 = Inverse end date of search (Passed as a parameter) GMTS2 = Inverse start date of search (Passed as a parameter) OUTPUT DEFINITION: This API (TRAN^VBECA4) will be the new entry point for Health Summary to use in gathering Blood Transfusion data. The call reads Blood Bank data and creates entries in ^TMP(TMPLOC,$J) for the presentation of the data. Health Summary agrees to stop calling XTRCT^GMTSLRTE and instead call TRAN^VBECA4(DFN,TMPLOC,GMTS1,GMTS2). The output format is: ^TMP(TMPLOC (passed in input parameter),$J,PRODUCT NAME ABBREVIATION) = FULL BLOOD PRODUCT NAME ^TMP(TMPLOC (passed in input parameter),$J,Inverse Date)=Date^Total of Units Pooled_"\"_Product Name Abbreviation ******************** 3177 NAME: DBIA3176-B CUSTODIAL PACKAGE: VBECS SUBSCRIBING PACKAGE: HEALTH SUMMARY ORDER ENTRY/RESULTS REPORTING added April 2009 USAGE: Controlled Subscri ENTERED: SEP 8,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point AVUNIT^VBECA4 returns the available units between two dates based on the patient identifier (DFN) value provided in the call. The API will create entries in the ^TMP global for every record found by the function. This API will replace the use of XTRCT^GMTSLRBE by Health Summary. ROUTINE: VBECA4 COMPONENT: AVUNIT VARIABLES: INPUT DEFINITION: DFN = Internal entry number from the PATIENT file (#2) (Passed as a parameter) TMPLOC = The first subscript location in the ^TMP global (Passed as a parameter) GMTS1 = Inverse end date of search (Passed as a parameter) GMTS2 = Inverse start date of search (Passed as a parameter) GMTSNDM = Maximum number to be extracted (Passed as a parameter) OUTPUT DEFINITION: The function will gather Blood Bank unit data for presentation to Health Summary. This API (AVUNIT^VBECA4) will replace XTRCT^GMTSLRBE as the new entry point for Health Summary to use in producing the report. The call reads Blood Bank available unit data and creates entries in ^TMP(TMPLOC,$J) for the temporary storage of the data. Health Summary agrees to stop calling XTRCT^GMTSLRBE and instead call AVUNIT^VBECA4(DFN,TMPLOC,GMTS1,GMTS2, GMTSNDM). The output format is: ^TMP(TMPLOC,$J,0) = ABO Value_U_RH factor ^TMP(TMPLOC,$J,Inverse Date) = Expiration Flag_U_Expiration Date_U_Unit ID_U_Component_U _Volume_U_ABO_U_RH_U_Donation Type_U_Division where unit is located_U_ Location to which unit of blood is being relocated ******************** 3178 NAME: Convert String to Soundex CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: AUG 29,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Use this function to convert a string into a numeric representation of the string, using soundex methods. Soundex represents the phonetic properties of a string; its chief feature is that it assigns similar strings the same soundex representation. ROUTINE: XUA4A71 COMPONENT: $$EN VARIABLES: string Type: Input String to convert into soundex form. Usage S X=$$EN^XUA4A71(string) ******************** 3179 NAME: 3179 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY USAGE: Private ENTERED: AUG 30,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API provides Inpatient Medications and Outpatient Pharmacy a means of getting the strength and unit for a specified drug from the DRUG file (#50). ROUTINE: PSSUTIL1 COMPONENT: EN VARIABLES: PSSDRIEN Type: Input IEN of drug from DRUG file (#50). X Type: Output The output variable is specifed by the user. The output is in the format strength|^^^IEN of DRUG UNITS file (#50.607)^Name of UNITS^99PSU or if the| units are calculated and not in the DRUG UNITS file the format will be strength |^^^^Name of UNITS^99PSU.| If there is no strength available the output will be format will be |^^^^^99PSU| This entry point returns the strength and unit for the drug IEN passed into the routine. If the stength of the drug does not match the stength of the NDF match and the unit contains a / then the unit returned is calculated and may not be contained in the DRUG UNITS file (#50.607) ******************** 3180 NAME: DBIA 3180 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Private ENTERED: AUG 29,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 27.16 ROOT: DD(27.16, DESCRIPTION: TYPE: File There is a "LAYGO" node on the .01 field of ENROLLMENT GROUP THRESHOLD file (#27.16). The code prevents any records from being added to the file. Since there are no FileMan tools to remove a "LAYGO" node once it's set, Enrollment would like permission to add an explicit KILL of the node in a post-install routine. The line of code would be: K ^DD(27.16,.01,"LAYGO") The ENROLLMENT GROUP THRESHOLD file is part of the Enrollment package. ROUTINE: ******************** 3181 NAME: DBIA3181-A CUSTODIAL PACKAGE: VBECS SUBSCRIBING PACKAGE: LAB SERVICE 2/25/14-Access to entry points ABO and RH for Lab is also documented in ICRs #3182 and 3183. These ICRs were retired as duplicates of ICR #3181. ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: SEP 16,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These API's are provided to return Blood Bank data to subscribing packages. ROUTINE: VBECA1 COMPONENT: ABORH VARIABLES: ABORH Type: DFN Type: Input This is the internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). INPUT DEFINITION: DFN = internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). OUTPUT DEFINITION: ABO RH This function will return the ABO Blood Group and RH Type value found for the patient provided in the call. This is an extrinsic function call. If no valid patient identifier is provided, the call will return a value of -1. If no ABO Blood Group or RH Type value for the patient exists in the database, the function will return a null value to the call. The values will be return separated by a space (" "). For example, if a patient has Blood Group "A" and RH Type "POS" (positive), the function would return "A POS". COMPONENT: ABO VARIABLES: DFN Type: Input This is the internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). INPUT DEFINITION: DFN = internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). OUTPUT DEFINITION: "A" or "B" or "AB" or "O" This function will return the ABO Blood Group value found for the patient provided in the call. This is an extrinsic function call. If no valid patient identifier is provided, the call will return a value of -1. If no ABO Blood Group value for the patient exists in the database, the function will return a null value to the call. COMPONENT: RH VARIABLES: Type: DFN Type: Input This is the internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). INPUT DEFINITION: DFN = internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). OUTPUT DEFINITION: "POS" or "NEG" This function will return the RH Type value for the patient provided in the call. This is an extrinsic function call. If no valid patient identifier is provided, the call will return a value of -1. If no RH Type value for the patient exists in the database, the function will return a null value to the call. COMPONENT: ABID VARIABLES: DFN Type: Input This is the internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). .ARR Type: Both The name of an array that will store the value of any antibodies found in Blood Bank patient records by the function. This array must be passed by reference. For each antibody record found, the returned array will contain the name of the antibody in the first data piece of the array and any antibody comments in the second data piece. The populated array will be returned with the following structure: ARR("ABID",n) = Antibody ^ Antibody comment Where "n" is a sequential number index for the array. INPUT DEFINITION: DFN = internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). .ARR = The name of an array that will store the value of any antibodies found in Blood Bank patient records by the function. This array must be passed by reference. OUTPUT DEFINITION: If no antibodies are found, the array will be returned empty. For each antibody record found, the array will contain the name of the antibody in the first data piece of the array and any antibody comments in the second data piece. The populated array will be returned with the following structure: ARR("ABID",n) = Antibody ^ Antibody comment Where "n" is a sequential number index for the array. COMPONENT: AGAB VARIABLES: This component is no longer supported with the release of VBECS. COMPONENT: TRRX VARIABLES: DFN Type: Input This is the internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). .ARR Type: Both The name of the array, passed to the API by reference, that will be used to store the transfusion reactions found in Blood Bank patient records via the function. Retrieve any previously recorded transfusion reactions. If none exist on record, the array will be returned empty. For each transfusion reaction found, the array element will be assigned the transfusion reaction date/time value at the first data piece and the transfusion reaction type value at the second data piece. The populated array be returned with the following structure: ARR("TRRX",n) = RXN D/T ^ RXN Type Where "n" is a sequential index number. DFN = internal entry number from the PATIENT file (#2) (Passed as a parameter). You must precede the internal entry number with the accent grave character ( ` ). .ARR = The name of an array that will store the value of any absent antigens found by the function. Must be passed by reference. OUTPUT DEFINITION: ARR = The name of the array, passed to the API by reference, that will be used to store the transfusion reactions found in Blood Bank patient records via the function. Retrieve any previously recorded transfusion reactions. If none exist on record, the array will be returned empty. For each transfusion reaction found, the array element will be assigned the transfusion reaction date/time value at the first data piece and the transfusion reaction type value at the second data piece. The populated array be returned with the following structure: ARR("TRRX",n) = RXN D/T ^ RXN Type Where "n" is a sequential index number. COMPONENT: BBCMT VARIABLES: This component is no longer supported with the release of VBECS. COMPONENT: AUTO VARIABLES: This component is no longer supported with the release of VBECS. COMPONENT: AGPRES VARIABLES: This component is no longer supported with the release of VBECS. ******************** 3194 NAME: TIU AUTHORIZATION CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING IMAGING INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** This functionality is being released in HMP*2.0*2 USAGE: Controlled Subscri ENTERED: SEP 12,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC allows the calling application to evaluate privilege to perform any ASU-mediated action on a TIU document. ROUTINE: CANDO TIUSRVA ******************** 3195 NAME: TIU CAN CHANGE COSIGNER? CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 29,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure BOOLEAN RPC to evaluate user's privilege to modify the expected cosigner, given the current status of the document, and the user's role with respect to it. ROUTINE: CANCHCOS TIUSRVA ******************** 3197 NAME: XQALBUTL CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 19,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The DELSTAT entry point in XQALBUTL is a SUPPORTED reference for obtaining information on the recipients of the most recent alert with a specified alert id and the status of whether the alert has been deleted or not for those recipients. DELSTAT - For the most recent alert with XQAIDVAL as the PackageID passed in, on return array VALUES contains the DUZ for users in VALUES along with an indicator of whether the alert has been deleted or not, e.g., DUZ^0 if not deleted or DUZ^1 if deleted. Note that contents of VALUES will be killed prior to building the list. Example: D DELSTAT^XQALBUTL("OR;14765;23",.RESULTS) Returned: The value of RESULTS indicates the number of entries in the array. The entries are then ordered in numerical order in the RESULTS array. RESULTS = 3 RESULTS(1) = "146^0" User 146 - not deleted RESULTS(2) = "297^1" User 297 - deleted RESULTS(3) = "673^0" User 673 - not deleted ROUTINE: XQALBUTL COMPONENT: DELSTAT VARIABLES: XQAIDVAL Type: Input XQAIDVAL is a value which has been used as the XQAID value for generating an alert by a package. This value is used to identify the most recent alert generated with this XQAID value and that alert is used to generate the responses in terms of recipients and deletion status of the alert for each of the recipients. VALUES Type: Output This variable is passed by reference and is returned as an array. This value is KILLED prior to generation of the results for return. Returned: The value of VALUES indicates the number of entries in the array. The entries are then ordered in numerical order in the VALUES array. VALUES = 3 VALUES(1) = "146^0" User 146 - not deleted VALUES(2) = "297^1" User 297 - deleted VALUES(3) = "673^0" User 673 - not deleted DELSTAT - For the most recent alert with XQAIDVAL as the PackageID passed in, on return array VALUES contains the DUZ for users in VALUES along with an indicator of whether the alert has been deleted or not, e.g., DUZ^0 if not deleted or DUZ^1 if deleted. Note that contents of VALUES will be killed prior to building the list. Example: D DELSTAT^XQALBUTL("OR;14765;23",.RESULTS) Returned: The value of RESULTS indicates the number of entries in the array. The entries are then ordered in numerical order in the RESULTS array. RESULTS = 3 RESULTS(1) = "146^0" User 146 - not deleted RESULTS(2) = "297^1" User 297 - deleted RESULTS(3) = "673^0" User 673 - not deleted ******************** 3198 NAME: TIU DOCUMENTS BY CONTEXT CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE IMAGING ORDER ENTRY/RESULTS REPORTING BAR CODE EXPANSION INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** This functionality is being released in HMP*2.0*2 USAGE: Controlled Subscri ENTERED: SEP 12,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns lists of TIU Documents that satisfy the following search criteria: 1 - signed documents (all) 2 - unsigned documents 3 - uncosigned documents 4 - signed documents/author 5 - signed documents/date range ROUTINE: CONTEXT TIUSRVLO ******************** 3201 NAME: TIU IS THIS A CONSULT? CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING IMAGING INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** This functionality is being released in HMP*2.0*2 USAGE: Controlled Subscri ENTERED: NOV 6,2006 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure BOOLEAN RPC which evaluates whether the title indicated is that of a consult. ROUTINE: ISCNSLT TIUCNSLT ******************** 3204 NAME: TIU LONG LIST OF TITLES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT INSURANCE CAPTURE BUFFER ADDED JUNE 2009 MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) Effective with VPS*1*3 HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** This functionality is being released in HMP*2.0*2 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC serves data to a longlist of selectable TITLES by CLASS. e.g., passing the class PROGRESS NOTES will return active Progress Notes titles which the current user is authorized to enter notes under. ROUTINE: LONGLIST TIUSRVD ******************** 3205 NAME: TIU PERSONAL TITLE LIST CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING IMAGING MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure returns the user's list of preferred titles for a given class of documents, along with the default title, if specified. ROUTINE: PERSLIST TIUSRVD ******************** 3208 NAME: DBIA3208 CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX USAGE: Private ENTERED: FEB 21,2002 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 991.11 ROOT: RGHL7(991.11, DESCRIPTION: TYPE: File MPI-AUSTIN needs an integration agreement to support direct reads to ^RGHL7(991.11 for the MPI exception handler. ^RGHL7(991.11, 10 TEXT 10;E1,10 Direct Global Read & w This field holds the message for the exception type. ROUTINE: ******************** 3209 NAME: DDR GETS ENTRY DATA CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 20,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3210 NAME: TIU UPDATE ADDITIONAL SIGNERS CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: DENTAL ORDER ENTRY/RESULTS REPORTING INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC accepts a list of persons, and adds them as additional signers for the document identified by the first parameter. ROUTINE: IDSIGNRS TIULX ******************** 3211 NAME: DBIA3211 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: SCHEDULING USAGE: Private ENTERED: SEP 22,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File The Scheduling Package desires an Integration Agreement with the PCE Package to access and update the #9000010 VISIT file. The .01 VISIT/ADMIT DATE&TIME field will be validated and updated if necessary. ^AUPNVSIT(D0,0) .01 VISIT/ADMIT DATE&TIM 0;1 Direct Global Read & w .01 VISIT ADMIT DATE&TIM 0;1 Write w/Fileman ROUTINE: ******************** 3213 NAME: XQALSURO CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 27,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement adds two additional SUPPORTED entry points or APIs to XQALSURO. SETSURO1 should be used in the future instead of SETSURO to establish a surrogate for alerts. SETSURO1 returns a value of 1 if the surrogate was created successfully, otherwise, it returns a text string explaining why the surrogate was not created. SETSURO simply added the specified surrogate, but did not test for cyclic relationships (such that the user eventually would become the surrogate). SETSURO1 does these tests and therefore has the possibility of failure. GETSURO is an API which can be used to obtain information about the current surrogate, including start and end date/times if they are specified. SUROLIST is an API which can be used to obtain a list of the current and future surrogate periods for a selected user. SUROFOR is an API which can be used to obtain a list of any current users that the selected user is acting as a surrogate for. ROUTINE: XQALSURO COMPONENT: GETSURO VARIABLES: XQAUSER Type: Input This is the internal entry number in the NEW PERSON file (file #200) of the user for which alert surrogate information is to be returned. $$GETSURO^XQALSURO(XQAUSER) returns a string of '^' separated information on the current surrogate for the user with XQAUSER as his internal entry number in the NEW PERSON file. The value returned is of the form ien^NAME^FM_STARTDATE^FM_ENDDATE where ien is the internal entry number of the SURROGATE in the NEW PERSON file, NAME is the contents of the .01 field for the SURROGATE, FM_STARTDATE is the starting date/time for the SURROGATE in internal Filemanager format, and FM_ENDDATE is the ending date/time for the SURROGATE in internal Filemanager format. S X=$$GETSURO^XQALSURO(124) might yield a value of X containing 2327^DOE,JOHN^3000929.1630^3001006.0800 indicating that user #2327 (John Doe) will become active as surrogate at 4:30 PM 9/29/00 and will remain surrogate until 8:00 am on 10/06/00. If there was no surrogate, the result would be ^^^ If either of the date/times are not specified, they will return a null value for that piece of the return string. COMPONENT: SETSURO1 VARIABLES: XQAUSER Type: Input XQAUSER is the internal entry number in file 200 (DUZ) for the user for which the surrogate should act in receiving alerts. XQASURRO Type: Input XQASURRO is the internal entry number in file 200 (DUZ) for the user who will receive and process alerts for XQAUSER. XQASTART Type: Input XQASTART is an optional START Date/Time for the surrogate activity in Filemanager format. If XQASTART is not specified, the surrogate relationship begins immediately. XQAEND Type: Input XQAEND is an optional date/time for the end of the surrogate relationship in Filemanager format. If XQAEND is not specified, the surrogate remains active until anothersurrogate is specified, or the surrogate deleted. Type: This API should be used instead of the SETSURO^XQALSURO API. The SETSURO1 entry point returns a value indicating success (a TRUE (value =1)) or failure (a FALSE (value=message indicating reason for failure)). The SETSURO entry point returned no value and, as long as both a user and surrogate were specified, would simply store the values. This leaves open the possibility that the user is specified as the surrogate or that a chain of surrogates ends up pointing again at the user, cases that could result in a very tight, non-ending, loop being generated if an alert was sent. These possibilities have been tested for in the interactive specifiction of surrogates, and is tested for non-interactive usage in the SETSURO1^XQALSURO API. Usage would be: S XQAUSER=DUZ ; user identification S XQASURO=45 ; Surrogate's DUZ number (internal entry number in file 200) S XQASTRT=3001004.1630 ; Start Date/Time in Filemanager internal format S XQAEND=3001008.1630 ; End Date/Time for surrogate in FM internal format S X=$$SETSURO1^XQALSURO(USER,SURROGAT,START,END) I 'X W !,"Could not activate surrogate",!,?5,X Q The Start and End Date/Time values are optional. If the Start Date/Time is not specified, the surrogate relationship begins immediately. If the End Date/Time is not specified, the surrogate remains active until another surrogate is specified, or the surrogate deleted. COMPONENT: SUROLIST VARIABLES: XQAUSER Type: Input XQAUSER is the internal entry number in file 200 (DUZ) for the user for which the surrogate should act in receiving alerts. XQALIST Type: Both XQALIST is a variable which is passed by reference which will contain the list of current and future surogates for the specified user. The SUROLIST entry point returns a returns for XQAUSER a list of current and/or future surrogates in XQALIST (which must be passed by reference) Usage would be: S XQAUSER=DUZ ; user identification D SUROLIST^XQALSURO(XQAUSER,.USERLIST) This returns USERLIST=count USERLIST(1)=IEN2^NEWPERSON,USER2^STARTDATETIME^ENDDATETIME USERLIST(2)=3^NAME,USER3^3050407.1227^3050406 COMPONENT: SUROFOR VARIABLES: XQAUSER Type: Input XQAUSER is the internal entry number in file 200 (DUZ) for the user for which the surrogate should act in receiving alerts. Type: XQALIST Type: Both XQALIST is a variable which is passed by reference which will contain the list of users for whom the specified user is currently acting as a surrogate. The date in the list includes the internal entry number (DUZ) for the user, the user's name, and the start and end dates for the surrogate period. The SUROFOR entry point returns a list of users for which the specified user is currently acting as a surogate for. Usage would be: S XQAUSER=DUZ ; user identification D SUROFOR^XQALSURO(XQAUSER,.USERLIST) This returns USERLIST=count USERLIST(1)=IEN2^NEWPERSON,USER2^STARTDATETIME^ENDDATETIME USERLIST(2)=3^NAME,USER3^3050407.1227^3050406 ******************** 3214 NAME: GMRYAPI CUSTODIAL PACKAGE: GEN. MED. REC. - I/O SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: OCT 16,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine provides entry points to return GEN. MED. REC. - I/O (aka Intake and Output) data to the calling application. ROUTINE: GMRYAPI COMPONENT: INPUT() VARIABLES: This function returns the number of entries in the GMRY INPUT TYPE file (#126.56). There are no input or output variables for this function. COMPONENT: OUTPUT() VARIABLES: This function returns the number of entries in the GMRY OUTPUT TYPE file (#126.58). There are no input or output variables for this function. ******************** 3215 NAME: DDR DELETE ENTRY CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3216 NAME: DDR FILER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3217 NAME: DDR FIND1 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3218 NAME: DDR FINDER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3220 NAME: DDR GET DD HELP CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3221 NAME: DDR LISTER CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3222 NAME: DDR LOCK/UNLOCK NODE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3223 NAME: DDR VALIDATOR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3224 NAME: DDR KEY VALIDATOR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: OCT 3,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC entry may be referenced from the Option file to support invoking the RPC from its corresponding FM Delphi Component. The RPC must not be invoked directly. ROUTINE: ******************** 3225 NAME: Service Catagory Calculation API CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 5,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CPRS requests an integration agreement to call the SVC^PXKCO routine. This routine calculates the appropriate service category for an encounter, and is needed to correct problems with some encounters generated in CPRS. ROUTINE: PXKCO COMPONENT: SVC VARIABLES: SVC Type: Input Initial Service Category DSS Type: Input Stop Code PXKIO Type: Input Set to 1 if Patient is an inpatient, 0 otherwise. LOC Type: Input Hospital Location $$SVC Type: Output Returns the corrected Service Category value. ******************** 3227 NAME: NURAPI CUSTODIAL PACKAGE: NURSING SERVICE SUBSCRIBING PACKAGE: GEN. MED. REC. - VITALS USAGE: Private ENTERED: OCT 17,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This routine provides entry points to return Nursing package data to the calling package. ROUTINE: NURAPI COMPONENT: ACTLOCS(.ARRAY) VARIABLES: ARRAY Type: Both Input - (Required) The name of the array to store the entries. Output - ArrayName(sequential #)=File 211.4 ien^File 44 name (for 211.4 ien). If no active locations returns: ArrayName(1)="NO UNIT". Returns all active nursing locations from the NURS LOCATION file (#211.4) in the array specified. FILE 211.4 points to HOSPITAL LOCATION file (#44). COMPONENT: PTCHK(LOC) VARIABLES: LOC Type: Input (Required) NURS LOCATION file (#211.4) ien. This function indicates if any patients (active or inactive) are associated with the Nursing location identified. Returns: 0 - no patients associated with this location 1 - yes, patients are associated with this location -1 - (minus 1) LOC is undefined or not found COMPONENT: APTCHK(LOC) VARIABLES: LOC Type: Input (Required) NURS LOCATION file (#211.4) ien. This function indicates if active patients are associated with the Nursing location identified. Returns: 0 - no active patients associated with this location 1 - yes, active patients are associated with this location -1 - (minus 1) LOC is undefined or not found COMPONENT: PTLIST(LOC,.ARRAY) VARIABLES: LOC Type: Input (Required) NURS LOCATION file (#211.4) ien. ARRAY Type: Both Input - (Required) Name of array to return entries in Output - Subscripted by sequential number with DFN in first piece and patient name in second piece. Example: ArrayName(sequential #)=DFN^patient name If LOC is undefined or not found, then returns ARRAY(1)=-1. If no patients on the Location, then returns ARRAY(1)="^No Patients". Returns a list of all (active and inactive) patients for a nursing location in the array specified. COMPONENT: APTLIST(LOC,.ARRAY) VARIABLES: LOC Type: Input (Required) NURS LOCATION file (#211.4) ien. ARRAY Type: Both Input - (Required) Name of the array to return entries in Output - Subscripted by sequential number with DFN in first piece and patient name in second piece. Example: ArrayName(sequential #)=DFN^patient name If LOC is undefined or not found, then returns ARRAY(1)=-1. If no patients on the Location, then returns ARRAY(1)="^No Patients". Returns a list of active patients for a nursing location in the array specified. COMPONENT: FINDNLOC(LOC) VARIABLES: LOC Type: Input (Required) Name of the Nursing location (as it appears in File 44). The name should begin with the characters 'NUR '. If not, NUR will be appended to the beginning of LOC. This function returns the NURS LOCATION file (#211.4) ien and the ien of the location (File 44, Field .01). If LOC is undefined, then returns -1. If no such location returns: "^Location not found". Returns: File 211.4 ien^File 44 ien COMPONENT: MASWARDS(LOC,.ARRAY) VARIABLES: LOC Type: Input (Required) NURS LOCATION file (#211.4) ien. ARRAY Type: Both Input - (Required) Name of array to return entries in. Output - ARRAY subscripted by the MAS WARD value. Example: ArrayName($P(^NURSF(211.4,LOC,3,D1,0),U,1))= "" If LOC is null or not found, then ARRAY(1)=-1. Returns the MAS wards associated with this Nursing location in the array specified. The .01 field of the MAS WARD multiple of the NURS LOCATION file points to the WARD LOCATION file (#42). ******************** 3228 NAME: VIEW MERGE IMAGES FOR FEE BASIS CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: FEE BASIS USAGE: Private ENTERED: OCT 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 15.4 ROOT: XDRM( DESCRIPTION: TYPE: File This integration agreement permits the patch FB*3.5*19 post install to examine data in the MERGE IMAGES (#15.4) file. This data will be used to identify and correct problems in the Fee Basis software that may have occurred when patients were merged before installation of patch FB*3.5*19. In addition to reading data in the global, the post install will loop (using $Order) through the following parts of the XDRM global to locate the Fee Basis data. XDRM(D0) loop thru all patient pairs in MERGED IMAGES file XDRM(D0,1,"B", loop thru FROM FILE# "B" x-ref to locate Fee files XDRM(D0,1,D1,1,D2) loop thru GLOBAL DATA for a specific FROM FILE XDRM(D0,2,"B", loop thru TO FILE# "B" x-ref to locate Fee files XDRM(D0,2,D1,1,D2) loop thru GLOBAL DATA for a specific TO FILE XDRM(D0,3,"B", loop thru POINTERS CHANGED "B" x-ref to find Fee files Data in the MERGE IMAGES fill will not be modified under this integration agreement. ^XDRM(D0,0) .01 MERGED FROM 0;1 Direct Global Read & w This field contains a variable pointer reference to the location in the primary merge file of the entry which was merged into another entry. .02 MERGED TO 0;2 Direct Global Read & w This field contains a variable pointer reference to the entry in the primary file for the merge, into which the entry indicated by the MERGED FROM (#.01) field was merged. ^XDRM(D0,1,D1,0) .01 FROM FILE# 0;1 Direct Global Read & w This field specifies a file for which a data image was recorded for the entry specified by the MERGED FROM (#.01) field in the parent file (MERGE IMAGES, 15.4). ^XDRM(D0,1,D1,1,D2,0) .01 GLOBAL NODE 0;1 Direct Global Read & w This is the global node for which the data is given. ^XDRM(D0,1,D1,1,D2,1) 1.01 DATA VALUE 1;E1,245 Direct Global Read & w This is the value associated with the current global node. ^XDRM(D0,2,D1,0) .01 TO FILE# 0;1 Direct Global Read & w This field specifies a file for which a data image was recorded for the entry specified by the MERGED TO (#.02 ) field in the parent file (MERGE IMAGES, 15.4). ^XDRM(D0,2,D1,1,D2,0) .01 GLOBAL NODE 0;1 Direct Global Read & w This is the global node for which the data is given. ^XDRM(D0,2,D1,1,D2,1) 1.01 DATA VALUE 1;E1,245 Direct Global Read & w This is the value associated with the current global node. ^XDRM(D0,3,D1,0) .01 POINTERS CHANGED 0;1 Direct Global Read & w This field contains data on a location where a pointer value was changed. The #.01 field contains the information which would be specified as subscripts in the array passed in a call to FILE^DIE. The array subscripts are separated by a ';', and are in the form FILE;IENS;FIELD. ^XDRM(D0,3,D1,1) 1.01 ORIGINAL VALUE 1;1 Direct Global Read & w This is the pointer value before it was changed. ROUTINE: ******************** 3230 NAME: DBIA 3230 Imaging Device file entry CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: IMAGING Will be used to created Device and Terminal type entries used by VistA Imaging for displaying DHCP reports on the VistA Imaging GUI application. USAGE: Private ENTERED: OCT 24,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This request is to allow the VistA Imaging package to add a HFS device to the DEVICE file and a Terminal Type entry; this is done during the installation of the Imaging application. The entry for the Device file will be named IMAGING WORKSTATION and the Terminal Type file entry will be named P-IMAGING. This device is used by the GUI portions of VistA Imaging to generate DHCP reports into a global array format. The following is the code used to create this device: EN ;Create an entry in the Device file for an Imaging workstation. ; TERM N A,DA,DD,DO,DIC,DIE,ENTRY,X,Y W !,"I will setup the 'P-IMAGING' entry in the Terminal Type file." I $D(^%ZIS(2,"B","P-IMAGING")) D G DEV . W !,"An entry already exists for 'P-IMAGING' in the Terminal Type file ." ;Set the entry S DIC="^%ZIS(2," S X="P-IMAGING",DIC(0)="O" K DD,D0 D FILE^DICN S ENTRY=+Y G:'ENTRY ERRDEV S DR=".02///0;1///80;2///"_"#"_";4///"_"$C(8)"_";7///"_"D CLOSE^MAGGTU5; 3///64" S DA=ENTRY,DIE="^%ZIS(2," D ^DIE ;.02/SELECTABLE AT SIGNON;1/RIGHT MARGIN;2/FORM FEED;4/BACK SPACE ;7/CLOSE EXECUTE;3/PAGE LENGTH DEV N A,DA,DD,DO,DIC,DIE,ENTRY,X,Y,MAGOS W !,"I will setup an 'Imaging Workstation' entry in the Device file." I $D(^%ZIS(1,"B","IMAGING WORKSTATION")) D Q . W !,"An entry already exists for 'IMAGING WORKSTATION' in the Device f ile." S DIC="^%ZIS(1," S X="IMAGING WORKSTATION",DIC(0)="O" K DD,D0 D FILE^DICN S ENTRY=+Y G:'ENTRY ERRDEV I ^%ZOSF("OS")["DSM" D . S MAGOS="DSM" . S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT" . S DR=DR_";4///0;5///0;19///"_"(NEWVERSION,DELETE)"_";2///"_"HFS" . S DIE="^%ZIS(1," I ^%ZOSF("OS")["OpenM" D . S MAGOS="OPENM" . S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT" . S DR=DR_";4///0;5///0;19///"_"""NWS"""_";2///"_"HFS" . S DIE="^%ZIS(1," I ^%ZOSF("OS")["MSM" D . S MAGOS="MSM" . S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT" . S DR=DR_";4///0;5///0;19///"_"(""WS.DAT"":""M"")"_";2///"_"HFS" . S DIE="^%ZIS(1," I $D(MAGOS) D ^DIE ;.02/LOCATION OF TERMINAL;3/SUBTYPE;1/$I;4=ASK DEVICE;5/ASK PARAMETERS ;19/OPEN PARAMETERS;2/TYPE Q ERRDEV ; W !,"Could not setup the IMAGING WORKSTATION entry in the Device file." W !,"Could not setup the P-IMAGING entry in the Terminal Type file." MSG W !,"Please review the Installation Manual to create this entry." Q ROUTINE: ******************** 3231 NAME: LOCAL TIMEZONE CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: IMAGING We wish to use this cross-reference to provide accurate timing of local events to remote customer support. USAGE: Private ENTERED: OCT 27,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.3 ROOT: XMB(1, DESCRIPTION: TYPE: File The Vista Imaging application supports site reporting on a monthly basis and the reporting of critical events that require customer support intervention. Tracking these events remotely is easier if the "TIMEZONE" associated with these events is included in the message. We seek direct read access to the ^XMB("TIMEZONE") for this purpose. ^XMB('TIMEZONE') 1 TIME ZONE 0;2 Direct Global Read & w The three character code represents the time zone and daylight savings where appropriate of the VHA facility supportin the VISTA HIS. This is the field 1 cross-ferefence. ROUTINE: ******************** 3233 NAME: DBIA3233 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VISTA INTEGRATION ADAPTOR Access to DOSE^PSSORUTL for VIABDPS2 OISLCT RPC and OrderMgmtSvc - getMedOrderableItemDefaults method USAGE: Controlled Subscri ENTERED: OCT 27,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine With the implementation of the Pharmacy Ordering Enhancements project, Dosages will now be stored in the DRUG file (#50), in the form of Possible Dosages and Local Possible Dosages. When a medication (Orderable Item) is selected in CPRS (Computerized Patient Record System) in the medication order entry process, that Orderable Item will be passed to the Pharmacy Data Management package, along with the Pharmacy application and patient internal entry number. The Pharmacy Data Management package will pass back to CPRS Dosage information from the Drugs in the DRUG file (#50) that are matched to that Orderable Item. ROUTINE: PSSORUTL COMPONENT: DOSE(PSSX,PD,TYPE,PSSDFN) VARIABLES: PSSX Type: Input This is simply the name of the array to be built that will return the information to CPRS. PD Type: Input This is the internal entry number from the PHARMACY ORDERABLE ITEM file (#50.7) of the selected Orderable Item in the CPRS medication order entry process. TYPE Type: Input This variable will indicate the Pharmacy package of the order. It will be "O" for Outpatient, "U" for Unit Dose, or "I" for "IV". PSSDFN Type: Input This variable is optional. It is the internal entry number from the PATIENT file (#2). It will only be used for Outpatient package orders, to calculate the maximum number of refills allowed. PSSX(#) Type: Output This is the array returned in the call, subscripted with whatever variable name is passed into the call. This output array will increment for as many unique Drug dosages that are found. This output array is divided into 6 pieces, separated by the "^" character. The pieces are: Piece 1 = Possible Dosage. This piece is a numeric value, and will only have data if it is a Possible Dosage that is being returned. This is calculated by multiplying the Strength by the Dispense Units per Dose. Piece 2 = Unit. This is the Unit of measure for the product. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 3 = Dispense Units per Dose. Similar to piece 1, this is a numeric value, and will only be returned if a Possible Dosage is being returned. This value multiplied by the Strength will be the Possible Dosage. Piece 4 = Noun. This is the Noun that is associated with the Dosage. For example, a Dosage Form of TAB would likely have a Noun of TABLET(S). Piece 5 = Instructions. This can be used for the dosage selection. For a Possible Dosage, it is the numeric dosage concatenated with the Unit. Some examples would be 325 MG, 650 MG, and 10 MG/15 ML. For a Local Possible Dosage, it would be a text dosage. Some examples would be 1 DROP, 2 DROPS, and 1 TEAPSOONFUL. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 6 = Dispense Drug. This is internal entry number from the DRUG file (#50). Piece 7 = Price. If the Drug has a Price Per Dispense Unit associated with it, this will be that price times the Dispense Units per Dose. If the Dosage does not have a Dispense Units per Dose, and does not have a Price Per Dispense Unit, this will be null. PSSX('DD', Type: Output This array contains specific Drug information of the Drug that is associated with the Dosage. For every drug entry (piece 6 of the PSSX(#) array), there will be a corresponding entry in this PSSX("DD", Dispense Drug IEN) array. The pieces of this array are separated by the "^" character, and they are as follows: Piece 1 = Name. This is the name of the Drug, the .01 field of the DRUG file (#50). Piece 2 = Price Per Dispense Unit. This is the price per dispense unit for this drug. Piece 3 = Local Non-formulary flag. If the drug is designated as non-formulary, then a 1 will be returned in this piece, otherwise, a null will be returned. Piece 4 = Dispense Unit. This is the Dispense Unit for the drug. Piece 5 = Strength. This is a value that represents the single dose of medication supplied by this product. This field could be null for some drugs, such as multi-ingredient drugs. Piece 6 = Unit. This is the unit of measure of this product. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 7 = Dosage Form. This is the name of the Dosage Form of the product. Piece 8 = Maximum # of refills. This will only be returned for Outpatient medication orders. It can be used as a default for the maximum number of refills allowed for the medication order. Piece 9 = Schedule requirement flag. This is always set to 1. This piece is not currently used. Piece 10 = DEA Special Handling Flag. This field can have 1 of 3 values: 1 = The DEA Special Handling field contains a "1", or contains a "2". This indicates that a wet signature is required. 2 = The DEA Special Handling field does not meet wet signature requirements, but does indicate a Controlled Substance. This is the case if the field contains a "3", or a "4", or a "5". 0 = All others. Piece 11 = Flag for splitting Dosage Form. This will be a 0 or a 1. The only time it will be a 1 is if there are Possible Dosages associated with the drug, and there is at least 1 Possible Dosage that is entered for the drug with a decimal point. This indicates that the Dosage Form can be split. PSSX('MISC Type: Output This array contains information relating to the Dosage Form that is associated with the selected Orderable Item. It contains 3 pieces, separated by the "^" character. The pieces are: Piece 1 = Verb. This is the verb associated with the Dosage Form. Examples would be INSTILL for the Dosage Form of SOLN,OTIC, and TAKE for the Dosage Form of TAB. Piece 2 = Preposition. This is the preposition associated with the Dosage Form. Examples would be BY for the Dosage Form of TAB, and TO for the Dosage Form of CREAM. Piece 3 = Conjunction. This is the conjunction associated with the Dosage Form. Most Dosage Forms would have a conjunction of OF. PSSX(#,#) Type: Output This array contains the same information as the PSSX(#) array. This array is only returned when Possible Dosages are being returned, and there are duplicate Possible Dosages with different Dispense Units per Dose. The PSSX(#) array would contain the Possible Dosage with the lowest Dispense Units per Dose, and the PSSX(#,#) arrays would contain all other Possible Dosages with higher Dispense Units per Dose. PSSX('PI', Type: Output This array holds the default Patient Instructions from the Pharmacy Orderable Item (#50.7) file. PSSX('DEA' Type: Output This output variable indicates the DEA Special Handling code at the Pharmacy Orderable Item level, based on dispense drugs matched to the Item. This variable can be one of four values, a "1", a "2", a "0", or null. If a "1" is returned, that indicates that there is at least one active dispense drug matched to that Pharmacy Orderable Item for the specified package, that has a DEA Special Handling Code that contains a "1", or contains a "2". This means that a wet signature is required. If a "2" is returned, that indicates that the first condition wasn't met, and that there is at least one active dispense drug matched to that Pharmacy Orderable Item for the specified package, that has a DEA Special Handling Code that contains a "3", or contains a "4", or contains a "5". This means a wet signature is not required, but it does indicate a Controlled Substance. A "0" is returned if neither of the first two conditions are met, but there are active drugs matched to the Pharmacy orderable Item for the specified package. If there are no active drugs for the specified package matched to the Pharmacy Orderable Item, then a null is returned. This entry point will be used by CPRS to retrieve all of the available Dosages in the DRUG file (#50) for the selected Orderable Item. Additionally, other information will be returned from the DRUG file (#50) and the DOSAGE FORM file (#50.606) that will be used by CPRS in the medication order entry process. ******************** 3234 NAME: DBIA3234 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: OCT 30,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine With the implementation of the Pharmacy Ordering Enhancements project, Dosages will now be stored in the DRUG file (#50), in the form of Possible Dosages and Local Possible Dosages. When a Dispense Drug is selected during the medication order entry process in the Outpatient Pharmacy and Inpatient Medications applications, that drug will be passed to the Pharmacy Data Management application, along with the Pharmacy application and Patient. Pharmacy Data Management will pass back the available Dosages from the DRUG file (#50) and other related information. ROUTINE: PSSORPH COMPONENT: DOSE(PSSX,PD,TYPE,PSSDFN,PSSDUPD) VARIABLES: PSSX Type: Input This is simply the name of the array to be built that will return the information to the Pharmacy applications. PD Type: Input This is the internal entry number from the DRUG file (#50). TYPE Type: Input This variable will indicate the pharmacy application of the order. It will be "O" for Outpatient, "U" for Unit Dose, and "I" for IV. PSSDFN Type: Input This variable is optional. It is the internal entry number from the PATIENT file (#2). It will only be used for Outpatient orders, to calculate the maximum number of refills allowed. PSSUPD Type: Input This variable is optional. If this variable is passed in, it represents a Dispense Units per Dose value that was entered during the medication order entry process in the pharmacy application. A new Dosage will be calculated for this Dispense Units per Dose, and returned in the array. PSSX(#) Type: Output This is the array returned in the call, subscripted with whatever variable name is passed into the call. This output array will increment for as many unique Drug dosages that are found. This output array is divided into 12 pieces, separated by the "^" character. The pieces are: Piece 1 = Possible Dosage. This piece is a numeric value, and will only have data if it is a Possible Dosage that is being returned. This is calculated by multiplying the Strength by the Dispense Units per Dose. Piece 2 = Unit. This is the Unit of measure for the product. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 3 = Dispense Units per Dose, or Local Possible Dosage. If there is data in piece 1 of this array, indicating that this is a Possible Dosage, then piece 3 will be the Dispense Units per Dose for the Possible Dosage. If piece 1 is null, then piece 3 is the Local Possible Dosage. Piece 4 = Dispense Drug. This is the internal entry number from the DRUG file (#50). Piece 5 = Strength. This is a value that represents the single dose of medication supplied by this product. This field could be null for some drugs, such as multi-ingredient drugs. Piece 6 = Noun. This is the Noun that is associated with the Dosage. For example, a Dosage Form of TAB would likely have a Noun of TABLET(S). Piece 7 = Dosage Form. This is the name of the Dosage Form of the product. Piece 8 = Verb. This is the verb associated with the Dosage Form. Examples would be INSTILL for the Dosage Form of SOLN,OTIC, and TAKE for the Dosage Form of TAB. Piece 9 = Preposition. This is the preposition associated with the Dosage Form. Examples would be BY for the Dosage Form of TAB, and TO for the Dosage Form of CREAM. Piece 10 = Conjunction. This is the conjunction associated with the Dosage Form. Most Dosage Forms would have a conjunction of OF. This is only returned when Local Possible Dosages are being returned. Piece 11 = Dosage Display. This is only returned for Possible Dosages. It is a combination of Strength and Unit, which makes for a readable selection display. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 12 = BCMA Units Per Dose. This will only be returned for Inpatient Orders. PSSX('DD', Type: Output This array contains specific Drug information of the Drug that is associated with the Dosage. For every drug entry (piece 3 of the PSSX(#) array), there will be a corresponding entry in this PSSX("DD", Dispense Drug IEN) array. The pieces of this array are separated by the "^" character, and they are as follows: Piece 1 = Name. This is the name of the Drug, the .01 field of the DRUG file (#50). Piece 2 = Price Per Dispense Unit. This is the price per dispense unit for this drug. Piece 3 = Local Non-formulary flag. If the drug is designated as non-formulary, then a 1 will be returned in this piece, otherwise, a null will be returned. Piece 4 = Dispense Unit. This is the Dispense Unit for the drug. Piece 5 = Strength. This is a value that represents the single dose of medication supplied by this product. This field could be null for some drugs, such as multi-ingredient drugs. Piece 6 = Unit. This is the unit of measure of this product. This value is formatted via the API $$DOSE^PSSORUTE(DOSE) (see IA# 4555) in order to add leading zeros to decimal numbers and a blank space between number and unit. Piece 7 = Maximum # of refills. This will only be returned for Outpatient medication orders. It can be used as a default for the maximum number of refills allowed for the medication order. Piece 8 = This piece is not being used. Piece 9 = Noun. This is the Noun that is associated with the Dosage. For example, a Dosage Form of TAB would likely have a Noun of TABLET(S). Piece 10 = Verb. This is the verb associated with the Dosage Form. Examples would be INSTILL for the Dosage Form of SOLN,OTIC, and TAKE for the Dosage Form of TAB. Piece 11 = Dosage flag. 1 means that a numeric free text entry in the dosage field can be interpreted as a Possible Dosage, with an associated numeric Dispense Units per Dose. 0 means that a numeric free text entry in the dosage field cannot be interpreted as a Possible Dosage, and must be interpreted as a Local Possible Dosage. Type: This entry point will be used by the Outpatient Pharmacy and the Inpatient Medications applications. Returned in this call will be all of the available Dosages for that drug. Additionally, other information will be returned from the DRUG file (#50) and the DOSAGE FORM file (#50.606) that will be used in the medication order entry process in the Pharmacy applications. ******************** 3236 NAME: MSG GMPLX CUSTODIAL PACKAGE: PROBLEM LIST SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: OCT 30,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry point into the routine GMPLX which is MSG when called as a function, Will return a line of text "+ Next Screen - Prev Screen ?? More actions" ROUTINE: GMPLX COMPONENT: MSG VARIABLES: Will return one line of Help text as described above. ******************** 3237 NAME: DBIA3237 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR Access will be used by VIABDPS2 OISLCT RPC for VIA's OrderMgmtSvc - getMedOrderableItemDefaults USAGE: Private ENTERED: OCT 30,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call, provided by Outpatient Pharmacy, will return a default Quantity value or a default Days Supply to CPRS for the Outpatient medication order entry process through CPRS. A value will only be returned if a value can appropriately be determined, based on data passed into the call. If a Quantity value is not received in this call, then a default Quantity value will be calculated. If a Quantity value is received in this call, then a default Days Supply value will be calculated. ROUTINE: PSOSIG COMPONENT: QTYX(PSOQX) VARIABLES: PSOQX('DOS Type: Input This array holds the number of Dispense Units per Dose for each dosing sequence entered during the medication order entry process in CPRS. PSOQX('DUR Type: Input This array holds the durations for each dosing sequence entered during the medication order entry process in CPRS. It is in the form of: S for # of seconds. M for # of minutes. H for # of hours. D for # of days. W for # of weeks. L for # of months. If only a numeric is passed in, then Days will be assumed. PSOQX('SCH Type: Input This array holds the schedules associated with each dosing sequence entered during the medication order entry process in CPRS. PSOQX('DAY Type: Output If the PSOQX("QTY") variable is defined when the call is made, then the PSOQX("DAYS SUPPLY") variable will be used to calculate a default Quantity value. If the PSOQX("QTY") variable is not defined when the call is made, then the PSOQX("DAYS SUPPLY") variable will be the output variable that contains the default Days Supply value, if a value is able to be determined. PSOQX('QTY Type: Output If this variable is defined when the call is made, then it will be used to calculate a default Days Supply value. If this variable is not defined when the call is made, this will be the output variable that contains the default Quantity value, if a value is able to be determined. PSOQX('PAT Type: Input This variable will only be used when calculating a default Days Supply. It is equal to the internal entry number of the patient from the PATIENT file (#2). PSOQX('DRU Type: Input This variable will only be used when calculating a default Days Supply. It is equal to the internal entry number of the drug from the DRUG file (#50). PSOQX('CON Type: Input This array holds the conjunctions for each dosing sequence, 'A' for And, 'T' for Then. This entry point will be used by CPRS to determine if a default Quantity value or a default Days Supply value can be assigned to an Outpatient order that is being entered through CPRS. ******************** 3238 NAME: Activate Vista Imaging Health Summary Component CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: IMAGING This completes the functionality which enables the Vista Imaging Health Summary Component at the site when the component exists. USAGE: Private ENTERED: OCT 30,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142.1 ROOT: GMT(142.1, DESCRIPTION: TYPE: File The following code is designed to conditionly enable the Imaging Health Summary Component upon package install. ; Enable the Imaging Health Summary component I $D(^GMT(142.1,235)) D . S (DIE,DIC)=142.1,DA=235 . S DR="5///@;8///@" . D ^DIE The request is for direct read and a fileman edit. This code is processed during the Imaging post init. ^GMT(142.1,235) 5 DISABLE FLAG 0;6 Write w/Fileman This field controls the availability of this GMTS component. 8 OUT OF ORDER MESSAGE 0;8 Write w/Fileman This is the message displayed to the user if this out of order component is selected. ROUTINE: ******************** 3239 NAME: DBIA3239 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: OCT 31,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This agreement allows Computerized Patient Record System (CPRS) to pass into Pharmacy Data Management a Pharmacy Orderable Item, and the Pharmacy application for which a medication order is being entered in CPRS. In return, Pharmacy Data Management will return an array of active Dispense Drugs for that Pharmacy application that are tied to the Pharmacy Orderable Item. This call will be used by CPRS so order checks can be performed on all Dispense Drugs tied to an Orderable Item, when a Dispense Drug cannot be associated with a medication order in CPRS. ROUTINE: PSSUTIL1 COMPONENT: DRG(PSSDD,PSSOI,PSSPK) VARIABLES: PSSDD Type: Input This is simply the subscripted array name. PSSOI Type: Input This variable is the internal entry number from the PHARMACY ORDERABLE ITEM file (#50.7). PSSPK Type: Input This variable indicates which package the medication order is intended. 'O' for Outpatient, 'I' for Inpatient. PSSDD(#;#) Type: Output This array contains all of the active Dispense Drugs that are matched to the Orderable Item, for that particular package. The first number subscript of the array is the internal entry number from the DRUG file (#50). The second number subscript of the array (following the semicolon), is the pointer to the VA GENERIC file (#50.6) entry that the Dispense Drug is matched to. Each entry will be equal to the drug name. This entry point will return all active Dispense Drugs tied to a Pharmacy Orderable Item for a specific Pharmacy application. COMPONENT: ITEM(PSSIT,PSSDR) VARIABLES: PSSIT Type: Input This represents the internal entry number for the Pharmacy Orderable Item, file #50.7. PSSDR Type: Input This represents the internal entry number for the Dispense Drug, file #50. $$ITEM Type: Output This is the output variable, in the following format: 0 means the Dispense Drug is matched to the same Pharmacy Orderable Item. 1^# means the Dispense Drug is matched to a new Pharmacy Orderable Item, and piece 2 is the internal entry number for that item. -1 means invalid data has been passed to the call. This entry point accepts the Pharmacy Orderable Item and Dispense Drug for a pharmacy order. The call determines whether or not the Dispense Drug is still matched to the same Pharmacy Orderable Item, or if the Dispense Drug has been rematched, and if so, will return the new Pharmacy Orderable Item. COMPONENT: EN1(PSSOA,PSSOAP) VARIABLES: PSSOA Type: Input This variable is passed by reference. The input variable is equal to the internal entry number of the Pharmacy Orderable Item. PSSOAP Type: Input This variable is passed by value. It is either "O" for Outpatient, or "I" for Inpatient. PSSOA Type: Output This is the array of Pharmacy Orderable Items that are found as formulary alternatives, in the form of PSSOA(#)="", where # is the internal entry number from the Pharmacy Orderable Item file. This entry point accepts a Pharmacy Orderable Item, and a package application identifier. Based on the package, this call looks at the formulary alternatives for all Dispense Drugs matched to the Pharmacy Orderable Item, and finds all the Pharmacy Orderable Items that those drugs are matched to. If an Orderable Item has at least one active Dispense Drug matched to it for that package, that Orderable Item is returned in the call. The purpose of this call is to provide Orderable Item formulary alternatives to CPRS, if a non-formulary Orderable Item is selected in the medication order process in CPRS. COMPONENT: SCH(SCH) VARIABLES: SCH Type: Input This is the condensed Schedule of the Outpatient order, passed by reference. Since it is passed by reference, it is returned as the output variable, as in an expanded form if an expansion if found, or as it was passed in. This entry point returns an expanded Schedule for an Outpatient order entered through CPRS. COMPONENT: MAXDS(INPUT) VARIABLES: INPUT('PSO Type: Input Pointer to the PHARMACY ORDERABLE ITEM file (#50.7). This parameter is required. INPUT('DRU Type: Input Pointer to the DRUG file (#50). This parameter is optional. If not passed, the API will return the highest value from all the dispense drugs linked to the Pharmacy Orderable Item. $$MAXDS Type: Output Maximum number of days supply that can be dispensed for the orderable item and/or dispense drug. This API accepts an array containing the Pharmacy Orderable Item (required) and Dispense Drug (optional) and returns the maximum number of Days Supply allowed to be dispensed for the specific medication. ******************** 3240 NAME: Mailgroup Updates CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: IMAGING 1) for Mail group lookup: S MAGA="MAG SERVER" ; Mail group name S MAGDATA=$$FIND1^DIC(3.8,"","MX",MAGA,"","","ERR") Then: . ;Add G.MAG SERVER @ development site as remote recipient . S MAGM="G.IMAGING DEVELOPMENT TEAM@FORUM.VA.GOV" . I $$FIND1^DIC(3.812,","_MAGDATA_",","MX",MAGM,"","","ERR") D . . S MAGE(3.812,"+1,"_MAGDATA_",",.01)=MAGM . . D UPDATE^DIE("E","MAGE") . ;Remove development domain mailgroup reference . S MAGX=$E("G.MAG SERVER@LAVC.ISC-WASH.VA.GOV",1,30) . S IEN=$$FIND1^DIC(3.812,","_MAGDATA_",","MX",MAGX,"","","E RR") . I +IEN>0 D . . K MAGE . . S MAGE(3.812,IEN_","_MAGDATA_",",.01)="@" . . D UPDATE^DIE("E","MAGE") 2) D GETS^DIQ(3.8,IEN_",","2*;11*;12*","","ARRAY") USAGE: Private ENTERED: NOV 1,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.812 ROOT: XMB(3.8, DESCRIPTION: TYPE: File In order to meet the FDA requirements to track the usage of the medical device known as "Vista Imaging" (the IMAGING package) VA maintains a Vista mailman mail server. The server processes monthly site usage parameters and critical event driven alerts. The 2 issues: 1) We create and populate a local mail group, "MAG SERVER", into which we add the local installer and our own, "G.IMAGING DEVELOPMENT TEAM@FORUM.VA.GOV", remote member. We also, as cleanup, remove a formerly installed remote member which failed often as a result of mail scripts not always having our development domain in place, "G.MAG SERVER@LAVC.ISC-WASH.VA.GOV". 2) Also, for clarity and because remotes may not have access to the resolved DUZ of local recipient's we place the entire recipient list in the text of the message so when coordinating efforts to resolve critical events, the contacts are most assuredly identified. ^XMB(3.8,D0,1, .01 MEMBER 0;1 Both R/W w/Fileman ^XMB(3.8,D0,6, .01 REMOTE MEMBER 0;.01 Both R/W w/Fileman ^XMB(3.8,D0,5, .01 MEMBER GROUP NAME 0;.01 Both R/W w/Fileman ROUTINE: ******************** 3242 NAME: DIRECT READ OF XMB(3.9 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: NATIONAL DRUG FILE USAGE: Private ENTERED: NOV 2,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.9 ROOT: XMB(3.9 DESCRIPTION: TYPE: File NDF requests a one time agreement with MailMan to do direct global reads to XMB(3.9,DA(1),2,DA Patch PSN*4*41 identified several entries in file 50 as being improperly matched to NDF. Many of these entries were incorrectly so identified. The patch generated a message to users listing the items. Sites have requested a supplemental list showing not only the name of the item, but also the IEN, inactivation date, and whether the item is an investigational drug. The data in file 50 which was used to identify these items was deleted by patch PSN*4*41. The only way to generate these new lists is to read the original message and use the B cross reference in file 50 to get the requested information. LIST^DIC will be used to identify and retrieve the messages. ^XMB(3.9,D0,2,D1,0, 3 TEXT 2;0 Direct Global Read & w ROUTINE: ******************** 3243 NAME: Active Flag CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 2,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API returns a flag indicating the status of the Orderable Item, Dispense Drug, Additive and/or Solution within the order. A call to $$ACTIVE^PSJORREN(DFN,ON) returns one of the following data: 1 - The drug(s) within the order is active 2^New Orderable Item - A new Orderable Item is found for Unit Dose order 0^Inactive reason - This order has no active drugs ROUTINE: PSJORREN COMPONENT: $$ACTIVE VARIABLES: DFN Type: Input Patient Internal Entry Number ON Type: Input ON_"U/V" where ON is the order number and "U" is for a Unit dose or "V" for IV order. $$ACTIVE Type: Output Returns 1,2,0 for Unit Dose and 1,0 for IV orders: 1 - The drug(s) within the order is active 2^New Orderable Item - A new Orderable Item is found for Unit Dose order 0^Inactive reason - This order has no active drugs A call to $$ACTIVE^PSJORREN(DFN,ON) returns one of the following data: 1 - The drug(s) within the order is active 2^New Orderable Item - A new Orderable Item is found for Unit Dose order 0^Inactive reason - This order has no active drugs ******************** 3244 NAME: Invalid MPI/PD exception messages sent to FORUM CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX E CLAIMS MGMT ENGINE CLINICAL PROCEDURES added 3/22/10 USAGE: Controlled Subscri ENTERED: NOV 6,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 773 ROOT: HLMA(D0, DESCRIPTION: TYPE: File Exception messsages are being sent to the MPI/PD team under the wrong circumstances. Non-MPI/PD applications trigger exception messages under inappropriate conditions because of issues in the execution of the VistA Health Level Seven (HL7) software. This IA will eliminate the possibility of non-MPI/PD applications generating exception messages. ^HLMA('C', 2 MESSAGE ID Direct Global Read & w MESSAGE ID x-ref ^HLMA(D0, 13 SENDING APPLICATION 0;11 Read w/Fileman Indicates the application sending the message. 14 RECEIVING APPLICATIO 0;12 Read w/Fileman Indicates the application receiving this message. ^HLMA(D0,'MSH',D1, 200 MSH 0;1 Read w/Fileman This field, a word processing data type, is used to store the "MSH" segment when the TCP/IP Lower Layer Protocol is used. The data for this field, MSH, is located on the "MSH" data node. ROUTINE: ******************** 3245 NAME: TIU GET ASSOCIATED IMAGES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure Call (RPC) allows the calling application to access a list of Images that have been captured and maintained by VistA Imaging, and have been asscociated with a given Document in TIU. NAME: TIU GET ASSOCIATED IMAGES TAG: GETILST ROUTINE: TIUSRVPL RETURN VALUE TYPE: ARRAY AVAILABILITY: SUBSCRIPTION DESCRIPTION: Given a Document, get the list of associated images. INPUT PARAMETER: TIUDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). RETURN PARAMETER DESCRIPTION: This is the list of Images associated with the Document identified by TIUDA. For example: TIUY(1)=21734 TIUY(2)=21799 TIUY(3)=21803 Where the rvalue of each list element is the record number (IEN) of each image in the IMAGE FILE (#2005). Given a Document, get the list of associated images. ROUTINE: GETILST TIUSRVPL ******************** 3246 NAME: TIU GET DOCUMENTS FOR IMAGE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure Call (RPC) allows the calling application to access a list of Documents that have been captured and maintained by TIU, and have been asscociated with a given Image in VistA Imaging. NAME: TIU GET DOCUMENTS FOR IMAGE TAG: GETDLST ROUTINE: TIUSRVPL RETURN VALUE TYPE: ARRAY AVAILABILITY: SUBSCRIPTION DESCRIPTION: Given an image, get the list of associated documents. INPUT PARAMETER: IMGDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: This is the record number (IEN) of the image in the IMAGE FILE (#2005). RETURN PARAMETER DESCRIPTION: This is the list of Documents associated with the Image identified by IMGDA. For example: TIUY(1)=721734 TIUY(2)=721799 TIUY(3)=721803 Where the rvalue of each list element is the record number (IEN) of image in the TIU DOCUMENT FILE (#8925). Given an image, get the list of associated documents. ROUTINE: GETDLST TIUSRVPL ******************** 3247 NAME: TIU LINK DOCUMENT TO IMAGE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote procedure call will allow the calling application to link a specific Document in the TIU Document File (#8925) with a specific Image in the Image File (#2005). The call will support a many-to-many cardinality between Documents and Images. NAME: TIU LINK DOCUMENT TO IMAGE TAG: PUTIMAGE ROUTINE: TIUSRVPL RETURN VALUE TYPE: SINGLE VALUE AVAILABILITY: SUBSCRIPTION DESCRIPTION: This RPC links a document with an image. It will support a many-to-many association between documents and images. INPUT PARAMETER: TIUDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). INPUT PARAMETER: IMGDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 2 DESCRIPTION: This is the record number (IEN) of the document in the IMAGE FILE (#2005). RETURN PARAMETER DESCRIPTION: The return variable is a scalar result. If a link is successfully created, it will be the record number of the link in the TIU EXTERNAL LINKAGE FILE (#8925.91). If a link cannot be made (e.g., the document and image are already linked), the return variable will be a two '^'-piece result, with zero in the first '^'-piece, and an explanatory message in the second (e.g., 0^ Document already linked to this image). This RPC links a document with an image. It will support a many-to-many association between documents and images. ROUTINE: PUTIMAGE TIUSRVPL ******************** 3248 NAME: TIU REMOVE LINK TO IMAGE CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: NOV 13,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote procedure call will allow the calling application to REMOVE the link between a specific Document in the TIU Document File (#8925) and a specific Image in the Image File (#2005). NAME: TIU REMOVE LINK TO IMAGE TAG: DELIMAGE ROUTINE: TIUSRVPL RETURN VALUE TYPE: SINGLE VALUE AVAILABILITY: SUBSCRIPTION DESCRIPTION: This RPC will remove a link between a document and an image. Only valid links may be removed. INPUT PARAMETER: TIUDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). INPUT PARAMETER: IMGDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 2 DESCRIPTION: This is the record number (IEN) of the document in the IMAGE FILE (#2005). RETURN PARAMETER DESCRIPTION: This is a BOOLEAN result. If the call is made with record numbers for which a valid link exists, it will remove the link, and the return value will be 1 (TRUE), otherwise, the return value will have two '^'-pieces (i.e., zero and an explanatory message (e.g., 0^ Document and Image not currently linked)). This RPC will remove a link between a document and an image. Only valid links may be removed. ROUTINE: DELIMAGE TIUSRVPL ******************** 3249 NAME: Imaging Medicine Procedure field CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING DICOM images received on Imaging gateway contain a psuedo transaction number consisting of the medicine file and internal entry number (example: GM-200 would be Generalized Procedure/Consult Medicine file (#699.5) and entry 200). This information is lookup in the Medicine file(s) to get the patient name and procedure/sub specialty name using FILEMAN Database API. To obtain the PROCEDURE/SUBSPECIALTY field number in any Medicine file sent in the psuedo transaction number a call is made to $$PRCFLD^MCUIMAGO. The results are saved in a variable and passed to a FM database call, GETS^DIQ(MEDFILE,MEDIEN,MEDFLDS,"IE","MAGARR","MAGERR") to lookup the entry (MEDIEN) in the medicine file. USAGE: Private ENTERED: NOV 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Vista Imaging is requesting permission to use API $$PRCFLD^MCUIMAG0. This is needed needed to lookup the Procedure/Subspecialty pointer field during an image capture via the DICOM Image gateway. The gateway receive images directly from Image Acquisition devices (IFA, Olympus, etc.) and each device sends a pseudo transaction number consisting of the Medicine file and internal entry number for the images to be attached to. This call is required to get the procedure field name/number to do a Fileman lookup on the entry sent. ROUTINE: MCUIMAG0 COMPONENT: PRCFLD VARIABLES: MEDFILE Type: Input Contains a Medicine file number to be used to lookup the PROCEDURE/SUBSPECIALITY field number. The field# in one of the Medicine Procedure data files that points to the Procedure/Subspecialty file (#690). ******************** 3250 NAME: Imaging 3250 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING On an Imaging workstation, a user can select for a specified patient a list of Medicine file entries. Once a selected entry is selected a psuedo transaction number is displayed. The psuedo transaction number consists of the Medicine file and internal entry number selected. Calling $$VALID^MCUIMAGO will verify the entry selected. USAGE: Private ENTERED: NOV 14,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Vista Imaging is requesting permission to call $$VALID^MCUIMAG0 to validate an entry in a Medicine file. This is used on an Imaging workstation to obtain a psuedo transaction number to be used to capture DICOM images directly from image acquisition devices (IFA, Olympus, etc.). ROUTINE: MCUIMAG0 COMPONENT: VALID VARIABLES: FILE Type: Input Medicine file number IEN Type: Input Medicine internal entry number to be validated. DFN Type: Input Patient's DFN PRC Type: Input Pointer to the Procedure/Subspecialty file (#697.2) Module validate an entry in the Medicine file. ******************** 3252 NAME: CALL TO GMRCASV1 CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING REGISTRATION FEE BASIS CLAIMS SYSTEM USAGE: Controlled Subscri ENTERED: NOV 15,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA will allow an application to call GUI^GMRCASV1. When this routine is called with the appropriate variables it will pass back the selected consult services, synonyms, indicate if it is a parent or the IEN of the parent, and if there are children (sub services). ROUTINE: GMRCASV1 COMPONENT: GUI(GMRCARR,GMRCSTRT,GMRCWHY,GMRCSYSN) VARIABLES: GMRCARR Type: Both Passed in as the array to return results in. Service - IEN^SVC NAME^PARENT^HAS CHILDREN^SVC USAGE PARENT = "0" if it is the parent record or the IEN of the parent record. HAS CHILDREN = "+" if the service has children (sub-services). SVC USAGE contains "S" if the array item is a synonym of a service entry. GMRCSTRT Type: Input Service to begin building output array from. GMRCWHY Type: Input If value is passed in as "0", all services (Service, Grouper, Tracking Only, Disabled) will be displayed. If value is passed in as "1", only services that are orderable or used for forwarding will be displayed. GMRCSYN Type: Input If value is set to "0", synonyms will not be returned and if value is set to "1", synonyms will be returned. ******************** 3259 NAME: CHECK FOR ADFN X-REF IN 991.1 CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: NOV 16,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 991.1 ROOT: RGHL7(991.1, DESCRIPTION: TYPE: File In order to keep the number of repeating Local ICNs being sent to the MPI for resolution when their is still an exception outstanding, the Local/Missing ICN Resolution job will no longer send up patients that have a Potential Match Exception. The only way that a potential match patient can get an ICN assignment would be via the Single Patient Initialization Option, so there is no need to send them up during the background job. Having said that, MPIF would like to be able to check for the Potential match exception by check for: $D(^RGHL7(991.1,"ADFN",218,)) Where DFN is the IEN of the patient in the Patient File. ^RGHL7(991.1,'ADFN',218 checking for the existance of ^RGHL7(991.1,"ADFN",218,). Where 218 is the Exception number for Potential Matches and DFN is the ien of the patient in the Patient file (#2). ROUTINE: COMPONENT: RGHL7(991.1 VARIABLES: Checking for the existance of $D(^RGHL7(991.1,"ADFN",218,)) Where DFN is the IEN of the patient in the Patient File. ******************** 3260 NAME: Imaging 3260 - Lab Referral file. CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: IMAGING During image capture for Laboratory, the end user inputs the Laboratory Accession area, the year and the accession number. This is used to lookup the patient name and ssn. DSS - DECISION SUPPORT SYSTEM EX TEXT INTEGRATION UTILITIES Added 7/31/20, effective with TIU*1*290 (CPRS31B) to access the .01 field. USAGE: Controlled Subscri ENTERED: NOV 17,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 67 ROOT: LRT(67 DESCRIPTION: TYPE: File Images captured for Laboratory are associated to the Lab accession number which identifies the entry in appropriate sub-file in Laboratory. It is possible to have an accession number associated to the REFERRAL FILE and not the patient file. For this precaution, Imaging is requesting FM read access to this file. ^0 .01 NAME 0;1 Read w/Fileman Patient's name .09 IDENTIFIER 0;9 Read w/Fileman ROUTINE: ******************** 3261 NAME: BLOOD BANK AND DIRECT ACCESS TO DD GLOBAL CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: LAB SERVICE The blood bank software is discriminated as the LRBL namespace contained in the LR namespace or the LAB SERVICES package version 5.2 USAGE: Private ENTERED: NOV 24,2000 STATUS: Active EXPIRES: DURATION: Next Version VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File The Blood Bank module of the LAB SERVICES package has been granted permission by the custodial package (VA FileMan) to access the DD global as detailed in this DBIA. ^DD(65,.01,0) Code in routines ^LRBLJCK and ^LRBLJD1 perform Xecution of the input transform stored at this node in piece 5 to 99 of the data value. This input transform is defined for the UNIT ID field (#.01) of the BLOOD INVENTORY file (#65). Routine ^LRBLPED performs a Write of the field name stored at this node in piece 1. This field name is defined for the UNIT ID field (#.01) of the BLOOD INVENTORY file (#65). ^DD(65,.01,3) Code in routines LRBLJCK and LRBLJD1 perform a conditional Write of help prompt message stored at this node. This help prompt message is defined for the UNIT ID field (.01) of the BLOOD INVENTORY file (#65). ^DD(65,.01,4) Code in routines LRBLJCK and LRBLJD1 perform conditional execution of the executable help stored at this node. This executable help is defined for the UNIT ID field (#.01) of the BLOOD INVENTORY file (#65). ^DD(65,.03,0) Code in routine ^LRBLJCK performs 1) the Write of the field name stored at piece 1 of this node, and 2) performs the Xecution of the input transform stored at piece 5 to 99 of this node. The field name and input transform is defined for the INVOICE# field (#.03) of the BLOOD INVENTORY file (#65). ^DD(65,.03,3) Code in routine ^LRBLJCK performs a conditional write of the help prompt message stored at this node. This help prompt message is defined for the INVOICE# field (#.03) of the BLOOD INVENTORY file (#65). ^DD(65,.03,4) Code in routine LRBLJCK performs a conditional execution of the executable help stored at this node. The executable help is defined for the INVOICE# field (#.03) of the BLOOD INVENTORY file (#65). ^DD(65,4.1,0) Code in routine ^LRBLJD performs variable assignment equal to the data type stored at piece 3 at this node. This data type is defined for the DISPOSITION field (#4.1) of the BLOOD INVENTORY file (#65). ^DD(65,4.1,1) Code in routine ^LRBLJD and ^LRBLJD1 perform conditional Xecution of the Mumps X-references stored at the following nodes: ^DD(65,4.1,1,1,1) = node 1 of "AC" x-ref ^DD(65,4.1,1,2,1) = node 1 of "APS" x-ref ^DD(65,4.1,1,1,2) = node 2 of "AC" x-ref ^DD(65,4.1,1,2,2) = node 2 of "APS" x-ref ^DD(65,4.1,1,3,2) = node 2 of "AG" x-ref These Mumps x-references is defined for the DISPOSITION field (#4.1) of the BLOOD INVENTORY file (#65). ^DD(65,4.2,1,1,1) Code in routine ^LRBLJD1 performs conditional execution of the Regular x-reference stored at this node. This "AC" Regular x-ref is defined for DISPOSITION DATE filed (#4.2) of the BLOOD INVENTORY file (#65). ^DD(69.2,.07,3) Code in routine ^LRBLJLA performs a conditional Write of the help prompt message stored at this node. This help prompt message is defined for the LINES IN A LABLE field (#.07) of the LAB SECTION PRINT file (#69.2). ^DD(69.2,.07,4) Code in routine ^LRBLJLA performs conditional Xecution of the executable help stored at this node. This executable help is defined for the LINES IN A LABEL field (#.07) of the LAB SECTION PRINT file (#69.2). ^DD(69.2,.07,0) Code in routine ^LRBLJLA performs Xecution of the input transform stored at piece 5 to 99 of this node. This input transform is defined for LINES IN A LABEL field (#.07) of the LAB SECTION PRINT file (#69.2). ^DD(66,.23,0) Code in routine ^LRBLPED performs a Write of the field name stored at this node in piece 1 of the data string. This field name is for the SPECIFIC GRAVITY field (#.23) of the BLOOD PRODUCT file (#66). ^DD(66,.22,0) Code in routine ^LRBLPED performs a Write of the field name stored at this node in piece 1. This field name is for the PEDIATRIC PRODUCT field (#.22) of the BLOOD PRODUCT file (#66). ^DD(65,8.1,0) Code in routine ^LRBLQST performs variable assignment equal to the data type stored at piece 3 at this node. This data type is defined for the POS/INCOMPLETE SCREENING TESTS (#8.1) of the BLOOD INVENTORY file (#65). ^DD(65,8.3,0) Code in routine ^LRBLQST performs variable assignment equal to the data type stored at piece 3 at this node. This data type is defined for the DONATION TYPE (#8.3) for the BLOOD INVENTORY file (#65). ROUTINE: ******************** 3264 NAME: PROCESSING RTN FIELDS CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: LAB SERVICE USAGE: Private ENTERED: NOV 29,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 101 ROOT: ORD(101, DESCRIPTION: TYPE: File One time IA for the pre-init for patches LA*5.2*58 and LR*5.2*266: The letter "Q" will need to be entered in the Processing RTN field (#771) and the Response Processing RTN field (#772) of the Protocol file (#101) for the LA7D CARELIFE RESULTS and the LA7D CARELIFE SERVER entries. Leaving this field blank will, in some instances, cause an error. FileMan utilities will be used to set these fields. ^ORD(101,D0, 771 GENERATE/PROCESS ROU 771;E1,2 Both R/W w/Fileman This field is executed on the receiving system. It defines the routine used to process the original inbound message in a transaction and to GENERATE and APPLICATION response/ACK back to the sending system using the entry point, GENACK^HLMA1. ^ORD(101,D0, 772 GENERATE/PROCESS ACK 772;E1,2 Both R/W w/Fileman This field is executed on the sending system when an Acknowledgement or Query response is received. The message ID of the original message is always contained within the response. This is used to identify the location of the original message and the corresponding event point protocol. Note that this pertains to Original and Enhanced Mode Application Acks only. The HL7 package generates and processes Enhanced mode Commit Accepts internally. ROUTINE: ******************** 3266 NAME: OBTAIN PATIENT DOB FROM DPTLK1 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: IMAGING Imaging is using the DOB^DPTLK1 api to obtain a patient's date of birth. INPATIENT MEDICATIONS GEN. MED. REC. - VITALS CLINICAL PROCEDURES VISUAL IMPAIRMENT SERVICE TEAM ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT BAR CODE MED ADMIN MENTAL HEALTH JSHARVEY 20061128/ ADDED MH AS SUBSCRIBER AS PER FAIN. AUTOMATED MED INFO EXCHANGE added 5/26/09 EMERGENCY DEPARTMENT ADDDED 4/3/08 VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: DEC 5,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The patient lookup routine, DPTLK1, has a useful api for obtaining a formated date of birth. Imaging is requesting permission to use this api. ROUTINE: DPTLK1 COMPONENT: $$DOB(DFN,DGYR) VARIABLES: DFN Type: Input Patient's DFN. DGYR Type: Input If input value is: 0 - returns 4-digit year (default) 1 - returns 2-digit year 2 - returns filemanager date output DOB = mm/dd/yyyy (default) = mm/dd/yy, if DGYR=1 = yyymmdd, if DGYR=2 Calling routine passes the Patient's DFN and obtains the corresponding date of birth for that patient. If the patient's primary eligibility is 'Employee' then "SENSISTIVE" is passed in place of the date of birth. ******************** 3267 NAME: OBTAIN PATIENT SSN FROM DPTLK1 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: IMAGING Imaging is using the api to get the patient's social security number. This routine is part of the patient sensitive issue and does not display a ssn for an employee. VISUAL IMPAIRMENT SERVICE TEAM CLINICAL PROCEDURES GEN. MED. REC. - VITALS ORDER ENTRY/RESULTS REPORTING CARE MANAGEMENT BAR CODE MED ADMIN MENTAL HEALTH JSHARVEY 20061128/ ADDED MH AS SUBSCRIBER AS PER FAIN AUTOMATED MED INFO EXCHANGE ADDED 5/26/09 EMERGENCY DEPARTMENT ADDED 4/3/08 VA POINT OF SERVICE (KIOSKS) CONSULT/REQUEST TRACKING 7/23/14-API will be used as part of an HL7 interface between Consults/Request Tracking and the Healthcare Claims Processing System. USAGE: Controlled Subscri ENTERED: DEC 5,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The patient lookup routine, DPTLK1, has a useful api for obtaining the patient's social security number. Imaging is requesting permission to use this api. ROUTINE: DPTLK1 COMPONENT: SSN VARIABLES: DFN Type: Input Patient's dfn On a given patient will display the patient's ssn identifier; except for employees. ******************** 3268 NAME: Read file 8925 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING Imaging displays the document type, patient name, and document date/time. Fields .01, .02 and 1201 are read using fileman. DENTAL MENTAL HEALTH MH ADDED 2.15.2011 USAGE: Controlled Subscri ENTERED: DEC 7,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925, DESCRIPTION: TYPE: File Imaging is requesting read permission to file 8925 to obtain the document type, patient name, and document entry date/time. ^TIU(8925, .01 DOCUMENT TYPE 0;1 Read w/Fileman This field points to file 8925.1 (TIU DOCUMENT DEFINITION). .02 PATIENT 0;2 Read w/Fileman This field points to file 9000001 (PATIENT/IHS). 1201 ENTRY DATE/TIME 12;1 Read w/Fileman .03 VISIT 0;3 Read w/Fileman .05 STATUS 0;5 Read w/Fileman 1405 REQUESTING PACKAGE R 14;5 Read w/Fileman This field allows a linkage to be maintained between the TIU Document and the VistA package for which it was generated. ROUTINE: ******************** 3269 NAME: Imaging - Rad variable set CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging only store the Radiology report pointer associated with the image and the api RA07PC3 requires the patieint ien, inverse date/time and case ien to create the report array. Passing the report ien in varialbe 'Y' to RASET^RAUTL2 will created the variables needed for the RA07PC3 api. USAGE: Controlled Subscri ENTERED: DEC 8,2000 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Imaging is requesting permission to call RASET^RAUTL2 to set radiology variables needed to call RAO7PC3. Imaging stores only the Radiology Report pointer and not all the information needed by api RAO70C3. ROUTINE: RAUTL2 COMPONENT: RASET VARIABLES: Y Type: Input Radiology report (IEN) RACN Type: Output Case number RADATE Type: Output External date/time RADFN Type: Output Patient ien RADTE Type: Output FM date/time RADTI Type: Output inverse date/time RACNI Type: Output Case ien Y Type: Output String ^RADPT(RADFN,"DT",RADTI,"P",RANCI,0) This module requires the variable 'Y' set to the Radiology Report (file #74) ien. Variables created are: RACN, RACNI, RADATE,RADFN, RADTE, RADTI, and Y. ******************** 3270 NAME: DBIA 3270 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging is requesting permission to call EN1^RAUTL20 and EN2^RAUTL20 to assist an end-user in deciphering if the case selected is part of a print set. The case selected may be part of a print set and the image is attached to the primary case number of the print set. USAGE: Controlled Subscri ENTERED: DEC 18,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Imaging request permission to subscribe to routine RAUTL20, sub-modules EN1 and EN2, that have useful information for print sets. These modules will pass variables that assist in determining if a case is part of a print set. ROUTINE: RAUTL20 COMPONENT: EN1 VARIABLES: RADFN Type: Input Patient's dfn. RADTI Type: Input The internal entry number (inverse date) for the Exam Date in the Registered Exams subfile (70.02). ex: ^RADPT(RADFN,"DT",RADTI RACNI Type: Input The internal entry number for the multiple in the Examination Subfile (70.03). ex: ^RADPT(RADFN,"DT",RADTI,"P",RACNI RAPRTSET Type: Output An indicator if the case is part of a combined PRINTset; if so RARPTSET=1. RAMEMLOW Type: Output An indicator that indicates if the case is the lowest ien of the print set; if so RAMEMLOW=1. Routine for displaying '+' and '.' during a case lookup. Receives variables, RADPT, RADTI and RACNI, outputs variables RAPRTSET and RAMEMLOW. COMPONENT: EN2 VARIABLES: RA4 Type: Both Incoming an array of case numbers and outgoing an array of case number ien(s) with the following results. RA4(ienof #70.03)=case number^procedure pointers^ptr #74 RADFN Type: Input Patient's dfn RADTI Type: Input Exam date ien RACNI Type: Input Case number ien RAPRTSET Type: Output Routine for determining if a case number is part of a print set and returns all entries within the printset. ******************** 3272 NAME: DBIA3272 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: DEC 20,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 200 ROOT: VA(200, DESCRIPTION: TYPE: File The Integrated Billing package requests a DBA exemption to allow the .01 field of the IB BILLING PROVIDER ID file (355.9) to point to the NEW PERSON file (200). This field is actually a variable pointer field and the NEW PERSON file would be one of the files included in that variable pointer file set. This will allow IB to access VA provider data without duplicate entry for determining the correct provider id to use for claims. ROUTINE: ******************** 3273 NAME: DBIA3273 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX CLINICAL PROCEDURES USAGE: Controlled Subscri ENTERED: DEC 20,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 773 ROOT: HLMA(D0, DESCRIPTION: TYPE: File This is a request for the MPI/PD package to have Fileman Read access to several fields for the purpose of improving the information provided in the exception messages,generated while processing HL7 messages, that are sent to the MPI/PD team via Mailman. The exception message currently includes the message id of the message where the exception was encountered. We would like to add to the exception message some information about the HL7 message,including the Logical Link, Message Type,and Event Type. For that purpose we request Fileman read access to the following fields: HL7 Message Administration file (#773): Logical Link (#7) Message Type (#15) Event Type (#16) ^HLMA( 7 LOGICAL LINK 0;7 Direct Global Read & w 15 MESSAGE TYPE 0;13 Read w/Fileman 16 EVENT TYPE 0;14 Read w/Fileman 8 SUBSCRIBER PROTOCOL 0;8 Direct Global Read & w 20 STATUS P;1 Direct Global Read & w 100 DATE/TIME PROCESSED S;1 Direct Global Read & w .01 DATE/TIME ENTERED 0;1 Read w/Fileman 13 SENDING APPLICATION 0;11 Read w/Fileman The "B" x-ref may also be directly read. ^HLMA('AC', Read access to the "AC" x-ref. ROUTINE: ******************** 3277 NAME: XUSRB CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 29,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA records supported API's in the XUSRB routine. This routine is used by Broker for GUI sign-on. ROUTINE: XUSRB COMPONENT: OWNSKEY VARIABLES: RET Type: Output A subscripted array with a value of 1 or 0 to indicated if user holds the security key. LIST Type: Input A single value or a subscripted array of security keys to be evaluated. DUZ Type: Used DUZ variable should be defined before calling to this api. IEN Type: Input Optional. The DUZ of a user that you want to check if they hold keys. This api is used by the "XUS KEY CHECK" rpc. This api OWNSKEY^XUSRB can be used to verify if a user has a specified security key assigned. The calling routine will send one or a reference to a subscripted array and the api will return a subscripted array with a value of 1 (user owns key) or 0 (key not found). COMPONENT: $$INHIBIT VARIABLES: Is API is used to check if LOGON's have been inhibited. There are no inputs. ******************** 3278 NAME: DBIA3278 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VISTA INTEGRATION ADAPTOR Access will be used by VIA for: VIABDPS2 OISLCT RPC for OrderMgmtSvc - getMedOrderableItemDefaults VIAB DFLTSPLY RPC for OrderMgmtSvc - getDaysMedicationSupply USAGE: Private ENTERED: DEC 29,2000 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These calls, provided by Outpatient Pharmacy, will return default values to Computerized Patient Record System (CPRS) for Days Supply and Maximum Number of Refills for the medication order entry process. ROUTINE: PSOSIGDS COMPONENT: DSUP(PSOQX) VARIABLES: PSOQX('PAT Type: Input This is equal to the internal entry number of the patient from the PATIENT file (#2). PSOQX('DRU Type: Input This is equal to the internal entry number of the drug from the DRUG file (#50). PSOQX('DAY Type: Output This is the default Days Supply value. This entry point will be used to return a default Days Supply value to CPRS, based on the patient and the drug selected in the medication order entry process. COMPONENT: MAX(PSOQX) VARIABLES: PSOQX('PAT Type: Input This is equal to the internal entry number of the patient from the PATIENT file (#2). PSOQX('DRU Type: Input This is equal to the internal entry number of the drug from the DRUG file (#50). PSOQX('DAY Type: Input This is equal to the Days Supply of the medication order. PSOQX('MAX Type: Output This is the default Maximum Refills value. PSOQX('DIS Type: Input This variable will be set to 1 if this order is an Outpatient order that is being entered for an Inpatient, or if these are Inpatient orders being transferred to Outpatient for discharge. This entry point will be used to return a default Maximum Refills value to CPRS, based on the Patient, Drug, and Days Supply selected in the medication order entry process. ******************** 3279 NAME: MCARUTL2 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 2,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine These APIs allow the Imaging package access to the Medicine package data. The APIs will do lookups on the MEDICAL PATIENT File (#690) and the PROCEDURE/SUBSPECIALTY file (#697.2) and return data from the associated Medicine files. ROUTINE: MCARUTL2 COMPONENT: SUB VARIABLES: .ARRAY Type: Both (Required) .ARRAY = The return array where the data will be placed. Recommend the array should be namespaced. Return Array: ARRAY can be any variable array that the developer chooses. Recommend the array be namespaced. The API returns all of the procedures found for the patient in the variable array specified. When the API returns the data it will be placed into the variable array specified. ARRAY(0) = Piece1_^_Piece2 Piece1 1 Indicates that the component returned data. 0 Indicates that the component failed. Piece2 is an informational message either indicating how many entries were found for the patient or and error message stating why the component failed. X = Is a sequential number from 1 to the total number of procedures found as indicated by ARRAY. ARRAY(X) = Piece1_^_Piece2_^_Piece3 _^_Piece4_^_Piece5 _^_Piece6_^ Piece1 is the date and time of the procedure in an External format. Piece2 is procedure name within PROCEDURE/SUBSPECIALTY file (#697.2). Piece3 is Patient name. Piece4 is MCAR concatenated with "(" and the file number where the procedure can be found within the Medicine package. Piece5 is the Internal Entry Number of the procedure within the file as indicated in Piece 4 Piece6 indicates that the system found associated images. 1 indicates that there are images for this procedure 0 indicates no images where found. Y = Is a sequential number from 1 to the last IMAGE that is associated with this procedure. ARRAY(X,2005,Y) = Is the IEN of the image within the IMAGE file (#2005). DFN Type: Input (Required) The Internal Entry Number of the Patient with in MEDICAL PATIENT file (#690). SUB Type: Input (Required) Either the Internal Entry Number within the PROCEDURE/SUBSPECIALTY file (#697.2) or the Free Text Name of the entry in PROCEDURE/SUBSPECIALTY file (#697.2). FROM Type: Input (Optional) The start date for the procedure in File Manager format. TO Type: Input (Optional) The end date for the procedure in File Manager format. For a Patient in the MEDICAL PATIENT file (#690) and Procedure in the PROCEDURE/SUBSPECIALTY file (#697.2), this component will return all of the requested procedures performed on that patient. Coding example of Query call: Case 1 K VAR S DFN=33,SUB=75 S FROM=2990101,TO=3001231 D SUB^MCARUTL2(.VAR,DFN,SUB,FROM,TO) or Case 2 K VAR S DFN=33,SUB="GENERIC SUBSPECIALTY" D SUB^MCARUTL2(.VAR,DFN,SUB) Example of Return Array: Case 1 Where there was a FROM and TO date for the patient. Case 2 Would pickup all data for the patient. In both cases the data would be returned in the following format. VAR=3 VAR(0)=1^3 GENERIC SUBSPECIALTY Procedures found for Patient ROBERTSON,JOHN VAR(1)=Nov 24, 2000@13:09^GENERIC SUBSPECIALTY^ROBERTSON,JOHN^MCAR(699.5^30^1^ VAR(1,2005,1)=16 VAR(2)=Nov 24, 2000@15:13^GENERIC SUBSPECIALTY^ROBERTSON,JOHN^ MCAR(699.5^32^0^ VAR(3)=Nov 24, 2000@15:23^GENERIC SUBSPECIALTY^ROBERTSON,JOHN^MCAR(699.5^ 33^0^ COMPONENT: PATLK VARIABLES: IEN Type: Output Internal Entry Number on the Medical Patient File (#690). This API is for selecting valid Medicine patients. The calling code would make an extrinsic function call to this entry point and the user would be prompted for a patient. After a patient has been selected the API will pass back the Medical Patient File (#690) internal entry number for that patient. It will return a -1 if a patient is not selected. Coding example of Query call: S X=$$PATLK^MCARUTL2 User interface: Select MEDICAL PATIENT NAME: LANDO,JOSEPH LANDO,JOSEPH 1-5-57 3456711 66 YES ACTIVE DUTY Enrollment Priority: GROUP 1 Category: IN PROCESS End Date: COMPONENT: PATSUB VARIABLES: .ARRAY Type: Both (Required) The total number of procedures found for this patient. .ARRAY = Recommend the return array should be namespaced. Return Values: ARRAY can be any variable array that the developer chooses. When the API returns the data it will be placed into the variable array specified. ARRAY(0) = Piece1_^_Piece2 Piece1 1 Indicates that the component returned data. 0 Indicates that the component failed. Piece2 is an informational message either indicating how many entries were found for the patient or an error message stating why the component failed. X = Is a sequential number from 1 to the total number of procedures found as indicated by ARRAY. ARRAY(X) = Piece1_^_Piece2_^_Piece3 Piece1 is procedure name within PROCEDURE/SUBSPECIALTY file (#697.2). Piece2 is Internal Entry Number within PROCEDURE/ SUBSPECIALTY file (#697.2). Piece3 Total number of entries for that patient for that subspecialty. DFN Type: Input (Required) The Internal Entry Number of the Patient with in MEDICAL PATIENT file (#690). This API will return all of the sub-specialties for a given patient with in the Medicine package. Coding example of Query call: KILL VAR D PATSUB^MCARUTL2(.VAR,DFN) Example of Return Array: VAR=8 VAR(0)=1^There were 8 procedures found for patient ROBERTSON,JOHN VAR(1)=ECG^2^2 VAR(2)=EP^4^1 VAR(3)=COL^8^1 VAR(4)=BMA^12^1 VAR(5)=BMB^13^1 VAR(6)=CONSULT^15^2 VAR(7)=PFT^23^10 VAR(8)=HEM^58^1 ******************** 3280 NAME: MCARUTL3 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 2,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API allows the Imaging package access to the Medicine package data. The API will do a lookup on the MEDICAL PATIENT File (#690) and the PROCEDURE/SUBSPECIALTY file (#697.2) for the indicated entry and return the associated Medicine package data. ROUTINE: MCARUTL3 COMPONENT: MEDLKUP VARIABLES: .ARRAY Type: Both (Required) .ARRAY = The return array where the data will be placed. Recommend the array should be namespaced. Return Values: ARRAY can be any variable array that the developer chooses. When the API returns the data it will be placed into the variable array specified. ARRAY = Piece1_^_Piece2_^_Piece3_^_ Piece4_^_Piece5_^_ Piece6_^_ Piece7_^_Piece8_^_Piece9_^_ Piece10_^_Piece11 Piece1 1 Indicates that the component returned data. 0 Indicates that the component failed. If the component fails Piece 2 will contain text indicating why the component failed. Piece2 The file number within the Medicine package. Piece3 The Internal Entry Number of the entry within the file indicated by Piece2. Piece4 The Internal Entry Number of the patient within the Medical Patient File (690). Piece5 The External format of the patient name. Piece6 The Procedure date and time in File Manager format. Piece7 The Procedure date and time in External format. Piece8 Pointer to the Procedure/ Subspecialty file (697.2) Piece9 The Name of the Procedure indicated in Piece8. Piece10 The internal entry number of the last image entry within the 2005 multiple in the indicated procedure. For example, ^MCAR(FN,IEN,2005,X,0) where X is the last entry. X is what is returned as Piece 10. Piece11 The internal entry number of the entry within the IMAGE file (#2005) indicated by Piece 10. FN Type: Input (Required) The File number within the Medicine package. IEN Type: Input (Required) The Internal Entry Number of the entry within the indicated file as specified by FN. This component will return all information on the indicated procedure and last associated image if any. Coding example of Query call: K IMAGE S FN=699.5,IEN=33 D MEDLKUP^MCARUTL3(.IMAGE,FN,IEN) Example of Return Array: IMAGE=1^699.5^30^33^ROBERTSON,JOHN^3001124.1309^ Nov 24, 2000@13:09^75^GENERIC SUBSPECIALTY^1^10 ******************** 3281 NAME: Kernel Installation & Distribution System build status. CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE Radiology/Nuclear Medicine will determine the status of a build by reading, with FileMan, the STATUS (#.02) field of the INSTALL (#9.7) file. CLINICAL INFO RESOURCE NETWORK Clinical Info Resource Network will determine the status of a build by reading, with FileMan, the STATUS (#.02) field of the INSTALL (#9.7) file. VA CERTIFIED COMPONENTS - DSSI Using FIND^DIC, pass in "B" index into the index parameter. Use screen: I $P(^(0),U,9)=3 [STATUS field #.02] PHARMACY BENEFITS MANAGEMENT USAGE: Controlled Subscri ENTERED: JAN 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9.7 ROOT: XPD(9.7 DESCRIPTION: TYPE: File The status of a Kernel Installation & Distribution System (KIDS) build needs to be determined so a single distribution build Alpha, can queue build Beta, another single distribution. Before build Alpha queues build Beta, build Beta must be loaded from a distribution. ^XPD(9.7,D0, .02 STATUS 0;9 Read w/Fileman This is the status of this package at this facility. Possible statuses as of Jan 01, 2001: ================================== === 0 = Loaded from Distribution 1 = Queued for Install 2 = Start of Install 3 = Install Completed 4 = De-Installed .01 NAME 0;1 Read w/Fileman 17 INSTALL COMPLET TIME 1;3 Read w/Fileman ROUTINE: ******************** 3282 NAME: GMT(142 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: IMAGING Imaging displays Health Summary reports by executing the following routines: SELTYP1^GMTS and EN^GMTS1. These routines require variables set to an entry in file 142 and the associated title for the selected entry. All lookups into the file are done with FM22 calls. USAGE: Private ENTERED: JAN 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142 ROOT: GMT(142, DESCRIPTION: TYPE: File Health Summary grants Imaging permission to read the following fields in the HEALTH SUMMARY TYPE FILE (142). Field Node;Piece Field Name ----- ---------- ----------- .01 0;1 NAME .02 T;1 Title ^GMTS(142,D0 .01 NAME 0;1 Read w/Fileman Name of the Health Summary Type. .02 TITLE T;1 Read w/Fileman The title for the Health Summary Type. ROUTINE: ******************** 3283 NAME: DBIA3283 CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JAN 18,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 870 ROOT: HLCS(870 DESCRIPTION: TYPE: File The Registration package requests permission to perform a Read with FileMan of file 870 in order to get the name of links subscribed to by a record. ^HLCS(870 .02 INSTITUTION 0;2 Read w/Fileman ROUTINE: ******************** 3284 NAME: DBIA3284 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION Use the routine as API to get Primary Care Position name and IEN. USAGE: Private ENTERED: APR 21,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: SCAPMCU2 COMPONENT: NMPCTP VARIABLES: DFN Type: Input Patient IEN in the PATIENT File (#2). Name Type: Output Name of Primary Care position. IEN Type: Output IEN of Primary Care position. To get Primary Care Position name and IEN. ******************** 3285 NAME: DBIA3285 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION Reference ^SCTM(404.57) to get Primary Care Pager. USAGE: Private ENTERED: JAN 4,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 404.57 ROOT: SCTM(404.57 DESCRIPTION: TYPE: File ^SCTM(404.57,IEN,0) .11 BEEPER NUMBER 0;11 Read w/Fileman To get the pager of the team position. ROUTINE: ******************** 3286 NAME: DBIA3286 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION Reference field #.02 of file #404.51 to get Primary Care Team phone. USAGE: Private ENTERED: JAN 4,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 404.51 ROOT: SCTM(404.51 DESCRIPTION: TYPE: File ^SCTM(404.51,IEN,0) .02 TEAM PHONE NUMBER 0;2 Read w/Fileman To get the team phone number. ROUTINE: ******************** 3287 NAME: DBIA3287 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION Reference field #320 of file #8989.3 to get the DEFAULT DIRECTORY FOR HFS. USAGE: Private ENTERED: JAN 4,2001 STATUS: Active EXPIRES: AUG 27,2002 DURATION: Till Otherwise Agr VERSION: FILE: 8989.3 ROOT: XTV(8989.3 DESCRIPTION: TYPE: File The IA is requested for a one-time-use for a set of extract routines to read the value of the field. This version of the extract routines will retire after successfully gathered data for qualified patients at the sites. ^XTV(8989.3,D0, 320 DEFAULT DIRECTORY FO DEV;1 Read w/Fileman To get the default directory for HFS. ROUTINE: ******************** 3288 NAME: ORQOR LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of patient orders. ROUTINE: LIST ORQOR1 ******************** 3289 NAME: ORWCS LIST OF CONSULT REPORTS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns a list on consult reports for a specific patient. ROUTINE: LIST ORWCS ******************** 3290 NAME: ORWCS REPORT TEXT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns an array containing a formattied consult report. This array matches exactly the report format on the roll 'n scroll version of CPRS. ROUTINE: RPT ORWCS ******************** 3291 NAME: ORWPT LAST5 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertigan. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover Sheet. VA POINT OF SERVICE (KIOSKS) The ORWPT LAST5 RPC will be triggered by a request sent by the Vecna Kiosk system. Access to this RPC is needed for VPS*1*1. VPS*1*2 will not be using this RPC. VISTA INTEGRATION ADAPTOR SCHEDULING 3/26/15-Scheduling added as a subscriber for PCMM Web. USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of patients matching the string of Last Name Initial_Last 4 SSN (Initial/Last 4 look-up to PATIENT file). ROUTINE: LAST5 ORWPT ******************** 3292 NAME: ORWPT PTINQ CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH 5/10/13-The Mental Health Program Office contracted with Capital Solution Design Corporation to provide the Behavioral Health Lab (BHL) software. BHL is a vendor product that calls this VistA RPC. Capital Solution Design John Boles - 202-642-9280 johnboles@capitalsolutiondesign.com VA BHL Support - 202-670-2847 bhl.support@capitalsolutiondesign.com GEN. MED. REC. - VITALS CARE MANAGEMENT CLINICAL PROCEDURES VISTA INTEGRATION ADAPTOR JOINT LEGACY VIEWER Added as a subscriber for JLV 2.6 release USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns formatted patient inquiry text for display in GUI environment. ROUTINE: PTINQ ORWPT ******************** 3293 NAME: ORWU CLINLOC CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL MENTAL HEALTH CARE MANAGEMENT BAR CODE EXPANSION JSH/10-23-2006 BCE added in agreement between Tony Thompson and Rich Vertig an. As part of the Bar Code Expansion project, Care Fusion's wCareView software will give providers a read-only view of consolidated patient information in a similar fashion as the CPRS Cover 5>Sheet. VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** Effective with HMP*2.0*2 USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a list of clinics from the HOSPITAL LOCATION file (#44). ROUTINE: CLINLOC ORWU ******************** 3294 NAME: ORWMC PATIENT PROCEDURES CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: DENTAL AUTOMATED MED INFO EXCHANGE VISTA INTEGRATION ADAPTOR USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This remote procedure call returns a list of patient procedures for a specific patient. ROUTINE: PROD ORWMC ******************** 3295 NAME: PXRM REMINDER DIALOG (TIU) CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 25,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns reminder dialog for a given dialog ien. ROUTINE: ******************** 3296 NAME: PXRM REMINDER CATEGORY CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: APR 25,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns list of reminders for a reminder category in display order. ROUTINE: ******************** 3297 NAME: DBIA3297 CUSTODIAL PACKAGE: INCOME VERIFICATION MATCH SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: APR 21,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This DBIA is being entered to request access to two IVM APIs by the Registration package. The Registration package is creating a GUI version of the Load/Edit Patient Data option. In this option a financial query will be sent if indicated, just as in the roll and scroll Load/Edit. The APIs called are NEED^IVMCQ and QUERY^IVMCQ1. They mirror the functionality performed by the roll and scroll Load/Edi in REQ^IVMCQ. ROUTINE: DGLEIVM COMPONENT: EN VARIABLES: DFN Type: Input This is the IEN from the Patient file (#2). RESULT Type: Output This array will return RESULT(0)="^1^FINANCIAL QUERY SENT" or S RESULT(0)="^1^A FINANCIAL QUERY IS NOT REQUIRED FOR THIS PATIENT" if successful, and RESULT(0)="^0^UNABLE TO PERFORM FINANCIAL QUERY", S RESULT(0)="^1^A FINANCIAL QUERY IS NOT REQUIRED FOR THIS PATIENT" or S RESULT(0)="^0^Patient Not on File" if not. ******************** 3298 NAME: Reference CMOR Request CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION CLINICAL INFO RESOURCE NETWORK USAGE: Controlled Subscri ENTERED: JAN 11,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 984.9 ROOT: MPIF(984.9 DESCRIPTION: TYPE: File The Registration package is requesting a DBIA with Master Patient Index (MPIF) to read with FileMan the MPIF CMOR REQUEST (#984.9) file as well as a direct global read on the "C" and "AC" cross references. This information is used to display need information need to make decision about changing the CMOR. ^MPIF(984.9,D0,0) .01 REQUEST NUMBER 0;1 Read w/Fileman .03 DATE REQUESTED 0;3 Read w/Fileman .06 STATUS 0;6 Read w/Fileman .07 SITE 0;7 Read w/Fileman .08 TYPE OF MESSAGE 0;8 Read w/Fileman ^MPIF(984.9,D0,1) 1.03 TYPE OF REQUEST 1;3 Read w/Fileman ^MPIF(984.9,'C', .02 PATIENT 'C' x-re Direct Global Read & w To identify all requests for a specific patient we are looping through the 'C' cross reference on the PATIENT (#.02) field. ^MPIF(984.9,'AC', ROUTINE: ******************** 3299 NAME: DBIA3299 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: JAN 12,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The CIRN package is requesting an integration agreement with the registration package to call START^VAFCPDAT. An action has been added to the CIRN Exception Handling [RG CIRN EXCEPTION HANDLING] option. This option allows the user for view Treating Facility and Subscription data associated with the selected patient. ROUTINE: VAFCPDAT COMPONENT: START VARIABLES: DFN Type: Input Internal entry number for patient file. Displays Treating Facility and Subscription data associated with a selected patient. COMPONENT: MAIN VARIABLES: DFN Type: Input Internal entry number for patient file. Does the same thing as START but includes a device call. ******************** 3300 NAME: $$MPIQQ MPIFAPI CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: REGISTRATION This API has been approved for use by the Smart Card portion of the Registration package. No longer used. OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: MAY 21,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Smart Card folks has requested an API to be able to task off the real-time connection to the MPI for an ICN request. This process will be the same as the MPIQ^MPIFAPI(DFN) API, but will task the process off to the background. ROUTINE: MPIFAPI COMPONENT: MPIFQQ VARIABLES: DFN Type: Input DFN is the IEN of the patient in the Patient (#2) file. TASK Type: Output TASK = The task number of the TaskMan job. New API: S TASK=$$MPIQQ^MPIFAPI(DFN) Input: DFN - IEN of the patient in the Patient (#2) file. Returns: Task Number of the tasked job. ******************** 3301 NAME: 3301 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CMOP USAGE: Controlled Subscri ENTERED: JAN 30,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File Consolidated Mail Outpatient (CMOP) is allowed access to field # .6 Test Patient Indicator so that it may screen such patients from having data transmitted to CMOP hosts. ^DPT(DO,0) .6 TEST PATIENT INDICAT 0;21 Read w/Fileman ROUTINE: ******************** 3302 NAME: DBIA3302 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM DBIA subscriber is ENROLLMENT APPLICATION SYSTEM (EAS), Electronic 10-10EZ Processor module. INSURANCE CAPTURE BUFFER ADDED JUNE 2009 USAGE: Controlled Subscri ENTERED: JAN 31,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The ENROLLMENT APPLICATION SYSTEM (EAS) package requests use of the function $$BUFF^IBCNBES1 to add new entries to the INSURANCE BUFFER file (#355.33). Update: IB*2*497 increased the length of the SUBSCRIBER ID field, NAME OF INSURED field, and GROUP NUMBER field to support the EDI New Standards and Operating Rules for VHA providers. This required length increase made it necessary to move the location of these 3 fields to new Data Dictionary nodes. To support this implementation, all subscribers to this ICR will need to make the necessary changes in their applications to reference the new fields and remove the references to the old fields. When all subscribers have implemented the use of the new fields, the old fields will be deleted with IB*2*518. Old and new fields are noted in the field list detail of this ICR. ROUTINE: IBCNBES1 COMPONENT: $$BUFF VARIABLES: IBDATA Type: Input Array to be passed by reference, contains Insurance entries to be added to the INSURANCE BUFFER file (#355.33). Medicare Only Patient Name (DFN) 60.01 IBDATA("M","DFN") pointer to #2 Source of Information .03 IBDATA("M","SOURCE") 1 - Interview Effective Date 60.02 IBDATA("M","PART A") Effective Date 60.02 IBDATA("M","PART B") Medicare HICN 60.04 IBDATA("M","HICN") *Name of Insured 60.07 IBDATA("M","NAME") Note: IB*2*497 - replaced by 91.01 Name of Insured 91.01 IBDATA("M","NAME") Veteran's Insurance Patient Name (DFN) 60.01 IBDATA(x,60.01) pointer to #2 Source of Information .03 IBDATA(x,.03) 1 - Interview Whose Insurance 60.05 IBDATA(x,60.05) 'v' for Veteran Pt. Relationship to 60.06 IBDATA(x,60.06) '01' for Patient Insured Insurance Company Name 20.01 IBDATA(x,20.01) *Name of Insured 60.07 IBDATA(x,60.07) Note: IB*2*497 - replaced by 91.01 Name of Insured 91.01 IBDATA(x,91.01) *Subscriber ID 60.04 IBDATA(x,60.04) Note: IB*2*497 - replaced by 90.03 Subscriber ID 90.03 IBDATA(x,90.03) *Group Number 40.03 IBDATA(x,40.03) Note: IB*2*497 - replaced by 90.02 Group Number 90.02 IBDATA(x,90.02) Spouse's Insurance Patient Name (DFN) 60.01 IBDATA(x,60.01) pointer to #2 Source of Information .03 IBDATA(x,.03) 1 - Interview Whose Insurance 60.05 IBDATA(x,60.05) 's' for Spouse Pt. Relationship to 60.06 IBDATA(x,60.06) '02' for Spouse Insured Insurance Company Name 20.01 IBDATA(x,20.01) *Name of Insured 60.07 IBDATA(x,60.07) Note: IB*2*497 - replaced by 91.01 Name of Insured 91.01 IBDATA(x,91.01) *Subscriber ID 60.04 IBDATA(x,60.04) Note: IB*2*497 - replaced by 90.03 Subscriber ID 90.03 IBDATA(x,90.03) *Group Number 40.03 IBDATA(x,40.03) Note: IB*2*497 - replaced by 90.02 Group Number 90.02 IBDATA(x,90.02) The entries subscripted by X (w/X=1:1) are regular insurance entries. The second level subscript contains the data to be filed in the buffer for a particular insurance policy. This second level subscript is the field number of the data field in the INSURANCE BUFFER file (#355.33). Source of Information (.03) and Patient Name (60.01) are required. IBDATA(x) Type: Output IBDATA(x,"MESSAGE") where X="M",1:1 A message node is added to the input array for each insurance company, including Medicare. This node will be either the IFN of the new entry in the buffer file if filing was successful or 0^error message. This call adds new entries to the INSURANCE BUFFER file (#355.33). Returns 1 if all entries stored; returns 0 if any of the entries encountered an error while filing. ******************** 3303 NAME: DBIA3303 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: FEB 7,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 391.98 ROOT: DGCN(391.98, DESCRIPTION: TYPE: File THE CLINICAL INFORMATION RESOURCE NETWORK PACKAGE NEEDS TO ORDER THROUGH THE PATIENT DATA EXCEPTION (#391.98) FILE TO PRODUCE A DISPLAY SHOWING THE STATUS AND COUNT OF OUTSTANDING PATIENT DATA REVIEW ITEMS. ^DGCN(391.98,'AST' .04 STATUS 0;4 Direct Global Read & w ROUTINE: ******************** 3304 NAME: DBIA3304 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: FEB 7,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 391.984 ROOT: DGCN(391.984 DESCRIPTION: TYPE: File THE CLINICAL INFORMATION RESOURCE NETWORK PACKAGE NEEDS TO GET THE EXTERNAL VALUE OF THE EXCEPTION STATUS OF PATIENT DATA REVIEW ENTRIES FOR THE MPI/PD STATUS DISPLAY. ^DGCN(391.984 .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3310 NAME: EN and PAT - SCMCQK Access CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: FEB 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The PC Assign or Unassign, [PXCE SC PC Assign/Unassign], protocol uses the Scheduling routine SCMCQK as a means to acquire Team information for display and possible processing. [PXCE SC PC Assign/Unassign], PC Assign or Unassign, is an action item on the PXCE MAIN and PXCE SDAM menus and accesses SCMCQK using the "EN" and "PAT" entry points. ROUTINE: SCMCQK COMPONENT: PAT VARIABLES: PAT^SCMCQK WILL "PROCESS A PATIENT" COMPONENT: EN VARIABLES: EN^SCMCQK IS THE "MAIN CALL" TO SCMCQK TO VERIFY SETUP OF PATIENT/TEAM INFORMATION. ******************** 3311 NAME: PXCE SC DISPLAY TEAM INFO Protcol CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Private ENTERED: FEB 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The entry action for the Display Team Information, [PXCE SC DISPLAY TEAM INFO], protocol has the potential to use routine SCMCU1 as means to select a patient. PXCE SC DISPLAY TEAM INFO (TI Display Team Information) is an action item on the PXCE MAIN and PXCE SDAM menus and may access ^SCMCU1 at its "SEL" entry point. ROUTINE: SCMCU1 COMPONENT: SEL VARIABLES: SEL^SCMCU1 WILL "SELECT A PATIENT". ******************** 3314 NAME: Outpatient Pharmacy/NDBI A7RPSOUB CUSTODIAL PACKAGE: NDBI SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Private ENTERED: FEB 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Outpatient Pharmacy package makes a call into the National Database Integration function $$ZIEN52^A7RPSOUB(STATION#,RX#). This function will return either a NDBI Drug Table ien value if the Prescription number for the station supplied was moved to the priamry site in an integrated system or null. Calls into NDBI $$ZIEN52^A7RPSOUB(STATION#,RX#) from Outpatient Pharmacy are contingent on: 1) the presence of the sub-routine $$ZIEN52^A7RPSOUB. 2) a variable that contains a three-digit station number associated with the RX#. If any one of these two conditions is not met, then Outpatient Pharmacy will not make the call. ROUTINE: A7ROUSB COMPONENT: ZIEN52 VARIABLES: Station# Type: Input The station number should be a three digit number of the Prescription number supplied. RX# Type: Input The RX# is the .01 field of the Prescription file. National Database Integration function $$ZIEN52^A7RPSOUB returns either the National Drug Table ien number or null. If a value is returned, then RX# from the site supplied was moved to the primary site of an integrated database. ******************** 3315 NAME: UPDATE DIE CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: FEB 14,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Registration is requesting to export a new cross reference to the .01 and .09 fields of the Patient file (#2) by hardsetting the ^DD("IX" global nodes and using UPDATE^DIE to get the IEN in ^DD("IX" to use. The reason to hardset the global rather than have KIDS export the x-ref is that the .01 of the Patient file (#2) is has changes in test in the field for the Name Standardization patch which is on indefinate hold. ROUTINE: DIE COMPONENT: UPDATE VARIABLES: ZZFDA Type: Input Array containing file number and x-ref name ZZIEN Type: Output IEN for new entry in ^DD("IX" - INDEX file. for the .01: S ZZFDA(.11,"+1,",.01)=file# <--- would be 2 in this case S ZZFDA(.11,"+1,",.02)=xrefName <--- would be "AMPIZZ" in this case D UPDATE^DIE("","ZZFDA","ZZIEN") S DA=ZZIEN(1) <--- The Updater returns the IEN of the added entry in ZZIEN for the .09: S ZZFDA(.11,"+1,",.01)=file# <--- would be 2 in this case S ZZFDA(.11,"+1,",.02)=xrefName <--- would be "ATSSN" in this case D UPDATE^DIE("","ZZFDA","ZZIEN") S DA=ZZIEN(1) <--- The Updater returns the IEN of the added entry in ZZIEN ******************** 3317 NAME: Imaging Update Radiology files #3317 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging will use the STUFPHY component to update the radiologist information when an exam has been interpreted. The DELIMGPT module will be used to delete the image pointer from the Radiology Report file when an image is deleted. USAGE: Controlled Subscri ENTERED: FEB 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine RARIC1 has callable modules to: 1) to stuff the physician data into an exam record and 2) delete Imaging pointers in the Radiology Report file. ROUTINE: RARIC1 COMPONENT: STUFPHY(RAVERF,RASR,RARTN VARIABLES: RAVERF Type: Input DUZ of physician (primary staff or primary resident) RASR Type: Input Variable equals 15 for staff and 12 if resident. RARTN Type: Output Returns description string from calling this API. Adds the physician data into exam record and will delete second staff/ resident if it matches the primary staff/resident COMPONENT: DELIMGPT(RAIE74,RAIE2005 VARIABLES: RAIE74 Type: Input ien for entry in file 74 (Radiology Report). RAIE2005 Type: Input ien for entry in file 2005 (Image) to be deleted from file 74. Deletes imaging pointer from the Radiology Report file (74). ******************** 3320 NAME: UPDATE BCMA STATUS INFORMATION CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: FEB 21,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this API is to get information from BAR CODE MEDICATION ADMINSTRATION (BCMA) to put in the PHARMACY PATIENT FILE (#55). ROUTINE: PSJBCMA3 COMPONENT: EN(DFN,ON,BCID,STATUS,DATE) VARIABLES: DFN Type: Input Internal Entry number for the patient. (Required) ON Type: Input Order number (from the PHARMACY PATIENT file) to be udpated. (Required) BCID Type: Input The barcode (unique) identifier to be updated. (Required) STATUS Type: Input Bar Code Medication Administration (BCMA) status for the specified BCID. (Required) DATE Type: Input The date that BCMA changed the status of the specified unique ID. (Required) ******************** 3321 NAME: DBIA 3321 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: IMAGING Imaging will place copies of the following routines MCUIMAG0, MCARUTL2 and MCARTUL3 into a transport global to be downloaded into the Imaging gateways. These routines are used by Imaging to store Image pointers in the Medicine package and to acquire information regarding the medicine entry. Imaging is also requesting the following information to be provided on each released patch to the aforemention routines. Information: If you are running Vista Imaging, use the menu option to copy the routines to the Imaging DICOM gateways as follows: "On the Vista server (hospital database), use menu option 'Copy Routines to DICOM Gateway' located under the 'Imaging System Manager' Menu. Then on all Text and Image gateways use the 'System Maintenance' menu to select Gateway Configuration and DICOM Master File and then select 'Download Current Radiology and MAS Routines'. This will cause the up-to-date versions of all radiology and MAS routines to be copied to the gateway systems." USAGE: Controlled Subscri ENTERED: FEB 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Medicine gives permission to the VistA Imaging application to copy the following routines into their Imaging gateways. These routines are not renamed or modified at the destination. ROUTINE: COMPONENT: MCUIMAGO VARIABLES: Routine to file image pointers and delete image pointers in the Medicine files. COMPONENT: MCARUTL2 VARIABLES: Utility routine for Imaging to obtain information on Medicine file entries COMPONENT: MCARUTL3 VARIABLES: Utility routine for Imaging to obtain information on Medicine file entries. ******************** 3323 NAME: DBIA3323 - Image file points to Rad Report CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging files 2005 and 2005.1 both have field number 61 defined as a pointer to the Radiology Report file. Fields have been setup with no LAYGO access and these fields are set by an Imaging routine and not by user interaction. The 2005 file is the storage location for all images and file 2005.1 is the storage location for all images deleted at the site; used as an audit trail. ADD^MAGGTIA(MAGRY,MAGGZ) is the api used to update the entries into the Image files; the routine uses UPDATE^DIE to add an image file entry. Input variables: MAGRY is the results of the update and MAGGZ is an array that contains field numbers and associated values for the update. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT( DESCRIPTION: TYPE: File Radiology gives permission to the Imaging package to point to the Radiology Report file (#74) from the Image (#2005) and Image Audit (#2005.1) data dictionaries. ^RARPT(D0,0) .01 DAY-CASE# 0;1 Read w/Fileman This field contains the date and case number of the Radiology exam associated with this report. ROUTINE: ******************** 3324 NAME: DBIA3324 - Imaging points to file 71 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging files 2005 and 2005.1 both have field number 62 defined as a pointer to the RAD/NUC MED PROCEDURE file. Fields have been setup with no LAYGO access and these fields are updated by an Imaging routine and not by user interaction. The 2005 file is the storage location for all images and file 2005.1 is the storage location for all images deleted at the site; used as an audit trail. Field 62 (PACS Procedure) was created to identify the Radiology procedure for the captured image. ADD^MAGGTIA(MAGRY,MAGGZ) is the api used to update the entries into the Image files; the routine uses UPDATE^DIE to add an image file entry. Input variables: MAGRY is the results of the update and MAGGZ is an array that contains field numbers and associated values for the update. USAGE: Controlled Subscri ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 71 ROOT: RAMIS(71 DESCRIPTION: TYPE: File Radiology gives permission to the Imaging package to point to the RAD/NUC MED PROCEDURE file (#71) from the Image (#2005) and Image Audit (#2005.1) data dictionaries. ^RAMIS(72,D0,0) .01 NAME 0;1 Read w/Fileman Name of the RAD/NUC MED PROCEDURE. ROUTINE: ******************** 3325 NAME: DBIA3325 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM This call provides a user interface with the PATIENT file (#2) including standard patient lookup and duplicate checking functions. With user entry of basic patient identifying data (e.g., name, social security number, and date of birth), a matching entry within the Patient database is found or a new Patient record is created. The call is made from routine EASEZI as follows: D GETPAT^DGRPTU("",1,.DFN,.DGNEWPF) where: "" --> DGHOWPT in the formal parameter list. 1 --> DGHADDF in the formal parameter list; allow new patient. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Enrollment Application System requests use of entry point GETPAT^DGRPTU for use by the 1010EZ module. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. Before the electronically submitted data can be stored by the 1010EZ module within the site's Patient database, user acceptance of the data is required. The first step in that process is for the user to match, if possible, the veteran's identifying data with an existing Patient record. This entry point, which was previously implemented by the 1010T module, will provide the user interface with standard patient lookup and duplicate checking functions within Registration. ROUTINE: DGRPTU COMPONENT: GETPAT(DGHOWPT,DGADDF,DFN,DGNEWPF) VARIABLES: DFN Type: Output DFN = PATIENT file (#2) IEN; if DFN = -1, then no patient selected. DGNEWPF Type: Output DGNEWPF = New patient added flag; if DGNEWPF = 1, then new patient added; if DGNEWPF = null, then existing patient. DGHOWPT Type: Input How was patient entered: 1 =10-10T registration "" otherwise DGADDF Type: Input Add new entry flag (optional): 1 =Allow new patient ******************** 3326 NAME: DBIA3326 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM As part of the Means Test Blocking and letters functionality, $$LST^DGMTU is called from several locations in the EASMT routines to determine the last Means Test and Means Test status for purposes of appointment management and auto-generation of notification letters to the patient. Data transmitted to the VistA 1010EZ module from the web-based application system includes a significant amount of income-related information. This information provides the identity of Spouse and Dependents, as well as some annual income and expense data. If the user has matched the veteran applicant with an existing Patient record, the call to $$LST^DGMTU will provide the most recent income test information held at the site. Then the 1010EZ module will allow the user to compare income data returned by ALL^DGMTU21 with data contained in the 1010EZ application. The call is made from EASESF2 as follows: S LASTINC=$$LST^DGMTU(EASDFN,YREND,1) I LASTINC="" S LASTINC=$$LST^DGMTU(EASDFN,YREND,2) where: EASDFN is DFN YREND is DGDT (set to 12/31 of the current year) DGMTYPT is Type of income test: 1 is Means Test and 2 is Co-Pay Test Type of income test, where 1 is Means Test and 2 is Co-Pay Test. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU COMPONENT: $$LST(DFN,DGDT,DGMTYPT) VARIABLES: DFN Type: Input Patient IEN DGDT Type: Input Date/Time (Optional - default today@2359) DGMTYPT Type: Input Type of Test (Optional - if not defined Means Test will be assumed) $$LST Type: Output Annual Means Test IEN^Date of Test^Status Name^Status Code^Source of Test Retrieve a pointer to the last Means Test or Co-pay Test and its date if the veteran has income test data at the site. ******************** 3327 NAME: DBIA3327 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM Each data element must pass FileMan validator VAL^DIE before filing by FILE^DIE. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The Enrollment Application System requests ability to read data via FileMan from numerous fields in the PATIENT (#2) file. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. In a some cases, information about the veteran applicant will already reside in the site's patient database. If that is the case, then the 1010EZ module is required to display both the newly submitted data and the existing data for comparison purposes. The Enrollment Application System requests ability to write data using FileMan to the same fields in the PATIENT (#2) file. Since the 1010EZ is a means of initiating enrollment/registration, it is of course necessary to commit the data to the database. Medical center users may review and edit the data, as needed, before filing. ^DPT( .01 NAME 0;1 Read w/Fileman .02 SEX 0;2 Both R/W w/Fileman .03 DATE OF BIRTH 0;3 Read w/Fileman .05 MARITAL STATUS 0;5 Both R/W w/Fileman .08 RELIGIOUS PREFERENCE 0;8 Both R/W w/Fileman .09 SOCIAL SECURITY NUMB 0;9 Read w/Fileman .091 REMARKS 0;10 Both R/W w/Fileman .111 STREET ADDRESS [LINE .11;1 Both R/W w/Fileman .112 STREET ADDRESS [LINE .11;2 Both R/W w/Fileman .114 CITY .11;4 Both R/W w/Fileman .115 STATE .11;5 Both R/W w/Fileman .116 ZIP CODE .11;6 Both R/W w/Fileman .117 COUNTY .11;7 Both R/W w/Fileman .131 PHONE NUMBER [RESIDE .13;1 Both R/W w/Fileman .132 PHONE NUMBER [WORK] .13;2 Both R/W w/Fileman .211 K-NAME OF PRIMARY NO .21;1 Both R/W w/Fileman .212 K-RELATIONSHIP TO PA .21;2 Both R/W w/Fileman .213 K-STREET ADDRESS [LI .21;3 Both R/W w/Fileman .214 K-STREET ADDRESS [LI .21;4 Both R/W w/Fileman .216 K-CITY .21;6 Both R/W w/Fileman .217 K-STATE .21;7 Both R/W w/Fileman .218 K-ZIP CODE .21;8 Both R/W w/Fileman .219 K-PHONE NUMBER .21;9 Both R/W w/Fileman .21011 K-WORK PHONE NUMBER .21;11 Both R/W w/Fileman .2201 E-ZIP+4 .22;1 Both R/W w/Fileman .2202 D-ZIP+4 .22;2 Both R/W w/Fileman .2205 EMPLOYER ZIP+4 .22;5 Both R/W w/Fileman .2206 SPOUSE'S EMP ZIP+4 .22;6 Both R/W w/Fileman .2207 K-ZIP+4 .22;7 Both R/W w/Fileman .251 SPOUSE'S EMPLOYER NA .25;1 Both R/W w/Fileman .2515 SPOUSE'S EMPLOYMENT .25;15 Both R/W w/Fileman .252 SPOUSE'S EMP STREET .25;2 Both R/W w/Fileman .255 SPOUSE'S EMPLOYER'S .25;5 Both R/W w/Fileman .256 SPOUSE'S EMPLOYER'S .25;6 Both R/W w/Fileman .257 SPOUSE'S EMP ZIP COD .25;7 Both R/W w/Fileman .258 SPOUSE'S EMP PHONE N .25;8 Both R/W w/Fileman .301 SERVICE CONNECTED? .3;1 Both R/W w/Fileman .302 SERVICE CONNECTED PE .3;2 Both R/W w/Fileman .313 CLAIM NUMBER .31;3 Both R/W w/Fileman .3192 COVERED BY HEALTH IN .31;11 Both R/W w/Fileman .3111 EMPLOYER NAME .311;1 Both R/W w/Fileman .31115 EMPLOYMENT STATUS .311;15 Both R/W w/Fileman .3113 EMPLOYER STREET [LIN .311;3 Both R/W w/Fileman .3116 EMPLOYER CITY .311;6 Both R/W w/Fileman .3117 EMPLOYER STATE .311;7 Both R/W w/Fileman .3118 EMPLOYER ZIP CODE .311;8 Both R/W w/Fileman .3119 EMPLOYER PHONE NUMBE .311;9 Both R/W w/Fileman .324 SERVICE DISCHARGE TY .32;4 Both R/W w/Fileman .325 SERVICE BRANCH [LAST .32;5 Both R/W w/Fileman .326 SERVICE ENTRY DATE [ .32;6 Both R/W w/Fileman .327 SERVICE SEPARATION D .32;7 Both R/W w/Fileman .328 SERVICE NUMBER [LAST .32;8 Both R/W w/Fileman .32102 AGENT ORANGE EXPOS. .321;2 Both R/W w/Fileman .32103 RADIATION EXPOSURE I .321;3 Both R/W w/Fileman .322013 ENVIRONMENTAL CONTAM .322;13 Both R/W w/Fileman .331 E-NAME .33;1 Both R/W w/Fileman .332 E-RELATIONSHIP TO PA .33;2 Both R/W w/Fileman .333 E-STREET ADDRESS [LI .33;3 Both R/W w/Fileman .334 E-STREET ADDRESS [LI .33;4 Both R/W w/Fileman .336 E-CITY .33;6 Both R/W w/Fileman .337 E-STATE .33;7 Both R/W w/Fileman .338 E-ZIP CODE .33;8 Both R/W w/Fileman .339 E-PHONE NUMBER .33;9 Both R/W w/Fileman .33011 E-WORK PHONE NUMBER .33;11 Both R/W w/Fileman .341 D-NAME OF DESIGNEE .34;1 Both R/W w/Fileman .3405 D-DESIGNEE SAME AS N .34;10 Both R/W w/Fileman .342 D-RELATIONSHIP TO PA .34;2 Both R/W w/Fileman .343 D-STREET ADDRESS [LI .34;3 Both R/W w/Fileman .344 D-STREET ADDRESS [LI .34;4 Both R/W w/Fileman .346 D-CITY .34;6 Both R/W w/Fileman .347 D-STATE .34;7 Both R/W w/Fileman .348 D-ZIP CODE .34;8 Both R/W w/Fileman .349 D-PHONE NUMBER .34;9 Both R/W w/Fileman .34011 D-WORK PHONE NUMBER .34;11 Both R/W w/Fileman .362 DISABILITY RET. FROM .36;2 Both R/W w/Fileman .368 SERVICE DENTAL INJUR .36;8 Both R/W w/Fileman .36235 RECEIVING A VA PENSI .362;14 Both R/W w/Fileman .36255 RECEIVING MILITARY R .362;16 Both R/W w/Fileman .381 ELIGIBLE FOR MEDICAI .38;1 Both R/W w/Fileman .525 POW STATUS INDICATED .52;5 Both R/W w/Fileman .531 CURRENT PH INDICATOR .53;1 Read w/Fileman .532 CURRENT PURPLE HEART .53;2 Read w/Fileman 57.4 SPINAL CORD INJURY 57;4 Both R/W w/Fileman .133 EMAIL ADDRESS .13;3 Both R/W w/Fileman .2516 SPOUSE'S DATE OF RET .25;16 Both R/W w/Fileman .31116 DATE OF RETIREMENT .311;16 Both R/W w/Fileman 1010.156 MOST RECENT 1010EZ 1010.15; Both R/W w/Fileman 1010.157 COMBAT INDICATED ON 1010.15; Both R/W w/Fileman 1010.158 DISABILITY DISCHARGE 1010.15; Both R/W w/Fileman 1010.159 APPOINTMENT REQUEST 1010.15; Both R/W w/Fileman 1010.151 APPOINTMENT REQUEST 1010.15; Read w/Fileman .134 PHONE NUMBER [CELLUL 13;4 Read w/Fileman .135 PAGER NUMBER 13;5 Read w/Fileman ^DPT(D0,.01, .01 ALIAS 0;1 Read w/Fileman ^DPT(DO,.02, .01 RACE INFORMATION 0;1 Both R/W w/Fileman .02 METHOD OF COLLECTION 0;2 Both R/W w/Fileman ^DPT(D0,.06, .01 ETHNICITY INFORMATIO 0;1 Both R/W w/Fileman .02 METHOD OF COLLECTION 0;2 Both R/W w/Fileman ROUTINE: ******************** 3328 NAME: DBIA3328 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM Data is passed through FileMan validator VAL^DIE before filing by FILE^DIE, or is filed using UPDATE^DIE. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.12 ROOT: DGPR(408.12 DESCRIPTION: TYPE: File The Enrollment Application System requests ability to read data via FileMan from several fields in the PATIENT RELATION (#408.12) file. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. In a some cases, information about the veteran applicant will already reside in the site's patient database. If that is the case, then the 1010EZ module is required to display both the newly submitted data and the existing data for comparison purposes. The Enrollment Application System requests ability to write data using FileMan to the same fields in the PATIENT RELATION (#408.12) file. Since the 1010EZ is a means of initiating enrollment/registration, it is of course necessary to commit the data to the database. Medical center users may review and edit the data, as needed, before filing. The data placed in file #408.12 will be further edited at the time of formal Registration and Means Testing. ^DGPR(408.12, .01 PATIENT 0;1 Both R/W w/Fileman .02 RELATIONSHIP 0;2 Both R/W w/Fileman .03 PERSON 0;3 Both R/W w/Fileman ^DGPR(408.12,D0,E, .01 EFFECTIVE DATE 0;1 Both R/W w/Fileman For global reference ^DGPR(408.12,D0,E,D1,0), the E subscript is the Effective Date in internal FileMan format; the D1 subscript is a sequential integer since there may be more than one subrecord for a given date. ROUTINE: ******************** 3329 NAME: DBIA3329 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM Data is passed through FileMan validator VAL^DIE before filing by FILE^DIE, or is filed using UPDATE^DIE. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.13 ROOT: DGPR(408.13 DESCRIPTION: TYPE: File The Enrollment Application System requests ability to read data via FileMan from several fields in the INCOME PERSON (#408.13) file. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. In a some cases, information about the veteran applicant will already reside in the site's patient database. If that is the case, then the 1010EZ module is required to display both the newly submitted data and the existing data for comparison purposes. The Enrollment Application System requests ability to write data using FileMan to the same fields in the INCOME PERSON (#408.13) file. Since the 1010EZ is a means of initiating enrollment/registration, it is of course necessary to commit the data to the database. Medical center users may review and edit the data, as needed, before filing. The data placed in file #408.13 will be further edited at the time of formal Registration and Means Testing. ^DGPR(408.13, .01 NAME 0;1 Both R/W w/Fileman .02 SEX 0;2 Both R/W w/Fileman .03 DATE OF BIRTH 0;3 Both R/W w/Fileman .09 SOCIAL SECURITY NUMB 0;9 Both R/W w/Fileman 1.1 MAIDEN NAME 1;1 Both R/W w/Fileman 1.2 STREET ADDRESS 1 1;2 Both R/W w/Fileman 1.3 STREET ADDRESS 2 1;3 Both R/W w/Fileman 1.4 STREET ADDRESS 3 1;4 Both R/W w/Fileman 1.5 CITY 1;5 Both R/W w/Fileman 1.6 STATE 1;6 Both R/W w/Fileman 1.7 ZIP 1;7 Both R/W w/Fileman 1.8 TELEPHONE NUMBER 1;8 Read w/Fileman ROUTINE: ******************** 3330 NAME: DBIA3330 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM If a call to LST^DGMTU indicates that the veteran has in income test for the current income year in the site's database, no data filing is attempted. Data is passed through FileMan validator VAL^DIE before filing by FILE^DIE, or is filed using UPDATE^DIE. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.21 ROOT: DGMT(408.21 DESCRIPTION: TYPE: File The Enrollment Application System requests ability to read data via FileMan from several fields in the INDIVIDUAL ANNUAL INCOME (#408.21) file. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. In a some cases, information about the veteran applicant will already reside in the site's patient database. If that is the case, then the 1010EZ module is required to display both the newly submitted data and the existing data for comparison purposes. The Enrollment Application System requests ability to write data using FileMan to the same fields in the INDIVIDUAL ANNUAL INCOME (#408.21) file. Since the 1010EZ is a means of initiating enrollment/registration, it is of course necessary to commit the data to the database. Medical center users may review and edit the data, as needed, before filing. The data placed in file #408.21 will be further edited at the time of formal Registration and Means Testing. ^DGMT(408,21, 2.01 CASH, AMOUNTS IN BAN 2;1 Both R/W w/Fileman 2.03 REAL PROPERTY 2;3 Both R/W w/Fileman 2.04 OTHER PROPERTY OR AS 2;4 Both R/W w/Fileman .01 YEAR 0;1 Both R/W w/Fileman .02 PATIENT RELATION 0;2 Both R/W w/Fileman .14 TOTAL INCOME FROM EM 0;14 Both R/W w/Fileman .17 ALL OTHER INCOME 0;17 Both R/W w/Fileman 1.01 MEDICAL EXPENSES 1;1 Both R/W w/Fileman 1.02 FUNERAL AND BURIAL E 1;2 Both R/W w/Fileman 1.03 EDUCATION EXPENSES 1;3 Both R/W w/Fileman 1.12 GROSS MEDICAL EXPENS 1;12 Read w/Fileman ROUTINE: ******************** 3331 NAME: DBIA3331 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ENROLLMENT APPLICATION SYSTEM If a call to LST^DGMTU indicates that the veteran has in income test for the current income year in the site's database, no data filing is attempted. Data is passed through FileMan validator VAL^DIE before filing by FILE^DIE, or is filed using UPDATE^DIE. USAGE: Private ENTERED: MAR 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 408.22 ROOT: DGMT(408.22 DESCRIPTION: TYPE: File The Enrollment Application System requests ability to read data via FileMan from several fields in the INCOME RELATION (#408.22) file. The VistA-resident portion of the 1010EZ module accepts data transmitted to the site electronically from a web-based application where a veteran has entered enrollment data. In a some cases, information about the veteran applicant will already reside in the site's patient database. If that is the case, then the 1010EZ module is required to display both the newly submitted data and the existing data for comparison purposes. The Enrollment Application System requests ability to write data using FileMan to the same fields in the INCOME RELATION (#408.22) file. Since the 1010EZ is a means of initiating enrollment/registration, it is of course necessary to commit the data to the database. Medical center users may review and edit the data, as needed, before filing. The data placed in file #408.22 will be further edited at the time of formal Registration and Means Testing. ^DGMT(408,22, .01 PATIENT 0;1 Both R/W w/Fileman .02 INDIVIDUAL ANNUAL IN 0;2 Both R/W w/Fileman .07 AMOUNT CONTRIBUTED T 0;7 Both R/W w/Fileman .09 INCAPABLE OF SELF-SU 0;9 Both R/W w/Fileman .1 CONTRIBUTED TO SUPPO 0;10 Both R/W w/Fileman .11 CHILD HAD INCOME 0;11 Both R/W w/Fileman .18 CHILD 18-23 IN SCHOO 0;18 Both R/W w/Fileman .19 AMOUNT CONTRIBUTED T 0;19 Read w/Fileman ROUTINE: ******************** 3332 NAME: PXRM REMINDERS AND CATEGORIES CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: USAGE: Controlled Subscri ENTERED: APR 25,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns list of reminders and categories that may be selected. ROUTINE: ******************** 3333 NAME: PXRMAPI0 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: MAR 2,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine API calls for the reminder package: 1) CATREM^PXRMAPI0 Returns list of reminders and sub-categories for a given category. ROUTINE: PXRMAPI0 COMPONENT: CATREM VARIABLES: COMPONENT: CATREM(CIEN,.CARRAY) VARIABLES: CIEN Type: Input CIEN is the reminder category IEN from file 811.7. CARRAY Type: Output CARRAY is the array of reminders that are assigned to a category. This component return a list of reminders assigned to a specific category. ******************** 3335 NAME: Gather Logical Link Domain CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX MASTER PATIENT INDEX VISTA CONSULT/REQUEST TRACKING OUTPATIENT PHARMACY OneVA Pharmacy project requested to added Outpatient Pharmacy as a subscriber to access the Domain (#.03) field. USAGE: Controlled Subscri ENTERED: MAR 6,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 870 ROOT: HLCS(870, DESCRIPTION: TYPE: File ^HLCS(870, .03 DOMAIN 0;7 Read w/Fileman This is a pointer to the Domain file but we are using the external domain name. .01 NODE 0;1 Direct Global Read & w Also allows direct global read access to the "B" x-ref. .02 INSTITUTION 0;2 Read w/Fileman 2 LLP TYPE 0;3 Read w/Fileman 4 STATE 0;5 Read w/Fileman 14 SHUTDOWN LLP ? 0;15 Read w/Fileman 400.03 TCP/IP SERVICE TYPE 400;3 Read w/Fileman ROUTINE: ******************** 3336 NAME: IB REFERENCING 433 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 7,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 433 ROOT: PRCA(433 DESCRIPTION: TYPE: File Various places in the IB package, such as MRA Extract and Diagnostic Measures, need to pull transactions from AR. This agreement allows IB to directly access the AR Transaction file (433). ^PRCA(433,TRDA,0) .01 TRANSACTION NUMBER 0;1 Direct Global Read & w 4 TRANSACTION STATUS 0;4 Direct Global Read & w These fields are being used by various reports in the Diagnostic Measures module that display the comments from the transactions for each receivable, for example: First Party Follow-up report. ^PRCA(433,'C',BILL,TRDA) Various reports in the Diagnostic Measures module use this cross-reference in order to get the transactions entered for a given bill. ^PRCA(433,TRDA,1) 11 TRANSACTION DATE 1;1 Direct Global Read & w 12 TRANSACTION TYPE 1;2 Direct Global Read & w 19 DATE ENTERED 1;9 Direct Global Read & w These fields are being used by various reports in the Diagnostic Measures module that display the comments from the transactions for each receivable, for example: First Party Follow-up report. ^PRCA(433,TRDA,5) 20 PREPAYMT TRANS. 5;1 Direct Global Read & w 5.02 BRIEF COMMENTS 5;2 Direct Global Read & w These fields are being used by various reports in the Diagnostic Measures module that display the comments from the transactions for each receivable, for example: First Party Follow-up report. ^PRCA(433,TRDA,8) 86 TRANS. COMMENTS 8;6 Direct Global Read & w These fields are being used by various reports in the Diagnostic Measures module that display the comments from the transactions for each receivable, for example: First Party Follow-up report. ^PRCA(433,TRDA,7,COM,0) .01 COMMENTS 0;1 Direct Global Read & w These fields are being used by various reports in the Diagnostic Measures module that display the comments from the transactions for each receivable, for example: First Party Follow-up report. ROUTINE: ******************** 3337 NAME: IB referencing 430.3 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: APR 27,2006 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 430.3 ROOT: PRCA(430.3 DESCRIPTION: TYPE: File ^PRCA(430.3,D0,0 .01 NAME 0;1 Direct Global Read & w 1 ABBREVIATION 0;2 Direct Global Read & w 2 STATUS NUMBER 0;3 Direct Global Read & w ROUTINE: ******************** 3339 NAME: DBIA 3339 - FBCS & File 2 fields CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: FEE BASIS CLAIMS SYSTEM added 12/11/2008 LAB SERVICE LR added 3/21/11 USAGE: Controlled Subscri ENTERED: MAR 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT DESCRIPTION: TYPE: File The subscribers are given permission to read the following fields from the Patient file (#2). Fields: .01 -NAME .02 -SEX .03 -DATE OF BIRTH .09 -SOCIAL SECURITY NUMBER 301 -TYPE 391 -SERVICE CONNECTED? 1901 -VETERAN (Y/N)? ^DPT(D0,0 .01 NAME 0;1 Read w/Fileman Patient name .02 SEX 0;2 Read w/Fileman Patient's Sex (M:MALE;F:FEMALE) .03 DATE OF BIRTH 0;3 Read w/Fileman Patient's date of birth .09 SOCIAL SECURITY NUMB 0;9 Read w/Fileman Patient's social security number .301 SERVICE CONNECTED? .3;1 Read w/Fileman SERVICE CONNECTED (Y:YES;N:NO) 391 TYPE TYPE;1 Read w/Fileman Patient type. Field is a pointer to ^DG(391. 1901 VETERAN (Y/N)? VET;1 Read w/Fileman Is patient a veteran. (Y:YES;N:NO) ROUTINE: ******************** 3342 NAME: DBIA3342 CUSTODIAL PACKAGE: PAID SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 27,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 450 ROOT: PRSPC( DESCRIPTION: TYPE: File Integrated Billing has permission to access the PAID EMPLOYEE file (#450) for the following fields described in this DBIA: ^PRSPC( 80 SEPARATION IND 1;33 Direct Global Read & w IB uses the SEPARATION IND field as part of the process to identify if a VA patient is also a VA employee. First, it will check if the patient SSN is on the PAID EMPLOYEE file (#450) by looking at the "SSN" cross- -reference. If found, it then checks if the field 80 (SEPARATION IND) for the employee has a value different of "Y". If so, it assumes that the patient is a VA employee. ^PRSPC('SSN',SSN,DA) With the Social Security Number, IB can use this cross-reference to find the internal entry number (DA) for the SSN holder on the PAID EMPLOYEE file (#450). ROUTINE: ******************** 3343 NAME: DBIA3343 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: APR 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Accounts Receivable has permission to make the following calls to IB in order to get information about bills: ROUTINE: IBCOIVM1 COMPONENT: $$BTYP(BN,X) VARIABLES: BN Type: Input Pointer to the bill in file #399 X Type: Input Zeroth node of pointed-to bill entry $$BTYP Type: Output There are 4 possible values returned by this function: "R" - Pharmacy Refill "P" - Prosthetics "I" - Inpatient "O" - Outpatient This function returns the bill type as the following: "R" - Pharmacy Refill "P" - Prosthetics "I" - Inpatient "O" - Outpatient AR uses this function in the generation of the AR Workload To-Do List. It passes a pointer to the BILL/CLAIMS file (#399) plus the zero node of this entry and the function returns one of the 4 classifications above for the bill. ******************** 3344 NAME: DG FIELD MONITOR CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SPINAL CORD DYSFUNCTION The subscribing protocols are: SPN REG STATUS DELETE Notice of Date of Death Deletion SPN REG STATUS UPDATE Update Registration Status to Expired SCHEDULING The subscribing protocol is: SCMC PCMM INACTIVATE ON DATE OF DEATH FEE BASIS The subscribing protocol is: FB PATIENT DATA CHANGE PHARMACY BENEFITS MANAGEMENT The subscribing protocol is: PSU PATIENT DEMOGRAPHIC CHANGE VIRTUAL PATIENT RECORD Added VPR DG UPDATES protocol to event point. The VPR protocol listeners will store the patient's DFN in an ^XTMP array; another process within HMP watches this global for patients to update and will re-pull a snapshot of the patient's demographics. HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** HMP DG UPDATES protocol has been added to the DG FIELD MONITOR protocol by HMP v.2.0 to trigger unsolicited patient updates from VistA to JDS when fields monitored by this protocol are updated. USAGE: Controlled Subscri ENTERED: MAR 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other This protocol is an event point which monitors the editing of fields in DG* application files. At the time of this event point, the following variables will be present in the environment: Variable Description -------- ----------------------------------------------- DGDA DA array as exists during Fileman editing DGFILE File or subfile number where changed field resides DGFIELD Number of changed field DGTYPE Type of cross reference action (ADD, DELETE or UPDATE) DGDTH Date/time of change in $Horolog format DGUSER DUZ of user that made the change DGOPT Current menu option in "option_name^menu_text" format DGX X array as documented for Fileman new style x-refs DGX1 X1 array as documented for Fileman new style x-refs DGX2 X2 array as documented for Fileman new style x-refs This protocol is triggered by "listener" cross references on selected fields. By employing logic such as "If DGFILE=2, DGFIELD=.361, DGTYPE="SET", then...", subscribers to this protocol may take action based on edit activity which involves those fields. This event point is designed to occur only once per field editing activity. The DGTYPE variable can be interpreted as follows: o ADD transactions indicate that data has been added to a field that was previously null. The DGX, DGX1 and DGX2 arrays will contain the Fileman X, X1 and X2 arrays (respectively) as documented for the execution of 'SET' logic. o DELETE transactions indicate that previously existing data has been deleted without being replaced. The DGX, DGX1 and DGX2 arrays will contain the Fileman X, X1 and X2 arrays (respectively) as documented for the execution of 'KILL' logic. o UPDATE transactions indicate that existing data has been deleted and new data has been filed. The DGX, DGX1 and DGX2 arrays will contain the Fileman X, X1 and X2 arrays (respectively) as documented for the execution of 'SET' logic. ROUTINE: ******************** 3345 NAME: DBIA3345 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: APR 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Accounts Receivable has permission to make the following calls to IB in order to get the classification (First or Third Party) for an AR Category. ROUTINE: IBJD1 COMPONENT: $$CATTYP(IBBCAT) VARIABLES: IBBCAT Type: Input AR Category $$CATTYP Type: Output There are three possible values returned by this function: "F" - First Party Category "T" - Third Party Category "" - Category cannot be classified or invalid category This function classifies an AR category into three types: "F" - First Party Category "T" - Third Party Category "" - Category cannot be classified or invalid category AR uses this function in the generation of the AR Workload To-Do List. It passes an AR Category (pointer to file #430.2) and this function classifies the AR Category as First Party or Third Party. Note: The algorithm used in this function is specific for the Diagnostic Measures module. ******************** 3346 NAME: DBIA3346 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission to make the following calls to AR in order get information about Repayment Plans. This information is used in 2 reports: First Party Follow-up Report and Repayment Plan Follow-up Report. Both of these reports belong to the Diagnostic Measures module. ROUTINE: RCBECHGA COMPONENT: $$REPDATA(BILL,DAYS) VARIABLES: BILL Type: Input Pointer to the ACCOUNTS RECEIVABLE file (#430). DAYS Type: Input Number of days over the due date for a payment not received to be considered defaulted. $$REPDATA Type: Output The value returned by this function is a string that contains the following information separated by "^" (up-arrow): 1. Repayment Plan Start Date (FM format) 2. Balance (Repayment Plan) 3. Monthly Payment Amount 4. Due Date (day of the month) 5. Last Payment Date (from file #433) 6. Last Payment Amount (from file #433) 7. Number of Payments Due 8. Number of Payments Defaulted This function returns information about a Repayment Plan associated to an AR receivable. ******************** 3347 NAME: DBIA3347 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING REGISTRATION USAGE: Private ENTERED: MAR 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 340 ROOT: RCD(340 DESCRIPTION: TYPE: File Integrated Billing has permission to access the following fields on the AR DEBTOR file (#340): ^RCD(340, .01 DEBTOR 0;1 Direct Global Read & w 110 SSN Computed Read w/Fileman "B" X-REF Direct Global R/W & w/ 1.01 STREED ADDRESS #1 1;1 Direct Global R/W & w/ 1.02 STREET ADDRESS #2 1;2 Direct Global R/W & w/ 1.03 STREET ADDRESS #3 1;3 Direct Global R/W & w/ 1.04 CITY 1;4 Direct Global R/W & w/ 1.05 STATE 1;5 Direct Global R/W & w/ 1.06 ZIP CODE 1/6 Direct Global R/W & w/ 1.07 PHONE NUMBER 1;7 Direct Global R/W & w/ 1.08 FOREIGN COUNTRY CODE 1;8 Direct Global R/W & w/ 1.09 ADDRESS UNKNOWN 1;9 Direct Global R/W & w/ The fields DEBTOR and SSN are being used by the following Diagnostic Measures reports: First Party Follow-up Report, CHAMPVA/CHAMPUS (Tricare) Follow-up Report, Repayment Plan Follow-up Report and the AR Productivity Report. The "B Cross-Reference and the address fields on the 1 node are used to build HL7 messages for the PFSS project. ROUTINE: ******************** 3348 NAME: DBIA3348 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAR 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission to make the following calls to AR in order to get information about Transactions (File #433): ROUTINE: RCRJRCOT COMPONENT: $$VALID(TRANDA) VARIABLES: TRANDA Type: Input Pointer to the AR TRANSACTION file (#433). $$VALID Type: Output There are two possible values returned by this function: 0 - TRANDA is NOT a valid transaction 1 - TRANDA is a valid transaction This function is used to check if a specific transaction is valid or not. It will return 1 if the transaction is valid and 0 otherwise. IB uses this function in the AR Productivity Report. It passes a pointer to the AR TRANSACTION file (#433) to the function and the function returns if the transaction is valid or not. If the transaction is not valid it is not printed on the report. ******************** 3350 NAME: DBIA3350 CUSTODIAL PACKAGE: INTEGRATED BILLING SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Private ENTERED: MAR 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 351.73 ROOT: IBE(351.73, DESCRIPTION: TYPE: File Accounts Receivable has permission to access the following fields on the IB DM WORKLOAD PARAMETERS file (#351.73): ^IBE(351.73,CLERK,1,ASSIGN) The AR Workload To-Do List process (invoked by the AR Nightly process) will loop through all the assignments for one clerk and will generate the tasks for this clerk, based on the parameters of his assignments. ^IBE(351.73,CLERK) The AR Workload To-Do List process (invoked by the AR Nightly process) will loop through all the clerks on this file and will generate tasks for each clerk based on their assignments. ^IBE(351.73,CLERK,1,ASSIGN,0) .02 BILL CATEGORY 0;2 Direct Global Read & w This field is used to identify which bill category should be considered in the generation of the To-Do List for the assignment. Only one category per assignment is allowed. .03 MINIMUM ACCOUNT BALA 0;3 Direct Global Read & w This field is used to identify the minimum balance for a bill to be included in the To-Do List for the assignment. .05 EXCLUDE REGIONAL COU 0;5 Direct Global Read & w This field is used to identify if bills referred to Regional Counsel should be excluded from the To-Do List or not. ^IBE(351.73,CLERK,1,ASSIGN,1) 1.01 DAYS SINCE LAST PAYM 1;1 Direct Global Read & w This field is used to decide if a bill should be included in the To-Do List or not. The bill will be included in the To-Do List only if number of days since the last payment transaction till the day the To-Do List runs, is not smaller than the number in this field. 1.02 FIRST PARTY-FIRST PA 1;2 Direct Global Read & w This field is used to identify the first name of the patient name range when generating the To-Do List for the assignment (First Party assignments only). 1.03 FIRST PARTY-LAST PAT 1;3 Direct Global Read & w This field is used to identify the last name of the patient name range when generating the To-Do List for the assignment (First Party assignments only). 1.04 FIRST PARTY-FIRST SS 1;4 Direct Global Read & w This field is used to identify the first number of last 4SSN of the patient last 4SSN range when generating the To-Do List for the assignment (First Party assignments only). 1.05 FIRST PARTY-LAST SSN 1;5 Direct Global Read & w This field is used to identify the last number of last 4SSN of the patient last 4SSN range when generating the To-Do List for the assignment (First Party assignments only). ^IBE(351.73,CLERK,1,ASSIGN,2) 2.01 DAYS SINCE LAST TRAN 2;1 Direct Global Read & w This field is used to decide if a bill should be included in the To-Do List or not. The bill will be included in the To-Do List only if number of days since the last transaction till the day the To-Do List runs, is not smaller than the number in this field. 2.02 FIRST INSURANCE CARR 2;2 Direct Global Read & w This field is used to identify the first Insurance carrier name of the range of Insurance carriers when generating the To-Do List for the assignment (Third Party assignments only). 2.03 LAST INSURANCE CARRI 2;3 Direct Global Read & w This field is used to identify the first Insurance carrier name of the range of Insurance carriers when generating the To-Do List for the assignment (Third Party assignments only). 2.04 THIRD PARTY-FIRST PA 2;4 Direct Global Read & w This field is used to identify the first name of the patient name range when generating the To-Do List for the assignment (Third Party assignments only). 2.05 THIRD PARTY-LAST PAT 2;5 Direct Global Read & w This field is used to identify the last name of the patient name range when generating the To-Do List for the assignment (Third Party assignments only). 2.06 THIRD PARTY-FIRST SS 2;6 Direct Global Read & w This field is used to identify the first number of last 4SSN of the patient last 4SSN range when generating the To-Do List for the assignment (Third Party assignments only). 2.07 THIRD PARTY-LAST SSN 2;6 Direct Global Read & w This field is used to identify the last number of last 4SSN of the patient last 4SSN range when generating the To-Do List for the assignment (Third Party assignments only). 2.08 TYPE OF RECEIVABLE 2;8 Direct Global Read & w This field is used to identify the type of receivable that should be included in the To-Do List. There are 5 possible types: 1 - Inpatient, 2 - Outpatient, 3 - Prosthetics, 4 - Pharmacy Refill and 5 - All Receivables. ROUTINE: ******************** 3351 NAME: API CALL TO GET DOCUMENT TITLE IEN CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ADVERSE REACTION TRACKING SURGERY MENTAL HEALTH VBECS ADDED 11/27/2007 USAGE: Controlled Subscri ENTERED: APR 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Extrinsic Function $$WHATITLE^TIUPUTU will accept the freetext name of a TIU DOCUMENT DEFINITION of type TITLE, and return its Internal Entry Number in the TIU DOCUMENT DEFINITION File (#8925.1). ROUTINE: TIUPUTU COMPONENT: WHATITLE VARIABLES: X Type: Input This is the freetext name of a valid TIU DOCUMENT DEFINITION of type title. Call the extrinsic function as follows, to determine the IEN of a given title: S TIUTTL=$$WHATITLE^TIUPUTU("ADVERSE REACTION/ALLERGY") I TIUTTL'>0 Q where the single input parameter for the extrinsic function is the name of the title to be identified. Note that the function will return the IEN of the specified title, or -1, if the text passed in the input parameter cannot be resolved as a valid TITLE. ******************** 3352 NAME: INPUT TEMPLATE RECOMPILATION CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION KERNEL FEE BASIS USAGE: Controlled Subscri ENTERED: APR 5,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Recompile compiled input templates that contain specific fields within a file. ROUTINE: DIKCUTL3 COMPONENT: DIEZ VARIABLES: TOPFILE_NO Type: Input File number. (This is the top-level file number, even if the field being searched for in input templates is within a multiple.) FIELD_LIST Type: Input This input parameter is passed by reference, and is an array of file and field numbers, in the format: FIELD_LIST(file#,field)="" and/or FIELD_LIST(subfile#,subfield#)="" This entry point can be called from the Post-Install Routine of a KIDS build to recompile all compiled input templates that contain specific fields. (This is useful when the data dictionary definition of a field is changed and that field is sent in a KIDS build. KIDS does not automatically recompile the input templates that contain that field.) Example: If on file 12345 a new cross-reference is created, and that cross-reference contains fields 11 and 12, the following code will recompile all input templates that contain fields 11 and 12: N ZZFLD,ZZLIST F ZZFLD=11,12 S ZZLIST(12345,ZZFLD)="" D DIEZ^DIKCUTL3(12345,.ZZLIST) ******************** 3355 NAME: EXPORTING NEW ASU STATUS ENTRIES CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: APR 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930.6 ROOT: USR(8930.6, DESCRIPTION: TYPE: File Periodically, when new functions for document management are introduced by applications making use of ASU, it is necessary to introduce new definitions for the state (or status) of the object being acted upon, following the new processing event. One example is support for the retraction of a TIU Document that was entered in error for the wrong patient. To implement retraction, we needed to be able to identify the new status "retracted," and declare business rules specifying privileges for specific users to act on such documents. Such extensions necessitate adding new entries to the USR RECORD STATUS FILE (#8930.6), and distributing them with patches that implement the new functionality. ASU grants permission to TIU to issue such updates to the USR RECORD STATUS FILE (#8930.6), until otherwise agreed. ^WHOLE FILE W/DD This file contains the allowable states (or statuses) which may be applied to objects for which ASU Business Rules may be declared. ROUTINE: ******************** 3356 NAME: Kernel Variable XQY0 CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: REGISTRATION TEXT INTEGRATION UTILITIES WOMEN'S HEALTH USAGE: Controlled Subscri ENTERED: APR 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other Registration requests permission to reference the variable XQY0 to obtain the current menu option. DG FIELD MONITOR logic will be designed to run reguardless of the XQY0 being defined or set to "null". The DG FIELD MONITOR protocol provides an event point to monitor field editing in the DG* application files. Cross references and subscribers are added when applications need to monitor activity on a field. XQY0 contains the current menu option in the option name^menu text format when the cross references and event point are executed. This information is made available to the subscribing applications. Variable: XQY0 = First node(zero subscript) of the current option. Patient Name Standardization uses the XQY0 variable to identify the option name. It will populate the NOTES ABOUT NAME (#11) field in the NAME COMPONENTS (#20) file with the User's name, DUZ, and option name when an entry is added or updated in the Name Components file. ROUTINE: ******************** 3357 NAME: DBIA3357 CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: APR 16,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DD( DESCRIPTION: TYPE: File Inpatient Medications requests an agreement to allow the deletion of the 'V' level for the .01 field of the MAR LABELS file (#53.41). The level was apparently left over when the field was converted from a 'VARIABLE POINTER' data type to a 'SET OF CODES' data type. The 'V' level will be deleted in PSJ*5.0*57 with a direct KILL to the global. ROUTINE: ******************** 3358 NAME: BRIEF CONSULTS HS COMP CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: HEALTH SUMMARY This IA supports the data extract routine used to produce the Consults Brief Health Summary Component. USAGE: Private ENTERED: APR 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 123 ROOT: GMR(123, DESCRIPTION: TYPE: File ^GMR(123,'AD',DFN,INV,IEN Used check to see if the patient (DFN) has a consult (IEN) and to list consults by inverse date (INV). This is a direct global read of an index. ^GMR(123,D0,0 .01 FILE ENTRY DATE 0;1 Read w/Fileman Date the consultation request was entered into the file. Transparent to user. 1 TO SERVICE 0;5 Read w/Fileman This is the service or specialty responsible for completion of the consult request. 2 FROM 0;6 Read w/Fileman This is the location that sent the order to the receiving location. 3 DATE OF REQUEST 0;7 Read w/Fileman This is the date and time the order was released. 8 CPRS STATUS 0;12 Read w/Fileman This is the current CPRS status of the consult or request order. 9 LAST ACTION TAKEN 0;13 Read w/Fileman This is the last action that updated the activity tracking audit trail. 17 CLINICALLY INDICATED 0;24 Read w/Fileman This is the date by which it is clinically appropriate to complete the consult. GMRC*3.0*81 released on 3/8/16 changed the field name from Earliest Date to Clinically Indicated Date. ^GMR(123,D1,40,D0,0 1 ACTIVITY 0;2 Read w/Fileman Consult activity. 2 DATE/TIME OF ACTUAL 0;3 Read w/Fileman The date and time the activity was done. 8 PRINTED TO 0;8 Read w/Fileman This is the printer where the CONSULT FORM 513 was printed. 9 RESULT 0;9 Read w/Fileman This is the result of the activity. 10 ACTION METHOD 0;10 Read w/Fileman The action method will identify how the user performed the action. ROUTINE: ******************** 3359 NAME: DBIA3359 CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE The IRS mail group will be removed in patch PRCA*4.5*169. USAGE: Private ENTERED: APR 23,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.8 ROOT: XMB(3.8 DESCRIPTION: TYPE: File This DBIA allows Accounts Receivable to delete a mail group. The Accounts Receivable code will first look to see if the mail group exists in file 3.8 by looking at the B cross reference on the NAME (.01) field. If the mail group exists, the code will next loop the AD cross reference on the MEMBER GROUP NAME sub-field (.01) of the MEMBER GROUPS field (11) in file 3.8. If the mail group is a member of another mail group, the mail group will be removed from the MEMBER GROUPS field using DIK. Finally, the mail group will be removed using DIK. The following is an example of the code that deletes the IRS mail group: S RCMIRSDA=+$O(^XMB(3.8,"B","IRS",0)) I RCMIRSDA D . ; check to see if IRS mail group is a member of another . ; mail group. If so, delete it from the other mail group. . S RCDA(1)=0 F S RCDA(1)=$O(^XMB(3.8,"AD",RCMIRSDA,RCDA(1))) Q:'RCDA(1) D . . S RCDA=0 F S RCDA=$O(^XMB(3.8,"AD",RCMIRSDA,RCDA(1),RCDA)) Q:'RCDA D . . . S DA(1)=RCDA(1),DA=RCDA,DIK="^XMB(3.8,"_RCDA(1)_",5," . . . D ^DIK . ; . ; delete the mail group . S DA=RCMIRSDA,DIK="^XMB(3.8," . D ^DIK ^XMB(3.8,B, .01 NAME 0;1 Direct Global Read & w Reference to the "B" cross reference for the .01 field. ^XMB(3.8,AD, 11 MEMBER GROUPS 5;0 Direct Global Read & w Reference the "AD" cross reference for the MEMBER GROUPS to determine if a mail group is a member of another mail group. ROUTINE: ******************** 3362 NAME: ACCESS TO FILE OPERATING ROOM FILE (131.7) CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: IFCAP ORDER ENTRY/RESULTS REPORTING INPATIENT MEDICATIONS USAGE: Controlled Subscri ENTERED: APR 27,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 131.7 ROOT: SRS( DESCRIPTION: TYPE: File IFCAP developers are permitted to directly access the NAME field (.01) of the OPERATING ROOM file (131.7) so that this information can be accurately reported on the IFCAP PATIENT DISTRIBUTION COST REPORT. This will resolve a NOIS that was generated due to the fact that previously the report has used the pointer from the SURGERY file (130) field OPERATING ROOM (.02) to access the HOSPITAL LOCATION file (44) field NAME (.01). With this agreement in place IFCAP will be able to use the proper pointer to the HOSPITAL LOCATION file (44) field NAME (.01), namely the NAME field (.01) of the OPERATING ROOM file (131.7). ^SRS( .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 3363 NAME: ORWU DT CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE MENTAL HEALTH FUNCTIONAL INDEPENDENCE INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VISTA INTEGRATION ADAPTOR HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** Effective with HMP*2.0*2 DENTAL CPRS approved adding Dental as a subscriber for Dental Record Manager to this ICR on 8/11/2009 to document existing references. However the update was not made to the ICR until 2/9/18. USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns date in internal VA FileMan format. ROUTINE: DT ORWU ******************** 3364 NAME: ORWLRR CHART CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: CHART ORWLRR ******************** 3365 NAME: ORQQPL PROBLEM LIST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE MENTAL HEALTH ADDED 4/21/2011 USAGE: Controlled Subscri ENTERED: MAR 18,2011 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Parameters: Patient DFN - DFN of patient from VistA Context - The status of problems to return, passed as a single letter: (A)ctive, (I)nactive, (B)oth, (R)emoved. If null, Active problems will be returned. Data is returned in ROOT. ROOT(0) is the number of items returned. Subsequent entries in ROOT are the problems found along with other information. ROOT(#)=1 ifn ^ 2 status ^ 3 description ^ 4 ICD code ^ 5 onset date ^ 6 last modified date ^ 7 Service Connected ("SC","NSC",or "") ^ 8 Special Exposures ^ 9 Condition (T)ranscribed or (P)ermanent ^ 10 Location ^ 11 Location Type ^ 12 Provider (DFN;NAME) ^ 13 Service ^ 14 Priority ^ 15 Has Comment ^ 16 Date Recorded ^ 17 SC Condition ^ 18 Inactive (set to # if the ICD code is inactive) ^ 19 ICD Long Description (for problems with ICD codes only) ^ 20 ICD Coding System Abbreviation (ICD or 10D) Sample return array ROOT(0)=2 ROOT(1)="638^A^Hypertension (ICD-9-CM 401.9)^401.9^3050407^3070410^NSC ^^^^^10000000031;CPRSPROVIDER,FIFTY^1018;MEDICAL^C^0^3070410^NSC^^ UNSPECIFIED ESSENTIAL HYPERTENSION^ICD" ROOT(2)="1035^A^CAD - Coronary Artery Disease (SCT 53741008)^I25.10^ 3170921^3170921^NSC^^P^^^10000000424;CPRSPROVIDER,ONE^^A^1^3170921^NSC ^^^10D" Problem list for CPRS GUI client ROUTINE: PROBL ORQQPL3 ******************** 3366 NAME: ORWORR AGET CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE CLINICAL PROCEDURES Requested to be added on May 16, 2007. BAR CODE EXPANSION added 11/27/2007 VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Get an abbreviated order list for a patient in the format: ^TMP("ORR",$J,ORLIST,n)=IFN^DGrp^ActTm ROUTINE: AGET ORWORR ******************** 3367 NAME: ORWORR GET4LST CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE CLINICAL PROCEDURES Requested to be added May 16, 2007 VISTA INTEGRATION ADAPTOR VA POINT OF SERVICE (KIOSKS) USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the order fields for a list of orders. ROUTINE: GET4V11 ORWORR ******************** 3368 NAME: ORWLRR MICRO CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: MICRO ORWLRR ******************** 3369 NAME: ORWRP1 LISTNUTR CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure ROUTINE: LISTNUTR ORWRP1 ******************** 3370 NAME: DBIA3370 CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS USAGE: Private ENTERED: APR 30,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine For the Pharmacy Ordering Enhancements (POE) project it is necessary to convert the orderable item in the PHARMACY PATIENT file (#55), IV sub-file (#55.01). The same orderable item is also stored in the BCMA MEDICATION LOG file (#53.79). Inpatient Medications is requesting a one-time integration agreement with Bar Code Medication Administration to allow updates to the BCMA MEDICATION LOG file (#53.79) using FileMan. The updates would occur at the time of the POE installation. ROUTINE: PSJ0050 COMPONENT: EN VARIABLES: PSJDFN Type: Input Patient Internal File Number (required) PSJORDER Type: Input Order number to be converted (required) PSJCURR Type: Input Internal entry number for the current orderable item PSJNEW Type: Input Internal entry number for the new orderable item ******************** 3371 NAME: ORWU HASKEY CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: EVENT CAPTURE CARE MANAGEMENT USAGE: Controlled Subscri ENTERED: MAY 4,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns 1 if a user holds a security key, otherwise 0. ROUTINE: ******************** 3372 NAME: TIU TEMPLATE FIELD CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CLINICAL REMINDERS In order for the Clinical Reminders Exchange Utility to transport reminder dialogs it needs to also transport TIU Template Fields. Therefore Clinical Reminders requires read and write access via FileMan to all fields of the TIU Template Fields file. USAGE: Private ENTERED: MAY 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8927.1 ROOT: TIU(8927.1) DESCRIPTION: TYPE: File ROUTINE: ******************** 3373 NAME: PSSUTLA1 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA POINT OF SERVICE (KIOSKS) VISTA INTEGRATION ADAPTOR VIABDX SAVE RPC references PSSUTLA1 routine. VIRTUAL PATIENT RECORD Virtual Patient Record can invoke the PLACER component to retrieve the CPRS Order Number, and the LOC component to retrieve the most appropriate location for a pharmacy order. USAGE: Controlled Subscri ENTERED: MAY 10,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management returns a DEA Special Handling code for a Pharmacy Orderable Item, based on the Dispense Drugs that are matched to that Pharmacy Orderable Item. Pharmacy Data Management also returns the Computerized Patient Record System (CPRS) Order Number when a Pharmacy Order Number is passed into the PLACER component. Pharmacy Data Management also returns the most appropriate Order Location when a Pharmacy Order Number is passed into the LOC component. ROUTINE: PSSUTLA1 COMPONENT: OIDEA(PSSXOI,PSSXOIP) VARIABLES: PSSXOI Type: Input This variable is the internal entry number from the Pharmacy Orderable Item (#50.7) file. PSSXOIP Type: Input This variable can be one of three values. "O" indicates that this call is being made for an Outpatient Pharmacy order. Either an "I" or a "U" indicates that this call is being made for an Inpatient Medications order. $$OIDEA Type: Output This output variable indicates the DEA Special Handling code at the Pharmacy Orderable Item level, based on dispense drugs matched to the Item. This variable can be one of four values, a "1", a "2", a "0", or null. If a "1" is returned, that indicates that there is at least one active dispense drug matched to that Pharmacy Orderable Item for the specified package, that has a DEA Special Handling Code that contains a "1", or contains a "2". This means that a wet signature is required. If a "2" is returned, that indicates that the first condition wasn't met, and that there is at least one active dispense drug matched to that Pharmacy Orderable Item for the specified package, that has a DEA Special Handling Code that contains a "3", or contains a "4", or contains a "5". This means a wet signature is not required, but it does indicate a Controlled Substance. A "0" is returned if neither of the first two conditions are met, but there are active drugs matched to the Pharmacy orderable Item for the specified package. If there are no active drugs for the specified package matched to the Pharmacy Orderable Item, then a null is returned. This entry point will return a DEA Special Handling code for a Pharmacy Orderable Item. COMPONENT: $$PLACER(PSOPDFN,PSOPIEN) VARIABLES: PSOPDFN Type: Input This represents the Internal Entry Number from the PATIENT File (#2). PSOPIEN Type: Input This represents the Pharmacy Order number, in the form of order number followed by the one character uppercase file indicator, as follows: ###P - NON-VERIFIED ORDERS File (#53.1), ###U - UNIT DOSE Subfile (#55.06) of PHARMACY PATIENT File (#55), ###I - IV Subfile (#55.01) of the PHARMACY PATIENT File (#55), ###N - NON-VA MEDS Subfile (#55.05) of the PHARMACY PATIENT File (#55), ###S - PENDING OUTPATIENT ORDERS File (#52.41), ###R - PRESCRIPTION File (#52) For the 'U', 'I' and 'N' entries above, the number represents the Internal Entry Number from the subfile. $$PLACER Type: Output This represents the Internal Entry Number from the ORDER File (#100). (CPRS Order Number). For the Inpatient files (P,U and I), the return value may contain a semicolon followed by another number. In those cases, the CPRS Order Number is the first piece, with ";" as the delimiter. If for any reason a return value cannot be found, a null value is returned. This component returns the CPRS Order Number when a Pharmacy Order Number is passed in. COMPONENT: $$LOC(PSSPDFN,PSSPIEN) VARIABLES: PSSPDFN Type: Input This represents the Internal Entry Number from the PATIENT File (#2). PSSPIEN Type: Input This represents the Pharmacy Order number, in the form of order number followed by the one character uppercase file indicator, as follows: ###P - NON-VERIFIED ORDERS File (#53.1), ###U - UNIT DOSE Subfile (#55.06) of PHARMACY PATIENT File (#55), ###I - IV Subfile (#55.01) of the PHARMACY PATIENT File (#55), ###N - NON-VA MEDS Subfile (#55.05) of the PHARMACY PATIENT File (#55), ###S - PENDING OUTPATIENT ORDERS File (#52.41), ###R - PRESCRIPTION File (#52) For the 'U', 'I' and 'N' entries above, the number represents the Internal Entry Number from the subfile. $$LOC Type: Output This represents the most appropriate order location of the pharmacy order. It is a 3 piece return with a '^' delimiter, as follows: Piece 1 = Internal Entry Number for the entry being returned. Piece 2 = The .01 field of the entry being returned. Piece 3 = The file number that the entry being returned belongs to. It can be one of 4 values: 4 (INSTITUTION) 40.8 (MEDICAL CENTER DIVISION) 42 (WARD LOCATION) 44 (HOSPITAL LOCATION) If for any reason a value cannot be determined for the order, the default institution from the INSTITUTION File (#4) is returned. This component returns the order location when a Pharmacy Order Number is passed in. ******************** 3374 NAME: DBIA3374 CUSTODIAL PACKAGE: ACCOUNTS RECEIVABLE SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: MAY 10,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing has permission to make the following call to AR to determine if AR has cancelled a specific receivable associated with a bill. The IB option [IB CANCEL BILL] allows a clerk to cancel a bill which then invokes the call $$CANCEL^RCBEIB. ROUTINE: RCBEIB COMPONENT: $$CANCEL(PRCASV(ARREC),PRCASV(DATE),PRCASV(BY),PRCASV(AMT),PRCASV (COMMENT),PRCASV(CRD)) VARIABLES: ARREC Type: Input Ien of the BILL/receivable in ACCOUNTS RECEIVABLE file (#430) that needs to be cancelled. DATE Type: Input This is the date the bill was cancelled. This parameter is optional. BY Type: Input This is the DUZ of the person cancelling the bill. This parameter is optional. AMT Type: Input This is the "$" amount of the bill being cancelled. This parameter is optional. COMMENT Type: Input This is the reason the clerk cancelled the bill. This parameter is optional. X Type: Output The value returned by this function is a string that contains two fields seperated by "^" (up-arrow) and addresses the following 2 scenarios: Receivable has been Cancelled returns a 1 in the first piece and the second piece is null. < i.e. > 1 Receivable has not been Cancelled returns a 0 in the first piece and if available returns the reason why in second piece. "0^reason why goes here" CRD Type: Input This is the IB Correction flag. It is used to notify AR and FMS that the user is in the Correct Rejected/Denied Claim Option. This function returns information on a specific receivable associated with a bill. Please note this package limits the input of variables using string subscripts i.e. the variable PRCASV("ARREC") cannot be entered because it contains "". Also this package limits the display variables to 10 characters then truncates. The correct call from IB to AR is S X=$$CANCEL^RCBEIB($G(PRCASV("ARREC")),$G(PRCASV("DATE")), $G(PRCASV("BY")),$G(PRCASV("AMT")),$G(PRCASV("COMMENT")),$G(PR CASV("ARCRD"))). ******************** 3375 NAME: CREATE/DELETE TIU DOCUMENT RECORDS CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CLINICAL PROCEDURES MENTAL HEALTH INSURANCE CAPTURE BUFFER ADDED JUNE 2009 VA POINT OF SERVICE (KIOSKS) ORDER ENTRY/RESULTS REPORTING Added 3/23/20 for the PDMP project. USAGE: Controlled Subscri ENTERED: MAY 14,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Clinical Procedures will be using the MAKE^TIUSRVP API to create TIU Document records and the DELETE^TIUSRVP API to delete TIU DOCUMENT records. ROUTINE: TIUSRVP COMPONENT: MAKE(SUCCESS,DFN,TITLE,VDT,VLOC,VSIT,VSTR,TIUX,SUPPRESS) VARIABLES: SUCCESS Type: Both SUCCESS returns TIU DOCUMENT # (Pointer to TIU Document file #8925). (Passed By Reference) DFN Type: Input Patient IEN (Patient file #2). TITLE Type: Input Pointer to TIU DOCUMENT DEFINITION file (#8925.1). VDT Type: Input Date(/Time) of Visit. VLOC Type: Input Visit Location (pointer to HOSPITAL LOCATION file #44). VSIT Type: Input Pointer to VISIT file (#9000010). TIUX Type: Input Array containing identifying fields of the document. VSTR Type: Input This parameter identifies the visit location, date/time, and Service Category (Hospitalization, Ambulatory, Telecommunications, or Event (HISTORICAL)) in the form of a semi-colon delimited string (e.g., "469;2970616.1415;A"). SUPPRESS Type: Used BOOLEAN flag indicating whether or not to suppress execution of the COMMIT ACTION for the document in question. This gives the calling application control over the circumstances in which the COMMIT CODE should be executed. COMPONENT: DELETE(ERR,TIUDA,TIURSN) VARIABLES: ERR Type: Both Returns error message with ERR=1^Explanation text if the user is NOT authorized to delete the named record. (Passed By Reference) TIUDA Type: Input Record number of TIU Document to be deleted. TIURSN Type: Used This optional parameter specifies the reason for deletion (i.e., Privacy Act, or Administrative Action). ******************** 3376 NAME: DBIA3376 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CLINICAL PROCEDURES SURGERY USAGE: Controlled Subscri ENTERED: MAY 14,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925,DA,0) DESCRIPTION: TYPE: File This IA will document the fact that in the CP TRANSACTION file (#702) has a field called TIU NOTE (Field #.06) which points to the TIU DOCUMENT file (#8925). ^TIU(8925,DA,0) .01 DOCUMENT TYPE 0;1 Pointed to ROUTINE: ******************** 3377 NAME: DBIA3377 CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: MAY 14,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: TIU(8925.1,DA,0) DESCRIPTION: TYPE: File This IA is to document the fact that the CP DEFINITION file (#702.01) has a field called DEFAULT TIU NOTE (Field #.04) which points to the TIU DOCUMENT DEFINITION file (#8925.1). This IA also documents the fact that field (#.05), USE TIU NOTE TITLE, of the Sub-file (#703.91), MEDICINE FILE PARAMETERS, in the CP CONVERSION file (#703.9) points to the TIU DOCUMENT DEFINITION file (#8925.1). ^TIU(8925.1,DA,0) .01 NAME 0;1 Pointed to ROUTINE: ******************** 3378 NAME: DBIA3378 CUSTODIAL PACKAGE: CLINICAL PROCEDURES SUBSCRIBING PACKAGE: CONSULT/REQUEST TRACKING Consult will be calling the $$EXTDATA(MDPROC) entry point to determine whether the procedure requires external data. TEXT INTEGRATION UTILITIES TIU will be calling the $$TIUCOMP(MDNOTE) entry point to complete the CP transaction, the $$TIUDEL(MDNOTE) entry points to update Clinical Procedures that a TIU document is deleted, and $$TIUREAS(MDFN,MDOLDC, MDANOTE,MDNDFN,MDNEWC,MDNEWV,MDNTIU) entry point to clean up and update a TIU document re-assignment. IMAGING Imaging will be calling the ISTAT(MDARR) entry point to update Clinical Procedures with the result of the image(s) being copied to the Imaging Server. USAGE: Controlled Subscri ENTERED: APR 7,2005 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA documents calls to MDAPI. ROUTINE: MDAPI COMPONENT: $$EXTDATA(MDPROC) VARIABLES: MDPROC Type: Input The CP Definition IEN from CP DEFINITION file (702.01) $$EXTDATA Type: Output This is an extrinsic function and it returns: 1/0 for Yes/No. Entry Point to check if a medical device is associated with the CP Definition. COMPONENT: $$TIUCOMP(MDNOTE) VARIABLES: MDNOTE Type: Input The TIU Document IEN from TIU DOCUMENT file (#8925). $$TIUCOMP Type: Output This is an Extrinsic Function and it returns: 0/1 for fail/success of transaction completion. Entry Point to complete a CP transaction. COMPONENT: $$TIUDEL(MDNOTE) VARIABLES: MDNOTE Type: Input The TIU Document IEN from TIU DOCUMENT file (#8925). $$TIUDEL Type: Output This is an extrinsic Function and it returns: 0/1 for fail/success of the TIU Note deletion update. Entry Point to clean up the CP Transaction file entry of the TIU Note that was deleted. COMPONENT: ISTAT(MDARR) VARIABLES: MDARR Type: Input An array of the following: MDARR(0)="0^error message" or "1^success message" MDARR(1)=TrackID (CP;Transaction IEN) MDARR(2)=Image(s) Queue Number MDARR(3..N)=Warnings, if error(s) exist. Entry Point to update Clinical Procedures of the result of the image(s) that was copied to the Imaging Server. COMPONENT: ITIU(RESULTS,DFN,CONSULT,VSTRING) VARIABLES: RESULTS Type: Output RESULTS(0) will equal one of the following (Required) ; IEN of the TIU note if successful ; or on failure one of the following status messages ; -1^No patient DFN ; -1^No Consult IEN ; -1^No VString ; -1^Error in CP transaction ; -1^Unable to create CP transaction ; -1^Unable to create the TIU document ; -1^No such consult for this patient. DFN Type: Input Patient IEN. (Required) CONSULT Type: Input Consult IEN. (Required) VSTRING Type: Input VString data for TIU Note. (Required) This entry point enables VistA Imaging to retrieve/create a TIU note for a consult for attaching images to. COMPONENT: $$TIUREAS(MDFN,MDOLDC,MDANOTE,MDNDFN,MDNEWC,MDNEWV,MDNTIU) VARIABLES: MDFN Type: Input Patient DFN in Patient File (#2). MDOLDC Type: Input The old consult number that the TIU note is being re-assigned from. MDANOTE Type: Input The TIU Note internal Entry Number that is being re-assigned. MDNDFN Type: Input The patient DFN who will be re-assigned to the TIU document. MDNEWC Type: Input The new consult number that will be re-assigned to the TIU document. MDNEWV Type: Input The new visit for the TIU document assignment. MDNTIU Type: Input The new re-assigned TIU document internal entry number. $$TIUREAS Type: Output This is an extrinsic function and it returns: 1 for Success or 0^Error Message. This entry point enables TIU to notify CP that a TIU note was reassigned and CP needs to clean up and update the TIU note re-assignment. ******************** 3380 NAME: PSB VALIDATE ESIG CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure PSB VALIDATE ESIG is used to validate the data in PSBESIG against the user currently signed on (DUZ). Validate the data in PSBESIG against the user currently signed on (DUZ) ROUTINE: ESIG PSBRPC ******************** 3382 NAME: PSB FMDATE CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Used to validate Fileman dates. Used to validate Fileman dates. ROUTINE: FMDATE PSBRPC ******************** 3383 NAME: PSB SCANPT CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC is used to validate the data scanned in at the scan patient wristband prompt of the mnOpenPatient component. The value passed in is either the full SSN scanned in from the patient wristband -or- the 1U4N syntax of the patient lookup. In either case the call must return only one patient from the lookup. If the 1U4N syntax is used and multiple patients are found the call returns an error. If only one patient is found the RESULTS array is loaded with the patient data and passed back to the client for verification. This RPC is used to validate the data scanned in at the scan patient wristband prompt of the mnOpenPatient component. The value passed in is either the full SSN scanned in from the patient wristband -or- the 1U4N syntax of the patient lookup. In either case the call must return only one patient from the lookup. If the 1U4N syntax is used and multiple patients are found the call returns an error. If only one patient is found the RESULTS( ) array is loaded with the patient data and passed back to the client for verification. ROUTINE: SCANPT PSBRPC ******************** 3384 NAME: PSB USERLOAD CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This RPC is called at application startup to populate the BCMA_User object with the users defaults. No paramters are passed, the current DUZ is assumed. This RPC is called at application startup to populate the BCMA_User object with the users defaults. No paramters are passed, the current DUZ is assumed. ROUTINE: USRLOAD PSBRPC ******************** 3385 NAME: PSB DISPLAY ORDER CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns a display for a selected order when double clicked on the VDL. ROUTINE: DISPORD PSBRPC ******************** 3386 NAME: PSB GETPRNS CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns all administrations of a PRN order that have NOT had the PRN Effectiveness documented for the last 30 days. Returns all administrations of a PRN order that have NOT had the PRN Effectiveness documented for the last 30 days. ROUTINE: GETPRNS PSBPRN ******************** 3387 NAME: PSB GETORDERLIST CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the current order set for today to display on the client VDL. Using the input paramter DFN and ORDDATE a call is made to an Inpatient Meds API to return all active orders for a patient in Unit Dose, IV's and Pending Orders. These are returned to the client and the client will then begin retrieving each order with RPC PSB GETORDER. ROUTINE: RPC PSBVDL1 ******************** 3388 NAME: PSB REACTIONS CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns detailed listing of reactions when Reactions Button is clicked. Returns reactions from server call to EN1^GMRADPT. ROUTINE: REACT PSBRPC ******************** 3389 NAME: PSB SERVER CLOCK VARIANCE CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 21,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Returns the variance from the server to the client in minutes. Client date/time in external FileMan format. Returns the variance from the server to the client in minutes. ROUTINE: CLOCK PSBUTL ******************** 3390 NAME: PSB VALIDATE ORDER CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 22,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Final check of order against an actual administration date/time used immediately after scanned med has been validated to be a good unadministered order and by the PSBODL (Due List) output. ROUTINE: EN PSBVDLVL ******************** 3391 NAME: PSB PARAMETER CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 22,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Return a parameter list. Called by client to return or set parameters ROUTINE: RPC PSBPAR ******************** 3395 NAME: PSB TRANSACTION CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 22,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This is the filing RPC for all data returning from the client regarding the medication log. Filing is handled by business rules on the server and this RPC will return either '1^Data Filed' or '-1^reason for not filing data' to the client. Business rules are conducted via the [0] node data. If a '+1^MEDPASS' is encountered it is a complete new med pass and is validated as such. Transaction type MEDPASS is the only type that requires a +1 in the first piece of the header, all other transactions MUST supply a valid medication log entry in the IENS. This is the filing RPC for all data returning from the client regarding the medication log. Filing is handled by business rules on the server and this RPC will return either '1^Data Filed' or '-1^reason for not filing data' to the client. Results of the processed transaction is communicated via the RESULTS array. The number of RESULTS subscripts used (n) will be presented in RESULTS[0]. RESULTS [1..n] will contain the RESULTS message. Business rules are conducted via the [0] node data. If a '+1^MEDPASS' is encountered it is a complete new med pass and is validated as such. Transaction type MEDPASS is the only type that requires a +1 in the first piece of the header, all other transactions MUST supply a valid medication log entry in the IENS. The data for filing is passed in as a list in Param[1] as shown below. Example Delphi Call with RPCBroker1 do begin RemoteProcedure := 'PSB TRANSACTION'; Param[0].Value := '88484^COMMENT'; Param[0].PType := Literal; Param[1].Mult['0'] := 'Comment for the med pass'; Param[1].Ptype := List; Call; end; ------------------------------------------------------------------------- TRANSACTION = MEDPASS Note: Entries 1-6 are required, 7,8,9 are required depending on item [2] order type... [0] = Patient IEN [1] = IV/Unit Dose Order Number Note: will be passed in as I;#### for IV and U;#### for Unit Dose future release will allow P;#### for pending [2] = Schedule Note: C:Continuous P:PRN 1:One Time O:On Call [3] = Status Note: G:Given H:Held R:Refused [4] = Orderable Item Note: IEN to 'PHARMACY ORDERABLE ITEM' (#50.7) [5] = Scheduled Administration Date/Time Note: This is when the med is scheduled, med is entered as GIVEN NOW! [6] = Reason Given PRN^PRN Reason Flag Note: Required if given PRN must be null if not PRN [7] = Comment Note: 1-200 characters [8] = Injection Site [9] = Tab^Unique ID # [10..n]= RecordType^IEN^Units Ordered^Units Given^Units Type Record Type = DD: Dispense Drug SOL: Solution ADD: Additive IEN = Internal Entry Number of the following if Record Type = DD: DRUG (FILE #50) SOL: IV SOLUTIONS (FILE #??) ADD: IV ADDITIVES (FILE #??) Units Ordered = Number of units in the Inpt Meds Order Units Given = Number of units scanned/entered by the user Units Type = Type of administration unit (i.e. TAB, CAPLET, ML) ------------------------------------------------------------------------- TRANSACTION = COMMENT [0] = Comment to append to the log entry Note: Will be appended to the log with user ien and NOW as a date ------------------------------------------------------------------------- TRANSACTION = PRN EFFECTIVENESS [0] = Effective Comment Note: will be filed as entered now by current user ------------------------------------------------------------------------- TRANSACTION = STATUS UPDATE [0] = New Status Note: If status is Given, Date/Time administered D/T will be set to NOW If status is Held/Refused administered D/T will be set to null Status on med log must be <> null to execute. New status must NOT match current status or G will overwrite administration DT. [1] = Comment Note: Comment *IS* Required ------------------------------------------------------------------------- TRANSACTION = EDIT [0] = Action Status [1] = Patient DFN [2] = Inf/Inj Site [3] = IV Unique ID [4] = Admin Date/Time (fileman format) [5] = Prn Reason [6] = Prn Effectiveness [7] = Comment Note: comment data is required! [8] = "DD/ADD/SOL^ Drug IEN ^ Dose Ordered ^ Dose Given ^ Unit of Administration" [n] = "additional data per DD/ADD/SOL associated with order." ROUTINE: RPC PSBML ******************** 3396 NAME: PSB SUBMIT MISSING DOSE CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 22,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: Version 1.0 FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Allows the client to submit a missing dose interactively. Allows the client to submit a missing dose interactively. ROUTINE: RPC PSBMD ******************** 3397 NAME: Medicine Report Support CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES USAGE: Private ENTERED: MAY 29,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: TMP('OR',$J,'MCAR' DESCRIPTION: TYPE: File This DBIA documents the setting of data into a ^TMP global that is used by CPRS to get a list of patient procedures for display on the CPRS Reports Tab. See DBIA #2757 for related information on API's used. ^TMP('OR',$J,'MCAR' Global containing a list of procedures for display in OE/RR. Located at ^TMP("OR",$J,"MCAR", This temporary global is sorted by either inverse date or Procedure Name, based on input parameters. Subscripts S1 and S2 hold the sort values. The sorted version of the TMP global is used for selection of procedures. The second version is used as input to produce the report. $P(^TMP("OR",$J,"MCAR",S1,S2),U,1)=Gross Evaluation ...),U,2)=Pointer to Procedure ...),U,3)=Print Routine (Field #5 from file 697.2) ...),U,4)=Print Line (Field #6 from file 697.2) ...),U,5)=Print Name (Field #7 from file 697.2) ...),U,10)=Summary Title ...),U,11)=Procedure Name ...),U,12)=Print Name_"/"_Procedure Name $P(^TMP("OR",$J,"MCAR","OT",L),U,1)=Print Name ...),U,2)=Pointer to Procedure ...),U,3)=Print Routine ...),U,4)=Print Line ...),U,5)=Print Name ...),U,6)=Date/time of procedure ...),U,7)=Gross Evaluation ...),U,10)=Summary Title ...),U,11)=Inverse date or Procedure (depends on sort) ...),U,12)=Procedure or Inverse date (depends on sort)^ ROUTINE: ******************** 3399 NAME: ROUTINE SCUTBK3 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION USAGE: Controlled Subscri ENTERED: MAY 30,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine In support of hte Smart Card initiative the Registration Package needs the use of Scheduling APIs contained in this routine. ROUTINE: SCUTBK3 COMPONENT: VERPAT VARIABLES: SCPATCH Type: Input Server patch^Client version SCRESULT Type: Output 0 - Cannot continue 1 - Continue n - RPC Time Limit Entry point for RPC to check client/server pair ******************** 3400 NAME: FILE 404.45 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION This agreement will allow the Registration package to keep track of client/server pairs at the local site, and server version on the remote site for the Network Data Retrieval functionality of the Smart Card initiative. USAGE: Controlled Subscri ENTERED: MAY 30,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.45 ROOT: SCTM(404.45 DESCRIPTION: TYPE: File In support of the Smart Card initiative the Registration package needs to use file 404.45 - PCMM SERVER PATCH file. ^SCTM(404.45 .01 SERVER PATCH NUMBER 0;1 Direct Global R/W & w/ Field holds the patch number of the server software. .02 ASSOCIATED CLIENT 0;2 Direct Global R/W & w/ Field holds the client version allowed for this server patch number. .03 EFFECTIVE DATE 0;3 Direct Global R/W & w/ Date this server patch became active. .04 ACTIVE SERVER VERSIO 0;4 Direct Global R/W & w/ A yes/no field showing whether or not htis server version is active. ROUTINE: ******************** 3401 NAME: FILE 404.46 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: REGISTRATION This agreement will allow the Registration package to keep track ofclient/server pairs at the local site, and server version on the remotesite for the Network Data Retrieval functionality of the Smart Cardinitiative. USAGE: Controlled Subscri ENTERED: MAY 30,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 404.46 ROOT: SCTM(404.46 DESCRIPTION: TYPE: File In support of the Smart Card initiative the Registration package needs to use file 404.46 - PCMM CLIENT PATCH file. ^SCTM(404.46 .01 CLIENT VERSION NUMBE 0;1 Direct Global R/W & w/ Field holds a client version number. .02 CLIENT VERSION ENABL 0;2 Direct Global R/W & w/ Yes/No field showing whether or not this client version is active. .03 EFFECTIVE DATE 0;3 Direct Global R/W & w/ Date this version became active. .04 ASSOCIATED RPC VERSI 0;4 Direct Global R/W & w/ Patch number for the appropriate server version. ROUTINE: ******************** 3402 NAME: DG SENSITIVE RECORD ACCESS CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 15,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure Call (RPC) will: - Verify user is not accessing his/her own Patient file record if the Restrict Patient Record Access (#1201) field in the MAS parameters (#43) file is set to yes and the user does not hold the DG RECORD ACCESS security key. If parameter set to yes and user is not a key holder , a social security number must be defined in the New Person file for the user to access any Patient file record. - Determine if user accessing a sensitive record or an employee's record. This Remote Procedure Call (RPC) will: - Verify user is not accessing his/her own Patient file record if the Restrict Patient Record Access (#1201) field in the MAS parameters (#43) file is set to yes and the user does not hold the DG RECORD ACCESS security key. If parameter set to yes and user is not a key holder , a social security number must be defined in the New Person file for the user to access any Patient file record. - Determine if user accessing a sensitive record or an employee's record. ROUTINE: PTSEC DGSEC4 ******************** 3403 NAME: DG SENSITIVE RECORD BULLETIN CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: MAY 15,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure Call (RPC) will add an entry to the DG SECURITY LOG (#38.1) file and/or generate the sensitive record access bulletin depending on the value in ACTION input parameter. If ACTION parameter not defined, defaults to update DG Security Log file and generate Sensitive Record Access mail message. This Remote Procedure Call (RPC) will add an entry to the DG SECURITY LOG (#38.1) file and/or generate the sensitive record access bulletin depending on the value in ACTION input parameter. If ACTION parameter not defined, defaults to update DG Security Log file and generate Sensitive Record Access mail message. ROUTINE: NOTICE DGSEC4 ******************** 3404 NAME: UPDATE NEW-STYLE X-REF ONLY CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION USAGE: Private ENTERED: JUN 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .11 ROOT: DD( DESCRIPTION: TYPE: File Registration is requesting to export New Style-Cross References to registration files by setting the ^DD("IX" global nodes of the INDEX file using UPDATE^DIE and WP^DIE. This methodology allows us to create New Style cross-references without exporting the field itself. Listed below is an example how the Filer Array would be populated. ;Create filer array S DGFDA(.11,"+1,",.01)= ;FILE NUMBER S DGFDA(.11,"+1,",.02)= ;X-REF NAME S DGFDA(.11,"+1,",.11)="This X-ref invokes DG FIELD MONITOR " ;SHORT DESCRIPTION S DGFDA(.11,"+1,",.2)= ;TYPE S DGFDA(.11,"+1,",.4)= ;EXECUTION S DGFDA(.11,"+1,",.41)= ;ACTIVITY S DGFDA(.11,"+1,",.5)= ;ROOT TYPE S DGFDA(.11,"+1,",.51)= ;ROOT FILE NUMBER S DGFDA(.11,"+1,",.42)= ;USE S DGFDA(.11,"+1,",1.1)= ;SET LOGIC S DGFDA(.11,"+1,",2.1)= ;KILL LOGIC ;CROSS REFERENCE VALUES S DGFDA(.114,"+2,+1,",.01)= ;ORDER NUMBER S DGFDA(.114,"+2,+1,",1)= ;TYPE OF VALUE S DGFDA(.114,"+2,+1,",2)= ;FILE NUMBER S DGFDA(.114,"+2,+1,",3)= ;FIELD NUMBER S DGFDA(.114,"+2,+1,",7)= ;COLLATION ;DESCRIPTION S DGWP(1)="This cross reference activates the DG FIELD MONITOR event point." S DGWP(2)="Applications that wish to monitor edit activity related to this field may" S DGWP(3)="subscribe to that event point and take action as indicated by the changes" S DGWP(4)="that occur. Refer to the DG FIELD MONITOR protocol for a description of" S DGWP(5)="the information available at the time of the event." ;File INDEX record D UPDATE^DIE("","DGFDA","DGIEN","DGERR") I $D(DIERR) D Q ;CHECK FOR ERROR .N DGI S DGI="" .F S DGI=$O(DGERR("DIERR",1,"TEXT",DGI)) Q:DGI="" D ..D MES^XPDUTL(DGERR("DIERR",1,"TEXT",DGI)) ;DISPLAY ERROR ..Q .Q ;File DESCRIPTION field D WP^DIE(.11,DGIEN(1)_",",.1,"","DGWP") ;FILE DESCRIPTION Q ^DD('IX' ROUTINE: ******************** 3405 NAME: TRIG DICR CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: REGISTRATION KERNEL USAGE: Controlled Subscri ENTERED: JUN 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Registration is requesting to use TRIG^DICR for the purposes of updating the trigger logic when exporting New Style-Cross References in conjunction with DBIA 3404 to registration files. Usage of this routine is outlined below. TRIG^DICR(.fieldList,.outputList) Where, fieldList = (Input) Array of file/fields that may be triggered. The trigger logic of fields that trigger the fields in this list is modified, as necessary. Format: fieldList(file#,field#)="" outputList = (Output) This array is returned with the list of fields whose trigger logic was modified. Format: outputList(file#,field#)="" ROUTINE: DICR COMPONENT: TRIG VARIABLES: fieldlist Type: Input outputlist Type: Output ******************** 3406 NAME: MPIF* OPTIONS EXPORTED IN RG* PATCH CUSTODIAL PACKAGE: MASTER PATIENT INDEX VISTA SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: JUN 20,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Other MPI/PD exports some MPIF* namespaced options in RG*1.0*19. The following options are distributed via KIDS as "ATTACH TO MENU." Master Patient Index Menu [MPIF VISTA MENU] Coordinating Master of Record (CMOR) Request [MPIF CMOR MGR] Patient File Initialization to MPI [MPIFINIT DPT TO MPI] Site Parameters Edit for CMOR [MPIF SITE PARAMETER] ROUTINE: ******************** 3409 NAME: DIRECT READ OF USER CLASS FILE CUSTODIAL PACKAGE: AUTHORIZATION/SUBSCRIPTION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES TIU needs to make this lookup in order to see if a USER class exists. USAGE: Private ENTERED: NOV 29,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8930 ROOT: USR(8930 DESCRIPTION: TYPE: File TIU requests the ability to directly read the "B" cross reference of USR(8930 (The ASU User Class File #8930). This is to support the ability to check if a specific USER class exists. ROUTINE: ******************** 3410 NAME: 3410 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES TIU needs the ability to perform direct global reads on the REMINDER DIALOG FILE (801.41). The purpose is to create linkage between the Reminder dialogs and the TIU Templates. USAGE: Controlled Subscri ENTERED: OCT 28,2004 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 801.41 ROOT: PXRMD(801.41) DESCRIPTION: TYPE: File Clinical Reminders is allowing access to the Reminder Dialog file. ^PXRMD(801.41,D0,0) 3 DISABLED 0;3 Direct Global Read & w This field disables use of this dialog when it contains text. The text should be a short message explaining why use of this dialog has been disabled, as it will be displayed if this dialog is selected. 4 TYPE 0;4 Direct Global Read & w This field defines what type of dialog component this entry is. The type determines the processing that can occur with this entry. 10 COMPONENTS 10,0 Direct Global Read & w This field contains the components that are used to process a reminder. Generally the components relate to the TYPE of entry in the Reminder Dialog File. Reminder dialogs have dialog group or dialog element components. Dialog groups have a combination fo dialog element components. Dialog elements have prompt and forced value components. ^PXRMD(801.41,D0,100) 100 CLASS 100;1 Direct Global Read & w This is the class of a dialog. It is used to seperate the National dialogs that can't be edited except by a programmer and the LOCAL and/or VISN level dialogs that can be edited by local and visn level users. ^PXRMD(801.41,DA(1),10,B,DA) This is a cross reference on node 10 allowing for searching for necessary entries. ^PXRMD(801.41,D0,10,D1,0) 2 ITEM 0;2 Direct Global Read & w This field points to a dialog which is subordinate to this dialog. NOTE: The parent dialog menu or one of its ancestors may not be entered as an item. .01 SEQUENCE 0;1 Direct Global Read & w This field specifies the order in which this itme will be displayed or processed. ROUTINE: ******************** 3411 NAME: DBIA3411 CUSTODIAL PACKAGE: CLINICAL REMINDERS SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS Once off DBA for patch PSJ*5*61. USAGE: Private ENTERED: JUN 25,2001 STATUS: Active EXPIRES: JAN 1,2002 DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Routine to delete the reminder patient data cache for a selected patient. ROUTINE: PXRMPINF COMPONENT: KILLPC VARIABLES: PXRMDFN Type: Input Patient identifier in the format "PXRMDFN"_DFN The routine may be called directly D KILLPC^PXRMPINF(PXRMDFN). If there is an error in reminder evaluation after the install of patch PSJ*5*61 this is probably due to erroneous patient cache entries created within the prior 24 hours. The routine deletes the patient cache for a selected patient causing the cache to be rebuilt by the reminder evaluation process. ******************** 3412 NAME: Print Encounter Forms CUSTODIAL PACKAGE: AUTOMATED INFO COLLECTION SYS SUBSCRIBING PACKAGE: REGISTRATION USAGE: Supported ENTERED: JUN 25,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The Registration package needs to be able to Print an Encounter Form while Registering a Patient through the GUI Registration. ROUTINE: IBDF1B1 COMPONENT: APPT VARIABLES: DFN Type: Input This is the IEN of the Patient file (#2). IBAPPT Type: Input This is the time/date NOW, as derived from NOW^%DTC. IBCLINIC Type: Input This variable holds the clinic location IEN (file #44, pointed to by the .01 field of file 409.95). IBDT Type: Input IBDT is the same as DT. ******************** 3415 NAME: DBIA3415 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JUN 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Pharmacy Data Management will invoke this CPRS routine for conversions, as part of the install process of phase 2 of the Pharmacy Ordering Enhancements project. This phase 2 is released as 1 build, containing patches OR*3*94, PSJ*5*50, PSO*7*46 and PSS*1*38. ROUTINE: ORY94 COMPONENT: POST VARIABLES: This routine loops though all of the Pharmacy quick orders stored in CPRS to fix the following two problems. 1. CPRS looks for any Pharmacy quick orders that use Orderable Items that Pharmacy Data Management has inactivated and makes a call to see if Pharmacy Data Management has a new Orderable Item to replace the old Orderable Item. If a new Orderable Item is returned, CPRS updates the quick order automatically. If a new Orderable Item is not returned, a bulletin is generated at the end of the Post-Init that contains a list of all quick orders that still have inactive Orderable Items, and the bulletin is sent to the user who ran the install. 2. Because this patch changes the way that dose instructions are prompted for in the Outpatient ordering dialog, the same routine will also attempt to convert the dose saved with Outpatient quick orders into the new format. Any quick order that cannot be automatically converted will be listed in the bulletin generated at the end of the Post-Init. ******************** 3416 NAME: DBIA3416 CUSTODIAL PACKAGE: INPATIENT MEDICATIONS SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: JUN 27,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this API is to allow Bar Code Medication Administration (BCMA) to expire/reinstate Inpatient Medications orders based on an administration event. ROUTINE: PSJBCMA4 COMPONENT: ENE(DFN,ON) VARIABLES: DFN Type: Input Internal Entry number for the patient. (Required) ON Type: Input Order number (from the PHARMACY PATIENT file) to be udpated. (Required) The ENE component allows the expiration of an Inpatient Medications order with a schedule type of one-time. The order must be at an Active status and the stop date must be in the future. COMPONENT: ENR(DFN,ON) VARIABLES: DFN Type: Input Internal Entry number for the patient. (Required) ON Type: Input Order number (from the PHARMACY PATIENT file) to be udpated. (Required) The ENR component allows the reinstatement of an Inpatient Medications order. The order must have been expired at the request of BCMA and the original stop date must be in the future. ******************** 3417 NAME: EXAM STATUS ORDER CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary looks for an 'Examination Status' order of 9 - Completed for displaying examinations within a range of dates of a visit or an admission. USAGE: Controlled Subscri ENTERED: JUN 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 72 ROOT: RA(72, DESCRIPTION: TYPE: File As data is gathered, it may be stored in ^TMP("RAE",$J, which global may be killed before and after use. ^RA(72,D0,0) 3 ORDER 0;3 Read w/Fileman This field contains the logical order that this exam status falls into. Exam status 'CANCELLED' is reserved and has an order of '0'. Exam status 'COMPLETE' is reserved and has an order of '9'. ROUTINE: ******************** 3420 NAME: NOK Work Phone CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING HEALTH SUMMARY USAGE: Controlled Subscri ENTERED: JUL 19,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File CPRS GUI users have requested to see the Next-of-Kin's work phone number on the CPRS patient inquiry display. Other NOK data is pulled from VADPT, but work phone is not available. After discussing with Mary Marks on a FORUM message, it was decided that we should enter an integration agreement to reference this field until such time as VADPT can be modified to add the work number to the array returned. ^DPT(2, .21011 K-WORK PHONE NUMBER .21;11 Direct Global Read & w ROUTINE: ******************** 3422 NAME: DBIA3422 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: JUL 23,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 391.71 ROOT: VAT(391.71, DESCRIPTION: TYPE: File MPI/PD requires read only access to ^VAT(391.71,"AXMIT" to order through the cross-reference and get a count of the number of Treating Facility Updates and Data Updates waiting to be processed. ^VAT(391.71,'AXMIT' ^VAT(391.71,'C' ROUTINE: ******************** 3423 NAME: DBIA3423 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 25,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This call provides a Schedule validation check for medication orders entered through Computerized Patient Record System (CPRS). ROUTINE: PSSGS0 COMPONENT: EN(X,PSSLSTPK) VARIABLES: X Type: Input This variable is passed by reference. It is the Schedule entered for the medication order. PSSLSTPK Type: Input This variable is the pharmacy package for which the order is being entered. "O" will be for Outpatient orders, "I" will be for Inpatient orders. X Type: Output If the Schedule passed this validation checks, the value will be the Schedule, as it was passed in. If the Schedule did not pass the validation checks, this variable will be undefined. This call is used by CPRS Listman to validate a Schedule that is entered for a medication order. This call can be interactive, depending on the Schedule and file set-up, possibly prompting the user to select between duplicate schedules. ******************** 3424 NAME: DBIA3424 CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: JUL 25,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine When phase 2 of the Pharmacy Ordering Enhancements project is installed, a rematching process will occur at the time of install, where IV Additives and IV Solutions will be matched to new Pharmacy Orderable Items. Pharmacy needs to provide this new information to CPRS, so CPRS can update as many of their Quick Orders as possible. The old pointer values will be stored in an XTMP global for 30 days to assist in this process. ROUTINE: PSSQORD COMPONENT: $$EN(PSS1,PSS2) VARIABLES: PSS1 Type: Input This variable is the internal number from the PHARMACY ORDERABLE ITEM (#50.7) File. PSS2 Type: Input This variable is the internal number from the DRUG (#50) File. $$EN Type: Output This variable can be one of three values: "-1" indicates that a new Pharmacy Orderable Item could not be found. "#^0^date" indicates a Pharmacy Orderable Item was found, but the item is inactive. Piece 1 is the internal entry number from the PHARMACY ORDERABLE ITEM (#50.7) File, piece 2 is "0" indicating the item is inactive, and piece 3 is the inactive date. "#^1" indicates a Pharmacy Orderable Item was found. Piece 1 is the internal entry number from the PHARMACY ORDERABLE ITEM (#50.7) File, and piece 2 is "1", indicating that the item is active. This entry point is used to provide CPRS with updated Pharmacy Orderable Item information to use in Quick Order updates, as a result of the automatic rematching process of the Pharmacy Ordering Enhancements phase 2 install. ******************** 3425 NAME: Consult editing utilities CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING FEE BASIS CLAIMS SYSTEM USAGE: Controlled Subscri ENTERED: AUG 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The included entry points allow access to information about editng and resubmitting records in the Consult/Request Tracking package. ROUTINE: GMRCEDT2 COMPONENT: $$EDRESOK(GMRCDA) VARIABLES: GMRCDA Type: Input This variable is the internal entry number from the REQUEST/CONSULTATION (#123) file. $$EDRESOK Type: Output Boolean value 1 (may be edited and resubmitted) 0 (not available for editing and resubmission) This entry point provides information regarding the ability to edit and resubmit a particular consult record. ******************** 3426 NAME: DBIA3426 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: AUG 6,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File Incomplete Records Tracking is accessing the CLOSE OUT FILE Field (#7.1). CLOSE OUT FILE Field (#7.1) is a pointer to the PTF CLOSE OUT File (#45.84) which will be use to return a close out date entry. ^DGPT( 7.1 CLOSE OUT FILE 0;9 Direct Global Read & w This is a pointer field to the PTF CLOSE OUT File (#45.84). ROUTINE: ******************** 3427 NAME: Purchase Card info CUSTODIAL PACKAGE: IFCAP SUBSCRIBING PACKAGE: PROSTHETICS USAGE: Controlled Subscri ENTERED: NOV 14,2001 STATUS: Active EXPIRES: DURATION: Next Version VERSION: pre-CoreFLS FILE: 440.6 ROOT: PRCH DESCRIPTION: TYPE: File This is a one time request, limited duration integration agreement. This request is limited to use within changes to Prosthetics version 3.0 made by patch RMPR*3*67. This agreement and the changes made by patch RMPR*3*67 will be terminated at the time that IFCAP releases patch PRC*5.1*45 which is an updated API that meets the extended needs of Prosthetics. This agreement is needed to allow sites to reconcile Prosthetics Orders that had their Purchase Card numbers changed by the credit card supplier. This agreement includes a direct global read only access of the "D" cross- reference at ^PRCH(440.6,"D",date) for processing time needs. As part of this one time request, limited duration integration agreement, direct global read only access of ^PRC(442,ien,0) first piece is requested. ^PRCH(440.6, .01 ORACLE DOCUMENT ID 0;1 Read w/Fileman 3 CREDIT CARD NUMBER 0;4 Both R/W w/Fileman 5 STATEMENT DATE 0;6 Read w/Fileman 14 FISCAL YEAR 0;15 Read w/Fileman 16 CARD HOLDER 0;17 Direct Global Read & w 20 VENDOR PURCHASE ORDE 0;21 Read w/Fileman 6 TRANSACTION DATE 0;7 Read w/Fileman ROUTINE: ******************** 3429 NAME: DBIA #3429 CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: BAR CODE MED ADMIN USAGE: Private ENTERED: NOV 14,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 101.24 ROOT: ORD(101.24, DESCRIPTION: TYPE: File ^ORD(101.24, .42 MAXIMUM DAYS BACK 4;2 Read w/Fileman 'B' x-re Direct Global Read & w ROUTINE: ******************** 3430 NAME: DBIA3430 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: AUG 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File Incomplete Records Tracking is accessing the NAME (#.01) field of the MEDICAL CENTER DIVISION (#40.8) file. Incomplete Records Tracking uses the following reference: "B" cross reference ^DG(40.8,"B",DA) ----------------------------- Incomplete Records Tracking has retained full authority for the "DT" node and its fields located and maintained in the MEDICAL CENTER DIVISION (#40.8) File. This includes development of the data dictionary (DD) for these fields, as well as responsibility for data entry into and data retriveval from these fields. This agreement is a "delegation of custody" of these fields from Registration to Incomplete Records Tracking. It provides Incomplete Records Tracking all rights and privileges to development and distribution for all DD elements and data in these fields. In addition, all DBIAs required for access to the DD and data for these fields will be between any subscriber and Incomplete Records Tracking as the custodian. ^DG(40.8, 100.01 TRACK INCOMPLETE SUM DT;1 Both R/W w/Fileman 100.02 DEFAULT PRIMARY PHYS DT;2 Both R/W w/Fileman 100.03 ARE REPORTS REVIEWED DT;3 Both R/W w/Fileman 100.04 DEFAULT REVIEWING PH DT;4 Both R/W w/Fileman 100.05 TRACK OUTPATIENT OP DT;5 Both R/W w/Fileman 100.06 DAYS FOR DICTATION DT;6 Both R/W w/Fileman 100.07 DAYS FOR SIGNATURE DT;7 Both R/W w/Fileman 100.08 DAYS FOR REVIEW DT;8 Both R/W w/Fileman 100.09 INCOMPLETE SUMMARIES DT;9 Both R/W w/Fileman 100.1 DEFAULT PHYS. FOR SI DT;10 Both R/W w/Fileman 100.2 STD. DEFIC. FOR SHOR DT;11 Both R/W w/Fileman 100.3 DEFAULT MEDICAL RECO DT;12 Both R/W w/Fileman .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 3431 NAME: DBIA3431 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: AUG 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File 1. Incomplete Records Tracking has retained full authority for the "IRT" node and its field IRT BACKGROUND JOB LAST RUN (#401) located in the MAS PARAMETERS (#43) File. 2. Incomplete Records Tracking has retained full authority for the field IRT SHORT FORM LIST GROUP (#513) located in the MAS PAREMETERS (#43) File. This includes development of the data dictionary (DD) for these fields, as well as responsibility for data entry into and data retriveval from these fields. This agreement is a "delegation of custody" of these fields from Registration to Incomplete Records Tracking. It provides Incomplete Records Tracking all rights and privileges to development and distribution for all DD elements and data in these fields. In addition, all DBIAs required for access to the DD and data for these fields will be between any subscriber and Incomplete Records Tracking as the custodian. ^DG(43, 513 IRT SHORT FORM LIST NOT;14 Direct Global R/W & w/ Select the name of the mailgroup which should be notified whenever the IRT Background Job is run, options: (IRT Update Std. Deficiencies and IRT Update Std. Def. Background Job), to receive a list of patients that have been discharged less than 48 hours from their admission (Short Form).. If no mailgroup is selected no bulletin will be generated. 401 IRT BACKGROUND JOB L IRT;1 Both R/W w/Fileman ROUTINE: ******************** 3432 NAME: DBIA3432 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: AUG 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 405 ROOT: DGPM( DESCRIPTION: TYPE: File Incomplete Records Tracking has retained full authority for the "IRT" node and its field IRT BACKGROUND JOB RUN (#60.01) located in the PATIENT MOVEMENT (#405) File. This includes development of the data dictionary (DD) for these fields, as well as responsibility for data entry into and data retriveval from these fields. This agreement is a "delegation of custody" of these fields from Registration to Incomplete Records Tracking. It provides Incomplete Records Tracking all rights and privileges to development and distribution for all DD elements and data in these fields. In addition, all DBIAs required for access to the DD and data for these fields will be between any subscriber and Incomplete Records Tracking as the custodian. ^DGPM( 60.01 IRT BACKGROUND JOB R IRT;1 Direct Global R/W & w/ ROUTINE: ******************** 3433 NAME: DBIA3433 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: AUG 9,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File Incomplete Records Tracking is accessing the NAME Field (#.01) of the MEDICAL CENTER DIVISION (#40.8) File. Incomplete Records Tracking uses the following cross references: "B" cross reference ^DG(40.8,"B",DA) ^DG(40.8,D0,0) .01 NAME 0;1 Direct Global Read & w ROUTINE: ******************** 3434 NAME: DIALOG File Entry Deletion CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: EXTENSIBLE EDITOR USAGE: Private ENTERED: AUG 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .84 ROOT: DI(.84 DESCRIPTION: TYPE: File When creating patch RGED*2.6*1 to remove Extensible Editor v.2.6, we tried to eliminate the DIALOG (#.84) file entries distributed with the package (9960001 - 9960070) by placing them in the build and marking them as DELETE AT SITE. KIDS did not remove them on the target system because delete access on File .84 is set to an "^". Therefore, a private integration agreement is established to allow the reference to ^DI(.84 using the following code in RGEDPST. ;Delete DIALOG file entries 9960001 through 9960070. N RGEDLOG W !!," Deleting Extensible Editor dialog entries.",!," " S DIK="^DI(.84," F RGEDLOG=9960001:1:9960070 S DA=RGEDLOG D ^DIK W "." W !!," DIALOG entries 9960001 through 9960070 have been deleted." ROUTINE: ******************** 3435 NAME: CONTROL CODES SUBFILE CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: INPATIENT MEDICATIONS OUTPATIENT PHARMACY REGISTRATION BAR CODE MED ADMIN Used by BCMA: EB - End Barcode EL - End Label FI - Format Initialization FI1 Format Initialization 1 FI2 Format Initialization 2 SB - Start Barcode SBF - Start Barcode Field SL - Start Label ST - Start Text STF - Start Text Field Although the name of the control codes are shared with other applications, the coding logic associated with each control code are quite different. close attention should be paid to the usage and sharing of control codes among barcode printing devices. USAGE: Controlled Subscri ENTERED: MAR 5,2003 STATUS: Active EXPIRES: DURATION: VERSION: FILE: 3.2 ROOT: %ZIS(2 DESCRIPTION: TYPE: File The purpose of this agreement is to allow direct MUMPS read access to the CONTROL CODES subfile (#3.2055) of the TERMINAL TYPE file (#3.2). Any subscribing package must coordinate the ABBREVIATION and FULL NAME information with the KERNEL developers when subscribing to this agreement. Also, the agreed upon control codes should be added to this agreement for documentation. Inpatient Medications is using the control codes to create generic print routines for barcode printing. Inpatient Medications will use the following control codes, as will Registration and Bar Code Medication Administration (BCMA).: ET - End Text ETF - End Text Field EB - End Barcode EBF - End Barcode Field EL - End Label FE - Format End FI - Format Initialization FI1 - Format Initialization 1 FI2 - Format Initialization 2 SB - Start Barcode SBF - Start Barcode Field SL - Start Label ST - Start Text STF - Start Text Field SM - Start Med Route SMF - Start Med Route field EM - End Med Route EMF - End Med Route field Outpatient Pharmacy is using the control codes to create a generic print routine for laser labels. Outpatient Pharmacy will use the following control codes: ACI = ADDRESS CHANGE INITIALIZATION ALI = ALLERGY SECTION INITIALIZATION AWI = ALLERGY WARNING INITIALIZATION BLB = BOTTLE LABEL BODY INITIALIZATION BLBC = BOTTLE LABEL BARCODE BLF = BOTTLE LABEL FOOTER INITIALIZATION BLH = BOTTLE LABEL HEADER INITIALIZATION CDII = CRITICAL DRUG INTERACTION INITIALIZATION CNI = COPAY NARRATIVE INITIALIZATION EBLBC = END OF BOTTLE LABEL BARCODE EBT = END OF BARCODE TEXT F10 = TEN POINT FONT - NO BOLD F10B = TEN POINT FONT, BOLDED F12 = TWELVE POINT FONT - NO BOLD F12B = 12 POINT FONT BOLDED F6 = SIX POINT FONT - NO BOLD F8 = EIGHT POINT FONT - NO BOLD F9 = NINE POINT FONT - NO BOLD FDU = FONT DISABLE UNDERLINE FWU = FONT WITH UNDERLINE LL = LASER LABEL LLI = LASER LABEL INIT MLI = MAILING LABEL INITIALIZATION NR = NORMAL ROTATION PFDI = PHARMACY FILL DOCUMENT INITIALIZATION PFDQ = PHARMACY FILL DOCUMENT QUANTITY PFDT = PHARMACY FILL DOCUMENT TRAILER PFDW = PHARMACY FILL DOCUMENT WARNING PFI = PATIENT FILL INITIALIZATION PII = PATIENT INSTRUCTION INITIALIZATION PMII = PMI SECTION INITIALIZATION RMI = RETURN MAIL INITIALIZATION RNI = REFILL NARRATIVE INITIALIZATION RPI = REFILL PRINT INITIALIZATION RT = ROTATE TEXT SBT = START OF BARCODE TEXT SPI = SUSPENSE PRINT INITIALIZATION ST = START OF TEXT WLI = WARNING LABEL INITIALIZATION ^%ZIS(2,ien,55 .01 ABBREVIATION 0;1 Direct Global Read & w 1 FULL NAME 0;2 Direct Global Read & w 2 CONTROL CODE 1;1 Direct Global Read & w ROUTINE: ******************** 3436 NAME: CALLS TO TIUSRVR CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CPRS calls these tags both MUMPS-to-MUMPS, and from RPCs (i.e., see IA #'s 3438 and 3439). IMAGING MENTAL HEALTH MH ADDED 2.15.2011 USAGE: Controlled Subscri ENTERED: AUG 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: TIUSRVR COMPONENT: GET1405 VARIABLES: TIUY Type: Output Passed By Reference. Will contain the result of the procedure call. TIUDA Type: Input This is the Record Number (IEN) of the document in the TIU DOCUMENT FILE (#8925) for which the calling application is inquiring. Call with record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). - Returns the variable pointer to the REQUESTING PACKAGE REFERENCE (e.g., "IEN;GMR(123," for Consults; or "IEN;SRF(" for Surgery), if a value is present. - Otherwise, returns "-1^" COMPONENT: GETALRT VARIABLES: TIUY Type: Output Passed by Reference. Contains the result of the call. XQAID Type: Input This is the alert ID for the TIU SIGNATURE ALERT. Its format will be: "TIU" Given an Alert ID for a TIU Signature Alert, returns the string: "^^" COMPONENT: GETPREF VARIABLES: ******************** 3437 NAME: REGISTRATION FILE USED BY TIU - DG(40.8 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES USAGE: Private ENTERED: AUG 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.8 ROOT: DG(40.8, DESCRIPTION: TYPE: File TIU extracts INSTITUTION FILE POINTER data from the MEDICAL CENTER DIVISION file (#40.8) for a one-time use in the installation environment check routine TIUEN113. ^DG(40.8, ^DG(40.8,'ADV' .07 INSTITUTION FILE POI 0;7 Read w/Fileman ROUTINE: TIUEN113 ******************** 3438 NAME: TIU GET REQUEST CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CPRS calls this entry point as both a Remote Procedure, and MUMPS-to-MUMPS, as documented in IA #3436. HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** This functionality is being released in HMP*2.0*2 USAGE: Controlled Subscri ENTERED: AUG 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure This Remote Procedure returns the variable pointer to the REQUESTING PACKAGE REFERENCE (File #8925, Field #1405). This would be the record in the Requesting Package (e.g., Consult/Request Tracking or Surgery) for which the resulting document has been entered in TIU. INPUT PARAMETER: TIUDA PARAMETER TYPE: LITERAL REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: This is the record number (IEN) of the document in the TIU Document File (#8925). RETURN PARAMETER DESCRIPTION: This is the Variable pointer (e.g., "15741;GMR(123,") to the corresponding request. ROUTINE: ******************** 3439 NAME: TIU GET ALERT INFO CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING CPRS makes this call both as an RPC, and in a direct MUMPS-to-MUMPS call, as documented in IA #3436. AUTOMATED MED INFO EXCHANGE USAGE: Controlled Subscri ENTERED: AUG 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure Given a TIU XQAID, return the patient and document type for the item being alerted. INPUT PARAMETER: XQAID PARAMETER TYPE: LITERAL MAXIMUM DATA LENGTH: 60 REQUIRED: YES DESCRIPTION: The XQAID of the alert. RETURN PARAMETER DESCRIPTION: TIUDA^DFN^ where TIUDA is the document IEN in the TIU DOCUMENT File (#8925), DFN is the IEN of the Patient in the PATIENT File (#2), and is an arbitrarily set constant based on the document type. ROUTINE: ******************** 3440 NAME: TIU PRINT DRIVER CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING VA CERTIFIED COMPONENTS - DSSI USAGE: Controlled Subscri ENTERED: AUG 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The API RPC^TIUPD is called both from the remote procedure TIU PRINT RECORD, as documented in DBIA #1834 and MUMPS-to-MUMPS, to print a given record to a named device, either for work or chart copies, and will accommodate both Windows and host printers. ROUTINE: TIUPD COMPONENT: RPC VARIABLES: TIUY Type: Output This is an error flag/message which will have two '^'-pieces. The first piece will be a boolean flag indicating whether or not the call failed (0 indicates success, while 1 indicates failure). The second piece is a textual message indicating the nature of the error. In the event of success, the second piece will describe whether the printout will be for a CHART COPY or a WORK COPY. TIUDA Type: Input This is the record number of the document in the TIU DOCUMENT FILE (#8925). It uniquely identifies the document to be printed. TIUIO Type: Input This is the NAME of the device to which the document is to be printed. NOTE: You may not pass the $I for the device, or the Pointer to the DEVICE FILE entry corresponding to the device. ONLY THE DEVICE NAME will work. TIUFLAG Type: Input This is a flag which tells the print driver to specify a CHART versus WORK copy of the document. If it is undefined or its value is 0, then the printed copy will be marked as a WORK COPY. If its value is 1, then it will be marked as a CHART COPY. TIUWIN Type: Input Boolean flag indicating whether the output is directed to a Windows printer (1), or a printer directed directly to the host (0 or ""). Allows printing of TIU Documents on demand. ******************** 3441 NAME: CALLS TO TIUSRVLI CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Controlled Subscri ENTERED: AUG 16,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CPRS makes use of several APIs in TIUSRVLI to determine the complete hierarchical context of a given document when building the TreeView for the Notes, Summaries, and Consults tabs. ROUTINE: TIUSRVLI COMPONENT: $$HASDAD(DA) VARIABLES: DA Type: Input This is the record number (IEN) of the document in file 8925. Type: Output The function returns TRUE (i.e., 1) if the document has a parent (i.e., it's an addendum or an Interdisciplinary entry), or FALSE (i.e., 0) if the document stands alone. Boolean extrinsic function which evaluates whether a given document has a parent (i.e., either it is an addendum, or an Interdisciplinary Entry). COMPONENT: SETDAD(TIUY,DA,TIUI) VARIABLES: TIUY Type: Input This is the NAME of the array (global or local) in which the data should be returned. DA Type: Input This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). TIUI Type: Input This OPTIONAL parameter is the subscript from which the array should be incremented (defaults to 1). This allows the calling application to accumulate the ancestry of multiple documents in the same array, by calling SETDAD iteratively. This subroutine will build an array which includes the complete hierarchical "ancestry" of a given TIU Document. For example, if one passes the record number of an addendum to an Interdisciplnary entry, and the name of an array to be returned (either as $NA(^TMP("",$J)) or as a local array), the module will return the Interdisciplinary Parent entry, and the Interdisciplinary entry to which the addendum belongs. NOTE: Prior to making the call, the local variable SEQUENCE should be set, indicating whether the documents should be returned in ascending ("A") or descending ("D") chronological order. Default is descending (most recent first). COMPONENT: $$HASKIDS(DA) VARIABLES: DA Type: Input This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). Type: Output The function returns TRUE (i.e., 1) if the document has descendents (i.e., addenda or Interdisciplinary Entries), or FALSE (i.e., 0) if the document has none. Boolean extrinsic function which evaluates whether a given document has descendents (i.e., either addenda, or an Interdisciplinary Entries). COMPONENT: SETKIDS(TIUY,DA,TIUI) VARIABLES: TIUY Type: Input This is the NAME of the array (global or local) in which the data should be returned. DA Type: Input This is the record number (IEN) of the document in the TIU DOCUMENT FILE (#8925). TIUI Type: Input This OPTIONAL parameter is the subscript from which the array should be incremented (defaults to 1). This allows the calling application to accumulate the ancestry of multiple documents in the same array, by calling SETKIDS iteratively. This subroutine will build an array which includes all descendents of a given TIU Document. For example, if one passes the record number of an Interdisciplinary parent document, which has one or more entries, any of which having addenda; and the name of an array to be returned (either as $NA(^TMP("",$J)) or as a local array), the module will return the complete hierarchy. NOTE: Prior to making the call, the local variable SEQUENCE should be set, indicating whether the documents should be returned in ascending ("A") or descending ("D") chronological order. Default is descending (most recent first). ******************** 3442 NAME: ZIS GLOBAL CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: AUTOMATED INFO COLLECTION SYS The AICS package has permission to execute the following code until an API is developed for this. X $G(^%ZIS(2,$G(IOST(0)),2)) AICS needs to be able to reset a device without the open command. ORDER ENTRY/RESULTS REPORTING OE/RR needs access to the following globals to use and setup an HFS device: ^%ZIS(2,"B", ^%ZIS(2,IFN,0) ^%ZIS(2,IFN,1) USAGE: Controlled Subscri ENTERED: FEB 27,2003 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 3.2 ROOT: %ZIS(2 DESCRIPTION: TYPE: File This DBIA describes access needed by packages to various parts of the global/file ^%ZIS(2 ^%ZIS(2, .01 NAME 0;1 Direct Global Read & w 1 RIGHT MARGIN 1;1 Direct Global Read & w 2 FORM FEED 1;2 Direct Global Read & w 3 PAGE LENGTH 1;3 Direct Global Read & w 6 OPEN EXECUTE 2;E1,245 Direct Global Read & w The 'B' cross reference is accessed directly to get to the data. ROUTINE: ******************** 3443 NAME: Check RAD/NUC MED REPORTS file header CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING See General description. USAGE: Private ENTERED: AUG 17,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 74 ROOT: RARPT DESCRIPTION: TYPE: File There are two permissions granted through this Integration Agreement (IA). The first is that VistA Imaging will be granted permission to examine the file header of the RAD/NUC MED REPORTS (#74) file. The purpose is to allow Imaging to verify that the counter in the file header (third piece of ^RARPT(0)) has not decreased significantly since it was last inspected. This approach will enable us to detect major status changes in the global that could be caused by a global restoration, compression, or global move. The second is that VistA Imaging will be granted permission to traverse the top-level 'B' cross reference for records in the RAD/NUC MED REPORTS file. The 'B' cross reference is created via VA FileMan and is placed on the .01 field of the file. The name of the .01 field of the RAD/NUC MED REPORTS file is DAY-CASE#. ^RARPT(0) This IA allows the subscribing application the right to look at the file header of the RAD/NUC MED REPORTS file. ^RARPT('B' This IA allows the subscribing application the right to traverse the top-level 'B' cross reference of the RAD/NUC MED REPORTS file. ROUTINE: ******************** 3444 NAME: REGISTRATION FILE USED BY TIU - DG(43 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES PROBLEM LIST Added 6/19/18. USAGE: Controlled Subscri ENTERED: AUG 16,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 43 ROOT: DG(43, DESCRIPTION: TYPE: File TIU extracts MULTIDIVISION MED CENTER? data from the MAS PARAMETERS file (#43) for use in routine TIULA and TIULA1 to determine if a facility is multidivisional. ^DG(43,1,'GL' 11 MULTIDIVISION MED CE GL;2 Read w/Fileman ROUTINE: ******************** 3445 NAME: Determine the Service associated with a ward. CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE USAGE: Private ENTERED: AUG 22,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 42 ROOT: DIC(42, DESCRIPTION: TYPE: File In order to determine whether an exam gets sent to PCE for crediting, a check on the patient's physical location must be performed. If the patient is currently being seen in a clinic, or if the patient is assigned to a ward and that ward has a Service defined as Domiciliary, then the record passed this check and can be passed to PCE if other checks are successful. I need to get the Service associated with a ward location, and I am requesting to achieve this by utilizing a "read with FileMan" utility: $$GET1^DIQ(42,ien of file 42 record,.03,"I" -or- "E") where: Where '42' is the file number for the WARD LOCATION file, the second subscript is self-explanatory, '.03' is the SERVICE field number and 'I' indicates we'd like the internal representation, while 'E' indicates that we'd like the external representation of the data. ^DIC(42, .03 SERVICE 0;3 Read w/Fileman A service, short for hospital service, is associated with a ward in order to keep patients with similar medical experiences together in order to provide better treatment. Many reports are used to track the number of patient per ward, as well as, how many patients are linked to a particular hospital service. The Service (#.03) field is the third piece located on the zero node (0;3) of the file record. ROUTINE: ******************** 3446 NAME: coreFLS Foreign File Format CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP EQUIPMENT/TURN-IN REQUEST ENGINEERING USAGE: Private ENTERED: AUG 23,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .44 ROOT: DIST(.44 DESCRIPTION: TYPE: File coreFLS needs to obtain data from various files to populate their tables with legacy data. One method being used is the FileMan data export tools. Since it is not possible to send FileMan Foreign File formats via KIDS, we will need to populate FOREIGN FORMAT file (#.44) with an entry. ^DIST(.44 1 FIELD DELIMITER 0;2 Write w/Fileman 2 RECORD DELIMITER 0;3 Write w/Fileman 5 RECORD LENGTH FIXED? 0;6 Write w/Fileman 7 MAXIMUM OUTPUT LENGT 0;8 Write w/Fileman 8 QUOTE NON-NUMERIC FI 0;10 Write w/Fileman 40 FORMAT USED? 0;9 Write w/Fileman 6 NEED FOREIGN FIELD N 0;7 Write w/Fileman 10 SEND LAST FIELD DELI 0;12 Write w/Fileman 20 FILE HEADER 1;E1,245 Write w/Fileman 25 FILE TRAILER 2;E1,245 Write w/Fileman 31 USAGE NOTES 4;0 Write w/Fileman 30 DESCRIPTION 3;0 Write w/Fileman ROUTINE: ******************** 3447 NAME: coreFLS Export Templates CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IFCAP ENGINEERING EQUIPMENT/TURN-IN REQUEST USAGE: Private ENTERED: AUG 23,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .4 ROOT: DIPT DESCRIPTION: TYPE: File With the new entry into the FOREIGN FORMAT file (#.44) (see IA 3446), the PRCL* namespaced export templates in the PRINT TEMPLATE file (#.4) will need to have the EXPORT FORMAT field (#105) updated to be the foreign format IEN. ^DIPT 105 EXPORT FORMAT 105;1 Write w/Fileman 8 TEMPLATE TYPE 0;8 Read w/Fileman ROUTINE: ******************** 3448 NAME: PSB MEDICATION HISTORY REPORT CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: SEP 10,2001 STATUS: Active EXPIRES: MAY 2003 DURATION: VERSION: 1.0 FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this agreement is to provide other packages with the ability to call the BCMA Medication History report. It returns a report of medications a patient has received by orderable item. ROUTINE: PSBML COMPONENT: HISTORY VARIABLES: DFN Type: Input Patient IEN number. PSBOI Type: Input Orderable Item number. RESULTS Type: Input The name of the array that the output is passed in. If the calling routine sets ^TMP("PSBMH",$J)="", then PSBML will search only for solutions that are marked as pre-mix. The entry is not required. If the calling packages wants all solutions to be searched, no set is required. ******************** 3449 NAME: ADVERSE REACTION ASSESSMENT CUSTODIAL PACKAGE: ADVERSE REACTION TRACKING SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary Allergy Component needs to extract the name of the person making the assessment and the assessment date. BAR CODE MED ADMIN VDEF VDEF needs to be able to determine if a patient has active allergies as part of the PFSS project. VA POINT OF SERVICE (KIOSKS) VPS is requesting FileMan read access to the Reaction Assessment (#1) field. VIRTUAL PATIENT RECORD HEALTH MANAGEMENT PLATFORM HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR USAGE: Controlled Subscri ENTERED: SEP 11,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 120.86 ROOT: GMR(120.86, DESCRIPTION: TYPE: File ^GMR(120.86,D0,0) 2 ASSESSING USER 0;3 Read w/Fileman This field contains the name of the user who made the last reaction assessment for this patient. 3 ASSESSMENT DATE/TIME 0;4 Read w/Fileman This field contains the date/time of the last reaction as sessment for this patient. 1 REACTION ASSESSMENT 0;2 Direct Global Read & w Set of codes that indicates the patient's allergy assessment level. Value of 1 indicates that the patient has allergies while a value of 0 indicates that the patient has no known allergies (NKA). ROUTINE: ******************** 3451 NAME: TIU/SELECTED PROGRESS NOTES CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY TIU DOCUMENT DEFINITION are pointed to by Health Summary for the PROGRESS NOTES SELECTED component. USAGE: Private ENTERED: SEP 11,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.1 ROOT: TIU(8925.1, DESCRIPTION: TYPE: File ^TIU(8925.1,DO,0) .01 NAME 0;1 Pointed to ROUTINE: ******************** 3452 NAME: MAIL.CIO.MED.VA.GOV Domain CUSTODIAL PACKAGE: MAILMAN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: SEP 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4.2 ROOT: DIC(4.2, DESCRIPTION: TYPE: File CIRN MPI/PD has an agreement to do a read with FileMan on the NAME (#.01) field in the DOMAIN (#4.2) file. This is used in environment check routine, RGP22ENV, to ensure that the instructions in informational patch XM*DBA*139 have been followed for domain "MAIL.CIO.MED.VA.GOV". The environment check routine will not allow patch RG*1.0*22 to be installed unless the "MAIL.CIO.MED.VA.GOV" entry exists. Patch RG*1.0*22 is in support of GCPR. ^DIC(4.2,D0,0) .01 NAME 0;1 Read w/Fileman ROUTINE: ******************** 3453 NAME: Enter/Edit OFFICE OF INFORMATION SRV CNTR Entry CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK USAGE: Private ENTERED: SEP 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 4 ROOT: DIC(4, DESCRIPTION: TYPE: File CIRN MPI/PD has an agreement to use a FileMan FILE^DICN call to edit the following fields in the INSTITUTION (#4) file. NAME (#.01), STATE (#.02), STATUS (#11), FACILITY TYPE (#13), STATION NUMBER (#99) and OFFICAL VA NAME (#100). This is done in pre-install routine, PRE^RGP22, to create the OFFICE OF INFORMATION SRV CNTR entry in the INSTITUTION file if it is not present. This functionality is in support of GCPR. The entry created has the following values. NAME: OFFICE OF INFORMATION SRV CNTR STATE: OHIO STATUS: National FACILITY TYPE: VAMC STATION NUMBER: 776 OFFICAL VA NAME: OFFICE OF INFORMATION SERVICE CENTER ^DIC(4,D0,0) .01 NAME 0;1 Write w/Fileman .02 STATE 0;2 Write w/Fileman 11 STATUS 0;11 Write w/Fileman ^DIC(4,D0,3) 13 FACILITY TYPE 3;1 Write w/Fileman ^DIC(4,D0,99) 99 STATION NUMBER 99;1 Write w/Fileman 100 OFFICIAL VA NAME 99;3 Write w/Fileman ROUTINE: ******************** 3454 NAME: Enter/Edit VACIO Entry in HL LOGICAL LINK (#870) CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK OUTPATIENT PHARMACY USAGE: Private ENTERED: SEP 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 870 ROOT: HLCS(870, DESCRIPTION: TYPE: File MPI/PD build RG*1.0*22 exports (via KIDS) the following HL LOGICAL LINK. NODE: VACIO INSTITUTION: OFFICE OF INFORMATION SRV CNTR LLP TYPE: TCP AUTOSTART: Enabled DOMAIN: MAIL.CIO.MED.VA.GOV QUEUE SIZE: 10 EXCEED RE-TRANSMIT ACTION: restart TCP/IP ADDRESS: 152.127.1.6 TCP/IP PORT: 5000 TCP/IP SERVICE TYPE: CLIENT (SENDER) Post-install routine PST^RGP22, determines if the account is the production or test account. (IA #3335 and #2525 allow the read access necessary to do this.) If the account is the test account, we do not want the 'VACIO' node to be actively used. Therefore, the DOMAIN (#.03) and TCP/IP ADDRESS (#400.01) fields are omitted in the post-install. CIRN MPI/PD has an agreement to use a FileMan DIE call to edit/eliminate the DOMAIN (#.03) and TCP/IP ADDRESS (#400.01) fields in the HL LOGICAL LINK (#870) file for entry 'VACIO'. This functionality is in support of GCPR. ^HLCS(870, .03 DOMAIN 0;7 Write w/Fileman 400.01 TCP/IP ADDRESS 400;1 Write w/Fileman 4.5 AUTOSTART 0;6 Write w/Fileman ROUTINE: ******************** 3455 NAME: DBIA3455 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: CLINICAL REMINDERS Clinical Reminders needs to determine who was the visit/encounter provider. Therefore Clinical Reminders needs to read the following fields: USAGE: Private ENTERED: SEP 14,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010.06 ROOT: AUPNVPRV DESCRIPTION: TYPE: File ^AUPNVPRV(D0,0) .01 PROVIDER 0;1 Direct Global Read & w .03 VISIT 0;3 Direct Global Read & w .02 PATIENT NAME 0;2 Direct Global Read & w .04 PRIMARY/SECONDARY 0;4 Direct Global Read & w ^AUPNVPRV('AD' ROUTINE: ******************** 3456 NAME: DBIA3456-A CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PCE PATIENT CARE ENCOUNTER USAGE: Controlled Subscri ENTERED: SEP 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this API is to facilitate the filing of the Head/Neck Cancer Diagnosis into the NOSE AND THROAT RADIUM HISTORY (#28.11) file when verified through an external application (i.e. PCE Encounter Checkout). ROUTINE: DGNTAPI1 COMPONENT: $$FILEHNC(DFN) VARIABLES: DFN Type: Input IEN of patient in the PATIENT File (#2) $$FILEHNC Type: Output IEN of new entry in NOSE AND THROAT RADIUM HISTORY (#28.11) file 0 - if no previous record exists in the NOSE AND THROAT RADIUM HISTORY (#28.11) for the DFN or the internal value of the SCREENING STATUS field (#.03) is not equal to "3". 0^error message - if an error occurred during the filing of the new record in the NOSE AND THROAT RADIUM HISTORY (#28.11) file. Entry point $$FILEHNC^DGNTAPI(DFN) will file a new record in the NOSE AND THROAT RADIUM HISTORY (#28.11) file if a previous record exists for the DFN and the internal value of the SCREENING STATUS field (#.03) is equal to "3", indicating "PENDING DIAGNOSIS". The new record will consist of data from the previous record plus the following fields and values: Field# Field Name Field Value ------ --------------------- ------------------- 2.01 HEAD/NECK CA DX "Y" 2.02 DATE/TIME DX VERIFIED $$NOW^XLFDT 2.03 DX VERIFIED BY DUZ 2.04 SITE VERIFYING DX $P($$SITE^VASITE,U) Example of use: -------------- I $$FILEHNC^DGNTAPI(DFN) W !,"Verified HEAD/NECK CA DX has been filed." ******************** 3457 NAME: DBIA3457 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this API is to facilitate the retrieval of veterans' Nose/Throat Radium (NTR) Treatment information from the NOSE AND THROAT RADIUM HISTORY (#28.11) file. The primary mechanism is within the Registration package. ROUTINE: DGNTAPI COMPONENT: $$GETCUR(DFN,TARGET_ROOT) VARIABLES: DFN Type: Input IEN of patient in the PATIENT File (#2) $$GETCUR Type: Output IEN of primary entry in NOSE AND THROAT RADIUM HISTORY File (#28.11) "0"- If no NTR history entry is found for the patient. TARGET_ROO Type: Both Input: (Optional) Target Array name that should be passed as a closed root reference. If the parameter is not passed, then the default TARGET_ROOT is set equal to "DGNTAPI". Output: The output array is in the format of TARGET_ROOT(subscript) with subscript being derived from the following table: subscript field name field val --------- -------------- --------- "DFN" Patient internal "IND" NTR Indicator int^ext "STAT" Screening Status int^ext "NTR" NTR Treatment int^ext "AVI" Aviator Pre 1/31/55 int^ext "SUB" Submarin Pre 1/1/65 int^ext "EDT" Date/Time NTR Enter internal "EUSR" NTR Entered By internal "PRIM" NTR Primary Entry internal "SUPER" Date/Time Supersede internal "VER" Verification Method int^ext "VDT" Date/Time Verified internal "VUSR" Verified By internal "VSIT" Site Verifying Doc internal "HNC" Head/Neck CA DX int^ext "HDT" Date/Time DX Verif internal "HUSR" DX Verified By internal "HSIT" Site Verifying DX internal The $$GETCUR^DGNTAPI(DFN,TARGET_ROOT) entry point will be used to obtain a patient's primary/current record from the NOSE AND THROAT RADIUM HISTORY (#28.11) file and place it in the local target array, TARGET_ROOT, passed as a closed root reference. Example of use: -------------- I $$GETCUR^DGNTAPI(DFN,"DGNT") D . W !,"DGNT array now contains patient's primary NTR record." ******************** 3458 NAME: OUTPATIENT PHARMACY ORDER STATUS CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY INPATIENT MEDICATIONS ADVERSE REACTION TRACKING USAGE: Controlled Subscri ENTERED: SEP 25,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: ORQOR2 COMPONENT: $$STATUS(ORN) VARIABLES: ORN Type: Input The PLACER ORDER # field (#39.3) of the PRESCRIPTION file (#52) which is the internal entry number of the ORDER file (#100). (Required) $$STATUS Type: Output Returns the current status of an order in the format: STATUS^STATUS DESCRIPTION STATUS is the STATUS field (#5) of the ORDER file (#100), a pointer to the ORDER STATUS file (#100.01). This entry point will be used by Outpatient Pharmacy to get the Pharmacy order status from the ORDER file (#100). ******************** 3459 NAME: PSB MEDICATION HISTORY REPORT CUSTODIAL PACKAGE: BAR CODE MED ADMIN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: SEP 25,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this agreement is to provide other packages with the ability to call the BCMA Medication History report. It returns a report of medications a patient has received by orderable item. This DBIA is for BCMA Version 2.0 only. ROUTINE: PSBMLHS COMPONENT: HISTORY VARIABLES: RESULTS Type: Input The name of the array that the output ispassed in. DFN Type: Input Patient IEN number. PSBOI Type: Input Orderable Item number. If the calling routine sets ^TMP("PSBMH",$J)="", then PSBML will search only for solutions that are marked as pre-mix. The entry is not required. If the calling packages wants all solutions to be searched, no set is required. ******************** 3460 NAME: TIU pointer validation CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING USAGE: Private ENTERED: SEP 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925 ROOT: TIU(8925 DESCRIPTION: TYPE: File ^TIU(8925, 2 DFN 0;2 Direct Global Read & w ROUTINE: ******************** 3461 NAME: TIU pointer validation CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: IMAGING Imaging is reading information from file TIU EXTERNAL DATA LINK (#8925.91). CONSULT/REQUEST TRACKING USAGE: Controlled Subscri ENTERED: SEP 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 8925.91 ROOT: TIU(8925.91, DESCRIPTION: TYPE: File The Text Integration Utilities application grants Imaging permission to read data in file 8925.91. At the time of image acquisition on the DICOM gateway, the only piece of information sent with the image is the associated TIU note entry in file 8925. The gateway needs to determine if an Imaging pointer exists for this document in file 8925.91. ^TIU(8925.91, .01 DOCUMENT 0;1 Read w/Fileman .02 IMAGE 0;2 Read w/Fileman ^TIU(8925.91,'B', Direct global read of "B" x-ref approved. ROUTINE: ******************** 3462 NAME: DBIA3462 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: OCT 1,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine A private IA for IB to call PSO to make them aware of a billing event that has taken place. ROUTINE: PSOCPIB COMPONENT: PSOCPIB VARIABLES: Y(1) Type: Input IB will have the variable Y(1) defined with the following pieces: 1st piece = date/time 2nd piece = user causing the update 3rd piece = prescription number 4th piece = fill/refill number 5th piece = partial/full billing flag 6th piece = IB number Top level entry into routine. ******************** 3463 NAME: PHARMACY ORDER DISCONTINUED DATE/TIME CUSTODIAL PACKAGE: ORDER ENTRY/RESULTS REPORTING SUBSCRIBING PACKAGE: OUTPATIENT PHARMACY USAGE: Controlled Subscri ENTERED: OCT 2,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 100 ROOT: OR( DESCRIPTION: TYPE: File Outpatient Pharmacy package request permission to access the ORDER file (#100). Outpatient Pharmacy option, the Expire Prescriptions [PSO EXPIRE PRESCRIPTIONS], routine PSOHLEXP, flags prescriptions that have passed the expire date as expired and sends an HL7 message across to CPRS to flag those prescriptions as expired. Recently we noticed that it not only sends the expire message for expired prescriptions but also for discontinued prescriptions, and as a result in CPRS the discontinued prescriptions are flagged as expired, which is incorrect. Outpatient Pharmacy will correct the statuses of all those prescriptions in CPRS from expired status to discontinued status. This will be a one-time request. ^OR(100, 63 DC DATE/TIME 6;3 Direct Global R/W & w/ This is the exact date/time the order was discontinued. 31 DATE OF LAST ACTIVIT 3;1 Direct Global R/W & w/ 12 PACKAGE 0;14 Direct Global Read & w 33 PACKAGE REFERENCE 4;1 Direct Global Read & w ROUTINE: ******************** 3464 NAME: HL(772 Diagnostic Utility CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX USAGE: Controlled Subscri ENTERED: OCT 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 772 ROOT: HL(772 DESCRIPTION: TYPE: File This IA supports a diagnostic utility used for problem resolution with messaging issues associated with HL7 data transmissions for MPI/PD. The tool will be available for diagnostic purposes as needed by the development team or NVS. The utility compiles data from the HL7 MESSAGE TEXT (#772) file for a selected date range. Each HL7 message in the date range is examined. If the RELATED EVENT PROTOCOL (#10) field contains the MPI/PD protocols (e.g., ""VAF"", ""RG"", or ""MPI"") data is stored in the ^XTMP("RGMT","HL" array. A cross-reference is built on patient ICN and DFN for faster data retrieval for the associated reports. Direct global reads are necessary for efficiency and speed for the data compilation process. A number of diagnostic reports are generated from the compiled data including the following. HL7 Activity by Patient for a Single Protocol for Date Range HL7 Activity by Patient for All MPI/PD Protocols for Date Range HL7 Message Status Summary Report (total number of messages for each date in range, transmission type, and status) Detailed HL7 Message Status Report ^HL(772,'B', "B" CROSS REFERENCE ^HL(772, 200 MESSAGE TEXT IN;0 Direct Global Read & w .01 DATE/TIME ENTERED 0;1 Direct Global Read & w 4 TRANSMISSION TYPE 0;4 Direct Global Read & w 10 RELATED EVENT PROTOC 0;10 Direct Global Read & w 20 STATUS P;1 Direct Global Read & w 21 DATE/TIME PROCESSED P;2 Direct Global Read & w From the message text multiple, examine the following segments. From the PID segment, get the ICN and the patient DFN. From the QAK segment, get the patient DFN. From the RDT segment, get the ICN. From the VTQ segment, get the SSN. From the MFE segment, for MAD or MUP, get the ICN. ROUTINE: ******************** 3465 NAME: Clinical Registries CUSTODIAL PACKAGE: LAB SERVICE SUBSCRIBING PACKAGE: CLINICAL CASE REGISTRIES USAGE: Private ENTERED: OCT 16,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 63 ROOT: LR( DESCRIPTION: TYPE: File The Clinical Registries package requires the ability to send Autopsy data to the national registry. Therefore access to the ^LR(D0,"AU" node is required. 1) Access Autopsy node: ^LR(D0,"AU") - ("AU";1)("AU";5)("AU";6)("AU";12) ^LR( 11 AUTOPSY DATE/TIME AU;1 Read w/Fileman 14.1 LOCATION AU;5 Read w/Fileman 14 AUTOPSY ACC # AU;6 Read w/Fileman 12.1 PHYSICIAN AU;12 Read w/Fileman 13.1 DATE FINAL AUTOPSY D AU;4 Direct Global Read & w 14.5 SERVICE AU;8 Direct Global Read & w 32.2 CLINICAL DIAGNOSES 81;0 Read w/Fileman 32.3 PATHOLOGICAL DIAGNOS 82;0 Read w/Fileman 14.7 AUTOPSY RELEASE DATE AU;15 Direct Global Read & w ROUTINE: ******************** 3466 NAME: DBIA3466-A CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Supported ENTERED: OCT 5,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA allows a package to set a key for easily looking up a Generic Code Sheet Stack File document in file 2100.1. ROUTINE: GECSSTAA COMPONENT: SETKEY(A,B) VARIABLES: A Type: Output the internal entry number in file 2100.1 that will be returned fro the key when looked up. B Type: Input the key to lookup used to look up the entry. Call this entry point to set the key lookup in file 2100.1. ******************** 3467 NAME: DBIA3466-B CUSTODIAL PACKAGE: GENERIC CODE SHEET SUBSCRIBING PACKAGE: ACCOUNTS RECEIVABLE USAGE: Supported ENTERED: OCT 5,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This IA allows a package to lookup a Generic Code Sheet Stack File document in file 2100.1 based on a key set by SETKEY^GECSSTAA. ROUTINE: GECSSGET COMPONENT: KEYLOOK(A,B) VARIABLES: A Type: Input the key to pass for looking up a document. B Type: Input a flag. If it is passed as a number, the code sheet for the document found using the key will be returned in the GECSDATA array. If variable B is passed as a 0, the code sheet data will not be returned in the GECSDATA array. Call this entry point to lookup a Generic Code Sheet Stack File document in file 2100.1. The internal entry number of the document will be returned in the GECSDATA variable. ******************** 3468 NAME: CLINICAL PROCEDURE UTILITIES CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: CLINICAL PROCEDURES IMAGING USAGE: Controlled Subscri ENTERED: OCT 10,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement describes several utilities used to gather information or update Consult records involved in the Clinical Procedures interface to Consult/Request Tracking. ROUTINE: GMRCCP COMPONENT: CPLIST(GMRCPT,GMRCPR,GMRCRET) VARIABLES: GMRCPT Type: Input This is the patient identifier (DFN). GMRCPR Type: Input This optional variable is a pointer to the CP DEFINITION (#702.01) file. If this variable is not passed, all CP requests will be returned. GMRCRET Type: Output This required variable is the name of a global array in which to return the list of CP requests for a patient. The array is returned in the format: ^global(array)= a^b^c^d^e^f where: a=date of request b=CP DEFINITION name c=urgency d=status e=consult ien from file 123 f=CP DEFINITION ien This entry point returns a list of Clincial Procedure requests on file for a given patient. COMPONENT: $$CPDOC(GMRCDA,TIUDA,ACTION) VARIABLES: GMRCDA Type: Input This required variable is the file 123 ien. TIUDA Type: Input This required variable is the ien from the TIU DOCUMENT (#8925) file that is to be updated in the consult request (GMRCDA). ACTION Type: Input This required variable is teh activity to take on the consult using the TIU document. The only current implementation is the value of 2 which will update the consult to partial results and attach the TIU document with the Clinical Procedure request. $$CPDOC Type: Output This output variable will return: 1 = successful 0^error = unsuccessful^problem This entry point updates REQUEST/CONSULTATION (#123) file entries by attaching a TIU document as a result. COMPONENT: $$CPLINK(PROC) VARIABLES: PROC Type: Input This required variable is a pointer to the CP DEFINITION (#702.01) file. $$CPLINK Type: Output The output of this entry point will be in the form: 1 = currently linked to a GMRC PROCEDURE (#123.3) file entry 0 = not currently linked to a GMRC PROCEDURE (#123.3) file entry This entry point is used to determine if a given CP DEFINITION (#702.01) file entry is linked to any entry in the GMRC PROCEDURE (#123.3) file. COMPONENT: CPLINKS(.NAMES,PROC) VARIABLES: NAMES Type: Output This variable is passed by reference and is returned as array of GMRC PROCEDUREs linked to a given CP DEFINITION in format: NAMES(x)=GMRC PROCEDURE name^GMRC PROCEDURE ien NAMES(1)="EKG^21" NAMES(2)="EKG PORTABLE^32" if not currently linked, returned as: NAMES(1)="-1^not currently linked" PROC Type: Input This required variable is pointer to the CP DEFINITION (#702.01) file. This entry point returns a list of the GMRC PROCEDURE (#123.3) file entries linked to a given CP DEFINITION. COMPONENT: $$CPROC(PROC) VARIABLES: PROC Type: Input This required variable is a point to the GMRC Procedure (#123.3) file. $$CPROC Type: Output The output to this entry point is 0 or the pointer to the CP Definition (#702.01) file. This entry point returns the CP Definition that is mapped to an orderable procedure. ******************** 3469 NAME: RGJUSITE CUSTODIAL PACKAGE: CLINICAL INFO RESOURCE NETWORK SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: OCT 11,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function call is used to determine if the MPI/PD messages should be fired. It will check the STOP MPI/PD MESSAGING (#16) field in the CIRN SITE PARAMETER (#991.8) file. ROUTINE: RGJUSITE COMPONENT: SEND() VARIABLES: STOP Type: Output This function returns a zero if the messages are to be stopped. A positive one is returned if the messages are not to be stopped. A two is returned for suspend. ******************** 3470 NAME: DBIA3470 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INCOMPLETE RECORDS TRACKING USAGE: Private ENTERED: OCT 18,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Incomplete Records Tracking requests access to the Patient Movement routine DGPMV. IRT Enter/Edit screen contains a Treating Specialty Update protocol which calls CA^DGPMV. This protocol is the action to update the Treating Specialty and Primary and Attending physicians for the IRT package and ADT without exiting the IRT enter/edit option. ROUTINE: DGPMV COMPONENT: CA VARIABLES: DFN Type: Input DFN is set to the patient number. DGPMT Type: Input DGPMT is the Patient Movement type (set to 6 = Treating Specialty Transfer). DGPMCA Type: Input DGPMCA is the Patient Movement coresponding Admission. Y Type: Output Y is set to the Patient Movement entry added/edited. ******************** 3471 NAME: HLCSAC CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: OCT 19,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: HLCSAC COMPONENT: EN VARIABLES: loglink Type: Input Logical Link Name or IEN input Type: Input A clossed root representing an array containing message segments to be sent output Type: Output A closed root representing an array containing message segments returned This function is for use by the MPI application at each medical center to send HL7 messages over a direct connection to the MPI. The communication protocol that this function utilizes is proprietary. Therefore, this function is not recommended for use by any other application. Usage S returnval=$$EN^HLCSAC(loglink,input,output) If the function is fully successful, the return value will be 0(zero). Otherwise, a non-zero followed by an error message text will be returned in a format similar to "-1^error message". ******************** 3472 NAME: TIU use of GMRCCP CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES TIU calls $$CPACTM^GMRCCP to check the status of the consult as it related to Clinical Procedures (CP). TIU calls $$CPPAT^GMRCCP to check if the patient is associated with the consult. TIU calls $$CPINTERP^GMRCCP to see if a person can be an Interpreter for a particular document. USAGE: Private ENTERED: OCT 24,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement describes calls used by TIU in GMRCCP. ROUTINE: GMRCCP COMPONENT: $$CPACTM(GMRCDA) VARIABLES: GMRCDA Type: Input This required variable is the Request/Consultation file (#123) IEN. $$CPACTM Type: Output The output value of this function will return the following: 0 = not a CP request or TIU*1*109 not present 1 = CP request but no instrument report expected 2 = CP and still waiting on instr. or images 3 = CP and incomplete CP doc attached 4 = CP and complete CP doc attached This function returns the actions available for a CP request. COMPONENT: $$CPPAT(GMRCDA,GMRCDFN) VARIABLES: GMRCDA Type: Input This required variable is the Request/Consultation file (#123) IEN. GMRCDFN Type: Input This required variable is the Patient file (#2) IEN. $$CPPAT Type: Output The output value of this function will return the following: 1 = patient is object of request GMRCDA 0 = patient is NOT object of request in GMRCDA This function returns whether or not a patient is an object of the specified request. COMPONENT: $$CPINTERP(GMRCTIU,GMRCUSER) VARIABLES: GMRCTIU Type: Input This required variable is the TIU Document file (#8925) IEN. GMRCUSER Type: Input This required variable is the New Person file (#200) IEN. $$CPINTERP Type: Output The output value of this function will return the following: 1 = GMRCUSER is an interpreter 0 = GMRCUSER is NOT an interpreter This function returns whether or not a user is an interpreter for a specified TIU document. ******************** 3473 NAME: TIU use of GMRCTIU CUSTODIAL PACKAGE: CONSULT/REQUEST TRACKING SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES TIU calls $$SEND^GMRCTIU to get a list of consult requests for a patient. TIU calls GET^GMRCTIU to update the Consult from TIU. USAGE: Private ENTERED: OCT 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement describes calls used by TIU in GMRCTIU. ROUTINE: GMRCTIU COMPONENT: SEND(DFN,OVERRIDE,CP) VARIABLES: DFN Type: Input This required variable is the Patient file (#2) IEN. OVRRIDE Type: Input This optional variable is a boolean flag to override user validation. CP Type: Input This optional variable is set to 1 if only entries that have CP documents attached should be returned. This procedure gets a list of consults for a patient and returns them in ^TMP. COMPONENT: GET(GMRC0,GMRCTUFN,GMRCTUST,GMRCAUTH) VARIABLES: GMRC0 Type: Input This required variable is the Request/Consultation file (#123) IEN. GMRCTUFN Type: Input This required variable is the TIU Document file (#8925) IEN. GMRCTUST Type: Input This required variable is the TIU status of report. GMRCAUTH Type: Input This optional variable is the Author of the document. Update Consult from TIU. ******************** 3475 NAME: DBIA3475 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: SURGERY USAGE: Controlled Subscri ENTERED: NOV 5,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The purpose of this DBIA is to allow Surgery to display the patient's status related to environmental contaminants for patients having ambulatory surgery. ^DPT(D0,.322) .322013 ENVIRONMENTAL CONTAM .322;13 Read w/Fileman ROUTINE: ******************** 3476 NAME: DIEZ UNCOMPILE INPUT TEMPLATES/DELETE COMPILED ROUTINES CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: RADIOLOGY/NUCLEAR MEDICINE VistA Radiology will set the input variable DIEZ to the value of the input template to be deleted. VistA Radiology will set the value of the second input variable, DIFLAGS, to "D" to delete the associated compiled input template routines. REGISTRATION VistA Registration requests permission to un-compile input templates using the unsupported DIEZ call UNC^DIEZ(IEN). The IEN of the input template will be determined by the supported call FIND1^DIC. EX: IEN=$$FIND1^DIC(.402,"","X","DVBA C ADD 2507 PAT") USAGE: Controlled Subscri ENTERED: NOV 5,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine UNC^DIEZ is a silent VA FileMan call that allows the deletion of compiled Input Templates and their associated compiled routines. The entry point 'UNC' can accept two input parameters: DIEZ = The IEN of the input template to uncompile. DIFLAGS = "D" indicates all associated compiled routines are to be deleted. The variable DIEZ is required; the variable DIFLAGS is optional. ROUTINE: DIEZ COMPONENT: UNC VARIABLES: DIEZ Type: Input DIEZ is the Internal Entry Number (IEN) of the compiled input template to be deleted. DIFLAGS Type: Input DIFLAGS, when set to a value of "D", is used to indicate that all compiled input template routines for that compiled input template are to be deleted. The UNC entry point allows the deletion of the targeted compiled input templates and all associated compiled input template routines associated with those compiled input templates. ******************** 3477 NAME: TIU Uploads to SURGERY file CUSTODIAL PACKAGE: SURGERY SUBSCRIBING PACKAGE: TEXT INTEGRATION UTILITIES When the TIU-SURGERY interface patch (#TIU*1*112) is released, this agreement will no longer be needed (at least not in its current form), since sites will be uploading into the TIU DOCUMENT file instead of the SURGERY file. USAGE: Private ENTERED: NOV 6,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 130 ROOT: SRF( DESCRIPTION: TYPE: File This DBIA documents references from TIU upload routines to the SURGERY (#130), for upload of Surgeon's Dictation into the SURGERY file. ^SRF(DA, .01 PATIENT 0;1 Direct Global Read & w .09 DATE OF OPERATION 0;9 Direct Global Read & w 1.15 SURGEON'S DICTATION 12;0 Write w/Fileman ROUTINE: ******************** 3478 NAME: PSODRG CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING USAGE: Private ENTERED: NOV 15,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Allows CPRS to use EN^PSODRG to obtain information regarding lab tests linked to clozapine medications. ROUTINE: PSODRG COMPONENT: EN(drug) VARIABLES: drug Type: Input "drug" is the internal entry number of clozapine medication from the Drug fiile [#50]. LAB Type: Output LAB("NOT")=0 if medication is not clozapine LAB("BAD TEST")=0 if one or both lab tests aren't mapped LAB("ANC")=Lab file {#61} ien of ANC^Topography (specimen) file [#61] ien LAB("WBC")=Lab file {#61} ien of WBC^Topography (specimen) file [#61] ien Example: LAB("ANC")=1250^70 LAB("WBC")=1^70 Information is returned in "LAB": LAB("NOT")=0 if medication is not clozapine LAB("BAD TEST")=0 if one or both lab tests aren't mapped LAB("ANC")=Lab file {#61} ien of ANC^Topography (specimen) file [#61] ien LAB("WBC")=Lab file {#61} ien of WBC^Topography (specimen) file [#61] ien Example: LAB("ANC")=1250^70 LAB("WBC")=1^70 ******************** 3481 NAME: SC 0% NON COMPENSABLE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING SCHEDULING USAGE: Controlled Subscri ENTERED: NOV 23,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine For the Long Term Care Copay initiative IB has a requirement to determine if a patient is SC 0% non-compensable. Currently we are calling $$SC^DGMTR(DFN) to make that determination. ROUTINE: DGMTR COMPONENT: SC VARIABLES: DFN Type: Input DFN is the internal entry number to file 2 Patient File. Pass in the DFN to $$SC^DGMTR(DFN) returns "1" for yes and a "0" for no. ******************** 3484 NAME: HL7 Capacity Management Phase I API CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: NOV 26,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Returns Health Level 7 (HL7) activity totals for a parameter-supplied time range. Additional control over the HL7 activity included in the totals is available using passed parameters. (See HL*1.6*103 for additional information.) ROUTINE: HLUCM COMPONENT: $$CM VARIABLES: $$CM Type: Output Calling $$CM^HLUCM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) returns a 3 piece string of data. The pieces of data are: Piece 1 = Number of characters in all messages found by the API call. Piece 2 = Number of messages found by the API call. Piece 3 = Total transmission and receipt time for all messages found by API call. Calling $$CM^HLUCM returns this 3 piece string of data. In addition, when the API is called, it creates some ^TMP global data holding additional information about the messages found. Full information about the global created can be found in the patch HL*1.6*103 documentation. However, a brief overview of the data structure is provided below. The fifth parameter passed into the $$CM^HLUCM API is SAVE. This parameter specifies the initial subscript to be used in the ^TMP global data. (See the SAVE variable for more information.) For example, if the save parameter is passed as "DATA", the ^TMP global data is stored in ^TMP("DATA",$J,...). The ^TMP global data created by the $$CM^HLUCM call point is subdivided (by sorting subscripts) into the following sections: Totals by transmission time, namespace, and protocol. Totals by namespace, incoming/outgoing, namespace, transmission time, and protocol. Totals by namepsace, local/remote, namespace, transmission time, and protocol. Totals by protocol, namespace, and time. To explain the above information more fully, consider the last entry. What this means is that totals are sorted by protocol, and within protocol the totals are sorted by namespace, and within namespace the totals are sorted by transmission time. Example data, and additional explanation of the global data created by the API is in patch HL*1.6*103. SDT (param Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The first parameter, SDT, is the start time in Fileman format. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, SDT has the value of 3011123.12. EDT (param Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The second parameter, EDT, is the end time in Fileman format. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, EDT has the value of 3011123.13. NMSP (para Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The third parameter, NMSP, is the NAMESPACE of the entry(s) to be included. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, NMSP has the value of "DG". See patch HL*1.6*103 documentation for additional details. PROT (para Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The fourth parameter, PROT, is the PROTOCOL of the entry(s) to be included. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, PROT has the value of "VAFH A08". See patch HL*1.6*103 documentation for additional details. SAVE (para Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The fifth parameter, SAVE, is the initial subscript to use in the ^TMP global data. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, SAVE has the value of "DATA". This would cause the Creation of ^TMP("DATA",$J) data. COND (para Type: Input The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The sixth parameter, COND, defines criteria to be used when searching For messages. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, COND has the value of "BOTH". Passing the value of "BOTH" requires that each message has to have a namespace of "DG" and a protocol of "VAFH A08." In other words, 'both' the namespace and the protocol values have to be true before a message is counted. Instead of "BOTH", the value of "EITHER" can be passed. In the above Example, if "EITHER" had been passed as the value of COND, then Messages will be counted if 'either' the namespace is "DG" or the Protocol is "VAFH A08." In other words, if either criteria is Matched, a message is counted. See patch HL*1.6*103 documentation for addition information. ERR (param Type: Output The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The sixth parameter, COND, defines criteria to be used when searching For messages. An example call is shown below. W $$CM^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, ERR is passed by reference. No data is present in The ERR array prior to the call, (and even if it did, the ERR local Array is killed as one of the initial API actions, in order to ensure That the ERR array is empty at the start of processing.) If any Problems are encountered by the API, such as passing in invalid Parameter values, information about the error(s) is placed in the ERR local array and "passed back" to the calling process. See patch HL*1.6*103 documentation for addition information. The syntax for the $$CM call point is: $$CM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The passable parameters for this call pointer are explained below. SDT - Start date/time in Fileman format. (E.g., 3011123.1234) EDT - End date/time in Fileman format. NMSP - Namespace(s) of entries to be included. PROT - Protocol(s) to be included. SAVE - Free text name of inital subscript in ^TMP(SAVE,$j) global created by this call point. COND - Conditions under which matching entries are to be collected. ERR - Location for error information returned by the $$CM call point. ERR is passed by reference. The above information regarding the $$CM call point is provided as an overview of its capabilities. Refer to the documentation included in patch HL*1.6*103 for complete explanation. ******************** 3485 NAME: DBIA3485 CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: CONTROLLED SUBSTANCES USAGE: Private ENTERED: NOV 28,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 58.84 ROOT: PSD(58.84, DESCRIPTION: TYPE: File This is an open agreement between Drug Accountability and Controlled Substances. The terms of this agreement are to allow Controlled Substances access to the NAME (#.01) field in the DRUG ACCOUNTABILITY TRANSACTION TYPE file (#58.84). The method of access can be either Direct Read/Write or by using Filemanager. The reason for this agreement is that prior to the release of Drug Accountability 3.0, this file was the property of Controlled Substances. ^PSD(58.84,D0,0) .01 NAME 0;1 Direct Global R/W & w/ ROUTINE: ******************** 3486 NAME: IAS FOR OMGCOAS1 CUSTODIAL PACKAGE: CORBA SERVICES SUBSCRIBING PACKAGE: ORDER ENTRY/RESULTS REPORTING AUTOMATED MED INFO EXCHANGE ADDED 5/26/09 USAGE: Controlled Subscri ENTERED: FEB 5,2004 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This API is invoked by the server code for Remote Data Views to request Department of Defense patient data through Station 200 to the FHIE Framework system. The DoD data is retrieved and placed in the common CPRS Remote Data View format. ROUTINE: OMGCOAS1 COMPONENT: GCPR((IEN,DATATYPE,BEGDATE,ENDDATE,ORMAX) VARIABLES: IEN Type: Input Patient IEN DATATYPE Type: Input LRO - Lab Orders LRC - Chem & Hem SP - Surgical Pathology CY - Cytology MI - Microbiology RR - Radiology Report RXA - Active Outpatient RX RXOP- All Outpatient RX ADT - Admission/Discharge/Transfer Summary DS - Discharge Summary ALRG - Allergies CONS - Consult Report SADR - Standard Ambulatory Data BEGDATE Type: Input Starting date for report (Fileman internal format) ENDDATE Type: Input Ending date for report (Fileman internal format) ORMAX Type: Input Maximum number of observations to retrieve ~TMP("ORDA Type: Output 1.1.1.1 Output The CPRS Remote Data View server code expects the DoD data to be populated in ^TMP global nodes. The output generated by calls to GCPR^OMGCOAS1 is described in the following sections for each of the supported data partitions. In each section, the global nodes in ^TMP populated by the call are identified, and the data fields stored into these nodes are defined and mapped to elements in one of the data model templates maintained by the NGIT Framework. The following templates are used: LAB Laboratory data LabWebTopTemplate0204 RAD Radiology data RadWebTopTemplate0102 MED Medications data MedWebTopTemplate0205 ENC Patient Encounter data PatientEncounterTemplate0102 WL Working List data WorkingListTemplate0101 CONS Consults data ConsultsTemplate0101 The CORBA request for DoD data may fail with an exception status. If so, an error message is written to the global output node in ^TMP that would otherwise contain the Facility name. The most common cause of an exception is failure to connect to the Framework, in which case the error message should appear as: Unable to connect to DoD repository. Please contact the National Help Desk at 1-888-596-HELP (4357). 1.1.1.1.1 Chemistry and Hematology Data (LRC): ^TMP("LRC",$J,IDT,CNT)=CDT^SPC^TST^RSL^FLG^U NT^LO^HI where: IDT = Inverse collection date/time CND = Print order sequence number from file 60 CDT = Count value for observations SPC = Specimen for lab order in an external printable form TST = Lab test ordered in a external printable form RSL = Numeric result of test FLG = Reference flag (H, *H,L,*L). UNT = Unit of measure (external format). LO = Reference/Therapeutic Lower bound. HI= Reference/Therapeutic Upper bound. ^TMP("LRC ,$J,IDT, C )=Comments ^TMP("LRO",$J,IDT,CNT,"facility")=Facility 1.1.1.1.1 Standard Lab Orders Data (LRO): ^TMP("LRO",$J,IDT,cnt)=CDT^TST^SPC^URG^OS^MD ^ODT^ACC^RDT^COL where: IDT = Inverse collection date/time of order. cnt = Count value for observations. CDT = Collection date/time of order. TST = Lab test ordered. Variable format A;B where A=internal pointer, B=external text. SPC = Specimen. Variable format A;B where A=internal pointer, B=external text. URG = Urgency of lab order. OS = Status of lab order. MD = Provider. Variable format A;B where A=internal pointer, B=external text. ODT = Date/Time lab ordered. ACC = Accession number of lab order. RDT = Date/Time results for this lab order available. COL = Lab or ward collect. ^TMP("LRO",$J,IDT,SN_FN,"facility")=Facility 1.1.1.1.1 Surgical Pathology Data: ^TMP("LRA",$J,IDT,0) = ^ ^TMP("LRA",$J,IDT,.1) = "Site/Specimen"^ ^TMP("LRA",$J,IDT,.1,sub1) = .: ^TMP("LRA",$J,IDT,1.4,sub2) = ^TMP("LRA",$J,IDT,"facility") = 1.1.1.1.1 Cytopathology Data: ^TMP("LRCY",$J,IDT,0) = ^ ^TMP("LRCY",$J,IDT,1) = "Site/Specimen"^ ^TMP("LRCY",$J,IDT,1,sub1) = .: ^TMP("LRCY",$J,IDT,"NDX",sub2) = ^TMP("LRCY",$J,IDT,"facility") = 1.1.1.1.1 Microbiology Data: ^TMP("LRM",$J,RPT,SS)=CDT^ACC^CS^SS^TST^RSTA ^TMP("LRM",$J,RPT,SS,"RPT",n)=OC^ON^OQ ;organism category^name^quantity ^TMP("LRM",$J,RPT,SS,"RPT",n,ant)=ANTN^SEN^I NT ^TMP("LRM",$J,RPT,SS,"REPORT ,n)=text line of formatted report based on "RPT nodes ^TMP("LRM",$J,RPT,SS,"facility")=Facility where: RPT = Inverse report date/time SS = subscript value CDT = Collection date/time ACC = Accession CS = Collection Sample SS = Specimen TST = Lab Test Ordered RSTA = Report Status ANTN = Antibiotic name SEN = Sensitivity INT = Interpretation 1.1.1.1.1 Radiology Report Data: Global variable definitions: GMTSIDT = reverse exam date/time ^TMP("RAE",$J,GMTSIDT,sub1,0)= ^ ^ ^ ^ ^ ^ ^ ^ ^TMP("RAE",$J, GMTSIDT,sub1,"facility") = ^TMP("RAE",$J, GMTSIDT,sub1,"H",sub2) = ^TMP("RAE",$J, GMTSIDT,sub1,"R",sub2) = report text line, where report text is formatted as follows: Exm Date: Req Phys: Pat Loc: Img Loc: Service: Exam: CPT: Report Status: Date verified: Report: Reason for order: Order Comment: 1.1.1.1.1 All Outpatient RX Data This call is to be used when requesting Outpatient RX data from the FHIE Framework for display through CPRS. ^TMP("PSOO",$J,IFD,0)=ID^FD^DR^PR^ST^RX^QT^R F^EX Where: IFD = Inverse last fill date of Rx. ID = Issue date of Rx. FD = Last fill date of Rx. DR = Drug in Rx. Variable format A;B where A=internal pointer, B=external text. PR = Provider. Variable format A;B where A=internal pointer, B=external text. ST = Status of Rx. Variable format A;B where A=internal pointer, B=external text. RX = Rx number. QT = Quantity of DRG in Rx. RF = Number of refills remaining. EX = Expire/Cancel date of Rx. SIG = Medication instruction for this Rx. Output: ^TMP("PSOO",$J,IFD,n,0)=SIG ^TMP("PSOO",$J,IFD,"facility") = Facility [#Facility number] [,Phone number] 1.1.1.1.1 Discharge Summary report This call is to be used when requesting Discharge Summary data from the FHIE Framework for display through CPRS. The DoD Discharge Summary report will be formatted and passed in the HL7 message to the FHIE framework in formatted form. The report information is retrieved and displayed in the CPRS report exactly as formatted by the DoD CHCS I site. ^TMP("ORDATA",$J,IDT, WP ,1)=1^Facility name ^TMP("ORDATA",$J, IDT, WP ,2)=2^Admitted date/time ^TMP("ORDATA",$J, IDT, WP ,3)=3^Discharge date/time ^TMP("ORDATA",$J, IDT, WP ,4)=4^Author/Dictated by ^TMP("ORDATA",$J, IDT, WP ,5)=5^Approved by ^TMP("ORDATA",$J, IDT, WP ,6)=6^Status ^TMP("ORDATA",$J, IDT,"WP",9,report line number)=9^Report text lines 1.1.1.1.1 ADT Summary report This call is to be used when requesting ADTdata from the FHIE Framework for display through CPRS. The DoD ADT Summary information is passed to the FHIE framework through the appropriate ADT HL7 messages. The data is parsed and formatted into the appropriate ADT summary report consistent with CPRS Remote Data Views. ^TMP("ORDATA",$J,IDT,report line count)=report text line Report Format: DOB: Provider/Specialty: Attending/Ward: Admitting DX: Bed Section: LOS: DXLS: ICD DX: Disposition Place: Admitting Procedures: Procedure Procedure << repeats with multiple observations>> 1.1.1.1.1 Allergy report This call is to be used when requesting Allergy data from the FHIE Framework for display through CPRS. The DoD ADT Summary information is passed to the FHIE framework through the appropriate HL7 messages. The data is parsed and formatted into the appropriate Allergy summary report consistent with CPRS Remote Data Views. ^TMP("ORDATA",$J,IDT,"WP",1)=1^Facility Name ^TMP("ORDATA",$J,IDT,"WP",2)=2^Characteristi c Observed (Allergy Reactant) ^TMP("ORDATA",$J,IDT,"WP",3)=3^Allergy Type ^TMP("ORDATA",$J,IDT,"WP",4)=4^ ^TMP("ORDATA",$J,IDT,"WP",5)=5^ ^TMP("ORDATA",$J,IDT,"WP",6,report line number)=6^Comments 1.1.1.1.1 Consult Report This call is to be used when requesting Allergy data from the FHIE Framework for display through CPRS. The DoD ADT Summary information is passed to the FHIE framework through the appropriate HL7 messages. The data is parsed and formatted into the appropriate Allergy summary report consistent with CPRS Remote Data Views. ^TMP("ORDATA",$J,IDT,"WP",1)=1^Facility Name ^TMP("ORDATA",$J,IDT,"WP",2)=2^Request Date ^TMP("ORDATA",$J,IDT,"WP",3)=3^Completion Date ^TMP("ORDATA",$J,IDT,"WP",4)=4^Consult Service ^TMP("ORDATA",$J,IDT,"WP",5)=5^Status ^TMP("ORDATA",$J,IDT,"WP",6)=6^Procedure Type ^TMP("ORDATA",$J,IDT,"WP",7,report line number)=7^Consult Report Text Lines 1.1.1.1.1 SADR Report This call is to be used when requesting this SADR (Standard Ambulatory Data Record) data from the FHIE Framework for display through CPRS. The DoD SADR information is passed to the FHIE framework through the appropriate SADR HL7 messages. The data is parsed and formatted into a SADR report consistent with CPRS Remote Data Views. ^TMP("ORDATA",$J,IDT, WP ,report line count) = report text lines Report Format: Date Facility Hospital Location Encounter Provider ID: PCM Code: Diagnosis: ... Procedure: ... E and M: << Diagnoses and procedures repeat for multiple occurrences in the data>> MAKE REQUEST FOR DATA FROM THE FRAMEWORK. Invocation: D GCPR^OMGCOAS1(IEN,DATATYPE,BEGDATE,ENDDATE,ORMAX) Parameters: IEN: Patient IEN DATATYPE: Identifies requested report. Datatypes currently supported: LRO - Lab Orders LRC - Chem & Hem SP - Surgical Pathology CY - Cytology MI - Microbiology RR - Radiology Report RXA - Active Outpatient RX RXOP- All Outpatient RX ADT - Admission/Discharge/Transfer Summary DS - Discharge Summary ALRG - Allergies CONS - Consult Report SADR - Standard Ambulatory Data BEGDATE: Starting date for report (Fileman internal) ENDDATE: Ending date for report (Fileman internal) ORMAX: Maximum number of observations to retrieve Output: Results are returned in nodes of the ^TMP global specific to the requested report, e.g. ^TMP("ORDATA",$J) for ADT. ******************** 3487 NAME: HEALTH SUMMARY COMPONENT FILE #142.1 CUSTODIAL PACKAGE: HEALTH SUMMARY SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 8,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 142.1 ROOT: GMT(142.1, DESCRIPTION: TYPE: File ^GMT(142.1, .01 NAME 0;1 Read w/Fileman 1 PRINT ROUTINE 0;2 Read w/Fileman 2 TIME LIMITS APPLICAB 0;3 Read w/Fileman 3 ABBREVIATION 0;4 Read w/Fileman 4 MAXIMUM OCCURRENCES 0;5 Read w/Fileman 5 DISABLE FLAG 0;6 Read w/Fileman 6 LOCK 0;7 Read w/Fileman 8 OUT OF ORDER MESSAGE 0;8 Read w/Fileman 9 DEFAULT HEADER NAME 0;9 Read w/Fileman 10 HOSPITAL LOCATION AP 0;10 Read w/Fileman 11 ICD TEXT APPLICABLE 0;11 Read w/Fileman 12 PROVIDER NARRATIVE A 0;12 Read w/Fileman 13 PREFIX 0;13 Read w/Fileman 14 CPT MODIFIER APPLICA 0;14 Read w/Fileman ^GMT(142.1,D0,.1, .01 EXTERNAL/EXTRACT ROU 0;1 Read w/Fileman ^GMT(142.1,D0,1, .01 SELECTION FILE 0;1 Read w/Fileman 1 SELECTION COUNT LIMI 0;2 Read w/Fileman ^GMT(142.1,D0,3.5, .01 DESCRIPTION 0;1 Read w/Fileman ROUTINE: ******************** 3488 NAME: HL7 Capacity Management Phase II API CUSTODIAL PACKAGE: HEALTH LEVEL SEVEN SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: DEC 3,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Returns Health Level 7 (HL7) activity totals for a parameter-supplied time range. Additional control over the Hl7 activity included in the totals is available using passed parameters. (See HL*1.6*103 for additional information.) COMPARISON OF $$CM & $$CM2: --------------------------- Patch HL*1.6*79 holds phase I software, and is associated with DBIA# 3484. Phase I software is almost identical to phase II software, except in the number of "messages" returned by the two APIs. The call point for DBIA# 3484 - phase I software - is $$CM^HLUCM. The call point for this DBIA - phase II software - is $$CM2^HLUCM. $$CM^HLUCM returns the number of discrete message occurring during a parameter-defined period of time. $$CM2^HLUCM returns the number of "message units" during the same period of time. All other totals returned by both parameters are identical. A message is an individual message, such as an application acknowledgement. A message unit is made up of all related messages. The difference between a message (phase I, $$CM^HLUCM) and a message unit (phase II, $$CM2^HLUCM) can be illustrated using the following sequence of events. * Baltimore sends a message to Washington. * Washington sends back a commit acknowledgement to Baltimore. * Washington sends an application acknowledgement to Washington. * Baltimore sends back to Washington a commit acknowledgement for the just sent application acknowledgement. In the above example, $$CM^HLUCM would report a count of 4 messages. $$CM2^HLUCM would report a count of 1 message, or "message unit." (Since all 4 messages are "related", they are combined into one reported "message.") ROUTINE: HLUCM COMPONENT: $$CM2 VARIABLES: $$CM2 Type: Output Calling $$CM2^HLUCM(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) returns a 3 piece string of data. The pieces of data are: Piece 1 = Number of characters in all messages found by the API call. Piece 2 = Number of message units found by the API call. Piece 3 = Total transmission and receipt time for all message units found by API call. Calling $$CM2^HLUCM returns this 3 piece string of data. In addition, when the API is called, it creates some ^TMP global data holding additional information about the messages found. Full information about the global created can be found in the patch HL*1.6*103 documentation. However, a brief overview of the data structure is provided below. The fifth parameter passed into the $$CM2^HLUCM API is SAVE. This parameter specifies the initial subscript to be used in the ^TMP global data. (See the SAVE variable for more information.) For example, if the save parameter is passed as "DATA", the ^TMP global data is stored in ^TMP("DATA",$J,...). The ^TMP global data created by the $$CM2^HLUCM call point is subdivided (by sorting subscripts) into the following sections: Totals by transmission time, namespace, and protocol. Totals by namespace, incoming/outgoing, namespace, transmission time, and protocol. Totals by namepsace, local/remote, namespace, transmission time, and protocol. Totals by protocol, namespace, and time. To explain the above information more fully, consider the last entry. What this means is that totals are sorted by protocol, and within protocol the totals are sorted by namespace, and within namespace the totals are sorted by transmission time. Example data, and additional explanation of the global data created by the API is in patch HL*1.6*103. SDT Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The first parameter, SDT, is the start time in Fileman format. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, SDT has the value of 3011123.12. EDT Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The second parameter, EDT, is the end time in Fileman format. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, EDT has the value of 3011123.13. NMSP Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The third parameter, NMSP, is the NAMESPACE of the entry(s) to be included. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, NMSP has the value of "DG". See patch HL*1.6*103 documentation for additional details. PROT Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The fourth parameter, PROT, is the PROTOCOL of the entry(s) to be included. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, PROT has the value of "VAFH A08". See patch HL*1.6*103 documentation for additional details. SAVE Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The fifth parameter, SAVE, is the initial subscript to use in the ^TMP global data. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, SAVE has the value of "DATA". This would cause the creation of ^TMP("DATA",$J) data. COND Type: Input The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The sixth parameter, COND, defines criteria to be used when searching for messages. An example call is shown below. W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, COND has the value of "BOTH". Passing the value of "BOTH" requires that each message has to have a namespace of "DG" and a protocol of "VAFH A08." In other words, 'both' the namespace and the protocol values have to be true before a message is counted. Instead of "BOTH", the value of "EITHER" can be passed. In the above example, if "EITHER" had been passed as the value of COND, then messages will be counted if 'either' the namespace is "DG" or the protocol is "VAFH A08." In other words, if either criteria is matched, a message is counted. See patch HL*1.6*103 documentation for addition information. ERR Type: Output The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The seventh parameter, ERR, is the location for error information returned by the $$CM2 call. Here is an example call: W $$CM2^HLUCM(3011123.12,3011123.13,"DG","VAFH A08","DATA","BOTH",.ERR) In this example, ERR is passed by reference. No data is present in the ERR array prior to the call, (and even if it did, the ERR local array is killed as oneof the initial API actions, in order to ensure that the ERR array is empty at the start of processing.) If any problems are encountered by the API, such as passing in invalid parameter values, information about the error(s) is placed in the ERR local array and "passed back" to the calling process. See patch HL*1.6*103 documentation for addition information. The syntax for the $$CM2 call point is: $$CM2(SDT,EDT,NMSP,PROT,SAVE,COND,ERR) The passable parameters for this call pointer are explained below. SDT - Start date/time in Fileman format. (E.g., 3011123.1234) EDT - End date/time in Fileman format. NMSP - Namespace(s) of entries to be included. PROT - Protocol(s) to be included. SAVE - Free text name of inital subscript in ^TMP(SAVE,$j) global created by this call point. COND - Conditions under which matching entries are to be collected. ERR - Location for error information returned by the $$CM call point. ERR is passed by reference. The above information regarding the $$CM2 call point is provided as an overview of its capabilities. Refer to the documentation included in patch HL*1.6*103 for complete explanation. ******************** 3489 NAME: DBIA3489 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: BENEFICIARY TRAVEL USAGE: Private ENTERED: DEC 4,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 13 ROOT: DIC(13 DESCRIPTION: TYPE: File A direct read is used to display the CODE (#3) field if the zero node exists using $DATA on the zero node. ^DIC(13,D0,0 => CODE 3 CODE 0;4 Direct Global Read & w ROUTINE: ******************** 3491 NAME: DBIA3491 CUSTODIAL PACKAGE: SCHEDULING SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: DEC 7,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 40.7 ROOT: DIC(40.7 DESCRIPTION: TYPE: File ^DIC(40.7, .01 NAME 0;1 Read w/Fileman 1 AMIS REPORTING STOP 0;2 Read w/Fileman 2 INACTIVE DATE 0;3 Read w/Fileman ROUTINE: ******************** 3492 NAME: NAME VAFCPID2 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: DEC 12,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Master Patient Index VistA application would like to formalize the use of this API for standardization of the name as was done in patch DG*5.3*149 for transmission of patient names to the MPI in the query messages and for comparing existing names to MPI names. No updates to the patient file name would occur during this process. ROUTINE: VAFCPID2 COMPONENT: NAME VARIABLES: DFN Type: Input Internal entry number of the patient in the patient file. MPISTR Type: Both Initially, this variable is passed into the routine as the patient's name to be standardized. Upon existing the routine, this variable contains the standardized version of the name. FLG Type: Input This field is to denote wether of not the Patient file entry should be updated. Initially that was an option -- currently this field should never be yes. NAME(DFN,MPISTR,FLG) DFN - ien from Patient file MPISTR - name as stored in Patient file FLG - DON'T updated in patient file (default is not to update) - 1="Y", 0=" N" ******************** 3493 NAME: VAFCDD01 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: DEC 12,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Master Patient Index VistA would like to formalize the DBIA with Registration for use of AVAFC and XMITFLAG entry points for VAFCDD01. AVAFC - is being used to create an A08 message when the data on the ICN has been correlated but not updated on the site and then the site changes data but the update is not transmitted to the other sites and the MPI. XMITFLAG - is being used to set the REQUIRES TRANSMISSION field in the ADT/HL7 PIVOT file used in conjunction with the $$PIVNW^VAFHPIVT call to create a Treating Facility update entry in the ADT/HL7 PIVOT file. ROUTINE: VAFCDD01 COMPONENT: AVAFC VARIABLES: DFN Type: Input DFN is the internal entry number of the patient in the patient file that the A08 update is to be created for. This API creates an A08 entry in the ADT/HL7 PIVOT file. COMPONENT: XMITFLAG VARIABLES: PIVOTPTR Type: Input - Pointer to entry in ADT/HL7 PIVOT file (#391.71) - Use this parameter if the entry number is known - Not required if using PIVOTNUM parameter - Use of this parameter takes precedence over use the PIVOTNUM parameter PIVOTNUM Type: Input PIVOT NUMBER value (field #.02) for entry in ADT/HL7 PIVOT file (#391.71) - Use this parameter if the pivot number is known - Not required if using PIVOTPTR parameter TURNOFF Type: Input Denotes if REQUIRES TRANSMISSION field (#.08) should be turned on (set to 'YES') or off (set to 'NO') 1 = Turns transmission off 0 = Turns transmission on (default) Turn transmission flag for entry in ADT/HL7 PIVOT file on/off. ******************** 3494 NAME: VAFHPIVT CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: MASTER PATIENT INDEX VISTA USAGE: Private ENTERED: DEC 12,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This function returns 0 node of the ADT/HL7 Pivot file and ADT/HL7 Pivot file entry number, if no entry in the if no entry in pivot file, create one and return #:0 node ROUTINE: VAFHPIVT COMPONENT: $$PIVNW VARIABLES: DFN Type: Input The internal entry number of the patient to be added to the pivot file. EVDT Type: Input This the the event date/time (time is optional). EVTY Type: Input This is the event type - in our case for the treating facility update message it would be a 5. PTR Type: Input This is the variable pointer - in our case to the patient file. This function returns 0 node of the ADT/HL7 Pivot file and ADT/HL7 Pivot file entry number, if no entry in the if no entry in pivot file, create one and return #:0 node ******************** 3495 NAME: IAS FOR OMGPID01 CUSTODIAL PACKAGE: CORBA SERVICES SUBSCRIBING PACKAGE: MASTER PATIENT INDEX USAGE: Private ENTERED: DEC 13,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine NEWGCPR^OMGPID01 is the API that the MPI code calls when a new patient is added to the VA MPI. This API performs the findOrRegisterIds interface to the Framework for patient correlation. It is the reverse of the findCandidates interface. ROUTINE: OMGPID01 COMPONENT: NEWGCPR VARIABLES: IEN Type: Input INTERNAL ENTRY NUMBER OF THE PATIENT BEING ADDED TO THE MPI. THIS API PERFORMS THE findOrRegisterids interface to the Framework for patient correlation. ******************** 3496 NAME: VAFC REMOTE PDAT CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX MASTER PATIENT INDEX VISTA USAGE: Controlled Subscri ENTERED: DEC 19,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Remote Procedure MPI/PD developers request the use of the VAFC REMOTE PDAT remote procedure call distributed in patch DG*5.3*414. This remote procedure call returns the text Patient MPI/PD Data Inquiry report to a remote site. Usage: I +LOC>0 D EN1^XWB2HL7(.RETURN,LOC,"VAFC REMOTE PDAT",1,ICN,"") This Remote Procedure Call will return the text Patient MPI/PD Data Inquiry report to a remote site. ROUTINE: PDAT VAFCRPC ******************** 3497 NAME: coreFLS/Pharmacy Interface CUSTODIAL PACKAGE: DRUG ACCOUNTABILITY SUBSCRIBING PACKAGE: COMMUNICATIONS SERVICE LIBRARY USAGE: Controlled Subscri ENTERED: DEC 19,2001 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: XTMP( DESCRIPTION: TYPE: Routine Define the use of ^XTMP("PSAPUSH") in the coreFLS/Pharmacy interface. ^XTMP('PSAPUSH', This temprary global will store the content of a pharmacy order receipt. ROUTINE: CSLPHAR COMPONENT: CSLPHAR VARIABLES: XTMP Type: Output The coreFLS receipt information will be parsed into ^XTMP("PSAPUSH") in the following format: ^XTMP("PSAPUSH",0) = Kernel Purge Date ^ Today's Date ^XTMP("PSAPUSH",$H,PO#,Receipt#) = Vendor Name ^ PO Date ^ Date Received ^ Pharmacy Location ^ Transaction Type ^ (Null) ^ Ship to Address ^ Revision# ^XTMP("PSAPUSH",$H,PO#,Receipt#,Line#,1) = Item Number ^ Item Description ^ Packaging Multiple (Ordered) ^XTMP("PSAPUSH",$H,PO#,Receipt#,Line#,2) = Controlled Substances Flag ^ Quantity Received ^ Unit of Measure (Received) ^ Packaging Multiple (Received) ^ National Drug Code ^ Purchase Order Quantity ^ Unit Price ^ Vendor Stock Number ^ Unit of Measure (Ordered) ** Receipt# = OrgID_"-"_Receipt# Parse coreFLS receipt message into ^XTMP("PSAPUSH") which will be used by VistA Drug Accountability package. ******************** 3498 NAME: DBIA3498 CUSTODIAL PACKAGE: COMMUNICATIONS SERVICE LIBRARY SUBSCRIBING PACKAGE: SURGERY USAGE: Controlled Subscri ENTERED: DEC 26,2001 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Build an SIU transaction of patient schedule to transmit to DynaMed. This function is meant to be called in foreground, not background as messages will be displayed to the user. If the transaction is built successfully, the function will display this fact with the Message Control ID. If the transaction cannot be built, the function will display the fact that nothing was built, and the reason this occurred. After the message displays, the user will be expected to hit the or key to continue. ROUTINE: CSLSUR1 COMPONENT: $$BLDSEG(1) VARIABLES: $$BLDMSG Type: Output 0 - Case was not successfully set up in HL7 ^ Reason 1 - Case was set up successfully in HL7 global TMP Type: Input Node Value ---------- ------------------------------ ---------------------- 1 Surgical Case Number 2 Patient's ID ^ Patient ICN 3 Event Type: 1- New, 2- Edit, 3- Cancel, 4- Delete 4 Start Date and Time ^ End Date and Time ^ Date of Operation 5,0 Surgeon's free text description of the Principal Procedure (up to 135 char) 5,1 Principal CPT Code ^ Name associated with the Principal CPT Code 5,1,1-n CPT Code Modifier Code ^ CPT Code Modifier Name 5,2-n Other CPT Code ^ Other CPT Code Name 5,2-n,1-n CPT Code Modifier Code ^ CPT Code Modifier Name 6 Surgeon ID ^ Surgeon's Name 7 Surgical Specialty ID ^ Surgical Specialty Name 8 Local Surgical Specialty ID ^ Local Surgical Specialty Name 9 Operating Room Code/ID ^ Operating Room Name 10,1-n SPD Comment lines 1 through n, each line 80 characters max 11 Hospital ID (pointer to file #4 Institution File) 12 ID of Requestor ^Name of Requestor 13 ID of Person who enters/edits schedule ^ Name 14 Patient Type: I- Inpatient, O- Outpatient 15 Time Stamp (Time event occurred in the application) 16 Attending Surgeon ID (IEN in file 200) ^Surgeon Name note: ^TMP("CSLSUR1",$J) may be set to null on entry to the API with no negative effect. 1 Type: Input This parameter is required and it indicates the parameters are being passed in ^TMP("CSLSUR1",$J). At this time, this is always set to 1. NOTE: ^TMP("CSLSUR1",$J) will be killed by this call ******************** 3499 NAME: DBIA3499 CUSTODIAL PACKAGE: ENROLLMENT APPLICATION SYSTEM SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: JAN 14,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The purpose of this API is to facilitate the check for a required means test for a veteran during appointment management. A deficiency noted in the "Report of Task Force to Review Enrollment, Means Testing and Income Verification", item #22, required VHA to identify a means to acquire veterans' signatures on means tests at a local level. This API provides a procedure that when called will check on a veteran means test status and return a flag on whether a means test is required or not, and optionally, a related text message that can be displayed by the calling procedure. This API is provided in the Enrollment Application Systems namespace. ROUTINE: EASMTCHK COMPONENT: MT(DFN,EASAPT,EASACT,EASDT,EASQT,EASMSG) VARIABLES: DFN Type: Input Contains the Internal Entry Number of the patient in the PATIENT File, #2. EASAPT Type: Input Contains the Internal Entry Number of the appointment type from the APPOINTMENT TYPE, File #409.1. Current requirements are for action only on "Regular" type appointments. EASACT Type: Input Appointment action flag [Optional]. Used to specify the appointment action being taken. If not specified, a default of "Other" is used. Walk-In and Other appointment actions will not block an appointment action, and may be used for returning a MT status message. M - Make an appointment C - Check In/Out an existing appointment W - Unscheduled/Walk-In appointment O - Other (Default) EASDT Type: Input Appointment Date/Time in FileMan format. If the appointment type is not available, then the appointment date/time must be passed. EASMSG Type: Input Return array for alert message [Optional], if defined, the alert text is copied to the array. Can be used in conjunction with EASQT to control how and when alert messages are displayed. RSLT Type: Output Outputcontains the results: 1 - MT Required 0 - MT Not required EASQT Type: Input Silent flag [Optional], if set, prevents display of alert message. The MT^EASMTCHK entry point returns a flag and alert messgae if a means test update is required for the patient. If a means test update is not required, a "0" is returned. The IEN in the PATIENT File, #2, is passed into the call as variable DFN. If DFN is not populated, the call fails. EASAPT is the IEN of the Appointment type in the APPOINTMENT TYPE File, #409.1, and EASDT is the date of the appointment. If the Appointment type is not available, then the appointment date/time must be passed in. When the Appointment action flag is "C", the appointment date/time is used to lookup the appointment and determine the appointment type for the MT status determination. Normally either the appointment type or the appointment date/time will be available to the API. If one or the other is not passed in, the API will return "0". ******************** 3500 NAME: PDM CONVERSION ACCESS CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY DATA MANAGEMENT USAGE: Private ENTERED: JAN 16,2002 STATUS: Active EXPIRES: JUL 16,2002 DURATION: Next Version VERSION: FILE: 52 ROOT: PSRX(D0 DESCRIPTION: TYPE: File Pharmacy Data Management (PDM) requests a one-time DBIA with Outpatient Pharmacy to allow direct read access to the PRESCRIPTION file (#52), to retrieve the LOGIN DATE field (#21). As part of the Pharmacy Benefits Management project, PDM is processing through all Unit Dose, IV and Outpatient Pharmacy orders/prescriptions to find the first Pharmacy service date. In order to do this, PDM needs to be able to retrieve the login date information for a prescription. This will be in a multi-package build titled PSS PSJ PSO Service Date. ^PSRX(D0,2) 21 LOGIN DATE 2;1 Direct Global Read & w ROUTINE: ******************** 3501 NAME: DBIA3501 CUSTODIAL PACKAGE: OUTPATIENT PHARMACY SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT The Pharmacy Benefits Management package extracts outpatient data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. MYHEALTHEVET USAGE: Private ENTERED: JAN 17,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 52 ROOT: PSRX( DESCRIPTION: TYPE: File ^PSRX( 20 DIVISION 2;9 Direct Global Read & w 2 PATIENT 0;2 Direct Global Read & w ROUTINE: ******************** 3502 NAME: PHARMACY DATA MANAGEMENT CUSTODIAL PACKAGE: PHARMACY DATA MANAGEMENT SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT The Pharmacy Benefits Management package extracts patient demographic, inpatient and outpatient data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. The following read only information is needed for the extract: USAGE: Private ENTERED: JAN 24,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 55 ROOT: PS(55 DESCRIPTION: TYPE: File ^PS(55 .07 FIRST SERVICE DATE 0;7 Direct Global Read & w .08 ACTUAL/HISTORICAL FL 0;8 Direct Global Read & w ^PS(55,D0,'IV',D1 9 ORIGINAL WARD 2;10 Direct Global Read & w 68 LAST WARD LOCATION 0;23 Direct Global Read & w 104 WARD 0;22 Direct Global Read & w ^PS(55,D0,5,'B',D1 Order Number Cross Reference ROUTINE: ******************** 3503 NAME: PATIENT DATES OF LEAVE FOR A BILLING DATE RANGE CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: INTEGRATED BILLING USAGE: Private ENTERED: JAN 28,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Integrated Billing requires a list of the # of leave/pass and ASIH days in a billing cycle period and the start and end dates of each leave period used to compile this number. ROUTINE: DGUTL2 COMPONENT: APLD VARIABLES: DGPMCA Type: Input Input variable containing the corresponding admission internal entry number. Variable is required and must contain a valid pointer to the Patient Movement (#405) file. DGARR Type: Both Required variable containing the output array name passed by reference. Function call returns a -1 if the required input parameters are missing or invalid. The following array is returned: DGARR(0)=Total days^Begin Date^Ending Date DGARR(Pointer to Patient Movement file)=Movement Start Date^Movement End Date^Total # of days^Movement type (P405.2)^RTN^Return movement type (P405.2)^Return movement IEN (P405) DGBDT Type: Input Required input variable containing the billing start date DGEDT Type: Input Required input variable containing the billing end date DGMTYP Type: Input Optional parameter containing requested movement types: A: ASIH movements only P: Pass and leave movements only B: Both (default) ******************** 3504 NAME: 3504 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: JAN 30,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 2 ROOT: DPT( DESCRIPTION: TYPE: File The Pharmacy Benefits Management package extracts patient demographic data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. The following read only patient information is needed for the extract: ^DPT(D0 .6 TEST PATIENT INDICAT 0;21 Direct Global Read & w ROUTINE: ******************** 3505 NAME: Imaging Type file CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging VistARad software provides the Radiologist an on-line worklist (patient exams) displayed on a VistARad workstation. The worklist should contain the Imaging type and its abbreviation for each exam. The information is located in the Imaging Type file (79.2) in fields .01 and 3. Imaging is requesting permission to read this information. VA POINT OF SERVICE (KIOSKS) CLINICAL REMINDERS HEALTH MANAGEMENT PLATFORM ******************************************************** ****************** HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP*2.0*12 released on 10/17/17 is an informational patch outlining the steps for the sites to shut down the application. If HMP is reactivated in the future, the HMP project team should review the access provided by this ICR with the custodial application before reactivating HMP's subscription to this ICR. ******************************************************** ****************** USAGE: Controlled Subscri ENTERED: JAN 30,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79.2 ROOT: RA(79.2, DESCRIPTION: TYPE: File Radiology gives Imaging permission to read file 79.2, IMAGING TYPE. ^RA(79.2, .01 TYPE OF IMAGING 0;1 Direct Global Read & w Name of a type of imaging. 3 ABBREVIATION 0;3 Direct Global Read & w The abbreviation associated with the type of imaging. ^RA(79.2,'C',ABBREVIATION,DA Allows for the look-up of an imaging location by abbreviation. ROUTINE: ******************** 3506 NAME: Imaging (file 79) CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging is referencing the .1 data node of file 79, RAD/NUC MED DIVISION. This is to set the variable RAMDV that is needed to execute the routine to update the exam's status to the next default exam status defined in the Radiology's Exam Status file. The RAMDV variable contains the Radiology Division entry's parameters that the module uses during various stages of exam and report processing and inquiring. These parameter switches allow the 'customizing' of the module for each division by the package coordinator. USAGE: Controlled Subscri ENTERED: FEB 1,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 79 ROOT: RA(79 DESCRIPTION: TYPE: File Radiology gives Imaging permission to read file 79, RAD/NUC MED DIVISION. ^RA(79,DA,.1 .12 PRINT FLASH CARD FOR .1;2 Direct Global Read & w Division parameter to control the printing of flash card for each exam. .16 AUTO USER CODE FILIN .1;6 Direct Global Read & w Division parameter to indicate that the user should be asked for their access code during the processing of exams and reports of which various activity logs are kept. .17 DETAILED PROCEDURE R .1;7 Direct Global Read & w Division parameter that controls if the entry of a 'detailed', 'series' or 'parent' procedure type should be required during the initial exam registration or request. .18 PRINT JACKET LBLS W/ .1;8 Direct Global Read & w Division parameter controls the automatic printing of a jacket label during each visit. .19 ASK 'CAMERA/EQUIP/RM .1;9 Direct Global Read & w Division parameter controls whether during an exam edit if the camera/equip/rm is asked. .11 TRACK EXAM STATUS CH .1;10 Direct Global Read & w Division parameter to control the collecting of the date and time of exam status changes. .111 ASK EXAM STATUS TIME .1;11 Direct Global Read & w Division parameter that controls the prompting for exact date/time of the exam status change. If this parameter is not set then defaults to current date/time. .112 ALLOW STANDARD REPOR .1;12 Direct Global Read & w Division parameter controls whether a standard report can be selected during report entry/edit process. .113 ALLOW BATCHING OF RE .1;13 Direct Global Read & w Division parameter that allows placing reports in a batch during report entry. .114 ALLOW COPYING OF REP .1;14 Direct Global Read & w Division parameter that allow copying the contents of one report's text and impression into another. .116 IMPRESSION REQUIRED .1;16 Direct Global Read & w Division parameter that controls if an impression is required to be given on a report before: 1) the report can be verified and 2) the exam can be considered 'complete'. .117 ASK 'REQUESTED DATE' .1;17 Direct Global Read & w Division parameter that controls if the transcriptionist should be prompted for the Desired Date for the exam. This field is set to 'YES' by the system. .118 ALLOW VERIFYING BY R .1;18 Direct Global Read & w Division parameter that controls if interpreting residents should be allowed to verify other interpreting physicians' reports. .119 TRACK REQUEST STATUS .1;19 Direct Global Read & w Division parameter that controls collecting the date and the time of request status changes. .121 ASK 'IMAGING LOCATIO .1;21 Direct Global Read & w Division parameter that controls if the user should be asked when requesting an exam, which 'Imaging Location' the request should be forwarded to. .122 ALLOW RPTS ON CANCEL .1;22 Direct Global Read & w Division parameter that controls if the user who does not have the RA MGR key may enter a report for an exam that has a status of CANCELLED. .124 TIME LIMIT FOR FUTUR .1;24 Direct Global Read & w Division parameter that controls the number of hours in the future (0-168) that a user may register a patient for an exam. .125 WARNING ON RPTS NOT .1;25 Direct Global Read & w Division parameter that controls the display of the 'report status' on reports in any status except 'Verified' will print the status surrounded by asterisks under the body of the report. .126 AUTO E-MAIL TO REQ. .1;26 Direct Global Read & w Division parameter that controls automatically sending Requesting Physicians the radiology reports via e-mail. .127 ALLOW E-SIG ON COTS .1;27 Direct Global Read & w Division parameter that controls automatically adding the Electronic Signature Block printed name of the Verifying Physician that signed the report being transmitted to Rad/Nuc Med via an HL7 interface to a COTS voice reporting system. .128 INTERPRETING STAFF R .1;28 Direct Global Read & w Division parameter that controls the required entry of 'PRIMARY INTERPRETING STAFF' to be mandatory when entering Diagnostic data or Reports. ROUTINE: ******************** 3507 NAME: Imaging - RAUTL CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING To be consistent with the display used throughout the Radiology application Imaging is calling D^RAUTL to output the date/time value. USAGE: Controlled Subscri ENTERED: JAN 31,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives Imaging permission to execute D^RAUTL. ROUTINE: RAUTL COMPONENT: D VARIABLES: Y Type: Input Y=internal Fileman format of date and time. Utility to display the date and time in a readable format. ******************** 3508 NAME: Imaging - RAUTL11 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING VistARad is calling SVTCOM^RAUTL11 to save the TECH COMMENT in ^TMP($J,"RAE2" global. This information is presented to the Radiologist on the VistARad workstation's on-line exam worklist. USAGE: Controlled Subscri ENTERED: JAN 31,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives Imaging permission to execute SVTCOM^RAUTL11. ROUTINE: RAUTL11 COMPONENT: SVTCOM VARIABLES: RADFN Type: Input Patient's dfn. RADTI Type: Input The EXAM DATE internal entry number. RACNI Type: Input The CASE NUMBER internal entry number. Utility to read the exam's tech comments and save the results in ^TMP($J,"RAE2" global. ******************** 3509 NAME: Imaging - RAO7PC1A CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING VistARAd software is utilizing the SETDATA^RAO7PC1A to set one entry in the ^TMP($J,"RAE1",patient ien,Exam ID) node. This is used when a Radiologist selects an exam from the workstation's exam listing and/or used for prefetching. USAGE: Controlled Subscri ENTERED: JAN 31,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives Imaging permission to call SETDATA^RAO7PC1A. ROUTINE: RAO7PC1A COMPONENT: SETDATA VARIABLES: RADFN Type: Input Patient's dfn. RAIBDT Type: Input EXAM DATE internal entry number. RAEXN Type: Input Maximum number of exams to be researched. RAXIT Type: Input Variable to determine exiting from program. RACNT Type: Input Processing counter. TMP($J,'RA Type: Output Temporary global that holds the results as follows. TMP($J,"RAE1",Patient IEN,Exam ID)=Procedure name^Case number^ ; Report status^Abnormal alert flag^Report ien^ ; Exam status order #~Exam status name^ ; Imaging location name^Imaging type abbr~ ; Imaging type name^abnormal results flag^CPT Code ; ^CPRS Order ien^Images exist flag Utility to set the radiology exam information into the ^TMP($J,"RAE1" global. ******************** 3510 NAME: Imaging - Complication Types CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging displays the exam's associated COMPLICATION TYPE on the on-line Exam Worklist provided on VistARad workstation for Radiologist to review and process. Imaging is requesting permission to read field #.01 COMPLICATION in file 78.1, COMPLICATION TYPES. USAGE: Controlled Subscri ENTERED: FEB 1,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 78.1 ROOT: RA(78.1, DESCRIPTION: TYPE: File Radiology gives Imaging permission to read the COMPLICATIONS TYPES file. ^RA(78.1, .01 COMPLICATION 0;1 Direct Global Read & w This field contains the name of the type of complication that may be associated with an exam. ROUTINE: ******************** 3511 NAME: DBIA3511 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT USAGE: Private ENTERED: FEB 4,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 45 ROOT: DGPT( DESCRIPTION: TYPE: File The Pharmacy Benefits Management package extracts outpatient and inpatient visit data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. Patient information is needed from cross references, as well as admission date and ICD codes. These fields are included in the following references: ^DGPT('B' Patient cross reference. ^DGPT('ADS' Discharge Date cross reference. ^DGPT(D0,'P','AP6' Procedure Code cross reference. ^DGPT(D0,'S','AO' Procedure Code cross reference. ^DGPT(D0,'AP' Procedure Code cross reference. ^DGPT( .01 PATIENT 0;1 Direct Global Read & w 2 ADMISSION DATE 0;2 Direct Global Read & w 79 DXLS 70;10 Direct Global Read & w (#79) PRINCIPAL DIAGNOSIS [10P:80] from DD 11/24/17 79.16 ICD2 70;16 Direct Global Read & w (#79.16) SECONDARY DIAGNOSIS 1 [16P:80] from DD 11/24/17 79.17 ICD3 70;17 Direct Global Read & w (#79.17) SECONDARY DIAGNOSIS 2 [17P:80] from DD 11/24/17 79.18 ICD4 70;18 Direct Global Read & w (#79.18) SECONDARY DIAGNOSIS 3 [18P:80] from DD 11/24/17 79.19 ICD5 70;19 Direct Global Read & w (#79.19) SECONDARY DIAGNOSIS 4 [19P:80] from DD 11/24/17 79.201 ICD6 70;20 Direct Global Read & w (#79.201) SECONDARY DIAGNOSIS 5 [20P:80] from DD 11/24/17 79.21 ICD7 70;21 Direct Global Read & w (#79.21) SECONDARY DIAGNOSIS 6 [21P:80] from DD 11/24/17 79.22 ICD8 70;22 Direct Global Read & w (#79.22) SECONDARY DIAGNOSIS 7 [22P:80] from DD 11/24/17 79.23 ICD9 70;23 Direct Global Read & w (#79.23) SECONDARY DIAGNOSIS 8 [23P:80] from DD 11/24/17 79.24 ICD10 70;24 Direct Global Read & w (#79.24) SECONDARY DIAGNOSIS 9 [24P:80] from DD 11/24/17 80 PRINCIPAL DIAGNOSIS 70;11 Direct Global Read & w (#80) PRINCIPAL DIAGNOSIS pre 1986 [11P:80] from DD 11/24/17 ^DGPT(D0,'M','AC' ICD pointers ROUTINE: ******************** 3512 NAME: DBIA3512 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: PHARMACY BENEFITS MANAGEMENT VA CERTIFIED COMPONENTS - DSSI USAGE: Controlled Subscri ENTERED: FEB 4,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File The Pharmacy Benefits Management package extracts outpatient visit data monthly to support the VA National Formulary, disease management issues and patient safety initiatives. The following references are needed for extract. ^AUPNVSIT(D0 .01 VISIT/ADMIT DATE 0;1 Direct Global Read & w .05 PATIENT NAME 0;5 Direct Global Read & w 15002 PATIENT STATUS IN/OU 150;2 Direct Global Read & w ROUTINE: ******************** 3513 NAME: Imaging - RAORD5 CUSTODIAL PACKAGE: RADIOLOGY/NUCLEAR MEDICINE SUBSCRIBING PACKAGE: IMAGING Imaging software uses the "Print Request" routine, RAORD5, to display a selected radiology order on the VistARad workstation. The use of this routine allows the Radiologist to view the order as if he/she was using the Radiology menu option. When displaying information that is stored in the Radiology database the information provided to the Radiologist on a VistARad workstation should be transparent to the application. USAGE: Controlled Subscri ENTERED: FEB 5,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Radiology gives Imaging permission to call RAORD5. ROUTINE: RAORD5 COMPONENT: RAORD5 VARIABLES: RADFN Type: Input Patient's DFN. RAOIFN Type: Input Exam's entry IEN in the RAD/NUC MED ORDERS file (75.1). RAX Type: Input Variable used to exit routine. RAPGE Type: Input Page counter. Routine that prints a Radiology request. ******************** 3519 NAME: TIU EXTRACT SELECTED FIELDS BY CLASS CUSTODIAL PACKAGE: TEXT INTEGRATION UTILITIES SUBSCRIBING PACKAGE: HEALTH SUMMARY Health Summary will used this API (in leiu of TIUAPIC) when only a few fields are desired during data extraction to help speed up extract/display times. USAGE: Controlled Subscri ENTERED: FEB 11,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Extraction of selected fields from TIU by Document Class. ROUTINE: TIULAFC COMPONENT: MAIN(DFN,DOC,TIME1,TIME2,OCCLIM,TEXT,.FLDS,IDX) VARIABLES: DFN Type: Input The IEN of the PATIENT file #2 (required) DOC Type: Input TIU document class, IEN of the TIU DOCUMENT DEFINITION file #8925.1 (required) TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input A maxixum limit of occurrences of the type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) .FLDS Type: Input An array of fields to extract from the TIU DOCUMENT file #8925 and passed by reference (required) Format: FLD()="" IDX Type: Input This is a field number from the TIU DOCUMENT file #8925 to use to create an index in the ^TMP global (optional). This field must also be included in FLDS() array. Creates the following index in the ^TMP global: ^TMP("TIU",$J,"IDX",,,) This TMP index can be used to display the data in an order other than 'REFERENCE DATE' This entry point is used to extract TIU documents by document Reference Date. It differs from MAIN^TIULAPIC in that the fields required may be passed in by reference and the resulting global array may be indexed by a field other that the Reference Date. COMPONENT: VISIT(DFN,DOC,TIME1,TIME2,LIM,TEXT,.FLDS,IDX) VARIABLES: DFN Type: Input The IEN of the PATIENT file #2 (required) DOC Type: Input TIU document class, IEN of the TIU DOCUMENT DEFINITION file #8925.1 (required) TIME1 Type: Input The beginning date for a range of dates to extract TIU documents (optional, default 6666666) TIME2 Type: Input The ending date for a range of dates to extract TIU documents (optional, default 9999999) OCCLIM Type: Input A maxixum limit of occurrences of the type of document to extract (optional, default 999) TEXT Type: Input Boolean flag (1/0) to include or not to include document text with the extraction (required) .FLDS Type: Input An array of fields to extract from the TIU DOCUMENT file #8925 and passed by reference (required) Format: FLD()="" IDX Type: Input This is a field number from the TIU DOCUMENT file #8925 to use to create an index in the ^TMP global (optional). This field must also be included in FLDS() array. Creates the following index in the ^TMP global: ^TMP("TIU",$J,"IDX",,,) This TMP index can be used to display the data in an order other than 'VISIT DATE' This entry point is used to extract TIU documents by document Visit Date. It differs from VISIT^TIULAPIC in that the fields required may be passed in by reference and the resulting global array may be indexed by a field other that the Visit Date. ******************** 3520 NAME: %ZTSCH(TASK Global CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX USAGE: Controlled Subscri ENTERED: FEB 12,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: %ZTSCH(TASK, DESCRIPTION: TYPE: File CLINICAL INFO RESOURCE NETWORK - Master Patient Index/Patient Demographics (MPI/PD) will make our RGMTRUN utility routine class I at all VA facilities. We will create a remote query tool on the Master Patient Index (MPI) to query a site for the currently running task information. The following code in RGMTRUN examines the currently running tasks in the SCHEDULE file. For each task found, it examines the ROUTINE field. If the ROUTINE field contains "HL" (Health Level Seven), then for that task, EN^XUTMTP(TASK) is called to display the task information. S TASK=0 F S TASK=$O(^%ZTSCH("TASK",TASK)) Q:'TASK Q:QFLG D .S ROU=$P(^%ZTSCH("TASK",TASK),"^",2) .I ROU["HL" D EN^XUTMTP(TASK) This IA is for direct global read of the ^%ZTSCH("TASK",TASK) node of the SCHEDULE file and for direct global read, $P(^%ZTSCH( "TASK",TASK),"^",2) for pieces 2 and 4, ROUTINE and OPTION NAME. ^%ZTSCH(TASK, Examine the currently running tasks in the SCHEDULE file. For each task found, examine the ROUTINE field. S TASK=0 F S TASK=$O(^%ZTSCH("TASK",TASK)) Q:'TASK Q:QFLG D .S ROU=$P(^%ZTSCH("TASK",TASK),"^",2) ROUTINE: ******************** 3521 NAME: XUTMTP Routine CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: CLINICAL INFO RESOURCE NETWORK MASTER PATIENT INDEX USAGE: Controlled Subscri ENTERED: FEB 12,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine CLINICAL INFO RESOURCE NETWORK - Master Patient Index/Patient Demographics (MPI/PD) will make our RGMTRUN utility routine class I at all VA facilities. We will create a remote query tool on the Master Patient Index (MPI) to query a site for the currently running task information. The following code in RGMTRUN examines the currently running tasks in the SCHEDULE file. For each task found, it examines the ROUTINE field. If the ROUTINE field contains "HL" (Health Level Seven), then for that task, EN^XUTMTP(TASK) is called to display the task information. S TASK=0 F S TASK=$O(^%ZTSCH("TASK",TASK)) Q:'TASK Q:QFLG D .S ROU=$P(^%ZTSCH("TASK",TASK),"^",2) .I ROU["HL" D EN^XUTMTP(TASK) This IA allows MPI/PD to call the EN entry point in routine XUTMTP. ROUTINE: XUTMTP COMPONENT: EN(TASK) VARIABLES: TASK Type: Input TaskMan's task ID. ZTENV Type: Input set = 1 ZTKEY Type: Input set = 0 ZTNAME Type: Input set = ZTFLAG Type: Input set = 1 XUTMUCI Type: Input X ^%ZOSF("UCI") S XUTMUCI=Y Examine the currently running tasks in the SCHEDULE file. For each task found, examine the ROUTINE field. If the ROUTINE field contains "HL" (Health Level Seven), then for that task, EN^XUTMTP(TASK) is called to display the task information. Example of information displayed by EN^XUTMTP(TASK): ---------------------------------------------------- 261181: EN^HLCSLM, HL7 Link Manager. No device. DEV,MOU. From 12/31/2001 at 14:17, By USER,NAME. Started running 12/31/2001 at 14:17. Job #: 562039155 ******************** 3522 NAME: $$OS EXTRINSIC FUNCTION IN ROUTINE %ZOSV CUSTODIAL PACKAGE: KERNEL SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 12,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine The $$OS^%ZOSV() extrinsic function is only available under Cache'/OpenM systems. This function returns the underlying operating system such as VMS, UNIX or NT. ROUTINE: %ZOSV COMPONENT: $$OS VARIABLES: Usage: I ^%ZOSF("OS")["OpenM" S Y=$$OS^%ZOSV ******************** 3523 NAME: DBIA3523 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: USAGE: Supported ENTERED: FEB 20,2002 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine ROUTINE: DGMTU COMPONENT: $$FUT(DFN,DGDT,DGMTYPT) VARIABLES: DFN Type: Input Contains the Internal Entry Number of the patient in the PATIENT File, #2. DGDT Type: Input Date (Optional- default to today). DGMTYPT Type: Input Type of Test (Optional - default to Means Test) $$FUT Type: Output If a future DCD test was performed it will be returned, else the earliest performed future test for the Income Year will be. Data returned: Future MT IEN^Date of Test (Future)^Status Name^Status Code^Source of Test Identify veteran's records with future tests. ******************** 3524 NAME: XDRDFPD CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: MASTER PATIENT INDEX Master Patient Index Austin is utilizing the Duplicate Record Merge software from within Kernel Toolkit to search for patients already existing in the index. USAGE: Private ENTERED: FEB 14,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This integration agreement is for access from the top of the routine XDRDFPD. Entry at this location will result in the user being prompted for a specific file to check for duplicate entries, then prompted for a specific entry within that file. To proceed there must be an entry for the selected file in the DUPLICATE RESOLUTION file (#15.1). The routine then checks other entries within the specified file to determine whether they are potential duplicates based upon the information and routines specified in the DUPLICATE TESTS sub-file (field #1100) for the specified file. Entries which are identified as potential duplicates are entered into the DUPLICATE RECORD file (#15). ROUTINE: XDRDFPD COMPONENT: XDRDFPD VARIABLES: Entry at this location will result in the user being prompted for a specific file to check for duplicate entries, then prompted for a specific entry within that file. To proceed there must be an entry for the selected file in the DUPLICATE RESOLUTION file (#15.1). The routine then checks other entries within the specified file to determine whether they are potential duplicates based upon the information and routines specified in the DUPLICATE TESTS sub-file (field #1100) for the specified file. Entries which are identified as potential duplicates are entered into the DUPLICATE RECORD file (#15). ******************** 3525 NAME: EN XDRDFPD CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: MASTER PATIENT INDEX Master Patient Index Austin is utilizing the Duplicate Record Merge software from within Kernel Toolkit to search for patients already existing in the index. USAGE: Private ENTERED: FEB 14,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine This entry point provides the ability to perform a search on a specified file for potential duplicates to a specified file entry, using user specified criteria in the DUPLICATE RESOLUTIION file (#15.1). The routine creates entries in the DUPLICATE RECORD file (#15) of potential duplicates identified for subsequent verification. The users must create an entry in the DUPLICATE RESOLUTION file for the file that will be analyzed. This entry must include data in the CANDIDATE COLLECTION ROUTINE field (#.09) which will specify the routine to be used as the basis for identifying those that might be potential duplicates. These candidates are then compared using the data and routines specified in the DUPLICATE TESTS sub-file (field #1100) for the analyis. The weighted result from these tests is then compared to the POTENTIAL DUPLICATE THRESHOLD% value to determine if an entry should be considered a potential duplicate and entered into the DUPLICATE RECORD file. ROUTINE: XDRDFPD COMPONENT: EN VARIABLES: XDRCD Type: Input The variable XDRCD contains the internal entry number of the desired file entry for which potential duplicates are to be identified. Any potential duplicates that are found are entered into the DUPLICATE RECORD file (#15). XDRFL Type: Input This variable contains the file number for which the duplicate resolution search will be performed. This file number will be used to extract all the relevant fields for the tests from the DUPLICATE RESOLUTION file (#15.1). This entry point is used to identify potential duplicates in the file XDRL to the file entry number contained in the variable XDRCD. This Entry point assumes XDRCD and XDRFL are defined. ******************** 3526 NAME: SETUP XDRDFPD CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: MASTER PATIENT INDEX USAGE: Private ENTERED: FEB 14,2002 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Master Patient Index Austin is utilizing the Duplicate Record Merge software from within Kernel Toolkit to search for patients already existing in the index. ROUTINE: XDRDFPD COMPONENT: SETUP VARIABLES: ******************** 3527 NAME: CHECK XDRDMAIN CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: MASTER PATIENT INDEX USAGE: Private ENTERED: FEB 14,2002 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Master Patient Index Austin is utilizing the Duplicate Record Merge software from within Kernel Toolkit to search for patients already existing in the index. ROUTINE: XDRDMAIN COMPONENT: CHECK VARIABLES: ******************** 3528 NAME: FILE XDRDQUE CUSTODIAL PACKAGE: TOOLKIT SUBSCRIBING PACKAGE: MASTER PATIENT INDEX USAGE: Private ENTERED: FEB 14,2002 STATUS: Active EXPIRES: DURATION: VERSION: FILE: ROOT: DESCRIPTION: TYPE: Routine Master Patient Index Austin is utilizing the Duplicate Record Merge software from within Kernel Toolkit to search for patients already existing in the index. ROUTINE: XDRDQUE COMPONENT: FILE VARIABLES: XDRFL Type: Used XDRFL is set to the file number. If this variable is not set then the user will be prompted for the file. "-1" will be returned if the file doesn't exist in file 15.1. XDRD(array Type: Output The XDRD(array) will be returned for valid file entries. This array stores the search critera for the Merge s/w. This sub-routine sets-up the XDRD array that is used when initially searching files for duplicates. The information stored in this array is derived from file #15.1 (Duplicate Resolution). If the variable "XDRFL" is set then that will be used as the file number, otherwise the user will be prompted for the file. If the file doesn't exist in file #15.1, "-1" will be returned. ******************** 3529 NAME: DBIA3529 CUSTODIAL PACKAGE: REGISTRATION SUBSCRIBING PACKAGE: BENEFICIARY TRAVEL SCHEDULING USAGE: Controlled Subscri ENTERED: FEB 15,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 21 ROOT: DIC(21 DESCRIPTION: TYPE: File Beneficiary Travel uses a direct read on the zero node of the PERIOD OF SERVICE (#21) File. ^DIC(21,DA,0) .03 CODE 0;3 Direct Global Read & w ROUTINE: ******************** 3530 NAME: DBIA3530 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: INTEGRATED BILLING LAB SERVICE USAGE: Controlled Subscri ENTERED: FEB 27,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 9000010 ROOT: AUPNVSIT( DESCRIPTION: TYPE: File Integrated Billing receives encounters from PCE but screens out many based on certain criteria. One of these criteria is the Data Source of the encounter. The following reference is needed to identify the Data Source of an encounter to determine if the encounter should pass to Integrated Billing. ^AUPNVSIT(D0 81203 DATA SOURCE 812;3 Direct Global Read & w Visit's Data Source, pointer to file 839.7 ROUTINE: ******************** 3531 NAME: DBIA3531 CUSTODIAL PACKAGE: PCE PATIENT CARE ENCOUNTER SUBSCRIBING PACKAGE: INTEGRATED BILLING CLINICAL REMINDERS USAGE: Controlled Subscri ENTERED: FEB 27,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: 839.7 ROOT: PX(839.7, DESCRIPTION: TYPE: File Integrated Billing receives encounters from PCE but screens out some based on the Data Source of the encounter. The following reference is needed to identify the Data Source of an Encounter to determine if the encounter is billable. ^PX(839.7,D0 .01 SOURCE NAME 0;1 Direct Global Read & w Name of a Data Source. ROUTINE: ******************** 3532 NAME: Imaging DIBT read CUSTODIAL PACKAGE: VA FILEMAN SUBSCRIBING PACKAGE: IMAGING Vistarad generates a temporary file containing a "master" list of radiology exam records to display on demand to the workstation in response to an RPC call. It is important that the list is delivered to the workstation within one to 2 seconds of initiation of the RPC call. The actual records to be displayed for a given list that is requested generally consist of a subset of the master list, filtered according to selection criteria defined in a List Definition file (#2006.631). The code that executes this filtering uses search logic that has been created by calling EN^DIS, Fileman search logic entry function. To accommodate the needs of the filtering program, the internal representation of the Fileman search logic that was generated must be stored with the List definition, to be re-used whenever the filtered list is produced. Since the Fileman Search results are stored in ^DIBT, some of the information required to implement the above logic must be read from ^DIBT at the time that the search logic is defined. The specific nodes that are read are: ^DIBT(IEN,"DC"), ff. ^DIBT(IEN,"DL"), ff. ^DIBT(IEN,"O"), ff. The code to read the global is the following, where variable DIARI equals the IEN for the entry in the SORT TEMPLATE file, and GREF is the global array for an Imaging file, 2006.631: S GREF=$NA(^MAG(2006.631,MAGIEN,"DEF")) ... ... S GLIN=$NA(^DIBT(DIARI)) ; Copy search logic to 2006.631 "DEF" nodes F TNOD=3,4 S FNOD=$P("^^DC^DL",U,TNOD) D . S T="",CT=0 . F S T=$O(@GLIN@(FNOD,T)) Q:T="" S X=^(T) I X]"" S CT=CT+1,@GREF@(TNOD,CT)=X . S @GREF@(TNOD,0)=CT S T=0 F S T=$O(@GLIN@("O",T)) Q:T="" S @GREF@(5,T)=^(T,0) Q Imaging understands that the nodes read from the DIBT global are not documented and may change. Please note that the variable DIARI is an undocumented output variable from the api EN^DIS. A NOIS entry, ISW-0302-20006, has been entered by Imaging requesting the FileMan v22 Programmer Manual to be updated to documenting this variable. this variable. USAGE: Controlled Subscri ENTERED: FEB 27,2002 STATUS: Active EXPIRES: DURATION: Till Otherwise Agr VERSION: FILE: .401 ROOT: DIBT DESCRIPTION: TYPE: File FileMan gives Imaging permission to read the DIBT global. The Fileman team reserves the right to make changes allowing Imaging developers 3 to 6 months notice prior modifications. This request is to read the search criteria stored in the DIBT global. A call to EN^DIS is initiated to start the FileMan search logic dialog. Imaging understands that the nodes read from the DIBT global are not documented and may change. ^DIBT(D0 ^DIBT(D0,'DC' The node that contains the fields and search value representation. Example: ^DIBT(1228,"DC",1)=^9>20 <