org.vmdb.hl7
Class ORUMessage

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7SegmentContainer
              |
              +--org.vmdb.hl7.HL7Message
                    |
                    +--org.vmdb.hl7.ORUMessage

public class ORUMessage

extends HL7Message

Observation Unsolicited (ORU) Message.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

Message class(es) form the main API for the library. In most cases, there will be simple methods for inserting and extracting values from the message structure as well as for parsing incoming messages or building outgoing messages in either delimited HL7 or the draft XML representation.

The Observation Unsolicited (ORU) message is the approved method for submitting data to the Veterinary Medical Database (VMDB). This class implements a subset of the ORU message that meets all requirements of VMDB and parses and builds standard-compliant ORU messages. Appropriate default values are provided for required fields not used by VMDB. Limitations added by VMDB are supported and taken advantage of in order to keep the API as simple as possible. For routine processing of VMDB submissions, the only methods needed should be those provided in the ORUMessage's public interface and the public methods inherited from HL7Message.

For more complex tasks or for anything I've missed, any standard-compliant ORU message should parse correctly and any of its contents be accessible using lower-level classes. Similarly, using lower-level classes it is possible to build any standard-compliant ORU message which can then be rendered as either delimited or XML version HL7.

The XML representation of HL7 2.x introduces the concepts of groups and lists that, while present in the construction rules of delimited HL7, are not explicitly named or labelled in the messages themselves. The internal representation in this class follows the XML version with explicitly constructed groups and lists which we've combined under the general term (borrowed from X12) of "loop." Going to the lower-level access methods often requires knowing the location of a segment in this loop structure. Perhaps the simplest way to learn this loop structure is to use the library to import a delimited HL7 message of the structure you are working with, and then print it out using the toXML() method. Because all the groups and lists are explicitly named in the XML, the structure hierarchy will be right there.

The internal representation is built up using recursive construction. The message contains segments and loops. Loops can contain segments and other loops. Segments contain fields defined by elements of specific HL7 types. These elements my be simple strings of various types (all represented by SimpleElement currently) or may be built up from components which are themselves elements and so on. Because any given message can contain a potentially infinite number of segments, the data structure is only instantiated as it is needed either from reading in segments during parsing or from setting values that reside in a segment or field not yet instantiated. This is actually implemented in the getSSS() methods on the basis that a program is only getting the segment to do something with it. Similarly, segments are intially instantiated with place holders for all fields up to the last required field. This ensures that all delimiters required for standards compliance are present when the structure is output as HL7. If a value is set for an optional field after the last required field, placeholders up to and including the new field are instantiated. Because XML uses tag labels rather than position to identify fields, these empty fields are not output in the toXML() method.

Note: We use Java Bean like convention of getXXX and setXXX but with a few deviations. First as previously mentioned, getSSS() where SSS is a segment or loop abbreviation has the side affect of constructing the segment or loop if it does not already exist. Also, the set methods frequently take multiple parameters especially when the actual value is a mildly complex element-type such as coded entry (CE). We have added common conventional name patterns. For example addSSS() for segments that repeat and addDiagnosis(), etc., to abstract the process of adding a segment (usually OBX) holding a single data entry such as a finding (addFinding) or diagnosis (addDiagnosis). listXXX() returns an Iterator object over a collection of segments of the type specified by XXX. findEEE( XXX ) methods perform a depth-first search of the object hierarchy looking for XXX.

TODO: Add string length validation to all methods taking String input and add to documentation.

Constructor Summary

ORUMessage()
Construct an empty ORU Message with type and version set.

Method Summary

OBXSegment	addDiagnosis(CEElement ceDiagnosis) Add a Diagnosis as a predefined CE Element.
OBXSegment	addDiagnosis(CEElement ceDiagnosis, boolean bRecheck) Add a Diagnosis as a predefined CE Element.
OBXSegment	addDiagnosis(java.lang.String sDiagnosisCode, java.lang.String sDiagnosisText, java.lang.String sCodeSystem) Add a Diagnosis as the individual components of the CE Element.
OBXSegment	addDiagnosis(java.lang.String sDiagnosisCode, java.lang.String sDiagnosisText, java.lang.String sCodeSystem, boolean bRecheck) Add a Diagnosis as the individual components of the CE Element.
OBXSegment	addDiagnosis(java.lang.String sDiagnosisCode, java.lang.String sDiagnosisText, java.lang.String sCodeSystem, java.lang.String sAltDiagnosisCode, java.lang.String sAltDiagnosisText, java.lang.String sAltCodeSystem) Add a Diagnosis as the individual components of the CE Element.
OBXSegment	addDiagnosis(java.lang.String sDiagnosisCode, java.lang.String sDiagnosisText, java.lang.String sCodeSystem, java.lang.String sAltDiagnosisCode, java.lang.String sAltDiagnosisText, java.lang.String sAltCodeSystem, boolean bRecheck) Add a Diagnosis as the individual components of the CE Element.
OBXSegment	addFinding(CEElement ceFinding) Add a Finding as a predefined CE Element.
OBXSegment	addFinding(java.lang.String sFindingCode, java.lang.String sFindingText, java.lang.String sCodeSystem) Add a Finding as the individual components of a CE Element.
OBXSegment	addFinding(java.lang.String sFindingCode, java.lang.String sFindingText, java.lang.String sCodeSystem, java.lang.String sAltFindingCode, java.lang.String sAltFindingText, java.lang.String sAltCodeSystem) Add a Finding as the individual components of a CE Element.
OBXSegment	addOBX() Add an OBX segment that should be located in this loop.
OBXSegment	addProcedure(CEElement ceProcedure) Add a Procedure as a predefined CE Element.
OBXSegment	addProcedure(java.lang.String sProcedureCode, java.lang.String sProcedureText, java.lang.String sCodeSystem) Add a Procedure as the individual components of a CE Element.
OBXSegment	addProcedure(java.lang.String sProcedureCode, java.lang.String sProcedureText, java.lang.String sCodeSystem, java.lang.String sAltProcedureCode, java.lang.String sAltProcedureText, java.lang.String sAltCodeSystem) Add a Procedure as the individual components of a CE Element.
java.lang.String	getAdmissionType() Get the admission type code.
java.lang.String	getAdmitDateTime() Get the admit date/time as a string.
XCNElement	getAttendingDoctor() Get the attending doctorn ID as a full XCN Element.
java.lang.String	getAttendingDoctorAssigningAuthority() Get the attending doctor ID assigning facility.
java.lang.String	getAttendingDoctorId() Get the attending doctor ID number.
CEElement	getBreed() Get the breed as a predefined CE Element.
java.lang.String	getBreedText() Get the breed text.
CEElement	getChiefComplaint() Get the Chief Complaint as a predefined CE Element.
java.lang.String	getChiefComplaintText() Get the Chief Complaint text.
java.lang.String	getColor() Get the animal's color as string.
java.lang.String	getDateOfBirth() Get the date of birth.
java.lang.String	getDischargeDateTime() Get the discharge date/time as a string.
java.lang.String	getDisposition() Get Discharge Disposition string.
java.lang.String	getEarTagText() Get the ear tag text.
java.lang.String	getEarTagType() Get the ear tag type.
java.lang.String	getMedicalRecordNumber() Get the Medical record number.
java.lang.String	getMessageControlId() Get the message control id.
java.lang.String	getMicrochipNumber() Get the microchip number.
java.lang.String	getMicrochipType() Get the microchip type.
OBRSegment	getOBR() Get the OBR segment that should be nested somewhere within this loop.
java.lang.String	getObservationDateTime() Get the observation date/time as a string.
ORCSegment	getORC() Get the ORC segment that should be nested somewhere within this loop.
ORCSegment	getORC(java.lang.String sOrderControl) Get the ORC segment that should be nested somewhere within this loop.
java.lang.String	getOrderControl() Get Order Contrl string.
PATIENT_RESULTLoop	getPATIENT_RESULT() Get the The PATIENT_RESULT loop contained in this message.
java.lang.String	getPatientClass() Get the patient class code.
java.lang.String	getPatientName() Get the patient's name.
java.lang.String	getPatientZipcode() Get the postal code.
PIDSegment	getPID() Get the PID segment that should be nested within this message.
PV1Segment	getPV1() Get the PV1 segment that should be nested somewhere within this loop.
java.lang.String	getSendingFacilityId() Get the Sending facility VMDB Institution Id.
java.lang.String	getSendingFacilityName() Get the Sending facility name.
java.lang.String	getSex() Get the gender.
CEElement	getSpecies() Get the species as a predefined CE Element.
java.lang.String	getSpeciesText() Get the species text.
java.lang.String	getTattooText() Get the tattoo text.
java.lang.String	getTattooType() Get the tattoo type.
CEElement	getUniversalServiceId() Get the coded universal service identifier as a preformed CE Element.
java.lang.String	getUniversalServiceIdText() Get the universal service identifier text.
CXElement	getVisitNumber() Get the Visit Number ID as full CX Element.
java.lang.String	getVisitNumberAssigningAuthority() Get the Visit Number assigning facility.
java.lang.String	getVisitNumberId() Get the Visit Number ID number.
java.lang.String	getWeight() Get the animal's weight.
boolean	getWeightMeasured() Was the weight we returned with getWeight a measured weight rather than an estimate.
java.lang.String	getWeightUnits() Get the weight units.
java.util.Iterator	listDiagnoses() Get the Diagnosis list as an iterator over OBXSegment objects.
java.util.Iterator	listFindings() Get the Finding list as an iterator over OBXSegment objects.
java.util.Iterator	listModifiers(OBXSegment obxRoot) Get the Modifier list as iterator over OBXSegment objects.
java.util.Iterator	listProcedures() Get the Procedure list as an iterator over OBXSegment objects.
java.util.Iterator	listRechecks() Get the Recheck list as an iterator over OBXSegment objects.
OBXSegment	modifyObservation(OBXSegment obxRoot, CEElement ceIdentifier, CEElement ceModifier) Modify a coded OBXSegment using predefined Coded Entry for identifier and code.
void	setAdmissionType(java.lang.String sAdmissionType) Set the admission type code (C, K, E, Z, P, or R).
void	setAdmitDateTime(java.lang.String sDateTime) Set the admit date/time of the message to string formatted date/time.
void	setAttendingDoctor(java.lang.String sIdNumber, java.lang.String sAssigningAuthority) Set the attending doctor.
void	setAttendingDoctorAssigningAuthority(java.lang.String sIdNumber, java.lang.String sAssigningAuthority) Set the attending doctor.
void	setAttendingDoctorId(java.lang.String sIdNumber) Set the attending doctor ID number using the default assigning facility of the facility sending the report.
void	setBreed(CEElement ceBreed) Set the breed as a predefined CE Element.
void	setBreed(java.lang.String sBreedCode, java.lang.String sBreedText, java.lang.String sCodeSystem) Set the breed as the individual components of a CE Element.
void	setBreed(java.lang.String sBreedCode, java.lang.String sBreedText, java.lang.String sCodeSystem, java.lang.String sAltBreedCode, java.lang.String sAltBreedText, java.lang.String sAltCodeSystem) Set the breed as the individual components of a CE Element.
OBXSegment	setChiefComplaint(CEElement ceChiefComplaint) Set the Chief Complaint as a predefined CE Element.
OBXSegment	setChiefComplaint(java.lang.String sChiefComplaintCode, java.lang.String sChiefComplaintText, java.lang.String sCodeSystem) Set the Chief Complaint as the individual components of a CE Element.
OBXSegment	setChiefComplaint(java.lang.String sChiefComplaintCode, java.lang.String sChiefComplaintText, java.lang.String sCodeSystem, java.lang.String sAltChiefComplaintCode, java.lang.String sAltChiefComplaintText, java.lang.String sAltCodeSystem) Set the Chief Complaint as the individual components of a CE Element.
void	setColor(java.lang.String sColor) Set the animal's color as uncoded text.
void	setDateOfBirth(java.lang.String sBDate) Set the date of birth as ISO format data string YYYYMMDD
void	setDateOfBirth(TSElement tsBDate) Set the date of birth as ISO format data string YYYYMMDD
void	setDischargeDateTime(java.lang.String sDateTime) Set the discharge date/time of the message to string formatted date/time.
void	setDisposition(java.lang.String sDisp) Set the Discharge Disposition.
void	setEarTag(java.lang.String sEarTagText, java.lang.String sEarTagType) Set the ear tag text and type.
void	setMedicalRecordNumber(java.lang.String sMRN) Set the Medical record number.
void	setMessageControlId(java.lang.String sMessageControlId) Set the message control id.
void	setMicrochip(java.lang.String sChipNumber, java.lang.String sChipType) Set the microchip number and type.
void	setObservationDateTime(java.lang.String sDateTime) Set the observation date/time of the message to string formatted date/time.
void	setOrderControl(java.lang.String sOrderControl) Set the Order Control.
void	setPatientClass(java.lang.String sPatClass) Set the patient class code (A, I, O, R).
void	setPatientName(java.lang.String sName) Set the patient's name (normally "Confidential").
void	setPatientZipcode(java.lang.String sZipcode) Set the postal code of animal's residence.
void	setSendingFacility(java.lang.String sName, java.lang.String sId) Set the Sending facility VMDB Institution Id.
void	setSex(java.lang.String sSex) Set the gender.
void	setSpecies(CEElement ceSpecies) Set the species as a predefined CE Element.
void	setSpecies(java.lang.String sSpeciesCode, java.lang.String sSpeciesText, java.lang.String sCodeSystem) Set the species as the individual components of a CE Element
void	setSpecies(java.lang.String sSpeciesCode, java.lang.String sSpeciesText, java.lang.String sCodeSystem, java.lang.String sAltSpeciesCode, java.lang.String sAltSpeciesText, java.lang.String sAltCodeSystem) Set the species as the individual components of a CE Element
void	setTattoo(java.lang.String sTattooText, java.lang.String sTattooType) Set the tattoo text and type.
void	setUniversalServiceId(CEElement ceServiceId) Set the coded universal service identifier as a preformed CE Element.
void	setUniversalServiceId(java.lang.String sCode, java.lang.String sText, java.lang.String sCodeType) Set the coded universal service identifier.
void	setVisitNumber(java.lang.String sVisitNumber) Set the Visit Number.
void	setVisitNumberAssigningAuthority(java.lang.String sAssigningAuthority) Set the Visit Number ID assigning facility.
void	setWeight(java.lang.String sWeight, java.lang.String sWeightUnits) Set the animal's weight and weight units.
void	setWeight(java.lang.String sWeight, java.lang.String sWeightUnits, boolean bMeasured) Set the weight.
void	setWeightRange(SNElement snWeightRange, CEElement ceWeightUnits) Set the animal's weight range and weight units.
void	setWeightRange(java.lang.String sMin, java.lang.String sMax, CEElement ceWeightUnits) Set the animal's weight range and weight units.

