cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PerformedProcedureStepRelationshipModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PerformedProcedureStepRelationshipModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PerformedProcedureStepRelationshipModule
extends Module

\* This module describes the attributes in Performed Procedure Step Relationship Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PerformedProcedureStepRelationshipModule(IDataSet objIDataSet) Creates Performed Procedure Step Relationship Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getIssuerofPatientID() Return attribute identifies Assigning Authority that issued the Patient ID.
IssuerofPatientIDMacro	getIssuerofPatientIDMacro() Get the Instance of Issuer of Patient ID Macro.Attributes related to Issuer of Patient ID Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
IssuerofServiceEpisodeIDSequence	getIssuerofServiceEpisodeIDSequence() This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.
java.lang.String	getPatientID() Return identifies Primary hospital identification number or code for the patient.
java.lang.String	getPatientsBirthDate() Return Date of birth of the named patient.
java.lang.String	getPatientsName() Return Patient's full legal name.
java.lang.String	getPatientsSex() Retrieves sex of Patient.
ReferencedPatientSequence	getReferencedPatientSequence() Retrieves pre-initialized object of ReferencedPatientSequence.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
ScheduledStepAttributesSequence	getScheduledStepAttributesSequence() Retrieves pre-initialized object of ScheduledStepAttributesSequence.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	getServiceEpisodeDescription() Retrieves Service Episode Description.
java.lang.String	getServiceEpisodeID() Retrieves Service Episode ID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setIssuerofPatientID(java.lang.String strIssuerOfPatientID) Sets attribute identifies Assigning Authority that issued the Patient ID.
void	setPatientID(java.lang.String strPatientID) Sets attribute identifies Primary hospital identification number or code for the patient.
void	setPatientsBirthDate(java.lang.String StrPatientsBirthDate) Sets attribute identifies Date of birth of the named patient.
void	setPatientsName(java.lang.String strPatientsName) Sets attribute identifies Patient's full legal name.
void	setPatientsSex(EnumPatientsSex enumPatientsSex) Sets attribute identifies sex of Patient.
void	setServiceEpisodeDescription(java.lang.String strServiceEpisodeDescription) Sets Description of the type of service episode.
void	setServiceEpisodeID(java.lang.String strServiceEpisodeID) Sets Identifier of the Service Episode as assigned by the healthcare provider.
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

PerformedProcedureStepRelationshipModule

public PerformedProcedureStepRelationshipModule(IDataSet objIDataSet)

Creates Performed Procedure Step Relationship 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

setPatientsName

public void setPatientsName(java.lang.String strPatientsName)

Sets attribute identifies Patient's full legal name.

Parameters:

strPatientsName - - String identifies Patient's full legal name.

getPatientsName

public java.lang.String getPatientsName()

Return Patient's full legal name.

Returns:

String - String identifies Patient's full legal name.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets attribute identifies Primary hospital identification number or code for the patient.

Parameters:

strPatientID - - String identifies Primary hospital identification number

getPatientID

public java.lang.String getPatientID()

Return identifies Primary hospital identification number or code for the patient.

Returns:

String - String identifies Primary hospital identification number

getIssuerofPatientIDMacro

public IssuerofPatientIDMacro getIssuerofPatientIDMacro()

Get the Instance of Issuer of Patient ID Macro.Attributes related to Issuer of Patient ID Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Issuer of Patient ID Macro

setIssuerofPatientID

public void setIssuerofPatientID(java.lang.String strIssuerOfPatientID)

Sets attribute identifies Assigning Authority that issued the Patient ID.

Parameters:

strIssuerOfPatientID - - String Patient ID.

getIssuerofPatientID

public java.lang.String getIssuerofPatientID()

Return attribute identifies Assigning Authority that issued the Patient ID.

Returns:

String - String Patient ID.

setPatientsBirthDate

public void setPatientsBirthDate(java.lang.String StrPatientsBirthDate)

Sets attribute identifies Date of birth of the named patient.

Parameters:

StrPatientsBirthDate - - String Date of birth

getPatientsBirthDate

public java.lang.String getPatientsBirthDate()

Return Date of birth of the named patient.

Returns:

String - String identifies Date of birth

setPatientsSex

public void setPatientsSex(EnumPatientsSex enumPatientsSex)

Sets attribute identifies sex of Patient.

Parameters:

enumPatientsSex - - Enum value sex of Patient

getPatientsSex

public java.lang.String getPatientsSex()

Retrieves sex of Patient.

Returns:

the patients sex

getReferencedPatientSequence

public ReferencedPatientSequence getReferencedPatientSequence()

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

ReferencedPatientSequence - instance of Referenced Reference Image Sequence.

setServiceEpisodeID

public void setServiceEpisodeID(java.lang.String strServiceEpisodeID)

Sets Identifier of the Service Episode as assigned by the healthcare provider.

Parameters:

strServiceEpisodeID - String value of Service Episode ID

getServiceEpisodeID

public java.lang.String getServiceEpisodeID()

Retrieves Service Episode ID.

Returns:

String - String value of Service Episode ID

getIssuerofServiceEpisodeIDSequence

public IssuerofServiceEpisodeIDSequence getIssuerofServiceEpisodeIDSequence()

This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.

Returns:

- object of Issuer of Service Episode ID Sequence. 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

setServiceEpisodeDescription

public void setServiceEpisodeDescription(java.lang.String strServiceEpisodeDescription)

Sets Description of the type of service episode.

Parameters:

strServiceEpisodeDescription - String value of Service Episode Description

getServiceEpisodeDescription

public java.lang.String getServiceEpisodeDescription()

Retrieves Service Episode Description.

Returns:

String - String value of Service Episode Description

getScheduledStepAttributesSequence

public ScheduledStepAttributesSequence getScheduledStepAttributesSequence()

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

ScheduledStepAttributesSequence - instance of Referenced Reference Image Sequence.