cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralPurposePerformedProcedureStepInformationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralPurposePerformedProcedureStepInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralPurposePerformedProcedureStepInformationModule
extends Module

\* This module specifies attributes of General Purpose Performed Procedure Step Information Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
GeneralPurposePerformedProcedureStepInformationModule(IDataSet objIDataSet) Instantiates a new general purpose performed procedure step information module.

Method Summary

Methods

Modifier and Type	Method and Description
ActualHumanPerformersSequence	getActualHumanPerformersSequence() Retrieves pre-initialized object of ActualHumanPerformersSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getCommentsonthePerformedProcedureStep() Return attribute identifies User-defined comments on the Performed Procedure Step.
java.lang.String	getGeneralPurposePerformedProcedureStepStatus() Retrieves value Contains the state of the Performed Procedure Step.
java.lang.String	getPerformedProcedureStepDescription() Return attribute identifies Institution-generated description or classification of the Procedure Step that was performed.
java.lang.String	getPerformedProcedureStepEndDate() Return identifies Date on which the General Purpose Performed Procedure Step ended.
java.lang.String	getPerformedProcedureStepEndTime() Return Time at which the General Purpose Performed Procedure Step ended.
java.lang.String	getPerformedProcedureStepID() Return attribute identifies User or equipment generated identifier of that part of a Procedure that has been carried out within this procedure step.
java.lang.String	getPerformedProcedureStepStartDate() Return attribute identifies Date on which the General Purpose Performed Procedure Step started.
java.lang.String	getPerformedProcedureStepStartTime() Return attribute identifies Time at which the General Purpose Performed Procedure Step started.
PerformedProcessingApplicationsCodeSequence	getPerformedProcessingApplicationsCodeSequence() Retrieves pre-initialized object of PerformedProcessingApplicationsCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
PerformedStationClassCodeSequence	getPerformedStationClassCodeSequence() Retrieves pre-initialized object of PerformedStationClassCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
PerformedStationGeographicLocationCodeSequence	getPerformedStationGeographicLocationCodeSequence() Retrieves pre-initialized object of PerformedStationGeographicLocationCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
PerformedStationNameCodeSequence	getPerformedStationNameCodeSequence() Retrieves pre-initialized object of PerformedStationNameCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
PerformedWorkitemCodeSequence	getPerformedWorkitemCodeSequence() Retrieves pre-initialized object of PerformedWorkitemCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCommentsonthePerformedProcedureStep(java.lang.String strCommentsonthePerformedProcedureStep) Sets attribute identifies User-defined comments on the Performed Procedure Step.
void	setGeneralPurposePerformedProcedureStepStatus(EnumGeneralPurposePerformedProcedureStepStatus enumGeneralPurposePerformedProcedureStepStatus) Sets Contains the state of the Performed Procedure Step.
void	setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription) Sets attribute identifies Institution-generated description or classification of the Procedure Step that was performed.
void	setPerformedProcedureStepEndDate(java.lang.String strPerformedProcedureStepEndDate) Sets attribute identifies Date on which the General Purpose Performed Procedure Step ended.
void	setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime) Sets Time at which the General Purpose Performed Procedure Step ended.
void	setPerformedProcedureStepID(java.lang.String StrPerformedProcedureStepID) Sets attribute identifies User or equipment generated identifier of that part of a Procedure that has been carried out within this procedure step.
void	setPerformedProcedureStepStartDate(java.lang.String StrPerformedProcedureStepStartDate) Sets attribute identifies Date on which the General Purpose Performed Procedure Step started.
void	setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime) Sets attribute identifies Time at which the General Purpose Performed Procedure Step started.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

GeneralPurposePerformedProcedureStepInformationModule

public GeneralPurposePerformedProcedureStepInformationModule(IDataSet objIDataSet)

Instantiates a new general purpose performed procedure step information module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags.

getActualHumanPerformersSequence

public ActualHumanPerformersSequence getActualHumanPerformersSequence()

Retrieves pre-initialized object of ActualHumanPerformersSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ActualHumanPerformersSequence - instance of Actual Human Performers Sequence.

getPerformedStationNameCodeSequence

public PerformedStationNameCodeSequence getPerformedStationNameCodeSequence()

Retrieves pre-initialized object of PerformedStationNameCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PerformedStationNameCodeSequence - instance of Performed Station Name Code Sequence

getPerformedStationClassCodeSequence

public PerformedStationClassCodeSequence getPerformedStationClassCodeSequence()

Retrieves pre-initialized object of PerformedStationClassCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PerformedStationClassCodeSequence - instance of Performed Station Class Code Sequence

getPerformedStationGeographicLocationCodeSequence

public PerformedStationGeographicLocationCodeSequence getPerformedStationGeographicLocationCodeSequence()

Retrieves pre-initialized object of PerformedStationGeographicLocationCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PerformedStationGeographicLocationCodeSequence - instance of PerformedStation Geographic Location Code Sequence

getPerformedProcessingApplicationsCodeSequence

public PerformedProcessingApplicationsCodeSequence getPerformedProcessingApplicationsCodeSequence()

Retrieves pre-initialized object of PerformedProcessingApplicationsCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PerformedProcessingApplicationsCodeSequence - instance of Performed Processing Applications Code Sequence.

setPerformedProcedureStepStartDate

public void setPerformedProcedureStepStartDate(java.lang.String StrPerformedProcedureStepStartDate)

Sets attribute identifies Date on which the General Purpose Performed Procedure Step started.

Parameters:

StrPerformedProcedureStepStartDate - - String Date on which the General Purpose Performed Procedure Step started.

getPerformedProcedureStepStartDate

public java.lang.String getPerformedProcedureStepStartDate()

Return attribute identifies Date on which the General Purpose Performed Procedure Step started.

Returns:

String - String Date on which the General Purpose Performed Procedure Step started.

setPerformedProcedureStepStartTime

public void setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime)

Sets attribute identifies Time at which the General Purpose Performed Procedure Step started.

Parameters:

strPerformedProcedureStepStartTime - - String Time at which the General Purpose Performed Procedure Step started.

getPerformedProcedureStepStartTime

public java.lang.String getPerformedProcedureStepStartTime()

Return attribute identifies Time at which the General Purpose Performed Procedure Step started.

Returns:

String - String Time at which the General Purpose Performed Procedure Step started.

setPerformedProcedureStepID

public void setPerformedProcedureStepID(java.lang.String StrPerformedProcedureStepID)

Sets attribute identifies User or equipment generated identifier of that part of a Procedure that has been carried out within this procedure step.

Parameters:

StrPerformedProcedureStepID - - String User or equipment generated identifier.

getPerformedProcedureStepID

public java.lang.String getPerformedProcedureStepID()

Return attribute identifies User or equipment generated identifier of that part of a Procedure that has been carried out within this procedure step.

Returns:

String - String User or equipment generated identifier.

setPerformedProcedureStepEndDate

public void setPerformedProcedureStepEndDate(java.lang.String strPerformedProcedureStepEndDate)

Sets attribute identifies Date on which the General Purpose Performed Procedure Step ended.

Parameters:

strPerformedProcedureStepEndDate - - String identifies Date on which the General Purpose Performed Procedure Step ended.

getPerformedProcedureStepEndDate

public java.lang.String getPerformedProcedureStepEndDate()

Return identifies Date on which the General Purpose Performed Procedure Step ended.

Returns:

String - String identifies Date on which the General Purpose Performed Procedure Step ended.

setPerformedProcedureStepEndTime

public void setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime)

Sets Time at which the General Purpose Performed Procedure Step ended.

Parameters:

strPerformedProcedureStepEndTime - - String Time at which the General Purpose Performed Procedure Step ended.

getPerformedProcedureStepEndTime

public java.lang.String getPerformedProcedureStepEndTime()

Return Time at which the General Purpose Performed Procedure Step ended.

Returns:

String - String Time at which the General Purpose Performed Procedure Step ended.

setGeneralPurposePerformedProcedureStepStatus

public void setGeneralPurposePerformedProcedureStepStatus(EnumGeneralPurposePerformedProcedureStepStatus enumGeneralPurposePerformedProcedureStepStatus)

Sets Contains the state of the Performed Procedure Step.

Parameters:

enumGeneralPurposePerformedProcedureStepStatus - - Enum value Contains the state of the Performed Procedure Step.

getGeneralPurposePerformedProcedureStepStatus

public java.lang.String getGeneralPurposePerformedProcedureStepStatus()

Retrieves value Contains the state of the Performed Procedure Step.

Returns:

the general purpose performed procedure step status

setPerformedProcedureStepDescription

public void setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription)

Sets attribute identifies Institution-generated description or classification of the Procedure Step that was performed.

Parameters:

strPerformedProcedureStepDescription - - String identifies description of Institution

getPerformedProcedureStepDescription

public java.lang.String getPerformedProcedureStepDescription()

Return attribute identifies Institution-generated description or classification of the Procedure Step that was performed.

Returns:

String - String identifies description of Institution

setCommentsonthePerformedProcedureStep

public void setCommentsonthePerformedProcedureStep(java.lang.String strCommentsonthePerformedProcedureStep)

Sets attribute identifies User-defined comments on the Performed Procedure Step.

Parameters:

strCommentsonthePerformedProcedureStep - - String identifies User-defined comments

getCommentsonthePerformedProcedureStep

public java.lang.String getCommentsonthePerformedProcedureStep()

Return attribute identifies User-defined comments on the Performed Procedure Step.

Returns:

String - String identifies the User-defined comments

getPerformedWorkitemCodeSequence

public PerformedWorkitemCodeSequence getPerformedWorkitemCodeSequence()

Retrieves pre-initialized object of PerformedWorkitemCodeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

PerformedWorkitemCodeSequence - instance of Performed Work item Code Sequence