PCE APIs FOR THE CLINICAL REMINDERS INDEX ICR (4250)

Name

Value

NUMBER

4250

IA #

4250

DATE CREATED

2004/09/15

CUSTODIAL PACKAGE

PCE PATIENT CARE ENCOUNTER

CUSTODIAL ISC

Albany

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXPXRM

NAME

PCE APIs FOR THE CLINICAL REMINDERS INDEX

GENERAL DESCRIPTION

This ICR will provide subscribing packages the ability
to get data from the PCE V-files

STATUS

Active

KEYWORDS

PCE
VCPT
VHF
VIMM
VPEDU
VPOV
VSKIN
VXAM
VICR
VSCDATA

DURATION

Till Otherwise Agreed

PXPXRM

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

VCPT(DA,.DATA)

This entry point is called as D
VCPT^PXPXRM(DA,.DATA). The  data from V CPT, file #9000010.18, is returned in
the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the Data in the V VCPT file,
#9000010.18

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("PROVIDER NARRATIVE")=Pointer to PROVIDER NARRATIVE file, #9999999.27
DATA("DIAGNOSIS")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 2")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 3")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 4")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 5")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 6")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 7")=Pointer to ICD DIAGNOSIS file, #80
DATA("DIAGNOSIS 8")=Pointer to ICD DIAGNOSIS file, #80
DATA("PRINCIPLE PROCEDURE")=Set of codes:
Y=Yes, N=No
DATA("QUANTITY")=An integer
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VHF(DA,.DATA)

This entry point is called as D VHF^PXPXRM(DA,.DATA).
The data from V HEALTH FACTORS, file #9000010.23, is returned in the DATA
array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the data in the V HEALTH
FACTORS file, #9000010.23

DATA

Output


DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("LEVEL/SEVERITY")=Set of codes:
M=Minimal, MO=Moderate, H=Heavy/Severe
DATA("VALUE")=Set of codes:
M=Minimal, MO=Moderate, H=Heavy/Severe
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("MEASUREMENT")=MAGNITUDE^UCUM code
MAGNITUDE is a number and UCUM code is a pointer to the UCUM CODES
file, #757.5
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VIMM(DA,.DATA)

This entry point is called as D
VIMM^PXPXRM(DA,.DATA). The data from V IMMUNIZATION, file #9000010.11, is
returned in the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V
IMMUNIZATION file, #9000010.11

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("SERIES")=Set of codes:
P=Partially Complete, C=Complete, B=Booster, a number 1-8=1-8
DATA("VALUE")=Set of codes:
P=Partially Complete, C=Complete, B=Booster, a number 1-8=1-8
DATA("REACTION")=Set of codes:
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
DATA("CONTRAINDICATED")=Set of codes: 1=Yes
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("EVENT DATE TIME")=Date and time in FileMan internal format
DATA("ORDERING PROVIDER")=IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("ENCOUNTER PROVIDER")=IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("DOSE")=Number (e.g., 0.5)
DATA("DOSE UNITS")=UCUM Code (e.g., mL)
DATA("DATE RECORDED")=Date and time in FileMan internal format
DATA("DOCUMENTER")= IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("LOT NUMBER")=IEN^Lot Number
IEN = Pointer to the IMMUNIZATION LOT file, #9999999.41
DATA("MANUFACTURER")=IEN^Name
IEN = Pointer to the IMM MANUFACTURER file, #9999999.04
DATA("EXPIRATION DATE")=Date in FileMan internal format
DATA("INFO SOURCE")=IEN^HL7 Code^Name
IEN = Pointer to the IMMUNIZATION INFO SOURCE file, #920.1
DATA("ADMIN ROUTE")=IEN^HL7 Code^Name
IEN = Pointer to the IMM ADMINISTRATION ROUTE file, #920.2
DATA("ADMIN SITE")=IEN^HL7 Code^Name
IEN = Pointer to the IMM ADMINISTRATION  SITE (BODY) file, #920.3
DATA("VIS OFFERED",n,0)=IEN^Date Offered^Name^Edition Date^Language
IEN = Pointer to the VACCINE INFORMATION STATEMENT file, #920
Date Offered=Date in FileMan internal format
Edition Date=Date in FileMan internal format
DATA("REMARKS",n,0)=Free text, word-processing
DATA("IMMUNIZATION")=IEN^Name
IEN = Pointer to the IMMUNIZATION file, #9999999.14
DATA("CVX")=CVX Code
DATA("VISIT DATE TIME")=Date and Time in FileMan internal format
DATA("FACILITY")=IEN^Name^Station #
IEN = Pointer to the INSTITUTION file, #4
DATA("LOCATION")=IEN^Name
IEN = Pointer to the HOSPITAL LOCATION file, #44
DATA("CODES",Coding System Name)=Code 1^Code 2^... Code x
DATA("VACCINE GROUP",n,0)=Free Text 2-30 characters in length
DATA("WARNING ACK")=Set of codes: 1=Yes
DATA("OVERRIDE REASON")=Free Text 3-245 characters in length
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=IEN^Name
IEN = Pointer to the PCE DATA SOURCE file, #839.7