Methods inherited from class org.vmdb.hl7.HL7Message

getDTD, getMessageName, getMSH, getReceivingFacility, getReceivingFacilityId, getReceivingFacilityName, getSendingFacility, getStyleSheet, printRule, readHL7, setDTD, setMessageName, setMessageName, setReceivingFacility, setReceivingFacility, setSendingFacility, setStyleSheet, toXML, toXML

Methods inherited from class org.vmdb.hl7.HL7SegmentContainer

findSegment, listsSegments, setSeparators, toString

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

ORUMessage

public ORUMessage()

Construct an empty ORU Message with type and version set. This object is ready to either build via a series of set and add calls, or to read in an HL7 or XML (future) message.

Method Detail

getPATIENT_RESULT

public PATIENT_RESULTLoop getPATIENT_RESULT()

Get the The PATIENT_RESULT loop contained in this message. If it does not exist, take the necessary steps to create it.

Chaining calls to get[*]Loop() allows the retrieval of a loop at any point in the hierarchy with knowledge that if this is the first use of any loop or loops in the hierarchy, they will be created so that the returned reference is a valid part of the message being constructed. The referenced loop can then be used to access a segment via getSSS() or addSSS() depending on the type repeatablility of the segment.

Returns:

A reference to the PATIENT_RESULTLoop object located at the appropriate place in the loop.

getPID

public PIDSegment getPID()

Get the PID segment that should be nested within this message. If it does not exist, take the necessary steps to create it in the appropriate nested loop structure.

Note: The "get" semantics here only work correctly for segments that exist singly in a message. We break with generic HL7 here in that only under VMDB are we restricted to a single patient per message. If we drop this limitation we will need to create more complex "addPID()" semantics.

Returns:

A reference to the PIDSegment object located at the appropriate place.

getPV1

public PV1Segment getPV1()

Get the PV1 segment that should be nested somewhere within this loop. If it does not exist, take the necessary steps to create it in the appropriate nested loop structure.

Note: The "get" semantics here only work correctly for segments that exist singly in a message. We break with generic HL7 here in that only under VMDB are we restricted to a single patient visit per message. If we drop this limitation we will need to create more complex "addPV1()" semantics.

Returns:

A reference to the PV1Segment object located at the appropriate place in the loop.

getOBR

public OBRSegment getOBR()

Get the OBR segment that should be nested somewhere within this loop. If it does not exist, take the necessary steps to create it in the appropriate nested loop structure.

Note: The "get" semantics here only work correctly for segments that exist singly in a message. We break with generic HL7 here in that only under VMDB are we restricted to a single observation request per message. If we drop this limitation we will need to create more complex "addOBR()" semantics.

Returns:

a reference to the OBRSegment object located at the appropriate place in the loop.

getORC

public ORCSegment getORC()

Get the ORC segment that should be nested somewhere within this loop. If it does not exist, take the necessary steps to create it in the appropriate nested loop structure.

Returns:

a reference to the OBRSegment object located at the appropriate place in the loop.

getORC

public ORCSegment getORC(java.lang.String sOrderControl)

Get the ORC segment that should be nested somewhere within this loop. If it does not exist, take the necessary steps to create it in the appropriate nested loop structure.

