Print Page as PDF
UCUM CODES APIs ICR (6225)

UCUM CODES APIs    ICR (6225)

Name Value
NUMBER 6225
IA # 6225
DATE CREATED 2015/08/26
CUSTODIAL PACKAGE LEXICON UTILITY
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE LEXMUCUM
NAME UCUM CODES APIs
GENERAL DESCRIPTION
This ICR works in conjunction with ICR #6224 to allow
packages to use UCUM Codes for storing measurements.

STATUS Active
KEYWORDS UCUM CODES APIs
ID LEXMUCUM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
UCUMCODES
Given the internal entry number (IEN) of an entry
from the UCUM CODES file, #757.5, this entry point returns the UCUM Code.
Usage:

$$UCUMCODE^LEXMUCUM(IEN)

VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
This is the internal entry number of an entry from
file #757.5.

UCUMDATA
Given an identifier, which can be the internal entry
number (IEN), the Description, or the UCUM Code this API returns the
associated data for the entry. Usage:

D UCUMDATA^LEXMUCUM(IDEN,.UCUMDATA)

VARIABLES TYPE VARIABLES DESCRIPTION
IDEN Input
IDEN identifies the entry from the UCUM Codes file,
#757.5, for which to return the associated data. IDEN can be an internal entry
number, a Description, or a UCUM Code.

UCUMDATA Output
UCUMDATA is an array, passed by reference, that
contains the data associated with the identified entry from the UCUM Codes
file #757.5.  The elements of the array are:

UCUMDATA(IEN,"COMMENTS") - Comments, if there are any

UCUMDATA(IEN,"DESCRIPTION") - Description

UCUMDATA(IEN,"IEN") - The internal entry number

UCUMDATA(IEN,"ROW") - The row number, from the Table of Examples of UCUM codes
for  Electronic Messaging - Version 1.3, on which this entry is found. It can
be used to identify the entry to the developers of this table.

UCUMDATA(IEN,"UCUM CODE") - The UCUM Code


VERSION
This API returns the version information for the UCUM
CODES file, #757.5. Usage:

D VERSION^LEXMUCUM(.VERDATA)

VARIABLES TYPE VARIABLES DESCRIPTION
VERDATA Output
This array, passed by reference, contains the version
information.

VERDATA("DATE") - The release date of this version

VERDATA("NAME") - The name of this version

VERDATA("VERSION") - The version identification

SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
CLINICAL REMINDERS
PCE PATIENT CARE ENCOUNTER
HEALTH SUMMARY
Effective with GMTS*2.7*122, to allow display of an
enterprise standard units of measure for Education Topics, Exams, and Health
Factors.
DATE ACTIVATED 2015/09/02