ca.uhn.hl7v2.model.v231.message

Class OMS_O01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.OMS_O01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OMS_O01
extends AbstractMessage

Represents a OMS_O01 message structure (see chapter 4.7). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: OMS_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) optional
• 4: OMS_O01_ORCRQDNTEOBXNTEBLG (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
OMS_O01() Creates a new OMS_O01 message with DefaultModelClassFactory.
OMS_O01(ModelClassFactory factory) Creates a new OMS_O01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
OMS_O01_ORCRQDNTEOBXNTEBLG	getORCRQDNTEOBXNTEBLG() Returns the first repetition of ORCRQDNTEOBXNTEBLG (a Group object) - creates it if necessary
OMS_O01_ORCRQDNTEOBXNTEBLG	getORCRQDNTEOBXNTEBLG(int rep) Returns a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object) - creates it if necessary
List<OMS_O01_ORCRQDNTEOBXNTEBLG>	getORCRQDNTEOBXNTEBLGAll() Returns a non-modifiable List containing all current existing repetitions of ORCRQDNTEOBXNTEBLG.
int	getORCRQDNTEOBXNTEBLGReps() Returns the number of existing repetitions of ORCRQDNTEOBXNTEBLG
OMS_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1	getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1() Returns PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
OMS_O01_ORCRQDNTEOBXNTEBLG	insertORCRQDNTEOBXNTEBLG(int rep) Inserts a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)
void	insertORCRQDNTEOBXNTEBLG(OMS_O01_ORCRQDNTEOBXNTEBLG structure, int rep) Inserts a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
OMS_O01_ORCRQDNTEOBXNTEBLG	removeORCRQDNTEOBXNTEBLG(int rep) Removes a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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 java.lang.Object

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

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

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

OMS_O01

public OMS_O01()

Creates a new OMS_O01 message with DefaultModelClassFactory.

OMS_O01

public OMS_O01(ModelClassFactory factory)

Creates a new OMS_O01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1

public OMS_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1()

Returns PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) - creates it if necessary

getORCRQDNTEOBXNTEBLG

public OMS_O01_ORCRQDNTEOBXNTEBLG getORCRQDNTEOBXNTEBLG()

Returns the first repetition of ORCRQDNTEOBXNTEBLG (a Group object) - creates it if necessary

getORCRQDNTEOBXNTEBLG

public OMS_O01_ORCRQDNTEOBXNTEBLG getORCRQDNTEOBXNTEBLG(int rep)

Returns a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object) - 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.

getORCRQDNTEOBXNTEBLGReps

public int getORCRQDNTEOBXNTEBLGReps()

Returns the number of existing repetitions of ORCRQDNTEOBXNTEBLG

getORCRQDNTEOBXNTEBLGAll

public List<OMS_O01_ORCRQDNTEOBXNTEBLG> getORCRQDNTEOBXNTEBLGAll()
                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORCRQDNTEOBXNTEBLG

public void insertORCRQDNTEOBXNTEBLG(OMS_O01_ORCRQDNTEOBXNTEBLG structure,
                            int rep)
                              throws HL7Exception

Inserts a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCRQDNTEOBXNTEBLG

public OMS_O01_ORCRQDNTEOBXNTEBLG insertORCRQDNTEOBXNTEBLG(int rep)
                                                    throws HL7Exception

Inserts a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCRQDNTEOBXNTEBLG

public OMS_O01_ORCRQDNTEOBXNTEBLG removeORCRQDNTEOBXNTEBLG(int rep)
                                                    throws HL7Exception

Removes a specific repetition of ORCRQDNTEOBXNTEBLG (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)