Returns:

a reference to the OBRSegment object located at the appropriate place in the loop.

addOBX

public OBXSegment addOBX()

Add an OBX segment that should be located in this loop. If the loop does not exist, take the necessary steps to create it.

Note: This should really be linked to a specific OBR, but because VMDB only allows one OBR per message, we are safe like this.

Returns:

OBXSegment object newly created.

setMessageControlId

public void setMessageControlId(java.lang.String sMessageControlId)

Set the message control id.

Overrides:

setMessageControlId in class HL7Message

getMessageControlId

public java.lang.String getMessageControlId()

Get the message control id.

Overrides:

getMessageControlId in class HL7Message

Returns:

String with unique identifier

setSendingFacility

public void setSendingFacility(java.lang.String sName,
                               java.lang.String sId)

Set the Sending facility VMDB Institution Id.

Overrides:

setSendingFacility in class HL7Message

Parameters:

sName - String with VMDB facility name

sId - String with VMDB facility id

getSendingFacilityId

public java.lang.String getSendingFacilityId()

Get the Sending facility VMDB Institution Id.

Overrides:

getSendingFacilityId in class HL7Message

Returns:

String with VMDB facility id

getSendingFacilityName

public java.lang.String getSendingFacilityName()

Get the Sending facility name.

Overrides:

getSendingFacilityName in class HL7Message

Returns:

String with VMDB facility name

setMedicalRecordNumber

public void setMedicalRecordNumber(java.lang.String sMRN)

Set the Medical record number.

Medical record is defined in this logic as the identifier assigned by the sending facility. To work correctly, the sending facility identifier must be set before actions involving MRN.

Parameters:

sMRN - String with facility's MRN

getMedicalRecordNumber

public java.lang.String getMedicalRecordNumber()

Get the Medical record number.

Medical record is defined in this logic as the identifier assigned by the sending facility. To work correctly, the sending facility identifier must be set before actions involving MRN.

Returns:

String with facility's MRN

setSpecies

public void setSpecies(CEElement ceSpecies)

Set the species as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getSpecies() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Parameters:

ceSpecies - CEElement populated with the coded species

setSpecies

public void setSpecies(java.lang.String sSpeciesCode,
                       java.lang.String sSpeciesText,
                       java.lang.String sCodeSystem)

Set the species as the individual components of a CE Element

Parameters:

sSpeciesCode - String with the code for species

sSpeciesText - String with the species spelled out

sCodeSystem - String, usually "SCT," with the type of code

setSpecies

public void setSpecies(java.lang.String sSpeciesCode,
                       java.lang.String sSpeciesText,
                       java.lang.String sCodeSystem,
                       java.lang.String sAltSpeciesCode,
                       java.lang.String sAltSpeciesText,
                       java.lang.String sAltCodeSystem)

Set the species as the individual components of a CE Element

Parameters:

sSpeciesCode - String with the code for species

sSpeciesText - String with the species spelled out

sCodeSystem - String, usually "SCT," with the type of code

sAltSpeciesCode - String with the alternate code for the SAME species

sAltSpeciesText - String with the species spelled out as in alternate system

sAltCodeSystem - String, alternate the type of code

getSpecies

public CEElement getSpecies()

Get the species as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If setSpecies was called with a constant, subsequent calls to getSpecies() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Returns:

A reference to the CEElement populated with species

getSpeciesText

public java.lang.String getSpeciesText()

Get the species text.

Returns:

String species spelled out

setBreed

public void setBreed(CEElement ceBreed)

Set the breed as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getBreed() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Parameters:

ceBreed - CEElement populated with breed

setBreed

public void setBreed(java.lang.String sBreedCode,
                     java.lang.String sBreedText,
                     java.lang.String sCodeSystem)

Set the breed as the individual components of a CE Element.

Parameters:

sBreedCode - String snomed code for breed

sBreedText - String breed spelled out

sCodeSystem - String usually SCT with type of code

setBreed

public void setBreed(java.lang.String sBreedCode,
                     java.lang.String sBreedText,
                     java.lang.String sCodeSystem,
                     java.lang.String sAltBreedCode,
                     java.lang.String sAltBreedText,
                     java.lang.String sAltCodeSystem)

Set the breed as the individual components of a CE Element.

Parameters:

sBreedCode - String snomed code for breed

sBreedText - String breed spelled out

sCodeSystem - String usually SCT with type of code

sAltBreedCode - String Alternate code for breed

sAltBreedText - String breed spelled out as in alternate system

sAltCodeSystem - String alternate type of code

getBreed

public CEElement getBreed()

Get the breed as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getBreed() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Returns:

A reference to the CEElement populated with breed

getBreedText

public java.lang.String getBreedText()

Get the breed text.

Returns:

String breed spelled out

setDateOfBirth

public void setDateOfBirth(java.lang.String sBDate)

Set the date of birth as ISO format data string YYYYMMDD

setDateOfBirth

public void setDateOfBirth(TSElement tsBDate)

Set the date of birth as ISO format data string YYYYMMDD

getDateOfBirth

public java.lang.String getDateOfBirth()

Get the date of birth.

Returns:

String with date of birth as YYYYMMDD

setSex

public void setSex(java.lang.String sSex)

Set the gender.

Parameters:

sSex - String with gender as M, C, T, F, S, O, U, H, or X

getSex

public java.lang.String getSex()

Get the gender.

Returns:

String with gender code

setWeight

public void setWeight(java.lang.String sWeight,
                      java.lang.String sWeightUnits,
                      boolean bMeasured)

Set the weight.

Stored as OBX with loinc code 8335-2 "Body Weight Estimated" or 3141-9 "Body Weight Measured"
TODO: Add checking that the string supplied as sWeight parses as a numeric.
TODO: Add checking that the string supplied as sWeightUnits is a valid unit of measure

Parameters:

sWeight - String with weight in numeric form

sWeightUnits - String with units in ISO or ANSI abbreviation (usually kg or lb)

bMeasured - true if weight was measured rather than estimated reflected internally by loinc code 3141-9 measured vs. 8335-2 est default is true

setWeight

