Print Page as PDF
DBIA1889-F ICR (1894)

DBIA1889-F    ICR (1894)

Name Value
NUMBER 1894
IA # 1894
DATE CREATED 1997/01/23
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAPI
NAME DBIA1889-F
ORIGINAL NUMBER 1889
GENERAL DESCRIPTION
APIs to obtain encounter information.

Updated 1/16/2026 to include the addition of V STANDARD CODES, and the
addition of the 900 nodes in the VISIT and V POV files.  The 900 nodes replace
the 800 nodes to store the Service Connected and Special Authority (SC/SA)
applicability for an encounter. For encounters created after the installation
of PX*1*244 an 800 node will be constructed from the 900 node to provide
backwards compatibility. Effective with patch PX*1*244.
STATUS Active
DURATION Next Version
ID PXAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION
GETENC
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 ^

Returned Data:
Identical to that returned by ENCEVENT^PXAPI, see above.
If the input data matches more than one Visit file entry
there will be sets of
^TMP("PXKENC",$J,VISIT IEN) entries for each of them.
ENCEVENT

ENCEVENT^PXAPI(VISITIEN,DONTKILL)

This API was developed to extract all PCE encounter data
for a single encounter. The data represents elements
that are stored in the Visit file 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 initialized. Enter 0 or
"" (NULL) to initialize the array, and 1
to retain it.

Returned Data:

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: Name spaced variable: "PXKENC".
Subscript 2: Job Number, $J.
Subscript 3: Internal Entry Number (IEN) of the Visit.
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
"SC"    = V Standard Codes      #9000010.71
"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: DD node/subscript where the data is stored.
Only the DD nodes that have data are
published.

Returned Data:

The data to the right of the equal sign is a copy the data in the PCE file. In
the example below, the encounter consists of the Visit file entry with
IEN=7589 and the various V-file entries pointing to it. For example,

^TMP("PXKENC",2241218,7589,"CPT",3445,0)="99601^140^7589^829^^^^^^^^^^^^1" is
the 0 node of the V CPT entry IEN=3445. You can determine what each piece of
data is by examining the data dictionary for V CPT. The same applies for the
12 and 812 nodes. In this example, the other V CPT nodes do not have any data
so they are not published.

Output Example:

