CLINICAL REMINDER TEXT FORMATTING APIs ICR (6935)

Name

Value

NUMBER

6935

IA #

6935

DATE CREATED

2018/06/22

CUSTODIAL PACKAGE

CLINICAL REMINDERS

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXRMTEXT

NAME

CLINICAL REMINDER TEXT FORMATTING APIs

GENERAL DESCRIPTION

Clinical Reminders has a set of text formatting APIs,
this ICR allows other packages to use that functionality.

Revision History:
05/08/2024 Added the component FORMAT, available with PXRM*2.0*67. ORDER
ENTRY/RESULTS REPORTING was added as a subscriber, effective with
OR*3.0*508.

STATUS

Active

KEYWORDS

List Manager
Text Formatting Utilities

DURATION

Till Otherwise Agreed

PXRMTEXT

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

COLFMT

This entry point is a 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. For example, 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	The text string to be formatted, the text for each column is separated by "^".
PC	Input	This is the character used to 'pad' the text so it fills the width of the column. Typically, this is the space character.
NL	Output	This is the number of lines of formatted text returned in OUTPUT; passed by reference.
OUTPUT	Output	An array containing the columnar formatted output text; passed by reference.

FORMATS

This API formats 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; passed by reference.
TEXTOUT	Output	This array contains the formatted text; passed by reference.

LMFMTSTR

This entry point builds a columnar format string
using the List Manager variable VALMDDF.

Usage: S FMTSTR=$$LMFMTSTR^PXRMTEXT(VALMDDF,JSTR)

VARIABLES

TYPE

VARIABLES DESCRIPTION

VALMDDF

Input

The List Manager variable VALMDDF contains the list
template column formatting information. The structure is: VALMDDF(COLUMN
NAME)=COLUMN NAME^COLUMN^WIDTH^CAPTION ^VIDEO^SCROLL LOCK. COLUMN is the
starting column and WIDTH is the column width.

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.

FORMAT

This API formats the array of text in TEXTIN so that
each formatted line has a left margin of LM and a right margin of RM. The
formatted text is in TEXTOUT. "\\" is the end of line marker.  Lines ending
with "\\" will not have anything appended to them. A blank line can be created
with a line containing just "\\". Lines containing nothing but whitespace will
also act like a "\\".

Usage: D FORMAT(LM,RM,NIN,.TEXTIN,.NOUT,.TEXTOUT)

VARIABLES	TYPE	VARIABLES DESCRIPTION
LM	Input	The left margin.
RM	Input	The right margin.
NIN	Input	The number of lines of text in TEXTIN.
TEXTIN	Input	An array containing the lines of text to be formatted; passed by reference.
NOUT	Output	The number of formatted lines in TEXTOUT; passed by reference.
TEXTOUT	Output	An array containing the formatted text; passed by reference.

SUBSCRIBING PACKAGE

SUBSCRIBING DETAILS

PCE PATIENT CARE ENCOUNTER

Patch PX*1*211 creates integrated management utilities
for Education Topics, Exams, and Health Factors. These are based on the model
of the management utility that was developed for Clinical Reminders
Taxonomies.  Because they follow the same model that was used for Taxonomies,
they need the same text formatting utilities. This ICR allows PCE to use those
utilities promoting code reuse.

ORDER ENTRY/RESULTS REPORTING

Added 5/6/24, effective with OR*3.0*508. OE/RR needs
access to the Clinical Reminders Text Formatting tools to correctly format the
detail text in the CPRS Information Panel functionality.

DATE ACTIVATED

2018/06/26