Package ca.uhn.hl7v2.model.v24.segment

Class OM3

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v24.segment.OM3

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class OM3
extends AbstractSegment

Represents an HL7 OM3 message segment (Categorical Service/Test/Observation). This segment has the following fields:

• OM3-1: Sequence Number - Test/ Observation Master File (NM) optional
• OM3-2: Preferred Coding System (CE) optional
• OM3-3: Valid Coded "Answers" (CE) optional
• OM3-4: Normal Text/Codes for Categorical Observations (CE) optional repeating
• OM3-5: Abnormal Text/Codes for Categorical Observations (CE) optional
• OM3-6: Critical Text/Codes for Categorical Observations (CE) optional
• OM3-7: Value Type (ID) optional

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
OM3(Group parent, ModelClassFactory factory)	Creates a new OM3 segment

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
CE	getAbnormalTextCodesForCategoricalObservations()	Returns OM3-5: "Abnormal Text/Codes for Categorical Observations" - creates it if necessary
CE	getCriticalTextCodesForCategoricalObservations()	Returns OM3-6: "Critical Text/Codes for Categorical Observations" - creates it if necessary
CE[]	getNormalTextCodesForCategoricalObservations()	Returns all repetitions of Normal Text/Codes for Categorical Observations (OM3-4).
CE	getNormalTextCodesForCategoricalObservations(int rep)	Returns a specific repetition of OM3-4: "Normal Text/Codes for Categorical Observations" - creates it if necessary
int	getNormalTextCodesForCategoricalObservationsReps()	Returns a count of the current number of repetitions of Normal Text/Codes for Categorical Observations (OM3-4).
NM	getOm31_SequenceNumberTestObservationMasterFile()	Returns OM3-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE	getOm32_PreferredCodingSystem()	Returns OM3-2: "Preferred Coding System" - creates it if necessary
CE	getOm33_ValidCodedAnswers()	Returns OM3-3: "Valid Coded "Answers"" - creates it if necessary
CE[]	getOm34_NormalTextCodesForCategoricalObservations()	Returns all repetitions of Normal Text/Codes for Categorical Observations (OM3-4).
CE	getOm34_NormalTextCodesForCategoricalObservations(int rep)	Returns a specific repetition of OM3-4: "Normal Text/Codes for Categorical Observations" - creates it if necessary
int	getOm34_NormalTextCodesForCategoricalObservationsReps()	Returns a count of the current number of repetitions of Normal Text/Codes for Categorical Observations (OM3-4).
CE	getOm35_AbnormalTextCodesForCategoricalObservations()	Returns OM3-5: "Abnormal Text/Codes for Categorical Observations" - creates it if necessary
CE	getOm36_CriticalTextCodesForCategoricalObservations()	Returns OM3-6: "Critical Text/Codes for Categorical Observations" - creates it if necessary
ID	getOm37_ValueType()	Returns OM3-7: "Value Type" - creates it if necessary
CE	getPreferredCodingSystem()	Returns OM3-2: "Preferred Coding System" - creates it if necessary
NM	getSequenceNumberTestObservationMasterFile()	Returns OM3-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary
CE	getValidCodedAnswers()	Returns OM3-3: "Valid Coded "Answers"" - creates it if necessary
ID	getValueType()	Returns OM3-7: "Value Type" - creates it if necessary
CE	insertNormalTextCodesForCategoricalObservations(int rep)	Inserts a repetition of OM3-4: "Normal Text/Codes for Categorical Observations" at a specific index
CE	insertOm34_NormalTextCodesForCategoricalObservations(int rep)	Inserts a repetition of OM3-4: "Normal Text/Codes for Categorical Observations" at a specific index
CE	removeNormalTextCodesForCategoricalObservations(int rep)	Removes a repetition of OM3-4: "Normal Text/Codes for Categorical Observations" at a specific index
CE	removeOm34_NormalTextCodesForCategoricalObservations(int rep)	Removes a repetition of OM3-4: "Normal Text/Codes for Categorical Observations" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

OM3

public OM3(Group parent,
 ModelClassFactory factory)

Creates a new OM3 segment

Method Details

getSequenceNumberTestObservationMasterFile

public NM getSequenceNumberTestObservationMasterFile()

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

getOm31_SequenceNumberTestObservationMasterFile

public NM getOm31_SequenceNumberTestObservationMasterFile()

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

getPreferredCodingSystem

public CE getPreferredCodingSystem()

Returns OM3-2: "Preferred Coding System" - creates it if necessary

getOm32_PreferredCodingSystem

public CE getOm32_PreferredCodingSystem()

Returns OM3-2: "Preferred Coding System" - creates it if necessary

getValidCodedAnswers

public CE getValidCodedAnswers()

Returns OM3-3: "Valid Coded "Answers"" - creates it if necessary

getOm33_ValidCodedAnswers

public CE getOm33_ValidCodedAnswers()

Returns OM3-3: "Valid Coded "Answers"" - creates it if necessary

getNormalTextCodesForCategoricalObservations

public CE[] getNormalTextCodesForCategoricalObservations()

Returns all repetitions of Normal Text/Codes for Categorical Observations (OM3-4).

getOm34_NormalTextCodesForCategoricalObservations

public CE[] getOm34_NormalTextCodesForCategoricalObservations()

Returns all repetitions of Normal Text/Codes for Categorical Observations (OM3-4).

getNormalTextCodesForCategoricalObservationsReps

public int getNormalTextCodesForCategoricalObservationsReps()

Returns a count of the current number of repetitions of Normal Text/Codes for Categorical Observations (OM3-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getNormalTextCodesForCategoricalObservations

public CE getNormalTextCodesForCategoricalObservations(int rep)

Returns a specific repetition of OM3-4: "Normal Text/Codes for Categorical Observations" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm34_NormalTextCodesForCategoricalObservations

public CE getOm34_NormalTextCodesForCategoricalObservations(int rep)

Returns a specific repetition of OM3-4: "Normal Text/Codes for Categorical Observations" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOm34_NormalTextCodesForCategoricalObservationsReps

public int getOm34_NormalTextCodesForCategoricalObservationsReps()

Returns a count of the current number of repetitions of Normal Text/Codes for Categorical Observations (OM3-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertNormalTextCodesForCategoricalObservations

public CE insertNormalTextCodesForCategoricalObservations(int rep)
                                                   throws HL7Exception

Inserts a repetition of OM3-4: "Normal Text/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)

insertOm34_NormalTextCodesForCategoricalObservations

public CE insertOm34_NormalTextCodesForCategoricalObservations(int rep)
                                                        throws HL7Exception

Inserts a repetition of OM3-4: "Normal Text/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)

removeNormalTextCodesForCategoricalObservations

public CE removeNormalTextCodesForCategoricalObservations(int rep)
                                                   throws HL7Exception

Removes a repetition of OM3-4: "Normal Text/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)

removeOm34_NormalTextCodesForCategoricalObservations

public CE removeOm34_NormalTextCodesForCategoricalObservations(int rep)
                                                        throws HL7Exception

Removes a repetition of OM3-4: "Normal Text/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)

getAbnormalTextCodesForCategoricalObservations

public CE getAbnormalTextCodesForCategoricalObservations()

Returns OM3-5: "Abnormal Text/Codes for Categorical Observations" - creates it if necessary

getOm35_AbnormalTextCodesForCategoricalObservations

public CE getOm35_AbnormalTextCodesForCategoricalObservations()

Returns OM3-5: "Abnormal Text/Codes for Categorical Observations" - creates it if necessary

getCriticalTextCodesForCategoricalObservations

public CE getCriticalTextCodesForCategoricalObservations()

Returns OM3-6: "Critical Text/Codes for Categorical Observations" - creates it if necessary

getOm36_CriticalTextCodesForCategoricalObservations

public CE getOm36_CriticalTextCodesForCategoricalObservations()

Returns OM3-6: "Critical Text/Codes for Categorical Observations" - creates it if necessary

getValueType

public ID getValueType()

Returns OM3-7: "Value Type" - creates it if necessary

getOm37_ValueType

public ID getOm37_ValueType()

Returns OM3-7: "Value Type" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment