cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralPurposeScheduledProcedureStepRelationshipModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralPurposeScheduledProcedureStepRelationshipModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralPurposeScheduledProcedureStepRelationshipModule
extends Module

\* This module specifies the Attributes that identify the General Purpose Scheduled 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
GeneralPurposeScheduledProcedureStepRelationshipModule(IDataSet objIDataSet) Instantiates a new general purpose scheduled procedure step relationship module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getIssuerOfPatientID() Retrieves Identifier of the Assigning Authority (system, organization, agency, or department) that issued the Patient ID.
java.lang.String	getPatientBirthDate() Retrieves Patient Birth Date.
java.lang.String	getPatientID() Retrieves Primary hospital identification number or code for the patient.
java.lang.String	getPatientSex() Retrieves Patient Sex.
java.lang.String	getPatientsName() Retrieves Patient's full legal name.
ReferencedRequestSequence	getReferencedRequestSequence() Retrieves pre-initialized object of ReferencedRequestSequence.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	setIssuerOfPatientID(java.lang.String strIssuerOfPatientID) Identifier of the Assigning Authority (system, organization, agency, or department) that issued the Patient ID.
void	setPatientBirthDate(java.lang.String strPatientBirthDate) Sets Date of birth of the named patient.
void	setPatientID(java.lang.String strPatientID) Sets Primary hospital identification number or code for the patient.
void	setPatientSex(EnumPatientsSex enumPatientSex) Sets Sex of the named patient.
void	setPatientsName(java.lang.String strPatientsName) Sets Patient's full legal name.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.

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

GeneralPurposeScheduledProcedureStepRelationshipModule

public GeneralPurposeScheduledProcedureStepRelationshipModule(IDataSet objIDataSet)

Instantiates a new general purpose scheduled procedure step relationship module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

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 - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setPatientsName

public void setPatientsName(java.lang.String strPatientsName)

Sets Patient's full legal name.

Parameters:

strPatientsName - String value of Patient's Name.

getPatientsName

public java.lang.String getPatientsName()

Retrieves Patient's full legal name.

Returns:

String - String value of Patient's full legal name.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets Primary hospital identification number or code for the patient.

Parameters:

strPatientID - String value of Patient ID.

getPatientID

public java.lang.String getPatientID()

Retrieves Primary hospital identification number or code for the patient.

Returns:

String - String value of Patient ID.

setIssuerOfPatientID

public void setIssuerOfPatientID(java.lang.String strIssuerOfPatientID)

Identifier of the Assigning Authority (system, organization, agency, or department) that issued the Patient ID.

Parameters:

strIssuerOfPatientID - - String value of Issuer Of PatientID.

getIssuerOfPatientID

public java.lang.String getIssuerOfPatientID()

Retrieves Identifier of the Assigning Authority (system, organization, agency, or department) that issued the Patient ID.

Returns:

String - String value of Issuer Of Patient ID.

setPatientBirthDate

public void setPatientBirthDate(java.lang.String strPatientBirthDate)

Sets Date of birth of the named patient.

Parameters:

strPatientBirthDate - - String value of Patient Birth Date.

getPatientBirthDate

public java.lang.String getPatientBirthDate()

Retrieves Patient Birth Date.

Returns:

String - String value of Patient Birth Date.

setPatientSex

public void setPatientSex(EnumPatientsSex enumPatientSex)

Sets Sex of the named patient. Enumerated Values:M = male, F = female, O = other

Parameters:

enumPatientSex - - Enum value of Patient sex.

getPatientSex

public java.lang.String getPatientSex()

Retrieves Patient Sex.

Returns:

String - String value of Patient Sex.

getReferencedRequestSequence

public ReferencedRequestSequence getReferencedRequestSequence()

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

ReferencedRequestSequence - instance of ReferencedRequestSequence.

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:

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