Print Page as PDF
CPT Code APIs ICR (1995)

CPT Code APIs    ICR (1995)

Name Value
NUMBER 1995
IA # 1995
DATE CREATED 1997/04/08
CUSTODIAL PACKAGE CPT/HCPCS CODES
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ICPTCOD
NAME CPT Code APIs
ORIGINAL NUMBER 1995
GENERAL DESCRIPTION
This contains the supported references to routine
ICPTCOD for the supported APIs to be released with v.6.0 of CPT.

These entry points will retrieve CPT/HCPCS code related data.

All entry points will return
-1^error description in an error condition.
STATUS Active
KEYWORDS
  • 1995
  • 1997
  • 1996
DURATION Till Otherwise Agreed
ID ICPTCOD
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$CPT(CODE,CDT,SRC)
Extrinsic function that returns basic information for
CPT code.

WARNING: Use of the INACTIVE FLAG field (#5) can produce
unpredictable results if the API is not used.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
The CPT, HCPCS, or Level III code in either internal
or external format.
CDT Input
The date for which status of the code is being
checked.  The Default value is TODAY.
If CDT < 1/1/1989, use 1/1/1989
If CDT > DT, validate with newest In/Activation Dates
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
$$CPT Output
String, containing the following information in the
following "^" pieces:

Piece    Description
=====    ===========
1      internal entry number of code in ^ICPT
2      CPT CODE (.01 field)
3      SHORT NAME (versioned from .01 field #61 multiple)
4      CATEGORY ien (#3 field)
5      SOURCE code (#6 field) ==> C:CPT; H:HCPCS; L:VA LOCAL
6      EFFECTIVE DATE (from .01 field #60 multiple)
7      STATUS 0:inactive; 1:active (from .02 of #60 multiple)
8      INACTIVE DATE (versioned from .01 field #60 multiple)
9      ACTIVE DATE (versioned from .01 field #60 multiple)
10      NOTICE OF TEXTUAL INACCURACY
SRC Input
Flag to indicate if Level III codes need to be
screened out. If SRC=0 or null, Level III codes are not processed as valid
input; if SRC>0, Level III codes are accepted.
$$CPTD(CODE,'OUTARR',DFN,CDT)
Extrinsic function that returns the full description
of a code, from the "D" node (field 50) of the ICPT file.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
The CPT or HCPCS code in either internal or external
format.
$$CPTD Output
Contains number of lines (number of subscripts) in
description (array)
OUTARR Both
An array name in which to store the returned
versioned description.  If no name is provided, the default name will be
^TMP("ICPTD",$J,.  The calling routine is responsible for killing
^TMP("ICPTD",$J) after the call, if used.

On return, the array contains corresponding lines of text of the code's
versioned description (field 62)

OUTARR(1) = 1st line of description OUTARR(last) = last line of description
OUTARR(last+1) = blank line OUTARR(last+2) = NOTICE OF TEXTUAL INACCURACY

where last+2 is the value returned by $$CPTD.
DFN Input
Not in use. Added in anticipation of future need.
CDT Input
Code Date to check, Default = Today (FileMan format)
Not in use. Added for future need.
If CDT < 1/1/1989, use 1/1/1989
If CDT > DT, use the 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
$$CODM(CODE,'OUTARR',SRC,CDT,DFN)
Extrinsic function that returns alphabetic array
containing list of all acceptable modifiers for a selected code.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
The CPT, HCPCS, or Level III code in either internal
or external format.
OUTARR Both
An array name in which to store the list of
acceptable modifiers.  If no name is provided, the default name will be
^TMP("ICPTM",$J,

The calling routine is responsible for killing ^TMP("ICPTM",$J)  after the
call, if used.

Array sorted on Modifier (field .01) and containing the Versioned Name (field
#61), and ien of modifier.

OUTARR(<modifier>)= versioned name^ien
SRC Input
Flag to indicate if Level III codes and modifiers
need to be screened out. If SRC=0 or null, Level III codes are not valid input
and Level III modifiers are not valid output; if SRC>0, Level III codes and
modifiers are included.  *Note that all Level III modifiers are currently
INACTIVE, and will be rejected.
CDT Input
Date in Fileman format to check modifier status
against. If CDT=0 or null, both active and inactive modifiers will be included
in the output as acceptable modifiers. If CDT is passed as a date, only
modifiers being active as of this date will be included in the output as
acceptable modifiers.
If CDT < 1/1/1989, use 1/1/1989
If CDT > DT, validate with newest In/Activation Dates
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
DFN Input
Not in use. Included in anticipation of future needs.

$$CODM Output
Number of modifiers in OUTARR(mod name).
or -1^error description      in an error condition
$$MOD(MOD,MFT,MDT,SRC)
Extrinsic function that returns basic information for
MODIFIER

WARNING: Use of the INACTIVE FLAG field (#5) can produce
unpredictable results if the API is not used.
VARIABLES TYPE VARIABLES DESCRIPTION
$$MOD Output
String containing modifier data in "^" pieces:

Piece    Description
=====    ===========
1      internal entry number
2      MODIFIER (.01 field)
3      NAME (.02 field)
4      CODE (.O3 field) alternate 5-digit code for CPT
modifiers
5      SOURCE (.04 field) C:CPT; H:HCPCS; V:VA NATIONAL
6      EFFECTIVE DATE (.01 field of multiple field 60)
7      STATUS (.02 field of multiple field 60)
8      INACTIVE DATE (.01 field of multiple field 60)
9      ACTIVE DATE (.01 field of multiple field 60)
10      NOTICE OF TEXTUAL INACCURACY
MOD Input
MODIFIER (.01 field or ien:  External or ien format)
MFT Input
MOD format where "I" = internal (ien); "E" = external
(.01) Default value is "E".
MDT Input
Date to check modifier status for. Default value is
TODAY.
If MDT < 1/1/1989, use 1/1/1989.
If MDT > DT, validate with newest In/Activation Dates
If MDT is year only, use first of the year
If MDT is year and month only, use first of the month
SRC Input
Flag to indicate if Level III modifiers need to be
screened out If SRC=0 or null, Level III modifiers are not valid input; if
SRC>0, Level III modifiers are accepted.  *Note that all Level III modifiers
are currently INACTIVE, and will be rejected.
$$MODP(CODE,MOD,MFT,MDT,SRC)
Extrinsic function that returns ien value of modifier
if it can be used with code - MODIFIER/CODE pair checker.
VARIABLES TYPE VARIABLES DESCRIPTION
$$MODP Output
If pair not okay, 0. If pair okay, string containing
modifier data in "^" pieces:

Piece    Description
=====    ===========
1      internal entry number
2      NAME (.02 field)
CODE Input
The CPT, HCPCS, or Level III code in either internal
or external format.
MOD Input
MODIFIER (.01 field or ien:  External or ien format)
MFT Input
MOD format where "I" = internal (ien); "E" = external
(.01) Default value is "E".
MDT Input
Date to check modifier status for. Default value is
TODAY.
If MDT < 1/1/1989, use 1/1/1989
If MDT > DT, validate with newest In/Activation Dates
If MDT is year only, use first of the year
If MDT is year and month only, use first of the month
SRC Input
Flag to indicate if Level III codes and modifiers
need to be screened out. If SRC=0 or null, Level III codes and Level III
modifiers are not valid input; if SRC>0, Level III codes and modifiers are
accepted.  *Note that all Level III modifiers are currently INACTIVE, and will
be rejected.
$$CODEN(CODE)
Extrinsic function that returns the ien of a CPT or
HCPCS code
VARIABLES TYPE VARIABLES DESCRIPTION
$$CODEN Output
The Internal Entry Number of the CPT or HCPCS code.
CODE Input
CPT/HCPCS Code   REQUIRED
$$CODEC(CODE)
Extrinsic function that returns the CPT or HCPCS code
of an ien.
VARIABLES TYPE VARIABLES DESCRIPTION
$$CODEC Output
The CPT or HCPCS code.
CODE Input
The Internal Entry Number of the CPT or HCPCS code.