public void setWeight(java.lang.String sWeight,
                      java.lang.String sWeightUnits)

Set the animal's weight and weight units.

Stored as OBX with loinc code 3141-9 "Body Weight Measured." This is just a convenience method for the common case where weights are normally always measured.

Parameters:

sWeight - String with weight in numeric form

sWeightUnits - String with units in ISO or ANSI abbreviation (usually kg or lb)

setWeightRange

public void setWeightRange(SNElement snWeightRange,
                           CEElement ceWeightUnits)

Set the animal's weight range and weight units.

Stored as OBX with loinc code 3141-9 "Body Weight Measured." This is just a convenience method for the common case where weights are normally always measured.

Parameters:

snWeightRange - SNElement with coded weight range

setWeightRange

public void setWeightRange(java.lang.String sMin,
                           java.lang.String sMax,
                           CEElement ceWeightUnits)

Set the animal's weight range and weight units.

Stored as OBX with loinc code 3141-9 "Body Weight Measured." This is just a convenience method for the common case where weights are normally always measured.

Parameters:

sMin - std::string with low end of weight range in numeric form

sMax - std::string with high end of weight range in numeric form

getWeight

public java.lang.String getWeight()

Get the animal's weight.

Stored as OBX with loinc code 8335-2 "Body Weight Estimated" or 3141-9 "Body Weight Measured"
Note: We assume only one weight. The logic here is to take the first found of measured or the first estimated if no measured found. Equally valid would be to take the latest measurement, etc.

Returns:

String with weight

getWeightUnits

public java.lang.String getWeightUnits()

Get the weight units.

Note: Thelogic used here must be kept in step with the logic used in getWeight(). For now that means if there is a measured weight we use it in getWeight and return true hereWe assume only one weight. The logic here is to take the first found of measured or the first estimated if no measured found. Equally valid would be to take the latest measurement, etc.. Sequential calls to getWeight(), getWeightUnits(), and getWeightMeasured() should return information about the same weight observation. This might be un-threadsafe in environments where another thread could be writing a weight OBX while another is reading. In such cases, it would be better to get the OBX and extract the fields manually.
TODO: If demand arises, add a getWeightOBX() method to facilitate thread-safe access.

Returns:

String with weight units in ISO or ANSI abbreviation

getWeightMeasured

public boolean getWeightMeasured()

Was the weight we returned with getWeight a measured weight rather than an estimate.

Note: Thelogic used here must be kept in step with the logic used in getWeight(). For now that means if there is a measured weight we use it in getWeight and return true hereWe assume only one weight. The logic here is to take the first found of measured or the first estimated if no measured found. Equally valid would be to take the latest measurement, etc.. Sequential calls to getWeight(), getWeightUnits(), and getWeightMeasured() should return information about the same weight observation. This might be un-thread-safe in environments where one thread could be writing a weight OBX while another is reading. In such cases, it would be better to get the OBX and extract the fields manually.
TODO: If demand arises, add a getWeightOBX() method to facilitate thread-safe access.

Returns:

boolean true if a measured weight found. NOTE: This returns false even if NO weight observation was found, so this should only be interpreted after retrieving a valid weight value.

setColor

public void setColor(java.lang.String sColor)

Set the animal's color as uncoded text.

Stored as OBX with loinc code 29552-7 color nar

Parameters:

sColor - String color

getColor

public java.lang.String getColor()

Get the animal's color as string.

Stored as OBX with loinc code 29552-7 color nar

Returns:

String color

setMicrochip

public void setMicrochip(java.lang.String sChipNumber,
                         java.lang.String sChipType)

Set the microchip number and type.

Parameters:

sChipNumber - String with chip number

sChipType - String with chip type coded or text?

getMicrochipNumber

public java.lang.String getMicrochipNumber()

Get the microchip number.

Note: This logic assumes only one microchip per animal. It is possible that an animal would have multiple, ie, one US and one European chip. More than one chip can be set using this program logic as long as the types differ. They they will be stored and transmitted correctly and could be retrieved using lower-level code. However, this code returns only the first chip found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with chip number

getMicrochipType

public java.lang.String getMicrochipType()

Get the microchip type.

Note: This logic assumes only one microchip per animal. It is possible that an animal would have multiple, ie, one US and one European chip. More than one chip can be set using this program logic as long as the types differ. They they will be stored and transmitted correctly and could be retrieved using lower-level code. However, this code returns only the first chip found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with chip type

setTattoo

public void setTattoo(java.lang.String sTattooText,
                      java.lang.String sTattooType)

Set the tattoo text and type.

Note: This logic assumes only one tattoo per animal. It is possible that an animal would have multiple. More than one tattoo can be set using this program logic as long as they are different types and they will be stored and transmitted correctly. However, this logic returns only the tattoo found.

Parameters:

sTattooText - String with text of tattoo

sTattooType - String with type of tattoo (location, program, etc.) The value supplied must be one of the constants defined in Identifiers. Eventually these constants will be replaced with a more robust system for controlled vocabulary lookup. For now, programmers may add constants to Identifiers, Loinc, etc., without being required to submit the change under the LGPL.

getTattooText

public java.lang.String getTattooText()

Get the tattoo text.

Note: This logic assumes only one tattoo per animal. This method returns the first found. However, this logic returns only the tattoo found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with tattoo text

getTattooType

public java.lang.String getTattooType()

Get the tattoo type.

Note: This logic assumes only one tattoo per animal. This method returns the first found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with tattoo type (location, program, etc.)

setEarTag

public void setEarTag(java.lang.String sEarTagText,
                      java.lang.String sEarTagType)

Set the ear tag text and type.

Note: This logic assumes only one ear tag per animal. It is possible that an animal would have multiple. More than one ear tag can be set using this program logic as long as they are different types and they will be stored and transmitted correctly. However, this logic returns only the first ear tag found.
More so than the other identifiers, this may be an issue. It is not a big project for the library developer to change to add/list logic but it will add complexity at the application programming layer as it will be up to the application to look through the list Iterator.

Parameters:

sEarTagText - String with text of ear tag

sEarTagType - String with type of ear tag (location, program, etc.)

