cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PerformedProcedureStepInformationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PerformedProcedureStepInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PerformedProcedureStepInformationModule
extends Module

\* This module describes the attributes in 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
PerformedProcedureStepInformationModule(IDataSet objIDataSet) CreatesPerformed Procedure Step Information Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommentsonthePerformedProcedureStep() Return User-defined comments on the Performed Procedure Step.
java.lang.String	getPerformedLocation() Return attribute identifies Description of the location at which the Performed Procedure Step was performed.
java.lang.String	getPerformedProcedureStepDescription() Return attribute identifies Institution-generated description or classification of the Procedure Step that was performed.
PerformedProcedureStepDiscontinuationReasonCodeSequence	getPerformedProcedureStepDiscontinuationReasonCodeSequence() Retrieves pre-initialized object of PerformedProcedureStepDiscontinuationReasonCodeSequence.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	getPerformedProcedureStepEndDate() Return Date on which the Performed Procedure Step ended.
java.lang.String	getPerformedProcedureStepEndTime() Return Time at which the Performed Procedure Step ended.
java.lang.String	getPerformedProcedureStepID() Return attribute User or equipment generated identifier of that part of a Procedure that has been carried out within this step.
java.lang.String	getPerformedProcedureStepStartDate() Return Date on which the Performed Procedure Step started.
java.lang.String	getPerformedProcedureStepStartTime() Return Time at which the Performed Procedure Step started.
java.lang.String	getPerformedProcedureStepStatus() Retrieves state of the Performed Procedure Step.
java.lang.String	getPerformedProcedureTypeDescription() Return the description of the type of procedure performed.
java.lang.String	getPerformedStationAETitle() Return attribute identifies AE title of the modality on which the Performed Procedure Step was performed.
java.lang.String	getPerformedStationName() Return attribute An institution defined name for the modality on which the Performed Procedure Step was performed.
ProcedureCodeSequence	getProcedureCodeSequence() Retrieves pre-initialized object of ProcedureCodeSequence.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
ReasonForPerformedProcedureCodeSequence	getReasonForPerformedProcedureCodeSequence() Retrieves pre-initialized object of ReasonForPerformedProcedureCodeSequence.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 User-defined comments on the Performed Procedure Step.
void	setPerformedLocation(java.lang.String StrPerformedLocation) Sets attribute identifies Description of the location at which the Performed Procedure Step was performed.
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 Date on which the Performed Procedure Step ended.
void	setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime) Sets attribute Time at which the Performed Procedure Step ended.
void	setPerformedProcedureStepID(java.lang.String StrPerformedProcedureStepID) Sets attribute User or equipment generated identifier of that part of a Procedure that has been carried out within this step.
void	setPerformedProcedureStepStartDate(java.lang.String StrPerformedProcedureStepStartDate) Sets attribute identifies Date on which the Performed Procedure Step started.
void	setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime) Sets attribute identifies Time at which the Performed Procedure Step started.
void	setPerformedProcedureStepStatus(EnumPerformedProcedureStepStatus enumPerformedProcedureStepStatus) Sets Contains the state of the Performed Procedure Step.
void	setPerformedProcedureTypeDescription(java.lang.String StrPerformedProcedureTypeDescription) Sets the description of the type of procedure performed.
void	setPerformedStationAETitle(java.lang.String StrPerformedStationAETitle) Sets attribute identifies AE title of the modality on which the Performed Procedure Step was performed.
void	setPerformedStationName(java.lang.String StrPerformedStationName) Sets attribute An institution defined name for the modality on which the Performed Procedure Step was performed.
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

PerformedProcedureStepInformationModule

public PerformedProcedureStepInformationModule(IDataSet objIDataSet)

CreatesPerformed Procedure Step Information Module with default initialization.

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:

- validation status as success or failure

Throws:

InvalidModuleException - when the module is invalid

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

setPerformedStationAETitle

public void setPerformedStationAETitle(java.lang.String StrPerformedStationAETitle)

Sets attribute identifies AE title of the modality on which the Performed Procedure Step was performed.

Parameters:

StrPerformedStationAETitle - - String AE title

getPerformedStationAETitle

public java.lang.String getPerformedStationAETitle()

Return attribute identifies AE title of the modality on which the Performed Procedure Step was performed.

Returns:

String - String AE title

setPerformedStationName

public void setPerformedStationName(java.lang.String StrPerformedStationName)

Sets attribute An institution defined name for the modality on which the Performed Procedure Step was performed.

Parameters:

StrPerformedStationName - - String institution name.

getPerformedStationName

public java.lang.String getPerformedStationName()

Return attribute An institution defined name for the modality on which the Performed Procedure Step was performed.

Returns:

String - String institution name.

setPerformedLocation

public void setPerformedLocation(java.lang.String StrPerformedLocation)

Sets attribute identifies Description of the location at which the Performed Procedure Step was performed.

Parameters:

StrPerformedLocation - - String identifies Description of the location

getPerformedLocation

public java.lang.String getPerformedLocation()

Return attribute identifies Description of the location at which the Performed Procedure Step was performed.

Returns:

String - String Description of the location

setPerformedProcedureStepStartDate

public void setPerformedProcedureStepStartDate(java.lang.String StrPerformedProcedureStepStartDate)

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

Parameters:

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

getPerformedProcedureStepStartDate

public java.lang.String getPerformedProcedureStepStartDate()

Return Date on which the Performed Procedure Step started.

Returns:

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

setPerformedProcedureStepStartTime

public void setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime)

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

Parameters:

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

getPerformedProcedureStepStartTime

public java.lang.String getPerformedProcedureStepStartTime()

Return Time at which the Performed Procedure Step started.

Returns:

String - String identifies Time at which the Performed Procedure Step started.

setPerformedProcedureStepID

public void setPerformedProcedureStepID(java.lang.String StrPerformedProcedureStepID)

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

Parameters:

StrPerformedProcedureStepID - - String User or equipment generated identifier

getPerformedProcedureStepID

public java.lang.String getPerformedProcedureStepID()

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

Returns:

String - String User or equipment generated identifier

setPerformedProcedureStepEndDate

public void setPerformedProcedureStepEndDate(java.lang.String strPerformedProcedureStepEndDate)

Sets attribute Date on which the Performed Procedure Step ended.

Parameters:

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

getPerformedProcedureStepEndDate

public java.lang.String getPerformedProcedureStepEndDate()

Return Date on which the Performed Procedure Step ended.

Returns:

String - String Date on which the Performed Procedure Step ended.

setPerformedProcedureStepEndTime

public void setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime)

Sets attribute Time at which the Performed Procedure Step ended.

Parameters:

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

getPerformedProcedureStepEndTime

public java.lang.String getPerformedProcedureStepEndTime()

Return Time at which the Performed Procedure Step ended.

Returns:

String - String identifies Time at which the Performed Procedure Step ended.

setPerformedProcedureStepStatus

public void setPerformedProcedureStepStatus(EnumPerformedProcedureStepStatus enumPerformedProcedureStepStatus)

Sets Contains the state of the Performed Procedure Step.

Parameters:

enumPerformedProcedureStepStatus - - Enum value of state of the Performed Procedure Step

getPerformedProcedureStepStatus

public java.lang.String getPerformedProcedureStepStatus()

Retrieves state of the Performed Procedure Step.

Returns:

the 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 Institution-generated description

getPerformedProcedureStepDescription

public java.lang.String getPerformedProcedureStepDescription()

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

Returns:

String - String Institution-generated description

setCommentsonthePerformedProcedureStep

public void setCommentsonthePerformedProcedureStep(java.lang.String strCommentsonthePerformedProcedureStep)

Sets User-defined comments on the Performed Procedure Step.

Parameters:

strCommentsonthePerformedProcedureStep - - String User-defined comments

getCommentsonthePerformedProcedureStep

public java.lang.String getCommentsonthePerformedProcedureStep()

Return User-defined comments on the Performed Procedure Step.

Returns:

String - String User-defined comments

setPerformedProcedureTypeDescription

public void setPerformedProcedureTypeDescription(java.lang.String StrPerformedProcedureTypeDescription)

Sets the description of the type of procedure performed.

Parameters:

StrPerformedProcedureTypeDescription - - String description of the type of procedure performed.

getPerformedProcedureTypeDescription

public java.lang.String getPerformedProcedureTypeDescription()

Return the description of the type of procedure performed.

Returns:

String - String description of the type of procedure performed.

getProcedureCodeSequence

public ProcedureCodeSequence getProcedureCodeSequence()

Retrieves pre-initialized object of ProcedureCodeSequence.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:

ProcedureCodeSequence - instance of Referenced Procedure Code Sequence

getReasonForPerformedProcedureCodeSequence

public ReasonForPerformedProcedureCodeSequence getReasonForPerformedProcedureCodeSequence()

Retrieves pre-initialized object of ReasonForPerformedProcedureCodeSequence.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:

ReasonForPerformedProcedureCodeSequence - instance of ReasonForPerformedProcedureCodeSequence.

getPerformedProcedureStepDiscontinuationReasonCodeSequence

public PerformedProcedureStepDiscontinuationReasonCodeSequence getPerformedProcedureStepDiscontinuationReasonCodeSequence()

Retrieves pre-initialized object of PerformedProcedureStepDiscontinuationReasonCodeSequence.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:

PerformedProcedureStepDiscontinuationReasonCodeSequence - instance of Referenced Reference Image Sequence.