GENERAL DESCRIPTION |
This ICR will be retired upon ICD10 Implementation
(retire action estimated to occur April 1,2016). New development efforts
should use ICR 5747.
This contains the references to routine ICDAPIU for the supported APIs to be
released with v.20.0 of ICD.
These include extrinsic functions for retieving Code History, performing
Status checks, retrieving Next/Previous Codes, retrieving Dates based on the
Business Rules, and retrieving a notice of a code's textual inaccuracy.
|
COMPONENT/ENTRY POINT |
COMPONENT/ENTRY POINT |
COMPONENT DESCRIPTION |
VARIABLES |
$$STATCHK(CODE,CDT) |
Extrinsic function that returns the Status of an ICD
Code.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
CODE |
Input |
ICD Code REQUIRED
|
CDT |
Input |
Code Date to check, Default = Today (FileMan format)
If CDT < 10/1/1978, use 10/1/1978.
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
|
$$STATCHK |
Output |
String, containing the following information in the
following "^" pieces:
Piece Description
===== ===========
1 STATUS where 1:active; 0:inactive
2 IEN of code, -1 if not found
|
|
$$NEXT(CODE) |
Extrinsic function that returns the Next ICD Code
(active or inactive)
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
CODE |
Input |
ICD Code REQUIRED
|
$$NEXT |
Output |
The Next ICD Code, Null if there is none.
|
|
$$PREV(CODE) |
Extrinsic function that returns the Previous ICD Code
(active or inactive)
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
CODE |
Input |
ICD Code REQUIRED
|
$$PREV |
Output |
The Previous ICD Code, Null if there is none.
|
|
$$HIST(CODE,ARY) |
Extrinsic function that returns the activation
history of an ICD Code.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
CODE |
Input |
ICD Code REQUIRED
|
.ARY |
Both |
Array, passed by Reference
ARY (which was passed by reference) is returned as follows: ARY(0) = number of
history entries, -1 if error ARY(date) = STATUS where 1:active; 0:inactive
'date' is in FileMan format ARY("IEN") = Internal Entry Number
of ICD Code
|
$$HIST |
Output |
The number of activation history entries are
returned, -1 if error
|
|
$$DTBR(CDT,CS) |
Extrinsic function that returns a date after applying
several Business Rules, depending on the Coding System.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
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
|
CS |
Input |
Code System (0:ICD, 1:CPT/HCPCS, 2:DRG, Default=0)
|
$$DTBR |
Output |
If CDT < 10/1/1978 and CS=0, return 10/1/1978 If CDT
< 1/1/1989 and CS=1, return 1/1/1989 If CDT < 10/1/1982 and CS=2, return
10/1/1982 Otherwise, return CDT
|
|
$$MSG(CDT,CS) |
Extrinsic function that returns a message to inform
someone that the code text may be inaccurate.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
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
|
CS |
Input |
Code System (0:ICD, 1:CPT/HCPCS, 2:DRG, 3:LEX,
Default=0)
|
$$MSG |
Output |
A warning stating: "CODE TEXT MAY BE INACCURATE"
|
|
PERIOD(CODE,ARY) |
Funtion that returns Activation/Inactivation Period
in ARY
ARY(0) = IEN (or, -1 if error) ARY(Act_date) = Inactivation Date^Versioned
Short Name Text (field #67)
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
COD |
Input |
ICD Code REQUIRED
|
ARY |
Output |
Array, passed by Reference REQUIRED
|
|
|