Print Page as PDF
HS Components-PDX Segments ICR (1023)

HS Components-PDX Segments    ICR (1023)

Name Value
NUMBER 1023
IA # 1023
DATE CREATED 1994/10/13
CUSTODIAL PACKAGE PATIENT DATA EXCHANGE
CUSTODIAL ISC Albany
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VAQUTL50
NAME HS Components-PDX Segments
GENERAL DESCRIPTION 

As the Health Summary package adds new components to the HEALTH SUMMARY
COMPONENT file (#142.1), it will also add those components to PDX's
VAQ - DATA SEGMENT file (#394.71).

At this time, Health Summary will only add those components that do not
have selection items.

Health Summary will use the entry point $$ADDSEG^VAQUTL50() to add its
components to the VAQ - DATA SEGMENT file and will use the entry point
$$UPDSEG^VAQUTL50() to update the VAQ - DATA SEGMENT file entries when
the corresponding component is modified.  Health Summary will also use
the entry point $$FIRSTUP^VAQUTL50() to check that the component name is
in the uppercase/lowercase naming convention used by PDX.

As new components are made available to the PDX users, those components
will be added to DBIA297-E (816).

Revision History:
06/01/2023 - Effective with VAQ*1.5*46 and GMTS*2.7*144:
Added new component $$UPDSEG
Corrected component $$ADDSEG to reflect how released code
works
STATUS Active
DURATION Till Otherwise Agreed
ID VAQUTL50
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$FIRSTUP(TEXT) 
This component will convert a string so that the
first letter of every word is uppercase and the remaining characters in the
word are lowercase.
VARIABLES TYPE VARIABLES DESCRIPTION
TEXT Input 
String to convert
$$FIRSTUP Output 
Passed-in string with the first letter of every word
in uppercase and the remaining letters in lowercase.
$$ADDSEG(HSPTR,MAXTIME,MAXOCCUR) 
This component will add a new data segment given a
Health Summary component.

NOTES  : If time and/or occurrence limits do not apply to
the component, MAXTIME and/or MAXOCCUR are not
required.
: If time and/or occurrence limits apply to the
component, default values will be taken from the
VAQ - PARAMETER file (#394.81).  If parameter file
does not contain these values, a default of 1 year
and 10 occurrences will be used.
: If a maximum limit is not valid, the default limit
will be used.
VARIABLES TYPE VARIABLES DESCRIPTION
HSPTR Input 
Pointer to HEALTH SUMMARY COMPONENT file (#142.1)
MAXTIME Input 
Max time limit allowed for auto processing
MAXOCCUR Input 
Max occurrence limit allowed for auto processing
$$ADDSEG Output 
0 - VAQ - DATA SEGMENT file (#394.71) entry was
successfully added

-1^Error_Text - Entry not created
$$UPDSEG(VAQHSPTR,VAQMAXTIME,VAQMAXOCCUR) 
This component will update an existing data segment
to match the Health Summary component passed in, such as a change in name.

NOTES  : If time and/or occurrence limits do not apply to
the component, MAXTIME and/or MAXOCCUR are not
required.
: If time and/or occurrence limits apply to the
component, default values will be taken from the
VAQ - PARAMETER file (#394.81).  If parameter file
does not contain these values, a default of 1 year
and 10 occurrences will be used.
: If a maximum limit is not valid, the default limit
will be used.
VARIABLES TYPE VARIABLES DESCRIPTION
VAQHSPTR Input 
Pointer to the HEALTH SUMMARY COMPONENT file (#142.1)
VAQMAXTIME Input 
Max time limit allowed for auto processing
VAQMAXOCCUR Input 
Max occurrence limit allowed for auto processing
$$UPDSEG Output 
0 - VAQ - DATA SEGMENT file (#394.71) entry was
successfully updated

-1^Error_Text - Entry not updated
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
HEALTH SUMMARY Salt Lake City
DATE ACTIVATED 2023/06/09