ca.uhn.hl7v2.model.v24.group

Class ORL_O22_PATIENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ORL_O22_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O22_PATIENT
extends AbstractGroup

Represents a ORL_O22_PATIENT 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: ORL_O22_GENERAL_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 and Description
ORL_O22_PATIENT(Group parent, ModelClassFactory factory) Creates a new ORL_O22_PATIENT group

Method Summary

Methods

Modifier and Type	Method and Description
ORL_O22_GENERAL_ORDER	getGENERAL_ORDER() Returns the first repetition of GENERAL_ORDER (a Group object) - creates it if necessary
ORL_O22_GENERAL_ORDER	getGENERAL_ORDER(int rep) Returns a specific repetition of GENERAL_ORDER (a Group object) - creates it if necessary
List<ORL_O22_GENERAL_ORDER>	getGENERAL_ORDERAll() Returns a non-modifiable List containing all current existing repetitions of GENERAL_ORDER.
int	getGENERAL_ORDERReps() Returns the number of existing repetitions of GENERAL_ORDER
PID	getPID() Returns PID (Patient identification) - creates it if necessary
String	getVersion() Returns "2.4"
ORL_O22_GENERAL_ORDER	insertGENERAL_ORDER(int rep) Inserts a specific repetition of GENERAL_ORDER (a Group object)
void	insertGENERAL_ORDER(ORL_O22_GENERAL_ORDER structure, int rep) Inserts a specific repetition of GENERAL_ORDER (a Group object)
ORL_O22_GENERAL_ORDER	removeGENERAL_ORDER(int rep) Removes a specific repetition of GENERAL_ORDER (a Group object)

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_PATIENT

public ORL_O22_PATIENT(Group parent,
               ModelClassFactory factory)

Creates a new ORL_O22_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getGENERAL_ORDER

public ORL_O22_GENERAL_ORDER getGENERAL_ORDER()

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

getGENERAL_ORDER

public ORL_O22_GENERAL_ORDER getGENERAL_ORDER(int rep)

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

getGENERAL_ORDERReps

public int getGENERAL_ORDERReps()

Returns the number of existing repetitions of GENERAL_ORDER

getGENERAL_ORDERAll

public List<ORL_O22_GENERAL_ORDER> getGENERAL_ORDERAll()
                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertGENERAL_ORDER

public void insertGENERAL_ORDER(ORL_O22_GENERAL_ORDER structure,
                       int rep)
                         throws HL7Exception

Inserts a specific repetition of GENERAL_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGENERAL_ORDER

public ORL_O22_GENERAL_ORDER insertGENERAL_ORDER(int rep)
                                          throws HL7Exception

Inserts a specific repetition of GENERAL_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGENERAL_ORDER

public ORL_O22_GENERAL_ORDER removeGENERAL_ORDER(int rep)
                                          throws HL7Exception

Removes a specific repetition of GENERAL_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)