VPEDU(DA,.DATA)

This entry point is called as D
VPEDU^PXPXRM(DA,.DATA). The data from V PATIENT ED, file #9000010.16, is
returned in the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V PATIENT
ED file, #9000010.16

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("LEVEL OF UNDERSTANDING")=Set of codes:
1=Poor, 2=Fair, 3=Good
4=Group-No Assessment, 5=Refused
DATA("VALUE")=Set of codes:
1=Poor, 2=Fair, 3=Good
4=Group-No Assessment, 5=Refused
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("MEASUREMENT")=MAGNITUDE^UCUM code
MAGNITUDE is a number and UCUM code is a pointer to the UCUM CODES
file, #757.5
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VPOV(DA,.DATA)

This entry point is called by D
VPOV^PXPXRM(DA,.DATA). The data from V POV, file #9000010.07, is returned in
the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V POV file,
#9000010.07

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("PROVIDER NARRATIVE")=Pointer to the Provider Narrative file,
#9999999.27
DATA("MODIFIER")=Set of codes:
C=Consider, D=Doubtful, F=Follow Up
M=Maybe,    O=Rule Out, P=Probable
R=Resolved, S=Suspect,  T=Status Post
DATA("PRIMARY/SECONDARY")=Set of codes:
P=Primary, S=Secondary
DATA("DATE OF INJURY")=Date and time in FileMan internal format
DATA("CLINICAL TERM")=Pointer to the Expressions file, #757.01
DATA("PROBLEM LIST ENTRY")=Pointer to the Problem file, #9000011
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VSKIN(DA,.DATA)

This entry point is called by D
VSKIN^PXPXRM(DA,.DATA). The data from V SKIN TEST, file #9000010.12, is
returned in the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V SKIN TEST
file #9000010.12

DATA

Output

The data array that is passed back to the calling
Package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("RESULTS")=Set of codes:
P=Positive, N=Negative, D=Doubtful, O=No Take
DATA("VALUE")=Set of codes:
P=Positive, N=Negative, D=Doubtful, O=No Take
DATA("DATE READ")=Date and time in FileMan internal format
DATA("READING")=Number (0-40)
DATA("SKIN TEST")=IEN^Name
IEN = Pointer to the SKIN TEST file, #9999999.28
DATA("VISIT DATE TIME")=Date and time in FileMan internal format
DATA("FACILITY")=IEN^Name^Station #
IEN = Pointer to the INSTITUTION file, #4
DATA("LOCATION")=IEN^Name
IEN = Pointer to the HOSPITAL LOCATION file, #44
DATA("READER")=IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("EVENT DATE TIME")=Date and time in FileMan internal format
DATA("ORDERING PROVIDER")=IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("ENCOUNTER PROVIDER")=IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("D/T PLACEMENT RECORDED")=Date and time in FileMan internal format
DATA("ANATOMIC LOC")=IEN^HL7 Code^Name
IEN = Pointer to the IMM ADMINISTRATION SITE (BODY) file, #920.3
DATA("HOURS READ")=Number
DATA("D/T READING RECORDED")=Date and time in FileMan internal format
DATA("READING COMMENTS")=Free text, 1 to 245 characters
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VXAM(DA,.DATA)

This entry point is called by D
VXAM^PXPXRM(DA,.DATA). The data from V EXAM, file #9000010.13, is returned in
the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V EXAM
file, #9000010.13

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("RESULT")=Set of Codes:
A=Abnormal, N=Normal
DATA("VALUE")=Set of Codes:
A=Abnormal, N=Normal
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("MEASUREMENT")=MAGNITUDE^UCUM code
MAGNITUDE is a number and UCUM code is a pointer to the UCUM CODES
file, #757.5
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VICR(DA,.DATA)

This entry point is called by D
VICR^PXPXRM(DA,.DATA). The data from V IMM CONTRA/REFUSAL EVENTS, file
#9000010.707, is returned in the DATA array.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V IMM
CONTRA/REFUSAL EVENTS file #9000010.707

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("CONTRA/REFUSAL")=Variable Pointer*^Name
Variable Pointer to the IMM CONTRAINDICATION REASONS file, #920.4 or
IMM REFUSAL REASONS file, #920.5
DATA("IMMUN")= IEN^Name
IEN = Pointer to the IMMUNIZATION file, #9999999.14
DATA("WARN UNTIL DATE")=Date in FileMan internal format
DATA("D/T RECORDED")=Date and time in FileMan internal format
DATA("EVENT D/T")=Date and time in FileMan internal format
DATA("ENC PROVIDER")= IEN^Name
IEN = Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free Text, 1 to 245 characters
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

VSCDATA(DA,.DATA)

This entry point is called as D
VSCDATA^PXPXRM(DA,.DATA). The data from the V STANDARD CODES, file
#9000010.71, is returned in the DATA array.  Note: This entry point is added
with patch PX*1*211.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Input

Internal entry number of the entry in the V STANDARD
CODES file, #9000010.71

DATA

Output

The data array that is passed back to the calling
package.

DATA("VISIT")=Pointer to the VISIT file, #9000010
DATA("PROVIDER NARRATIVE")=Pointer to the Provider Narrative file,
#99999999.27.
DATA("EVENT DATE AND TIME")=Date and time in FileMan internal format
DATA("ENCOUNTER PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("ORDERING PROVIDER")=Pointer to the NEW PERSON file, #200
DATA("COMMENTS")=Free text, 1 to 245 characters
DATA("MEASUREMENT")=MAGNITUDE^UCUM code MAGNITUDE is a number and UCUM
code is a pointer to the UCUM CODES file, #757.5
DATA("PACKAGE")=Pointer to the PACKAGE file, #9.4
DATA("DATA SOURCE")=Pointer to the PCE DATA SOURCE file, #839.7

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	ISC	SUBSCRIBING DETAILS
CLINICAL REMINDERS	Salt Lake City	Clinical Reminders will use these calls to retrieve information from a V-file after looking up the reference in the Clinical Reminders Index.
ORDER ENTRY/RESULTS REPORTING
VIRTUAL PATIENT RECORD		Effective with VPR10.
HEALTH MANAGEMENT PLATFORM		HMP's subscription to this ICR expired on 10/27/17 with the shutdown of HMP. HMP2.012 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.
COMPREHENSIVE CARE COORDINATION		ADDED 8/2/2022, effective with DSSV*1.1 DSS Class 3 product Document Only

DATE ACTIVATED

2024/03/14