getEarTagText

public java.lang.String getEarTagText()

Get the ear tag text.

Note: This logic assumes only one ear tag per animal. It returns only the first ear tag found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with ear tag text

getEarTagType

public java.lang.String getEarTagType()

Get the ear tag type.

Note: This logic assumes only one ear tag per animal. It returns only the first ear tag found.
Note: The same sort of thread-safety issue exists as in the getWeightUnits method.

Returns:

String with ear tag type

setPatientZipcode

public void setPatientZipcode(java.lang.String sZipcode)

Set the postal code of animal's residence.

getPatientZipcode

public java.lang.String getPatientZipcode()

Get the postal code.

Returns:

String with Zipcode or other postal code

setPatientName

public void setPatientName(java.lang.String sName)

Set the patient's name (normally "Confidential").

Parameters:

sName - String with name

getPatientName

public java.lang.String getPatientName()

Get the patient's name.

Returns:

String with Name

setPatientClass

public void setPatientClass(java.lang.String sPatClass)

Set the patient class code (A, I, O, R).

TODO: Add error checking to ensure only valud class code is provided.

getPatientClass

public java.lang.String getPatientClass()

Get the patient class code.

Returns:

String with patient class code

setAdmissionType

public void setAdmissionType(java.lang.String sAdmissionType)

Set the admission type code (C, K, E, Z, P, or R).

TODO: Add error checking to ensure only valud class code is provided.

getAdmissionType

public java.lang.String getAdmissionType()

Get the admission type code.

Returns:

String with admission type code

setAttendingDoctor

public void setAttendingDoctor(java.lang.String sIdNumber,
                               java.lang.String sAssigningAuthority)

Set the attending doctor.

Parameters:

sIdNumber - String Attending Doctor ID

sAssigningAuthority - String with identifier of assigning facility

setAttendingDoctorId

public void setAttendingDoctorId(java.lang.String sIdNumber)

Set the attending doctor ID number using the default assigning facility of the facility sending the report. (As is normal VMDB procedure,)

Parameters:

sIdNumber - Attending Doctor identifier assigned by sending facility

setAttendingDoctorAssigningAuthority

public void setAttendingDoctorAssigningAuthority(java.lang.String sIdNumber,
                                                 java.lang.String sAssigningAuthority)

Set the attending doctor.

Parameters:

sAssigningAuthority - String with identifier of assigning facility

getAttendingDoctor

public XCNElement getAttendingDoctor()

Get the attending doctorn ID as a full XCN Element.

Note: This and other "get" methods that return HL7 Element objects return references to the object in place in the message. They can thus be used to obtain a reference to a newly added entry. The XCNElement object's "set" methods can then be used to add details not provided with mutator methods at the message level. These additional components will most likely be ignored by VMDB when the message is received, but may be useful in other applications of the same messages, and as standard HL7 content will not cause errors at VMDB.

Returns:

Attending doctor's full extended composite name

getAttendingDoctorId

public java.lang.String getAttendingDoctorId()

Get the attending doctor ID number.

Returns:

String with ID number

getAttendingDoctorAssigningAuthority

public java.lang.String getAttendingDoctorAssigningAuthority()

Get the attending doctor ID assigning facility.

TODO: Check assigner logic and replace with Assigning Authority if necessary.

Returns:

String with identifier of Assigning Facility

setVisitNumber

public void setVisitNumber(java.lang.String sVisitNumber)

Set the Visit Number.

Normally assigned by the sending facility so this is added as the default Assigning Faciltiy.

Parameters:

sVisitNumber - String with facility-assigned visit identifier

setVisitNumberAssigningAuthority

public void setVisitNumberAssigningAuthority(java.lang.String sAssigningAuthority)

Set the Visit Number ID assigning facility.

Note: setVisitNumber() automatically assigns thisFacility as the assigning facility. So use only setVisitNumberAssigningAuthority() after setting the number to override on those rare occasions when sending for a subsidiary, etc., with a different identifier than the sender.
TODO: Check assigner logic and replace with Assigning Authority if necessary.

Parameters:

sAssigningAuthority - String with namespace identifier for assigning facility

getVisitNumber

public CXElement getVisitNumber()

Get the Visit Number ID as full CX Element.

Returns:

CXElement with visit number

getVisitNumberId

public java.lang.String getVisitNumberId()

Get the Visit Number ID number.

Returns:

String with Visit ID number

getVisitNumberAssigningAuthority

public java.lang.String getVisitNumberAssigningAuthority()

Get the Visit Number assigning facility.

TODO: Check assigner logic and replace with Assigning Authority if necessary.

Returns:

String with authority namespace id

setDisposition

public void setDisposition(java.lang.String sDisp)

Set the Discharge Disposition.

TODO: Add code validation logic

Parameters:

sDisp - one character string [0,1,2, or 3] for alive, dead, euthanized, or referred

getDisposition

public java.lang.String getDisposition()

Get Discharge Disposition string.

Returns:

String with discharge disposition code

setAdmitDateTime

public void setAdmitDateTime(java.lang.String sDateTime)

Set the admit date/time of the message to string formatted date/time.

TODO: Add date format validation logic

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getAdmitDateTime

public java.lang.String getAdmitDateTime()

Get the admit date/time as a string.

Returns:

String date/time

setDischargeDateTime

public void setDischargeDateTime(java.lang.String sDateTime)

Set the discharge date/time of the message to string formatted date/time.

TODO: Add date format validation logic

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getDischargeDateTime

public java.lang.String getDischargeDateTime()

Get the discharge date/time as a string.

Returns:

String date/time in yyyyMMddHHmmss format

setOrderControl

public void setOrderControl(java.lang.String sOrderControl)

Set the Order Control.

TODO: Add code validation logic

getOrderControl

public java.lang.String getOrderControl()

Get Order Contrl string.

Returns:

String with discharge disposition code

setUniversalServiceId

public void setUniversalServiceId(java.lang.String sCode,
                                  java.lang.String sText,
                                  java.lang.String sCodeType)

Set the coded universal service identifier.

This version takes the fully qualified CEElement components

