Pimstm

Revision History	iv Figures	xvii Tables	xvii Orientation	xviii Intended Audience	xviii Orientation	xviii How to Use this Manual	xviii Documentation Navigation	xix Documentation Conventions	xix On-line Help System	Contents xxi Definitions, Acronyms, and Abbreviations	xxi Reference Materials	xxii Introduction&Software Purpose24

1	Introduction & Software Purpose	24

1.1	Namespace Conventions	25

1.2	Background Job Options	25

1.3	SACC Exemptions/Non-Standard Code	27

1.4	Primary Care Management Module (PCMM) Overview	28

2	Implementation and Maintenance	30

2.1	Eligibility ID/Maintenance Menu	31

2.2	Station Number (Time Sensitive) Enter/Edit (D ^VASITE0)	32

3	Routines	34

3.1	Routines To Map	34

3.2	Callable Routines	34

3.3	Compiled Template Routines	36

3.3.1	Input Templates	36

3.3.2	Print Templates	37

3.3.3	Compiled Cross-Reference Routines	37

3.4	Routine List	38

3.5	New and modified routines	38

4	Files	42

4.1	Globals and Files	42

4.2	File List	42

5	Files And Templates In The PIMS Package	52

5.1	File Flow (Relationships between files)	52

5.2	Templates	52

5.3	VA FileMan Functions	52

6	Exported Options	58

6.1	Menu Diagrams	58

6.2	Exported Protocols	58

6.3	Exported Options	58

6.4	Exported Remote Procedures	58

6.5	Exported HL7 Applications for Ambulatory Care Reporting	59

6.6	Exported HL7 Applications For Inpatient Reporting To National Patient Care Database	59

6.7	Exported HL7 Applications for Home Telehealth Care Database	59

7	Archiving and Purging	60

7.1	Archiving	60

7.2	Purging	60

7.3	ADT Module	60

7.4	ACRP Database Conversion Option	60 7.5	HL7 Purger	61 8	External / Internal Relations	62 8.1	External Relations	62 9	DBIA Agreements	64 9.1	DBIA AGREEMENTS - CUSTODIAL PACKAGE	64 9.2	DBIA AGREEMENTS - SUBSCRIBER PACKAGE	64 9.3	Internal Relations	64 9.4	Package-Wide Variables	64 9.5	VADPT Variables	64 9.5.1	Scheduling Variables	65 9.5.2	Patient Record Flag Variables	66 9.6	VAUTOMA	71 9.7	VAFMON	71 9.8	AIT	72 10	How To Generate On-Line Documentation	74 10.1	XINDEX	74 10.2	INQUIRE TO OPTION FILE	74 10.3	PRINT OPTIONS FILE	75 10.4	LIST FILE ATTRIBUTES	75 10.5	Security	75 10.5.1	General Security	75 10.5.2	Security Keys	75 10.5.3	Legal Requirements	75 10.6	FileMan Access Codes	76 11	VADPT Variables	88 11.1	SUPPORTED REFERENCES	88 11.2	CALLABLE ENTRY POINTS IN VADPT	90 11.2.1	DEM^VADPT	90 11.2.2	ELIG^VADPT	92 11.2.3	MB^VADPT	94 11.2.4	SVC^VADPT	95 11.2.5	ADD^VADPT	101 11.2.6	OAD^VADPT	104 11.2.7	INP^VADPT	106 11.2.8	IN5^VADPT	108 11.2.9	OPD^VADPT	114 11.2.10	REG^VADPT	115 11.2.11	SDE^VADPT	116 11.2.12	SDA^VADPT	116 11.2.13	PID^VADPT	117 11.2.14	PID^VADPT6	118 11.2.15	ADM^VADPT2	118 11.2.16	KVAR^VADPT	119 11.2.17	KVA^VADPT	119 11.2.18	COMBINATIONS	119 11.3	Alpha Subscripts	121 12	Scheduling Application Programmer Interfaces (APIs)	128 12.1.1	Special Features	128 12.1.2	Application Programmer Interface - SDAPI	131 12.2	SDAPI - EXAMPLES	133 12.3	SDAPI - Data Fields	138 12.4	SDAPI - Filters	141 12.4.1	Available Data Filters	141 12.4.2	Input – Other Array Entries	143 12.4.3	Other Array Entries	146 12.4.4	SDAPI - Error Codes	147 12.4.5	SDAPI - Constraints	148 12.4.6	Application Programmer Interface - GETAPPT	148 12.5	Application Programmer Interface - NEXTAPPT	150 12.6	Application Programmer Interface - GETPLIST	151 12.7	Application Programmer Interface - PATAPPT	152 12.7.1	Scheduling Patient Record Flag Reports	154 12.8	Scheduling Mental Health AD HOC NO SHOW Reports	156 13	Data Fields	158 13.1	Available Data Fields	158 13.2	FILTERS	159 13.2.1	Valid Appointment Status Filters	159 13.2.2	Valid Patient Status Filters	160 13.2.3	Valid Patient Status and Appointment Status Filter Combinations	160 13.3	Application Programmer Interface - SDIMO	161 13.4	Configuring Bar Code Label Printers for Print patient label option	162 13.4.1	Hardware Setup	163 13.4.2	Software Setup	163 13.5	Control Code Overview	163 13.5.1	Patient Label Print Routine Control Code Use	164 13.5.2	Label Printer Setup Examples	164 13.5.3	Zebra Label Printer	165 13.6	Intermec Label Printer	166 14	HL7 INTERFACE SPECIFICATION FOR THE TRANSMISSION OF AMBULATORY CARE DATA	168 14.1	Assumptions	168 14.1.1	Message Content	168 14.1.2	Data Capture and Transmission	168 14.1.3	Background Messages	168 14.1.4	Batch Messages & Acknowledgements	168 14.1.5	VA MailMan Lower Level Protocol	169 14.2	HL7 CONTROL SEGMENTS	169 14.3	Message Definitions	169 14.4	Segment Table Definitions	169 14.5	Message Control Segments	169 14.5.1	MSH - MESSAGE HEADER SEGMENTS	170 14.5.2	BHS - Batch Header Segment	172 14.5.3	BTS - Batch Trailer Segment	173 14.5.4	MSA - MESSAGE ACKNOWLEDGMENT SEGMENT	173 14.5.5	EVN - EVENT TYPE SEGMENT	174 14.6	PID - Patient Identification Segment	175 14.6.1	PD1 - Patient Additional Demographic Segment	175 14.6.2	PV1 - Patient Visit Segment	177 14.6.3	PV2 - Patient Visit - Additional Information Segment	180 14.6.4	DG1 - Diagnosis Information Segment	183 14.6.5	PR1 - Procedure Information Segment	185 14.6.6	ROL - Role Segment	186 14.6.7	ZPD - VA-Specific Patient Information Segment	189 14.6.8	ZEL - VA-Specific Patient Eligibility Segment	191 14.6.9	VA-Specific Income Segment	193 14.6.10	ZCL - VA-Specific Outpatient Classification Segment	193 14.6.11	ZSC - VA-Specific Stop Code Segment	193 14.6.12	ZSP - VA-Specific Service Period Segment	194 14.6.13	ZEN - VA-Specific Enrollment Segment	194 14.7	PURPOSE	195 14.8	Trigger Events and Message Definitions	195 14.8.1	Update Patient Information (A08)	195 14.8.2	Delete a Patient Record (A23)	196 14.9	SUPPORTED AND USER-DEFINED HL7 TABLES	197 14.9.1	TABLE 0001 - SEX	197 14.9.2	TABLE 0002 - MARITAL STATUS	197 14.9.3	TABLE 0003 - EVENT TYPE CODE	197 14.9.4	TABLE 0008 - ACKNOWLEDGMENT CODE	197 14.9.5	TABLE 0023 - ADMIT SOURCE (USER DEFINED)	198 14.9.6	TABLE 0051 - DIAGNOSIS CODE (USER DEFINED)	198 14.9.7	TABLE 0069 - HOSPITAL SERVICE (USER DEFINED)	198 14.9.8	TABLE 0076 - MESSAGE TYPE	199 14.9.9	TABLE 0088 - PROCEDURE CODE (USER DEFINED)	199 14.9.10	TABLE 0115 - SERVICING FACILITY (USER DEFINED)	199 14.9.11	TABLE 0133 - PROCEDURE PRACTITIONER TYPE (USER DEFINED)	199 14.9.12	TABLE 0136 - YES/NO INDICATOR	200 14.9.13	TABLE SD001 - SERVICE INDICATOR (STOP CODE)	200 14.9.14	TABLE SD008 - OUTPATIENT CLASSIFICATION TYPE	200 14.9.15	TABLE SD009 - PURPOSE OF VISIT	201 14.9.16	TABLE VA01 - YES/NO	202 14.9.17	TABLE VA02 - CURRENT MEANS TEST STATUS	202 14.9.18	TABLE VA04 - ELIGIBILITY	203 14.9.19	TABLE VA05 - DISABILITY RETIREMENT FROM MILITARY	203 14.9.20	TABLE VA06 - ELIGIBILITY STATUS	204 14.9.21	TABLE VA07 - RACE	204 14.9.22	TABLE VA08 - RELIGION	204 14.9.23	TABLE VA08 – RELIGION (CONT.)	205 14.9.24	TABLE VA10 - MEANS TEST INDICATOR	207 14.9.25	TABLE VA11 - PERIOD OF SERVICE	208 14.9.26	TABLE VA12 - TYPE OF INSURANCE	209 14.9.27	TABLE VA0015 - ENROLLMENT STATUS	209 14.9.28	TABLE VA0016 - REASON CANCELED/DECLINED	210 14.9.29	TABLE VA0021 - ENROLLMENT PRIORITY	210 14.9.30	TABLE VA0022 - RADIATION EXPOSURE METHOD	210 14.9.31	TABLE VA0023 - PRISONER OF WAR LOCATION	210 14.9.32	TABLE VA0024 - SOURCE OF ENROLLMENT	211 14.9.33	TABLE VA0046 - AGENT ORANGE EXPOSURE LOCATION	211 14.9.34	TABLE NPCD 001 - NATIONAL PATIENT CARE DATABASE ERROR CODES	211 14.10	HL7 Interface Specification for the Transmission of PCMM Primary Care Data	212 14.11	Assumptions	212 14.11.1	Message Content	212 14.11.2	Data Capture and Transmission	212 14.11.3	Background Messages	212 14.11.4	VA MailMan Lower Level Protocol	213 HL7 CONTROL SEGMENTS	214 14.12	Message Definitions	214 14.13	Segment Table Definitions	214 14.14	Message Control Segments	214 14.14.1	MSH - Message Header Segment	215 14.14.2	EVN - Event Type Segment	216 14.14.3	PID - Patient Identification Segment	216 14.14.4	ZPC – VA Specific Primary Care Information Segment	218 15	HL7 message transactions	220 15.1	Trigger Events and Message Definitions	220 15.1.1	Update Patient Information (A08)	220 15.1.2	Business Rules	220 16	SUPPORTED AND USER-DEFINED HL7 TABLES	221 16.1	Table 0001 - Sex	221 16.2	Table 0002 - Marital Status	221 16.3	Table 0003 - Event Type Code	221 16.4	Table 0005 - Race	221 16.5	Table 0006 - Religion	221 16.6	Table 0006 – Religion (cont.)	223 16.7	Table 0076 - Message Type	224 17	HL7 Interface Specification for PCMM Primary Care Acknowledgement Processing	226 17.1	Message Control Segments	226 17.1.1	MSH - Message Header Segment	227 17.1.2	MSA Message Acknowledgment Segment	228 17.1.3	ERR Error Segment	229 17.1.4	ZPC VA Specific - Primary Care Information Segment	229 17.2	Specific Transaction Examples	231 17.3	Supported and User Defined Tables	233 17.3.1	Table 008 Acknowledgement Code	233 17.3.2	PCMM Error Code Table	233 18	HL7 Interface Specification for VIC Card VistA to NCMD	238 18.1	Assumptions	238 18.2	Message Content	238 18.3	Data Capture and Transmission	238 18.4	VA TCP/IP Lower Level Protocol	239 18.4.1	Message Definitions	239 18.4.2	Segment Table Definitions	239 18.4.3	Message Control Segments	239 18.4.4	MSH - Message Header Segment	240 18.4.5	MSA – Message Acknowledgment Segment	241 18.4.6	PID - Patient Identification Segment	242 18.4.7	ORC-Common Order Segment	244 18.4.8	RQD-Requisition Detail Segment	245 18.4.9	NTE – Notes and Comments	246 18.5	Trigger Events and Message Definitions	247 18.6	ORM - General Order Message (event O01)	247 18.7	ORR – General Order Response Message response to any ORM (event O02)	247 18.8	Supported and User Defined HL7 Tables	248 18.8.1	Table 0003 - Event Type Code	248 18.8.2	Table 0008 – Acknowledgment Code	248 18.8.3	Table 0076 - Message Type	248 18.8.4	Table 0119 – Order Control Codes	248 19	HL7 GENERIC PID, EVN, PV1 SEGMENT BUILDER ESTABLISHED BY MPI	250 19.1	Integration Agreement (IA) #3630	250 19.1.1	Custodial Package	250 19.2	API: BLDEVN^VAFCQRY	250 19.3	API: BLDPD1^VAFCQRY	251 19.4	API: BLDPID^VAFCQRY	251 20	HL7 Interface Specification for Home Telehealth (HTH)	252 20.1	Assumptions	252 20.2	Message Content	252 20.3	Data Capture and Transmission	252 21	VA TCP/IP Lower Level Protocol	254 21.1	HL7 CONTROL SEGMENTS	254 21.2	Message Definitions	254 21.3	Segment Table Definitions	254 21.4	Message Control Segments	255 22	Glossary	264 23	Military Time Conversion Table	268 24	Alphabetical Index of PIMS terms	270

Figures none Tables Table 1 - Documentation Symbol / Term Descriptions	xix