Package ca.uhn.hl7v2.model.v23.segment

Class OM5

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v23.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: Sequence Number - Test/ Observation Master File (NM) optional
• OM5-2: Test/Observations Included w/an Ordered Test Battery (CE) optional repeating
• OM5-3: 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-3: "Observation ID Suffixes" - creates it if necessary
NM	getOm51_SequenceNumberTestObservationMasterFile()	Returns OM5-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE[]	getOm52_TestObservationsIncludedWAnOrderedTestBattery()	Returns all repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).
CE	getOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)	Returns a specific repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" - creates it if necessary
int	getOm52_TestObservationsIncludedWAnOrderedTestBatteryReps()	Returns a count of the current number of repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).
ST	getOm53_ObservationIDSuffixes()	Returns OM5-3: "Observation ID Suffixes" - creates it if necessary
NM	getSequenceNumberTestObservationMasterFile()	Returns OM5-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE[]	getTestObservationsIncludedWAnOrderedTestBattery()	Returns all repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).
CE	getTestObservationsIncludedWAnOrderedTestBattery(int rep)	Returns a specific repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" - creates it if necessary
int	getTestObservationsIncludedWAnOrderedTestBatteryReps()	Returns a count of the current number of repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).
CE	insertOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)	Inserts a repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" at a specific index
CE	insertTestObservationsIncludedWAnOrderedTestBattery(int rep)	Inserts a repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" at a specific index
CE	removeOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)	Removes a repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" at a specific index
CE	removeTestObservationsIncludedWAnOrderedTestBattery(int rep)	Removes a repetition of OM5-2: "Test/Observations Included w/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

getSequenceNumberTestObservationMasterFile

public NM getSequenceNumberTestObservationMasterFile()

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

getOm51_SequenceNumberTestObservationMasterFile

public NM getOm51_SequenceNumberTestObservationMasterFile()

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

getTestObservationsIncludedWAnOrderedTestBattery

public CE[] getTestObservationsIncludedWAnOrderedTestBattery()

Returns all repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).

getOm52_TestObservationsIncludedWAnOrderedTestBattery

public CE[] getOm52_TestObservationsIncludedWAnOrderedTestBattery()

Returns all repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2).

getTestObservationsIncludedWAnOrderedTestBatteryReps

public int getTestObservationsIncludedWAnOrderedTestBatteryReps()

Returns a count of the current number of repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getTestObservationsIncludedWAnOrderedTestBattery

public CE getTestObservationsIncludedWAnOrderedTestBattery(int rep)

Returns a specific repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm52_TestObservationsIncludedWAnOrderedTestBattery

public CE getOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)

Returns a specific repetition of OM5-2: "Test/Observations Included w/an Ordered Test Battery" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm52_TestObservationsIncludedWAnOrderedTestBatteryReps

public int getOm52_TestObservationsIncludedWAnOrderedTestBatteryReps()

Returns a count of the current number of repetitions of Test/Observations Included w/an Ordered Test Battery (OM5-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertTestObservationsIncludedWAnOrderedTestBattery

public CE insertTestObservationsIncludedWAnOrderedTestBattery(int rep)
                                                       throws HL7Exception

Inserts a repetition of OM5-2: "Test/Observations Included w/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)

insertOm52_TestObservationsIncludedWAnOrderedTestBattery

public CE insertOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)
                                                            throws HL7Exception

Inserts a repetition of OM5-2: "Test/Observations Included w/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)

removeTestObservationsIncludedWAnOrderedTestBattery

public CE removeTestObservationsIncludedWAnOrderedTestBattery(int rep)
                                                       throws HL7Exception

Removes a repetition of OM5-2: "Test/Observations Included w/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)

removeOm52_TestObservationsIncludedWAnOrderedTestBattery

public CE removeOm52_TestObservationsIncludedWAnOrderedTestBattery(int rep)
                                                            throws HL7Exception

Removes a repetition of OM5-2: "Test/Observations Included w/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-3: "Observation ID Suffixes" - creates it if necessary

getOm53_ObservationIDSuffixes

public ST getOm53_ObservationIDSuffixes()

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

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment