ca.uhn.hl7v2.model.v22.group

Class ORU_R01_PATIENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v22.group.ORU_R01_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORU_R01_PATIENT
extends AbstractGroup

Represents a ORU_R01_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: NTE (NOTES AND COMMENTS) optional repeating
• 3: PV1 (PATIENT VISIT) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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
PID	getPID() Returns PID (PATIENT IDENTIFICATION) - creates it if necessary
PV1	getPV1() Returns PV1 (PATIENT VISIT) - creates it if necessary
String	getVersion() Returns "2.2"
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)
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 Detail

ORU_R01_PATIENT

public ORU_R01_PATIENT(Group parent,
                       ModelClassFactory factory)

Creates a new ORU_R01_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.2"

getPID

public PID getPID()

Returns PID (PATIENT IDENTIFICATION) - 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)

getPV1

public PV1 getPV1()

Returns PV1 (PATIENT VISIT) - creates it if necessary