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

Class OM3

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

Represents an HL7 OM3 message segment (CATEGORICAL TEST/OBSERVATION). This segment has the following fields:

  • OM3-1: Segment Type ID (ST) optional
  • OM3-2: Sequence Number - Test/ Observation Master File (NM) optional
  • OM3-3: Preferred Coding System (ID) optional
  • OM3-4: Valid coded answers (CE) optional repeating
  • OM3-5: Normal test codes for categorical observations (CE) optional repeating
  • OM3-6: Abnormal test codes for categorical observations (CE) optional
  • OM3-7: Critical test codes for categorical observations (CE) optional
  • OM3-8: Data Type (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getSegmentTypeID

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

    • getOm31_SegmentTypeID

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

    • getSequenceNumberTestObservationMasterFile

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

    • getOm32_SequenceNumberTestObservationMasterFile

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

    • getPreferredCodingSystem

      public ID getPreferredCodingSystem()
      Returns OM3-3: "Preferred Coding System" - creates it if necessary

    • getOm33_PreferredCodingSystem

      public ID getOm33_PreferredCodingSystem()
      Returns OM3-3: "Preferred Coding System" - creates it if necessary

    • getValidCodedAnswers

      public CE[] getValidCodedAnswers()
      Returns all repetitions of Valid coded answers (OM3-4).

    • getOm34_ValidCodedAnswers

      public CE[] getOm34_ValidCodedAnswers()
      Returns all repetitions of Valid coded answers (OM3-4).

    • getValidCodedAnswersReps

      public int getValidCodedAnswersReps()
      Returns a count of the current number of repetitions of Valid coded answers (OM3-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getValidCodedAnswers

      public CE getValidCodedAnswers(int rep)
      Returns a specific repetition of OM3-4: "Valid coded answers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm34_ValidCodedAnswers

      public CE getOm34_ValidCodedAnswers(int rep)
      Returns a specific repetition of OM3-4: "Valid coded answers" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm34_ValidCodedAnswersReps

      public int getOm34_ValidCodedAnswersReps()
      Returns a count of the current number of repetitions of Valid coded answers (OM3-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertValidCodedAnswers

      public CE insertValidCodedAnswers(int rep) throws HL7Exception
      Inserts a repetition of OM3-4: "Valid coded answers" 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)

    • insertOm34_ValidCodedAnswers

      public CE insertOm34_ValidCodedAnswers(int rep) throws HL7Exception
      Inserts a repetition of OM3-4: "Valid coded answers" 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)

    • removeValidCodedAnswers

      public CE removeValidCodedAnswers(int rep) throws HL7Exception
      Removes a repetition of OM3-4: "Valid coded answers" 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)

    • removeOm34_ValidCodedAnswers

      public CE removeOm34_ValidCodedAnswers(int rep) throws HL7Exception
      Removes a repetition of OM3-4: "Valid coded answers" 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)

    • getNormalTestCodesForCategoricalObservations

      public CE[] getNormalTestCodesForCategoricalObservations()
      Returns all repetitions of Normal test codes for categorical observations (OM3-5).

    • getOm35_NormalTestCodesForCategoricalObservations

      public CE[] getOm35_NormalTestCodesForCategoricalObservations()
      Returns all repetitions of Normal test codes for categorical observations (OM3-5).

    • getNormalTestCodesForCategoricalObservationsReps

      public int getNormalTestCodesForCategoricalObservationsReps()
      Returns a count of the current number of repetitions of Normal test codes for categorical observations (OM3-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getNormalTestCodesForCategoricalObservations

      public CE getNormalTestCodesForCategoricalObservations(int rep)
      Returns a specific repetition of OM3-5: "Normal test codes for categorical observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm35_NormalTestCodesForCategoricalObservations

      public CE getOm35_NormalTestCodesForCategoricalObservations(int rep)
      Returns a specific repetition of OM3-5: "Normal test codes for categorical observations" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm35_NormalTestCodesForCategoricalObservationsReps

      public int getOm35_NormalTestCodesForCategoricalObservationsReps()
      Returns a count of the current number of repetitions of Normal test codes for categorical observations (OM3-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertNormalTestCodesForCategoricalObservations

      public CE insertNormalTestCodesForCategoricalObservations(int rep) throws HL7Exception
      Inserts a repetition of OM3-5: "Normal test codes for categorical 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)

    • insertOm35_NormalTestCodesForCategoricalObservations

      public CE insertOm35_NormalTestCodesForCategoricalObservations(int rep) throws HL7Exception
      Inserts a repetition of OM3-5: "Normal test codes for categorical 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)

    • removeNormalTestCodesForCategoricalObservations

      public CE removeNormalTestCodesForCategoricalObservations(int rep) throws HL7Exception
      Removes a repetition of OM3-5: "Normal test codes for categorical 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)

    • removeOm35_NormalTestCodesForCategoricalObservations

      public CE removeOm35_NormalTestCodesForCategoricalObservations(int rep) throws HL7Exception
      Removes a repetition of OM3-5: "Normal test codes for categorical 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)

    • getAbnormalTestCodesForCategoricalObservations

      public CE getAbnormalTestCodesForCategoricalObservations()
      Returns OM3-6: "Abnormal test codes for categorical observations" - creates it if necessary

    • getOm36_AbnormalTestCodesForCategoricalObservations

      public CE getOm36_AbnormalTestCodesForCategoricalObservations()
      Returns OM3-6: "Abnormal test codes for categorical observations" - creates it if necessary

    • getCriticalTestCodesForCategoricalObservations

      public CE getCriticalTestCodesForCategoricalObservations()
      Returns OM3-7: "Critical test codes for categorical observations" - creates it if necessary

    • getOm37_CriticalTestCodesForCategoricalObservations

      public CE getOm37_CriticalTestCodesForCategoricalObservations()
      Returns OM3-7: "Critical test codes for categorical observations" - creates it if necessary

    • getDataType

      public ID getDataType()
      Returns OM3-8: "Data Type" - creates it if necessary

    • getOm38_DataType

      public ID getOm38_DataType()
      Returns OM3-8: "Data Type" - creates it if necessary

    • createNewTypeWithoutReflection

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