08/12/2005 0.4 DG*5.3*624 - (10-10EZ 3.0) Deleted DGRPT 10-10T REGISTRATION input template in the Compiled Template Routines section VA OI&T 08/05/2005 0.3 DG*5.3*666 Enhancement - added Background Job Option VA OI&T 11/15/2004 0.2 Manual updated to comply with SOP 192-352 Displaying Sensitive Data VA OI&T 11/9/2004 0.1 DG*5.3*415-Race and Ethnicity Addition to VADPT variable section (patch released in 2003, change omitted in error) VA OI&T
ENROLL API – My HealtheVet Register processing AUTHENT API – Authenticated My HealtheVet account status processing SECMSG API – Secure Messaging processing MHVOK API – Check patient's MHV registration information to determine if the alert should be activated or deactivated. DGMVUTL – Contains numerous APIs utilized by the other listed routines. The following existing routines are being updated to support this patch: DGPAR - PREREG subroutine – Updated to display value of the ENABLE MY HEALTHEVET PROMPTS?” (#1100.07) field in the MAS PARAMETERS (#43) file. DGPAR1 – Updated to allow the edit of the ENABLE MY HEALTHEVET PROMPTS? (#1100.07) field in the MAS PARAMETERS (#43) file. DGPREP1 - DIREDT API – Updated to include the new “Increase Engagement in My HealtheVet” prompts to display and prompt for updates from the clerk. DGRPC - EN API – Updated to include the new 315 Consistency Check for “Increase Engagement in My HealtheVet” DGRPC3 – Added 315 subroutine to include the new 315 Consistency Check Editing functionality. DGRPCE1– Updated to include 315 Consistency Check Editing functionality when necessary “Increase Engagement in My HealtheVet” data fields have not been updated.
409.75 TRANSMITTED OUTPATIENT ENCOUNTER ERROR ^SD(409.75, 409.76** TRANSMITTED OUTPATIENT ENCOUNTER ^SD(409.76, ERROR CODE 409.77 ACRP TRANSMISSION HISTORY ^SD(409.77, 409.91 ACRP REPORT TEMPLATE ^SDD(409.91, 409.92 ACRP REPORT TEMPLATE PARAMETER ^SD(409.92, *File comes with data. ** File comes with data which will overwrite existing data, if specified.
EN^SDMHPRO This routine is the front end of the Proactive background job report and sets up the data to be printed. Table 25: EN^SDMHPRO Routine Routine Name EN^SDMHPRO Enhancement Category New Modify Delete No Change Requirement Traceability Matrix N/A Related Options High Risk MH Proactive Nightly Report [SD MH PROACTIVE BGJ REPORT] option Related Routines Routines “Called By” Routines “Called” ^SDAMQ NOW^%DTC $$LINE^SDMHAP $$LINE1^SDMHAP START^SDMHAP RET^SDMHAP1 $$SETSTR^SDMHPRO1 SET1^SDMHPRO1 XMY^SDUTL2 $$FMTE^XLFDT ^XMD Data Dictionary (DD) References ^TMP( ^TMP("SDMHP" ^XMB(3.8 Related Protocols N/A Related Integration Control Registrations (ICRs) N/A Data Passing Input Output Reference Both Global Reference Local Input Attribute Name and Definition Name: None Definition: Output Attribute Name and Definition Name: None Definition: Current Logic None
^SDMHPRO1 This routine is called by routine SDMHPRO and is the routine that prints out the Proactive Background Job report. Table 26: EN^SDMHPRO1 Routine Routine Name EN^SDMHPRO1 Enhancement Category New Modify Delete No Change Requirement Traceability Matrix N/A Related Options High Risk MH Proactive Nightly Report [SD MH PROACTIVE BGJ REPORT] option Related Routines Routines “Called By” Routines “Called” ^SDMHPRO C^%DTC $$SDAPI^SDAMA301 COUNT^SDMHPRO HEAD^SDMHPRO HEAD1^SDMHPRO TOTAL^SDMHPRO $$SETSTR^SDUL1 PID^VADPT6 $$FMTE^XLFDT Data Dictionary (DD) References ^DG(40.8 ^DIC(40.7 ^DPT( ^DPT("B" ^SC( ^TMP( ^TMP("SDMHP" ^TMP("SDPRO1" ^TMP($J ^VA(200 Related Protocols N/A Related Integration Control Registrations (ICRs) N/A Data Passing Input Output Reference Both Global Reference Local
Call ^SDMHAP1 routine to print the report. EN^SDMHAP1 This routine is called by routine SDMHAP and is the routine that prints out the Proactive Ad Hoc report. Table 28: EN^SDMHAP1 Routine Routine Name EN^SDMHAP1 Enhancement Category New Modify Delete No Change Requirement Traceability Matrix N/A Related Options High Risk MH Proactive Adhoc Report [SD MH PROACTIVE AD HOC REPORT] option Related Routines Routines “Called By” Routines “Called” ^SDMHAP C^%DTC ^DIR $$SDAPI^SDAMA301 HEAD^SDMHAP HEAD1^SDMHAP COUNT^SDMHPRO TOTAL1^SDMHPRO PID^VADPT6 $$FMTE^XLFDT Data Dictionary (DD) References ^DIC(40.7 ^DPT( ^TMP( ^TMP($J ^VA(200 Related Protocols N/A Related Integration Control Registrations (ICRs) N/A
7. First print field: Name 8. Then print field: Description Legal Requirements The PIMS software package makes use of Current Procedural Terminology (CPT) codes that is an American Medical Association (AMA) copyrighted product. Its use is governed by the terms of the agreement between the Department of Veterans Affairs and the AMA. The CPT copyright notice is displayed for various PIMS users and should not be turned off. FileMan Access Codes Below is a list of recommended FileMan Access Codes associated with each file contained in the PIMS package. This list may be used to assist in assigning users appropriate FileMan Access Codes. Table 31: Fileman Access Codes FILE NUMBER FILE NAME DD ACCESS RD ACCESS WR ACCESS DEL ACCESS LAYGO ACCESS 2 PATIENT @ d D @ D 5 STATE @ d @ @ @ 8 ELIGIBILITY CODE @ d @ @ @ 8.1 MAS ELIGIBILITY CODE @ d @ @ @ 8.2 IDENTIFICATION FORMAT @ d @ @ @ 10 RACE @ d @ @ @ 11 MARITAL STATUS @ d @ @ @ 13 RELIGION @ d @ @ @ 21 PERIOD OF SERVICE @ d @ @ @ 22 POW PERIOD @ d @ @ @ 23 BRANCH OF SERVICE @ d @ @ @ 25 TYPE OF DISCHARGE @ d @ @ @ 26.11 PRF LOCAL FLAG @ @ @ @ @
26.12 PRF LOCAL FLAG HISTORY @ @ @ @ @ 26.13 PRF ASSIGNMENT @ d @ @ @ 26.14 PRF ASSIGNMENT HISTORY @ @ @ @ @ 26.15 PRF NATIONAL FLAG @ @ @ @ @ 26.16 PRF TYPE @ @ @ @ @ 26.17 PRF HL7 TRANSMISSION LOG @ @ @ @ @ 26.18 PRF PARAMETERS @ @ @ @ @ 26.19 PRF HL7 QUERY LOG @ @ @ @ @ 26.21 PRF HL7 EVENT @ @ @ @ @ 26.22 PRF HL7 REQUEST LOG FILE @ @ @ @ @ 27.11 PATIENT ENROLLMENT @ d @ @ @ 27.12 ENROLLMENT QUERY LOG @ @ @ @ 27.14 UPLOAD AUDIT 27.15 ENROLLMENT STATUS @ d @ @ @ 27.16 ENROLLMENT GROUP THRESHOLD @ @ @ @ @ 27.17 CATASTROPHIC DISABILITY REASONS @ @ @ @ @ 28.11 NOSE AND THROAT RADIUM HISTORY @ d @ @ @ 29.11 MST HISTORY 30 DISPOSITION LATE REASON @ d @ @ @
409.2 CANCELLATION REASONS @ d @ @ @ 409.41 OUTPATIENT CLASSIFICATION TYPE @ d @ @ @ 409.42 OUTPATIENT CLASSIFICATION @ d D D D 409.45 OUTPATIENT CLASSIFICATION STOP CODE EXCEPTION @ d @ @ @ 409.62 APPOINTMENT GROUP @ d @ @ @ 409.63 APPOINTMENT STATUS @ d @ @ @ 409.64 QUERY OBJECT @ d @ @ @ 409.65 APPOINTMENT STATUS UPDATE LOG @ d @ @ @ 409.66 APPOINTMENT TRANSACTION TYPE @ d @ @ @ 409.67 CLINIC GROUP @ D @ D 409.68 OUTPATIENT ENCOUNTER @ d @ @ @ 409.73 TRANSMITTED OUTPATIENT ENCOUNTER @ d @ @ @ 409.74 DELETED OUTPATIENT ENCOUNTER @ d @ @ @ 409.75 TRANSMITTED OUTPATIENT ENCOUNTER ERROR @ d @ @ @ 409.76 TRANSMITTED OUTPATIENT ENCOUNTER ERROR CODE @ d @ @ @
VADPT Variables VADPT is a utility routine designed to provide a central point where a programmer can obtain information concerning a patient's record. Supported entry points are provided which will return demographics, inpatient status, eligibility information, etc. Access to patient information is not limited to using the supported entry points in VADPT. Integration agreements can be established through the DBA between PIMS and other packages to reference information. Additionally, several data elements are supported without an integration agreement. SUPPORTED REFERENCES The following references to patient information (PATIENT file #2) are supported without an integration agreement. All nationally distributed cross-references on these fields are also supported. Table 32: Supported References FIELD NAME FIELD # GLOBAL LOCATION TYPE OF ACCESS NAME (#.01) 0;1 Read SEX (#.02) 0;2 Read DATE OF BIRTH (#.03) 0;3 Read AGE (#.033) N/A Read MARITAL STATUS (#.05) 0;5 Read RACE (#.06) 0;6 Read OCCUPATION (#.07) 0;7 Read RELIGIOUS PREFERENCE (#.08) 0;8 Read DUPLICATE STATUS (#.081) 0;18 PATIENT MERGED TO (#.082) 0;19 CHECK FOR DUPLICATE (#.083) 0;20 SOCIAL SECURITY NUMBER (#.09) 0;9 Read REMARKS (#.091) 0;10 Read PLACE OF BIRTH [CITY] (#.092) 0;11 Read
out of the appointment. 12 IEN TEXT NNN The outpatient encounter IEN associated with this appointment. 4578 13 PRIMARY STOP CODE IEN and CODE TEXT IEN;code Primary Stop code IEN and code associated with the clinic. 301;350 14 CREDIT STOP CODE IEN and CODE TEXT IEN;code Credit Stop code IEN and code associated with the clinic. 549;500 15 WORKLOAD NON-COUNT TEXT Y or N “Y” if clinic is else “N”. Y N 16 DATE MADE DATE YYYMMDD Date the appointment was entered into the Scheduling system. 3031215 17 DESIRED DATE OF DATE YYYMMDD The date the clinician or patient desired for the scheduling of this appointment. 3031215 18 PURPOSE OF VISIT TEXT Code (1, 2, 3, or 4) and short description (C&P, 10-10, SV, or UV) The Purpose of Visit. 1;C&P 2;10-10 3;SV 4;UV 19 EKG DATE/TIME The scheduled date/time of the EKG tests in conjunction with this appointment. 3031215.083 R M
20 X-RAY DATE/TIME The scheduled date/time of the X-RAY in conjunction with this appointment. 3031215.083 21 LAB DATE/TIME The scheduled date/time of the Lab tests in conjunction with this appointment. 3031215.083 22 STATUS TEXT Status Code, Status Description, Print Status, Checked In Date/Time, Checked Out Date/Time, and Admission Movement IFN Status Information for the Visit. 8;INPATIENT 23 X-RAY FILMS TEXT Y or N “Y” if x-ray films are required at clinic else “N”. Y N 24 DATE/TIME The date/time that the appointment was Auto-Rebooked (rescheduled) to. 3031215.083 25 NO-SHOW / CANCEL DATE/TIME The date/time that the appointment was No-Showed or Cancelled. 3031215.083 26 RSA ID TEXT NNN The unique numeric Oracle ID that identifies a specific RSA appointment. This field will be null for appointments in legacy VistA. 34983 M M M M
Table 37: Available Data Filters APPOINTMENT DATA TO BE FILTERED ARRAY ENTRY Format Examples of code to set array with filter values APPOINTMENT DATE/TIME ARRAY(1) Range of appointment date/times, "from" and "to" date/time separated by semicolon. Dates must be FileMan format ARRAY(1)="from date; to date" S ARRAY(1)="3030101;3030101" (one day) S ARRAY(1)="3040101" (appts after 2003) S ARRAY(1)=";3031231" (all appts thru 3031231) S ARRAY(1)=DT (all appts from today forward) S ARRAY(1)=DT_";3041231" (all appts from today through 3041231) CLINIC IEN ARRAY(2) List of valid clinic IENs (each separated by a semicolon) or a global root or a local root. Clinic must exist on Hospital Location file. ARRAY (2) ="ien1; ien2" etc. ARRAY(2)="^global(" ARRAY(2)="local(" ARRAY(2)="local(#" ARRAY(2)="local(#," S ARRAY(2)=300 S ARRAY(2)="300;301;304" S ARRAY(2)="^GBL(" S ARRAY(2)="^GBL(""DFN""" S ARRAY(2)="^GBL(""DFN""," S ARRAY(2)="LOCAL(" S ARRAY(2)="LOCAL(""DFN""" S ARRAY(2)="LOCAL(""DFN""," APPOINTMENT STATUS ARRAY(3) List of valid Appointment Status values, each separated by a semicolon. Valid values: R (Scheduled/Kept) I (Inpatient) S ARRAY(3)="I" S ARRAY(3)="R;I;NT" S ARRAY(3)="CC;CCR;CP;CPR"
NS (No-Show) NSR (No-Show, Rescheduled) CP (Cancelled by Patient) CPR (Cancelled by Patient, Rescheduled) CC (Cancelled by Clinic) CCR (Cancelled by Clinic, Rescheduled) NT (No Action Taken) ARRAY (3) ="status1; status2" etc. PATIENT DFN ARRAY(4) List of valid patient DFNs (each separated by a semicolon) or a global root or a local root. DFN must exist on PATIENT file. ARRAY (4) ="dfn1; dfn2" etc. ARRAY(4)="^global(" ARRAY(4)="local(" ARRAY(4)="local(#" ARRAY(4)="local(#," S ARRAY(4)=7179940 S S ARRAY(4)="^GBL(" S ARRAY(4)="^GBL(""IENLIST""" S ARRAY(4)="^GBL(""IENLIST""," S ARRAY(4)="LOCAL(" S ARRAY(4)="LOCAL(""IENLIST""" S ARRAY(4)="LOCAL(""IENLIST""," PRIMARY STOP CODE List of valid Primary Stop Code values (not IENs). Must be a valid AMIS REPORTING STOP CODE (field #1) on S ARRAY(13)=197 S ARRAY(13)="197;198;200;203;207"
7 OVERBOOK TEXT Y or N “Y” if appointment is an overbook else “N” Y N 8 ELIGIBILITY OF VISIT ID and NAME POINTER and TEXT ID^name Eligibility code and name associated with the appointment 2^AID & ATTENDANCE 7^ALLIED VETERAN OF VET. 9 CHECK-IN DATE/TIME DATE/TIME Date/time the patient checked in for the appointment 3021215@113 TYPE ID and NAME POINTER and TEXT ID^name Type of appointment ID and name & PENSION 3^ORGAN DONORS 7^COLLATERAL OF VET. DATE/TIME DATE/TIME Date/time the patient checked out of the appointment 3021215@113 PATIENT STATUS TEXT I O null For future, scheduled appointments, the current status of the patient. For past, kept appointments, the status at the time of the appointment. For cancelled and appointments, this will be null I O “” L
FILTERS Valid Appointment Status Filters The SDAPSTAT filter parameter can be used if you wish to screen on appointment status. If this parameter contains a value or set of values, then those appointments will be returned in the resulting array set. Request more than 1 value in the filter by separating them with a semi-colon (i.e. SDAPSTAT=”R;NT”). A null or undefined value will result in all being returned. Table 41: Valid Appointment Status Filters Appt Status Filter value Appointment Status Value(s) Returned R R (scheduled/kept) N N (no-show) C C (cancelled) NT NT (no action taken) Null (default) ALL appointment status values will be returned: R (scheduled/kept) N (no-show) C (cancelled) NT (no action taken) Valid Patient Status Filters The SDIOSTAT filter parameter can be used if you wish to retrieve only inpatient records or only outpatient records. A null or undefined value will result in both being returned. Table 42: Valid Patient Status Filters Patient Status Filter value Description I Inpatient O Outpatient Null (default) Both will be returned (inpatient and outpatient) Valid Patient Status and Appointment Status Filter Combinations Due to the design of VistA, the patient status (new field #12) of appointments that are cancelled, no-show, or no action taken, will not be available. If the patient status field is requested, a null value will be returned in the ^TMP output global for this field. Patient status is determined by analyzing the value of the STATUS field (#3) on the Patient subfile (2.98).
13 15 NM Sequence Number Not used 14 180 ST Continuation Pointer Not used 15 2 ID 0155 Accept Type NE (never acknowledge) 16 2 ID 0155 Application Type AL (always acknowledge) 17 2 ID Country Code Not used *AAC stands for Austin Automation Center. The name of that facility has been changed to Austin Information Technology Center. BHS - Batch Header Segment Table 46: Batch Header Segment SEQ LEN DT R/O RP/# TBL# ELEMENT NAME VISTA DESCRIPTION 1 1 ST R Batch Field Separator Recommended value is ^ (caret) 2 4 ST R Batch Encoding Characters Recommended delimiter values: Component = ~ (tilde) Repeat = | (bar) Escape = \ (back slash) Subcomponent = & (ampersand) 3 15 ST Batch Sending Application When originating from facility: AMBCARE-DH142 When originating from NPCDB: NPCD-AAC* 4 20 ST Batch Sending Facility When originating from facility: Station's facility number
28 UNITARIAN-UNIVERSALISM 29 UNKNOWN/NO PREFERENCE 30 NATIVE AMERICAN 31 ZEN BUDDHISM TABLE VA08 – RELIGION (CONT.) Code (#3) field of RELIGION (#13) file. VALUE DESCRIPTION 32 AFRICAN RELIGIONS 33 AFRO-CARIBBEAN RELIGIONS 34 AGNOSTICISM 35 ANGLICAN 36 ANIMISM 37 ATHEISM 38 BABI & BAHA’I FAITHS 39 BON 40 CAO DAI 41 CELTICISM 42 CHRISTIAN (NON-SPECIFIC) 43 CONFUCIANISM 44 CONGREGATIONAL 45 CYBERCULTURE RELIGIONS 46 DIVINATION 47 FOURTH WAY 48 FREE DAISM 49 FULL GOSPEL 50 GNOSIS 51 HINDUISM 52 HUMANISM 53 INDEPENDENT 54 JAINISM 55 MAHAYANA
3 80 ST O Text Message Free text error message 4 15 NM O Expected Sequence Number Not used 5 1 ID B 0102 Delayed Acknowledgment Type Not used 6 100 CE O Error Condition Not used PID - Patient Identification Segment Table 70: PID – Patient Idenfification Segment SEQ LEN DT R/O RP/# TBL# ELEMENT NAME VistA DESCRIPTION 1 4 SI Set ID - Patient ID Always set to ‘1’ 2 20 CK Patient ID (External ID) Social Security Number field of Patient file. 3 20 CM R Y Patient ID (Internal ID) Integrated Control Number (ICN) field of Patient file. Component 1: ICN w/checksum Component 2: Null Component 3: Null Component 4: Assigning authority (subcomponent 1: ‘USVHA’, subcomponent 3: ‘L’ Component 5: Type ‘NI’ 4 12 ST Alternate Patient ID Not used