Package ca.uhn.hl7v2.model.v24.group

Class RSP_Z88_QUERY_RESPONSE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.RSP_Z88_QUERY_RESPONSE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RSP_Z88_QUERY_RESPONSE
extends AbstractGroup

Represents a RSP_Z88_QUERY_RESPONSE group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: PID (Patient identification)
• 2: PD1 (patient additional demographic) optional
• 3: NTE (Notes and Comments) optional repeating
• 4: RSP_Z88_ALLERGY (a Group object) optional
• 5: RSP_Z88_COMMON_ORDER (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
RSP_Z88_QUERY_RESPONSE(Group parent, ModelClassFactory factory)	Creates a new RSP_Z88_QUERY_RESPONSE group

Method Summary

Modifier and Type	Method	Description
RSP_Z88_ALLERGY	getALLERGY()	Returns ALLERGY (a Group object) - creates it if necessary
RSP_Z88_COMMON_ORDER	getCOMMON_ORDER()	Returns the first repetition of COMMON_ORDER (a Group object) - creates it if necessary
RSP_Z88_COMMON_ORDER	getCOMMON_ORDER(int rep)	Returns a specific repetition of COMMON_ORDER (a Group object) - creates it if necessary
List<RSP_Z88_COMMON_ORDER>	getCOMMON_ORDERAll()	Returns a non-modifiable List containing all current existing repetitions of COMMON_ORDER.
int	getCOMMON_ORDERReps()	Returns the number of existing repetitions of COMMON_ORDER
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
PD1	getPD1()	Returns PD1 (patient additional demographic) - creates it if necessary
PID	getPID()	Returns PID (Patient identification) - creates it if necessary
String	getVersion()	Returns "2.4"
RSP_Z88_COMMON_ORDER	insertCOMMON_ORDER(int rep)	Inserts a specific repetition of COMMON_ORDER (a Group object)
void	insertCOMMON_ORDER(RSP_Z88_COMMON_ORDER structure, int rep)	Inserts a specific repetition of COMMON_ORDER (a Group object)
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)
RSP_Z88_COMMON_ORDER	removeCOMMON_ORDER(int rep)	Removes a specific repetition of COMMON_ORDER (a Group object)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)

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

accept, 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 ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMessage, getParent

Constructor Details

RSP_Z88_QUERY_RESPONSE

public RSP_Z88_QUERY_RESPONSE(Group parent,
 ModelClassFactory factory)

Creates a new RSP_Z88_QUERY_RESPONSE group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (patient additional demographic) - creates it if necessary

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)

getALLERGY

public RSP_Z88_ALLERGY getALLERGY()

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

getCOMMON_ORDER

public RSP_Z88_COMMON_ORDER getCOMMON_ORDER()

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

getCOMMON_ORDER

public RSP_Z88_COMMON_ORDER getCOMMON_ORDER(int rep)

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

getCOMMON_ORDERReps

public int getCOMMON_ORDERReps()

Returns the number of existing repetitions of COMMON_ORDER

getCOMMON_ORDERAll

public List<RSP_Z88_COMMON_ORDER> getCOMMON_ORDERAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMMON_ORDER

public void insertCOMMON_ORDER(RSP_Z88_COMMON_ORDER structure,
 int rep)
                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCOMMON_ORDER

public RSP_Z88_COMMON_ORDER insertCOMMON_ORDER(int rep)
                                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCOMMON_ORDER

public RSP_Z88_COMMON_ORDER removeCOMMON_ORDER(int rep)
                                        throws HL7Exception

Removes a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)