ca.uhn.hl7v2.model.v231.group

Class CRM_C01_PIDPV1CSRCSP

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.CRM_C01_PIDPV1CSRCSP

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CRM_C01_PIDPV1CSRCSP
extends AbstractGroup

Represents a CRM_C01_PIDPV1CSRCSP 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: CSR (CSR - clinical study registration segment)
• 4: CSP (CSP - clinical study phase 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
CRM_C01_PIDPV1CSRCSP(Group parent, ModelClassFactory factory) Creates a new CRM_C01_PIDPV1CSRCSP group

Method Summary

Modifier and Type	Method and Description
CSP	getCSP() Returns the first repetition of CSP (CSP - clinical study phase segment) - creates it if necessary
CSP	getCSP(int rep) Returns a specific repetition of CSP (CSP - clinical study phase segment) - creates it if necessary
List<CSP>	getCSPAll() Returns a non-modifiable List containing all current existing repetitions of CSP.
int	getCSPReps() Returns the number of existing repetitions of CSP
CSR	getCSR() Returns CSR (CSR - clinical study registration segment) - creates it if necessary
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
PV1	getPV1() Returns PV1 (PV1 - patient visit segment-) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertCSP(CSP structure, int rep) Inserts a specific repetition of CSP (CSP - clinical study phase segment)
CSP	insertCSP(int rep) Inserts a specific repetition of CSP (CSP - clinical study phase segment)
CSP	removeCSP(int rep) Removes a specific repetition of CSP (CSP - clinical study phase 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 Detail

CRM_C01_PIDPV1CSRCSP

public CRM_C01_PIDPV1CSRCSP(Group parent,
                            ModelClassFactory factory)

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

getCSR

public CSR getCSR()

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

getCSP

public CSP getCSP()

Returns the first repetition of CSP (CSP - clinical study phase segment) - creates it if necessary

getCSP

public CSP getCSP(int rep)

Returns a specific repetition of CSP (CSP - clinical study phase 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.

getCSPReps

public int getCSPReps()

Returns the number of existing repetitions of CSP

getCSPAll

public List<CSP> getCSPAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCSP

public void insertCSP(CSP structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of CSP (CSP - clinical study phase segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCSP

public CSP insertCSP(int rep)
              throws HL7Exception

Inserts a specific repetition of CSP (CSP - clinical study phase segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCSP

public CSP removeCSP(int rep)
              throws HL7Exception

Removes a specific repetition of CSP (CSP - clinical study phase segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)