ca.uhn.hl7v2.model.v24.segment
Class OM2

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.OM2

All Implemented Interfaces:

Segment, Structure, Serializable

public class OM2
extends AbstractSegment

Represents an HL7 OM2 message segment (Numeric Observation). This segment has the following fields:

• OM2-1: Sequence Number - Test/ Observation Master File (NM) optional
• OM2-2: Units of Measure (CE) optional
• OM2-3: Range of Decimal Precision (NM) optional repeating
• OM2-4: Corresponding SI Units of Measure (CE) optional
• OM2-5: SI Conversion Factor (TX) optional
• OM2-6: Reference (Normal) Range - Ordinal and Continuous Observations (RFR) optional
• OM2-7: Critical Range for Ordinal and Continuous Observations (NR) optional
• OM2-8: Absolute Range for Ordinal and Continuous Observations (RFR) optional
• OM2-9: Delta Check Criteria (DLT) optional repeating
• OM2-10: Minimum Meaningful Increments (NM) optional

See Also:

Serialized Form

Constructor Summary

OM2(Group parent, ModelClassFactory factory)
Creates a new OM2 segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
RFR	getAbsoluteRangeForOrdinalAndContinuousObservations() Returns OM2-8: "Absolute Range for Ordinal and Continuous Observations" - creates it if necessary
CE	getCorrespondingSIUnitsOfMeasure() Returns OM2-4: "Corresponding SI Units of Measure" - creates it if necessary
NR	getCriticalRangeForOrdinalAndContinuousObservations() Returns OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary
DLT[]	getDeltaCheckCriteria() Returns all repetitions of Delta Check Criteria (OM2-9).
DLT	getDeltaCheckCriteria(int rep) Returns a specific repetition of OM2-9: "Delta Check Criteria" - creates it if necessary
int	getDeltaCheckCriteriaReps() Returns a count of the current number of repetitions of Delta Check Criteria (OM2-9).
NM	getMinimumMeaningfulIncrements() Returns OM2-10: "Minimum Meaningful Increments" - creates it if necessary
NM	getOm21_SequenceNumberTestObservationMasterFile() Returns OM2-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
NM	getOm210_MinimumMeaningfulIncrements() Returns OM2-10: "Minimum Meaningful Increments" - creates it if necessary
CE	getOm22_UnitsOfMeasure() Returns OM2-2: "Units of Measure" - creates it if necessary
NM	getOm23_RangeOfDecimalPrecision(int rep) Returns a specific repetition of OM2-3: "Range of Decimal Precision" - creates it if necessary
int	getOm23_RangeOfDecimalPrecisionReps() Returns a count of the current number of repetitions of Range of Decimal Precision (OM2-3).
CE	getOm24_CorrespondingSIUnitsOfMeasure() Returns OM2-4: "Corresponding SI Units of Measure" - creates it if necessary
TX	getOm25_SIConversionFactor() Returns OM2-5: "SI Conversion Factor" - creates it if necessary
RFR	getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations() Returns OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary
NR	getOm27_CriticalRangeForOrdinalAndContinuousObservations() Returns OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary
RFR	getOm28_AbsoluteRangeForOrdinalAndContinuousObservations() Returns OM2-8: "Absolute Range for Ordinal and Continuous Observations" - creates it if necessary
DLT	getOm29_DeltaCheckCriteria(int rep) Returns a specific repetition of OM2-9: "Delta Check Criteria" - creates it if necessary
int	getOm29_DeltaCheckCriteriaReps() Returns a count of the current number of repetitions of Delta Check Criteria (OM2-9).
NM[]	getRangeOfDecimalPrecision() Returns all repetitions of Range of Decimal Precision (OM2-3).
NM	getRangeOfDecimalPrecision(int rep) Returns a specific repetition of OM2-3: "Range of Decimal Precision" - creates it if necessary
int	getRangeOfDecimalPrecisionReps() Returns a count of the current number of repetitions of Range of Decimal Precision (OM2-3).
RFR	getReferenceNormalRangeOrdinalAndContinuousObservations() Returns OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary
NM	getSequenceNumberTestObservationMasterFile() Returns OM2-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
TX	getSIConversionFactor() Returns OM2-5: "SI Conversion Factor" - creates it if necessary
CE	getUnitsOfMeasure() Returns OM2-2: "Units of Measure" - creates it if necessary
DLT	insertDeltaCheckCriteria(int rep) Inserts a repetition of OM2-9: "Delta Check Criteria" at a specific index
NM	insertOm23_RangeOfDecimalPrecision(int rep) Inserts a repetition of OM2-3: "Range of Decimal Precision" at a specific index
DLT	insertOm29_DeltaCheckCriteria(int rep) Inserts a repetition of OM2-9: "Delta Check Criteria" at a specific index
NM	insertRangeOfDecimalPrecision(int rep) Inserts a repetition of OM2-3: "Range of Decimal Precision" at a specific index
DLT	removeDeltaCheckCriteria(int rep) Removes a repetition of OM2-9: "Delta Check Criteria" at a specific index
NM	removeOm23_RangeOfDecimalPrecision(int rep) Removes a repetition of OM2-3: "Range of Decimal Precision" at a specific index
DLT	removeOm29_DeltaCheckCriteria(int rep) Removes a repetition of OM2-9: "Delta Check Criteria" at a specific index
NM	removeRangeOfDecimalPrecision(int rep) Removes a repetition of OM2-3: "Range of Decimal Precision" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

OM2

public OM2(Group parent,
           ModelClassFactory factory)

Creates a new OM2 segment

Method Detail

getSequenceNumberTestObservationMasterFile

public NM getSequenceNumberTestObservationMasterFile()

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

getOm21_SequenceNumberTestObservationMasterFile

public NM getOm21_SequenceNumberTestObservationMasterFile()

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