Parameters:

sCode - code value normally snomed

sText - spelled out term

setUniversalServiceId

public void setUniversalServiceId(CEElement ceServiceId)

Set the coded universal service identifier as a preformed CE Element.

Note: For VMDB submissions this will always be called as
setUniversalServiceId( Loinc.CHART_ABSTRACT );
If we can figure out where to put it, we may make this a default. The problem with that would be confusion when used for other applications.

Parameters:

ceServiceId - CEElement preformed usually constant from LOINC or SNOMED

getUniversalServiceId

public CEElement getUniversalServiceId()

Get the coded universal service identifier as a preformed CE Element.

Returns:

A reference to a CEElement with the Universal Service ID. Normally a preformed usually constant from LOINC or SNOMED

getUniversalServiceIdText

public java.lang.String getUniversalServiceIdText()

Get the universal service identifier text.

Returns:

String text of the type of service "requested." In VMDB submissions this is always "Chart Abstract"

setObservationDateTime

public void setObservationDateTime(java.lang.String sDateTime)

Set the observation date/time of the message to string formatted date/time.

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getObservationDateTime

public java.lang.String getObservationDateTime()

Get the observation date/time as a string.

Returns:

String date/time

modifyObservation

public OBXSegment modifyObservation(OBXSegment obxRoot,
                                    CEElement ceIdentifier,
                                    CEElement ceModifier)

Modify a coded OBXSegment using predefined Coded Entry for identifier and code.

Often uses one of the set of predefined constants.
The same Modifier methods can be used for Complaints, Diagnoses, Procedures, Findings, etc., anything in a coded OBX.
This logic uses the SubId field value. Each root observation within a GRP_1 loop receives a unique integer SubId. Modifiers of that root receive the root's integer followed by a period and a sequential integer. Modifiers of modifiers similarly add another period and integer.
TODO: Get the correct nomenclature for ceIdentifier and adjust method and documentation accordingly.

Parameters:

obxRoot - The OBXSegment to which modifier is applied. Used to obtain SubId value for this segment.

ceIdentifier - CEElement using predefined snomed code for type of modification such as "with associated etiology" or "with laterality."

ceModifier - CEElement populated with modifier term.

listModifiers

public java.util.Iterator listModifiers(OBXSegment obxRoot)

Get the Modifier list as iterator over OBXSegment objects.

The implementation is going to be very Java-specific because it depends on garbage collection to maintain an instance of a Vector until Iterator is released.

Parameters:

obxRoot - The OBXSegment to which modifiers are applied. Used to obtain subId value for this segment. This does not need to be a root-level diagnosis, finding, etc.. It can be itself a modifier. It simply indicates the observation being modified by the modifiers returned. Similarly, modifiers of these modifiers are not returned. To retrieve them, call listModifiers again passign each of the OBXs in the iterator in turn. To retrieve all modifiers that affect this observation directly or indirectly, you would perform a depth-first recursive tree walk, but that--as they say--is an excercise left to the student.

Returns:

Iterator over collection of OBXSegment objects that modify the root OBX.

setChiefComplaint

public OBXSegment setChiefComplaint(CEElement ceChiefComplaint)

Set the Chief Complaint as a predefined CE Element. Often uses one of the set of predefined constants.

Parameters:

ceChiefComplaint - CEElement populated with Chief Complaint

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

setChiefComplaint

public OBXSegment setChiefComplaint(java.lang.String sChiefComplaintCode,
                                    java.lang.String sChiefComplaintText,
                                    java.lang.String sCodeSystem)

Set the Chief Complaint as the individual components of a CE Element.

Parameters:

sChiefComplaintCode - String snomed code for Chief Complaint

sChiefComplaintText - String Chief Complaint spelled out

sCodeSystem - String, usually SCT, with type of code

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

setChiefComplaint

public OBXSegment setChiefComplaint(java.lang.String sChiefComplaintCode,
                                    java.lang.String sChiefComplaintText,
                                    java.lang.String sCodeSystem,
                                    java.lang.String sAltChiefComplaintCode,
                                    java.lang.String sAltChiefComplaintText,
                                    java.lang.String sAltCodeSystem)

Set the Chief Complaint as the individual components of a CE Element.

Parameters:

sChiefComplaintCode - String snomed code for Chief Complaint

sChiefComplaintText - String Chief Complaint spelled out

sCodeSystem - String, usually SCT, with type of code

sAltChiefComplaintCode - String alternate code for the SAME Chief Complaint

sAltChiefComplaintText - String Chief Complaint spelled out as in alternate system

sAltCodeSystem - String, alternate type of code

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

getChiefComplaint

public CEElement getChiefComplaint()

Get the Chief Complaint as a predefined CE Element.

Often uses one of the set of predefined constants.

Returns:

CEElement populated with ChiefComplaint

getChiefComplaintText

public java.lang.String getChiefComplaintText()

Get the Chief Complaint text.

Returns:

String ChiefComplaint spelled out

addDiagnosis

public OBXSegment addDiagnosis(CEElement ceDiagnosis)

Add a Diagnosis as a predefined CE Element.

Often uses one of the set of predefined constants

Parameters:

ceDiagnosis - CEElement populated with the coded Diagnosis

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addDiagnosis

public OBXSegment addDiagnosis(CEElement ceDiagnosis,
                               boolean bRecheck)

Add a Diagnosis as a predefined CE Element.

Often uses one of the set of predefined constants

Parameters:

ceDiagnosis - CEElement populated with the coded Diagnosis

bRecheck - true if this diagnosis is a recheck (default false)

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addDiagnosis

public OBXSegment addDiagnosis(java.lang.String sDiagnosisCode,
                               java.lang.String sDiagnosisText,
                               java.lang.String sCodeSystem)

Add a Diagnosis as the individual components of the CE Element.

Parameters:

sDiagnosisCode - String snomed code for the Diagnosis

sDiagnosisText - String with the Diagnosis spelled out

sCodeSystem - String, usually "SCT," with the type of code used

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addDiagnosis

