Package ca.uhn.hl7v2.model.v23.message

Class RQA_I09

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.RQA_I09

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class RQA_I09
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: RF1 (Referral Information Segment) optional
• 3: RQA_I09_AUTHORIZATION (a Group object) optional
• 4: RQA_I09_PROVIDER (a Group object) repeating
• 5: PID (Patient Identification)
• 6: NK1 (Next of kin) optional repeating
• 7: RQA_I09_GUARANTOR_INSURANCE (a Group object) optional
• 8: ACC (Accident) optional
• 9: DG1 (Diagnosis) optional repeating
• 10: DRG (Diagnosis Related Group) optional repeating
• 11: AL1 (Patient allergy information) optional repeating
• 12: RQA_I09_PROCEDURE (a Group object) optional repeating
• 13: RQA_I09_RESULTS (a Group object) optional repeating
• 14: RQA_I09_VISIT (a Group object) optional
• 15: 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	Description
RQA_I09()	Creates a new RQA_I09 message with DefaultModelClassFactory.
RQA_I09(ModelClassFactory factory)	Creates a new RQA_I09 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
ACC	getACC()	Returns ACC (Accident) - creates it if necessary
AL1	getAL1()	Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
AL1	getAL1(int rep)	Returns a specific repetition of AL1 (Patient allergy information) - creates it if necessary
List<AL1>	getAL1All()	Returns a non-modifiable List containing all current existing repetitions of AL1.
int	getAL1Reps()	Returns the number of existing repetitions of AL1
RQA_I09_AUTHORIZATION	getAUTHORIZATION()	Returns AUTHORIZATION (a Group object) - creates it if necessary
DG1	getDG1()	Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep)	Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
List<DG1>	getDG1All()	Returns a non-modifiable List containing all current existing repetitions of DG1.
int	getDG1Reps()	Returns the number of existing repetitions of DG1
DRG	getDRG()	Returns the first repetition of DRG (Diagnosis Related Group) - creates it if necessary
DRG	getDRG(int rep)	Returns a specific repetition of DRG (Diagnosis Related Group) - creates it if necessary
List<DRG>	getDRGAll()	Returns a non-modifiable List containing all current existing repetitions of DRG.
int	getDRGReps()	Returns the number of existing repetitions of DRG
RQA_I09_GUARANTOR_INSURANCE	getGUARANTOR_INSURANCE()	Returns GUARANTOR_INSURANCE (a Group object) - creates it if necessary
MSH	getMSH()	Returns MSH (Message header segment) - creates it if necessary
NK1	getNK1()	Returns the first repetition of NK1 (Next of kin) - creates it if necessary
NK1	getNK1(int rep)	Returns a specific repetition of NK1 (Next of kin) - 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 (Notes and comments segment) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of 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 (Patient Identification) - creates it if necessary
RQA_I09_PROCEDURE	getPROCEDURE()	Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
RQA_I09_PROCEDURE	getPROCEDURE(int rep)	Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
List<RQA_I09_PROCEDURE>	getPROCEDUREAll()	Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
int	getPROCEDUREReps()	Returns the number of existing repetitions of PROCEDURE
RQA_I09_PROVIDER	getPROVIDER()	Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
RQA_I09_PROVIDER	getPROVIDER(int rep)	Returns a specific repetition of PROVIDER (a Group object) - creates it if necessary
List<RQA_I09_PROVIDER>	getPROVIDERAll()	Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
int	getPROVIDERReps()	Returns the number of existing repetitions of PROVIDER
RQA_I09_RESULTS	getRESULTS()	Returns the first repetition of RESULTS (a Group object) - creates it if necessary
RQA_I09_RESULTS	getRESULTS(int rep)	Returns a specific repetition of RESULTS (a Group object) - creates it if necessary
List<RQA_I09_RESULTS>	getRESULTSAll()	Returns a non-modifiable List containing all current existing repetitions of RESULTS.
int	getRESULTSReps()	Returns the number of existing repetitions of RESULTS
RF1	getRF1()	Returns RF1 (Referral Information Segment) - creates it if necessary
String	getVersion()	Returns "2.3"
RQA_I09_VISIT	getVISIT()	Returns VISIT (a Group object) - creates it if necessary
AL1	insertAL1(int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
void	insertAL1(AL1 structure, int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
DG1	insertDG1(int rep)	Inserts a specific repetition of DG1 (Diagnosis)
void	insertDG1(DG1 structure, int rep)	Inserts a specific repetition of DG1 (Diagnosis)
DRG	insertDRG(int rep)	Inserts a specific repetition of DRG (Diagnosis Related Group)
void	insertDRG(DRG structure, int rep)	Inserts a specific repetition of DRG (Diagnosis Related Group)
NK1	insertNK1(int rep)	Inserts a specific repetition of NK1 (Next of kin)
void	insertNK1(NK1 structure, int rep)	Inserts a specific repetition of NK1 (Next of kin)
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
RQA_I09_PROCEDURE	insertPROCEDURE(int rep)	Inserts a specific repetition of PROCEDURE (a Group object)
void	insertPROCEDURE(RQA_I09_PROCEDURE structure, int rep)	Inserts a specific repetition of PROCEDURE (a Group object)
RQA_I09_PROVIDER	insertPROVIDER(int rep)	Inserts a specific repetition of PROVIDER (a Group object)
void	insertPROVIDER(RQA_I09_PROVIDER structure, int rep)	Inserts a specific repetition of PROVIDER (a Group object)
RQA_I09_RESULTS	insertRESULTS(int rep)	Inserts a specific repetition of RESULTS (a Group object)
void	insertRESULTS(RQA_I09_RESULTS structure, int rep)	Inserts a specific repetition of RESULTS (a Group object)
AL1	removeAL1(int rep)	Removes a specific repetition of AL1 (Patient allergy information)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
DRG	removeDRG(int rep)	Removes a specific repetition of DRG (Diagnosis Related Group)
NK1	removeNK1(int rep)	Removes a specific repetition of NK1 (Next of kin)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and comments segment)
RQA_I09_PROCEDURE	removePROCEDURE(int rep)	Removes a specific repetition of PROCEDURE (a Group object)
RQA_I09_PROVIDER	removePROVIDER(int rep)	Removes a specific repetition of PROVIDER (a Group object)
RQA_I09_RESULTS	removeRESULTS(int rep)	Removes a specific repetition of RESULTS (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Details

RQA_I09

public RQA_I09()

Creates a new RQA_I09 message with DefaultModelClassFactory.

RQA_I09

public RQA_I09(ModelClassFactory factory)

Creates a new RQA_I09 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getRF1

public RF1 getRF1()

Returns RF1 (Referral Information Segment) - creates it if necessary

getAUTHORIZATION

public RQA_I09_AUTHORIZATION getAUTHORIZATION()

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

getPROVIDER

public RQA_I09_PROVIDER getPROVIDER()

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

getPROVIDER

public RQA_I09_PROVIDER getPROVIDER(int rep)

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

getPROVIDERReps

public int getPROVIDERReps()

Returns the number of existing repetitions of PROVIDER

getPROVIDERAll

public List<RQA_I09_PROVIDER> getPROVIDERAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertPROVIDER

public void insertPROVIDER(RQA_I09_PROVIDER structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of PROVIDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROVIDER

public RQA_I09_PROVIDER insertPROVIDER(int rep)
                                throws HL7Exception

Inserts a specific repetition of PROVIDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROVIDER

public RQA_I09_PROVIDER removePROVIDER(int rep)
                                throws HL7Exception

Removes a specific repetition of PROVIDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of kin) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of kin) - 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 (Next of kin)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of kin)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getGUARANTOR_INSURANCE

public RQA_I09_GUARANTOR_INSURANCE getGUARANTOR_INSURANCE()

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

getACC

public ACC getACC()

Returns ACC (Accident) - creates it if necessary

getDG1

public DG1 getDG1()

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

getDG1

public DG1 getDG1(int rep)

Returns a specific repetition of DG1 (Diagnosis) - 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

getDG1All

public List<DG1> getDG1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDG1

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

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns the first repetition of DRG (Diagnosis Related Group) - creates it if necessary

getDRG

public DRG getDRG(int rep)

Returns a specific repetition of DRG (Diagnosis Related Group) - 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

getDRGAll

public List<DRG> getDRGAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDRG

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

Inserts a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDRG

public DRG insertDRG(int rep)
              throws HL7Exception

Inserts a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDRG

public DRG removeDRG(int rep)
              throws HL7Exception

Removes a specific repetition of DRG (Diagnosis Related Group)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getAL1

public AL1 getAL1()

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

getAL1

public AL1 getAL1(int rep)

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

getAL1All

public List<AL1> getAL1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAL1

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

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPROCEDURE

public RQA_I09_PROCEDURE getPROCEDURE()

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

getPROCEDURE

public RQA_I09_PROCEDURE getPROCEDURE(int rep)

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

getPROCEDUREReps

public int getPROCEDUREReps()

Returns the number of existing repetitions of PROCEDURE

getPROCEDUREAll

public List<RQA_I09_PROCEDURE> getPROCEDUREAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertPROCEDURE

public void insertPROCEDURE(RQA_I09_PROCEDURE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROCEDURE

public RQA_I09_PROCEDURE insertPROCEDURE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROCEDURE

public RQA_I09_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception

Removes a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getRESULTS

public RQA_I09_RESULTS getRESULTS()

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

getRESULTS

public RQA_I09_RESULTS getRESULTS(int rep)

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

getRESULTSReps

public int getRESULTSReps()

Returns the number of existing repetitions of RESULTS

getRESULTSAll

public List<RQA_I09_RESULTS> getRESULTSAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRESULTS

public void insertRESULTS(RQA_I09_RESULTS structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRESULTS

public RQA_I09_RESULTS insertRESULTS(int rep)
                              throws HL7Exception

Inserts a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRESULTS

public RQA_I09_RESULTS removeRESULTS(int rep)
                              throws HL7Exception

Removes a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getVISIT

public RQA_I09_VISIT getVISIT()

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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of 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 (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 (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 (Notes and comments segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)