Print Page as PDF
HLO BUILDING MESSAGES WITH DATA TYPES ICR (4853)

HLO BUILDING MESSAGES WITH DATA TYPES    ICR (4853)

Name Value
NUMBER 4853
IA # 4853
DATE CREATED 2006/06/05
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLOAPI4
NAME HLO BUILDING MESSAGES WITH DATA TYPES
GENERAL DESCRIPTION
This provides specialized APIs for buiding messages
with HL7 data types.  It applies only to HL7 messages received via the HLO
software that was released in patch HL*1.6*126.

STATUS Active
KEYWORDS
  • HLOAPI4
  • MAG HLOAPI4
DURATION Till Otherwise Agreed
ID HLOAPI4
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SETTS(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is a time stamp in FM format into the segment in HL7
format. The degree of precision may be optionally specified. The
inserted value will include the timezone if the input included the
time.
IF the component is specified, then the data type is 'demoted' to a
component, and its components are 'demoted' to subcomponents.


VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass by reference) The segment that is
being built.

FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

VALUE Input
(required, pass-by-reference to also pass the the
"PRECISION" subscript) The date/time in FileMan format.  You can optionally
specify that the value is to be rounded down to a particular precision by
specifying this subscript:
"PRECISION" -  Allowed values are:
"S" - second
"M" - minute
"H" - hour
"D" - day
"L" - month
"Y" - year
"" - precision not specified


SETDT(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is a date in FM format into the segment in HL7
format.
The degree of precision may be optionally specified.  IF the component
is specified, then the data type is 'demoted' to a component, and its
components are 'demoted' to subcomponents.

VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass by reference) The segment that is
being built.

VALUE Input
(required) The date to be set into the segment.
Optionally, you may specify that the value should be rounded down to a
particular precision by specifying this subscript:
"PRECISION" (If needed, VALUE must be passed by reference.)
Allowed values are:

"D" - day (default value)
"L" - month
"Y" - year


FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETCE(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is an HL7 Coded Element data type (HL7 Section
Reference 2.9.3) into the segment in the specified field.  IF the
component is specified, then the data type is 'demoted' to a component,
and its components are 'demoted' to subcomponents.

VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass-by-reference) The segment that is
being built.

VALUE Input
(required, pass-by-reference) These subscripts may be
passed:
"ID" - the identifier
"TEXT" -
"SYSTEM" - name of the code system
"ALTERNATE ID" - alternate identifier
"ALTERNATE TEXT"
"ALTERNATE SYSTEM" - name of the alternate coding system

FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETHD(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is an HL7 Hierarchic Designator data type (HL7
Section
Reference 2.9.21) into the segment in the specified field.  IF the
component is specified, then the data type is 'demoted' to a component,
and its components are 'demoted' to subcomponents.

VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass-by-reference) The array where the
segment is being built.

VALUE Input
(required, pass-by-reference) These subscripts may be
passed:
"NAMESPACE ID"
"UNIVERSAL ID"
"UNIVERSAL ID TYPE"

FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETCNE(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is an HL7 Coded With No Exceptions  data type (HL7
Section Reference 2.9.8) into the segment in the specified field.  IF
the
component is specified, then the data type is 'demoted' to a component,
and its components are 'demoted' to subcomponents.


VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass-by-reference) The array where the
segment is being built.

VALUE Input
(required, pass-by-reference) These subscripts may be
passed:
"ID" - the identifier
"TEXT" -
"SYSTEM" - name of the code system
"ALTERNATE ID" - alternate identifier
"ALTERNATE TEXT"
"ALTERNATE SYSTEM" - name of the alternate coding system
"SYSTEM VERSION" - version ID of the coding system
"ALTERNATE SYSTEM VERSION" - version ID of the alternate coding
system
"ORIGINAL TEXT"


FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETCWE(.SEG,.VALUE,FIELD,COMP,REP)

Sets a value that is an HL7 Coded With Exceptions  data type (HL7
Section
Reference 2.9.11) into the segment in the specified field.  IF the
component is specified, then the data type is 'demoted' to a component,
and its components are 'demoted' to subcomponents.


VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass-by-reference) The array where the
segment is being built.

VALUE Input
(required, pass-by-reference) These subscripts may be
passed:
"ID" - the identifier
"TEXT" -
"SYSTEM" - name of the code system
"ALTERNATE ID" - alternate identifier
"ALTERNATE TEXT"
"ALTERNATE SYSTEM" - name of the alternate coding system
"SYSTEM VERSION" - version ID of the coding system
"ALTERNATE SYSTEM VERSION" - version ID of the alternate coding
system
"ORIGINAL TEXT"


FIELD Input
(required) The sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETAD(.SEG,.VALUE,FIELD,COMP,REP)

Sets an AD data type (Address, HL7 Section Reference 2.9.1) into the
segment in the specified field. It can also be used to set the 1st 8
components of the XAD (Extended Address) data type.  IF the component is
specified, then the data type is 'demoted' to a component, and its
components are 'demoted' to subcomponents.

VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
(required, pass-by-reference) The array where the
segment is being built.

VALUE Input
(required, pass-by-reference) These subscripts may be
passed:
"STREET1" -street address
"STREET2" - other designation
"CITY"
"STATE" - state or province
"ZIP" - zip or postal code
"COUNTRY"
"TYPE"  - address type
"OTHER" - other geographic designation

FIELD Input
(required) the sequence # of the field.

COMP Input
(optional) If specified, the data type is 'demoted'
to a component value.

REP Input
(optional, defaults to 1) The occurrence #.  For a
non-repeating fields, this parameter is not necessary.

SETXPN(.SEG,.VALUE,FIELD,COMP,REP)
Sets an XPN data type (extended person name) into the
segment in the specified field. If the component is specified, then the data
type is 'demoted' to a component, and its components are 'demoted' to
subcomponents.
VARIABLES TYPE VARIABLES DESCRIPTION
SEG Both
The array of the segment being built and returned.

(required, pass by reference)
VALUE Input
VALUE is a subscripted array. The following
subscripts can be passed:
"FAMILY"
"GIVEN" first name
"SECOND" second and further names or initials
"SUFFIX" (e.g., JR)
"PREFIX" (e.g., DR)
"DEGREE" (e.g., MD)

(required, pass-by-reference)
FIELD Input
The sequence number of the field.

(required)
COMP Input
If specified, the data type is 'demoted' to a
component value.

(optional)
REP Input
The occurrence number. For non-repeating fields, this
parameter is not necessary.

(optional, defaults to 1)
CREATOR CEBELINSKI,GREGORY
DBA Comments
1/12/15-MM:  Opened ICR #4853 for editing.  Greg will be
adding the SETXPN entry point as a new component to the ICR.  SETXPN is the
only entry point in the HLOAPI4 routine that is not included in the ICR.
Imaging, VistA Maintenance, Product Support, Imaging and Message Administrator
agreed with resolution to add additional entry to the supported ICR.

1/22/15-MM:  Greg added SETXPN entry point and ICR has been reactivated.
DATE ACTIVATED 2015/01/22
MAIL MESSAGE 43332130
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2015/01/12 16:08 DEACTIVATED FOR EDITS CEBELINSKI,GREG ADES,ROBERT
2015/01/22 11:16 APPROVED CEBELINSKI,GREG ADES,ROBERT
Generated from JAN 24, 2019@ IA Listing Descriptions