ca.uhn.hl7v2.model.v231.message

Class ORU_R01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.ORU_R01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ORU_R01
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object) repeating
• 3: DSC (DSC - Continuation pointer segment) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (DSC - Continuation pointer segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI	getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI() Returns the first repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary
ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI	getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep) Returns a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary
List<ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI>	getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIAll() Returns a non-modifiable List containing all current existing repetitions of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI.
int	getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIReps() Returns the number of existing repetitions of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI
String	getVersion() Returns "2.3.1"
ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI	insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep) Inserts a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object)
void	insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI structure, int rep) Inserts a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object)
ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI	removePIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep) Removes a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (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

ORU_R01

public ORU_R01()

Creates a new ORU_R01 message with DefaultModelClassFactory.

ORU_R01

public ORU_R01(ModelClassFactory factory)

Creates a new ORU_R01 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

getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

public ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI()

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

getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

public ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep)

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

getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIReps

public int getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIReps()

Returns the number of existing repetitions of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIAll

public List<ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI> getPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTIAll()
                                                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

public void insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI structure,
                                              int rep)
                                                throws HL7Exception

Inserts a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

public ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI insertPIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep)
                                                                                        throws HL7Exception

Inserts a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI

public ORU_R01_PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI removePIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI(int rep)
                                                                                        throws HL7Exception

Removes a specific repetition of PIDPD1NK1NTEPV1PV2ORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (DSC - Continuation pointer segment) - creates it if necessary