ca.uhn.hl7v2.model.v231.group

Class SRM_S01_PIDPV1PV2OBXDG1

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SRM_S01_PIDPV1PV2OBXDG1

All Implemented Interfaces:

Group, Structure, Serializable

public class SRM_S01_PIDPV1PV2OBXDG1
extends AbstractGroup

Represents a SRM_S01_PIDPV1PV2OBXDG1 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 (PID - patient identification segment)
• 2: PV1 (PV1 - patient visit segment-) optional
• 3: PV2 (PV2 - patient visit - additional information segment) optional
• 4: OBX (OBX - observation/result segment) optional repeating
• 5: DG1 (DG1 - diagnosis segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DG1	getDG1() Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
DG1	getDG1(int rep) Returns a specific repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
List<DG1>	getDG1All() Returns a non-modifiable List containing all current existing repetitions of DG1.
int	getDG1Reps() Returns the number of existing repetitions of DG1
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
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 (PID - patient identification segment) - creates it if necessary
PV1	getPV1() Returns PV1 (PV1 - patient visit segment-) - creates it if necessary
PV2	getPV2() Returns PV2 (PV2 - patient visit - additional information segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
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)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (DG1 - diagnosis 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, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

SRM_S01_PIDPV1PV2OBXDG1

public SRM_S01_PIDPV1PV2OBXDG1(Group parent,
                       ModelClassFactory factory)

Creates a new SRM_S01_PIDPV1PV2OBXDG1 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

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

getPV2

public PV2 getPV2()

Returns PV2 (PV2 - patient visit - additional information 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

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 (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)

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

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

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

getDG1All

public List<DG1> getDG1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDG1

public void insertDG1(DG1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (DG1 - diagnosis segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)