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

Class OM2

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.OM2
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class OM2 extends AbstractSegment

Represents an HL7 OM2 message segment (NUMERIC OBSERVATION). This segment has the following fields:

  • OM2-1: Segment Type ID (ST) optional
  • OM2-2: Sequence Number - Test/ Observation Master File (NM) optional
  • OM2-3: Units of Measure (CE) optional
  • OM2-4: Range of Decimal Precision (NM) optional
  • OM2-5: Corresponding SI Units of Measure (CE) optional
  • OM2-6: SI Conversion Factor (TX) repeating
  • OM2-7: Reference (normal) range - ordinal & continuous observations (CM_RFR) optional repeating
  • OM2-8: Critical range for ordinal and continuous observations (CM_RANGE) optional
  • OM2-9: Absolute range for ordinal and continuous observations (CM_ABS_RANGE) optional
  • OM2-10: Delta Check Criteria (CM_DLT) optional repeating
  • OM2-11: Minimum Meaningful Increments (NM) optional
See Also:

  • Constructor Details

  • Method Details

    • getSegmentTypeID

      public ST getSegmentTypeID()
      Returns OM2-1: "Segment Type ID" - creates it if necessary

    • getOm21_SegmentTypeID

      public ST getOm21_SegmentTypeID()
      Returns OM2-1: "Segment Type ID" - creates it if necessary

    • getSequenceNumberTestObservationMasterFile

      public NM getSequenceNumberTestObservationMasterFile()
      Returns OM2-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary

    • getOm22_SequenceNumberTestObservationMasterFile

      public NM getOm22_SequenceNumberTestObservationMasterFile()
      Returns OM2-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary

    • getUnitsOfMeasure

      public CE getUnitsOfMeasure()
      Returns OM2-3: "Units of Measure" - creates it if necessary

    • getOm23_UnitsOfMeasure

      public CE getOm23_UnitsOfMeasure()
      Returns OM2-3: "Units of Measure" - creates it if necessary

    • getRangeOfDecimalPrecision

      public NM getRangeOfDecimalPrecision()
      Returns OM2-4: "Range of Decimal Precision" - creates it if necessary

    • getOm24_RangeOfDecimalPrecision

      public NM getOm24_RangeOfDecimalPrecision()
      Returns OM2-4: "Range of Decimal Precision" - creates it if necessary

    • getCorrespondingSIUnitsOfMeasure

      public CE getCorrespondingSIUnitsOfMeasure()
      Returns OM2-5: "Corresponding SI Units of Measure" - creates it if necessary

    • getOm25_CorrespondingSIUnitsOfMeasure

      public CE getOm25_CorrespondingSIUnitsOfMeasure()
      Returns OM2-5: "Corresponding SI Units of Measure" - creates it if necessary

    • getSIConversionFactor

      public TX[] getSIConversionFactor()
      Returns all repetitions of SI Conversion Factor (OM2-6).

    • getOm26_SIConversionFactor

      public TX[] getOm26_SIConversionFactor()
      Returns all repetitions of SI Conversion Factor (OM2-6).

    • getSIConversionFactorReps

      public int getSIConversionFactorReps()
      Returns a count of the current number of repetitions of SI Conversion Factor (OM2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSIConversionFactor

      public TX getSIConversionFactor(int rep)
      Returns a specific repetition of OM2-6: "SI Conversion Factor" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm26_SIConversionFactor

      public TX getOm26_SIConversionFactor(int rep)
      Returns a specific repetition of OM2-6: "SI Conversion Factor" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm26_SIConversionFactorReps

      public int getOm26_SIConversionFactorReps()
      Returns a count of the current number of repetitions of SI Conversion Factor (OM2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSIConversionFactor

      public TX insertSIConversionFactor(int rep) throws HL7Exception
      Inserts a repetition of OM2-6: "SI Conversion Factor" 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)

    • insertOm26_SIConversionFactor

      public TX insertOm26_SIConversionFactor(int rep) throws HL7Exception
      Inserts a repetition of OM2-6: "SI Conversion Factor" 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)

    • removeSIConversionFactor

      public TX removeSIConversionFactor(int rep) throws HL7Exception
      Removes a repetition of OM2-6: "SI Conversion Factor" 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)

    • removeOm26_SIConversionFactor

      public TX removeOm26_SIConversionFactor(int rep) throws HL7Exception
      Removes a repetition of OM2-6: "SI Conversion Factor" 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)

    • getReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR[] getReferenceNormalRangeOrdinalContinuousObservations()
      Returns all repetitions of Reference (normal) range - ordinal & continuous observations (OM2-7).

    • getOm27_ReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR[] getOm27_ReferenceNormalRangeOrdinalContinuousObservations()
      Returns all repetitions of Reference (normal) range - ordinal & continuous observations (OM2-7).

    • getReferenceNormalRangeOrdinalContinuousObservationsReps

      public int getReferenceNormalRangeOrdinalContinuousObservationsReps()
      Returns a count of the current number of repetitions of Reference (normal) range - ordinal & continuous observations (OM2-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR getReferenceNormalRangeOrdinalContinuousObservations(int rep)
      Returns a specific repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm27_ReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR getOm27_ReferenceNormalRangeOrdinalContinuousObservations(int rep)
      Returns a specific repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm27_ReferenceNormalRangeOrdinalContinuousObservationsReps

      public int getOm27_ReferenceNormalRangeOrdinalContinuousObservationsReps()
      Returns a count of the current number of repetitions of Reference (normal) range - ordinal & continuous observations (OM2-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR insertReferenceNormalRangeOrdinalContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" 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)

    • insertOm27_ReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR insertOm27_ReferenceNormalRangeOrdinalContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" 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)

    • removeReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR removeReferenceNormalRangeOrdinalContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" 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)

    • removeOm27_ReferenceNormalRangeOrdinalContinuousObservations

      public CM_RFR removeOm27_ReferenceNormalRangeOrdinalContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-7: "Reference (normal) range - ordinal & continuous observations" 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)

    • getCriticalRangeForOrdinalAndContinuousObservations

      public CM_RANGE getCriticalRangeForOrdinalAndContinuousObservations()
      Returns OM2-8: "Critical range for ordinal and continuous observations" - creates it if necessary

    • getOm28_CriticalRangeForOrdinalAndContinuousObservations

      public CM_RANGE getOm28_CriticalRangeForOrdinalAndContinuousObservations()
      Returns OM2-8: "Critical range for ordinal and continuous observations" - creates it if necessary

    • getAbsoluteRangeForOrdinalAndContinuousObservations

      public CM_ABS_RANGE getAbsoluteRangeForOrdinalAndContinuousObservations()
      Returns OM2-9: "Absolute range for ordinal and continuous observations" - creates it if necessary

    • getOm29_AbsoluteRangeForOrdinalAndContinuousObservations

      public CM_ABS_RANGE getOm29_AbsoluteRangeForOrdinalAndContinuousObservations()
      Returns OM2-9: "Absolute range for ordinal and continuous observations" - creates it if necessary

    • getDeltaCheckCriteria

      public CM_DLT[] getDeltaCheckCriteria()
      Returns all repetitions of Delta Check Criteria (OM2-10).

    • getOm210_DeltaCheckCriteria

      public CM_DLT[] getOm210_DeltaCheckCriteria()
      Returns all repetitions of Delta Check Criteria (OM2-10).

    • getDeltaCheckCriteriaReps

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

    • getDeltaCheckCriteria

      public CM_DLT getDeltaCheckCriteria(int rep)
      Returns a specific repetition of OM2-10: "Delta Check Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm210_DeltaCheckCriteria

      public CM_DLT getOm210_DeltaCheckCriteria(int rep)
      Returns a specific repetition of OM2-10: "Delta Check Criteria" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm210_DeltaCheckCriteriaReps

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

    • insertDeltaCheckCriteria

      public CM_DLT insertDeltaCheckCriteria(int rep) throws HL7Exception
      Inserts a repetition of OM2-10: "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)

    • insertOm210_DeltaCheckCriteria

      public CM_DLT insertOm210_DeltaCheckCriteria(int rep) throws HL7Exception
      Inserts a repetition of OM2-10: "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 CM_DLT removeDeltaCheckCriteria(int rep) throws HL7Exception
      Removes a repetition of OM2-10: "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)

    • removeOm210_DeltaCheckCriteria

      public CM_DLT removeOm210_DeltaCheckCriteria(int rep) throws HL7Exception
      Removes a repetition of OM2-10: "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-11: "Minimum Meaningful Increments" - creates it if necessary

    • getOm211_MinimumMeaningfulIncrements

      public NM getOm211_MinimumMeaningfulIncrements()
      Returns OM2-11: "Minimum Meaningful Increments" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment