Package ca.uhn.hl7v2.model.v251.segment

Class OM2

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v251.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: 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 repeating
  • OM2-7: Critical Range for Ordinal and Continuous Observations (RFR) optional repeating
  • 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:

  • Constructor Details

  • Method Details

    • 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).

    • getOm23_RangeOfDecimalPrecision

      public NM[] getOm23_RangeOfDecimalPrecision()
      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 all repetitions of Reference (Normal) Range - Ordinal and Continuous Observations (OM2-6).

    • getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR[] getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations()
      Returns all repetitions of Reference (Normal) Range - Ordinal and Continuous Observations (OM2-6).

    • getReferenceNormalRangeOrdinalAndContinuousObservationsReps

      public int getReferenceNormalRangeOrdinalAndContinuousObservationsReps()
      Returns a count of the current number of repetitions of Reference (Normal) Range - Ordinal and Continuous Observations (OM2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR getReferenceNormalRangeOrdinalAndContinuousObservations(int rep)
      Returns a specific repetition of OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR getOm26_ReferenceNormalRangeOrdinalAndContinuousObservations(int rep)
      Returns a specific repetition of OM2-6: "Reference (Normal) Range - Ordinal and Continuous Observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm26_ReferenceNormalRangeOrdinalAndContinuousObservationsReps

      public int getOm26_ReferenceNormalRangeOrdinalAndContinuousObservationsReps()
      Returns a count of the current number of repetitions of Reference (Normal) Range - Ordinal and Continuous Observations (OM2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR insertReferenceNormalRangeOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-6: "Reference (Normal) Range - Ordinal and 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)

    • insertOm26_ReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR insertOm26_ReferenceNormalRangeOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-6: "Reference (Normal) Range - Ordinal and 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)

    • removeReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR removeReferenceNormalRangeOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-6: "Reference (Normal) Range - Ordinal and 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)

    • removeOm26_ReferenceNormalRangeOrdinalAndContinuousObservations

      public RFR removeOm26_ReferenceNormalRangeOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-6: "Reference (Normal) Range - Ordinal and 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 RFR[] getCriticalRangeForOrdinalAndContinuousObservations()
      Returns all repetitions of Critical Range for Ordinal and Continuous Observations (OM2-7).

    • getOm27_CriticalRangeForOrdinalAndContinuousObservations

      public RFR[] getOm27_CriticalRangeForOrdinalAndContinuousObservations()
      Returns all repetitions of Critical Range for Ordinal and Continuous Observations (OM2-7).

    • getCriticalRangeForOrdinalAndContinuousObservationsReps

      public int getCriticalRangeForOrdinalAndContinuousObservationsReps()
      Returns a count of the current number of repetitions of Critical Range for Ordinal and 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.

    • getCriticalRangeForOrdinalAndContinuousObservations

      public RFR getCriticalRangeForOrdinalAndContinuousObservations(int rep)
      Returns a specific repetition of OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm27_CriticalRangeForOrdinalAndContinuousObservations

      public RFR getOm27_CriticalRangeForOrdinalAndContinuousObservations(int rep)
      Returns a specific repetition of OM2-7: "Critical Range for Ordinal and Continuous Observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm27_CriticalRangeForOrdinalAndContinuousObservationsReps

      public int getOm27_CriticalRangeForOrdinalAndContinuousObservationsReps()
      Returns a count of the current number of repetitions of Critical Range for Ordinal and 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.

    • insertCriticalRangeForOrdinalAndContinuousObservations

      public RFR insertCriticalRangeForOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-7: "Critical Range for Ordinal and 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_CriticalRangeForOrdinalAndContinuousObservations

      public RFR insertOm27_CriticalRangeForOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Inserts a repetition of OM2-7: "Critical Range for Ordinal and 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)

    • removeCriticalRangeForOrdinalAndContinuousObservations

      public RFR removeCriticalRangeForOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-7: "Critical Range for Ordinal and 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_CriticalRangeForOrdinalAndContinuousObservations

      public RFR removeOm27_CriticalRangeForOrdinalAndContinuousObservations(int rep) throws HL7Exception
      Removes a repetition of OM2-7: "Critical Range for Ordinal and 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)

    • 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).

    • getOm29_DeltaCheckCriteria

      public DLT[] getOm29_DeltaCheckCriteria()
      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