Package ca.uhn.hl7v2.model.v24.message

Class RCI_I05

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.RCI_I05

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class RCI_I05
extends AbstractMessage

Represents a RCI_I05 message structure (see chapter 11). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: QRD (Original-Style Query Definition)
• 4: QRF (Original Style Query Filter) optional
• 5: RCI_I05_PROVIDER (a Group object) repeating
• 6: PID (Patient identification)
• 7: DG1 (Diagnosis) optional repeating
• 8: DRG (Diagnosis Related Group) optional repeating
• 9: AL1 (Patient allergy information) optional repeating
• 10: RCI_I05_OBSERVATION (a Group object) optional repeating
• 11: NTE (Notes and Comments) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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
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
MSA	getMSA()	Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
NTE	getNTE()	Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and Comments) - 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
RCI_I05_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RCI_I05_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<RCI_I05_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
PID	getPID()	Returns PID (Patient identification) - creates it if necessary
RCI_I05_PROVIDER	getPROVIDER()	Returns the first repetition of PROVIDER (a Group object) - creates it if necessary
RCI_I05_PROVIDER	getPROVIDER(int rep)	Returns a specific repetition of PROVIDER (a Group object) - creates it if necessary
List<RCI_I05_PROVIDER>	getPROVIDERAll()	Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
int	getPROVIDERReps()	Returns the number of existing repetitions of PROVIDER
QRD	getQRD()	Returns QRD (Original-Style Query Definition) - creates it if necessary
QRF	getQRF()	Returns QRF (Original Style Query Filter) - creates it if necessary
String	getVersion()	Returns "2.4"
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)
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and Comments)
RCI_I05_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RCI_I05_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
RCI_I05_PROVIDER	insertPROVIDER(int rep)	Inserts a specific repetition of PROVIDER (a Group object)
void	insertPROVIDER(RCI_I05_PROVIDER structure, int rep)	Inserts a specific repetition of PROVIDER (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)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
RCI_I05_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
RCI_I05_PROVIDER	removePROVIDER(int rep)	Removes a specific repetition of PROVIDER (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

RCI_I05

public RCI_I05()

Creates a new RCI_I05 message with DefaultModelClassFactory.

RCI_I05

public RCI_I05(ModelClassFactory factory)

Creates a new RCI_I05 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (Original Style Query Filter) - creates it if necessary

getPROVIDER

public RCI_I05_PROVIDER getPROVIDER()

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

getPROVIDER

public RCI_I05_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<RCI_I05_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(RCI_I05_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 RCI_I05_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 RCI_I05_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

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)

getOBSERVATION

public RCI_I05_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public RCI_I05_OBSERVATION getOBSERVATION(int rep)

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

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

getOBSERVATIONAll

public List<RCI_I05_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(RCI_I05_OBSERVATION structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public RCI_I05_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public RCI_I05_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

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

getNTE

public NTE getNTE(int rep)

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

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)

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)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)