ca.uhn.hl7v2.model.v28.group

Class CCR_I16_CLINICAL_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.CCR_I16_CLINICAL_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCR_I16_CLINICAL_ORDER
extends AbstractGroup

Represents a CCR_I16_CLINICAL_ORDER 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: ORC (Common Order)
• 2: CCR_I16_CLINICAL_ORDER_TIMING (a Group object) optional repeating
• 3: CCR_I16_CLINICAL_ORDER_DETAIL (a Group object) repeating
• 4: CTI (Clinical Trial Identification) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CCR_I16_CLINICAL_ORDER_DETAIL	getCLINICAL_ORDER_DETAIL() Returns the first repetition of CLINICAL_ORDER_DETAIL (a Group object) - creates it if necessary
CCR_I16_CLINICAL_ORDER_DETAIL	getCLINICAL_ORDER_DETAIL(int rep) Returns a specific repetition of CLINICAL_ORDER_DETAIL (a Group object) - creates it if necessary
List<CCR_I16_CLINICAL_ORDER_DETAIL>	getCLINICAL_ORDER_DETAILAll() Returns a non-modifiable List containing all current existing repetitions of CLINICAL_ORDER_DETAIL.
int	getCLINICAL_ORDER_DETAILReps() Returns the number of existing repetitions of CLINICAL_ORDER_DETAIL
CCR_I16_CLINICAL_ORDER_TIMING	getCLINICAL_ORDER_TIMING() Returns the first repetition of CLINICAL_ORDER_TIMING (a Group object) - creates it if necessary
CCR_I16_CLINICAL_ORDER_TIMING	getCLINICAL_ORDER_TIMING(int rep) Returns a specific repetition of CLINICAL_ORDER_TIMING (a Group object) - creates it if necessary
List<CCR_I16_CLINICAL_ORDER_TIMING>	getCLINICAL_ORDER_TIMINGAll() Returns a non-modifiable List containing all current existing repetitions of CLINICAL_ORDER_TIMING.
int	getCLINICAL_ORDER_TIMINGReps() Returns the number of existing repetitions of CLINICAL_ORDER_TIMING
CTI	getCTI() Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
CTI	getCTI(int rep) Returns a specific repetition of CTI (Clinical Trial Identification) - creates it if necessary
List<CTI>	getCTIAll() Returns a non-modifiable List containing all current existing repetitions of CTI.
int	getCTIReps() Returns the number of existing repetitions of CTI
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
String	getVersion() Returns "2.8"
void	insertCLINICAL_ORDER_DETAIL(CCR_I16_CLINICAL_ORDER_DETAIL structure, int rep) Inserts a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)
CCR_I16_CLINICAL_ORDER_DETAIL	insertCLINICAL_ORDER_DETAIL(int rep) Inserts a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)
void	insertCLINICAL_ORDER_TIMING(CCR_I16_CLINICAL_ORDER_TIMING structure, int rep) Inserts a specific repetition of CLINICAL_ORDER_TIMING (a Group object)
CCR_I16_CLINICAL_ORDER_TIMING	insertCLINICAL_ORDER_TIMING(int rep) Inserts a specific repetition of CLINICAL_ORDER_TIMING (a Group object)
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
CCR_I16_CLINICAL_ORDER_DETAIL	removeCLINICAL_ORDER_DETAIL(int rep) Removes a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)
CCR_I16_CLINICAL_ORDER_TIMING	removeCLINICAL_ORDER_TIMING(int rep) Removes a specific repetition of CLINICAL_ORDER_TIMING (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)

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

CCR_I16_CLINICAL_ORDER

public CCR_I16_CLINICAL_ORDER(Group parent,
                              ModelClassFactory factory)

Creates a new CCR_I16_CLINICAL_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.8"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getCLINICAL_ORDER_TIMING

public CCR_I16_CLINICAL_ORDER_TIMING getCLINICAL_ORDER_TIMING()

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

getCLINICAL_ORDER_TIMING

public CCR_I16_CLINICAL_ORDER_TIMING getCLINICAL_ORDER_TIMING(int rep)

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

getCLINICAL_ORDER_TIMINGReps

public int getCLINICAL_ORDER_TIMINGReps()

Returns the number of existing repetitions of CLINICAL_ORDER_TIMING

getCLINICAL_ORDER_TIMINGAll

public List<CCR_I16_CLINICAL_ORDER_TIMING> getCLINICAL_ORDER_TIMINGAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertCLINICAL_ORDER_TIMING

public void insertCLINICAL_ORDER_TIMING(CCR_I16_CLINICAL_ORDER_TIMING structure,
                                        int rep)
                                 throws HL7Exception

Inserts a specific repetition of CLINICAL_ORDER_TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCLINICAL_ORDER_TIMING

public CCR_I16_CLINICAL_ORDER_TIMING insertCLINICAL_ORDER_TIMING(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of CLINICAL_ORDER_TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCLINICAL_ORDER_TIMING

public CCR_I16_CLINICAL_ORDER_TIMING removeCLINICAL_ORDER_TIMING(int rep)
                                                          throws HL7Exception

Removes a specific repetition of CLINICAL_ORDER_TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCLINICAL_ORDER_DETAIL

public CCR_I16_CLINICAL_ORDER_DETAIL getCLINICAL_ORDER_DETAIL()

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

getCLINICAL_ORDER_DETAIL

public CCR_I16_CLINICAL_ORDER_DETAIL getCLINICAL_ORDER_DETAIL(int rep)

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

getCLINICAL_ORDER_DETAILReps

public int getCLINICAL_ORDER_DETAILReps()

Returns the number of existing repetitions of CLINICAL_ORDER_DETAIL

getCLINICAL_ORDER_DETAILAll

public List<CCR_I16_CLINICAL_ORDER_DETAIL> getCLINICAL_ORDER_DETAILAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertCLINICAL_ORDER_DETAIL

public void insertCLINICAL_ORDER_DETAIL(CCR_I16_CLINICAL_ORDER_DETAIL structure,
                                        int rep)
                                 throws HL7Exception

Inserts a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCLINICAL_ORDER_DETAIL

public CCR_I16_CLINICAL_ORDER_DETAIL insertCLINICAL_ORDER_DETAIL(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCLINICAL_ORDER_DETAIL

public CCR_I16_CLINICAL_ORDER_DETAIL removeCLINICAL_ORDER_DETAIL(int rep)
                                                          throws HL7Exception

Removes a specific repetition of CLINICAL_ORDER_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (Clinical Trial Identification) - 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

getCTIAll

public List<CTI> getCTIAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCTI

public void insertCTI(CTI structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)