^TMP("PXKENC",2241218,7589,"CPT",3445,0)="99601^140^7589^829^^^^^^^^^^^^1"
^TMP("PXKENC",2241218,7589,"CPT",3445,12)=3260106.165547
^TMP("PXKENC",2241218,7589,"CPT",3445,812)="^170^19"
^TMP("PXKENC",2241218,7589,"HF",137,0)="648303^140^7589"
^TMP("PXKENC",2241218,7589,"HF",137,12)=3260108.165546
^TMP("PXKENC",2241218,7589,"HF",137,220)="0^623"
^TMP("PXKENC",2241218,7589,"HF",137,811)="This is a HF test comment."
^TMP("PXKENC",2241218,7589,"HF",137,812)="^170^19"
^TMP("PXKENC",2241218,7589,"HF",138,0)="550276^140^7589"
^TMP("PXKENC",2241218,7589,"HF",138,12)=3260108.165546
^TMP("PXKENC",2241218,7589,"HF",138,220)="30^533"
^TMP("PXKENC",2241218,7589,"HF",138,811)="This is a HF test comment."
^TMP("PXKENC",2241218,7589,"HF",138,812)="^170^19"
^TMP("PXKENC",2241218,7589,"PED",67,0)="39^140^7589^^^1"
^TMP("PXKENC",2241218,7589,"PED",67,12)="3240701.075^^^991"
^TMP("PXKENC",2241218,7589,"PED",67,812)="^170^19"
^TMP("PXKENC",2241218,7589,"POV",920,0)="503195^140^7589^827^^^^^^^^P"
^TMP("PXKENC",2241218,7589,"POV",920,12)="3260106.165547^^^991"
^TMP("PXKENC",2241218,7589,"POV",920,800,0,0)="0^1^0"
^TMP("PXKENC",2241218,7589,"POV",920,812)="^170^19"
^TMP("PXKENC",2241218,7589,"POV",920,900,1,0)="2^1"
^TMP("PXKENC",2241218,7589,"POV",920,900,2,0)="3^0"
^TMP("PXKENC",2241218,7589,"POV",920,900,3,0)="1^0"
^TMP("PXKENC",2241218,7589,"POV",921,0)="503268^140^7589^828^^^^^^^^S"
^TMP("PXKENC",2241218,7589,"POV",921,12)="3260106.165548^^^991"
^TMP("PXKENC",2241218,7589,"POV",921,800,0,0)="1^"
^TMP("PXKENC",2241218,7589,"POV",921,812)="^170^19"
^TMP("PXKENC",2241218,7589,"POV",921,900,1,0)="2^-1"
^TMP("PXKENC",2241218,7589,"POV",921,900,2,0)="1^1"
^TMP("PXKENC",2241218,7589,"POV",921,900,3,0)="13^1"
^TMP("PXKENC",2241218,7589,"PRV",3186,0)="520824698^140^7589^P^^144"
^TMP("PXKENC",2241218,7589,"PRV",3186,812)="^170^19"
^TMP("PXKENC",2241218,7589,"PRV",3187,0)="991^140^7589^S^^1"
^TMP("PXKENC",2241218,7589,"PRV",3187,812)="^170^19"
^TMP("PXKENC",2241218,7589,"VST",7589,0)="3260106.165546^3260107.165551^V^
^140^5 00^A^141^9^^^^3260107.16574^^^^^^^^15^240^991^46"
^TMP("PXKENC",2241218,7589,"VST",7589,150)="1DD2-ALN^0^P"
^TMP("PXKENC",2241218,7589,"VST",7589,800)="1^1^0^^^^^^^0^0^0^0"
^TMP("PXKENC",2241218,7589,"VST",7589,812)="^170^19"
^TMP("PXKENC",2241218,7589,"VST",7589,900,1,0)="1^1"
^TMP("PXKENC",2241218,7589,"VST",7589,900,2,0)="13^1"
^TMP("PXKENC",2241218,7589,"VST",7589,900,3,0)="2^1"
^TMP("PXKENC",2241218,7589,"VST",7589,900,4,0)="3^0"

The ^TMP("PXKENC",$J) global may be killed before and/or after the call.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
DSS - DECISION SUPPORT SYSTEM EXTRACTS Albany
AUTOMATED INFO COLLECTION SYS Albany
ORDER ENTRY/RESULTS REPORTING Salt Lake City
TEXT INTEGRATION UTILITIES Salt Lake City
LAB SERVICE Dallas
DENTAL
CARE MANAGEMENT
OUTPATIENT PHARMACY
INTEGRATED BILLING
CLINICAL CASE REGISTRIES
QUASAR
CLINICAL PROCEDURES
EMERGENCY DEPARTMENT
ADDED 10/10/2008
NATIONAL HEALTH INFO NETWORK
VIRTUAL PATIENT RECORD
Effective with VPR*1*0.
MYHEALTHEVET
Added 10/9/14.
BAR CODE EXPANSION
Added 10/10/14 as subscriber. Effective with new
project Bar Code Enhancement - Transfusion Verification, namespace MJCF.  The
new package  build is MJCF*1.0.KID.
VA POINT OF SERVICE (KIOSKS)
HEALTH MANAGEMENT PLATFORM
HMP's subscription to this ICR expired on 10/27/17 with
the shutdown of HMP.  HMP*2.0*12 released on 10/17/17 is an informational
patch outlining the steps for the sites to shut down the application.

If HMP is reactivated in the future, the HMP project team should review the
access provided by this ICR with the custodial application before reactivating
HMP's subscription to this ICR.
VISTA INTEGRATION ADAPTOR
Added 3/15/17
REGISTRATION
Added 2/2/21, effective with DG*5.3*1034
COMPREHENSIVE CARE COORDINATION
Added 12/5/22, effective with DSSV*1.1. Document only
Class 2, using $D before calling ENCEVENT.
DATE ACTIVATED 2016/09/19
GOOD ONLY FOR VERSION 1.0