getUnitsOfMeasure

public CE getUnitsOfMeasure()

Returns OM2-2: "Units of Measure" - creates it if necessary

getOm22_UnitsOfMeasure

public CE getOm22_UnitsOfMeasure()

Returns OM2-2: "Units of Measure" - creates it if necessary

getRangeOfDecimalPrecision

public NM[] getRangeOfDecimalPrecision()

Returns all repetitions of Range of Decimal Precision (OM2-3).

getRangeOfDecimalPrecisionReps

public int getRangeOfDecimalPrecisionReps()

Returns a count of the current number of repetitions of Range of Decimal Precision (OM2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getRangeOfDecimalPrecision

public NM getRangeOfDecimalPrecision(int rep)

Returns a specific repetition of OM2-3: "Range of Decimal Precision" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm23_RangeOfDecimalPrecision

public NM getOm23_RangeOfDecimalPrecision(int rep)

Returns a specific repetition of OM2-3: "Range of Decimal Precision" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm23_RangeOfDecimalPrecisionReps

public int getOm23_RangeOfDecimalPrecisionReps()

Returns a count of the current number of repetitions of Range of Decimal Precision (OM2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertRangeOfDecimalPrecision

public NM insertRangeOfDecimalPrecision(int rep)
                                 throws HL7Exception

Inserts a repetition of OM2-3: "Range of Decimal Precision" 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)

insertOm23_RangeOfDecimalPrecision

public NM insertOm23_RangeOfDecimalPrecision(int rep)
                                      throws HL7Exception

Inserts a repetition of OM2-3: "Range of Decimal Precision" 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)

removeRangeOfDecimalPrecision

public NM removeRangeOfDecimalPrecision(int rep)
                                 throws HL7Exception

Removes a repetition of OM2-3: "Range of Decimal Precision" 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)

removeOm23_RangeOfDecimalPrecision

public NM removeOm23_RangeOfDecimalPrecision(int rep)
                                      throws HL7Exception

Removes a repetition of OM2-3: "Range of Decimal Precision" 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)

getCorrespondingSIUnitsOfMeasure

public CE getCorrespondingSIUnitsOfMeasure()

Returns OM2-4: "Corresponding SI Units of Measure" - creates it if necessary

getOm24_CorrespondingSIUnitsOfMeasure

public CE getOm24_CorrespondingSIUnitsOfMeasure()

Returns OM2-4: "Corresponding SI Units of Measure" - creates it if necessary

getSIConversionFactor

public TX getSIConversionFactor()

Returns OM2-5: "SI Conversion Factor" - creates it if necessary

getOm25_SIConversionFactor

public TX getOm25_SIConversionFactor()

Returns OM2-5: "SI Conversion Factor" - creates it if necessary

getReferenceNormalRangeOrdinalAndContinuousObservations

public RFR getReferenceNormalRangeOrdinalAndContinuousObservations()

Returns OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary

getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations

public RFR getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations()

Returns OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary

getCriticalRangeForOrdinalAndContinuousObservations

public NR getCriticalRangeForOrdinalAndContinuousObservations()

Returns OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary

getOm27_CriticalRangeForOrdinalAndContinuousObservations

public NR getOm27_CriticalRangeForOrdinalAndContinuousObservations()

Returns OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary

getAbsoluteRangeForOrdinalAndContinuousObservations

public RFR getAbsoluteRangeForOrdinalAndContinuousObservations()

Returns OM2-8: "Absolute Range for Ordinal and Continuous Observations" - creates it if necessary

getOm28_AbsoluteRangeForOrdinalAndContinuousObservations

public RFR getOm28_AbsoluteRangeForOrdinalAndContinuousObservations()

Returns OM2-8: "Absolute Range for Ordinal and Continuous Observations" - creates it if necessary

getDeltaCheckCriteria

public DLT[] getDeltaCheckCriteria()

Returns all repetitions of Delta Check Criteria (OM2-9).

getDeltaCheckCriteriaReps

public int getDeltaCheckCriteriaReps()

Returns a count of the current number of repetitions of Delta Check Criteria (OM2-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getDeltaCheckCriteria

public DLT getDeltaCheckCriteria(int rep)

Returns a specific repetition of OM2-9: "Delta Check Criteria" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm29_DeltaCheckCriteria

public DLT getOm29_DeltaCheckCriteria(int rep)

Returns a specific repetition of OM2-9: "Delta Check Criteria" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm29_DeltaCheckCriteriaReps

public int getOm29_DeltaCheckCriteriaReps()

Returns a count of the current number of repetitions of Delta Check Criteria (OM2-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertDeltaCheckCriteria

public DLT insertDeltaCheckCriteria(int rep)
                             throws HL7Exception

Inserts a repetition of OM2-9: "Delta Check Criteria" 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)

insertOm29_DeltaCheckCriteria

public DLT insertOm29_DeltaCheckCriteria(int rep)
                                  throws HL7Exception

Inserts a repetition of OM2-9: "Delta Check Criteria" 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)

removeDeltaCheckCriteria

public DLT removeDeltaCheckCriteria(int rep)
                             throws HL7Exception

Removes a repetition of OM2-9: "Delta Check Criteria" 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)

removeOm29_DeltaCheckCriteria

public DLT removeOm29_DeltaCheckCriteria(int rep)
                                  throws HL7Exception

Removes a repetition of OM2-9: "Delta Check Criteria" 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)

getMinimumMeaningfulIncrements

public NM getMinimumMeaningfulIncrements()

Returns OM2-10: "Minimum Meaningful Increments" - creates it if necessary

getOm210_MinimumMeaningfulIncrements

public NM getOm210_MinimumMeaningfulIncrements()

Returns OM2-10: "Minimum Meaningful Increments" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment