ca.uhn.hl7v2.model.v27.group

Class CCI_I22_CLINICAL_HISTORY_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v27.group.CCI_I22_CLINICAL_HISTORY_DETAIL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCI_I22_CLINICAL_HISTORY_DETAIL
extends AbstractGroup

Represents a CCI_I22_CLINICAL_HISTORY_DETAIL 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: OBR (Observation Request) choice
• 2: ODS (Dietary Orders, Supplements, and Preferences) choice
• 3: PR1 (Procedures) choice
• 4: RF1 (Referral Information) choice
• 5: AL1 (Patient Allergy Information) choice
• 6: IAM (Patient Adverse Reaction Information) choice
• 7: ACC (Accident) choice
• 8: RMI (Risk Management Incident) choice
• 9: DB1 (Disability) choice
• 10: DG1 (Diagnosis) choice
• 11: DRG (Diagnosis Related Group) choice
• 12: PDA (Patient Death and Autopsy) choice
• 13: OBX (Observation/Result) optional repeating

Note that this structure has "choice" elements. This means that one of the structures above marked as "choice" must be present, but no more than one.

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ACC	getACC() Returns ACC (Accident) - creates it if necessary
AL1	getAL1() Returns AL1 (Patient Allergy Information) - creates it if necessary
DB1	getDB1() Returns DB1 (Disability) - creates it if necessary
DG1	getDG1() Returns DG1 (Diagnosis) - creates it if necessary
DRG	getDRG() Returns DRG (Diagnosis Related Group) - creates it if necessary
IAM	getIAM() Returns IAM (Patient Adverse Reaction Information) - creates it if necessary
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OBX	getOBX() Returns the first repetition of OBX (Observation/Result) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (Observation/Result) - 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
ODS	getODS() Returns ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
PDA	getPDA() Returns PDA (Patient Death and Autopsy) - creates it if necessary
PR1	getPR1() Returns PR1 (Procedures) - creates it if necessary
RF1	getRF1() Returns RF1 (Referral Information) - creates it if necessary
RMI	getRMI() Returns RMI (Risk Management Incident) - creates it if necessary
String	getVersion() Returns "2.7"
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (Observation/Result)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (Observation/Result)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)

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

CCI_I22_CLINICAL_HISTORY_DETAIL

public CCI_I22_CLINICAL_HISTORY_DETAIL(Group parent,
                                       ModelClassFactory factory)

Creates a new CCI_I22_CLINICAL_HISTORY_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.7"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getODS

public ODS getODS()

Returns ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary

getPR1

public PR1 getPR1()

Returns PR1 (Procedures) - creates it if necessary

getRF1

public RF1 getRF1()

Returns RF1 (Referral Information) - creates it if necessary

getAL1

public AL1 getAL1()

Returns AL1 (Patient Allergy Information) - creates it if necessary

getIAM

public IAM getIAM()

Returns IAM (Patient Adverse Reaction Information) - creates it if necessary

getACC

public ACC getACC()

Returns ACC (Accident) - creates it if necessary

getRMI

public RMI getRMI()

Returns RMI (Risk Management Incident) - creates it if necessary

getDB1

public DB1 getDB1()

Returns DB1 (Disability) - creates it if necessary

getDG1

public DG1 getDG1()

Returns DG1 (Diagnosis) - creates it if necessary

getDRG

public DRG getDRG()

Returns DRG (Diagnosis Related Group) - creates it if necessary

getPDA

public PDA getPDA()

Returns PDA (Patient Death and Autopsy) - creates it if necessary

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation/Result) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation/Result) - 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 (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)