ca.uhn.hl7v2.model.v231.group
Class DOC_T12_EVNPIDPV1TXAOBX

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.DOC_T12_EVNPIDPV1TXAOBX

All Implemented Interfaces:

Group, Structure, Serializable

public class DOC_T12_EVNPIDPV1TXAOBX
extends AbstractGroup

Represents a DOC_T12_EVNPIDPV1TXAOBX 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 (EVN - event type segment) optional
• 2: PID (PID - patient identification segment)
• 3: PV1 (PV1 - patient visit segment-)
• 4: TXA (Document notification segment)
• 5: OBX (OBX - observation/result segment) optional repeating

See Also:

Serialized Form

Constructor Summary

DOC_T12_EVNPIDPV1TXAOBX(Group parent, ModelClassFactory factory)
Creates a new DOC_T12_EVNPIDPV1TXAOBX group

Method Summary

EVN	getEVN() Returns EVN (EVN - event type segment) - creates it if necessary
OBX	getOBX() Returns the first repetition of OBX (OBX - observation/result segment) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (OBX - observation/result segment) - creates it if necessary
int	getOBXReps() Returns the number of existing repetitions of OBX
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
PV1	getPV1() Returns PV1 (PV1 - patient visit segment-) - creates it if necessary
TXA	getTXA() Returns TXA (Document notification segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (OBX - observation/result segment)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (OBX - observation/result segment)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (OBX - observation/result segment)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

DOC_T12_EVNPIDPV1TXAOBX

public DOC_T12_EVNPIDPV1TXAOBX(Group parent,
                               ModelClassFactory factory)

Creates a new DOC_T12_EVNPIDPV1TXAOBX group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getEVN

public EVN getEVN()

Returns EVN (EVN - event type segment) - creates it if necessary

getPID

public PID getPID()

Returns PID (PID - patient identification segment) - creates it if necessary

getPV1

public PV1 getPV1()

Returns PV1 (PV1 - patient visit segment-) - 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 (OBX - observation/result segment) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (OBX - observation/result 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

insertOBX

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

Inserts a specific repetition of OBX (OBX - observation/result segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (OBX - observation/result segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (OBX - observation/result segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)