org.vmdb.hl7
Class OBXSegment

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Segment
              |
              +--org.vmdb.hl7.OBXSegment

public class OBXSegment

extends HL7Segment

Observation/Result (OBX) Segment.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a visit summary report. The OBX segment identifies the specific type of observation result being reported (OBX-3) and the specific value of the observation (OBX-5).

Reporting to the VMDB focuses on OBX-3 and OBX-5 as the most informative elements of the message and thus, full effort should be made to make OBX-3 and OBX-5 as valid and unambiguous as possible. Because of its flexible nature, observations of nearly all types can be transmitted through a series of OBX segments. Because each segment identifies a separate unique value for an observation type-observation value pair, there is no limit to the number of observations that may be transmitted in a single ORU message. For VMDB reporting a minimum of one diagnosis OBX segment is required.

See HL7 Standard Chapter 7 for details.

Constructor Summary

OBXSegment()
Construct an empty observation result segment.

OBXSegment(HL7SegmentContainer msgParent)
Construct an empty observation result segment, setting its containing message object.

Method Summary

CEElement	getObservationIdentifier() Get the observation identifier as a CEElement.
HL7Element	getObservationValue() Get the observation value as base class HL7Element
java.lang.String	getObservationValueType() Get the HL7 data type of OBX.5.
java.lang.String	getSetId() Get the observation set id
java.lang.String	getSubId() Get the observation sub id.
CEElement	getUnits() Get the units as a CEElement
void	setObservationIdentifier(CEElement ceObsId) Set the type of observation as a LOINC coded CE element.
void	setObservationValue(HL7Element eNewValue) Set the observation value.
void	setObservationValue(java.lang.String sNewValue) Set the observation value.
void	setObservationValueType(java.lang.String sType) Set the type of OBX.5 as one of the HL7 data types.
void	setResultStatus(java.lang.String sCode) Set the result status.
void	setSetId(java.lang.String sSetId) Set the observation set id used to distinguish individual OBX's.
void	setSubId(java.lang.String sSubId) Set the observation sub id used to relate two or more OBX's as part of the same observation such as a modifier added to a term.
void	setUnits(CEElement eUnits) Set the Units as preformed CEElement.
void	setUnits(java.lang.String sUnits) Set the Units as String.

Methods inherited from class org.vmdb.hl7.HL7Segment

clearField, getField, getFieldValue, iterator, listFields, setField, setField, setField, setField, setField, setField, setField, toString, toXML

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OBXSegment

public OBXSegment()

Construct an empty observation result segment.

OBXSegment

public OBXSegment(HL7SegmentContainer msgParent)

Construct an empty observation result segment, setting its containing message object.

Parameters:

msgParent - HL7SegmentContainer (normally a loop) object that contains this segment.

Method Detail

setSetId

public void setSetId(java.lang.String sSetId)

Set the observation set id used to distinguish individual OBX's.

getSetId

public java.lang.String getSetId()

Get the observation set id

Returns:

String with set id

setObservationValueType

public void setObservationValueType(java.lang.String sType)
                             throws MalformedFieldException

Set the type of OBX.5 as one of the HL7 data types. For now, we only allow those types that we have implemented.

Parameters:

sType - String with CE, SN, NM, or ST value

MalformedFieldException

getObservationValueType

public java.lang.String getObservationValueType()

Get the HL7 data type of OBX.5.

Returns:

String with type code

setObservationIdentifier

public void setObservationIdentifier(CEElement ceObsId)

Set the type of observation as a LOINC coded CE element.

Parameters:

ceObsId - a constructed CEElement coding for the observation identifier. Normally this will be a preconstructed constant for one of the VMDB pre-LOINC-coded identifiers.

getObservationIdentifier

public CEElement getObservationIdentifier()

Get the observation identifier as a CEElement.

Returns:

CEElement with identifier. Use getText() to retrieve human-readable form.

setSubId

public void setSubId(java.lang.String sSubId)

Set the observation sub id used to relate two or more OBX's as part of the same observation such as a modifier added to a term.

Normally, it is best to leave this to the logic coded into the modifyObservation method of the ORU message class.

Parameters:

sSubId - String with 1.1, 1.2, 2.1, etc.

getSubId

public java.lang.String getSubId()

Get the observation sub id.

Returns:

String with sub id value.

setObservationValue

public void setObservationValue(HL7Element eNewValue)

Set the observation value.

Since OBX.5 is polymorphic, we use the base class HL7Element as the input. The actual value supplied should be the appropriate subtype as specified in setValueType above.

Parameters:

eNewValue - HL7Element (or subclass) with value.

setObservationValue

public void setObservationValue(java.lang.String sNewValue)

Set the observation value.

This version takes a string representing any of the simple HL7 types.

Parameters:

sNewValue - String with value of simple data type.

getObservationValue

public HL7Element getObservationValue()

Get the observation value as base class HL7Element

Returns:

HL7Element containing value. Cast to appropriate subclass to extract human-readable form.

setUnits

public void setUnits(CEElement eUnits)

Set the Units as preformed CEElement.

Normally will use a precoded ISO or ANSI coded units.

Parameters:

eUnits - CEElement with units coded as ISO+ or ANS+

setUnits

public void setUnits(java.lang.String sUnits)

Set the Units as String.

Should normally will use a precoded ISO or ANSI coded units but this method allows use of arbitrary strings for units.

Parameters:

sUnits - String with units

getUnits

public CEElement getUnits()

Get the units as a CEElement

Returns:

CEElement with coded units

setResultStatus

public void setResultStatus(java.lang.String sCode)

Set the result status.

This will almost always retain the default of "F" for final results. See HL7 2.4 chapter 7 for usage of other codes.

Parameters:

sCode - String with result status (normally "F")