Print Page as PDF
ICD Code APIs ICR (3990)

ICD Code APIs    ICR (3990)

Name Value
NUMBER 3990
IA # 3990
DATE CREATED 2003/03/12
CUSTODIAL PACKAGE DRG GROUPER
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
ROUTINE ICDCODE
NAME ICD Code APIs
GENERAL DESCRIPTION
This agreement contains the references to routine
ICDCODE for the supported APIs.  These entry points will retrieve ICD-9 code
related data.  For ICD-10 data see routine ICDEX (ICR 5747)

All entry points will return
-1^error description in an error condition.  in an error condition.


STATUS Retired
KEYWORDS
  • 3990
  • 3991
DURATION Till Otherwise Agreed
ID ICDCODE
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$ICDDX(CODE,CDT,DFN,SRC)
Extrinsic function that returns basic information for
an ICD Diagnosis Code.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
ICD Diagnosis Code, IEN or .01 format (Required)

CDT Input
Code Date to check. (Optional)

If CDT < 10/1/1978, use 10/1/1978.
If CDT > DT, validate with newest effective dates
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
Default = Today (FileMan format)

DFN Input
This variable is not used and not supported at this
time.

SRC Input
This is the Source Flag. (Optional)

0 = exclude local VA codes, use national codes only (default)
1 = include local VA codes and national codes

$$ICDDX Output
19 piece "^" delimited string containing the
following information:

Piece    Description
-----    -----------
1      IEN in ^ICD9(
2      ICD DX Code (#.01)
3      Identifiers (#2)
4      Versioned Dx Short Name (#67)
5      Unacceptable as Principal Dx (#101)
6      Versioned Major Dx Category (#72)
7      MDC13 (#5.5)
8      Do not use, see piece 19 for CC
9      ICD Expanded (#8)
10      Status (#66)
11      Sex (#9.5)
12      Inactive Date (#66)
13      MDC24 (#5.7)
14      MDC25 (#5.9)
15      Age Low (#14)
16      Age High (#15)
17      Activation Date (#66)
18      Message - Notice of Textual Inaccuracy
19      Versioned Complication/Comorbidity (CC) (#103)

or

-1^Error Description

$$ICDOP(CODE,CDT,DFN,SRC)
Extrinsic function that returns basic information for
an ICD Operation/Procedure Code.

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
ICD Procedure Code, IEN or .01 format (Required)

CDT Input
Code Date to check. (Optional) (Fileman Format)

If CDT < 10/1/1978, use 10/1/1978.
If CDT > DT, validate with newest effective dates
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
Default = Today (FileMan format)

DFN Input
This variable is not used and not supported at this
time.

SRC Input
This is the Source Flag. (Optional)

0 = exclude local VA codes, use national codes only (default)
1 = include local VA codes and national codes

$$ICDOP Output
14 piece "^" delimited string containing the
following information:

Piece    Description
-----    -----------
1      IEN in ^ICD9(
2      ICD Procedure Code (#.01)
3      Identifiers (#2)
4      MDC24 (#5)
5      Versioned Oper/Proc (#67)
6      <null>
7      <null>
8      <null>
9      ICD Expanded (#8)
10      Status (#66)
11      Use with Sex (#9.5)
12      Inactive Date (#66)
13      Activation Date (#66)
14      Message - Notice of Textual Inaccuracy

or

-1^Error Description

$$ICDD(CODE,'OUTARR',CDT)
Extrinsic function that returns the full description
of a code, from the "1" node (field 10) of the ICD9 file or the ICD0 file.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
ICD Diagnosis or Procedure Code (Required)

OUTARR Both
Array to store description
name of array - e.g. "ABC" or "ABC("TEST")"
or temp array.      Default = ^TMP("ICDD",$J)
The calling routine is responsible for killing
^TMP("ICDD",$J) after the call, if used.

On return, the array contains corresponding lies of text of the code's
versioned description (field 68).  OUTARR(1) = 1st line of versioned
description (field #68) OUTARR(last) = last line of versioned description
(field #68) OUTARR(last+1) = blank line OUTARR(last+2) = NOTICE OF TEXTUAL
INACCURACY
where last+2 is the value returned by $$ICDD.

CDT Input
Code Date to check - not used currently,
Included in anticipation of future need.
Default = Today (FileMan format)
If CDT < 10/1/1978, use 10/1/1978.
If CDT > DT, use most recent description
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
$$ICDD Output
Contains number of lines (number of subscripts) in
the description (array)

$$CODEN(CODE,FILE)
Extrinsic function that returns the internal entry
number and the global root of an ICD Code.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
ICD Code  REQUIRED
FILE Input
File Number in which to check for ICD code
80 for ICD Diagnosis file
80.1 for ICD Operation/Procedure file
$$CODEN Output
String, containing the following information in the
following "~" pieces:

Piece    Description
=====    ===========
1      ien of the ICD Code
2      "^ICD9(" if FILE=80; "^ICD0(" if FILE=80.1
$$CODEC(IEN,FILE)
This API returns the ICD Code of an IEN in the file
specified.

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is an Internal Entry Number (IEN) of an ICD
Diagnosis or Procedure Code.

FILE Input
This is the File Number to search for code

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

$$CODEC Output
This is an ICD Diagnosis or ICD Procedure Code based
on IEN and the file specified

or

-1 if no code is found or on error

DATE ACTIVATED 2014/09/04