Package ca.uhn.hl7v2.model.v22.segment

Class OM5

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v22.segment.OM5

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class OM5
extends AbstractSegment

Represents an HL7 OM5 message segment (OBSERVATION BATTERIES). This segment has the following fields:

• OM5-1: Segment Type ID (ST) optional
• OM5-2: Sequence Number - Test/ Observation Master File (NM) optional
• OM5-3: Tests / observations included within an ordered test battery (CE) optional repeating
• OM5-4: Observation ID Suffixes (ST) optional

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
OM5(Group parent, ModelClassFactory factory)	Creates a new OM5 segment

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
ST	getObservationIDSuffixes()	Returns OM5-4: "Observation ID Suffixes" - creates it if necessary
ST	getOm51_SegmentTypeID()	Returns OM5-1: "Segment Type ID" - creates it if necessary
NM	getOm52_SequenceNumberTestObservationMasterFile()	Returns OM5-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE[]	getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery()	Returns all repetitions of Tests / observations included within an ordered test battery (OM5-3).
CE	getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Returns a specific repetition of OM5-3: "Tests / observations included within an ordered test battery" - creates it if necessary
int	getOm53_TestsObservationsIncludedWithinAnOrderedTestBatteryReps()	Returns a count of the current number of repetitions of Tests / observations included within an ordered test battery (OM5-3).
ST	getOm54_ObservationIDSuffixes()	Returns OM5-4: "Observation ID Suffixes" - creates it if necessary
ST	getSegmentTypeID()	Returns OM5-1: "Segment Type ID" - creates it if necessary
NM	getSequenceNumberTestObservationMasterFile()	Returns OM5-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE[]	getTestsObservationsIncludedWithinAnOrderedTestBattery()	Returns all repetitions of Tests / observations included within an ordered test battery (OM5-3).
CE	getTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Returns a specific repetition of OM5-3: "Tests / observations included within an ordered test battery" - creates it if necessary
int	getTestsObservationsIncludedWithinAnOrderedTestBatteryReps()	Returns a count of the current number of repetitions of Tests / observations included within an ordered test battery (OM5-3).
CE	insertOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Inserts a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index
CE	insertTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Inserts a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index
CE	removeOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Removes a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index
CE	removeTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)	Removes a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

OM5

public OM5(Group parent,
 ModelClassFactory factory)

Creates a new OM5 segment

Method Details

getSegmentTypeID

public ST getSegmentTypeID()

Returns OM5-1: "Segment Type ID" - creates it if necessary

getOm51_SegmentTypeID

public ST getOm51_SegmentTypeID()

Returns OM5-1: "Segment Type ID" - creates it if necessary

getSequenceNumberTestObservationMasterFile

public NM getSequenceNumberTestObservationMasterFile()

Returns OM5-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary

getOm52_SequenceNumberTestObservationMasterFile

public NM getOm52_SequenceNumberTestObservationMasterFile()

Returns OM5-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary

getTestsObservationsIncludedWithinAnOrderedTestBattery

public CE[] getTestsObservationsIncludedWithinAnOrderedTestBattery()

Returns all repetitions of Tests / observations included within an ordered test battery (OM5-3).

getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery

public CE[] getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery()

Returns all repetitions of Tests / observations included within an ordered test battery (OM5-3).

getTestsObservationsIncludedWithinAnOrderedTestBatteryReps

public int getTestsObservationsIncludedWithinAnOrderedTestBatteryReps()

Returns a count of the current number of repetitions of Tests / observations included within an ordered test battery (OM5-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getTestsObservationsIncludedWithinAnOrderedTestBattery

public CE getTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)

Returns a specific repetition of OM5-3: "Tests / observations included within an ordered test battery" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery

public CE getOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)

Returns a specific repetition of OM5-3: "Tests / observations included within an ordered test battery" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm53_TestsObservationsIncludedWithinAnOrderedTestBatteryReps

public int getOm53_TestsObservationsIncludedWithinAnOrderedTestBatteryReps()

Returns a count of the current number of repetitions of Tests / observations included within an ordered test battery (OM5-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertTestsObservationsIncludedWithinAnOrderedTestBattery

public CE insertTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)
                                                             throws HL7Exception

Inserts a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertOm53_TestsObservationsIncludedWithinAnOrderedTestBattery

public CE insertOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)
                                                                  throws HL7Exception

Inserts a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeTestsObservationsIncludedWithinAnOrderedTestBattery

public CE removeTestsObservationsIncludedWithinAnOrderedTestBattery(int rep)
                                                             throws HL7Exception

Removes a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeOm53_TestsObservationsIncludedWithinAnOrderedTestBattery

public CE removeOm53_TestsObservationsIncludedWithinAnOrderedTestBattery(int rep)
                                                                  throws HL7Exception

Removes a repetition of OM5-3: "Tests / observations included within an ordered test battery" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getObservationIDSuffixes

public ST getObservationIDSuffixes()

Returns OM5-4: "Observation ID Suffixes" - creates it if necessary

getOm54_ObservationIDSuffixes

public ST getOm54_ObservationIDSuffixes()

Returns OM5-4: "Observation ID Suffixes" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment