ca.uhn.hl7v2.model.v231.message

Class RDS_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.RDS_O01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RDS_O01
extends AbstractMessage

Represents a RDS_O01 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: RDS_O01_PIDPD1NTEAL1PV1PV2 (a Group object) optional
• 4: RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (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
RDS_O01() Creates a new RDS_O01 message with DefaultModelClassFactory.
RDS_O01(ModelClassFactory factory) Creates a new RDS_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
RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE	getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE() Returns the first repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object) - creates it if necessary
RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE	getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep) Returns a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object) - creates it if necessary
List<RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE>	getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE.
int	getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEReps() Returns the number of existing repetitions of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE
RDS_O01_PIDPD1NTEAL1PV1PV2	getPIDPD1NTEAL1PV1PV2() Returns PIDPD1NTEAL1PV1PV2 (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)
RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE	insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep) Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object)
void	insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE structure, int rep) Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE	removeORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep) Removes a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (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

RDS_O01

public RDS_O01()

Creates a new RDS_O01 message with DefaultModelClassFactory.

RDS_O01

public RDS_O01(ModelClassFactory factory)

Creates a new RDS_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)

getPIDPD1NTEAL1PV1PV2

public RDS_O01_PIDPD1NTEAL1PV1PV2 getPIDPD1NTEAL1PV1PV2()

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

getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE()

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

getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep)

Returns a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (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.

getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEReps

public int getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEReps()

Returns the number of existing repetitions of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEAll

public List<RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE> getORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTEAll()
                                                                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public void insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE structure,
                                                    int rep)
                                                      throws HL7Exception

Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE insertORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep)
                                                                                                    throws HL7Exception

Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE removeORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(int rep)
                                                                                                    throws HL7Exception

Removes a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)