Package ca.uhn.hl7v2.model.v23.group

Class DOC_T12_RESULT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.DOC_T12_RESULT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class DOC_T12_RESULT
extends AbstractGroup

Represents a DOC_T12_RESULT 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: EVN (Event type) optional
• 2: PID (Patient Identification)
• 3: PV1 (Patient visit)
• 4: TXA (Document notification segment)
• 5: OBX (Observation segment) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EVN	getEVN()	Returns EVN (Event type) - creates it if necessary
OBX	getOBX()	Returns the first repetition of OBX (Observation segment) - creates it if necessary
OBX	getOBX(int rep)	Returns a specific repetition of OBX (Observation segment) - creates it if necessary
List<OBX>	getOBXAll()	Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps()	Returns the number of existing repetitions of OBX
PID	getPID()	Returns PID (Patient Identification) - creates it if necessary
PV1	getPV1()	Returns PV1 (Patient visit) - creates it if necessary
TXA	getTXA()	Returns TXA (Document notification segment) - creates it if necessary
String	getVersion()	Returns "2.3"
OBX	insertOBX(int rep)	Inserts a specific repetition of OBX (Observation segment)
void	insertOBX(OBX structure, int rep)	Inserts a specific repetition of OBX (Observation segment)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation segment)

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

DOC_T12_RESULT

public DOC_T12_RESULT(Group parent,
 ModelClassFactory factory)

Creates a new DOC_T12_RESULT group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getEVN

public EVN getEVN()

Returns EVN (Event type) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPV1

public PV1 getPV1()

Returns PV1 (Patient visit) - creates it if necessary

getTXA

public TXA getTXA()

Returns TXA (Document notification segment) - creates it if necessary

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation segment) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation segment) - 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.

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX

public void insertOBX(OBX structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)