ca.uhn.hl7v2.model.v231.message
Class RCL_I06

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.RCL_I06

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RCL_I06
extends AbstractMessage

Represents a RCL_I06 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: RCL_I06_PRDCTD (a Group object) repeating
• 6: PID (PID - patient identification segment)
• 7: DG1 (DG1 - diagnosis segment) optional repeating
• 8: DRG (DRG - diagnosis related group segment) optional repeating
• 9: AL1 (AL1 - patient allergy information segment) optional repeating
• 10: NTE (NTE - notes and comments segment) optional repeating
• 11: DSP (DSP - display data segment) optional repeating
• 12: DSC (DSC - Continuation pointer segment) optional

See Also:

Serialized Form

Constructor Summary

RCL_I06()
Creates a new RCL_I06 message with DefaultModelClassFactory.

RCL_I06(ModelClassFactory factory)
Creates a new RCL_I06 message with custom ModelClassFactory.

Method Summary

AL1	getAL1() Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
int	getAL1Reps() Returns the number of existing repetitions of AL1
DG1	getDG1() Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
DG1	getDG1(int rep) Returns a specific repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
int	getDG1Reps() Returns the number of existing repetitions of DG1
DRG	getDRG() Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
DRG	getDRG(int rep) Returns a specific repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary
int	getDRGReps() Returns the number of existing repetitions of DRG
DSC	getDSC() Returns DSC (DSC - Continuation pointer segment) - creates it if necessary
DSP	getDSP() Returns the first repetition of DSP (DSP - display data segment) - creates it if necessary
DSP	getDSP(int rep) Returns a specific repetition of DSP (DSP - display data segment) - creates it if necessary
int	getDSPReps() Returns the number of existing repetitions of DSP
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
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
int	getNTEReps() Returns the number of existing repetitions of NTE
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
RCL_I06_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RCL_I06_PRDCTD	getPRDCTD(int rep) Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
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"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
void	insertDRG(DRG structure, int rep) Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
DRG	insertDRG(int rep) Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
void	insertDSP(DSP structure, int rep) Inserts a specific repetition of DSP (DSP - display data segment)
DSP	insertDSP(int rep) Inserts a specific repetition of DSP (DSP - display data 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)
RCL_I06_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RCL_I06_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (DG1 - diagnosis segment)
DRG	removeDRG(int rep) Removes a specific repetition of DRG (DRG - diagnosis related group segment)
DSP	removeDSP(int rep) Removes a specific repetition of DSP (DSP - display data segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RCL_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, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

Constructor Detail

RCL_I06

public RCL_I06()

Creates a new RCL_I06 message with DefaultModelClassFactory.

RCL_I06

public RCL_I06(ModelClassFactory factory)

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

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

getPRDCTD

public RCL_I06_PRDCTD getPRDCTD()

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

getPRDCTD

public RCL_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

insertPRDCTD

public void insertPRDCTD(RCL_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 RCL_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 RCL_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

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

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

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

insertDG1

public void insertDG1(DG1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns the first repetition of DRG (DRG - diagnosis related group segment) - creates it if necessary

getDRG

public DRG getDRG(int rep)

Returns a specific repetition of DRG (DRG - diagnosis related group 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.

getDRGReps

public int getDRGReps()

Returns the number of existing repetitions of DRG

insertDRG

public void insertDRG(DRG structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertDRG

public DRG insertDRG(int rep)
              throws HL7Exception

Inserts a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeDRG

public DRG removeDRG(int rep)
              throws HL7Exception

Removes a specific repetition of DRG (DRG - diagnosis related group segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getAL1

public AL1 getAL1()

Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary

getAL1

public AL1 getAL1(int rep)

Returns a specific repetition of AL1 (AL1 - patient allergy information 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.

getAL1Reps

public int getAL1Reps()

Returns the number of existing repetitions of AL1

insertAL1

public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

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

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)

getDSP

public DSP getDSP()

Returns the first repetition of DSP (DSP - display data segment) - creates it if necessary

getDSP

public DSP getDSP(int rep)

Returns a specific repetition of DSP (DSP - display data 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.

getDSPReps

public int getDSPReps()

Returns the number of existing repetitions of DSP

insertDSP

public void insertDSP(DSP structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertDSP

public DSP insertDSP(int rep)
              throws HL7Exception

Inserts a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeDSP

public DSP removeDSP(int rep)
              throws HL7Exception

Removes a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDSC

public DSC getDSC()

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