ca.uhn.hl7v2.model.v231.message

Class ORF_R04

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.ORF_R04

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ORF_R04
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: QRD (QRD - original-style query definition segment)
• 4: QRF (QRF - original style query filter segment) optional
• 5: ORF_R04_PIDNTEORCOBRNTEOBXNTECTI (a Group object) repeating
• 6: ERR (ERR - error segment) optional
• 7: QAK (Query Acknowledgement) optional
• 8: 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
ORF_R04() Creates a new ORF_R04 message with DefaultModelClassFactory.
ORF_R04(ModelClassFactory factory) Creates a new ORF_R04 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
ERR	getERR() Returns ERR (ERR - error segment) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
ORF_R04_PIDNTEORCOBRNTEOBXNTECTI	getPIDNTEORCOBRNTEOBXNTECTI() Returns the first repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary
ORF_R04_PIDNTEORCOBRNTEOBXNTECTI	getPIDNTEORCOBRNTEOBXNTECTI(int rep) Returns a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary
List<ORF_R04_PIDNTEORCOBRNTEOBXNTECTI>	getPIDNTEORCOBRNTEOBXNTECTIAll() Returns a non-modifiable List containing all current existing repetitions of PIDNTEORCOBRNTEOBXNTECTI.
int	getPIDNTEORCOBRNTEOBXNTECTIReps() Returns the number of existing repetitions of PIDNTEORCOBRNTEOBXNTECTI
QAK	getQAK() Returns QAK (Query Acknowledgement) - creates it if necessary
QRD	getQRD() Returns QRD (QRD - original-style query definition segment) - creates it if necessary
QRF	getQRF() Returns QRF (QRF - original style query filter segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
ORF_R04_PIDNTEORCOBRNTEOBXNTECTI	insertPIDNTEORCOBRNTEOBXNTECTI(int rep) Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object)
void	insertPIDNTEORCOBRNTEOBXNTECTI(ORF_R04_PIDNTEORCOBRNTEOBXNTECTI structure, int rep) Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object)
ORF_R04_PIDNTEORCOBRNTEOBXNTECTI	removePIDNTEORCOBRNTEOBXNTECTI(int rep) Removes a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (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

ORF_R04

public ORF_R04()

Creates a new ORF_R04 message with DefaultModelClassFactory.

ORF_R04

public ORF_R04(ModelClassFactory factory)

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

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (QRD - original-style query definition segment) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (QRF - original style query filter segment) - creates it if necessary

getPIDNTEORCOBRNTEOBXNTECTI

public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI getPIDNTEORCOBRNTEOBXNTECTI()

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

getPIDNTEORCOBRNTEOBXNTECTI

public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI getPIDNTEORCOBRNTEOBXNTECTI(int rep)

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

getPIDNTEORCOBRNTEOBXNTECTIReps

public int getPIDNTEORCOBRNTEOBXNTECTIReps()

Returns the number of existing repetitions of PIDNTEORCOBRNTEOBXNTECTI

getPIDNTEORCOBRNTEOBXNTECTIAll

public List<ORF_R04_PIDNTEORCOBRNTEOBXNTECTI> getPIDNTEORCOBRNTEOBXNTECTIAll()
                                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDNTEORCOBRNTEOBXNTECTI

public void insertPIDNTEORCOBRNTEOBXNTECTI(ORF_R04_PIDNTEORCOBRNTEOBXNTECTI structure,
                                  int rep)
                                    throws HL7Exception

Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDNTEORCOBRNTEOBXNTECTI

public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI insertPIDNTEORCOBRNTEOBXNTECTI(int rep)
                                                                throws HL7Exception

Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDNTEORCOBRNTEOBXNTECTI

public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI removePIDNTEORCOBRNTEOBXNTECTI(int rep)
                                                                throws HL7Exception

Removes a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getERR

public ERR getERR()

Returns ERR (ERR - error segment) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgement) - creates it if necessary

getDSC

public DSC getDSC()

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