Print Page as PDF
CLINICAL REMINDER TEXT UTILITY APIs ICR (7459)

CLINICAL REMINDER TEXT UTILITY APIs    ICR (7459)

Name Value
NUMBER 7459
IA # 7459
DATE CREATED 2024/03/25
CUSTODIAL PACKAGE CLINICAL REMINDERS
USAGE Private
TYPE Routine
ROUTINE PXRMTEXT
NAME CLINICAL REMINDER TEXT UTILITY APIs
STATUS Pending
KEYWORDS
  • CLINICAL REMINDERS
  • TEXT UTILITIES
  • API
DURATION Till Otherwise Agreed
ID PXRMTEXT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
COLFMT
Columnar text formatter.

Usage:
D COLFMT^PXRMTEXT(FMTSTR,TEXTSTR,PC,.NL,.OUTPUT)
VARIABLES TYPE VARIABLES DESCRIPTION
FMTSTR Input
Format string - ^ separated string for each column in
the output. 35R2 defines a right justified column 35 characters wide with 2
blank spaces following. Columns can be centered (C) left justified (L) or
right justified (R).
TEXTSTR Input
Text string to be formatted, text for each column is
separated by "^".
PC Input
The pad character. If the number of characters for a
column in TEXTSTR does not fill the full width of the column this is the
character used to "pad" the text so it fills the column. Typically, this
character is space: ASCII 32.
NL Output
The number of lines of formatted output.
OUTPUT Output
An array containing the columnar formatted output
text.
FORMATS
Format a single line of text.

Usage:
D FORMATS^PXRMTEXT(LM,RM,TEXTLINE,.NOUT,.TEXTOUT)
VARIABLES TYPE VARIABLES DESCRIPTION
LM Input
The left margin.
RM Input
The right margin.
TEXTLINE Input
The single line of text to be formatted.
NOUT Output
The number of lines of formatted text.
TEXTOUT Output
An array containing the formatted text.
LMFMTSTR
The List Manager variable VALMDDF contains the list
template caption column formatting information. It contains the starting
column and the width in the form VALMDDF(COLUMN NAME)=COLUMN
NAME^COLUMN^WIDTH^CAPTION^VIDEO^SCROLL LOCK.

This information is used to build the format string (FMTSTR) for the column
formatter COLFMT^PXRMTEXT.

Usage:
S FMTSTR=$$LMFMTSTR^PXRMTEXT(VALMDDF,JSTR)
VARIABLES TYPE VARIABLES DESCRIPTION
VALMDDF Input
The List Manager variable VALMDDF contains the list
template caption column formatting information. It contains the starting
column and the width in the form VALMDDF(COLUMN NAME)=COLUMN
NAME^COLUMN^WIDTH^CAPTION^VIDEO^SCROLL LOCK.
JSTR Input
A string specifying the justification for each
column. There is one character for each column. The characters can be: L=left,
C=center, and R=right. The default is center.

The string "RLLLL" specifies column 1 is right justified and columns 2-5 are
left justified.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
PCE PATIENT CARE ENCOUNTER
PCE EDUCATION TOPIC, EXAM, and HEALTH FACTOR management
requires the ability to format and display text. Examples include building and
formatting text arrays for use in List Manager. The APIs in this ICR
facilitate that.