HLO DATA TYPE PARSERS ICR (4852)

Name

Value

NUMBER

4852

IA #

4852

DATE CREATED

2006/06/05

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOPRS2

NAME

HLO DATA TYPE PARSERS

GENERAL DESCRIPTION

This provides specialized APIs for parsing HL7 data
types from a segment.  It applies only to HL7 messages received via the HLO
software that was released in patch HL*1.6*126.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOPRS2

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

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

Gets a segment value that is a time stamp in HL7
format and converts it to FileMan format. IF the data type value includes the
time zone then the time is converted to local time. The degree of precision is
optionally returned.  IF the component is specified, then the component is
parsed for data type rather than at the higher field level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass by reference) The array returned by a call to $$NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	The occurrence # (optional, defaults to 1). For a non-repeating field, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference IF subscripts are used) The date/time in FileMan format. The PRECISION subscript is optional, if provided the time stamp's precision will be determined. "PRECISION" - (optional) Expected values are: "S" - second "M" - minute "H" - hour "D" - day "L" - month "Y" - year "" - precision not specified Note: FM does not allow greater precision than seconds, so greater precision will be rounded down to the second.

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

Gets a segment value that is a date in HL7 format and
converts it to FileMan format. The degree of precision is optionally returned.

IF the component is specified, then the component is parsed for data type
rather than at the higher field level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass by reference) The array returned by a call to $$NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	(optional, defaults to 1) The occurrence#. For a non-repeating fields, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference if the precisoin is needed) The date/time in FileMan format. The "PRECISION" subscript is also returned: "PRECISION" Expected values are: "S" - second (not valid for DT) "M" - minute (not valid for DT) "H" - hour (not valid for DT) "D" - day "L" - month "Y" - year "" - precision not specified

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

Gets an CE data type(Coded Element, HL7 Section Reference 2.9.8)from
the
specified field.  IF the component is specified, then the component is
parsed for data type rather than at the higher field level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass-by-reference) The array returned by a call to NEXTSEG^HLOPRS.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
FIELD	Input	(required) The sequence # of the field.
REP	Input	The occurrence # (optional, defaults to 1). For a non-repeating fields, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference) These subscripts are returned: "ID" - the identifier "TEXT" - "SYSTEM" - name of the code system "ALTERNATE ID" - alternate identifier "ALTERNATE TEXT" "ALTERNATE SYSTEM" - name of the alternate coding system

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

Gets an HD data type (Hierarchic Designator, HL7 Section Reference
2.9.21) from the specified field.  IF the component is specified, then
the component is parsed for data type rather than at the higher field
level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass-by-reference) The array returned by a call to NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	(optional, defaults to 1) The occurrence #. For a non-repeating fields, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference) These subscripts are returned: "NAMESPACE ID" "UNIVERSAL ID" "UNIVERSAL ID TYPE"

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

Gets an CNE data type (Coded With No Exceptions, HL7 Section
Reference 2.9.8) from the specified field.  IF the component is
specified, then the component is parsed for data type rather than at
the
higher field level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass-by-reference) The array returned by a call to NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	(optional, defaults to 1) The occurrence #. For a non-repeating fields, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference) These subscripts are returned: "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"

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

Gets an CWE data type (Coded With Exceptions, HL7 Section
Reference 2.9.11) from the specified field.  .  IF the component is
specified, then the component is parsed for data type rather than at
the
higher field level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass-by-reference) The array returned by a call to NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	(optional, defaults to 1) The occurrence #. For a non-repeating fields, this parameter is not necessary.
VALUE	Output	VALUE (required, pass-by-reference) These subscripts are returned: "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"

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

Gets an AD data type (Address, HL7 Section Reference 2.9.1) from the
specified field. It can also be used to get the 1st 8 components of the
XAD (Extended Address) data type.  IF the component is specified, then
the component is parsed for the address rather than at the higher field
level.

VARIABLES	TYPE	VARIABLES DESCRIPTION
SEG	Input	(required, pass-by-reference) The array returned by a call to NEXTSEG^HLOPRS.
FIELD	Input	(required) The sequence # of the field.
COMP	Input	(optional) If specified, the data type is parsed as a component value.
REP	Input	(optional, defaults to 1) The occurrence #. For a non-repeating fields, this parameter is not necessary.
VALUE	Output	(required, pass-by-reference) These subscripts are returned: "STREET1" -street address "STREET2" - other designation "CITY" "STATE" - state or province "ZIP" - zip or postal code "COUNTRY" "TYPE" - address type "OTHER" - other geographic designation