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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class OM4
extends AbstractSegment

Represents an HL7 OM4 message segment (Observations that Require Specimens). This segment has the following fields:

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CE	getAdditive() Returns OM4-7: "Additive" - creates it if necessary
TX	getContainerDescription() Returns OM4-3: "Container Description" - creates it if necessary
CE	getContainerUnits() Returns OM4-5: "Container Units" - creates it if necessary
NM	getContainerVolume() Returns OM4-4: "Container Volume" - creates it if necessary
ID	getDerivedSpecimen() Returns OM4-2: "Derived Specimen" - creates it if necessary
CQ	getMinimumCollectionVolume() Returns OM4-11: "Minimum Collection Volume" - creates it if necessary
CQ	getNormalCollectionVolume() Returns OM4-10: "Normal Collection Volume" - creates it if necessary
NM	getOm41_SequenceNumberTestObservationMasterFile() Returns OM4-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CQ	getOm410_NormalCollectionVolume() Returns OM4-10: "Normal Collection Volume" - creates it if necessary
CQ	getOm411_MinimumCollectionVolume() Returns OM4-11: "Minimum Collection Volume" - creates it if necessary
TX	getOm412_SpecimenRequirements() Returns OM4-12: "Specimen Requirements" - creates it if necessary
ID	getOm413_SpecimenPriorities(int rep) Returns a specific repetition of OM4-13: "Specimen Priorities" - creates it if necessary
int	getOm413_SpecimenPrioritiesReps() Returns a count of the current number of repetitions of Specimen Priorities (OM4-13).
CQ	getOm414_SpecimenRetentionTime() Returns OM4-14: "Specimen Retention Time" - creates it if necessary
ID	getOm42_DerivedSpecimen() Returns OM4-2: "Derived Specimen" - creates it if necessary
TX	getOm43_ContainerDescription() Returns OM4-3: "Container Description" - creates it if necessary
NM	getOm44_ContainerVolume() Returns OM4-4: "Container Volume" - creates it if necessary
CE	getOm45_ContainerUnits() Returns OM4-5: "Container Units" - creates it if necessary
CE	getOm46_Specimen() Returns OM4-6: "Specimen" - creates it if necessary
CE	getOm47_Additive() Returns OM4-7: "Additive" - creates it if necessary
TX	getOm48_Preparation() Returns OM4-8: "Preparation" - creates it if necessary
TX	getOm49_SpecialHandlingRequirements() Returns OM4-9: "Special Handling Requirements" - creates it if necessary
TX	getPreparation() Returns OM4-8: "Preparation" - creates it if necessary
NM	getSequenceNumberTestObservationMasterFile() Returns OM4-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
TX	getSpecialHandlingRequirements() Returns OM4-9: "Special Handling Requirements" - creates it if necessary
CE	getSpecimen() Returns OM4-6: "Specimen" - creates it if necessary
ID[]	getSpecimenPriorities() Returns all repetitions of Specimen Priorities (OM4-13).
ID	getSpecimenPriorities(int rep) Returns a specific repetition of OM4-13: "Specimen Priorities" - creates it if necessary
int	getSpecimenPrioritiesReps() Returns a count of the current number of repetitions of Specimen Priorities (OM4-13).
TX	getSpecimenRequirements() Returns OM4-12: "Specimen Requirements" - creates it if necessary
CQ	getSpecimenRetentionTime() Returns OM4-14: "Specimen Retention Time" - creates it if necessary
ID	insertOm413_SpecimenPriorities(int rep) Inserts a repetition of OM4-13: "Specimen Priorities" at a specific index
ID	insertSpecimenPriorities(int rep) Inserts a repetition of OM4-13: "Specimen Priorities" at a specific index
ID	removeOm413_SpecimenPriorities(int rep) Removes a repetition of OM4-13: "Specimen Priorities" at a specific index
ID	removeSpecimenPriorities(int rep) Removes a repetition of OM4-13: "Specimen Priorities" 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

OM4

public OM4(Group parent,
           ModelClassFactory factory)

Creates a new OM4 segment

Method Detail

getSequenceNumberTestObservationMasterFile

public NM getSequenceNumberTestObservationMasterFile()

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

getOm41_SequenceNumberTestObservationMasterFile

public NM getOm41_SequenceNumberTestObservationMasterFile()

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

getDerivedSpecimen

public ID getDerivedSpecimen()

Returns OM4-2: "Derived Specimen" - creates it if necessary

getOm42_DerivedSpecimen

public ID getOm42_DerivedSpecimen()

Returns OM4-2: "Derived Specimen" - creates it if necessary

getContainerDescription

public TX getContainerDescription()

Returns OM4-3: "Container Description" - creates it if necessary

getOm43_ContainerDescription

public TX getOm43_ContainerDescription()

Returns OM4-3: "Container Description" - creates it if necessary

getContainerVolume

public NM getContainerVolume()

Returns OM4-4: "Container Volume" - creates it if necessary

getOm44_ContainerVolume

public NM getOm44_ContainerVolume()

Returns OM4-4: "Container Volume" - creates it if necessary

getContainerUnits

public CE getContainerUnits()

Returns OM4-5: "Container Units" - creates it if necessary

getOm45_ContainerUnits

public CE getOm45_ContainerUnits()

Returns OM4-5: "Container Units" - creates it if necessary

getSpecimen

public CE getSpecimen()

Returns OM4-6: "Specimen" - creates it if necessary

getOm46_Specimen

public CE getOm46_Specimen()

Returns OM4-6: "Specimen" - creates it if necessary

getAdditive

public CE getAdditive()

Returns OM4-7: "Additive" - creates it if necessary

getOm47_Additive

public CE getOm47_Additive()

Returns OM4-7: "Additive" - creates it if necessary

getPreparation

public TX getPreparation()

Returns OM4-8: "Preparation" - creates it if necessary

getOm48_Preparation

public TX getOm48_Preparation()

Returns OM4-8: "Preparation" - creates it if necessary

getSpecialHandlingRequirements

public TX getSpecialHandlingRequirements()

Returns OM4-9: "Special Handling Requirements" - creates it if necessary

getOm49_SpecialHandlingRequirements

public TX getOm49_SpecialHandlingRequirements()

Returns OM4-9: "Special Handling Requirements" - creates it if necessary

getNormalCollectionVolume

public CQ getNormalCollectionVolume()

Returns OM4-10: "Normal Collection Volume" - creates it if necessary

getOm410_NormalCollectionVolume

public CQ getOm410_NormalCollectionVolume()

Returns OM4-10: "Normal Collection Volume" - creates it if necessary

getMinimumCollectionVolume

public CQ getMinimumCollectionVolume()

Returns OM4-11: "Minimum Collection Volume" - creates it if necessary

getOm411_MinimumCollectionVolume

public CQ getOm411_MinimumCollectionVolume()

Returns OM4-11: "Minimum Collection Volume" - creates it if necessary

getSpecimenRequirements

public TX getSpecimenRequirements()

Returns OM4-12: "Specimen Requirements" - creates it if necessary

getOm412_SpecimenRequirements

public TX getOm412_SpecimenRequirements()

Returns OM4-12: "Specimen Requirements" - creates it if necessary

getSpecimenPriorities

public ID[] getSpecimenPriorities()

Returns all repetitions of Specimen Priorities (OM4-13).

getSpecimenPrioritiesReps

public int getSpecimenPrioritiesReps()

Returns a count of the current number of repetitions of Specimen Priorities (OM4-13). 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-13: "Specimen Priorities" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm413_SpecimenPriorities

public ID getOm413_SpecimenPriorities(int rep)

Returns a specific repetition of OM4-13: "Specimen Priorities" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm413_SpecimenPrioritiesReps

public int getOm413_SpecimenPrioritiesReps()

Returns a count of the current number of repetitions of Specimen Priorities (OM4-13). 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-13: "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)

insertOm413_SpecimenPriorities

public ID insertOm413_SpecimenPriorities(int rep)
                                  throws HL7Exception

Inserts a repetition of OM4-13: "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-13: "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)

removeOm413_SpecimenPriorities

public ID removeOm413_SpecimenPriorities(int rep)
                                  throws HL7Exception

Removes a repetition of OM4-13: "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 getSpecimenRetentionTime()

Returns OM4-14: "Specimen Retention Time" - creates it if necessary

getOm414_SpecimenRetentionTime

public CQ getOm414_SpecimenRetentionTime()

Returns OM4-14: "Specimen Retention Time" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment