ca.uhn.hl7v2.model.v231.group

Class MFN_M09_OM3OM4

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.MFN_M09_OM3OM4

All Implemented Interfaces:

Group, Structure, Serializable

public class MFN_M09_OM3OM4
extends AbstractGroup

Represents a MFN_M09_OM3OM4 group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: OM3 (OM3 - categorical test/observation segment)
• 2: OM4 (OM4 - observations that require specimens segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
MFN_M09_OM3OM4(Group parent, ModelClassFactory factory) Creates a new MFN_M09_OM3OM4 group

Method Summary

Methods

Modifier and Type	Method and Description
OM3	getOM3() Returns OM3 (OM3 - categorical test/observation segment) - creates it if necessary
OM4	getOM4() Returns the first repetition of OM4 (OM4 - observations that require specimens segment) - creates it if necessary
OM4	getOM4(int rep) Returns a specific repetition of OM4 (OM4 - observations that require specimens segment) - creates it if necessary
List<OM4>	getOM4All() Returns a non-modifiable List containing all current existing repetitions of OM4.
int	getOM4Reps() Returns the number of existing repetitions of OM4
String	getVersion() Returns "2.3.1"
OM4	insertOM4(int rep) Inserts a specific repetition of OM4 (OM4 - observations that require specimens segment)
void	insertOM4(OM4 structure, int rep) Inserts a specific repetition of OM4 (OM4 - observations that require specimens segment)
OM4	removeOM4(int rep) Removes a specific repetition of OM4 (OM4 - observations that require specimens segment)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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 Detail

MFN_M09_OM3OM4

public MFN_M09_OM3OM4(Group parent,
              ModelClassFactory factory)

Creates a new MFN_M09_OM3OM4 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getOM3

public OM3 getOM3()

Returns OM3 (OM3 - categorical test/observation segment) - creates it if necessary

getOM4

public OM4 getOM4()

Returns the first repetition of OM4 (OM4 - observations that require specimens segment) - creates it if necessary

getOM4

public OM4 getOM4(int rep)

Returns a specific repetition of OM4 (OM4 - observations that require specimens segment) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getOM4Reps

public int getOM4Reps()

Returns the number of existing repetitions of OM4

getOM4All

public List<OM4> getOM4All()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of OM4.

Note that unlike getOM4(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertOM4

public void insertOM4(OM4 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of OM4 (OM4 - observations that require specimens segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOM4

public OM4 insertOM4(int rep)
              throws HL7Exception

Inserts a specific repetition of OM4 (OM4 - observations that require specimens segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOM4

public OM4 removeOM4(int rep)
              throws HL7Exception

Removes a specific repetition of OM4 (OM4 - observations that require specimens segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)