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

Class OM4

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

Represents an HL7 OM4 message segment (OBSERVATION that require specimens). This segment has the following fields:

  • OM4-1: Segment Type ID (ST) optional
  • OM4-2: Sequence Number - Test/ Observation Master File (NM) optional
  • OM4-3: Derived Specimen (ID) optional
  • OM4-4: Container Description (TX) optional
  • OM4-5: Container Volume (NM) optional
  • OM4-6: Container Units (CE) optional
  • OM4-7: Specimen (CE) optional
  • OM4-8: Additive (CE) optional
  • OM4-9: Preparation (TX) optional
  • OM4-10: Special Handling Requirements (TX) optional
  • OM4-11: Normal Collection Volume (CQ_QUANTITY) optional
  • OM4-12: Minimum Collection Volume (CQ_QUANTITY) optional
  • OM4-13: Specimen Requirements (TX) optional
  • OM4-14: Specimen Priorities (ID) optional repeating
  • OM4-15: Specimen Retention Time (CQ_QUANTITY) optional
See Also:

  • Constructor Details

  • Method Details

    • getSegmentTypeID

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

    • getOm41_SegmentTypeID

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

    • getSequenceNumberTestObservationMasterFile

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

    • getOm42_SequenceNumberTestObservationMasterFile

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

    • getDerivedSpecimen

      public ID getDerivedSpecimen()
      Returns OM4-3: "Derived Specimen" - creates it if necessary

    • getOm43_DerivedSpecimen

      public ID getOm43_DerivedSpecimen()
      Returns OM4-3: "Derived Specimen" - creates it if necessary

    • getContainerDescription

      public TX getContainerDescription()
      Returns OM4-4: "Container Description" - creates it if necessary

    • getOm44_ContainerDescription

      public TX getOm44_ContainerDescription()
      Returns OM4-4: "Container Description" - creates it if necessary

    • getContainerVolume

      public NM getContainerVolume()
      Returns OM4-5: "Container Volume" - creates it if necessary

    • getOm45_ContainerVolume

      public NM getOm45_ContainerVolume()
      Returns OM4-5: "Container Volume" - creates it if necessary

    • getContainerUnits

      public CE getContainerUnits()
      Returns OM4-6: "Container Units" - creates it if necessary

    • getOm46_ContainerUnits

      public CE getOm46_ContainerUnits()
      Returns OM4-6: "Container Units" - creates it if necessary

    • getSpecimen

      public CE getSpecimen()
      Returns OM4-7: "Specimen" - creates it if necessary

    • getOm47_Specimen

      public CE getOm47_Specimen()
      Returns OM4-7: "Specimen" - creates it if necessary

    • getAdditive

      public CE getAdditive()
      Returns OM4-8: "Additive" - creates it if necessary

    • getOm48_Additive

      public CE getOm48_Additive()
      Returns OM4-8: "Additive" - creates it if necessary

    • getPreparation

      public TX getPreparation()
      Returns OM4-9: "Preparation" - creates it if necessary

    • getOm49_Preparation

      public TX getOm49_Preparation()
      Returns OM4-9: "Preparation" - creates it if necessary

    • getSpecialHandlingRequirements

      public TX getSpecialHandlingRequirements()
      Returns OM4-10: "Special Handling Requirements" - creates it if necessary

    • getOm410_SpecialHandlingRequirements

      public TX getOm410_SpecialHandlingRequirements()
      Returns OM4-10: "Special Handling Requirements" - creates it if necessary

    • getNormalCollectionVolume

      public CQ_QUANTITY getNormalCollectionVolume()
      Returns OM4-11: "Normal Collection Volume" - creates it if necessary

    • getOm411_NormalCollectionVolume

      public CQ_QUANTITY getOm411_NormalCollectionVolume()
      Returns OM4-11: "Normal Collection Volume" - creates it if necessary

    • getMinimumCollectionVolume

      public CQ_QUANTITY getMinimumCollectionVolume()
      Returns OM4-12: "Minimum Collection Volume" - creates it if necessary

    • getOm412_MinimumCollectionVolume

      public CQ_QUANTITY getOm412_MinimumCollectionVolume()
      Returns OM4-12: "Minimum Collection Volume" - creates it if necessary

    • getSpecimenRequirements

      public TX getSpecimenRequirements()
      Returns OM4-13: "Specimen Requirements" - creates it if necessary

    • getOm413_SpecimenRequirements

      public TX getOm413_SpecimenRequirements()
      Returns OM4-13: "Specimen Requirements" - creates it if necessary

    • getSpecimenPriorities

      public ID[] getSpecimenPriorities()
      Returns all repetitions of Specimen Priorities (OM4-14).

    • getOm414_SpecimenPriorities

      public ID[] getOm414_SpecimenPriorities()
      Returns all repetitions of Specimen Priorities (OM4-14).

    • getSpecimenPrioritiesReps

      public int getSpecimenPrioritiesReps()
      Returns a count of the current number of repetitions of Specimen Priorities (OM4-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenPriorities

      public ID getSpecimenPriorities(int rep)
      Returns a specific repetition of OM4-14: "Specimen Priorities" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm414_SpecimenPriorities

      public ID getOm414_SpecimenPriorities(int rep)
      Returns a specific repetition of OM4-14: "Specimen Priorities" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getOm414_SpecimenPrioritiesReps

      public int getOm414_SpecimenPrioritiesReps()
      Returns a count of the current number of repetitions of Specimen Priorities (OM4-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenPriorities

      public ID insertSpecimenPriorities(int rep) throws HL7Exception
      Inserts a repetition of OM4-14: "Specimen Priorities" 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)

    • insertOm414_SpecimenPriorities

      public ID insertOm414_SpecimenPriorities(int rep) throws HL7Exception
      Inserts a repetition of OM4-14: "Specimen Priorities" 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)

    • removeSpecimenPriorities

      public ID removeSpecimenPriorities(int rep) throws HL7Exception
      Removes a repetition of OM4-14: "Specimen Priorities" 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)

    • removeOm414_SpecimenPriorities

      public ID removeOm414_SpecimenPriorities(int rep) throws HL7Exception
      Removes a repetition of OM4-14: "Specimen Priorities" 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)

    • getSpecimenRetentionTime

      public CQ_QUANTITY getSpecimenRetentionTime()
      Returns OM4-15: "Specimen Retention Time" - creates it if necessary

    • getOm415_SpecimenRetentionTime

      public CQ_QUANTITY getOm415_SpecimenRetentionTime()
      Returns OM4-15: "Specimen Retention Time" - creates it if necessary

    • createNewTypeWithoutReflection

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