ca.uhn.hl7v2.model.v231.message

Class RQC_I06

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.RQC_I06

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RQC_I06
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: QRD (QRD - original-style query definition segment)
• 3: QRF (QRF - original style query filter segment) optional
• 4: RQC_I06_PRDCTD (a Group object) repeating
• 5: PID (PID - patient identification segment)
• 6: NK1 (NK1 - next of kin / associated parties segment-) optional repeating
• 7: GT1 (GT1 - guarantor segment) optional
• 8: NTE (NTE - notes and comments 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
RQC_I06() Creates a new RQC_I06 message with DefaultModelClassFactory.
RQC_I06(ModelClassFactory factory) Creates a new RQC_I06 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
GT1	getGT1() Returns GT1 (GT1 - guarantor segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
List<NK1>	getNK1All() Returns a non-modifiable List containing all current existing repetitions of NK1.
int	getNK1Reps() Returns the number of existing repetitions of NK1
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
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
RQC_I06_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RQC_I06_PRDCTD	getPRDCTD(int rep) Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
List<RQC_I06_PRDCTD>	getPRDCTDAll() Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
int	getPRDCTDReps() Returns the number of existing repetitions of PRDCTD
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"
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
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)
RQC_I06_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RQC_I06_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RQC_I06_PRDCTD	removePRDCTD(int rep) Removes a specific repetition of PRDCTD (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

RQC_I06

public RQC_I06()

Creates a new RQC_I06 message with DefaultModelClassFactory.

RQC_I06

public RQC_I06(ModelClassFactory factory)

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

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

getPRDCTD

public RQC_I06_PRDCTD getPRDCTD()

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

getPRDCTD

public RQC_I06_PRDCTD getPRDCTD(int rep)

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

getPRDCTDReps

public int getPRDCTDReps()

Returns the number of existing repetitions of PRDCTD

getPRDCTDAll

public List<RQC_I06_PRDCTD> getPRDCTDAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPRDCTD

public void insertPRDCTD(RQC_I06_PRDCTD structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRDCTD

public RQC_I06_PRDCTD insertPRDCTD(int rep)
                            throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRDCTD

public RQC_I06_PRDCTD removePRDCTD(int rep)
                            throws HL7Exception

Removes a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPID

public PID getPID()

Returns PID (PID - patient identification segment) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (NK1 - next of kin / associated parties 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

getNK1All

public List<NK1> getNK1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1

public void insertNK1(NK1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getGT1

public GT1 getGT1()

Returns GT1 (GT1 - guarantor 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)