Print Page as PDF
CPT/HCPCS Modifier APIs ICR (1996)

CPT/HCPCS Modifier APIs    ICR (1996)

Name Value
NUMBER 1996
IA # 1996
DATE CREATED 1997/04/08
CUSTODIAL PACKAGE CPT/HCPCS CODES
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ICPTMOD
NAME CPT/HCPCS Modifier APIs
ORIGINAL NUMBER 1995
GENERAL DESCRIPTION
This contains the supported references to routine
ICPTMOD for the supported APIs.  These entry points will retrieve CPT MODIFIER
related data.  All entry points will return '-1^error description' in an error
condition.
STATUS Active
KEYWORDS
  • ICPTMOD
  • MODD
  • 1995
  • 1996
  • 1997
DURATION Till Otherwise Agreed
ID ICPTMOD
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$MOD(MOD,MFT,MDT,SRC,DFN)
Extrinsic function that returns basic information for
MODIFIER.  Returns string of data.  WARNING: Use of the INACTIVE FLAG field
(#5) can produce unpredictable results if the API is not used.
VARIABLES TYPE VARIABLES DESCRIPTION
MOD Input
MODIFIER (.01 field or ien:  External or ien format)
MFT Input
Modifier format where "I"=internal (ien);
"E"=external (.01) Default value is "E"
MDT Input
Date to check modifier status for.
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
$$MOD Output
A "^" delimited string containing the following
pieces:

1  Internal Entry Number (IEN)
2  MODIFIER (.01 field)
3  NAME (Versioned Name from multiple field 61)
4  CODE (.O3 field) alt. 5-digit code for CPT modifiers
5  SOURCE (.04 field) C:CPT; H:HCPCS; V:VA NATIONAL
6  EFFECTIVE DATE (from multiple field 60)
7  STATUS (.02 field of multiple field 60)

SRC Input
If 0 or Null, check national (level 1, level 2) mods
only If SRC>0, include VA modifiers
DFN Input
$$MODP(CODE,MOD,MFT,MDT,SRC,DFN)
Extrinsic function that returns ien value of modifier
if it can be used with code - MODIFIER/CODE pair checker.  Returns ien of MOD
if acceptable pair, 0 if not.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
The CPT or HCPCS code in either internal or external
format.
MOD Input
MODIFIER (.01 field or ien:  External or ien format)
MFT Input
Modifier format where "I"=internal (ien);
"E"=external (.01) Default value is "E"
MDT Input
Date to check modifier status for.
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
$$MODP Output
If pair is acceptable:    IEN^Versioned Name (from 61
multiple) If pair is unacceptable:  0 or                       -1^error
message
SRC Input
If 0 or Null, check national (level 1, level 2) mods
only If SRC>0, include VA modifiers
$$MODD(CODE,OUTARR,DFN,CDT)
Returns an array of text containing the versioned
Modifier description.
VARIABLES TYPE VARIABLES DESCRIPTION
$$MODD Output
Returns the number of lines of text in the versioned
description or '-1^error message' if there is no versioned description.
CODE Input
This is either a CPT/HCPCS Modifier code (external,
field .01) or an Internal Entry Number (IEN) of the CPT Modifier file #81.3.
OUTARR Both
This is an array name in which to store the returned
versioned description of the Modifier - e.g. "ABC" or "ABC("TEST")" or temp
array.  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 Modifier's
versioned description (field 62)

ARRAY(1) = 1st line of description
ARRAY(last) = last line of description
ARRAY(last+1) = blank line
ARRAY(last+2) = NOTICE OF TEXTUAL INACCURACY
where last+2 is the value returned by $$MODD.

DFN Input
Future use.
CDT Input
Code Set Versioning date - active as of date in
Fileman Format, default = today (FM)

If CDT < 2890101, use 2890101
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
MODA(CODE,DATE,.ARY)
This entry point builds a list of Active and Inactive
CPT Modifiers that are used in conjunction with a CPT code.  The determination
of the status of Active versus Inactive is made based on a date provided
(default TODAY).  The list is placed in a local array passed by reference.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE ['Input', 'VARIABLE SEQUENCE NUMBER: 1']
(Required) This is a CPT CODE.
DATE ['Input', 'VARIABLE SEQUENCE NUMBER: 2']
(Required) This is the date to use for retrieving the
list of CPT Modifiers and determine if the relationship between the CPT code
and the CPT Modifier is Active or Inactive.  The default value for this date
is TODAY.
.ARY ['Input', 'VARIABLE SEQUENCE NUMBER: 3']
(Required) Input array passed by reference.
ARY Output
This is an array of Active and Inactive CPT Modifiers
for a CPT code in the following format:

ARY(0) = 4 Piece String
1   # of Modifiers found for code CODE (input)
2   # of Modifiers w/Active Ranges
3   # of Modifiers w/Inactive Ranges
4   Code

ARY(ST,MOD) = 8 Piece Output String

ST   Status   A=Active  I=Inactive
MOD  Modifier  (external format)

8 Piece String
1   IEN of Modifier
2   Versioned Short Text (name)
3   Activation date of Modifier
4   Beginning Range Code
5   Ending Range Code
6   Activation Date of Range
7   Inactivation Date of Range
8   Modifier Identifier
DATE ACTIVATED 2008/09/18