ca.uhn.hl7v2.model.v281.group

Class CCR_I16_CLINICAL_HISTORY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CCR_I16_CLINICAL_HISTORY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCR_I16_CLINICAL_HISTORY
extends AbstractGroup

Represents a CCR_I16_CLINICAL_HISTORY 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_HISTORY_DETAIL (a Group object) optional repeating
• 3: CCR_I16_ROLE_CLINICAL_HISTORY (a Group object) optional 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_HISTORY(Group parent, ModelClassFactory factory) Creates a new CCR_I16_CLINICAL_HISTORY group

Method Summary

Modifier and Type	Method and Description
CCR_I16_CLINICAL_HISTORY_DETAIL	getCLINICAL_HISTORY_DETAIL() Returns the first repetition of CLINICAL_HISTORY_DETAIL (a Group object) - creates it if necessary
CCR_I16_CLINICAL_HISTORY_DETAIL	getCLINICAL_HISTORY_DETAIL(int rep) Returns a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object) - creates it if necessary
List<CCR_I16_CLINICAL_HISTORY_DETAIL>	getCLINICAL_HISTORY_DETAILAll() Returns a non-modifiable List containing all current existing repetitions of CLINICAL_HISTORY_DETAIL.
int	getCLINICAL_HISTORY_DETAILReps() Returns the number of existing repetitions of CLINICAL_HISTORY_DETAIL
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
CCR_I16_ROLE_CLINICAL_HISTORY	getROLE_CLINICAL_HISTORY() Returns the first repetition of ROLE_CLINICAL_HISTORY (a Group object) - creates it if necessary
CCR_I16_ROLE_CLINICAL_HISTORY	getROLE_CLINICAL_HISTORY(int rep) Returns a specific repetition of ROLE_CLINICAL_HISTORY (a Group object) - creates it if necessary
List<CCR_I16_ROLE_CLINICAL_HISTORY>	getROLE_CLINICAL_HISTORYAll() Returns a non-modifiable List containing all current existing repetitions of ROLE_CLINICAL_HISTORY.
int	getROLE_CLINICAL_HISTORYReps() Returns the number of existing repetitions of ROLE_CLINICAL_HISTORY
String	getVersion() Returns "2.8.1"
void	insertCLINICAL_HISTORY_DETAIL(CCR_I16_CLINICAL_HISTORY_DETAIL structure, int rep) Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)
CCR_I16_CLINICAL_HISTORY_DETAIL	insertCLINICAL_HISTORY_DETAIL(int rep) Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (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)
void	insertROLE_CLINICAL_HISTORY(CCR_I16_ROLE_CLINICAL_HISTORY structure, int rep) Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)
CCR_I16_ROLE_CLINICAL_HISTORY	insertROLE_CLINICAL_HISTORY(int rep) Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)
CCR_I16_CLINICAL_HISTORY_DETAIL	removeCLINICAL_HISTORY_DETAIL(int rep) Removes a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)
CCR_I16_ROLE_CLINICAL_HISTORY	removeROLE_CLINICAL_HISTORY(int rep) Removes a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)

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_HISTORY

public CCR_I16_CLINICAL_HISTORY(Group parent,
                                ModelClassFactory factory)

Creates a new CCR_I16_CLINICAL_HISTORY group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getCLINICAL_HISTORY_DETAIL

public CCR_I16_CLINICAL_HISTORY_DETAIL getCLINICAL_HISTORY_DETAIL()

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

getCLINICAL_HISTORY_DETAIL

public CCR_I16_CLINICAL_HISTORY_DETAIL getCLINICAL_HISTORY_DETAIL(int rep)

Returns a specific repetition of CLINICAL_HISTORY_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_HISTORY_DETAILReps

public int getCLINICAL_HISTORY_DETAILReps()

Returns the number of existing repetitions of CLINICAL_HISTORY_DETAIL

getCLINICAL_HISTORY_DETAILAll

public List<CCR_I16_CLINICAL_HISTORY_DETAIL> getCLINICAL_HISTORY_DETAILAll()
                                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCLINICAL_HISTORY_DETAIL

public void insertCLINICAL_HISTORY_DETAIL(CCR_I16_CLINICAL_HISTORY_DETAIL structure,
                                          int rep)
                                   throws HL7Exception

Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCLINICAL_HISTORY_DETAIL

public CCR_I16_CLINICAL_HISTORY_DETAIL insertCLINICAL_HISTORY_DETAIL(int rep)
                                                              throws HL7Exception

Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCLINICAL_HISTORY_DETAIL

public CCR_I16_CLINICAL_HISTORY_DETAIL removeCLINICAL_HISTORY_DETAIL(int rep)
                                                              throws HL7Exception

Removes a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROLE_CLINICAL_HISTORY

public CCR_I16_ROLE_CLINICAL_HISTORY getROLE_CLINICAL_HISTORY()

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

getROLE_CLINICAL_HISTORY

public CCR_I16_ROLE_CLINICAL_HISTORY getROLE_CLINICAL_HISTORY(int rep)

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

getROLE_CLINICAL_HISTORYReps

public int getROLE_CLINICAL_HISTORYReps()

Returns the number of existing repetitions of ROLE_CLINICAL_HISTORY

getROLE_CLINICAL_HISTORYAll

public List<CCR_I16_ROLE_CLINICAL_HISTORY> getROLE_CLINICAL_HISTORYAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertROLE_CLINICAL_HISTORY

public void insertROLE_CLINICAL_HISTORY(CCR_I16_ROLE_CLINICAL_HISTORY structure,
                                        int rep)
                                 throws HL7Exception

Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROLE_CLINICAL_HISTORY

public CCR_I16_ROLE_CLINICAL_HISTORY insertROLE_CLINICAL_HISTORY(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROLE_CLINICAL_HISTORY

public CCR_I16_ROLE_CLINICAL_HISTORY removeROLE_CLINICAL_HISTORY(int rep)
                                                          throws HL7Exception

Removes a specific repetition of ROLE_CLINICAL_HISTORY (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)