All ICR List

Package: PCE Patient Care Encounter ICR List

IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
446 DBIA446 File PCE PATIENT CARE ENCOUNTER 1994/04/12 APPROVED Active Private 9999999.27
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.
447 DBIA447 File PCE PATIENT CARE ENCOUNTER 1994/04/12 APPROVED Active Controlled Subscription 9000001
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).
448 DBIA448 File PCE PATIENT CARE ENCOUNTER 1994/04/12 Retired Private 9000011
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).
489 DBIA489 Routine PCE PATIENT CARE ENCOUNTER 1995/09/18 APPROVED Active Controlled Subscription
Interface with Visit Tracking to create Visits.		 VSIT
490 DBIA490 Routine PCE PATIENT CARE ENCOUNTER 1995/09/19 Retired Controlled Subscription
This is an entry point for getting a list of visits
that match defined criteria.		 vsitoe
907 AUPNVSIT Routine PCE PATIENT CARE ENCOUNTER 1994/07/13 APPROVED Active Controlled Subscription
Update dependent entry counter
------------------------------
Note: These calls are customarily done via a MUMPS cross reference on the
pointer field.		 AUPNVSIT
1238 DBIA1238 Routine PCE PATIENT CARE ENCOUNTER 1995/05/25 APPROVED Active Controlled Subscription
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		 PXRHS01
1239 IMMUNIZATION EXTRACT Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Controlled Subscription
This integration agreement allows subscribing packages
to retrieve immunization data. Subscribers can retrieve data on
administrations, contraindications, and refusals.		 PXRHS03 2023/10/10
1240 DBIA1240 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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 #
******		 PXRHS04
1241 DBIA1241 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Controlled Subscription
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 #		 PXRHS05
1242 DBIA1242 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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 #		 PXRHS06
1243 DBIA1243 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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 #		 PXRHS07
1244 DBIA1244 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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 #		 PXRHS09
1247 DBIA1247 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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		 PXRHS12
1248 DBIA1248 Routine PCE PATIENT CARE ENCOUNTER 1995/05/26 APPROVED Active Private
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		 PXRHS20
1251 DBIA 1251 File PCE PATIENT CARE ENCOUNTER 1995/08/03 APPROVED Active Private 150.9
PCE debugging utility calls Fileman to display the
entry number 1 to the user so that they can review it.
1254 DBIA1254 Routine PCE PATIENT CARE ENCOUNTER 1995/05/30 APPROVED Active Private 9000001
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.		 PXRHS13
1259 DBIA1259 File PCE PATIENT CARE ENCOUNTER 1995/05/30 APPROVED Active Private 9001017
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.
1268 DBIA1268 File PCE PATIENT CARE ENCOUNTER 1995/05/31 APPROVED Active Private 9999999.64
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.
1273 DBIA1273 Routine PCE PATIENT CARE ENCOUNTER 1995/08/03 APPROVED Active Private 9000010
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.		 PXRHS14
1298 PXK VISIT DATA EVENT Other PCE PATIENT CARE ENCOUNTER 1995/08/16 APPROVED Active Controlled Subscription
The Scheduling Developers are requesting permission to
hook 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		 2016/09/19
1323 Clinical Reminder/Maintenance API Routine PCE PATIENT CARE ENCOUNTER 1995/08/24 Retired Private
Request permission to call the
MAIN^PXRHM(DFN,AGE,SEX,PXRITEM,PXRHM) entry point to retrieve Clinical
Reminder/Maintenance data generated by the PCE PACKAGE. Listed below is the
details on accessing this entry point and the data that should be returned.
MAIN(DFN,AGE,SEX,PXRITEM,PXRHM)
INPUT: DFN - Pointer to Patient File (#2)
AGE - Age of patient
SEX - Sex of patient
PXRITEM - Internal entry of PCE Reminder/Maintenance Item
PXRHM - Flag to indicate level of information needed
1 - Health Maintenance
0 - Reminders DUE NOW only OUTPUT: Data found related
to the PCE Reminder/Maintenance Item (811.9) file
^TMP("PXRHM",$J,PXRITEM,"Reminder Item Text"="DUE NOW" or null
^ date due (Internal FM Date) ^ Last activity date (Internal FM date)
Note: The following items are only returned if PXRHM = 1.
If activity was found in files related to the reminder/maintenance item:
^TMP("PXRHM",$J,PXRITEM,"Reminder Item Text",inverted FM date of activity)=
Type of data^Internal FM date of activity^Name of activity
If there is text to describe the reminder/maintenance criteria:
^TMP("PXRHM",$J,PXRITEM,"Reminder Item Text","TXT",1 to N)=
Text about rule and patient findings		 PXRHM
1541 DBIA1541 Routine PCE PATIENT CARE ENCOUNTER 1998/02/23 APPROVED Active Controlled Subscription
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'		 PXAPIOE
1554 DBIA1554 Routine PCE PATIENT CARE ENCOUNTER 1996/06/26 APPROVED Active Controlled Subscription
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.		 PXAPIIB
1593 PATIENT CARE ENCOUNTER File PCE PATIENT CARE ENCOUNTER 1996/08/09 APPROVED Active Controlled Subscription 9999999.27
The purpose of this IA is to allow access to the
^AUTNPOV( global for purposes of gathering information specific to a problem.
1889 ADD/EDIT/DELETE PCE DATA SILENTLY Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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		 PXAPI 2017/01/10
1890 DBIA1889-B Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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.		 PXAPI
1891 DBIA1889-C Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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. 		PXAPI 2017/01/10
1892 DBIA1889-D Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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.		 PXAPI
1893 DBIA1889-E Routine PCE PATIENT CARE ENCOUNTER 2004/03/08 APPROVED Active Controlled Subscription
$$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.		 PXAPI
1894 DBIA1889-F Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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.		 PXAPI 2016/09/19
1895 DBIA1889-G Routine PCE PATIENT CARE ENCOUNTER 2004/03/02 APPROVED Active Controlled Subscription
$$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.		 PXAPI
1896 DBIA1889-H Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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.		 PXAPI
1897 DBIA1889-I Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
$$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.		 PXAPI
1898 DBIA1889-J Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
$$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.		 PXAPI
1899 DBIA1889-A Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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
<PROVIDER IEN> 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",<PROVIDER IEN>)
LOCAL("PROBLEM",<PROVIDER IEN>)
LOCAL("SOURCE")
LOCAL("ENCOUNTER")
LOCAL("DIAGNOSIS",<PROVIDER IEN>)
LOCAL("PROCEDURE",<PROVIDER IEN>)
LOCAL("PROVIDER",<PROVIDER IEN>)
LOCAL("IMMUNIZATION",<PROVIDER IEN>)
LOCAL("SKIN TEST",<PROVIDER IEN>)
LOCAL("EXAM",<PROVIDER IEN>)
LOCAL("PATIENT ED",<PROVIDER IEN>)
LOCAL("HEALTH FACTORS",<PROVIDER IEN>)
LOCAL("VITALS",<PROVIDER IEN>)
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",<NODE>,<PROVIDER
IEN>,<i>,<PIECE>)="Free text message^REJECTED VALUE"
Where <NODE> ::= "ENCOUNTER" | "VITALS" |
"DIAGNOSIS" | "PROCEDURE" |
"PROBLEM" | rest of list|
<PROVIDER IEN> ::= internal entry number of
provider. Is 0 (ZERO) for ENCOUNTER
and SOURCE
<i> ::= sub-entry 'i' for that provider
Is 0 (ZERO) for ENCOUNTER, SOURCE
and PROVIDER
<PIECE> ::= $P( selector in
LOCAL(<NODE>,<PROVIDER IEN>,<i>)
that failed.
The value of <PIECE> 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",<NODE>,<PROVIDER IEN>,<i>,<PIECE>)
="Free text message^QUESTIONABLE VALUE"
Where <NODE> ::= "ENCOUNTER" | "VITALS" |
"DIAGNOSIS" | "PROCEDURE" |
"PROBLEM"
<PROVIDER IEN> ::= internal entry number of
provider. Is 0 (ZERO) for ENCOUNTER
and SOURCE
<i> ::= sub-entry 'i' for that provider
Is 0 (ZERO) for ENCOUNTER, SOURCE,
and PROVIDER
<PIECE> ::= $P( selector in
LOCAL(<NODE>,<PROVIDER IEN>,<i>) in
question.
The value of <PIECE> 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 <PROVIDER IEN> 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",<PROVIDER IEN>, 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",<PROVIDER IEN>,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",<PROVIDER IEN>))is true.
LOCAL("DIAGNOSIS",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true.
LOCAL("PROCEDURE",<PROVIDER IEN>,i) = 1^2^3^4^5^6^7^8^9^10^
11^12^13^14,(pieces defined below)
LOCAL("PROCEDURE",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true.
LOCAL("PROBLEM",<PROVIDER IEN>,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",<PROVIDER IEN>= 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",<PROVIDER IEN>))
is true.
LOCAL ("IMMUNIZATION",<PROVIDER IEN>,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",<PROVIDER IEN>)) is
true. LOCAL ("SKIN TEST",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true.
LOCAL ("EXAM",<PROVIDER.IEN>")=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",<PROVIDER
IEN>)) is true. LOCAL ("PATIENT ED",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true. LOCAL ("HEALTH
FACTORS",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true.
LOCAL("VITALS",<PROVIDER IEN>,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",<PROVIDER IEN>)) is true.
LOCAL("LOCAL",<PROVIDER IEN>,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.		 PXCA
1900 DBIA1900-A Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
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 <visit date [and time] in FM format>
VSIT("VDT") may be used instead of VSIT.
(time will default to 12 noon if not
specified)
DFN <patient file pointer>
VSIT("PAT") may be used instead of DFN.
[VSIT(0)] <a string of characters that defines how
the visit processor will function, see
package-wide variables>
[VSIT("<xxx>")] <array with mnemonic subscript>
(used in match logic if VSIT(0)["M")
(for SVC, TYP, INS, CLN, ELG, LOC)
Note: For multiple field values use
[<field value>[^...]]
i.e., VSIT("SVC")="H^D" (will find both)
VSITPKG <package name space>
VSIT("PKG") may be used instead of
VSITPKG.
OUTPUT:
VSIT(<ien>) N^S[^1]
where:
N = <internal entry number of visit>
or -1 if could not get a visit
or -2 if calling package is not
active in Visit Package Parameters
S = <value of .01 field of visit>
1 = <indicates that a new visit was added
VSIT(<xxx>) array passed in with all the entries
defined and the defaulted values added
VSIT(<ien>,<xxx>) returns the data that is stored in the
Visit file in the same format as
VSIT(<xxx>)
Variable descriptions:
VSIT(<xxx>) Variable Names for VISIT file fields,
Where <xxx> 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[<number of days>]
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(<xxx>) 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(<ien>) N^S[^1]
where:
N = <internal entry number of visit>
S = <value of .01 field of visit>
1 = <indicates that a new visit was
added>		 VSIT 2017/01/10
1901 VISIT FILE DATE LAST MODIFIED Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
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		 VSIT 2016/03/29
1902 DBIA1900-C Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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. 		VSIT
1903 DBIA1900-D Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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		 VSIT
1904 DBIA1900-E Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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		 VSIT
1905 RETURN SELECTED VISITS FROM VSIT Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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)		 VSIT
1906 DBIA1900-G Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
$$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(<ien>,<xxx>) or VSIT(<xxx>) 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) 		VSIT 2017/01/10
1907 DBIA1900-H Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
$$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		 VSIT
1908 DBIA1900-A Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Private
$$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		 VSIT
1909 DBIA1900-B Routine PCE PATIENT CARE ENCOUNTER 1997/01/23 APPROVED Active Controlled Subscription
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)		 VSITKIL
1985 DBIA1985 Routine PCE PATIENT CARE ENCOUNTER 1997/04/02 APPROVED Active Controlled Subscription
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		 PXAPIIB
1987 DBIA1987 File PCE PATIENT CARE ENCOUNTER 1997/04/04 APPROVED Active Controlled Subscription 9999999.09
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
1988 DBIA1988 File PCE PATIENT CARE ENCOUNTER 1997/04/04 APPROVED Active Controlled Subscription 9999999.15
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
1989 DBIA1989 File PCE PATIENT CARE ENCOUNTER 1997/04/04 APPROVED Active Controlled Subscription 9999999.64
This integration agreement authorizes global reference
to the zeroth 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
1990 DBIA1990 File PCE PATIENT CARE ENCOUNTER 1997/04/04 APPROVED Active Controlled Subscription 9999999.14
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		 2021/11/16
1991 DBIA1991 File PCE PATIENT CARE ENCOUNTER 1997/04/04 APPROVED Active Controlled Subscription 9999999.28
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
1994 DBIA1994 Routine PCE PATIENT CARE ENCOUNTER 1997/04/08 APPROVED Active Private
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.		 PXBUTL
2028 READ ACCESS ONLY TO PCE VISIT FILE File PCE PATIENT CARE ENCOUNTER 1997/05/28 APPROVED Active Controlled Subscription 9000010
Visit Tracking grants PCE Patient Care Encounter Global
and/or FileMan Read to the Visit file: all fields and all cross references.
2048 DBIA2048 File PCE PATIENT CARE ENCOUNTER 1997/06/30 APPROVED Active Private 9000010.18
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).
2077 DBIA2077 File PCE PATIENT CARE ENCOUNTER 1997/09/24 APPROVED Active Controlled Subscription 9999999.17
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
2309 DBIA2309 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Controlled Subscription 9000010
2310 DBIA2310 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Private 9000010.18
2311 DBIA2311 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Private 9000010.13
2312 DBIA2312 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Controlled Subscription 9000010.23
2313 DBIA2313 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Controlled Subscription 9000010.11 2009/08/28
2314 DBIA2314 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Private 9000010.16
2315 DBIA2315 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Private 9000010.07
2316 DBIA2316 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Controlled Subscription 9000010.06
2317 DBIA2317 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Controlled Subscription 9000010.12
2318 DBIA2318 File PCE PATIENT CARE ENCOUNTER 1998/02/07 APPROVED Active Private 9000010.15
2348 SERVICE CONNECTED CONDITIONS Routine PCE PATIENT CARE ENCOUNTER 1998/03/24 APPROVED Active Controlled Subscription
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.		 PXUTLSCC
2349 ACTIVE PROVIDER Routine PCE PATIENT CARE ENCOUNTER 1998/03/24 APPROVED Active Controlled Subscription
This checks to see if a provider is active on the
system and if they have an active Person Class on a given date.		 PXAPI
2353 DBIA2353-A File PCE PATIENT CARE ENCOUNTER 1998/04/03 APPROVED Active Private 9000010.11
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.
2354 DBIA2353-B File PCE PATIENT CARE ENCOUNTER 1998/04/03 APPROVED Active Private 9000010.12
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.
Amendment: Added .03 and 1201 effective with OR*3*405		 2022/12/23
2355 DBIA2353-C File PCE PATIENT CARE ENCOUNTER 1998/04/03 APPROVED Active Private 9000010.13
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.
2356 DBIA2353-D File PCE PATIENT CARE ENCOUNTER 1998/04/03 APPROVED Active Private 9000010.16
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.
2357 DBIA2353-E File PCE PATIENT CARE ENCOUNTER 1998/04/03 APPROVED Active Private 9000010.23
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.
2444 DBIA2444 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9000010
VISIT file access to zeroeth node.
2445 DBIA2445 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9000010.13
V EXAM file access.
2446 DBIA2446 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9000010.23
V HEALTH FACTORS file access.
2447 DBIA2447 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 900010.11
V IMMUNIZATION file access.
2448 DBIA2448 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9000010.16
V PATIENT ED file access.
2449 DBIA2449 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9000010.12
V SKIN TEST file access.
2450 DBIA2450 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Controlled Subscription 9000010.15
V TREATMENT file access.
2451 DBIA2451 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9999999.09
EDUCATION TOPICS file access.
2452 DBIA2452 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9999999.15
EXAM file access.
2453 DBIA2453 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Controlled Subscription 9999999.64
HEALTH FACTORS file access.
2454 DBIA2454 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Controlled Subscription 9999999.14
IMMUNIZATION file access.
2455 DBIA2455 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Controlled Subscription 9999999.28
SKIN TEST file access.
2456 DBIA2456 File PCE PATIENT CARE ENCOUNTER 1998/07/01 APPROVED Active Private 9999999.17
TREATMENT file access.
2502 DBIA2502 Routine PCE PATIENT CARE ENCOUNTER 1998/08/18 APPROVED Active Private
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		 PXKMAIN
2597 DBIA2597 File PCE PATIENT CARE ENCOUNTER 1998/10/14 APPROVED Active Private 9000010.12
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.
2598 DBIA2598 File PCE PATIENT CARE ENCOUNTER 1998/10/14 APPROVED Active Private 9000010
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.
2599 DBIA2599 File PCE PATIENT CARE ENCOUNTER 1998/10/14 APPROVED Active Private 9000010.23
2600 DBIA2600 File PCE PATIENT CARE ENCOUNTER 1998/10/15 APPROVED Active Controlled Subscription 9000010.11
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.
2617 DBIA2617 File PCE PATIENT CARE ENCOUNTER 1998/10/19 APPROVED Active Private 9000010
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.
2619 DBIA2619 File PCE PATIENT CARE ENCOUNTER 1998/10/21 APPROVED Active Private 9000010.15
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.
2620 DBIA2620 File PCE PATIENT CARE ENCOUNTER 1998/10/21 APPROVED Active Private 9999999.17
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.
2623 DBIA2623 File PCE PATIENT CARE ENCOUNTER 1998/10/21 APPROVED Active Private 9999999.27
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.
2627 DBIA2627 File PCE PATIENT CARE ENCOUNTER 1998/11/24 APPROVED Active Private 9000010.18
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.
2659 DISPOSITION HOSPITAL LOCATIONS File PCE PATIENT CARE ENCOUNTER 1998/12/10 APPROVED Active Controlled Subscription 815
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.
2673 DBIA2673 File PCE PATIENT CARE ENCOUNTER 1998/12/16 APPROVED Active Private 9000010.06
CIRN needs read access to
^AUPNVPRV('AD'
^AUPNVPRV(D0, FIELD .03 LOCATION 0;3
^AUPNVPRV(D0, FIELD .04 LOCATION 0;4
2722 DBIA2722 Routine PCE PATIENT CARE ENCOUNTER 1999/01/21 APPROVED Active Private
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 		PXBAPI21 2017/01/10
3035 DBIA3035-A Routine PCE PATIENT CARE ENCOUNTER 2003/05/29 APPROVED Active Supported
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.		 PXAAVCPT
3038 DBIA3035-B Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVHF
3043 DBIA3035-C Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVIMM
3044 DBIA3035-D Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVMSR
3045 DBIA3035-E Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVPED
3046 DBIA3035-F Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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).		 PXAAVPOV
3047 DBIA3035-G Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVPRV
3048 DBIA3035-H Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Controlled Subscription
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.		 PXAAVSIT 2023/08/30
3049 DBIA3035-I Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVSK
3050 DBIA3035-J Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVTRT
3051 DBIA3035-A Routine PCE PATIENT CARE ENCOUNTER 2000/02/22 APPROVED Active Supported
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.		 PXAAVXAM
3054 DBIA3054 File PCE PATIENT CARE ENCOUNTER 2000/02/29 APPROVED Active Private 9000001
DG namespaced routine deletes PATIENT/IHS entries when
the patients that these entries point to in the PATIENT file are being
deleted.
3055 GET CODE MAPPING File PCE PATIENT CARE ENCOUNTER 2000/03/01 APPROVED Active Private 811.1
3063 PXRHS08 Patient Education Routine PCE PATIENT CARE ENCOUNTER 2000/03/09 APPROVED Active Controlled Subscription
Patient Education data extract.		 PXRHS08
3083 Health Factors in Clinical Reminders and Health Summary File PCE PATIENT CARE ENCOUNTER 2000/05/19 APPROVED Active Private 9999999.64
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.		 2021/05/11
3084 DBIA3084 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Controlled Subscription 9000010.23
Health Factors are used as a finding in Clinical
Reminders. Therefore Clinical Reminders needs to read the following fields.		 2009/06/08
3085 EDUCATION TOPICS IN CLINICAL REMINDERS AND HEALTH SUMMARY File PCE PATIENT CARE ENCOUNTER 2000/05/19 APPROVED Active Private 9999999.09
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.		 2021/05/11
3086 DBIA3086 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9000010.16
Education Topics are used as a finding in Clinical
Reminders. Therefore Clinical Reminders needs to read the following fields.
3087 EXAMS IN CLINICAL REMINDERS AND HEALTH SUMMARY File PCE PATIENT CARE ENCOUNTER 2000/05/19 APPROVED Active Private 9999999.15
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.		 2021/11/09
3088 DBIA3088 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9000010.13
Exams are used as a finding in Clinical Reminders.
Therefore Clinical Reminders needs to read the following fields.
3089 DBIA3089 File PCE PATIENT CARE ENCOUNTER 2004/07/15 APPROVED Active Private 9999999.14
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.
3090 DBIA3090 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9000010.11
Immunizations are used as a finding in Clinical
Reminders. Therefore Clinical Reminders needs to read the following fields.
3091 DBIA3091 File PCE PATIENT CARE ENCOUNTER 2000/05/19 APPROVED Active Private 9999999.28
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.
3092 DBIA3092 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9000010.12
Skin Tests are used as a finding in Clinical Reminders.
Therefore Clinical Reminders needs to read the following fields.
3093 DBIA3093 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9000010.18
CPT procedures are used as a finding in Clinical
Reminders. Therefore Clinical Reminders needs to read the following fields.
3094 DBIA3094 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Controlled Subscription 9000010.07
V POV diagnoses are used as a finding in Clinical
Reminders. Therefore Clinical Reminders needs to read the following fields.
3096 DBIA3096 File PCE PATIENT CARE ENCOUNTER 2000/05/16 APPROVED Active Private 9999999.27
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.
3114 DBIA3114 Other PCE PATIENT CARE ENCOUNTER 2000/05/18 APPROVED Active Private
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.
3118 DBIA3118 Other PCE PATIENT CARE ENCOUNTER 2000/05/19 APPROVED Active Private
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.
3146 TIU use of PXUTL1 Routine PCE PATIENT CARE ENCOUNTER 2001/09/27 APPROVED Active Private
TIU calls $$APPOINT^PXUTL1, when the Visit IEN is not
available, to check if a Visit is associated with an appointment.		 PXUTL1
3151 ONCOLOGY DISEASE INDEX File PCE PATIENT CARE ENCOUNTER 2000/07/28 APPROVED Active Private 9000010.07
ONCOLOGY needs to read with FileMan the following V POV
(9000010.07) fields for its [Disease Index] option:
3152 TIU use of PXBUTL2 Routine PCE PATIENT CARE ENCOUNTER 2000/07/31 APPROVED Active Private
TIU calls PRV^PXBUTL2 to get the default provider.		 PXBUTL2
3211 DBIA3211 File PCE PATIENT CARE ENCOUNTER 2000/09/22 APPROVED Active Private 9000010
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.
3225 Service Catagory Calculation API Routine PCE PATIENT CARE ENCOUNTER 2000/10/05 APPROVED Active Private
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.		 PXKCO
3455 DBIA3455 File PCE PATIENT CARE ENCOUNTER 2001/09/14 APPROVED Active Private 9000010.06
3512 DBIA3512 File PCE PATIENT CARE ENCOUNTER 2002/02/04 APPROVED Active Controlled Subscription 9000010
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.
3530 DBIA3530 File PCE PATIENT CARE ENCOUNTER 2002/02/27 APPROVED Active Controlled Subscription 9000010
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.
3531 DBIA3531 File PCE PATIENT CARE ENCOUNTER 2002/02/27 APPROVED Active Controlled Subscription 839.7
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.
3560 DBIA3560 File PCE PATIENT CARE ENCOUNTER 2002/04/15 APPROVED Active Private 9000010.18
3580 TIU use of Global AUPNVSIT(+VSIT,0) File PCE PATIENT CARE ENCOUNTER 2002/05/15 APPROVED Active Private 9000010
Direct global read of the 0th node of the Visit file
(#9000010), $G(^AUPNVSIT(+VSIT,0)).
3838 PXRM DIRECT READ OF THE VISIT FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 Withdrawn Private 9000010
Clinical Reminders requests the ability to do a global
read on the Visit File, specifically, the first piece of the zero node to
populate the new Clinical Reminders Index.
3839 PXRM DIRECT READ OF THE V CPT FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 APPROVED Active Private 9000010.18
Clinical Reminders requests the ability to do a global
read on the V CPT File, specifically, ^AUPNVCPT(, using multiple fields from
the Zero Node to populate the new Clinical Reminders Index.
3841 PXRM DIRECT READ OF THE V IMMUNIZATION FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 Withdrawn Private 9000010.11
Clinical Reminders requests the ability to do a global
read on the V Immunization File, specifically, ^AUPNVIMM(, using multiple
fields from the Zero Node to populate the new Clinical Reminders Index.
3842 PXRM DIRECT READ OF THE V PATIENT ED FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 Withdrawn Private 9000010.16
Clinical Reminders requests the ability to do a global
read on the V Patient Ed File, specifically, ^AUPNVPED(, using multiple fields
from the Zero Node to populate the new Clinical Reminders Index.
3843 PXRM DIRECT READ OF THE V POV FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 APPROVED Active Private 9000010.17
Clinical Reminders requests the ability to do a global
read on the V POV File, specifically, ^AUPNVPOV(, using multiple fields from
the Zero Node to populate the new Clinical Reminders Index.
3844 PXRM DIRECT READ OF THE V SKIN TEST FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 Withdrawn Private 9000010.12
Clinical Reminders requests the ability to do a global
read on the V Skin Test File, specifically, ^AUPNVSK(, using multiple fields
from the Zero Node to populate the new Clinical Reminders Index.
3845 PXRM DIRECT READ OF THE V EXAM FILE File PCE PATIENT CARE ENCOUNTER 2002/11/18 Withdrawn Private 9000010.13
Clinical Reminders requests the ability to do a global
read on the V Exam File, specifically, ^AUPNVXAM(, using multiple fields from
the Zero Node to populate the new Clinical Reminders Index.
3959 GLOBAL READ OF PXD(811.9 File PCE PATIENT CARE ENCOUNTER 2003/02/19 Withdrawn Private 811.9
4013 File 9000001 File PCE PATIENT CARE ENCOUNTER 2003/03/18 Withdrawn Private 9000001
4014 File 9999999.06 File PCE PATIENT CARE ENCOUNTER 2003/03/18 Withdrawn Private 9999999.06
4176 DISK CONSUMPTION ESTIMATE FOR CLINICAL REMINDERS File PCE PATIENT CARE ENCOUNTER 2004/06/29 APPROVED Active Private
The following global references are made:
Global Nodes
AUPNVCPT $P(^AUPNVCPT(0),U,4)
AUPNVXAM $P(^AUPNVXAM(0),U,4)
AUPNVHF $P(^AUPNVXHF(0),U,4)
AUPNVIMM $P(^AUPNVIMM(0),U,4)
AUPNVPED $P(^AUPNVPED(0),U,4)
AUPNVPOV $P(^AUPNVPOV(0),U,4)
AUPNVSK $P(^AUPNVSK(0),U,4)
AUPNPROB $P(^AUPNPROB(0),U,4)
4240 DBIA4240 File PCE PATIENT CARE ENCOUNTER 2003/09/16 APPROVED Active Private 9000010
The IIV (Insurance Identification and Verification)
enhancement patch IB*2.0*184, performs a direct file reference to the "B" and
"AA" cross- references as it loops through visit records as part of the IIV
data extracts. This applies only to extract #3 (Past encounters, non-verified
ins.) and #4 (Past encounters, No Insurance). These extracts reside
in routines IBCNEDE3 and IBCNEDE4 respectively.
In addition, the extract routines also performs a direct global read of
the "0" node ^AUPNVSIT(IEN,0) to retrieve the patient's DFN (5th piece)
value from the visits as they are looped-through.
4250 PCE APIs FOR THE CLINICAL REMINDERS INDEX Routine PCE PATIENT CARE ENCOUNTER 2004/09/15 APPROVED Active Controlled Subscription
This ICR will provide subscribing packages the ability
to get data from the PCE V-files 		PXPXRM 2024/03/14
4268 VDEF EVENTS AND EXTRACTION LISTS Other PCE PATIENT CARE ENCOUNTER 2004/08/23 Retired Supported
The following VDEF events are under the custody of PCE
PATIENT CARE ENCOUNTER:
ADT^A28^ENC
VXU^V04^HFCT
VXU^V04^IMMU
VXU^V04^SKIN
The following VDEF extraction lists are under the custody of PCE PATIENT CARE
ENCOUNTER:
PID-0-VISIT
PV1-0-VISIT
PV1-3-VISIT
PV1-19-VISIT-IEN
PV1-19-VISIT-ID
PV1-39-VISIT
PV1-50-VISIT
PV2-0-VISIT
ROL-0-VPROV
ROL-3-VPROV-PS
ROL-3-VPROV-OA
ROL-9-VPROV-PC-1-1
ROL-9-VPROV-PC-1-2
ROL-9-VPROV-PC-2-1
ROL-9-VPROV-PC-2-2
ROL-9-VPROV-PC-3-1
ROL-9-VPROV-PC-3-2
NTE-0-VPROV
OBX-0-VISIT-SVCCNCT
OBX-0-VISIT-AGENTORA
OBX-0-VISIT-RADEXP
OBX-0-VISIT-PGEXP
OBX-0-VISIT-MST
OBX-0-VISIT-HNCA
NTE-0-VISIT
PR1-0-VCPT
PR1-3-VCPT
PR1-15-VCPT
PR1-16-VCPT
Z12-0-VCPT
Z12-1-VCPT
Z12-2-VCPT
ROL-0-VCPT-OP
ROL-0-VCPT-EP
NTE-0-VCPT
PR1-0-VEXAM
ROL-0-VEXAM-OP
ROL-0-VEXAM-EP
OBX-0-VEXAM
NTE-0-VEXAM
PRB-0-VPOV
PRB-10-VPOV-PN
PRB-10-VPOV-CT
ROL-0-VPOV-OP
ROL-0-VPOV-EP
OBX-0-VPOV-SVCCNCT
OBX-0-VPOV-AGENTORA
OBX-0-VPOV-RADEXP
OBX-0-VPOV-PGEXP
NTE-0-VPOV
PID-0-HF
PV1-0-HF
ORC-0-HF
RXA-0-HF
OBX-0-HF
NTE-0-HF
PID-0-IMMU
PV1-0-IMMU
PV1-3-IMMU-VISIT-1
PV1-3-IMMU-VISIT-2
ORC-0-IMMU
RXA-0-IMMU
OBX-0-IMMU
NTE-0-IMMU
NTE-0-IMMU-S-REM
PID-0-SKIN
PV1-0-SKIN
PV1-3-SKIN-VISIT-1
PV1-3-SKIN-VISIT-2
ORC-0-SKIN
RXA-0-SKIN
OBX-0-SKIN
NTE-0-SKIN
4295 HEALTH FACTORS INFO File PCE PATIENT CARE ENCOUNTER 2004/02/23 APPROVED Active Controlled Subscription 9999999.64
This agreement is to access basic information about a
Health Factor, and the necessary cross-references to access them by Category.
4424 PCE Patient Immunization Data Routine PCE PATIENT CARE ENCOUNTER 2005/11/29 APPROVED Active Supported
The API was created to support a requirement for
MyhealtheVet project regarding a specific patient's immunization data.		 PXIMMAPI
4519 4519 Routine PCE PATIENT CARE ENCOUNTER 2004/11/17 APPROVED Active Private
Clinical Reminders calls these entry points to build
the Clinical Reminders Index for the V CPT file, #9000010.18, V HEALTH FACTORS
file, #9000010.23, V IMMUNIZATION file, #9000010.11, and the V IMM
CONTRA/REFUSAL EVENTS file, #9000010.707. There are no required variables.		 PXPXRMI1 2016/09/19
4520 BUILD PCE CLINICAL REMINDERS INDEXES Routine PCE PATIENT CARE ENCOUNTER 2004/11/20 APPROVED Active Private
Clinical Reminders calls these entry points to build
the Clinical Reminders Indexes for the V PATIENT ED file, #9000010.16, V POV
file, #9000010.07, V SKIN TEST file, #9000010.12, V EXAM file, #9000010.13,
and the V STANDARD CODES file, #9000010.71. There are no required variables. 		PXPXRMI2 2018/07/12
4567 DIRECT GLOBAL READS OF IMMUNIZATIONS, TIMES & DATES File PCE PATIENT CARE ENCOUNTER 2004/12/07 APPROVED Active Private 9000010.11
The pharmacy benefits management extracts needs to
perform direct global reads to extract the date, time and immunization from
this file.
4584 PXRHM used in TMP global File PCE PATIENT CARE ENCOUNTER 2004/12/28 APPROVED Active Controlled Subscription
The ^TMP("PXRHM",$J, global has been historically used
in PCE and is also used by other packages now for the same purpose.
4591 DBIA4589-C Other PCE PATIENT CARE ENCOUNTER 2005/02/04 APPROVED Active Controlled Subscription
The Health Revenue Center (HRC) will be using a special
telnet feature in CAPRI-Remote to view patient data across all Vista Systems.
They need access to the menu options listed in this IA in order to review
various records for any given patient.
4601 PXXDPT - File 9000001 Routine PCE PATIENT CARE ENCOUNTER 2005/07/19 Retired Private
My patch originated because user's were unable to
perform the check out process on certain encounters. We couldn't find the
source of the problem but we found out how to fix the encounters so that the
check out could be done. (The main problem was that you had Appt's pointing to
an encounter that did not have a pointer to a visit. Somehow the visit entry
did not get created along with the encounter as it should have.)
Now, during site testing we found some that still couldn't be checked out.
This was because of bad pointers in the IHS/Patient file (9000001).
After fixing this file, everything checked out properly. When we found that,
after looking into further we found that this patient file was also causing
the initial problem of the visit not being created when the encounter is
created. I then found some existing routine (PXXDPT) that builds/re-build
this patient file.
So, I've changed my fix utility (PXDELENC/PXDELFIX) to repair or build the
entries in the IHS/Patient file (9000001) also. And, here's where to
agreement comes into play. I want to put a check in the SD routine SDCO1 to
check this IHS/Patient file (9000001) file and if it needs repaired go ahead
and repair just before the check out process so that the check out would then
run with out issues.
May agreement will be between SD and PCE. My routine is PXDELFIX and there is
a FIXIHS line tag that does a couple calls to the PXXDPT routine.		 PXXDPT
4814 HEALTH RECORD NUMBER LOOKUP File PCE PATIENT CARE ENCOUNTER 2005/10/12 APPROVED Active Private 9000001
4991 PCE PRIMARY PROVIDER Routine PCE PATIENT CARE ENCOUNTER 2007/05/11 APPROVED Active Private
Returns the primary provider for a visit, if there is
one. 		PXUTL1 2007/09/27
5191 Mapping Validation for Immunization Standardization File PCE PATIENT CARE ENCOUNTER 2008/04/28 APPROVED Active Private 9999999.14
This agreement permits Health Data & Informatics (HDI)
read access, using FileMan, to the Immunization file (#9999999.14).
With the standardization of the Immunization file it is necessary for HDI to
monitor the local mapping of the term/concepts in this file.		 2008/05/01
5192 Mapping Validation for Skin Test Standardization File PCE PATIENT CARE ENCOUNTER 2008/04/28 APPROVED Active Private 9999999.28
This agreement permits Health Data & Informatics (HDI)
read access, using FileMan, to the Skin Test file (#9999999.28).
With the standardization of the Skin Test file it is necessary for HDI to
monitor the local mapping of the term/concepts in this file.		 2008/05/01
5193 Mapping Validation for PCE Code Mapping File PCE PATIENT CARE ENCOUNTER 2008/04/28 APPROVED Withdrawn Private 811.1
This agreement permits Health Data & Informatics (HDI)
read access, using FileMan, to the PCE Code Mapping file (#811.1).
With the standardization of the Immunization and Skin Test files it is
necessary for HDI to monitor the local mapping of the term/concepts in this
file.		 2008/05/01
5473 PCE PATIENT CARE ENCOUNTER Option Access PCE PATIENT CARE ENCOUNTER 2011/01/26 Withdrawn
5520 READ ACCESS TO V SKIN TEST FILE File PCE PATIENT CARE ENCOUNTER 2010/02/18 APPROVED Active Private 9000010.12
Clinical Case Registries requests access to the V SKIN
TEST file (#9000010.12): Direct global read access to the "C" cross-reference
(PATIENT NAME .02) and FileMan read access to the following fields: SKIN TEST
(.01) VISIT (.03) RESULTS (.04) READING (.05) DATE READ (.06) EVENT DATE AND
TIME (1201) ORDERING PROVIDER (1202) COMMENTS (81101)		 2010/02/20
5521 READ ACCESS TO V IMMUNIZATION FILE File PCE PATIENT CARE ENCOUNTER 2010/02/18 APPROVED Active Private 9000010.11
Clinical Case Registries requests access to the V
IMMUNIZATION file (#9000010.11): Direct global read access to the "C"
cross-reference (PATIENT NAME .02) and FileMan read access to the following
fields: IMMUNIZATION (.01) VISIT (.03) REACTION (.06) CONTRAINDICATED (.07)
EVENT DATE AND TIME (1201) ORDERING PROVIDER (1202) COMMENTS (81101)		 2010/02/20
5569 HEALTH FACTORS FOR PADP File PCE PATIENT CARE ENCOUNTER 2010/09/09 Withdrawn Controlled Subscription 9999999.64
As part of my C3-C1 Admission Assesment (PADP), I would
like to add ONS AA* and ONS RA* health factors to the Health Factor file.
5849 PADP Package Adding Health Factors File PCE PATIENT CARE ENCOUNTER 2012/10/03 Retired Private 9999999.64
PADP Package version 1.1 needs to add 809 Health
Factors to the Health Factor file. They are in the ONS AA and ONS RA
namespace. They get added in the post-init for package NUPA 1.1.
5853 PADP PACKAGE READING HEALTH FACTORS File PCE PATIENT CARE ENCOUNTER 2012/10/03 Withdrawn Private 9999999.64
The PADP executables pull in a list of all ONS AA & ONS
RA Health Factors. This is a FIND^DIC call to file 9999999.64 in an RPC.
Global ^AUTTHF. I would like to request an ICR to allow this.
6023 PX SAVE DATA Remote Procedure PCE PATIENT CARE ENCOUNTER 2014/01/17 APPROVED Active Controlled Subscription
The purpose of this RPC is to allow the calling
application to save data to PCE.
Revision History:
----------------
Added 8/8/24, effective with the ENHANCED PCE ENCOUNTER LOOKUP 1.0
multi-Package, PX*1.0*238, TIU*1.0*362 and OR*3.0*606 the sequence of calls to
add PCE data using PX SAVE DATA, should be:
1) call PX SAVE DATA, then
2) call TIU CREATE NOTE. This will ensure the PKGNAME and SRC fields
populate the Visit and PCE data and this supports reporting PCE results based
on the PKGNAME or SRC fields. ICR 7315 is preferred as it returns error
information.
Added 8/1/24, effective with PX*1*217, note the explanation of INPUT
PARAMETERS for PKGNAME and SRC and RETURN PARAMETERs expanded return values.
INPUT PARAMETER: PCELIST PARAMETER TYPE: LIST
MAXIMUM DATA LENGTH: 10000 REQUIRED: YES
SEQUENCE NUMBER: 1
DESCRIPTION:
PCELIST (n)=HDR^Encounter Inpatient?^Note has CPT codes?^Visit
string [Encounter location; Encounter date/time; Encounter
Service category] (REQUIRED)
(n)=VST^DT^Encounter date/time
(n)=VST^PT^Encounter patient (DFN) (n)=VST^HL^Encounter location
(n)=VST^VC^ Encounter Service Category
If applicable:
(n)=VST^PR^ Parent for secondary visit
(n)=VST^OL^ Outside Location for Historical visits
(n)=VST^SC^ Service Connected related?
(n)=VST^AO^ Agent Orange related?
(n)=VST^IR^ Ionizing Radiation related?
(n)=VST^EC^ Environmental Contaminates related?
(n)=VST^MST^ Military Sexual Trauma related?
(n)=VST^HNC^ Head and/or Neck Cancer related?
(n)=VST^CV^ Combat Vet related?
(n)=VST^SHD^ Shipboard Hazard and Defense related?
(n)=PRV(+: add, -: delete) ^ Provider IEN ^^^ Provider Name ^
Primary Provider?
(n)=POV(+: add, -: delete) ^ ICD diagnosis code ^ Category ^
Narrative (Diagnosis description) ^ Primary Diagnosis? ^
Provider String ^ Add to Problem List? ^^^ Next comment
sequence # if saving comments
(n)=COM^COM (Comments) ^ Next comment sequence # ^ @ = no
comments added
(n)=CPT (+: add, -: delete) ^ Procedural CPT code ^ Category ^
Narrative (Procedure description) ^ Quantity ^ Provider IEN
^^^ [# of modifiers; Modifier code/Modifier IEN ^ Next
comment sequence # ^
Effective with PX*1*209, the PCELIST input parameter contains
modifications for IMM (Immunization) type data to include
additional fields: Encounter Provider, Event Info Source,
Dosage, Route, Admin Site, Lot #, Manufacturer, Expiration Date.
The IMM PCELIST items are not required to have the new fields -
to support backward compatibility.
(n)=IMM (+: add, -: delete) ^ Immunization IEN ^ Category ^
Narrative (Immunization description/name) ^ Series ^
Encounter Provider ^ Reaction ^ Contraindicated? ^^ Next
comment sequence # ^ CVX Code ^ Event Info Source HL7
Code;IEN ^ Dose;Units;Units IEN ^ Route Name;HL7 Code;IEN ^
Admin Site Name;HL7 Code;IEN^ Lot #;IEN ^ Manufacturer ^
Expiration Date ^ Event Date and Time ^ Ordering Provider ^
VIS1 IEN/VIS1 Date;VISn IEN/VISn Date;...^ Remarks Start Seq
#;End Seq # ^ Warning Ack ^ Override Reason (Seq #)
(n)=SK (+: add, -: delete) ^ Skin Test IEN ^ Category ^
Narrative (Skin Test description/name) ^ Results ^ Enc
Provider ^ Reading ^ D/T Read ^ Event D/T ^ Next comment
sequence # ^ Reader ^ Ordering Provider ^ Anatomic Location
of Placement;HL7 Code;IEN ^ Reading Comment (Seq #)
(n)=PED (+: add, -: delete) ^ Patient Education IEN ^ Category ^
Narrative (Patient Education description/name) ^ Level of
understanding ^^^^^ Next comment sequence #
(n)=HF (+: add, -: delete) ^ Health Factor IEN ^ Category ^
Narrative (Health Factor description/name) ^ Level ^^^^^ Next
comment sequence # ^ Get Reminder
(n)=XAM(+: add, -: delete) ^ Exam IEN ^ Category ^ Narrative
(Exam description/name) ^ Results ^^^^^ Next comment sequence
#
(n)=ICR (+: add, -: delete) ^ Variable Pointer IMM
Contraindication Reasons/IMM Refusal Reasons ^ Category ^
Narrative ^ Immunization IEN ^ Warn Until Date ^ Event
Date/Time ^ Enc Provider IEN ^ ^ Next comment sequence #
INPUT PARAMETER: LOC PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 40 REQUIRED: NO
SEQUENCE NUMBER: 2
DESCRIPTION:
This is the hospital location. This is not used when the information is
from an outside source.
INPUT PARAMETER: PKGNAME PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 60 REQUIRED: YES
SEQUENCE NUMBER: 3
DESCRIPTION:
The package name that is sending the data to PCE. This should be the
full package name from the PACKAGE file or a pointer to the PACKAGE file
(#9.4). If Middleware is involved, the Middleware package name should be the
PKGNAME. If the calling product has a PACKAGE file entry and is not
middleware, then the product's PACKAGE file name should be the PKGNAME. For
CPRS PCE updates, the PKGNAME is PATIENT CARE ENCOUNTERS, but that should not
be used generically for any product.
Note:The Package Name field will only be updated in the PCE Visit and
V-files when PX SAVE DATA is called before TIU CREATE NOTE by the
application/middleware.
INPUT PARAMETER: SRC PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 64 REQUIRED: YES
SEQUENCE NUMBER: 4
DESCRIPTION:
The source of the data being sent to PCE. If the source is an application
using middleware, the SRC should be the name of that application. This
applies to COTS, Class 3, Class 2, and Class 1 applications. SRC can be text
or a pointer to the PCE DATA SOURCE file (#839.7). The text does not need to
be pre-defined in the PCE DATA SOURCE file because it will be added using
LAYGO for new data sources.
Note: The Data Source will only be updated in the PCE Visit and V-files when
PX SAVE DATA is called before TIU CREATE NOTE by the application/middleware.
RETURN PARAMETER DESCRIPTION: Returned Value:
1 If no errors occurred and data was processed.
-1 If errors occurred, but data was processed as completely as
possible.
-2 Unable to identify a valid Visit. No data was processed.
-3 RPC was called incorrectly. No data was processed.
-4 If cannot get a lock on the encounter.
-5 If there were only warnings.
Optionally, if the argument RETVISIT was "1", than the Visit IEN will be
returned as the second piece (e.g., "1^65234").		 PX SAVE DATA 2016/09/19
6134 ORWPCE SAVE Routine PCE PATIENT CARE ENCOUNTER 2014/11/21 Withdrawn Controlled Subscription
Saves PCE information.		 ORWPCE SAVE PXRPC 2015/11/24
6153 VPS WRITE TO 9000010.23 File PCE PATIENT CARE ENCOUNTER 2015/01/26 Withdrawn Controlled Subscription 9000010.23
This IA provides for the Fileman WRITE of the PATIENT
NAME (.02) and VISIT (.07) fields in the V HEALTH FACTORS file #9000010.23.		 2015/11/09
6201 DBIA 6201 File PCE PATIENT CARE ENCOUNTER 2015/05/29 APPROVED Active Private 9999999.14
The Health Summary Package desires to set up an
integration agreement with the PCE Package to point to the Immunizations
(#9999999.14) file. The Selection Item (.01) field in the Structure Multiple
(field 1) of the Health Summary Type (#142) file points to the Immunizations
file. The Selection File (.01) field in the Selection File multiple (field 7)
of the Health Summary Component (#142.1) file points to the Immunizations
file. Health Summary also requires the ability to add the application group
"GMTS" ^DIC(9999999.14) when the Health Factors files exists. This is done
with a Fileman Call.		 2015/09/08
6246 PXVIMM INFO SOURCE Remote Procedure PCE PATIENT CARE ENCOUNTER 2015/10/07 APPROVED Retired Controlled Subscription
*******************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library for list of retired HMP ICRs.
*******************************************************************
Returns entries from the IMMUNIZATION INFO SOURCE file (920.1). INPUT
PARAMETER: PXVFLTR PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Filter. Possible values are:
R:XXX - Return entry with IEN XXX.
H:XXX - Return entry with HL7 Code XXX.
N:XXX - Return entry with #.01 field equal to XXX
S:X - Return all entries with a status of X.
Possible values of X:
A - Active Entries
I - Inactive Entries
B - Both active and inactive entries
Defaults to "S:B". INPUT PARAMETER: PXVDATE PARAMETER TYPE:
LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION: Used for determining status (both for filtering and for return
value).
Defaults to NOW.
RETURN PARAMETER DESCRIPTION:
Returns:
PXVRSLT(0)=Count of elements returned (0 if nothing found)
PXVRSLT(n)=IEN^Name^HL7 Code^Status (1:Active, 0:Inactive)
When filtering based off IEN, HL7 Code, or #.01 field, only one entry will
be returned in PXVRSLT(1).
When filtering based off status, multiple entries can be returned. The
first entry will be returned in subscript 1, and subscripts will be
incremented by 1 for further entries. Entries will be sorted
alphabetically.
If no entries are found based off the filtering criteria, PXVRSLT(0) will
equal 0, and there will be no data returned in the subsequent subscripts.		 PXVIMM INFO SOURCE 2017/10/18
6253 PXVIMM ADMIN ROUTE Remote Procedure PCE PATIENT CARE ENCOUNTER 2015/10/21 Withdrawn Controlled Subscription
Returns entries from the IMM ADMINISTRATION ROUTE file
(920.2).
6264 VPS WRITE TO 9000010 File PCE PATIENT CARE ENCOUNTER 2015/11/09 Withdrawn Controlled Subscription 9000010
This IA provides for the Fileman Write of the TYPE
(.03), PATIENT NAME (.05) and SERVICE CATEGORY (.07) fields in the VISIT FILE
#9000010.
6278 HMP UPDATE TO 9000010.23 File PCE PATIENT CARE ENCOUNTER 2015/11/24 Withdrawn Controlled Subscription 9000010.23
The Enterprise Health MGMT Platform (HMP) is adding new
records to the V Health Factors file (#9000010.23). HMP uses UPDATE^DIE to add
new health factors for a patient visit.
HMP identifies the last record in the file using a reverse $O.
6282 HMP ACCESS TO AUTTHF File PCE PATIENT CARE ENCOUNTER 2015/11/24 Withdrawn Controlled Subscription 9999999.64
The Enterprise Health MGMT Platform (HMP) is accessing
the Health Factors file (#9999999.64) to get the Factor (.01) field.
6285 SELECTABLE IMMUNIZATIONS File PCE PATIENT CARE ENCOUNTER 2015/11/30 APPROVED Active Private 9999999.14 2015/12/16
6385 RPC Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/03/08 Pending Private
6386 DQSAVE Routine PCE PATIENT CARE ENCOUNTER 2016/03/08 APPROVED Active Private PXRPC 2016/03/10
6387 IMMUNIZATION APIS Routine PCE PATIENT CARE ENCOUNTER 2016/03/08 APPROVED Active Controlled Subscription
REVISIONS: 8/22/23 - Patch PX*1*236 adds a new parameter, PXSKIPNOTLIMITED, to
the IMMGRP component and a new parameter, PXSKIPFOUR, to the PATICR component
of this agreement. These new parameters will not impact current subscribers,
as the components will function as they do currently without this new
parameter.		 PXAPIIM 2023/10/10
6477 HMP ACCESS TO AUPNVIMM File PCE PATIENT CARE ENCOUNTER 2016/08/24 Retired Controlled Subscription 9000010.11
The Enterprise Health MGMT Platform (HMP) requests
access to do direct global reads of the V IMMUNIZATION FILE (#9000011.11). HMP
does a direct global read of the Immunization file in order to check to see if
the immunization for the visit has already been entered prior to entering a
new immunization for the visit. To do this HMP does a loop thru the
AUPNVIMM("AD" cross reference. If an entry is found in the AD cross reference,
then a check is made to compare the immunization and patient against the data
for the new entry. If a match is found, HMP doesn't add the immunization
record, otherwise a new immunization is added to the file for the patient's
visit.
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated.
Discussions between PCE and HMP stopped after 12/21/16 and temporary approval
was not processed. Access to AUPNVIMM was found in ENC+18 in routine HMPWB5
and several places in routine HMPWBIM1 in Albany's DNS gold account.
If HMP is reactivated in the future, the HMP project team will need to work
with PCE developers to resolve this issue.
**********************************************************************
6635 PXVIMM ADMIN CODES Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/18 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Making a call to the PXVIMM ADMIN CODES RPC to retrieve immunization
administration CPT codes.		 PXVIMM ADMIN CODES 2017/01/11
6656 PXVIMM ADMIN ROUTE Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM ADMIN ROUTE RPC to retrieve the entries from the IMM
ADMINISTRATION ROUTE File (#920.2).		 PXVIMM ADMIN ROUTE 2017/01/11
6657 PXVIMM ADMIN SITE Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM ADMIN SITE RPC to retrieve entries from the IMM
ADMINISTRATION SITE (BODY) File (#920.3).		 PXVIMM ADMIN SITE 2017/01/11
6658 PXVIMM ICR LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM ICR LIST RPC to retrieve entries from the IMM
CONTRAINDICATION REASONS File (#920.4) and the IMM REFUSAL REASONS File
(#920.5).		 PXVIMM ICR LIST 2017/01/11
6659 PXVIMM IMM DETAILED Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls to the PXVIMM IMM DETAILED RPC to retrieve a detailed Immunization
Record.		 PXVIMM IMM DETAILED 2017/01/11
6660 PXVIMM IMM FORMAT Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM IMM FORMAT RPC to retrieve a formatted text of an
immunization for use in documentation.		 PXVIMM IMM FORMAT 2017/01/11
6661 PXVIMM IMM LOT Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM IMM LOT RPC to retrieve information from the IMMUNIZATION LOT
File (#9999999.41).		 PXVIMM IMM LOT 2017/01/11
6662 PXVIMM IMM MAN Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM IMM MAN RPC to retrieve information from the IMM MANUFACTURER
File (#9999999.04).		 PXVIMM IMM MAN 2017/01/11
6663 PXVIMM IMM SHORT LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Active Controlled Subscription
Calls the PXVIMM IMM SHORT LIST RPC to retrieve a short list of immunizations. 		PXVIMM IMM SHORT LIST 2017/11/20
6664 PXVIMM IMMDATA Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM IMMDATA RPC to retrieve information from the IMMUNIZATION
File (#9999999.14).		 PXVIMM IMMDATA 2017/01/11
6665 PXVIMM VICR EVENTS Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM VICR EVENTS RPC to retrieve "active" entries from the V IMM
CONTRA/REFUSAL EVENTS File (#9000010.707) that are related to the given
patient and immunization. "Active" is defined as entries where the Event Date
and Time is greater than or equal to PXDATE and the Warn Until Date is null or
greater than PXDATE.		 PXVIMM VICR EVENTS 2017/01/11
6666 PXVIMM VIS Remote Procedure PCE PATIENT CARE ENCOUNTER 2016/11/25 APPROVED Retired Controlled Subscription
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. 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 the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
**********************************************************************
Calls the PXVIMM VIS RPC to retrieve information from the VACCINE INFORMATION
STATEMENT File (#920).		 PXVIMM VIS 2017/01/11
6804 GET PATIENT ENCOUNTER DATA Routine PCE PATIENT CARE ENCOUNTER 2017/07/24 Pending Private
This ICR allows the return of all information about one
encounter in a global array.		 PXKENC
6834 EXECUTE PCE'S EVENT Routine PCE PATIENT CARE ENCOUNTER 2017/11/13 Pending Private
EXECUTE PCE'S EVENT is an integration agreement that
lets the caller execute PCE'S event.		 PXKMAIN
6904 DBIA6904 File PCE PATIENT CARE ENCOUNTER 2018/04/09 Pending Private 9999999.64
This integration agreement authorizes global reference
to the zeroith node of the following file for purposes of retrieving pieces
1-11 and usage of the "B" cross reference.
6953 PROVIDER NARRATIVE API Routine PCE PATIENT CARE ENCOUNTER 2018/08/03 APPROVED Active Private PXAPI 2018/08/06
6954 DBIA 6954 File PCE PATIENT CARE ENCOUNTER 2018/08/10 Pending Private 9000010
VIA requests the ability to update the DATA SOURCE
field (#81203) of the VISIT file (#9000010).
A CPRS RPC is used to create and sign a new note which defines the data source
as TIU. Then an update is sent to add note information with the actual data
source as part of the data. PCE keeps the original data source unless there is
a change in the patient's location. VIA requests to update the DATA SOURCE
field with the calling application at the time the update to the note is sent.
6955 DBIA 6955 Routine PCE PATIENT CARE ENCOUNTER 2018/08/10 Pending Private
VIA requests this ICR to utilize SOURCE^PXAPIUTL to add
a new source if not previously defined.
As part of adding progress notes, a CPRS RPC is used to create and sign a new
note which defines the data source as TIU. Then an update is sent to add note
information with the actual data source as part of the data. PCE keeps the
original data source unless there is a change in the patient's location. VIA
requests to call SOURCE^PXAPIUTL to add a new source if update to the note is
sent.
This ICR will be utilized in conjunction with DBIA 6954.		 PXAPIUTL
6992 IMMUNIZATION API FOR CLINICAL REMINDERS Routine PCE PATIENT CARE ENCOUNTER 2018/11/27 APPROVED Active Controlled Subscription PXPXRM1 2018/12/03
7027 VS GUI access to Visit Tracking Parameters (#150.9) File PCE PATIENT CARE ENCOUNTER 2019/02/27 Pending Private 150.9
************************************************************************
* *
* This is a temporary ICR for the production VistA Scheduling (VS) * *
GUI software. * * The
need for this ICR was identified from the VS Sustainment Team * * reviewing
the VistA Scheduling Enhancement (VSE) software that was * * released
nationally without approved ICRs. This temporary ICR * * represents the
situation, where the Custodian package experts * * requested changes to
the production software to use approved * * APIs, which requires a
future VS patch. This temporary ICR will * * expire when the production
code is modified to the use approved * * APIs
*
* *
************************************************************************
7032 VS GUI access to routine AUPNPAT Routine PCE PATIENT CARE ENCOUNTER 2019/02/28 Withdrawn Private
************************************************************************
* *
* This is a temporary ICR for the production VistA Scheduling (VS) * *
GUI software. * * The
need for this ICR was identified from the VS Sustainment Team * * reviewing
the VistA Scheduling Enhancement (VSE) software that was * * released
nationally without approved ICRs. This temporary ICR * * represents the
situation, where the Custodian package experts * * requested changes to
the production software to use approved * * APIs, which requires a
future VS patch. This temporary ICR will * * expire when the production
code is modified to the use approved * * APIs
*
* *
************************************************************************		 AUPNPAT
7033 VS GUI access to routine AUPNVSIT Routine PCE PATIENT CARE ENCOUNTER 2019/02/28 Pending Private
************************************************************************
* *
* This is a temporary ICR for the production VistA Scheduling (VS) * *
GUI software. * * The
need for this ICR was identified from the VS Sustainment Team * * reviewing
the VistA Scheduling Enhancement (VSE) software that was * * released
nationally without approved ICRs. This temporary ICR * * represents the
situation, where the Custodian package experts * * requested changes to
the production software to use approved * * APIs, which requires a
future VS patch. This temporary ICR will * * expire when the production
code is modified to the use approved * * APIs
*
* *
************************************************************************
VSIT01 validates the date of visit so that it is not in the future, after the
patient's death or before the patient's birth.		 AUPNVSIT
7046 VS GUI access to routine VSITVID Routine PCE PATIENT CARE ENCOUNTER 2019/03/14 Withdrawn Private
************************************************************************
* *
* This is a temporary ICR for the production VistA Scheduling (VS) * *
GUI software. * * The
need for this ICR was identified from the VS Sustainment Team * * reviewing
the VistA Scheduling Enhancement (VSE) software that was * * released
nationally without approved ICRs. This temporary ICR * * represents the
situation, where the Custodian package experts * * requested changes to
the production software to use approved * * APIs, which requires a
future VS patch. This temporary ICR will * * expire when the production
code is modified to the use approved * * APIs
*
* *
************************************************************************		 VSITVID
7048 VS GUI access to file #9000001 File PCE PATIENT CARE ENCOUNTER 2019/03/18 Withdrawn Private 9000001
************************************************************************
* *
* This is a temporary ICR for the production VistA Scheduling (VS) * *
GUI software. * * The
need for this ICR was identified from the VS Sustainment Team * * reviewing
the VistA Scheduling Enhancement (VSE) software that was * * released
nationally without approved ICRs. This temporary ICR * * represents the
situation, where the Custodian package experts * * requested changes to
the production software to use approved * * APIs, which requires a
future VS patch. This temporary ICR will * * expire when the production
code is modified to the use approved * * APIs
*
* *
************************************************************************
7187 DG ACCESS TO DD(9000001,0,'PT' File PCE PATIENT CARE ENCOUNTER 2020/07/22 APPROVED Active Private 9000001
The REGISTRATION package is requesting approval to
access the list of Files that point to the PATIENT/IHS File by examining
entries in ^DD(9000001,0,"PT"). The purpose is to identify Patient-related
Files for the VistA Security Remediation Audit Solution (VAS) in order to
determine which AUDIT (#1.1) records should be sent to the external archive.		 2020/08/13
7282 PXVRPC1 Routine PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription PXVRPC1 2021/10/13
7283 PXVRPC2 Routine PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription PXVRPC2 2021/10/13
7284 PXVRPC4 Routine PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription PXVRPC4 2021/10/13
7285 PXVRPC5 Routine PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription PXVRPC5 2021/10/13
7286 PXVRPC8 Routine PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription PXVRPC8 2021/10/13
7287 PXVIMM IMM SHORT LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM IMM SHORT LIST TAG: IMMSHORT
ROUTINE: PXVRPC4 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns a short list of immunizations. INPUT PARAMETER: FILTER
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Filter (Optional; Defaults to "B")
Possible values are: ;
"A": Only return active entries
"H": Only return entries marked as Selectable for Historic
"B": Return both active entries and those marked as Selectable for
Historic INPUT PARAMETER: PXDATE PARAMETER TYPE:
LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Date (optional; defaults to TODAY)
Used for determining immunization status (both for filtering and for
return value) INPUT PARAMETER: OREXCLUDE PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 3
DESCRIPTION:
Should entries defined in ORWPCE EXCLUDE IMMUNIZATIONS be excluded? INPUT
PARAMETER: LOCATION PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 4
DESCRIPTION:
Used when excluding entried listed in ORWPCE EXCLUDE IMMUNIZATIONS. This
is the location used when getting the paramater value at the Location
level.
RETURN PARAMETER DESCRIPTION:
PXRTRN(x)
Note: Status (in the 5th piece) is determined as follows:
- If PXDATE is today, the status is based off the Inactive Flag
(#.07)
- If PXDATE is different than today, we will look when an update was
last made to the Immunization file (based off the Audits). If there
have not been any changes since PXDATE, we will get the status
based off the Inactive Flag, otherwise, we will get the status for
that date by calling GETSTAT^XTID.
1: "IMM"
2: #9999999.14 IEN
3: Name (#.01)
4: CVX Code (#.03)
5: Status (1: Active; 0: Inactive)
6: Selectable for Historic (#8803)
7: Mnemonic (#8801)
8: Acronym (#8802)
9: Active Lot linked to this Immunization? (1:Yes; 0:No)
PXRTRN(x)
1: "CDC"
2: CDC Product Name (#9999999.145, #.01)
PXRTRN(x)
1: "GROUP"
2: Vaccine Group Name (#9999999.147, #.01)		 PXVIMM IMM SHORT LIST 2021/10/21
7288 PXVIMM IMM DETAILED Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM IMM DETAILED TAG: IMMRPC
ROUTINE: PXVRPC4 RETURN VALUE TYPE: GLOBAL ARRAY
WORD WRAP ON: TRUE
DESCRIPTION:
Returns a detailed Immunization record INPUT PARAMETER: PXIMM
PARAMETER TYPE: LITERAL
REQUIRED: YES SEQUENCE NUMBER: 1
DESCRIPTION:
Pointer to #9999999.14 (Required) INPUT PARAMETER: PXDATE
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Immunization status and Codes will be based off this date
(Optional; Defaults to NOW) INPUT PARAMETER: PXLOC PARAMETER
TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 3
DESCRIPTION:
Used to determine Institution, when filtering Lot and Defaults (Optional).
Possible values are:
"I:X": Institution (#4) IEN #X
"V:X": Visit (#9000010) IEN #X
"L:X": Hopital Location (#44) IEN #X
If PXLOC is not passed in OR could not make determination based off input,
then default to DUZ(2), and if DUZ(2) is not defined, default to Default
Institution.
RETURN PARAMETER DESCRIPTION:
^TMP("PXVIMMRPC",$J,0)
1: 1 - Immunization was found. The "1" node will be returned, but the
other nodes are optional.
-1 - Immunization was not found; no other nodes will be returned
^TMP("PXVIMMRPC",$J,1)
Note: Status (in the 5th piece) is determined as follows:
- If PXDATE is today, the status is based off the Inactive Flag
(#.07)
- If PXDATE is different than today, we will look when an update was
last made to the Immunization file (based off the Audits). If there
have not been any changes since PXDATE, we will get the status
based off the Inactive Flag, otherwise, we will get the status for
that date by calling GETSTAT^XTID.
1: "IMM"
2: #9999999.14 IEN
3: Name (#.01)
4: CVX Code (#.03)
5: Status (1: Active; 0: Inactive)
6: Selectable for Historic (#8803)
7: Mnemonic (#8801)
8: Acronym (#8802)
9: Max # In Series (#.05)
10: Combination Immunization (Y/N) (#.2)
11: Reading Required (#.51)
12: Series Required (calculated)
^TMP("PXVIMMRPC",$J,x)
1: "VIS"
2: #920 IEN
3: Name (#920,#.01)
4: Edition Date (#920,#.02)
5: Edition Status (#920,#.03)
6: Language (#920, #.04)
7: 2D Bar Code (#100)
8: VIS URL (#101)
^TMP("PXVIMMRPC",$J,x)
1: "CDC"
2: CDC Product Name (#9999999.145, #.01)
^TMP("PXVIMMRPC",$J,x)
1: "GROUP"
2: Vaccine Group Name (#9999999.147, #.01)
^TMP("PXVIMMRPC",$J,x)
1: "SYNONYM"
2: Synonym (#9999999.141, #.01)
^TMP("PXVIMMRPC",$J,x)
Note: Only active codes (based off PXDATE) are returned.
1: "CS"
2: Coding System (#9999999.143, #.01)
3: Code (#9999999.1431,#.01)
4: Variable pointer. e.g., IEN;ICPT(
5: Short Description
^TMP("PXVIMMRPC",$J,x)
Note: Only active lots for the given division are returned.
Also, the Expiration date must be >= PXDATE
1: "LOT"
2: #9999999.41 IEN
3: Lot Number (#9999999.41, #.01)
4: Manufacturer (#9999999.04, #.01)
5: Expiration Date (#9999999.41, #.09)
6: Doses Unused (#9999999.41, #.12)
7: Low Supply Alert (#9999999.41, #.15)
8: NDC Code (#9999999.41, #.18)
^TMP("PXVIMMRPC",$J,x)
Note: Only active contraindications are returned
1: "CONTRA"
2: #920.4 variable pointer: IEN;PXV(920.4,
3: Name (#920.4, #.01)
4: Status (1:Active, 0:Inactive)
5: Code|Coding System (#920.4, #.02 and .05)
6: NIP004 (#920.4, #.04)
7: Contraindication/Precaution (#920.4, #.06)
8: Allergy-Related (1:Yes, 0:No)
9: Default Warn Until Date ("Forever" means it should be forever)
^TMP("PXVIMMRPC",$J,x)
1: "DEF"
2: Default Route (#920.051, #1302)
3: Default Site (#920.051, #1303)
4: Default Dose (#920.051, #1312)
5: Default Dose Units (#920.051, #1313)
6: Default Dose Units (external format) (#920.051, #1313)
7: Default Non-Standard Dose Units (#920.051, #1314)
^TMP("PXVIMMRPC",$J,x)
1: "DEFC"
2: Default Comments (#920.051, #81101)		 PXVIMM IMM DETAILED 2021/10/21
7289 PXVIMM ADMIN SITE Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM ADMIN SITE TAG: IMMSITE
ROUTINE: PXVRPC2 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns entries from the IMM ADMINISTRATION SITE (BODY) file (920.3). INPUT
PARAMETER: FILTER PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Filter. Possible values are:
R:XXX - Return entry with IEN XXX.
H:XXX - Return entry with HL7 Code XXX.
N:XXX - Return entry with #.01 field equal to XXX
S:X - Return all entries with a status of X.
Possible values of X:
A - Active Entries
I - Inactive Entries
B - Both active and inactive entries
Defaults to "S:B".
RETURN PARAMETER DESCRIPTION:
Returns:
PXVRSLT(0)=Count of elements returned (0 if nothing found)
PXVRSLT(n)=IEN^Name^HL7 Code^Status (1:Active, 0:Inactive)
When filtering based off IEN, HL7 Code, or #.01 field, only one entry will
be returned in PXVRSLT(1).
When filtering based off status, multiple entries can be returned. The
first entry will be returned in subscript 1, and subscripts will be
incremented by 1 for further entries. Entries will be sorted
alphabetically.
If no entries are found based off the filtering criteria, PXVRSLT(0) will
equal 0, and there will be no data returned in the subsequent subscripts.		 PXVIMM ADMIN SITE 2021/10/21
7290 PXVIMM ICR LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM ICR LIST TAG: GETICR
ROUTINE: PXVRPC5 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns entries from the IMM CONTRAINDICATION REASONS (#920.4) and IMM
REFUSAL REASONS (#920.5) files. INPUT PARAMETER: PXFILE
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Which file to pull from.
(Optional; Leave this null to pull entries from both files)
Possible values are:
"920.4" - Only return entries from IMM CONTRAINDICATION REASONS
(#920.4)
"920.5" - Only return entries from IMM REFUSAL REASONS (#920.5) INPUT
PARAMETER: FILTER PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Filter (Optional; Defaults to "S:A")
Possible values are:
R:X - Return entry with IEN X (PXFILE must be passed in with this
option).
C:X^Y - Return entry with Concept Code^Coding System X^Y (used only for
#920.4).
H:X - Return entry with HL7 Code X (used only for #920.5).
N:X - Return entry with #.01 field equal to X
I:X - Return all active entries that are selectable for Immunization
IEN X.
S:A - Return all active entries.
S:I - Return all inactive entries.
S:B - Return all entries (both active and inactive). INPUT PARAMETER:
INST PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 3
DESCRIPTION:
Institution IEN INPUT PARAMETER: LOC PARAMETER TYPE:
LITERAL
SEQUENCE NUMBER: 4
DESCRIPTION:
Location IEN (If Institution IEN is not passed in, the loc will be used
to get the institution).
RETURN PARAMETER DESCRIPTION:
PXRSLT(0)=Count of elements returned (0 if nothing found)
For 920.4 Entry:
PXRSLT(n)=IEN;PXV(920.4,^Name^Status (1:Active, 0:Inactive)^Code|Coding
System^NIP004^Contraindication/Precaution^Allergy-Related
(1:Yes, 0:No)^Default Warn Until Date ("Forever" means it
should be forever)
For 920.5 Entry:
PXRSLT(n)=IEN;PXV(920.5,^Name^Status (1:Active, 0:Inactive)^HL7
Code^Default Warn Until Date ("Forever" means it should be
forever)		 PXVIMM ICR LIST 2021/10/21
7291 PXVIMM INFO SOURCE Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM INFO SOURCE TAG: IMMSRC
ROUTINE: PXVRPC2 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns entries from the IMMUNIZATION INFO SOURCE file (920.1). INPUT
PARAMETER: FILTER PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Filter. Possible values are:
R:XXX - Return entry with IEN XXX.
H:XXX - Return entry with HL7 Code XXX.
N:XXX - Return entry with #.01 field equal to XXX
S:X - Return all entries with a status of X.
Possible values of X:
A - Active Entries
I - Inactive Entries
B - Both active and inactive entries
Defaults to "S:B".
RETURN PARAMETER DESCRIPTION:
Returns:
PXVRSLT(0)=Count of elements returned (0 if nothing found)
PXVRSLT(n)=IEN^Name^HL7 Code^Status (1:Active, 0:Inactive)
When filtering based off IEN, HL7 Code, or #.01 field, only one entry will
be returned in PXVRSLT(1).
When filtering based off status, multiple entries can be returned. The
first entry will be returned in subscript 1, and subscripts will be
incremented by 1 for further entries. Entries will be sorted
alphabetically.
If no entries are found based off the filtering criteria, PXVRSLT(0) will
equal 0, and there will be no data returned in the subsequent subscripts.		 PXVIMM INFO SOURCE 2021/10/21
7292 PXVIMM VICR EVENTS Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM VICR EVENTS TAG: GETVICR
ROUTINE: PXVRPC5 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns "active" entries from the V IMM CONTRA/REFUSAL EVENTS file
(#9000010.707) that are related to the given patient and immunization.
"Active" is defined as entries where the Event Date and Time is <=
PXDATE@24 and the Warn Until Date is null or>= PXDATE. INPUT PARAMETER: DFN
PARAMETER TYPE: LITERAL
REQUIRED: YES SEQUENCE NUMBER: 1
DESCRIPTION:
Pointer to file #2. INPUT PARAMETER: PXVIMM PARAMETER TYPE:
LITERAL
REQUIRED: YES SEQUENCE NUMBER: 2
DESCRIPTION:
Pointer to #9999999.14. INPUT PARAMETER: PXDATE PARAMETER
TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 3
DESCRIPTION:
Used to determine if entry is "active" (Optional; Defaults to TODAY)
Possible values are:
"L": Return a caret-delimited list of entries.
"W": Returns a warning message. INPUT PARAMETER: PXFORMAT
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 4
DESCRIPTION:
Format that return array should be returned (Optional; Defaults to "L")
Possible values are:
"L": Return a caret-delimited list of entries.
"W": Returns a warning message.
RETURN PARAMETER DESCRIPTION:
PXRSLT(0)=Count of elements returned (0 if nothing found)
If PXFORMAT="L":
PXRSLT(n)="VICR" ^ V IMM Contra/Refusal Events IEN ^ Visit IEN ^
Contra/Refusal variable pointer | Contra/Refusal Name ^
Immunization IEN | Name ^ Warn Until Date ^ D/T Recorded ^
Event D/T ^ Encounter Provider IEN | Name
PXRSLT(n)="COM" ^ Comments
If PXFORMAT["W":
PXRSLT(n)=Warning text		 PXVIMM VICR EVENTS 2021/10/21
7293 PXVIMM IMM MAN Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM IMM MAN TAG: IMAN
ROUTINE: PXVRPC1 RETURN VALUE TYPE: GLOBAL ARRAY
WORD WRAP ON: TRUE
DESCRIPTION:
This RPC returns information from the IMM MANUFACTURER file
(#9999999.04). INPUT PARAMETER: FILTER PARAMETER TYPE:
LITERAL
MAXIMUM DATA LENGTH: 80 REQUIRED: NO
SEQUENCE NUMBER: 1
DESCRIPTION:
This input parameter is used to specify the IMMUNIZATION LOT file
records to be returned. Possible values:
R:XXX - return entry with ien XXX
M:XXX - return entry with MVX code XXX
N:XXX - return entry with imm manufacturer name XXX
S:A - return list of all active manufacturers
S:I - return list of all inactive manufacturers
S:B - return list of all manufacturers, active and inactive
If this parameter is null, it defaults to "S:B". INPUT PARAMETER: PXVDATE
PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 7 REQUIRED: NO
SEQUENCE NUMBER: 2
DESCRIPTION:
This optional input parameter is used in determining status. Input
should be in VA FileMan date format. The default value is the current
date. INPUT PARAMETER: PXVI PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 1 REQUIRED: NO
SEQUENCE NUMBER: 3
DESCRIPTION:
This optional input parameter is used to return an alternate array with
record data in a caret delimited string. If this parameter is null or 0,
the return defaults to the other array.
1 - return alternate array with internal values in delimited string
RETURN PARAMETER DESCRIPTION:
Returns with PXVI not equal to 1:
PXVRETRN - returned information is stored in ^TMP("PXVLST",$J))
- return info format: Data Element Name^Data Element Value
- error format: -1^error message
For each record returned in the global array, the top value returned will
indicate the record number in the array and the total number of records
returned, e.g., "RECORD^1 OF 3".
This RPC returns the internal entry number (IEN) of the record and data
in external format from the following data fields in the IMM
MANUFACTURER file:
- NAME (#.01)
- MVX (#.02)
- INACTIVE FLAG (#.03)
- CDC NOTES (#201)
- STATUS (computed by Data Standardization utility)
Example Global Array Returned:
^TMP("PXVLST",$J,"WYETH-AYERST 1",0)="RECORD^1 OF 1"
.001)="IEN^55"
.01)="NAME^WYETH-AYERST"
.02)="MVX CODE^WA"
.03)="INACTIVE FLAG^INACTIVE"
201)="CDC NOTES^became WAL, now owned by
Pfizer"
"STATUS")="STATUS^INACTIVE"
Example Global Array Returned if No Records Found:
^TMP("PXVLST",$J,0)="0 RECORDS"
Example error messages:
^TMP("PXVLST",$J,0)="-1^Invalid input value"
^TMP("PXVLST",$J,0)="-1^Invalid input for manufacturer IEN"
^TMP("PXVLST",$J,0)="-1^Invalid input for MVX code"
^TMP("PXVLST",$J,0)="-1^Invalid input for manufacturer name"
Returns with PXVI equal to 1:
PXVRETRN - returned information is stored in ^TMP("PXVLST",$J))
Each record is a caret-delimited list of values. Within the
caret-delimited list, for fields with different internal and external
values, both the internal and external values are included, delimited
by a tilde (~) as indicated below:
Piece# Field# Field Name
------ ------ ----------
1 IEN
2 .01 NAME
3 .02 MVX CODE
4 .03 INACTIVE FLAG (Internal~External)
5 201 CDC NOTES
6 STATUS (computed by Data Standardization utility)		 PXVIMM IMM MAN 2021/10/21
7294 PXVIMM ADMIN ROUTE Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM ADMIN ROUTE TAG: IMMROUTE
ROUTINE: PXVRPC2 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns entries from the IMM ADMINISTRATION ROUTE file (920.2). INPUT
PARAMETER: FILTER PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Filter. Possible values are:
R:XXX - Return entry with IEN XXX.
H:XXX - Return entry with HL7 Code XXX.
N:XXX - Return entry with #.01 field equal to XXX
S:X - Return all entries with a status of X.
Possible values of X:
A - Active Entries
I - Inactive Entries
B - Both active and inactive entries
Defaults to "S:B". INPUT PARAMETER: PXVSITES PARAMETER TYPE:
LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Controls if the available sites for a give route are returned.
RETURN PARAMETER DESCRIPTION:
PXVRSLT(0)=Count of elements returned (0 if nothing found)
PXVRSLT(n)=IEN^Name^HL7 Code^Status (1:Active, 0:Inactive)
If PXVSITES=1, the sites for a given route will also be returned.
o If only a subset of sites are selectable for a route, that list will
be returned in:
PXVRSLT(n+1)=SITE^Site IEN 1
PXVRSLT(n+2)=SITE^Site IEN 2
PXVRSLT(n+x)=SITE^Site IEN x
o If all sites are selectable for a route, the RPC will return:
PXVRSLT(n+1)=SITE^ALL
o If no sites are selectable for a route, the RPC will return:
PXVRSLT(n+1)=SITE^NONE
equal 0, and there will be no data returned in the subsequent subscripts.		 PXVIMM ADMIN ROUTE 2021/10/21
7295 PXVSK DEF SITES Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVSK DEF SITES TAG: SKSITES
ROUTINE: PXVRPC8 RETURN VALUE TYPE: ARRAY
AVAILABILITY: SUBSCRIPTION
DESCRIPTION:
Returns a list of default administration sites for skin tests.
RETURN PARAMETER DESCRIPTION:
(0)=Count of elements returned (0 if nothing found)
(n)=IEN^NAME		 PXVSK DEF SITES 2021/10/21
7296 PXVSK SKIN SHORT LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVSK SKIN SHORT LIST TAG: SKSHORT
ROUTINE: PXVRPC8 RETURN VALUE TYPE: ARRAY
AVAILABILITY: SUBSCRIPTION
DESCRIPTION:
Returns one or more entries from the Skin Test file. INPUT PARAMETER: DATE
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 1
DESCRIPTION:
Used for determining skin test status. (Defaults to TODAY). INPUT PARAMETER:
FILTER PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Used to filter entries. (Optional; Defaults to "S:A").
Possible values are:
R:X - Return entry with IEN X.
N:X - Return entry with #.01 field equal to X
S:A - Return all active entries.
S:I - Return all inactive entries.
S:B - Return all entries (both active and inactive). INPUT PARAMETER:
OREXCLUDE PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 3
DESCRIPTION:
Should entries defined in ORWPCE EXCLUDE SKIN TESTS be excluded? (Used
when PXFLTR is set to S:x). INPUT PARAMETER: LOCATION
PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 4
DESCRIPTION:
Used when excluding entried listed in ORWPCE EXCLUDE SKIN TESTS. This
is the location used when getting the paramater value at the Location
level.
RETURN PARAMETER DESCRIPTION:
(0)=Count of elements returned (0 if nothing found)
(n)=SK^IEN^NAME^PRINT NAME
(n)=CS^Coding System^Code^Variable pointer^Short Description		 PXVSK SKIN SHORT LIST 2021/10/21
7297 PXVSK V SKIN TEST LIST Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVSK V SKIN TEST LIST TAG: SKLIST
ROUTINE: PXVRPC8 RETURN VALUE TYPE: ARRAY
AVAILABILITY: SUBSCRIPTION
DESCRIPTION:
Returns a list of V Skin Test entries that have been placed within the
last x days. The number of days to look back is defined in the PXV SK DAYS
BACK parameter. INPUT PARAMETER: DFN PARAMETER TYPE:
LITERAL
REQUIRED: YES SEQUENCE NUMBER: 1
DESCRIPTION:
Only V Skin Test entries for this patient will be returned. INPUT PARAMETER:
SKINTEST PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Skin Test IEN. If passed in, only V Skin Test entries for this Skin Test
will be returned. If not passed in, all V Skin Tests entries will be
returned. INPUT PARAMETER: DATE PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 3
DESCRIPTION:
The system will search back x number of days from this date. Defaults to
TODAY. INPUT PARAMETER: MAX PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 4
DESCRIPTION:
The max number of entries to return per skin test.
RETURN PARAMETER DESCRIPTION:
(0)=Count of elements returned (0 if nothing found)
(1)=DATERANGE^Start Date^Stop Date
(n)=PLACEMENT^V Skin Test IEN^Skin Test IEN^Skin Test Name^Date/Time of
Placement		 PXVSK V SKIN TEST LIST 2021/10/21
7298 PXVIMM ADMIN CODES Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 APPROVED Active Controlled Subscription
NAME: PXVIMM ADMIN CODES TAG:
IMMADMCODES
ROUTINE: PXVRPC4 RETURN VALUE TYPE: ARRAY
DESCRIPTION:
Returns immunization administration CPT codes. INPUT PARAMETER: VISIT
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 1 INPUT PARAMETER: PCELIST PARAMETER TYPE:
LIST
REQUIRED: YES SEQUENCE NUMBER: 2 INPUT PARAMETER:
RETCPTDEL PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 3
RETURN PARAMETER DESCRIPTION:
PXRSLT(n) = Array of CPT codes to add/delete from Visit in format passed
to PX SAVE DATA rpc.		 PXVIMM ADMIN CODES 2021/10/21
7299 PX ICE WEB Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/09/03 Pending Controlled Subscription
NAME: PX ICE WEB TAG: RPC
ROUTINE: PXVWICE RETURN VALUE TYPE: GLOBAL ARRAY
AVAILABILITY: SUBSCRIPTION WORD WRAP ON: TRUE
DESCRIPTION:
Call the ICE web service to get the list of recommended immunizations for
a given patient.
The RPC takes one parameter, the Patient IEN (DFN).
See the RETURN PARAMETER DESCRIPTION for the details on the format of the
returned array.
There must be at least one entry defined in File 920.75, PX ICE WEB
SERVER. If there is more than one entry, then the Site Parameter, PX ICE
WEB DEFAULT SERVER, specifies which entry is to be used. INPUT PARAMETER:
DFN PARAMETER TYPE: LITERAL
REQUIRED: YES SEQUENCE NUMBER: 1
DESCRIPTION:
Patient DFN INPUT PARAMETER: CACHE PARAMETER TYPE: LITERAL
REQUIRED: NO SEQUENCE NUMBER: 2
DESCRIPTION:
Use cache? 1=Yes; 0=No (default: 1).
RETURN PARAMETER DESCRIPTION:
If Unsuccessful:
0) = -X^Error Message
Note: -X can be one of the following values:
-1: Invalid input
-2: Could not make SOAP call (e.g., URL not populated in
920.75, etc.)
-3: HTTP call returned unsuccessful status code (i.e.,
Server returned status code other than 200)
-4: Unable to process incoming message from ICE
n) = If SOAP call was unsuccessful, this will be the message returned
by the ICE server.
If Successful:
0) = 1 ^ Number of Lines
n) = GRP ^ Vaccine Group Name ^ Group/CVX Code Recommended ^ Group/CVX
Display Name ^ Earliest Recommended Date ^ Overdue Date ^ Recommend
Code ^ Recommend Display Name ^ Doses Remaining
1: GRP
2: Vaccine Group Name - This is the vaccine group for this
recommendation
3: Group/CVX Code Recommended - Vaccine or vaccine group
recommended. If a specific vaccine is recommended, this will
be the CVX code, in the format C:CVX_Code. More commonly, this
will be populated with the vaccine group, in the format
G:Group_Name
4: Group/CVX Display Name - Display Name for CVX/Group in piece
#3.
5: Earliest Recommended Date
6: Overdue Date
7: Recommend Code (currently either RECOMMENDED,
FUTURE_RECOMMENDED, CONDITIONALLY_RECOMMENDED, or
NOT_RECOMMENDED)
8: Recommend Display Name
9: Doses Remaining
n) = RSN ^ Reason Code ^ Reason Display Name
Note: This is the reason(s) for the recommendation above.
1: RSN
2: Reason Code
3: Reason Display Name
n) = HIST ^ V Immunization IEN ^ Immunization Name ^ Administered CVX
Code ^ Admin date/time ^ Dose Number ^ Component CVX Code ^ CVX
Display Name ^ Validity Code ^ Validity Display Name
1: HIST
2: V Immunization IEN (#9000010.11 IEN)
3: Immunization Name (#9999999.14, #.01)
4: Administered CVX Code (#9999999.14, #.03)
5: Admin date/time
6: Dose Number
7: Component CVX Code (for combination vaccines, this can defer
from the CVX administered)
8: CVX Display Name
9: Validity Code
10: Validity Display Name
n) = RSN ^ Reason Code ^ Reason Display Name
Note: This is the reason(s) why the vaccine is valid, invalid or
accepted.
1: RSN
2: Reason Code
3: Reason Display Name		 PX ICE WEB
7315 PXRPC SAVE2 Remote Procedure PCE PATIENT CARE ENCOUNTER 2021/12/13 APPROVED Active Controlled Subscription
PXRPC SAVE2 was included in PX*1*217 and distributed
with CPRS v32b. This RPC PXRPC SAVE2 is encouraged to be used instead of PX
SAVE DATA, because it is a more complete solution which includes warnings and
error information.
NAME: PXRPC SAVE2 TAG: SAVE2
ROUTINE: PXRPC RETURN VALUE TYPE: ARRAY
AVAILABILITY: SUBSCRIPTION DESCRIPTION:
This is similar to PX SAVE DATA, except this RPC returns error
information. INPUT PARAMETER: PCELIST PARAMETER TYPE: LIST
MAXIMUM DATA LENGTH: 10000 REQUIRED: YES
SEQUENCE NUMBER: 1 DESCRIPTION:
See PX SAVE DATA. INPUT PARAMETER: PKGNAME PARAMETER TYPE:
LITERAL
MAXIMUM DATA LENGTH: 60 REQUIRED: YES
SEQUENCE NUMBER: 2 DESCRIPTION:
See PX SAVE DATA. INPUT PARAMETER: SRC PARAMETER TYPE:
LITERAL
MAXIMUM DATA LENGTH: 60 REQUIRED: YES
SEQUENCE NUMBER: 3 DESCRIPTION:
See PX SAVE DATA. INPUT PARAMETER: VISIT PARAMETER TYPE:
LITERAL
MAXIMUM DATA LENGTH: 30 REQUIRED: NO
SEQUENCE NUMBER: 4 DESCRIPTION:
See PX SAVE DATA. RETURN PARAMETER DESCRIPTION:
See PX SAVE DATA.		 PXRPC SAVE2 2024/08/30
7327 COMPACT ACT Routine PCE PATIENT CARE ENCOUNTER 2023/12/04 APPROVED Active Controlled Subscription
Patches DG*5.3*1104 and PX*1.0*240 will allow
Registration to make decisions on when to prompt for COMPACT Act clinical
information. For this decision-making process Registration needs to call the
entry point ASC^PXCOMPACT to determine if the patient is currently in an Acute
Suicidal Crisis.
Registration also needs to be able to add a new entry to the COMPACT ACT
EPISODE OF CARE file (#818) for a patient and this is allowed by a call made
to the ADMIT^PXCOMPACT entry point.
Other displays needed during the registration process are determined by the
entry point DISPLAY^PXCOMPACT.
Registration also needs to be able to use the entry point VISIT^PXCOMPACT to
set the Episode of Care (EOC) pointer to the PTF file.
If a new EOC needs to be opened or reopened during a patient transfer, or if
an EOC needs to be retracted during editing or deletion of a movement,
Registration needs to determine the appropriate EOC using $$GETEOC^PXCOMPACT
and $$GETEOCSEQ^PXCOMPACT, use SETENDDT to close an open outpatient episode,
and use NEWEOC^PXCOMPACT to create a new episode.
During an admission, Registration needs to access $$GETIPDT^PXCOMPACT and
$$GETSTDT^PXCOMPACT to determine benefit start and end dates.
Upon a discharge, Registration must use CHGTYPSTAT^PXCOMPACT to change the
COMPACT Act benefit from Inpatient to Outpatient.
During a transfer, Registration must call REOPNEOC^PXCOMPACT to reopen an
episode of care for a PTF that is already associated with an episode.
Revision History
5/7/24 - Removed FILEMANERR component (moved to new routine)
4/25/24 - Removed $$ADMIN Component and hence removed Scheduling package as
subscriber, since Scheduling only used the $$ADMIN component.
7/17/24 - Added $$GETEOC component effective with patches PX*1.0*240 and
DG*5.3*1104
9/24/24 - Added SETENDDT component effective with patches PX*1.0*240 and
DG*5.3*1104
10/22/24 - Added RESET component effective with patches PX*1.0*241 and
DG*5.3*1117		 PXCOMPACT 2024/10/24
7398 PXVUTIL Routine PCE PATIENT CARE ENCOUNTER 2022/12/22 APPROVED Active Controlled Subscription PXVUTIL 2022/12/23
7417 IMMUNIZATION HL7 CODE LOOKUP Routine PCE PATIENT CARE ENCOUNTER 2023/02/22 APPROVED Active Controlled Subscription PXRPC 2023/02/22
7433 RETURN THE INSTITUTION ENTRY FOR AN LOCATION Routine PCE PATIENT CARE ENCOUNTER 2023/08/08 APPROVED Active Private
This API returns the corresponding file 4 IEN for the
passed in location IEN from file 44.		 VSITCK1 2023/08/14
7435 Enhanced PCE Encounter Lookup Routine PCE PATIENT CARE ENCOUNTER 2023/08/22 APPROVED Active Controlled Subscription PXUTLVST 2023/08/23
7438 COMPACT ACT EOC EDIT ACCESS Other PCE PATIENT CARE ENCOUNTER 2023/10/05 APPROVED Active Private
The COMPACT Act EOC Edit [PX COMPACT ACT EOC EDIT]
option and the COMPACT Act EOC Inpatient Retraction [PX COMPACT EOC IP
RETRACTION] option will be added to the Supervisor ADT Menu [DG SUPERVISOR
MENU]. REGISTRATION admissions will need the ability to edit the start and/or
end date(s) of the Acute Suicidal Crisis from the new COMPACT Act EOC Edit
option so that this date will be captured per VA policy. The new COMPACT Act
EOC Inpatient Retraction option will allow an Episode of Care to be retracted
if a patient was entered in error or the wrong codes were used. These edits
will be made based on supporting documentation from the Provider.		 2023/10/16
7454 ACCESS COMPACT ACT DATA FOR HL7 TRANSMISSION Routine PCE PATIENT CARE ENCOUNTER 2024/02/01 APPROVED Active Private
Effective with PX*1.0*241 from the COMPACT OHI project,
to share critical changes to the COMPACT ACT EPISODE OF CARE File #818 to VES
via a new HL7 segment, ZCA, added to the existing IVM Background Job Full Z07
HL7 message.		 PXCOMPACTHL7 2024/10/10
7464 COMPACT ACT Retract Episode of Care Routine PCE PATIENT CARE ENCOUNTER 2024/04/15 APPROVED Active Private
Registration needs to be able to retract a COMPACT Act
Episode of Care when a patient was entered with the wrong codes or the wrong
patient was entered.		 PXCOMPACTEOC 2024/04/24
7469 COMPACT ACT ERROR LOGGING Routine PCE PATIENT CARE ENCOUNTER 2024/05/07 APPROVED Active Private
Patches DG*5.3*1104 and PX*1.0*240 will allow
Registration to log calls to the EE Web Service in the COMPACT ACT TRANSACTION
LOG File (#33.3). Registration needs to access the entry point
FILEMANERR^PXCOMPACT1 to log any data errors during this process.		 PXCOMPACT1 2024/05/20
7472 COMPACT ACT API for IB Routine PCE PATIENT CARE ENCOUNTER 2024/05/23 APPROVED Active Private
During COMPACT Act processing, Integrated Billing (IB)
needs to determine whether a given encounter, admission, or patient movement
is treatment for an acute suicidal crisis. This API allows IB to call PCE for
this information.		 PXCOMPACTIB 2024/08/12
7494 READ V STANDARD CODES DATA File PCE PATIENT CARE ENCOUNTER 2024/09/16 APPROVED Active Controlled Subscription 9000010.71 2024/09/16
7506 SPECIAL AUTHORITIES Routine PCE PATIENT CARE ENCOUNTER 2024/11/07 APPROVED Active Controlled Subscription
Patch PX*1*244 will release a new SPECIAL AUTHORITIES
FILE #(820) and a routine of API calls to retrieve information about all the
special authorities. This Controlled ICR allows subscribers to call these
APIs.
The Special Authorities file will define all the currently known Special
Authorities. This file will facilitate future growth and help minimize
elaborate software enhancements when adding a new special authority. This file
contains the business rules for each special authority, e.g. name, code,
disabled, abbreviation, sequence, default, disabled, visible, Package -
disabled?, Linked authority behavior rules, Linked Authority, When value is,
Actions to take.
See the individual component entries for descriptions and examples of how to
call the API and what it returns.		 PXSPECAUTH 2025/04/28
7519 PXSPECAUTH SPECAUTHDEF Remote Procedure PCE PATIENT CARE ENCOUNTER 2025/02/24 Pending Controlled Subscription
Patch PX*1.0*244 will release a new SPECIAL AUTHORITIES
FILE #(820) and a routine of API calls to retrieve information about all the
special authorities. This Controlled ICR allows subscribers to call these APIs
to retrieve information from the new file.
Special Authorities file will define all the previously known as Environmental
Indicators in a file to allow future growth and to help minimize elaborate
software enhancements when needing to add a new authority. This file contains
the business rules behind each authority, e.g. Name, code, disabled,
abbreviation, sequence, default, disabled, visible, Package - disabled?,
Linked authority behavior rules, Linked Authority, When value is, Actions to
take.
See individual Component Entry for description and examples of call and
returned results.
7577 SPECIAL AUTHORITIES READ VIA CODE FIELD File PCE PATIENT CARE ENCOUNTER 2025/08/12 Pending Controlled Subscription 820
This integration agreement allows subscribing packages
to lookup entries in the SPECIAL AUTHORITIES file (#820) via the CODE field
(#2) C cross-reference and access certain fields for each entry.
7582 SPECIAL AUTHORITIES STRUCTURE Remote Procedure PCE PATIENT CARE ENCOUNTER 2025/08/29 Pending Controlled Subscription
Patch PX*1.0*244 will release a new SPECIAL AUTHORITIES
FILE #(820) and a routine of API calls to retrieve information about all the
special authorities (previously known as Environmental Indicators). This
Controlled ICR allows subscribers to call these APIs to retrieve information
from the new file.
The Special Authorities file allows future growth and to help minimize
elaborate software enhancements when needing to add a new authority. This file
contains the business rules behind each authority, e.g. Name, code, disabled,
abbreviation, sequence, default, disabled, visible, Package - disabled?,
Linked authority behavior rules, Linked Authority, When value is, Actions to
take.
See individual Component Entry for description and examples of call and
returned results.