Print Page as PDF
CPT Utility APIs ICR (1997)

CPT Utility APIs    ICR (1997)

Name Value
NUMBER 1997
IA # 1997
DATE CREATED 1997/04/08
CUSTODIAL PACKAGE CPT/HCPCS CODES
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ICPTAPIU
NAME CPT Utility APIs
ORIGINAL NUMBER 1995
GENERAL DESCRIPTION
Routine contains supported calls for the CPT package.
These include an extrinsic variable, which returns the Distribution Date, an
extrinsic function that returns the category name for a category ien,
functions to perform Status Checks on codes, to retrieve the Next or Previous
code, and to retrieve the History of code activation/inactivation.

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

Another entry point will display the CPT SIGNON COPYRIGHT MESSAGE to the
calling device.
STATUS Active
KEYWORDS
  • 1995
  • 1997
  • 1996
DURATION Till Otherwise Agreed
ID ICPTAPIU
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
CPTDIST
Extrinsic Variable - returns distribution date of
current release.

S X=$$CPTDIST^ICPTAPIU
VARIABLES TYPE VARIABLES DESCRIPTION
DATE Output
DISTRIBUTION DATE (.02 field of file 81.2)
CAT
Extrinsic function that returns the CATEGORY NAME,
given the internal entry number.

S X=$$CAT^ICPTAPIU(CAT)
VARIABLES TYPE VARIABLES DESCRIPTION
CAT Input
Internal entry number of category.
STR Output
Category name (.01 field) for CAT (file 81.1)

-1^error description returned if error condition.
COPY
D COPY^ICPTAPIU will display the CPT SIGNON COPYRIGHT
MESSAGE to the calling device.
none
$$STATCHK(CODE,CDT)
Extrinsic function that returns the Status of a CPT
Code or Modifier.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
CPT Code or Modifier    REQUIRED
CDT Input
Code Date to check, Default = Today (FileMan format)
If CDT is year only, use first of the year
If CDT is year and month only, use first of the month
If CDT < 1/1/1989, use 1/1/1989
If CDT > DT, validate with newest In/Activation Dates
$$STATCHK Output
String, containing the following information in the
following "^" pieces:

Piece    Description
=====    ===========
1      STATUS where 0:inactive; 1:active
2      IEN of code/modifier, -1 on error
$$NEXT(CODE)
Extrinsic function that returns the Next CPT Code or
Modifier (active or inactive).
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
CPT Code or Modifier    REQUIRED
$$NEXT Output
The Next CPT Code/Modifier, Null if there is none.
$$PREV(CODE)
Extrinsic function that returns the Previous CPT Code
or Modifier (active or inactive).
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
CPT Code or Modifier    REQUIRED
$$PREV Output
The Previous CPT Code/Modifier, Null if there is
none.
$$HIST(CODE,ARY)
Extrinsic function that returns the activation
history of a CPT Code or Code Modifier.
VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
CPT Code or Modifier    REQUIRED
.ARY Both
Array, passed by Reference

ARY (which was passed by reference) is returned as follows: ARY(0) = Number of
Activation History Entries, -1 if error ARY(date) = STATUS where 0:inactive;
1:active
'date' is in FileMan format ARY("IEN") = Internal Entry Number
of CPT code/modifier
$$HIST Output
Number of Activation History Entries, -1 if error
PERIOD(CODE,ARY)
Return Activation/Inactivation Period(s) in ARY

ARY(0) = IEN  (or, -1 if error) ARY(Act_date) = Inactivation Date^Versioned
Short Name Text (field #61)

VARIABLES TYPE VARIABLES DESCRIPTION
CODE Input
CPT  Code or Modifier        REQUIRED
ARY Output
Array, passed by Reference   REQUIRED
CR(.ARY)
This API is used to place the Copyright Infomration
in a Local Array
VARIABLES TYPE VARIABLES DESCRIPTION
.ARY ['Input', 'VARIABLE SEQUENCE NUMBER: 1']
(Required)  Name of Locay Array passed by reference.
ARY ['Output', 'VARIABLE SEQUENCE NUMBER: 2']
Local array containing the CPT Copyright information.

DATE ACTIVATED 2008/09/18