Print Page as PDF
ICD Data Extraction ICR (5747)

ICD Data Extraction    ICR (5747)

Name Value
NUMBER 5747
IA # 5747
DATE CREATED 2011/11/06
CUSTODIAL PACKAGE DRG GROUPER
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ICDEX
NAME ICD Data Extraction
GENERAL DESCRIPTION
Application Programmer Interfaces (APIs) in this
routine were developed to remove the need for direct global access to either
the DIAGNOSIS file 80 or OPERATIONS/PROCEDURE file 80.1.

These entry points are meant to replace the following active/retired ICRs:

48  Private       YS File 80.2        Weight (2)
280  Private       HBH File 80         Code (.01)
365  Private       QAM File 80         Code (.01)
368  Private       IB File 80          Retired Nov 15, 2008
369  Private       IB File 80.1        Retired Nov 15, 2008
370  Private       IB/DSS 80.2         DRG Name (.01)
582  Private       IMR File 80         Code (.01)
647  Private       IB File 80          Retired Nov 15, 2008
1161  Private       VAM File 80         Retired Nov 15, 2008
1275  Private       GMTS File 80        Retired Nov 15, 2008
1276  Private       GMTS File 80.1      Retired Nov 15, 2008
1294  Subscription  PCE/TIU/OR File 80  Retired Nov 15, 2008
1487  Private       ACKQ File 80        Retired Nov 15, 2008
1586  Subscription  AICS/PCE File 80.3  MDC Name (.01)
2435  Private       PXRM File 80 Hdr    ^ICD9(0)
2436  Private       PXRM File 80.1 Hdr  ^ICD0(0)
3990  Supported     Routine ICDCODE     To be retired Apr 2016
3991  Supported     Routine ICDAPIU     To be retired Apr 2016
4052  Supported     Routine ICDGTDRG
5028  Subscription  GMPL File 80
5388  Supported     File 80             Code (.01), AB/BA/D/AST/ACT
To be retired Apr 2016
5404  Supported     File 80.1           Code (.01), BA/ACT
To be retired Apr 2016
5699  Supported     Routine ICDXCODE    To be retired Apr 2016
5757  Supported     Routine ICDSAPI     To be retired Apr 2016
10082  Supported     File 80             Retired Nov 15, 2008
10083  Supported     File 80.1           Retired Nov 15, 2008


STATUS Active
KEYWORDS
  • ICDEX
  • ICD-10
  • ICD10
  • 3990
  • ICDCODE
  • 3991
  • ICDAPIU
  • 280
  • 365
  • 582
  • 5388
  • 5404
DURATION Till Otherwise Agreed
ID ICDEX
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
HELP
This is an interactive help entry point for the input
and output variables for the APIs contained in the routine ICDEX.

$$ICDDX(CODE,CDT,SYS,FMT,LOC)
This entry point extracts data for an ICD-9 or ICD-10
code in the DIAGNOSIS file 80.

This entry point is intended to replace the ICD-9 Legacy API $$ICDDX^ICDCODE
(ICR 3990) and $$ICDDATA^ICDXCODE (ICR 5699), providing a single point of
entry for ICD diagnostic data.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD diagnosis code in either the external
or internal format.  If the internal format is used, then the input variable
FMT must be set to "I" (Required).


CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the code and text that was appropriate for the date passed in
this input parameter. (Optional, if not supplied, TODAY will be used)

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  The following coding systems are found in file 80:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis

(Optional, but highly encouraged)

FMT Input
This variable tells the API if the CODE is in
External or Internal format.

"E" = External (default)
"I" = Internal Entry Number

(Conditional, required if CODE is in internal format)

$$ICDDX Output
This is a 20 piece string delimited by "^"

1  IEN of code in ^ICD9(
2  ICD Dx Code                  (#.01)
3  Identifier                   (#1.2)
4  Versioned Dx                 (67 multiple)
5  Unacceptable as Principal Dx (#1.3)
6  Major Dx Cat                 (72 multiple)
7  MDC13                        (#1.4)
8  Compl/Comorb                 (103 multiple)
9  ICD Expanded                 (#1.7)
10  Status                       (66 multiple)
11  Sex                          (10 multiple)
12  Inactive Date                (66 multiple)
13  MDC24                        (#1.5)
14  MDC25                        (#1.6)
15  Age Low                      (11 multiple)
16  Age High                     (12 multiple)
17  Activation Date              (66 multiple)
18  Message
19  Complication/Comorbidity     (103 multiple)
20  Coding System                (#1.1)
21  Primary CC Flag              (103 multiple)
22  PDX Exclusion Code           (#1.11)
or

-1^Error Description

LOC Input
This is a boolean flag used to indicate if the API is
to use local VA codes.  It only applies to ICD-9 for backwards compatibility.

1 = Use local VA codes
0 = Do not use local VA codes (default)

$$ICDOP(CODE,CDT,SYS,FMT,LOC)
This entry point extracts data for an ICD-9 or ICD-10
code in the OPERATIONS/PROCEDURE file 80.1

This entry point is intended to replace the ICD-9 Legacy API $$ICDOP^ICDCODE
(ICR 3990) and $$ICDDATA^ICDXCODE (ICR 5699), providing a single point of
entry for ICD procedural data.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD operation/procedure code in either the
external or internal format.  If the internal format is used, then the input
variable FMT must be set to "I" (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the code and text that was appropriate for the date passed in
CDT.  (Optional, if not supplied, TODAY will be used)

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  The following coding systems are found in file 80.1:

2 = ICD-9 Procedures
31 = ICD-10 Procedures

(Optional, but highly encouraged)

FMT Input
This variable tells the API if the CODE is in
External or Internal format.

"E" = External (default)
"I" = Internal Entry Number

(Conditional, required if CODE is in internal format)

$$ICDOP Output
This is a 15 piece string delimited by "^"

1   IEN of code in ^ICD0(
2   ICD procedure code           (#.01)
3   Identifier                   (#1.2)
4   MDC24                        (#1.5)
5   Versioned Oper/Proc          (67 multiple)
6   <null>
7   <null>
8   <null>
9   ICD Expanded                 (#1.7)
10   Status                       (66 multiple)
11   Use with Sex                 (10 multiple)
12   Inactive Date                (66 multiple)
13   Activation Date              (66 multiple)
14   Message
15   Coding System                (#1.1)

or

-1^Error Description

LOC Input
This is a boolean flag used to indicate if the API is
to use local VA codes.  It only applies to ICD-9 for backwards compatibility.

1 = Use local VA codes
0 = Do not use local VA codes (default)

$$ICDD(CODE,.ARY,CDT,SYS,LEN)
This API returns the long description of either an
ICD-9 or ICD-10 code.

This entry point is intended to replace the ICD-9 Legacy API $$ICDD^ICDCODE
(ICR 3990) and $$ICDDESC^ICDXCODE (ICR 5699), providing a single point of
entry for ICD diagnosis/procedure descriptions.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD-9 or ICD-10 code in external format
only  (Required).

.ARY Input
This is the name of a local array, passed by
reference that will contain the output of this API.  (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the text that was appropriate for the date passed in this
input parameter. (Optional, if not supplied, TODAY will be used)

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  The following coding systems are found in files 80 and 80.1:

1 = ICD-9 Diagnosis file 80
2 = ICD-9 Procedure file 80.1
30 = ICD-10 Diagnosis file 80
31 = ICD-10 Procedure file 80.1

(Optional, but highly encouraged)

LEN Input
This is the text string length of the description
placed in array .ARY.  (Optional, if passed it must be greater than 27 based
on the longest word found in a diagnosis or procedure description and not
greater than 245.  If not passed it defaults to 245 characters based in the
input transformation)

$$ICDD Output
This is the number of lines in the output array .ARY
or if an error occurs, -1^Error Message

ARY Output
This is a local array, passed by reference,
containing the long description of an ICD code with string lengths defined by
LEN when passed or 245 characters.  If there is a warning message about text
accuracy (ICD-9 only) it will be appended to the end of the message preceded
by a blank line.

ARY(1) - Description (length of LEN)
ARY(n) - Description (continued if necessary)

If there is a warning message (ICD-9 only):

ARY(n+1) - blank
ARY(n+2) - message: CODE TEXT MAY BE INACCURATE

$$CODEN(CODE,FILE)
This API returns the Internal Entry Number (IEN) of a
ICD code.

This entry point is intended to replace the ICD-9 Legacy API $$CODEN^ICDCODE
(ICR 3990). It is also intended to replace the need for direct global access
of the 'BA' cross-reference in ICRs 5388 and 5404.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD-9 or ICD-10 code in external format
only  (Required).

FILE Input
This is the file number where the CODE is stored,
either 80 or 80.1 (Required)

$$CODEN Output
This is the Internal Entry Number (IEN) of CODE in
file FILE appended by a tilde "~" and the global root FILE:

IEN~^ROOT

or -1^Error Message on error

$$CODEC(FILE,IEN)
This entry point returns the ICD-9 or ICD-10 code
from a specified ICD file and Internal Entry Number (IEN).

This entry point is intended to replace the ICD-9 Legacy API $$CODEC^ICDCODE
(ICR 3990).  It is also intended to replace the need for direct global access
in ICRs 280, 365, 582, 5388, and 5404.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the code
(Required)

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is the internal entry number in FILE were the
code to be retrieved is stored (Required)

$$CODEC Output
This is either the ICD code stored at the Internal
Entry Number IEN in the file identified by the FILE input parameter, or upon
error:

-1 ^ Error Message

$$CODEBA(CODE,ROOT)
This entry point returns the internal entry number
(IEN) of a code found in the 'BA' cross-reference in the file specified.

This entry point is provided in lieu of ICD-9 Legacy entry point
$$CODEN^ICDCODE (ICR 3990) which will crash with a <MAXNUMBER> error if the
code passed has the letter 'E' in the middle of the code (example, ICD-10
procedure code 041E499 would be interpreted as scientific notation).
$$CODEBA^ICDEX is much safer.

If you already know the coding system, please use $$CODEABA^ICDEX instead.

This entry point replaces the need for direct global read access of the 'BA'
cross-reference allowed by ICRs 5388 and 5404.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD Diagnosis code or ICD Procedure
code (Required)

ROOT Input
This is the global root (or file number) where the
code is stored (Required)

$$CODEBA Output
This is the internal entry number (IEN) in the
specified file where the code is stored or -1 if not found.

$$CODEABA(CODE,ROOT,SYS)
This entry point returns the internal entry number
(IEN) of a code found in the system specific 'ABA' cross-reference in the file
specified.

This entry point is provided in lieu of ICD-9 Legacy entry point
$$CODEN^ICDCODE (ICR 3990) and new entry point $$CODEBA^ICDEX.

Entry point Comparison:

$$CODEN^ICDCODE will crash if the code
has the letter 'E' in the middle of the
code.  Do not use it.

$$CODEBA^ICDEX is safer but it will fail to
return the correct IEN if ICD-9 and ICD-10
ever have a similar code.

$$CODEABA^ICDEX will neither crash or fail
to return the correct IEN.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD Diagnosis code or ICD Procedure
code (Required)

ROOT Input
This is the global root (or file number) where the
code is stored (Optional if SYS is supplied)

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  The following coding systems are found in files 80 and 80.1:

1 = ICD-9 Diagnosis file 80
2 = ICD-9 Procedure file 80.1
30 = ICD-10 Diagnosis file 80
31 = ICD-10 Procedure file 80.1

This API will look for the code on one of the system specific
cross-references:

^ICD9("ABA",1,CODE,IEN)    ICD-9 Diagnosis
^ICD9("ABA",30,CODE,IEN)   ICD-10 Diagnosis
^ICD0("ABA",2,CODE,IEN)    ICD-9 Procedure
^ICD0("ABA",31,CODE,IEN)   ICD-10 Procedure

If not supplied, the API will attempt to determine the system based on code
and file.

(Optional, but highly encouraged)

$$CODEABA Output
This is the internal entry number (IEN) in the
specified file where the code is stored or -1 if not found.

$$CODEFI(CODE)
This entry point tries to resolve which file has an
ICD code on file.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD Diagnosis code or ICD Procedure
code (Required)

$$CODEFI Output
This is the ICD file number where the specified code
was found:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

or NULL if not found or could not resolve to a single file.

$$CODECS(CODE,FILE,CDT)
This entry point tries to resolve the Coding System
based on a code, a file and a date.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD Diagnosis code or ICD Procedure
code (Required)

FILE Input
This is the ICD file number used to resolve the
coding system:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

(Optional, but encouraged)  If not supplied, an attempt to resolve the input
variable FILE will be made using the entry point $$CODEFI(CODE).

CDT Input
This is the Code Set Versioning date (Fileman format)
used to resolve the coding system.

This date is ONLY used if a code is found in both ICD-9 and ICD-10 systems.
If that ever happens, the date passed will determine the coding system. If the
date passed is before the ICD-10 implementation date it will be considered an
ICD-9 code and if it is on or after the ICD-10 implementation date then it
will be considered ICD-10.

$$CODECS Output
This is a 2 piece "^" delimited string containing:

1   Coding System (pointer to file 80.4)
2   Coding Nomenclature (commonly used name)

Example output values:

1^ICD-9-CM
30^ICD-10-CM
2^ICD-9 Proc
31^ICD-10-PCS

NULL if the API cannot resolve the coding system based on code, file and date.

$$CSI(FILE,IEN)
This entry point returns the Coding System for an
Internal Entry Number (IEN).

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
coding system (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required).

$$CSI Output
This is a pointer to the ICD CODING SYSTEMS file
#80.4

$$VMDC(IEN,CDT,FMT)
This entry point retrieves the versioned Major
Diagnostic Category (MDC) for a diagnostic code in the DIAGNOSIS file 80.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the Major Diagnostic Category that was appropriate for the
date passed (Optional, if not passed TODAY is used).

FMT Input
This is a flag used to determine the output format.
Acceptable values are 0 and 1 (Optional, default value is 0).

FMT = 0    Major Diagnostic Category (MDC)
FMT = 1    MDC^Effective Date

$$VMDC Output
This is the Major Diagnostic Category (MDC) that was
appropriate for the date passed and the diagnosis code identified by input
parameter IEN.  The output may also have a second "^" delimited piece
containing the MDC Effective Date if the input parameter FMT is set to 1.

$$VAGEL(IEN,CDT,FMT)
This entry point retrieves the versioned Age Low
value for a diagnostic code in the DIAGNOSIS file 80.  Age Low is the minimum
age value for an age range for which the diagnostic code can be applied.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the Age Low value that was appropriate for the date passed
(Optional, if not passed TODAY is used).

FMT Input
This is a flag used to determine the output format.
Acceptable values are 0 and 1 (Optional, default value is 0).

FMT = 0    Age Low
FMT = 1    Age Low^Effective Date

$$VAGEL Output
This is the Age Low that was appropriate for the date
passed and the diagnosis code identified by the input parameter IEN.  The
output may also have a second "^" delimited piece containing the Age Low
Effective Date if the input parameter FMT is set to 1.  Null if Age Low not
found for date.

$$VAGEH(IEN,CDT,FMT)
This entry point retrieves the versioned Age High
value for a diagnostic code in the DIAGNOSIS file 80.  Age High is the maximum
age value for an age range for which the diagnostic code can be applied.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the Age High value that was appropriate for the date passed
(Optional, if not passed TODAY is used).

FMT Input
This is a flag used to determine the output format.
Acceptable values are 0 and 1 (Optional, default value is 0).

FMT = 0    Age High
FMT = 1    Age High^Effective Date

$$VAGEH Output
This is the Age High that was appropriate for the
date passed and the diagnosis code identified by the input parameter IEN.  The
output may also have a second "^" delimited piece containing the Age High
Effective Date if the input parameter FMT is set to 1.  Null if Age High is
not found for date.

$$VCC(IEN,CDT,FMT)
This entry point retrieves the versioned Complication
Comorbidity (CC) designation for a diagnostic code in the DIAGNOSIS file 80.
A diagnostic code can be designated as:

Non-Complication Comorbidity (Non-CC)
Complication Comorbidity (CC)
Major Complication Comorbidity (MCC)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the CC designation value that was appropriate for the date
passed (Optional, if not passed TODAY is used).

FMT Input
This is a flag used to determine the output format.
Acceptable values are 0 and 1 (Optional, default value is 0).

FMT = 0    CC designation
FMT = 1    CC designation^Effective Date

$$VCC Output
This is the CC designation that was appropriate for
the date passed and the diagnosis code identified by the input parameter IEN.
The output may also have a second "^" delimited piece containing the CC
designation Effective Date if the input parameter FMT is set to 1.

0 = Non-Complication Comorbidity (Non-CC)
1 = Complication Comorbidity (CC)
2 = Major Complication Comorbidity (MCC)

Null if not found for date

$$VSEX(FILE,IEN,CDT,FMT)
This entry point retrieves the versioned sex
designation for a diagnostic or procedure code in either the ICD DIAGNOSIS
file 80 or the ICD OPERATION/PROCEDURE file 80.1. If a sex designation exist
then the diagnosis or procedure should be applied only to that sex.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the sex
designation:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in either the
DIAGNOSIS file 80 or OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the sex designation value that was appropriate for the date
passed (Optional, if not passed TODAY is used).

FMT Input
This is a flag used to determine the output format.
Acceptable values are 0 and 1 (Optional, default value is 0).

FMT = 0    Sex designation
FMT = 1    Sex designation^Effective Date

$$VSEX Output
This is the sex designation that was appropriate for
the date passed and the code identified by the input parameter IEN.  The
output may also have a second "^" delimited piece containing the sex
designation Effective Date if the input parameter FMT is set to 1.

M = Male
F = Female
Null if sex is N/A or not found for date

$$SAI(FILE,IEN,CDT)
This entry point retrieves the Status, Activation
date and Inactivation date for a diagnosis or procedure on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
status and effective dates:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in either the
DIAGNOSIS file 80 or OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the status and effective dates that were appropriate for the
date passed (Optional, if not passed TODAY is used).

$$SAI Output
This is a 6 piece "^" delimited string

1  Status
2  Activation Date
3  Inactivation Date
4  IEN
5  Code
6  Short Text

If the status is active, the short
text will be the most recent.

If the status is inactive, the short
text will be the text in use on the
date it was inactivated.

Null if no status for date.

$$VST(FILE,IEN,CDT)
This entry point retrieves the Versioned Short Text
for an diagnosis or procedure on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
Versioned Short Text:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in either the
DIAGNOSIS file 80 or OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Short Text that was appropriate for the date
passed (Optional, if not passed TODAY is used).

$$VST Output
This is the Versioned Short Text from either file 80
(DIAGNOSIS) or 80.1 (OPERATION/PROCEDURE) that was appropriate for the date
passed and the code identified by the input parameter IEN.  Null if not found.

$$VLT(FILE,IEN,CDT)
This entry point retrieves the Versioned Long Text
(description) for a diagnosis or procedure on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
Versioned Long Text (description):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in either the
DIAGNOSIS file 80 or OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Long Text (description) that was appropriate
for the date passed (Optional, if not passed TODAY is used).

$$VLT Output
This is the Versioned Long Text (description) from
either file 80 or 80.1 that was appropriate for the date passed and the code
identified by the input parameter IEN.  Null if not found.

$$VSTD(IEN,CDT)
This entry point retrieves the Versioned Short Text
for a diagnosis on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Short Text that was appropriate for the date
passed (Optional, if not passed TODAY is used).

$$VSTD Output
This is the Versioned Short Text from file 80 that
was appropriate for the date passed and the code identified by the input
parameter IEN.  Null if not found.

$$VSTP(IEN,CDT)
This entry point retrieves the Versioned Short Text
for a procedure on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Short Text that was appropriate for the date
passed (Optional, if not passed TODAY is used).

$$VSTP Output
This is the Versioned Short Text from file 80.1 that
was appropriate for the date passed and the code identified by the input
parameter IEN.  Null if not found.

$$VLTD(IEN,CDT)
This entry point retrieves the Versioned Long Text
(description) for a diagnosis on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Long Text (description) that was appropriate
for the date passed (Optional,  If not passed TODAY is used).

$$VLTD Output
This is the Versioned Long Text (description) from
file 80 that was appropriate for the date passed and the code identified by
the input parameter IEN.  Null if not found.

$$VLTP(IEN,CDT)
This entry point retrieves the Versioned Long Text
(description) for a procedure on a specified date.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATION/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Long Text (description) that was appropriate
for the date passed (Optional,  If not passed TODAY is used).

$$VLTP Output
This is the Versioned Long Text (description) from
file 80.1 that was appropriate for the date passed and the code identified by
the input parameter IEN.  Null if not found.

$$SD(FILE,IEN,CDT,.ARY,LEN)
This entry point retrieves the Versioned Short Text
for a procedure on a specified date.  This entry point is similar to $$VST
except you can elect to have the Short Text returned in a local array and you
can specify the string lengths of the text in the array.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
Versioned Short Text (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an internal entry number (IEN) in either file
80 or 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Short Text that was appropriate for the date
passed (Optional,  If not passed TODAY is used).

.ARY Input
This is a local array name passed by reference that
will contain the Short Text output.

LEN Input
This is a number greater than 27 and less than 246
representing the desired text string lengths for the Short Text output.  If
specified, the output will be parsed into strings not to exceed the length
specified (Optional, default 245)

$$SD Output
This is the Versioned Short Text from either file 80
or 80.1 that was appropriate for the date passed and the code identified by
the input parameter IEN.  If not found:

-1^Error Message

ARY Output
If passed, this is a local array containing the
number of text lines, the effective date of the Short Text and the text.  If
the input parameter LEN (length) is specified and the length is shorter than
the Short Text, then the Short Text will be parsed into test strings not to
exceed LEN.

ARY(0)=# lines ^ effective date
ARY(1)=Short Text

LEN is defined shorter than text

ARY(0)=# lines ^ effective date
ARY(1)=String length not to exceed LEN
ARY(n)=String length not to exceed LEN

Null if not found

$$LD(FILE,IEN,CDT,.ARY,LEN)
This entry point retrieves the Versioned Long Text
(description) for a procedure on a specified date.  This entry point is
similar to $$VLT except you can elect to have the Long Text (description)
returned in a local array and you can specify the string lengths of the text
in the array.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
Versioned Long Text (description) (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an internal entry number (IEN) in either file
80 or 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the Versioned Long Text (description) that was appropriate
for the date passed (Optional,  If not passed TODAY is used).

.ARY Input
This is a local array name passed by reference that
will contain the Long Text (description) output.

LEN Input
This is a number greater than 27 and less than 246
representing the desired text string lengths for the Long Text (description)
output.  If specified, the output will be parsed into strings not to exceed
the length specified (Optional, default 245)

$$LD Output
This is the Versioned Long Text (description) from
either file 80 or 80.1 that was appropriate for the date passed and the code
identified by the input parameter IEN.  If not found:

-1^Error Message

ARY Output
If passed, this is a local array containing the
number of text lines, the effective date of the Long Text (description) and
the text.  If the input parameter LEN (length) is specified and the length is
shorter than the Long Text (description), then the Long Text (description)
will be parsed into test strings not to exceed LEN.

ARY(0)=# lines ^ effective date
ARY(1)=Long Text (description)

LEN defined shorter than text

ARY(0)=# lines ^ effective date
ARY(1)=String length not to exceed LEN
ARY(n)=String length not to exceed LEN

PAR(.ARY,LEN)
This entry point takes text in a local array (passed
by reference) and parses it into string lengths not to exceed the length
specified.

VARIABLES TYPE VARIABLES DESCRIPTION
.ARY Input
This is a local array name passed by reference and
contains the text to be parsed into strings not to exceed the length
specified.

ARY(1) = Unparsed Text

LEN Input
This is a number representing the desired text string
lengths for the text found in ARY().  (Optional, default length 79)

ARY Output
This is a local array containing the input text
parsed so that each text string length does not exceed the length specified.

ARY(1)=Parsed Text length not to exceed LEN
ARY(n)=Parsed Text length not to exceed LEN

$$STATCHK(CODE,CDT,SYS)
This entry point is used to determine the status
(active or inactive) of a ICD code.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis or procedure code
(external format) (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to retrieve the code's status, internal entry number (IEN) and effective
date that was appropriate for the date passed (Optional,  If not passed TODAY
is used)

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  The following coding systems are found in files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

(Optional, but encouraged, if doesn't exist it will try to determine coding
system by input parameter CODE)

$$STATCHK Output
This is a three piece "^" delimited string

1  Status 1 = Active, 0 = Inactive
2  IEN or -1 on error
3  Effective Date or error message

Error           0 ^ -1 ^ Error message
Active Code     1 ^ IEN ^ Effective Date
Inactive Code   0 ^ IEN ^ Effective Date

$$DTBR(CDT,STD,SYS)
This entry point returns the business rule date for a
coding system.  This is in earliest date possible for a coding standard and/or
a coding system.

VARIABLES TYPE VARIABLES DESCRIPTION
CDT Input
This is the Code Set Versioning date (Fileman format)
used to resolved the business rule date.  (Optional, if not passed TODAY is
used)

STD Input
This is a coding standard from a Standards
Development Organization (SDO).  A standard may have one or more coding
systems.  (Optional, default is 0)

0 = ICD (Default)
1 = CPT/HCPCS
2 = DRG

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional, there is no default value for this parameter, if it
does not exist then it is not used)

The following coding systems are found in files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

$$DTBR Output
Date adjusted by business rules:

If Standard (SDT) = 0 (ICD)

If CDT < 2781001 use 2781001
If CDT < 3131001 and SYS=30, use 3131001
If CDT < 3131001 and SYS=31, use 3131001

If Standard (SDT) = 1 (CPT/HCPCS)

If CDT < 2890101 use 2890101

If Standard (SDT) = 2 (DRG)

If CDT < 2821001 use 2821001

If CDT is year only, use first of the year If CDT is year and month only, use
first of the month

$$IMP(SYS,CDT)
This entry point returns the date a coding system was
implemented (taken from file 80.4).

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This is a coding system (taken from file 80.4) or a
coding system identifier that can be resolved to a coding system.

1 = ICD-9-CM
2 = ICD-9-PCS
30 = ICD-10-CM
31 = ICD-10-PCS

DX, DIAG, 80, ^ICD9(

1 = ICD-9-CM if CDT is before the ICD-10 implementation date
30 = ICD-10-CM if CDT is on or after the ICD-10 implementation date

PR, PROC, OPER, 80.1, ^ICD0(

2 = ICD-9-CM if CDT is before  the ICD-10 implementation date
31 = ICD-10-CM if CDT is on or after  the ICD-10 implementation date

CDT Input
This is the Code Set Versioning date (Fileman format)
used to resolve the coding system parameter SYS (Optional, if not passed TODAY
is used)

$$IMP Output
This is the date that a coding system identified by
the input parameters SYS and CDT was implemented in Fileman format or on
error:

-1 ^ Error message

$$MSG(CDT,STD,SYS)
This entry point returns a warning message that the
text may be inaccurate for the date specified.  It applies only to ICD-9
Diagnosis and Procedures.

VARIABLES TYPE VARIABLES DESCRIPTION
CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the accuracy of the text being returned (Optional, if not
passed TODAY is used)

STD Input
This is a coding standard from a Standards
Development Organization (SDO).  A standard may have one or more coding
systems.  (Optional, default is 0)

0 = ICD (Default)
1 = CPT/HCPCS
2 = DRG

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional, there is no default value for this parameter, if it
does not exist then it is not used)

The following coding systems are found in files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

$$MSG Output
If coding system is not ICD-10 and the date passed is
before the Code Set Versioning project Oct 1, 2002, then this variable is set
to the warning message, "CODE TEXT MAY BE INACCURATE" otherwise it is null.

$$SEL(FILE,IEN)
This entry point determines if an entry in a file is
selectable by calling applications.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified.

$$SEL Output
This is a Boolean value:

1  Entry IEN in file FILE is Selectable
0  Entry IEN in file FILE is NOT Selectable

or

-1  on error

$$NEXT(CODE,SYS,CDT)
This entry point returns the Next code in a sequence
of codes in a coding system.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis, an ICD procedure
code or null to retrieve the first code in a sequence.

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the next code being returned (Optional, there is no default
value for this parameter)

If CDT date is not passed then this entry point will return the next code,
regardless of status (active or inactive)

If CDT date is passed then this entry point will return the next active code.

$$NEXT Output
This is the next code in a sequence of codes.  If the
input code is null, then it will return the first code of the sequence of
codes.  If a date is passed in the input parameter CDT, then it will return
the next active code in a sequence of codes.

$$PREV(CODE,SYS,CDT)
This entry point returns the Previous code in a
sequence of codes in a coding system.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis, an ICD procedure
code or null to retrieve the last code in a sequence.

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the Previous code being returned (Optional, there is no
default value for this parameter)

If CDT date is not passed then this entry point will return the previous code,
regardless of status  (active or inactive)

If CDT date is passed then this entry point will return the previous active
code.

$$PREV Output
This is the previous code in a sequence of codes.  If
the input code is null, then it will return the last code of the sequence of
codes.  If a date is passed in the input parameter CDT, then it will return
the previous active code in a sequence of codes.

$$HIST(CODE,.ARY,SYS)
This entry point returns a code's activation history.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD diagnosis or procedure code.

.ARY Input
This is a local array name passed by reference that
will contain the code's activation history.

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

$$HIST Output
This is set equal to the number of history entries in
the local array ARY or -1 if there is an error or the code is not found.

ARY Output
This is a local array containing the history records

ARY(0) = Number of History Entries
ARY(<effective date>,<status>) = comment

$$PERIOD(CODE,.ARY,SYS)
This entry point returns all the activation periods
for a code.  An activation period is defined as the period of time between the
beginning activation effective date and the ending inactivation effective
date.  If the code is still active the period will have an activation date
without an inactivation date.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis or procedure code.

.ARY Input
This is a local array name passed by reference that
will contain the code's activation periods.

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

$$PERIOD Output
This is a 2 piece "^" delimited string if successful
and 3 piece "^" delimited string if unsuccessful or error.

1   IEN of code
2   Code is selectable (boolean 1/0)

or on error

-1 ^ 0 ^ Error Message

ARY Output
This is a local array containing the Periods of
activation for the code

ARY(0)

This is a 2 piece "^" delimited string if
successful and a 3 piece "^" delimited string
if unsuccessful or error.

1   IEN of code
2   Code is selectable (boolean 1/0)

or on error

-1^0^Error Message

ARY(Activation Date) = Inactivation Date^Short Name

Where the Short Name is the Versioned text, and the
text is versioned as follows:

Period is active   - Text for TODAY's date
Period is inactive - Text for inactivation date

$$OBA(FILE,CODE,SYS,REV)
This entry point is used to $ORDER through the BA or
ABA cross-references and replaces the need to access the BA/ABA
cross-references in a FOR loop.  This entry point is meant to replace BA
cross-reference in ICRs 5388 and 5404.

$$OBA(<file>,<code>,<system>) replaces:

$O(^ICD9("BA",(<code>_" ")) and
$O(^ICD0("BA",(<code>_" "))

Examples:

F  S CODE=$$OBA(80,CODE,1) Q:'$L(CODE)  D
F  S CODE=$$OBA(80,CODE,30) Q:'$L(CODE)  D
F  S CODE=$$OBA(80.1,CODE,2) Q:'$L(CODE)  D
F  S CODE=$$OBA(80.1,CODE,31) Q:'$L(CODE)  D

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to determine the
global root to $ORDER through (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

CODE Input
This is either an ICD diagnosis or procedure code to
$ORDER from (required):

$O(^ROOT("BA",(CODE_" ")))
$O(^ROOT("ABA",SYS,(CODE_" ")))

SYS Input
This is either an ICD diagnosis or procedure

This is an ICD coding system identifier (taken from file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

If the coding system can be identified then the "BA" cross-reference is
ignored and the $ORDER will be performed on the "ABA" cross-reference:

$O(^ROOT("ABA",SYS,(CODE_" ")))

The "ABA" cross-reference is a coding system specific cross-reference.

REV Used
This is a Reverse $ORDER flag, if set to 1, the
$ORDER operation will be in the reverse direction of "BA" or "ABA"
cross-reference (Optional, default is 0, $ORDER forward)

If equal to 1

$O(^ROOT("BA",(CODE_" ")),-1)
$O(^ROOT("ABA",SYS,(CODE_" ")),-1)

$$OBA Output
This is the Next or Previous Code in the "BA" or
"ABA" cross-reference depending on the $ORDER direction established by the
input parameter REV.

$$OD(FILE,WORD,SYS,REV)
This entry point is used to $ORDER through the "D" or
"AD" cross-reference and replaces the need to access the D/AD cross-references
in a FOR loop.  This entry point is meant to replace the D cross-reference in
ICRs 5388 and 5404.

$$OD(<file>,<word>,<system>) replaces:

$O(^ICD9("D",(<word>_" ")) and
$O(^ICD0("D",(<word>_" "))

Examples:

F  S WORD=$$OD(80,WORD,1) Q:'$L(WORD)  D
F  S WORD=$$OD(80,WORD,30) Q:'$L(WORD)  D
F  S WORD=$$OD(80.1,WORD,2) Q:'$L(WORD)  D
F  S WORD=$$OD(80.1,WORD,31) Q:'$L(WORD)  D

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to determine the
global root to $ORDER through (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

WORD Input
This is a one or two piece "^" delimited string

1  WORD  This is a single word parsed from the
codes description.

2  IEN   This is the internal entry number where
the description can be found that
contains the parsed word

WORD and IEN can be null.

$$OD $ORDER through "WORD^IEN" on either the D or AD cross-references

Coding System unknown:  $O(^ROOT("D",WORD,IEN)) Coding System known:
$O(^ROOT("AD",SYS,WORD,IEN))

SYS Input
This is an ICD coding system identifier (taken from
file 80.4).  (Optional)

The following coding systems are found in ICD files 80 and 80.1:

1 = ICD-9 Diagnosis
30 = ICD-10 Diagnosis
2 = ICD-9 Procedures
31 = ICD-10 Procedures

If the coding system can be identified then the "D" cross-reference is ignored
and the $ORDER will be performed on the "AD" cross-reference:

$O(^ROOT("AD",SYS,(CODE_" ")))

The "AD" cross-reference is a coding system specific cross-reference.

REV Input
This is a Reverse $ORDER flag, if set to 1, the
$ORDER operation will be in the reverse direction of "D" or "AD"
cross-reference (Optional, default is 0, $ORDER forward)

If equal to 1

$O(^ROOT("D",WORD)),-1)
$O(^ROOT("AD",SYS,WORD)),-1)

$$OD Output
This is a 2 piece "^" delimited string containing the
Next or Previous Word in the "D" or "AD" cross-reference and accompanying IEN
depending on the $ORDER direction established by the input parameter REV.

WORD^IEN taken from cross-references

^ROOT("D",WORD,IEN) or
^ROOT("AD",SYS,WORD,IEN)

$$DLM(FILE,IEN,FIELD,CDT)
This entry point returns the date a record or field
was last modified.  If the field number is passed, then the date last modified
(based on date) for the field is returned.  If the field is not passed, then
the date last modified (based on date) for the record at IEN is returned.  The
following are valid versioned fields:

File 80

10   Sex                          5;0
11   Age Low                      6;0
12   Age High                     7;0
66   Status                      66;0
67   Diagnosis                   67;0
68   Description                 68;0
71   DRG Grouper                  3;0
72   Major Diagnostic Category    4;0
103   Complication/Comorbidity    69;0

File 80.1

10   Sex                          3;0
66   Status                      66;0
67   Operation/Procedure         67;0
68   Description                 68;0
71   DRG Grouper                  2;0


VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to determine the
global root to $ORDER through (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

FIELD Input
This is the field number of a versioned data element
in the file specified.  (Optional, with no default value)

If the field number is provided then this API will return the date that the
field was last modified.

If the field number is not provided then this API will return the date that
the record was last modified.

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the date last modified (Optional, if not provided then TODAY
is used)

$$DLM Output
This is the date last modified for the record
identified by the input parameters FILE and IEN.  If the input parameter FIELD
is set to a valid versioned field then this will be the date that the field
was last modified.

or -1 ^ message on error

$$CS(FILE,FMT,CDT)
This is an interactive entry point to select a coding
system.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to select a coding
system (Optional, if not provided you will be prompted for an ICD file
Number):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

FMT Input
This is a flag to determine the display format for
the prompts:

E  Display External only (default)
I  Display External with Internal

Prompt using External only, default:

FMT=E      1   ICD-9-CM
2   ICD-10-CM

Prompt using External with Internal:

FMT=I      1   ICD-9-CM       (#1)
2   ICD-10-CM      (#30)

CDT Input
This is an optional date to use in selecting a coding
system.  If passed, only coding systems with an implementation date on or
before the date passed are selectable (optional)

$$CS Output
This is a 2 piece "^" delimited string

1  Coding System (internal) 2  Coding System (external)

or  -1  on error or non-selection or  ^^  double up-arrows or  ^   timeout or
single up-arrow

$$EFF(FILE,IEN,CDT)
This entry point returns a codes status, inactivation
date and activation date (replaces EFF^ICDSUPT)

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the status and effective dates on the date specified
(Optional, if not provided then TODAY is used)

$$EFF Output
This is a 3 piece "^" delimited string

1   Status
1 - Active
0 - Inactive
2   Inactivation Date
3   Activation Date

or
-1^error message

$$LA(FILE,IEN,CDT)
This entry point returns the last activation
effective date based on a date passed.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the last activation date based on the date specified
(Optional, if not provided then TODAY is used)

$$LA Output
This is the last activation date (Fileman format) or

-1^Not activated on or before date specified

$$LI(FILE,IEN,CDT)
This entry point returns the last inactivation
effective date based on a date passed.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the last inactivation date based on the date specified
(Optional, if not provided then TODAY is used)

$$LI Output
This is the last inactivation date (Fileman format)
or

-1^Not inactivated on or before date specified

$$LS(FILE,IEN,CDT)
This entry point returns the last code status based
on a date passed.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the last code status based on the date specified (Optional,
if not provided then TODAY is used)

$$LS Output
This is the last code status based on the date
passed.

1 - Active
0 - Inactive

or

-1^No status on or before date specified

$$NUM(CODE)
This entry point converts a code to a numeric
representation (found on the AN cross-reference)

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis or procedure code
(Required)  (This is the opposite of $$COD)

$$NUM Output
This is a numeric representation of a code.

$$COD(NUM)
This entry point converts a numeric representation of
a code to a code (found on the AN cross-reference)

VARIABLES TYPE VARIABLES DESCRIPTION
NUM Input
This is a numeric representation of an ICD diagnosis
or procedure code (This is the opposite of $$NUM)

$$COD Output
This is an ICD diagnosis or procedure code.

$$IE(CODE)
This entry point determines if a code is in an
external or internal format without plusing (+) the code.

If you have an ICD-10 code with the letter "E in the center and plus it you
will receive a MAXNUMBER error.

Example:  If you plus (+) the ICD-10 procedure code "041E499" it will be
interpreted as a scientific notation (E499 is a really big number).
Applications that plus the ICD code can use this entry point to safely
determine a code's format.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is either an ICD diagnosis or procedure code
(Required)

$$IE Output
This is a set of codes as follows:

I  CODE is in an internal format (IEN)
E  CODE is in an external format (Code)

or

Null on error

$$FILE(SYS)
This entry point will return an ICD file number.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This is a coding system, a global root or a file
identifier.

Global roots ^ICD9( and ^ICD0( are acceptable Coding Systems can be found in
file 80.4 File Identifier:  DX or PR
DIAG or PROC or OPER

$$FILE Output
This is an ICD file number 80 or 80.1

or -1 on error

$$ROOT(SYS)
This entry point will return an ICD global root.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This is a coding system, file number, a file
identifier or even an ICD code, provided the code is unique to a file.

Coding Systems can be found in file 80.4 File Number 80 or 80.1 File
Identifier:  DX or PR
DIAG or PROC or OPER

$$ROOT Output
This is a global root ^ICD9( or ^ICD0( or Null on
error

$$SYS(SYS,CDT,FMT)
This entry point will return a coding system.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This can be either a Coding System name,
Abbreviation, system identifier (uses date) or a code.

Coding System Names: ICD-9-CM, ICD-9 Proc, ICD-10-CM or ICD-10-PCS

Coding System Abbreviations: ICD, ICP, 10D or 10P

System Identifier (with date CDT)

Date is before the ICD-10 implementation date

DIAG, ICD9, 80, DX =  1
PROC, OPER, ICD0, ICP9, 80.1, PR = 2

Date is on or after the ICD-10 implementation date

DIAG, ICD9, 80, DX =  30
PROC, OPER, ICD0, ICP9, 80.1, PR = 31

An ICD code

If an ICD code is unique to an ABA
cross-reference then the Coding System
can be determined from a code

^ICD9("ABA",1,(CODE_" "))   = 1
^ICD9("ABA",30,(CODE_" "))  = 30
^ICD9("ABA",2,(CODE_" "))   = 2
^ICD9("ABA",31,(CODE_" "))  = 31

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the coding system based on a system identifier (Optional, if
not provided then TODAY is used)

FMT Input
This is a single character identifying the desired
output format (Optional, default is "I"):

I  Internal (default)
E  External
B  Both Internal ^ External

$$SYS Output
This is the Coding System in the format specified by
the input parameter FMT:

FMT=I     FMT=E        FMT=B
Internal  External     Both

1      ICD-9-CM     1^ICD-9-CM
2      ICD-9 Proc   2^ICD-9 Proc
30      ICD-10-CM    30^ICD-10-CM
31      ICD-10-PCS   31^ICD-10-PCS

or

-1   on error

$$SINFO(SYS,CDT)
This entry point returns coding system information
taken from file 80.4.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This can be either a Coding System name,
Abbreviation, system identifier, file number or a code.  (system identifier
and code uses date).

Coding System Names:

ICD-9-CM
ICD-9 Proc
ICD-10-CM or
ICD-10-PCS

Coding System Abbreviations:

ICD, ICP, 10D or 10P

System Identifier/File Number (with date CDT)

Date is before the ICD-10 implementation date

DIAG, ICD9, 80, DX =  1
PROC, OPER, ICD0, ICP9, 80.1, PR = 2

Date is on or after the ICD-10 implementation date

DIAG, ICD9, 80, DX =  30
PROC, OPER, ICD0, ICP9, 80.1, PR = 31

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the coding system based on a system identifier (Optional, if
not provided then TODAY is used)

$$SINFO Output
This is a 6 piece "^" delimited string

1      IEN to file 80.4
2      Coding System
3      Coding System Abbreviation
4      File Number
5      Implementation Date
6      Content

or

-1   on error

$$SNAM(SYS)
This entry point returns the coding system name.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This is a pointer to the coding system file 80.4

$$SNAM Output
This the coding system name, file 80.4 (.01)

ICD-9-CM
ICD-9 Proc
ICD-10-CM
ICD-10-PCS

Or  -1   on error

$$SAB(SYS,CDT)
This entry point returns the coding system
abbreviation.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This can be either a Coding System name,
Abbreviation, system identifier (uses date) or a code.

Coding System Names: ICD-9-CM, ICD-9 Proc, ICD-10-CM or ICD-10-PCS

Coding System Abbreviations: ICD, ICP, 10D or 10P

System Identifier (with date CDT)

Date is before the ICD-10 implementation date

DIAG, ICD9, 80, DX =  1
PROC, OPER, ICD0, ICP9, 80.1, PR = 2

Date is on or after the ICD-10 implementation date

DIAG, ICD9, 80, DX =  30
PROC, OPER, ICD0, ICP9, 80.1, PR = 31

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the source abbreviation based on a system identifier
(Optional, if not provided then TODAY is used)

$$SAB Output
3 Character Coding System abbreviation, file 80.4
(.02)

ICD
ICP
10D
10P

Or  -1   on error

$$EXC(FILE,IEN)
This entry point returns a boolean value indicating
if an entry in the specified file is to be excluded from lookup.  If it is to
be excluded, then the entry will not be placed on the selection list for a
user to select from.  Used primarily for the special lookup.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified.

$$EXC Output
Boolean value

1 = Yes, exclude from lookup
0 = No, include in the lookup

$$ISA(IEN1,IEN2,FIELD)
This entry point returns a boolean value indicating
that one code is a "condition" of another.  Conditions include:

Code 1 is Not Used With Code 2
Code 1 is Required With Code 2
Code 1 is Not Considered CC With Code 2

VARIABLES TYPE VARIABLES DESCRIPTION
IEN1 Input
This is the internal entry number (IEN) of a code in
file 80 that has a relationship with the code at IEN2  IEN1 is equivalent to
Fileman's DA and identifies a code stored in a multiple in field 20, 30, 40 or
pointed to by field 1.11.

IEN2 Input
This is the internal entry number (IEN) of a code in
file 80 that may have other codes (IEN1) associated with it.  IEN2 is
equivalent to Fileman's DA(1) and identifies the code in the .01 field.

FIELD Input
This is a field number in file 80 that contains one
or more ICD codes that have a relationship to the main entry.   Acceptable
field numbers and the type of relationships to check include:

Field       Relationship
20          Code 1 Not Used With Code 2
30          Code 1 Required With Code 2
40 or 1.11  Code 1 Not Considered CC With Code 2

$$ISA Output
This is a Boolean value

1   Yes/The relationship is True
0   No/The relationship is False

Field       Answers the Question
-----       --------------------------------
20          Code 1 (identified by IEN1) is
not used with Code 2 (identified
by IEN2)

30          Code 1 (identified by IEN1) is
required with Code 2 (identified
by IEN2)

40 or 1.11  Code 1 (identified by IEN1) is
not considered Complication
Comorbidity (CC) with Code 2
(identified by IEN2)

$$EXIST(IEN,FIELD)
This entry point determines if special condition ICD
codes exist.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

FIELD Input
This is a field number in file 80 that contains one
or more ICD codes that have a relationship to the main entry (Required)
Acceptable field numbers to check include:

20   Code Not Used With
30   Code Required With
40   Code Not Considered CC With

$$EXIST Output
Boolean value

1   Yes/True, codes exist
0   No/False, codes do not exist

Field   Answers the Question
-----   -------------------------------
20      Are there any codes that should
not be used with this code (IEN)
30      Are there any codes required
with this code (IEN)
40      Are there any codes that are not
considered CC with this code
(IEN)

$$GETDRG(FILE,IEN,CDT,MDC)
This entry point returns a string of DRGs for an ICD
Diagnosis or Procedure code.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the DRGs
(Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the DRGs that were appropriate on that date (Optional, if not
passed then TODAY is used)

MDC Input
This is a Major Diagnostic Category (pointer to file
80.3) used as a screen to limit the DRGs to an MDC.  This input parameter only
applies to the ICD OPERATIONS/PROCEDURE file 80.1 which has multiple MDCs,
each with a possibility of multiple DRGs  (Conditional)

$$GETDRG Output
3 piece semi-colon ";" delimited string

1  DRGs delimited by ^
2  Fiscal Year
3  Status flag
0 inactive
1 active

Example output:

907^908^909^;3071001;1

On Error:

-1;No DRG level;0

MD(FILE,IEN,CDT,.ARY,FLAG)
This entry point returns an array of Major Diagnostic
Categories (MDCs) and Diagnosis Related Groups (DRGs)

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
Major Diagnostic Categories (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDCs that were appropriate on that date (Optional, if not
passed then TODAY is used)  NOTE:  If no Fiscal Year is found for the input
date then the first (earliest( Fiscal Year is used.

.ARY Input
This is a local array name passed by reference that
will contain a list of MDCs by effective date

FLAG Input
This is a flag that determines the output format:

I   = Internal (default) Internal values
are always returned

E   = Include External values with Internal
values

ARY Output
ICD Procedures file 80.1 (multiple MDC)

ARY(<fiscal year>,<MDC>)=DRG^;FY;STA
ARY(<fiscal year>,<MDC>)="DRG^DRG^;FY;STA

If Flag contains "E"

ARY(<fiscal year>,"E",<MDC>)=MDC Name
ARY(<fiscal year>,"E",<MDC>,<DRG>)=DRG Name
ARY(<fiscal year>,"E",<MDC>)=MDC Name
ARY(<fiscal year>,"E",<MDC>,<DRG>)=DRG Name
ARY(<fiscal year>,"E",<MDC>,<DRG>)=DRG Name
ARY(<fiscal year>,"E","FY")=External FY

ICD Diagnosis file 80 (single MDC)

ARY(<fiscal year>,<MDC>)="DRG^DRG^;FY;STA

If Flag contains "E"

ARY(<fiscal year>,"E",<MDC>)=MDC Name
ARY(<fiscal year>,"E",<MDC>,<DRG>)=DRG Name
ARY(<fiscal year>,"E",<MDC>,<DRG>)=DRG Name
ARY(<fiscal year>,"E","FY")=External FY

NOTE:  If no Fiscal Year found for the input date then the first (earliest)
Fiscal Year is used.

$$EFM(CDT)
This entry point converts an external date to a
Fileman internal date.  This entry point replaces unsupported
$$DGY2K^DGPTOD0(X)

VARIABLES TYPE VARIABLES DESCRIPTION
CDT Input
External date (Required), examples of valid dates:

JAN 20 1957 or 20 JAN 57
1/20/57 or 012057
T   (for TODAY)
T+1 (for TOMORROW),  T+2,  etc.
T-1 (for YESTERDAY)
T-3W (for 3 WEEKS AGO), etc.

$$EFM Output
Internal Fileman Date

or -1 on error

$$FY(CDT)
This entry point returns the 4 digit fiscal year for
a specified date.  This entry point replaces unsupported $$FY^DGPTOD0(X)

VARIABLES TYPE VARIABLES DESCRIPTION
CDT Input
This is an internal Fileman date.

$$FY Output
This is a 4 digit fiscal year (YYYY) for the date
specified or null on error.

$$VMDCDX(IEN,CDT)
This entry point returns the versioned Major
Diagnostic Code for an ICD Diagnosis.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDCs that was appropriate on that date (Optional, if not
passed then TODAY is used)

$$VMDCDX Output
This is a single MDC (pointer to file 80.3) active on
the date specified.

$$VMDCOP(IEN,MDC,CDT)
This entry point returns the versioned Major
Diagnostic Codes for an ICD Procedure.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATION/PROCEDURE file 80.1 (Required)

MDC Input
This is a Major Diagnostic Category (pointer to file
80.3) used as a screen to limit the results to a single MDC (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDC that was appropriate on that date (Optional, if not
passed then TODAY is used)

$$VMDCOP Output
4 piece "^" delimited string

1   Fiscal Year, Fileman format
2   MDC, pointer to file 80.3
3   Fiscal Year, pointer to sub-file
80.171 (formerly DADRGFY)
4   MDC, pointer to sub-file 80.1711
(formerly DAMDC)

MDCG(IEN,CDT,.ARY)
This entry point sets up an array of MDCs (later used
in $$MDCT)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDCs that were appropriate on that date (Optional, if not
passed then TODAY is used)

.ARY Input
This is a local array name passed by reference that
will contain a list of MDCs (Required)

ARY Output
This is an array listing MDCs for all DRGs associated
with a diagnosis on the date specified.

ARY(MDC)=""
ARY(MDC)=""

$$MDCT(IEN,CDT,.ARY,FMT)
This entry point compares a single entry in the ICD
OPERATIONS/PROCEDURE file 80.1 to an array of Major Diagnostic Categories to
see if the ICD procedure is assigned to one or more of the MDCs in the array.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATIONS/PROCEDURE file 80.1 (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDCs that were appropriate on that date (Optional, if not
passed then TODAY is used)

.ARY Input
This is a local array passed by reference containing
a list of MDCs for comparison (Required)

FMT Input
This is a flag defining the output format (optional):

0   Boolean value only (default)
1   2 piece "^" delimited string

1   Boolean value
2   String of matching MDCs
delimited by ";"

$$MDCT Output
Boolean value

0  The ICD Procedure code identified by IEN
does not include any of the MDCs passed
in .ARY(MDC) on the date specified (CDT)

1  The ICD Procedure code identified by IEN
includes one or more of the MDCs passed
in .ARY(MDC) on the date specified (CDT)

Assuming the following input parameters:

IEN=4
CDT=3111110
ARY(2)=""
ARY(21)=""

Output format when input parameter FMT=0
(default)

$$MDCT(IEN,CDT,.ARY) = "1"

Output format when input parameter FMT=1

$$MDCT(IEN,CDT,.ARY) = "1^2;21"

$$MDCD(IEN,MDC,CDT)
This entry point checks for a Major Diagnostic
Category MDC in the ICD OPERATION/PROCEDURE file.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATIONS/PROCEDURE file 80.1 (Required)

MDC Input
This is a Major Diagnostic Category (pointer to file
80.3) (Required)

CDT Input
This is the Code Set Versioning date (Fileman format)
used to identify the MDCs that were appropriate on that date (Optional, if not
passed then the first FY is used)

$$MDCD Output
Boolean value

0  MDC does not exist on date specified
1  MDC exist on date specified

$$MOR(IEN)
This entry point returns the Major O.R. Procedure
string

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
OPERATIONS/PROCEDURE file 80.1 (Required)

$$MOR Output
Major O.R. Procedure or Null if the procedure is not
defined as a Major O.R. Procedure or is not found

Major O.R. Procedure definitions include:

1   Bowel                 2  Chest         3   Lymphoma/Leukemia     4  Joint
5   Pancreas/Liver        6  Pelvic 7   Shoulder/Elbow        8  Thumb/Joint 9
Head/Neck             A  Cardio M   Musculoskeletal       B  Spine

$$UPDX(IEN)
This entry point determines if a diagnosis is
unacceptable as a principle diagnosis.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

$$UPDX Output
Boolean value, answers the question:

Is the diagnosis UNACCEPTABLE as a Principle DX?

1   Yes  Code is Unacceptable as Principle DX
0   No   Code is Acceptable as Principle DX

$$NOT(IEN,SUB,FMT)
This entry point returns the number of ICD codes that
cannot be used with a specified code.  It can also return a global array
containing a list of the codes that cannot be used with the specified code.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

SUB Input
This is a subscript name used in a ^TMP global array
(Optional, if not provided, the subscript "ICDNOT" will be used)

^TMP(SUB,$J)

FMT Input
This is a flag defining the output format.

0 - Total number only (default)
1 - Total number with global array

$$NOT Output
The number of ICD codes that cannot be used with the
ICD code identified by IEN (FMT=0 or 1)

TMP global array as follows (FMT=1):

^TMP(SUB,$J,IEN)=CODE
^TMP(SUB,$J,"B",(CODE_" "),IEN)=""

$$REQ(IEN,SUB,FMT)
This entry point returns the number of ICD codes that
are required when the specified code is used.  It can also return a global
array containing a list of the codes that are required when the specified code
is used.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

SUB Input
This is a subscript name used in a ^TMP global array
(Optional, if not provided, the subscript "ICDREQ" will be used)

^TMP(SUB,$J)

FMT Input
This is a flag defining the output format.

0 - Total number only (default)
1 - Total number with global array

$$REQ Output
The number of ICD codes required when the ICD code
identified by IEN is used. (FMT=0 or 1)

TMP global array as follows (FMT=1):

^TMP(SUB,$J,IEN)=CODE
^TMP(SUB,$J,"B",(CODE_" "),IEN)=""

$$NCC(IEN,SUB,FMT)
This entry point returns the number of ICD codes that
are not considered CC with a specified code.  It can also return a global
array containing a list of the codes that are not considered CC with a
specified code.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the
DIAGNOSIS file 80 (Required)

SUB Input
This is a subscript name used in a ^TMP global array
(Optional, if not provided, the subscript "ICDNCC" will be used)

^TMP(SUB,$J)

FMT Input
This is a flag defining the output format.

0 - Total number only (default)
1 - Total number with global array

$$NCC Output
The number of ICD codes not considered CC with the
code identified by IEN. (FMT=0 or 1)

TMP global array as follows (FMT=1):

^TMP(SUB,$J,IEN)=CODE
^TMP(SUB,$J,"B",(CODE_" "),IEN)=""

LK
Special Lookup (called by DIC)

This is the Special Lookup program for files 80 and 80.1.  Only the ^DIC call
honors the special lookup routines.  Those calls that allow the user to
specify the indexes (IX^DIC and MIX^DIC1), and the Data Base Server calls
(FIND^DIC, $$FIND1^DIC, and UPDATE^DIE) all ignore the Special Lookup Program.
Also, if DIC(0) contains an "I" then the Special Lookup program will be
ignored.

This routine uses a majority of the variables used in calling Fileman ^DIC.
In addition to the Fileman variables, there are three special variables that
aid in controlling the lookup that can be set and killed by the calling
application;

Versioning Date (Fileman format)

ICDVDT or
^TMP("ICDEXLK",$J,"ICDVDT")=<versioning date>

Coding System (from file 80.4)

ICDSYS or
^TMP("ICDEXLK",$J,"ICDSYS")=<coding system>

Display Format (numeric, 1-4) (new)

ICDFMT or
^TMP("ICDEXLK",$J,"ICDFMT")=<display format>

VARIABLES TYPE VARIABLES DESCRIPTION
ICDVDT Input
Versioning Date (Fileman format)

ICDVDT or
^TMP("ICDEXLK",$J,"ICDVDT")=<date>

This is a Code Set Versioning Date (in Fileman format).  If set, it must also
be killed by the calling application.

If supplied, it is assumed that the lookup is to be a versioned lookup and
only active codes on that date will be included in the selection list.

If not supplied, the date will default to TODAY and all codes may be selected,
active and inactive.

In both cases the display will be altered based on the date.

ICDSYS Input
Coding System (from file 80.4)

ICDSYS or
^TMP("ICDEXLK",$J,"ICDSYS")=<coding system>

This is the Coding System taken from file 80.4.  If set, it must be killed by
the calling application.  It may be any of the following:

1    ICD    ICD-9-CM
2    ICP    ICD-9 Proc
30    10D    ICD-10-CM
31    10P    ICD-10-PCS

If supplied, the lookup will only look in the cross-references specific for
that coding system.

ICDFMT Input
Display Format (numeric, 1-4)

ICDFMT or
^TMP("ICDEXLK",$J,"ICDFMT")=<display format>

This is a flag defining a Display Format (numeric, 1-4).  If set, it must be
killed by the calling application.

1 = Fileman format, code and short text
(default)

250.00    DMII WO CMP NT ST UNCNTR

2 = Fileman format, code and description

250.00    DIABETES MELLITUS WITHOUT
MENTION OF COMPLICATION,
TYPE II OR UNSPECIFIED TYPE,
NOT STATED AS UNCONTROLLED

3 = Lexicon format, short text followed
by code

DMII WO CMP NT ST UNCNTR (250.00)

4 = Lexicon format, description followed
by code

DIABETES MELLITUS WITHOUT MENTION OF
COMPLICATION, TYPE II OR UNSPECIFIED
NOT STATED AS UNCONTROLLED (250.00)


X Input
This is the user's input, if not available the user
will be prompted for input.

FILEMAN Input
FileMan Variables used

DIC, DIC(0), DIC("A"), DIC("B"),
DIC("S"), DIC("W"), DIC("?N",<file>)

FileMan Variables not used:

DIC("DR"),DIC("PTRIX",<fm>,<to>,<file>),
DIC("T"), DIC("V"), DIC("?PARAM")

DIC(0) parameters applicable to a versioned file

A   Ask the entry; if erroneous, ask again
B   Only the B index is used
E   Echo information
F   Forget the lookup value
I   Ignore the special lookup program
O   Only find one entry if it matches exactly
Q   Question Input ??
S   Suppresses display of .01
T   Search until user selects or enters ^^
X   EXact match required
Z   Zero node in Y(0), external form in Y(0,0)

DIC(0) parameters NOT applicable to a versioned file and not used

C   Versioned cross-references not turned off
K   Primary Key not established
L   Learning a new entry LAYGO not allowed
M   Multiple-index lookup allowed
N   Uppercase, IEN lookup allowed (not forced)
n   ICD has no pure numeric entries
U   All values are external
V   Verification is not optional

FileMan Variables KILLed:

DLAYGO
DINUM

Y Output
Fileman Compliant:

Y        IEN ^ Code

If DIC(0) containing "Z"

Y(0)     0 Node
Y(0,0)   Code

Non-Fileman Compliant, DIC(0) contains "Z"

Y(0,1)   $$ICDDX or $$ICDOP
Y(0,2)   Long Description

$$LKTX(X,ROOT,CDT,SYS,VER,OUT)
This entry point is a lookup for text in either file
80 or 80.1  It is similar to the special lookup except there is no prompt for
input or display for selection (silent) and intended for GUI applications.

VARIABLES TYPE VARIABLES DESCRIPTION
X Input
This is a string of text to search for.

ROOT Input
This is either a global root or file number to
indicate either the DIAGNOSIS file 80 or the OPERATIONS/PROCEDURE file 80.1

CDT Input
This is the Code Set Versioning date (Fileman format)
used to determine the status of a code (active or inactive) It normally
represents the date that service was provided to the patient (HIPAA).
However, it may also represent the date of onset, visit date or movement date
depending on the application calling the lookup.

SYS Input
This is a coding system identifier (pointer to file
80.4)

1 = ICD-9-CM
2 = ICD-9-PCS
30 = ICD-10-CM
31 = ICD-10-PCS

VER Input
This is the versioned flag (boolean) to indicate if
the lookup is to be versioned or not:

0  No   Include all codes, active
and inactive

1  Yes  Include only Active codes
for date specified

OUT Input
This is a flag that defines the output format:

1  Fileman, Code and Short Text (default)

250.00    DMII WO CMP NT ST UNCNTR

2  Fileman, Code and Description

250.00    DIABETES MELLITUS WITHOUT
MENTION OF COMPLICATION TYPE
II OR UNSPECIFIED TYPE, NOT
STATED AS UNCONTROLLED

3  Lexicon, Short Text and Code

DMII WO CMP NT ST UNCNTR (250.00)

4  Lexicon, Description and Code

DIABETES MELLITUS WITHOUT MENTION OF
COMPLICATION, TYPE II OR UNSPECIFIED,
NOT STATED AS UNCONTROLLED (250.00)

$$LK Output
This is the number of entries found

The entries will be included in a ^TMP Global Array:

^TMP(ID,$J,"SEL")
^TMP(ID,$J,"SEL",0)=# of entries
^TMP(ID,$J,"SEL",#)=IEN ^ Display Text

Where ID is a package namespaced subscript:

ICD9 - for file #80
ICD0 - for file #80.1

$$VER(SYS,REL)
This API returns the current Coding System version,
the previous Coding System version or the next Coding System version based on
input parameters.

VARIABLES TYPE VARIABLES DESCRIPTION
SYS Input
This is a pointer to the coding system file 80.4

REL Input
This input parameter indicates the relationship of
the output coding system to the input coding system (Optional)

0   N/A - Return the current version (default)
1   Return the next version
-1   Return the previous version

$$VER Output
This is a 5 piece string containing:

1   Coding System (pointer to file 80.4)
2   Coding System Nomenclature
3   Coding System Abbreviation
4   File Number containing the Coding System
5   Date Coding System was Implemented or
-1   on error

Y(ROOT,IEN,CDT,FMT)
Given the global root or file number, the Internal
Entry Number (IEN) and a date, this API will return the equivalent of
FileMan's output variable Y without having to perform the lookup.

VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Input
This is either an ICD global root or file number.

IEN Input
This is an Internal Entry Number in the file
identified by the input parameter ROOT.

CDT Input
This is a code set versioning date used to returned
versioned (date sensitive) data from the ICD files.

FMT Input
This is a output format flag (optional, default 0).

0  Return standard Fileman Y - IEN ^ CODE
1  Return Expanded Y as if DIC(0) contained a "Z"

Y Output
Input parameter FMT = 0 or 1

Y = IEN ^ Code

Input parameter FMT = 1

FileMan Compliant

Y(0)    =  0 Node    (aka Code)
Y(0,0)  =  .01 Field (aka Code)

Non-FileMan Compliant

Y(0,1)  =  $$ICDDX or $$ICDOP
Y(0,2)  =  Versioned Long Description

TOKEN(TEXT,ROOT,SYS,ARY)
This API parses text into words/tokens and saves them
in a local array for later processing.  Words and tokens not found in the file
and coding system identified by the input parameters are not included in the
output array.

VARIABLES TYPE VARIABLES DESCRIPTION
TEXT Input
This is a text string to parse.

ROOT Input
This is a global root or file number (required)

^ICD9(  or  80
^ICD0(  or  80.1

SYS Input
This is the coding system  (Required)

1  or  ICD  or  ICD-9-CM
2  or  ICP  or  ICD-9 Proc
30  or  10D  or  ICD-10-CM
31  or  10P  or  ICD-10-PCS

.ARY Both
This is the output array passed by reference that
contains a list of words parsed from the input string X and arranged by
frequency of use

ARY(0)=# of words
ARY(#)=word

The least frequently used word will be ARY(1) and the most frequently used
word will be ARY($O(ARY(" "),-1)).  Words not found in the file and coding
system will not appear in the parsed array.

$$WORD(WORD,ROOT,SYS)
This API determines if a word is found in a file or a
coding system identified by the input parameters

VARIABLES TYPE VARIABLES DESCRIPTION
WORD Input
This is a single word.

ROOT Input
This is a global root or file number (optional)

^ICD9(  or  80
^ICD0(  or  80.1

SYS Input
This is the coding system (Optional)

1  or  ICD  or  ICD-9-CM
2  or  ICP  or  ICD-9 Proc
30  or  10D  or  ICD-10-CM
31  or  10P  or  ICD-10-PCS

$$WORD Output
This is a Boolean value indicating if a word is
contained in a set (file or system).

1 = Word was found

If ROOT is not supplied, the word was
found in either file 80 or 80.1

If SYS is not supplied, the word was
found in the file designated by ROOT
in any coding system in the file

If both ROOT and SYS are supplied,
the word was found in the specified
coding system

0 = Word was not found

$$ICDIDS(FILE,CODE,ARY)
This API returns an array of Diagnosis or Procedure
code Identifiers used in the calculation of DRG groups.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
identifier codes (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

CODE Input
This is an Internal Entry Number (IEN) in the file
specified (Required).

ARY Both
This is a local array of identifiers found for the
code identified input parameters FILE and CODE.

ARY(<identifier>)=""

$$ICDIDS Output
This is the number of identifiers found for the code
identified by the input parameters FILE and CODE, or upon error:

-1^error message

$$ICDID(FILE,ID,CODE)
This API checks if a specified ICD identifier exist
for a code identified by the input parameters FILE and CODE.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is the ICD file number used to retrieve the
identifier codes (Required):

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

ID Input
This is a Diagnosis or Procedure code identifier
(required)

CODE Input
This is an Internal Entry Number (IEN) in the file
specified (Required).

$$ICDID Output
Boolean value

1 if identifier was found for code
0 if identifier was not found for code

or upon error -1^error message

$$ISOWNCC(IEN,CDT,FMT)
This API returns the Complication/Comorbidity (CC)
value for an ICD Diagnosis code when the primary diagnosis is its own CC/MCC.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is the Internal Entry Number (IEN) of the ICD
Diagnosis file #80.

CDT Input
Date to use to extract CC (default TODAY)

FMT Input
This is a flag that controls the output format:

0 = CC only (default)
1 = CC ^ Effective Date

$$ISOWNCC Output
Complication/Comorbidity (CC)

DX is Own CC  Format  Output
------------  ------  -------------------------
Yes        0     CC Value
Yes        1     CC Value ^ Effective Date
No        N/A    0 (zero)

or upon error -1^error message

$$ICDRGCC(DRG,CDT)
This API returns the CC/MCC flag from DRG file #80.2

VARIABLES TYPE VARIABLES DESCRIPTION
DRG Input
This is an Internal Entry Number for the DRG file
80.2 (required)

CDT Input
Date to use to extract CC/MCC flag (default TODAY)

$$ICDRGCC Output
This is the Complication/Comorbidity/Major CC flag

0   No CC or MCC
1   CC present
2   MCC present
3   CC or MCC present

or upon error -1^error message

$$DRG(CODE,CDT)
This API returns basic information about a DRG.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
DRG code, internal or external format (Required)

CDT Input
Date to check status for, FileMan format (default =
TODAY)

If CDT < 10/1/1978, use 10/1/1978
If CDT > DT, validate with In/Activation Dates
If CDT is year only, use first of the year
If CDT is year and month, use first of the month

$$DRG Output
Returns an 22 piece string delimited by the up-arrow
(^) the pieces are:

1  DRG name (field #.01)
2  Weight (field #2)
3  Low Trim (days) (field #3)
4  High Trim (days) (field #4)
5  MDC (field #5)
6  Surgery Flag (field #.06)
7  <null>
8  Avg Length of Stay (days) (field 10)
9  Local Low Trim Days (field #11)
10  Local High Trim Days (field #12)
11  <null>
12  Local Breakeven (field #13)
13  Activation Date (.01 field, 66 multiple)
14  Status (.03 field, 66 multiple)
15  Inactivation Date (.01 field, 66 multiple)
16  Effective date (.01 field, 66 multiple)
17  Internal Entry Number (IEN)
18  Effective date (.01 field, 66 multiple)
19  Reference (field #900)
20  Weight (Non Affil) (field #7)
21  Weight (Int Affil) (field #7.5)
22  Message

or

-1^Error Description

$$DRGD(CODE,ARY,CDT)
Returns an unformatted DRG Description.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
ICD Code, Internal or External Format (required)

ARY Both
Input:   Name of Output Array for description

e.g. "ABC" or "ABC("TEST")"

Default = ^TMP("DRGD",$J)

Output:  Description in array

@ARY(1:n) - Description (lines 1-n)
@ARY(n+1) - Blank
@ARY(n+1) - Warning Message

or

-1^Error Description

NOTE:

User must initialize ^TMP("DRGD",$J)
if used.  The data is place in the
array unformatted, exactly as it is in
the DESCRIPTION multiple (sub-files
#80.068 or #80.168)

SEE ALSO:

$$DRGDES^ICDEX(IEN,CDT,.ARY,LENGTH) to
retrieve the description formatted into
string lengths specified by input
parameter for length.

CDT Input
Date to screen against (default = TODAY)

If CDT < 10/1/1978, use 10/1/1978
If CDT > DT, use DT
If CDT = year only, use 01/01/yyyy
If CDT = year & month, use mm/01/yyyy

$$DRGD Output
This is the number of lines in description output
array.

$$DRGDES(IEN,CDT,ARY,LEN)
This API returns the DRG Description formatted into
string lengths specified by the calling application.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
Internal Entry Number of DRG file 80.2

CDT Input
Date to screen against (default = TODAY)

.ARY Both
This is a local array passed by reference containing
the DRG description.  The text is formatted into string lengths specified by
the LEN input parameter.

LEN Input
Length of line of the description in the output array

Missing        Defaults to 79
Less than 25   Defaults to 25

$$DRGDES Output
This is the number of lines in description output
array.

$$DRGN(CODE)
This API returns the Internal Entry Number (IEN) of
the DRG specified by a DRG code.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is a DRG code.

$$DRGN Output
This is the IEN of the DRG code specified.

$$EFD(X)
This is an interactive API that will prompt the user
for an effective date in a range of dates.

VARIABLES TYPE VARIABLES DESCRIPTION
$$EFD Output
This is a 3 piece "^" delimited string containing an
effective date in both internal and external formats:

1   Date Fileman format         nnnnnnn
2   Date External Short Format  mm/dd/yyyy
3   Date External Long Format   Mmm dd, yyyy

or
"^^" if the user enters double up-arrows
"^"  if the user enters a single up-arrow
""   if the user times out

The earliest possible date is Oct 1, 1978, the initial ICD implementation date
in the VA.

If today's date is less than the implementation date of ICD-10, then the
latest possible date is 3 years from the ICD-10 implementation date.

If today's date is greater than the implementation date of ICD-10, then the
latest possible date is 3 years from today's date.

$$GETDATE(IEN)
This API calculates the Effective Date to use
retrieving ICD/DRG data based on a patient's treatment.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number of the PTF file #45

$$GETDATE Output
This is the correct "EFFECTIVE DATE" for a patient to
be used retrieving DRG/ICD/CPT data (default TODAY)

"EFFECTIVE DATE" Derived from:

Census Date      ^DGPT         0;13
Discharge Date   ^DG(45.86     0;1
Surgery Date     ^DGPT(D0,"S"  0;1
Movement Date    ^DGPT(D0,"M"  0;10
Default          $$NOW^XLFDT

$$IA(FILE,IEN)
This API returns an codes Initial Activation Date
based on a file number and the codes Internal Entry Number.  The Initial
Activation date may be different from the Last Activation date (see $$LA) if
the code was re-used.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is a Global Root or File Number for either the
ICD Diagnosis or ICD Procedure files (Required)

IEN Input
This is an Internal Entry Number (IEN) in the
specified file (Required)

$$IA Output
Initial Activation Date

OR

-1 ^ Error Message

$$IDSTR(FILE,IEN)
This API returns a string of ICD identifier
associated with either an ICD Diagnosis or ICD Procedure code (supports legacy
APIs)

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
File Number or root (required)

80 or ^ICD9     = File #80
80.1 or ^ICD0   = File #80.1

IEN Input
This is a Diagnosis/Procedure code IEN (required)

$$IDSTR Output
This is a string of Identifiers delimited by a
semi-colon

ID;ID;ID

$$ISVALID(FILE,IEN,CDT)
This API determine is an ICD code is valid.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is a file number or global root for either the
ICD Diagnosis file or the ICD Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified.

CDT Input
This is the date to use to determine if the code is
valid for date (default TODAY)

$$ISVALID Output
This is a Boolean value

1 if the code is valid
0 if the code is not valid

$$PDXE(IEN)
This API returns the Primary Diagnosis Exclusion
Code.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) for the ICD
Diagnosis file #80

$$PDXE Output
This is a pointer to DRG CC Exclusions file #82.13

$$REF(IEN,CDT)
This API returns the name of the DRG Reference Table.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) of the DRG
file #80.2

CDT Input
Effective date to use (default TODAY)

$$REF Output
Table reference associated with a DRG entry or null
if not found

$$VCCP(IEN,CDT,FMT)
This API returns the CC Primary Flag for a diagnosis.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) in the ICD
Diagnosis file 80 (required)

CDT Input
This is the date to use to Extract CC Primary Flag
(default TODAY)

FMT Input
Is is a flag to determine the output format
(optional):

0 = CC Primary Flag only (default)
1 = CC Prim Flag^Effective Date^Value

$$VCCP Output
This the CC Primary Flag in one of two formats:

CC Primary Flag only (FMT=0)
CC Primary Flag^Effective Date^Value  (FMT=1)

$$DRGW(IEN)
This API returns the DRG Weighted Work Unit (WWU)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) of the DRG
file 80.2

$$DRGW Output
This is the Weighted Work Unit (WWU) for a DRG

$$DRGC(IEN)
This API returns the DRG code.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) of the DRG
file 80.2

$$DRGC Output
This is a DRG Code (field .01)

$$MDCN(IEN)
This API returns the name of a Major Diagnostic
Category (MDC)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is the Internal Entry Number (IEN) for file 80.3

$$MDCN Output
This is a Major Diagnostic Category Name

$$HDR(FILE)
This API returns the header node of either file 80 or
80.1.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is a File Number or Global Root

80    or  ^ICD9(
80.1  or  ^ICD0(

$$HDR Output
This is the header node of either the ICD Diagnosis
file 80 or the Operation Procedure file 80.1

^ICD9(0)
^ICD0(0)

$$IEN(CODE,ROOT,SYS)
This API returns an internal entry number for a code
based on file/global root and coding system.

This API is similar to $$CODEABA^ICDEX except it will also return IENs for
codes excluded from lookup and VA Local Codes.  Its primary purpose to to
support file maintenance.  Use with great caution.

DO NOT USE in any application that requires codes and text to be versioned
(date sensitive).

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
This is an ICD Diagnosis or Procedure Code from
either the ICD-9 or ICD-10 coding systems (required)

ROOT Input
This is a file number or global root (optional)

^ICD9( or 80
^ICD0( or 80.1

SYS Input
This is a coding system (optional)

1 = ICD-9 Diagnosis
2 = ICD-9 Procedure
30 = ICD-10 Diagnosis
31 = ICD-10 Procedure

$$IEN Output
Returns the Internal Entry Number (IEN) for a CODE or
-1 if not found

$$SDH(FILE,IEN,ARY)
This API returns a history of Short Description
changes by date.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified.

.ARY Input
This is a local array name passed by reference that
will contain the code's short description history.

$$SDH Output
This is a three piece "^" delimited string
containing:

1   The number of short descriptions found
2   The earliest date found
3   The latest date found

ARY Output
This is a local array containing a history of Short
Descriptions by date:

ARY(0)= # ^ Earliest Date ^ Latest Date
ARY(DATE)=Long Description

$$LDH(FILE,IEN,ARY)
This API returns a history of Long Description
changes by date.

VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
This is an ICD file number:

80   = ICD Diagnosis file
80.1 = ICD Operation/Procedure file

IEN Input
This is an Internal Entry Number (IEN) in the file
specified.

.ARY Input
This is a local array name passed by reference that
will contain the code's long description history.

$$LDH Output
This is a three piece "^" delimited string
containing:

1   The number of long descriptions found
2   The earliest date found
3   The latest date found

OR -1 ^ Error Message

ARY Output
This is a local array containing a history of Long
Descriptions by date:

ARY(0)= # ^ Earliest Date ^ Latest Date
ARY(DATE)=Long Description

$$POAE(IEN)
This API checks to see if a Diagnosis Code is exempt
from Present on Admission (Added in ICD*18.0*67)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
Internal Entry Number for file 80

$$POAE Output
Boolean value

0  No, Diagnosis Code is not exempt for POA 1  Yes, Diagnosis Code is exempt
for POA

$$HAC(IEN)
This API checks to see if a Diagnosis Code is a
Hospital Acquired Condition (Added in ICD*18.0*67)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
Internal Entry Number for file 80

$$HAC Output
Boolean value

0  No, Diagnosis Code is not a Hospital
Acquired Condition 1  Yes, Diagnosis Code is a Hospital
Acquired Condition

$$RDX(CODE,CDT)
This API attempts to resolve a code fragment to a
code.  It will return -1 with an error message if it fails.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
Code or Code Fragment (Required)

CDT Input
Versioning Date (Optional, Default TODAY)

$$RDX Output
ICD Diagnosis code from fragment if it can be
resolved.  -1 ^ error message if not resolved

Example:

Input                   Output
Fragment    Oct 1, 2014        Oct 1, 2015
--------    ------------------------------
E8310         E831.0              E83.10
311           311.                311.
A870          A87.0               A87.0
A0201         -1^Could not resolve code fragment

SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
LEXICON UTILITY
The LEXICON UTILITY has access to all APIs listed in
this ICR as if it were the Custodial Package.

ACCOUNTS RECEIVABLE
ACCOUNT RECEIVABLE (PRCA) package will use the
following APIs:

$$CODEC^ICDEX
$$CODECS^ICDEX

INTEGRATED BILLING
INTEGRATED BILLING (IB) will use the following APIs:

$$SYS^ICDEX
$$CODEABA^ICDEX
$$STATCHK^ICDEX
$$ICDDX^ICDEX
$$ICDOP^ICDEX
$$LS^ICDEX
$$CODEC^ICDEX, Effective with IB*2.0*709
FEE BASIS
FEE BASIS (FB) package will use the following APIs:

$$GETDRG^ICDEX
$$STATCHK^ICDEX
$$CODEC^ICDEX
$$CODEABA^ICDEX
$$CODEN^ICDEX
$$SD^ICDEX

PROSTHETICS
PROSTHETICS (RMPR) will use the following APIs:

$$SINFO^ICDEX
$$CSI^ICDEX
$$STATCHK^ICDEX
$$ICDDX^ICDEX
$$VLT^ICDEX
$$LS^ICDEX
$$CODEC^ICDEX

SCHEDULING
SCHEDULING (SD) will use the following APIs:

$$IMP^ICDEX
$$CSI^ICDEX
$$VER^ICDEX
$$SYS^ICDEX
$$LS^ICDEX
$$ICDDX^ICDEX
$$VLTD^ICDEX
$$CODEC^ICDEX, effective with SD*5.3*851
$$STATCHK^ICDEX, effective with SD*5.3*853
REGISTRATION
REGISTRATION (DG) will use the following APIs:

$$CSI^ICDEX
$$CODEC^ICDEX
$$CODEN^ICDEX
$$CODEABA^ICDEX
$$LS^ICDEX
$$NOT^ICDEX
$$REQ^ICDEX
$$SYS^ICDEX
$$VLT^ICDEX
$$SINFO^ICDEX
$$CS^ICDEX
$$ICDDX^ICDEX
$$VST^ICDEX

CLINICAL REMINDERS
CLINICAL REMINDERS (PXRM) will use the following APIs:

$$CODEN^ICDEX
$$CODEABA^ICDEX
$$ICDDX^ICDEX
$$ICDOP^ICDEX
$$NEXT^ICDEX
$$PREV^ICDEX
$$IMP^ICDEX
$$ROOT^ICDEX
$$HDR^ICDEX
$$CODEC^ICDEX
$$CSI^ICDEX
$$SINFO^ICDEX

PHARMACY BENEFITS MANAGEMENT
PHARMACY BENEFITS MANAGEMENT (PSU) will use the
following APIs:

$$CSI^ICDEX
$$ICDDX^ICDEX
$$ICDOP^ICDEX

CLINICAL CASE REGISTRIES
CLINICAL CASE REGISTRIES (ROR) will use the following
APIs:

$$CSI^ICDEX
$$VSEX^ICDEX
$$UPDX^ICDEX
$$CODEC^ICDEX
$$CODEABA^ICDEX
$$VSTD^ICDEX
$$VLTD^ICDEX
$$VSTP^ICDEX
$$VLTP^ICDEX
$$FILE^ICDEX
$$VLT^ICDEX
$$VST^ICDEX
$$CODEN^ICDEX
$$ICDDX^ICDEX
$$ICDOP^ICDEX
$$SNAM^ICDEX
$$OBA^ICDEX
CLINICAL PROCEDURES
CLINICAL PROCEDURES (MD) and MEDICINE (MC) will use the
following APIs:

$$ICDDX^ICDEX
$$CSI^ICDEX
$$IMP^ICDEX
$$SINFO^ICDEX
$$CODEN^ICDEX
$$CODEC^ICDEX
$$CODECS^ICDEX
SPINAL CORD DYSFUNCTION
SPINAL CORD DYSFUNCTION (SPN) package will use the
following APIs:

$$OBA^ICDEX
$$CODEBA^ICDEX
$$CSI^ICDEX
$$CODEABA^ICDEX
$$VLT^ICDEX
$$VST^ICDEX

HOME BASED PRIMARY CARE
HOSPITAL-BASED HOME CARE (HBH) will use the following
APIs:

$$SYS^ICDEX
$$CODEC^ICDEX
$$VSTD^ICDEX
$$SAI^ICDEX
$$CSI^ICDEX

EVENT CAPTURE
EVENT CAPTURE (EC) package will use the following APIs:

$$SINFO^ICDEX
$$ICDDX^ICDEX
$$CODEN^ICDEX

AUTOMATED INFO COLLECTION SYS
AUTOMATED INFO COLLECTION SYS (IBD) package will use
the following APIs:

$$SINFO^ICDEX
$$STATCHK^IDEX
LAB SERVICE
LAB SERVICES (LR) will use the following APIs:

$$CODEC^ICDEX
$$ICDDX^ICDEX
$$ICDOP^ICDEX
$$IMP^ICDEX
$$SINFO^ICDEX
$$CSI^ICDEX
$$SD^ICDEX
$$SNAM^ICDEX
$$CODEN^ICDEX

QUASAR
QUASAR (ACKQ) will use the following APIs:

$$CODEC^ICDEX
$$CSI^ICDEX
$$CODEN^ICDEX

EMERGENCY DEPARTMENT
EMERGENCY DEPARTMENT (EDP) package will use the
following APIs:

$$ICDDX^ICDEX
$$ICDOP^ICDEX
$$CODEC^ICDEX
$$LD^ICDEX     Added 1/25/22: Effective EDP*2*16
PROBLEM LIST
PROBLEM LIST (GMPL) will use the following APIs:

$$CODEC^ICDEX
$$CSI^ICDEX
$$SAB^ICDEX

PCE PATIENT CARE ENCOUNTER
PATIENT CARE ENCOUNTER - PCE (PX) will use the
following APIs:

$$CODEC^ICDEX
$$CODEN^ICDEX
$$CSI^ICDEX
$$SINFO^ICDEX
$$LD^ICDEX
$$IE^ICDEX
$$ICDDX^ICDEX
$$CODEABA^ICDEX

MENTAL HEALTH
MENTAL HEALTH (YS) will use the following APIs:

$$SINFO^ICDEX

SURGERY
SURGERY (SR) package will use the following APIs:

$$CODEN^ICDEX
$$LS^ICDEX
$$SYS^ICDEX
$$VST^ICDEX
$$CODEABA^ICDEX
$$OBA^ICDEX
$$CSI^ICDEX
$$CODEC^ICDEX

ORDER ENTRY/RESULTS REPORTING
ORDER ENTRY/RESULTS REPORTING (OR) will use the
following APIs:

$$CODECS^ICDEX
$$CSI^ICDEX
$$SAB^ICDEX
$$VLTD^ICDEX
$$CODEBA^ICDEX
TEXT INTEGRATION UTILITIES
TEXT INTEGRATION UTILITIES (TIU) will use the following
APIs:

$$CODECS^ICDEX

VBECS
BLOOD BANK (VBEC) will use the following APIs:

$$ICDDX^ICDEX
$$ICDOP^ICDEX

VA POINT OF SERVICE (KIOSKS)
VA POINT OF SERVICE (KIOSKS) (VPS) will use the
following APIs:

$$SAB^ICDEX

HEALTH SUMMARY
HEALTH SUMMARY (GMTS) will use the following APIs:

$$CSI^ICDEX
$$CODEC^ICDEX
$$SNAM^ICDEX
$$VST^ICDEX

VIRTUAL PATIENT RECORD
VIRTUAL PATIENT RECORD (VPR) will use the following
APIs:

$$ICDDX^ICDEX
$$CODEC^ICDEX
$$VSTD^ICDEX
$$VLTD^ICDEX
$$CSI^ICDEX
$$SAB^ICDEX

HEALTH MANAGEMENT PLATFORM
Enterprise Health Mgmt Platform (HMP) will be using the
following APIs:

$$ICDDX^ICDEX
$$CODEC^ICDEX
$$ICDD^ICDEX

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. See VistA Document Library for list of retired
HMP ICRs.
CONSULT/REQUEST TRACKING
GMRC will use the following API:

$$CODECS^ICDEX $$CODEN^ICDEX
FEE BASIS CLAIMS SYSTEM
FEE BASIS CLAIMS SYSTEM (FBCS) will use the following
APIs:

$$LKTX^ICDEX
$$SYS^ICDEX
$$ICDDX^ICEDX
$$CODEC^ICDEX
$$LD^ICDEX
$$IMP^ICDEX
$$ICDOP^ICDEX
$$CODEABA^ICDEX

DENTAL
Dental Record Manager Plus has requested to add Dental
as a subscriber.


Dental will utilize the following APIs:

$$ICDDX^ICDEX
$$CODEN^ICDEX
$$CODEC^ICDEX
$$STATCHK^ICDEX
ADVANCED PROSTHETICS ACQUISITION TOOL
Advanced Prosthetics Acquisition Tool (APAT) has
requested to be added as a subscriber.

APAT will utilize the following APIs:
$$CSI^ICDEX
$$ICDDX^ICDEX
$$INFO^ICDEX
DATE ACTIVATED 2014/07/11