ca.uhn.hl7v2.model.v27.segment

Class CSS

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v27.segment.CSS

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class CSS
extends AbstractSegment

Represents an HL7 CSS message segment (Clinical Study Data Schedule Segment). This segment has the following fields:

• CSS-1: Study Scheduled Time Point (CWE)
• CSS-2: Study Scheduled Patient Time Point (DTM) optional
• CSS-3: Study Quality Control Codes (CWE) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
CSS(Group parent, ModelClassFactory factory) Creates a new CSS segment

Method Summary

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
CWE	getCss1_StudyScheduledTimePoint() Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary
DTM	getCss2_StudyScheduledPatientTimePoint() Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary
CWE[]	getCss3_StudyQualityControlCodes() Returns all repetitions of Study Quality Control Codes (CSS-3).
CWE	getCss3_StudyQualityControlCodes(int rep) Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary
int	getCss3_StudyQualityControlCodesReps() Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3).
CWE[]	getStudyQualityControlCodes() Returns all repetitions of Study Quality Control Codes (CSS-3).
CWE	getStudyQualityControlCodes(int rep) Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary
int	getStudyQualityControlCodesReps() Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3).
DTM	getStudyScheduledPatientTimePoint() Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary
CWE	getStudyScheduledTimePoint() Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary
CWE	insertCss3_StudyQualityControlCodes(int rep) Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CWE	insertStudyQualityControlCodes(int rep) Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CWE	removeCss3_StudyQualityControlCodes(int rep) Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CWE	removeStudyQualityControlCodes(int rep) Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

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

CSS

public CSS(Group parent,
           ModelClassFactory factory)

Creates a new CSS segment

Method Detail

getStudyScheduledTimePoint

public CWE getStudyScheduledTimePoint()

Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary

getCss1_StudyScheduledTimePoint

public CWE getCss1_StudyScheduledTimePoint()

Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary

getStudyScheduledPatientTimePoint

public DTM getStudyScheduledPatientTimePoint()

Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary

getCss2_StudyScheduledPatientTimePoint

public DTM getCss2_StudyScheduledPatientTimePoint()

Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary

getStudyQualityControlCodes

public CWE[] getStudyQualityControlCodes()

Returns all repetitions of Study Quality Control Codes (CSS-3).

getCss3_StudyQualityControlCodes

public CWE[] getCss3_StudyQualityControlCodes()

Returns all repetitions of Study Quality Control Codes (CSS-3).

getStudyQualityControlCodesReps

public int getStudyQualityControlCodesReps()

Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getStudyQualityControlCodes

public CWE getStudyQualityControlCodes(int rep)

Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCss3_StudyQualityControlCodes

public CWE getCss3_StudyQualityControlCodes(int rep)

Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCss3_StudyQualityControlCodesReps

public int getCss3_StudyQualityControlCodesReps()

Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertStudyQualityControlCodes

public CWE insertStudyQualityControlCodes(int rep)
                                   throws HL7Exception

Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertCss3_StudyQualityControlCodes

public CWE insertCss3_StudyQualityControlCodes(int rep)
                                        throws HL7Exception

Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeStudyQualityControlCodes

public CWE removeStudyQualityControlCodes(int rep)
                                   throws HL7Exception

Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeCss3_StudyQualityControlCodes

public CWE removeCss3_StudyQualityControlCodes(int rep)
                                        throws HL7Exception

Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment