ca.uhn.hl7v2.model.v231.group

Class CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR

All Implemented Interfaces:

Group, Structure, Serializable

public class CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR
extends AbstractGroup

Represents a CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR 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: PD1 (PD1 - patient additional demographic segment) optional
• 3: NTE (NTE - notes and comments segment) optional repeating
• 4: CSU_C09_PV1PV2 (a Group object) optional
• 5: CSR (CSR - clinical study registration segment)
• 6: CSU_C09_CSPCSSORCOBROBXORCRXARXR (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
CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR(Group parent, ModelClassFactory factory) Creates a new CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR group

Method Summary

Methods

Modifier and Type	Method and Description
CSU_C09_CSPCSSORCOBROBXORCRXARXR	getCSPCSSORCOBROBXORCRXARXR() Returns the first repetition of CSPCSSORCOBROBXORCRXARXR (a Group object) - creates it if necessary
CSU_C09_CSPCSSORCOBROBXORCRXARXR	getCSPCSSORCOBROBXORCRXARXR(int rep) Returns a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object) - creates it if necessary
List<CSU_C09_CSPCSSORCOBROBXORCRXARXR>	getCSPCSSORCOBROBXORCRXARXRAll() Returns a non-modifiable List containing all current existing repetitions of CSPCSSORCOBROBXORCRXARXR.
int	getCSPCSSORCOBROBXORCRXARXRReps() Returns the number of existing repetitions of CSPCSSORCOBROBXORCRXARXR
CSR	getCSR() Returns CSR (CSR - clinical study registration segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - 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
PD1	getPD1() Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
CSU_C09_PV1PV2	getPV1PV2() Returns PV1PV2 (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertCSPCSSORCOBROBXORCRXARXR(CSU_C09_CSPCSSORCOBROBXORCRXARXR structure, int rep) Inserts a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)
CSU_C09_CSPCSSORCOBROBXORCRXARXR	insertCSPCSSORCOBROBXORCRXARXR(int rep) Inserts a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
CSU_C09_CSPCSSORCOBROBXORCRXARXR	removeCSPCSSORCOBROBXORCRXARXR(int rep) Removes a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments 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

CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR

public CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR(Group parent,
                                                  ModelClassFactory factory)

Creates a new CSU_C09_PIDPD1NTEPV1PV2CSRCSPCSSORCOBROBXORCRXARXR 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

getPD1

public PD1 getPD1()

Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

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 (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPV1PV2

public CSU_C09_PV1PV2 getPV1PV2()

Returns PV1PV2 (a Group object) - creates it if necessary

getCSR

public CSR getCSR()

Returns CSR (CSR - clinical study registration segment) - creates it if necessary

getCSPCSSORCOBROBXORCRXARXR

public CSU_C09_CSPCSSORCOBROBXORCRXARXR getCSPCSSORCOBROBXORCRXARXR()

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

getCSPCSSORCOBROBXORCRXARXR

public CSU_C09_CSPCSSORCOBROBXORCRXARXR getCSPCSSORCOBROBXORCRXARXR(int rep)

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

getCSPCSSORCOBROBXORCRXARXRReps

public int getCSPCSSORCOBROBXORCRXARXRReps()

Returns the number of existing repetitions of CSPCSSORCOBROBXORCRXARXR

getCSPCSSORCOBROBXORCRXARXRAll

public List<CSU_C09_CSPCSSORCOBROBXORCRXARXR> getCSPCSSORCOBROBXORCRXARXRAll()
                                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertCSPCSSORCOBROBXORCRXARXR

public void insertCSPCSSORCOBROBXORCRXARXR(CSU_C09_CSPCSSORCOBROBXORCRXARXR structure,
                                  int rep)
                                    throws HL7Exception

Inserts a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCSPCSSORCOBROBXORCRXARXR

public CSU_C09_CSPCSSORCOBROBXORCRXARXR insertCSPCSSORCOBROBXORCRXARXR(int rep)
                                                                throws HL7Exception

Inserts a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCSPCSSORCOBROBXORCRXARXR

public CSU_C09_CSPCSSORCOBROBXORCRXARXR removeCSPCSSORCOBROBXORCRXARXR(int rep)
                                                                throws HL7Exception

Removes a specific repetition of CSPCSSORCOBROBXORCRXARXR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)