ca.uhn.hl7v2.model.v28.group

Class ORL_O22_RESPONSE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.ORL_O22_RESPONSE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O22_RESPONSE
extends AbstractGroup

Represents a ORL_O22_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: PRT (Participation Information) optional repeating
• 3: ARV (Access Restriction) optional repeating
• 4: ORL_O22_ORDER (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ARV	getARV() Returns the first repetition of ARV (Access Restriction) - creates it if necessary
ARV	getARV(int rep) Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
List<ARV>	getARVAll() Returns a non-modifiable List containing all current existing repetitions of ARV.
int	getARVReps() Returns the number of existing repetitions of ARV
ORL_O22_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
ORL_O22_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<ORL_O22_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
String	getVersion() Returns "2.8"
void	insertARV(ARV structure, int rep) Inserts a specific repetition of ARV (Access Restriction)
ARV	insertARV(int rep) Inserts a specific repetition of ARV (Access Restriction)
ORL_O22_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(ORL_O22_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
ARV	removeARV(int rep) Removes a specific repetition of ARV (Access Restriction)
ORL_O22_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)

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 Detail

ORL_O22_RESPONSE

public ORL_O22_RESPONSE(Group parent,
                        ModelClassFactory factory)

Creates a new ORL_O22_RESPONSE group

Method Detail

getVersion

public String getVersion()

Returns "2.8"

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

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

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getARV

public ARV getARV()

Returns the first repetition of ARV (Access Restriction) - creates it if necessary

getARV

public ARV getARV(int rep)

Returns a specific repetition of ARV (Access Restriction) - 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.

getARVReps

public int getARVReps()

Returns the number of existing repetitions of ARV

getARVAll

public List<ARV> getARVAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertARV

public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertARV

public ARV insertARV(int rep)
              throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeARV

public ARV removeARV(int rep)
              throws HL7Exception

Removes a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getORDER

public ORL_O22_ORDER getORDER()

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

getORDER

public ORL_O22_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<ORL_O22_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(ORL_O22_ORDER structure,
                        int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER

public ORL_O22_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER

public ORL_O22_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)