public OBXSegment addDiagnosis(java.lang.String sDiagnosisCode,
                               java.lang.String sDiagnosisText,
                               java.lang.String sCodeSystem,
                               java.lang.String sAltDiagnosisCode,
                               java.lang.String sAltDiagnosisText,
                               java.lang.String sAltCodeSystem)

Add a Diagnosis as the individual components of the CE Element.

Parameters:

sDiagnosisCode - String snomed code for the Diagnosis

sDiagnosisText - String with the Diagnosis spelled out

sCodeSystem - String, usually "SCT," with the type of code used

sAltDiagnosisCode - String alternate code for the Diagnosis

sAltDiagnosisText - String with the Diagnosis spelled out as in alternate system

sAltCodeSystem - String, alternate type of code used

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addDiagnosis

public OBXSegment addDiagnosis(java.lang.String sDiagnosisCode,
                               java.lang.String sDiagnosisText,
                               java.lang.String sCodeSystem,
                               boolean bRecheck)

Add a Diagnosis as the individual components of the CE Element.

Parameters:

sDiagnosisCode - String snomed code for the Diagnosis

sDiagnosisText - String with the Diagnosis spelled out

sCodeSystem - String, usually "SCT," with the type of code used

bRecheck - true if this diagnosis is a recheck (default false)

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addDiagnosis

public OBXSegment addDiagnosis(java.lang.String sDiagnosisCode,
                               java.lang.String sDiagnosisText,
                               java.lang.String sCodeSystem,
                               java.lang.String sAltDiagnosisCode,
                               java.lang.String sAltDiagnosisText,
                               java.lang.String sAltCodeSystem,
                               boolean bRecheck)

Add a Diagnosis as the individual components of the CE Element.

Parameters:

sDiagnosisCode - String snomed code for the Diagnosis

sDiagnosisText - String with the Diagnosis spelled out

sCodeSystem - String, usually "SCT," with the type of code used

sAltDiagnosisCode - String alternate code for the Diagnosis

sAltDiagnosisText - String with the Diagnosis spelled out as in alternate system

sAltCodeSystem - String, Alternate coding system

bRecheck - true if this diagnosis is a recheck (default false)

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

listDiagnoses

public java.util.Iterator listDiagnoses()

Get the Diagnosis list as an iterator over OBXSegment objects.

Often uses one of the set of predefined constants.
The implementation is going to be very Java-specific because it depends on garbage collection to maintain an instance of a Vector until Iterator is released.

Returns:

Iterator over collection of OBXSegment objects from Diagnosis OBXs

listRechecks

public java.util.Iterator listRechecks()

Get the Recheck list as an iterator over OBXSegment objects.

Often uses one of the set of predefined constants.
The implementation is going to be very Java-specific because it depends on garbage collection to maintain an instance of a Vector until Iterator is released.

Returns:

Iterator over collection of OBXSegment objects from Recheck OBXs

addProcedure

public OBXSegment addProcedure(CEElement ceProcedure)

Add a Procedure as a predefined CE Element.

Often uses one of the set of predefined constants

Parameters:

ceProcedure - CEElement populated with the coded Procedure

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addProcedure

public OBXSegment addProcedure(java.lang.String sProcedureCode,
                               java.lang.String sProcedureText,
                               java.lang.String sCodeSystem)

Add a Procedure as the individual components of a CE Element.

Parameters:

sProcedureCode - String with the code for Procedure

sProcedureText - String with the Procedure spelled out

sCodeSystem - String, usually "SCT," with the type of code

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addProcedure

public OBXSegment addProcedure(java.lang.String sProcedureCode,
                               java.lang.String sProcedureText,
                               java.lang.String sCodeSystem,
                               java.lang.String sAltProcedureCode,
                               java.lang.String sAltProcedureText,
                               java.lang.String sAltCodeSystem)

Add a Procedure as the individual components of a CE Element.

Parameters:

sProcedureCode - String with the code for Procedure

sProcedureText - String with the Procedure spelled out

sCodeSystem - String, usually "SCT," with the type of code

sAltProcedureCode - String alternate code for the SAME Procedure

sAltProcedureText - String with the Procedure spelled out as in the alternate system

sAltCodeSystem - String, alternate type of code

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

listProcedures

public java.util.Iterator listProcedures()

Get the Procedure list as an iterator over OBXSegment objects.

Often uses one of the set of predefined constants.
The implementation is going to be very Java-specific because it depends on garbage collection to maintain an instance of a Vector until Iterator is released.

Returns:

Iterator over collection of OBXSegment objects from Procedure OBXs

addFinding

public OBXSegment addFinding(CEElement ceFinding)

Add a Finding as a predefined CE Element.

Often uses one of the set of predefined constants

Parameters:

ceFinding - CEElement populated with the coded Finding

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addFinding

public OBXSegment addFinding(java.lang.String sFindingCode,
                             java.lang.String sFindingText,
                             java.lang.String sCodeSystem)

Add a Finding as the individual components of a CE Element.

Parameters:

sFindingCode - String with the code for Finding

sFindingText - String with the Finding spelled out

sCodeSystem - String, usually "SCT," with the type of code used

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

addFinding

public OBXSegment addFinding(java.lang.String sFindingCode,
                             java.lang.String sFindingText,
                             java.lang.String sCodeSystem,
                             java.lang.String sAltFindingCode,
                             java.lang.String sAltFindingText,
                             java.lang.String sAltCodeSystem)

Add a Finding as the individual components of a CE Element.

Parameters:

sFindingCode - String with the code for Finding

sFindingText - String with the Finding spelled out

sCodeSystem - String, usually "SCT," with the type of code used

sAltFindingCode - String alternate code for the SAME Finding

sAltFindingText - String with the Finding spelled out

sAltCodeSystem - String, aternate type of code used

Returns:

OBXSegment just added. This is normally used to apply modifiers if needed.

listFindings

public java.util.Iterator listFindings()

Get the Finding list as an iterator over OBXSegment objects.

Often uses one of the set of predefined constants.
The implementation is going to be very Java-specific because it depends on garbage collection to maintain an instance of a Vector until Iterator is released.

Returns:

Iterator over collection of OBXSegment objects from Finding OBXs