Print Page as PDF
HDI COLLECT SDOS ICR (6894)

HDI COLLECT SDOS    ICR (6894)

Name Value
NUMBER 6894
IA # 6894
DATE CREATED 2018/03/27
CUSTODIAL PACKAGE HEALTH DATA & INFORMATICS
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HDISDOC
NAME HDI COLLECT SDOS
GENERAL DESCRIPTION 
API for collecting Standards Development Organization
(SDO) codes from Laboratory based on items in the ORDERABLE ITEMS File
(#101.43)
STATUS Active
KEYWORDS
  • SDO
  • HDI
ID HDISDOC
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$EN(AREA, TYPE,VALUE, RETURN, ERRARRAY, COUNT) 
Call point for requesting SDO information

Return Values:
0 (zero) or null  no errors.
1 - Area Not Sent.
2 - Lookup Value Not Sent.
3 - Return Value Not Sent.
4 - Improper Search Area.
5 - Single Item Not Found in ORDERABLE ITEMS File 101.43.
6 - Single Item Not in Area.
7 - Partial Lookup Error.
8 - Orderable Items File Does Not Have Lab Pointer for
Item. Can be repeating, should have an entry in
ERRARRY.
9 - Orderable Item Lab Pointer Not Found in Lab File. Can
be repeating, should have an entry in ERRARRY.
12 - Type of Lookup not Sent.

See the HDI Orderable Items SDO Listing User Manual for additional
information.
VARIABLES TYPE VARIABLES DESCRIPTION
AREA Input 
(Required) This indicates which area the lookup is
for. L for Laboratory.
TYPE Input 
(Required) Type of lookup 'S' for Single, 'P' for
Partial Match, 'ALL' for ALL items.
VALUE Input 
(Required) This is the value that will be looked up.
For Single the value will be the IEN of the item in the ORDERABLE ITEMS File
(#101.43). For Partial Match the value will be a name partial match to an
orderable item name in the ORDERABLE ITEMS File (#101.43).  For ALL the value
will be ALL.
RETURN Output 
(Required) Closed Root of the variable where the
found items are returned.
ERRARRAY Output 
(Optional) Reference to a local variable where the
error array (if one) can be returned.
COUNT Output 
(Optional) Reference to a local variable where
various counts that are collected during the lookup process are returned.
DATE ACTIVATED 2018/10/30