DBIA3799 ICR (3799)

Name

Value

NUMBER

3799

IA #

3799

DATE CREATED

2002/10/23

CUSTODIAL PACKAGE

REGISTRATION

CUSTODIAL ISC

Albany

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DGUTL4

NAME

DBIA3799

GENERAL DESCRIPTION

This integration agreement contains the listing of
supported calls for interaction with the RACE (#10), ETHNICITY (#10.2), and
RACE AND ETHNICITY COLLECTION METHOD (#10.3) files.

Calls supported are:
1) $$PTR2TEXT^DGUTL4(VALUE,TYPE)
2) $$INACTIVE^DGUTL4(VALUE,TYPE)
3) $$PTR2CODE^DGUTL4(VALUE,TYPE,CODE)
4) $$CODE2PTR^DGUTL4(VALUE,TYPE,CODE)

STATUS

Active

KEYWORDS

RACE
ETHNICITY

DGUTL4

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$PTR2TEXT

Function call converts a pointer to the RACE,
ETHNICITY, or RACE AND ETHNICITY COLLECTION METHOD file (numbers 10, 10.2, and
10.3 respectively) into it's displayable name (i.e. .01 field).

Sample Use
----------
S VALUE=xxxxx
S TYPE=1
S X=$$PTR2TEXT^DGUTL4(VALUE,TYPE)
W !,"Entry number ",VALUE," in the RACE file is ",X

VARIABLES

TYPE

VARIABLES DESCRIPTION

VALUE

Input

Pointer to RACE file (#10), ETHNICITY file (#10.2),
or RACE AND ETHNICITY COLLECTION METHOD file (#10.3)

TYPE

Input

Flag indicating which file VALUE is for
1 = Race (default)
2 = Ethnicity
3 = Collection Method

$$PTR2TEXT

Output

Text (.01 field).  NULL ("") returned on bad input or
if there is no code.

$$INACTIVE

Function call returns whether or not a given entry in
the RACE or ETHNICITY file (numbers 10 and 10.2 respectively) is marked as
inactive.

Sample Use
----------
S VALUE=xxxxx
S TYPE=1
S X=$$INACTIVE^DGUTL4(VALUE,TYPE)
W:'X !,"Entry is currently active"
W:X !,"Entry was inactived on ",$$FMTE^XLFDT($P(X,"^",2))

VARIABLES

TYPE

VARIABLES DESCRIPTION

VALUE

Input

Pointer to RACE file (#10) or ETHNICITY file (#10.2)

TYPE

Input

Flag indicating which file VALUE is for
1 = Race (default)
2 = Ethnicity

$$INACTIVE

Output

0 - Entry not inactive
1^Date - Entry inactive (Date in FileMan format)

Note that 0 (zero) returned on bad input and that collection methods can not
currently be inactivated

$$PTR2CODE

Function call converts a pointer to the RACE,
ETHNICITY, or RACE AND ETHNICITY COLLECTION METHOD file (numbers 10, 10.2, and
10.3 respectively) into it's abbreviation, HL7, CDC, or PTF code.

Sample Use
----------
S VALUE=xxxxx
S TYPE=1
S CODE=4
S X=$$PTR2CODE^DGUTL4(VALUE,TYPE,CODE)
S Y=$$PTR2TEXT^DGUTL4(VALUE,TYPE)
W:X'="" !,"The PTF code for ",Y," is ",X
W:X="" !,Y," does not have a PTF code"

VARIABLES	TYPE	VARIABLES DESCRIPTION
VALUE	Input	Pointer to RACE file (#10), ETHNICITY file (#10.2), or RACE AND ETHNICITY COLLECTION METHOD file (#10.3)
TYPE	Input	TYPE - Flag indicating which file VALUE is for 1 = Race (default) 2 = Ethnicity 3 = Collection Method
CODE	Input	Flag indicating which code to return 1 = Abbreviation (default) 2 = HL7 3 = CDC (not applicable for Collection Method) 4 = PTF
$$PTR2CODE	Output	Requested code. NULL ("") returned on bad input or if there is no code.

$$CODE2PTR

Function call converts an abbreviation, HL7, CDC, or
PTF code into a pointer to it's entry in the RACE, ETHNICITY, or RACE AND
ETHNICITY COLLECTION METHOD file (numbers 10, 10.2, and 10.3 respectively).

Sample Use
----------
S VALUE=xxxxx
S TYPE=1
S CODE=4
S X=$$CODE2PTR^DGUTL4(VALUE,TYPE,CODE)
S Y=$$PTR2TEXT^DGUTL4(X,TYPE)
W:X !,VALUE," is the PTF code for ",Y
W:'X !,VALUE," is not a valid PTF code"

VARIABLES	TYPE	VARIABLES DESCRIPTION
VALUE	Input	Code to convert
TYPE	Input	Flag indicating which file VALUE is from 1 = Race (file #10) (default) 2 = Ethnicity (file #10.2) 3 = Collection Method (file #10.3)
CODE	Input	Flag indicating which code VALUE is for 1 = Abbreviation (default) 2 = HL7 3 = CDC (not applicable for Collection Method) 4 = PTF
$$CODE2PTR	Output	Pointer to file. 0 (zero) returned on bad input or if an entry can't be found.