Print Page as PDF
APIs in TIULS ICR (4174)

APIs in TIULS    ICR (4174)

Name Value
NUMBER 4174
IA # 4174
DATE CREATED 2003/08/04
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE TIULS
NAME APIs in TIULS
GENERAL DESCRIPTION
This DBIA documents calls to the routine TIULS that can
be re-used by subscribing applications.
STATUS Active
KEYWORDS WRAP
DURATION Till Otherwise Agreed
ID TIULS
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
NAME
This extrinsic function parses and returns person's
names as specified in a format string.
VARIABLES TYPE VARIABLES DESCRIPTION
X Input
This is the person's name in the default format
<last>,<first> <middle>.
FMT Input
This is the format string that determines how the
name will be formatted.

Allowable patterns include:

LAST  = Family (Last) Name FIRST = Given (First) Name LI    = Last Initial FI
= First Initial MI    = Middle Initial

in any combination. Other characters or strings will be treated as delimiters.

Annotated examples of use:
==========================

In all cases, the input string X will be "WINCHESTER,CHARLES EMERSON III"

a. To format the result as <first name> <middle initial>. <last name> the
format string may be passed as "FIRST MI. LAST" as shown below:

W $$NAME^TIULS(X,"FIRST MI LAST")

returns the result:

CHARLES E. WINCHESTER

b. To format the result as <last name>, <first initial>.<middle initial>.  the
format string may be passed as "LAST, FI.MI." as shown below:

W $$NAME^TIULS(X,"LAST, FI.MI.")

returns the result:

WINCHESTER, C.E.

c. To format the result as <first name> the great physician <last name>! the
format string may be passed as "FIRST the great physician LAST!" as shown
below:

W $$NAME^TIULS(X,"FIRST the great physician LAST!")

returns the result:

CHARLES the great physician WINCHESTER!
DATE
This extrinsic function parses and returns dates (and
times) as specified in a format string.
VARIABLES TYPE VARIABLES DESCRIPTION
X Input
This is a FileMan formatted date [with optional time]
following the pattern YYYMMDD.HHMMSS (e.g., 3030801.161845 would represent AUG
01, 2003@16:18:45).
FMT Input
This is the format string that determines how the
date will be formatted.

Allowable patterns include:

[Date Format String] (which has these components):
AMTH = Alphabetic Month
MM   = two-digit numeric Month
DD   = two-digit numeric Day of Month
CC   = two-digit numeric Century
YY   = two-digit numeric Year [Time Format String] (which has these
components):
HR   = two-digit numeric hour
MIN  = two-digit numeric minute
SEC  = two-digit numeric second

in any combination. Other characters or strings will be treated as delimiters.

NOTE: The time format string currently MUST include the "HR" tag in order to
behave appropriately (i.e., the "MIN" or "SEC" tags, alone or in combination,
without including the "HR" tag, won't be replaced with their appropriate
numeric values). This is a newly discovered bug that should be corrected in a
future patch.

Annotated examples of use:
==========================

In all cases, the input date X will be 3030801.161845

a. To format the result as 08/01/03@16:18 the format string may be passed as
"MM/DD/YY@HR:MIN" as shown below:

W $$DATE^TIULS(X,"MM/DD/YY@HR:MIN")

returns the result:

08/01/03@16:18

b. To format the result as 01 AUG 2003 the format string may be passed as "DD
AMTH CCYY" as shown below:

W $$DATE^TIULS(X,"DD AMTH CCYY")

returns the result:

01 AUG 2003

c. To format the result as 20030801161845, the format string may be passed as
"CCYYMMDDHRMINSEC" as shown below:

W $$DATE^TIULS(X,"CCYYMMDDHRMINSEC")

returns the result:

20030801161845
WRAP
The purpose of this component is to break a text
string into substrings of a specified length.
VARIABLES TYPE VARIABLES DESCRIPTION
TEXT Input
This is the text string that the subroutine will
break into substrings.
LENGTH Input
The length that should be used to create the
substrings. In other words, what's the maximum length of each substring.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
HEALTHEVET DESKTOP Salt Lake City
ORDER ENTRY/RESULTS REPORTING
DATE ACTIVATED 2023/05/18