cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PatientModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PatientModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PatientModule
extends Module

This class specifies the Attributes of the Patient that describe and identify the Patient who is the subject of a diagnostic Study. This Module contains Attributes of the patient that are needed for diagnostic interpretation of the Image and are common for all studies performed on the patient.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PatientModule(IDataSet objIDataSet) Instantiates a new patient module.

Method Summary

Methods

Modifier and Type	Method and Description
BreedRegistrationSequence	getBreedRegistrationSequence() This method provides the pre-initialized object of Breed Registration Sequence.
java.lang.String	getDeidentificationMethod() Retrieves Deidentification Method.
DeidentificationMethodCodeSequence	getDeidentificationMethodCodeSequence() This method provides the pre-initialized object of Deidentification Method Code Sequence.
java.lang.String	getEthnicGroup() Return the String value of the attribute Ethnic Group.
java.lang.String	getIssuerOfPatientID() Return the String value of the attribute Issuer Of Patient ID.
IssuerofPatientIDMacro	getIssuerofPatientIDMacro() Get the Instance of Issuer of Patient ID Macro.Attributes related to IssuerofPatientID 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.
java.lang.String[]	getOtherPatientIDs() Return the Array of String values of the attribute Other Patient IDs.
OtherPatientIDsSequence	getOtherPatientIDsSequence() This method provides the pre-initialized object of Other Patient IDs Sequence.
java.lang.String[]	getOtherPatientNames() Return the Array of String values of the attribute Other Patient Names.
java.lang.String	getPatientBirthDate() Return the String value of the attribute Patient Birth Date.
java.lang.String	getPatientBirthTime() Return the String value of the attribute Patient Birth Time.
PatientBreedCodeSequence	getPatientBreedCodeSequence() This method provides the pre-initialized object of Patient Breed Code Sequence.
java.lang.String	getPatientBreedDescription() Retrieves Patient Breed Description.
java.lang.String	getPatientComments() Return the String value of the attribute Patient Comments.
java.lang.String	getPatientID() Return the String value of the attribute Patient ID.
java.lang.String	getPatientIdentityRemoved() Retrieves Patient Identity Removed.
java.lang.String	getPatientName() Return the String value of the attribute Patient Name.
java.lang.String	getPatientSex() Return the String value of the attribute Patient Sex.
PatientSpeciesCodeSequence	getPatientSpeciesCodeSequence() This method provides the pre-initialized object of Patient Species Code Sequence.
java.lang.String	getPatientSpeciesDescription() Retrieves Patient Species Description.
java.lang.String	getQualityControlSubject() Retrieves Quality Control Subject.
ReferencedPatientPhotoSequence	getReferencedPatientPhotoSequence() This method provides the pre-initialized object of Referenced Patient Photo Sequence.
ReferencedPatientSequence	getReferencedPatientSequence() This method Returns provides the pre-initialized object of Referenced Patient Sequence return - object of Referenced Patient Sequence.
java.lang.String	getResponsibleOrganization() Retrieves Responsible Organization.
java.lang.String	getResponsiblePerson() Retrieves Responsible Person.
java.lang.String	getResponsiblePersonRole() Retrieves Responsible Person Role.
ISingleCollection<ITag>	getVectorOfKeys() Returns the vector of keys representing the DataElements that belong to this module.
boolean	isPresent(int iGroupNumber, int iElementNumber) Checks the presence of the specified DataElement in the Patient Module.
void	setDeidentificationMethod(java.lang.String strDeidentificationMethod) Sets Deidentification Method.
void	setEthnicGroup(java.lang.String strEthnicGroup) Sets the Ethnic Group in Patient Module.
void	setIssuerOfPatientID(java.lang.String strIssuerOfPatientID) Sets the Issuer Of Patient ID in Patient Module.
void	setOtherPatientIDs(java.lang.String[] arrStrOtherPatientIDs) Sets the Other Patient IDs in Patient Module.
void	setOtherPatientNames(java.lang.String[] arrStrOtherPatientNames) Sets the Other Patient Names in Patient Module.
void	setPatientBirthDate(java.lang.String strPatientBirthDate) Sets the Patient Birth Date in Patient Module.
void	setPatientBirthTime(java.lang.String strPatientBirthTime) Sets the Patient Birth Time in Patient Module.
void	setPatientBreedDescription(java.lang.String strPatientBreedDescription) The breed of the patient.
void	setPatientComments(java.lang.String strPatientComments) Sets the Patient Comments in Patient Module.
void	setPatientID(java.lang.String strPatientID) Sets the strPatient ID in Patient Module.
void	setPatientIdentityRemoved(EnumPatientIdentityRemoved enumPatientIdentityRemoved) Sets Patient Identity Removed.
void	setPatientName(java.lang.String strPatientName) Sets the Patient Name in Patient Module.
void	setPatientSex(java.lang.String strPatientSex) Sets the Patient Sex in Patient Module.
void	setPatientSpeciesDescription(java.lang.String strPatientSpeciesDescription) The species of the patient.
void	setQualityControlSubject(EnumQualityControlSubject enumQualityControlSubject) Sets Quality Control Subject.
void	setResponsibleOrganization(java.lang.String strResponsibleOrganization) Name of organization with medical decision making authority for the patient.
void	setResponsiblePerson(java.lang.String strResponsiblePerson) Name of person with medical decision making authority for the patient.
void	setResponsiblePersonRole(EnumResponsiblePersonRole enumResponsiblePersonRole) Sets Responsible Person Role.
boolean	validateModule() 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, 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

PatientModule

public PatientModule(IDataSet objIDataSet)

Instantiates a new patient 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

setPatientName

public void setPatientName(java.lang.String strPatientName)

Sets the Patient Name in Patient Module.

Parameters:

strPatientName - - Patient's full name.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets the strPatient ID in Patient Module.

Parameters:

strPatientID - - Primary hospital identification number or code for the patient.

setIssuerOfPatientID

public void setIssuerOfPatientID(java.lang.String strIssuerOfPatientID)

Sets the Issuer Of Patient ID in Patient Module.

Parameters:

strIssuerOfPatientID - - String value of Identifier of the Assigning Authority that issued the Patient ID.

setPatientBirthDate

public void setPatientBirthDate(java.lang.String strPatientBirthDate)

Sets the Patient Birth Date in Patient Module.

Parameters:

strPatientBirthDate - : String value of Birth date of the patient.

setPatientSex

public void setPatientSex(java.lang.String strPatientSex)

Sets the Patient Sex in Patient Module.

Parameters:

strPatientSex - : String value of Sex of the patient.

setQualityControlSubject

public void setQualityControlSubject(EnumQualityControlSubject enumQualityControlSubject)

Sets Quality Control Subject.

Parameters:

enumQualityControlSubject - - enum value of Quality Control Subject.

setPatientBirthTime

public void setPatientBirthTime(java.lang.String strPatientBirthTime)

Sets the Patient Birth Time in Patient Module.

Parameters:

strPatientBirthTime - : String value of Birth time of the Patient..

setOtherPatientIDs

public void setOtherPatientIDs(java.lang.String[] arrStrOtherPatientIDs)

Sets the Other Patient IDs in Patient Module.

Parameters:

arrStrOtherPatientIDs - : String value of Other identification numbers or codes used to identify the patient

setOtherPatientNames

public void setOtherPatientNames(java.lang.String[] arrStrOtherPatientNames)

Sets the Other Patient Names in Patient Module.

Parameters:

arrStrOtherPatientNames - : String array of Other names used to identify the patient.

setEthnicGroup

public void setEthnicGroup(java.lang.String strEthnicGroup)

Sets the Ethnic Group in Patient Module.

Parameters:

strEthnicGroup - the str ethnic group

setPatientComments

public void setPatientComments(java.lang.String strPatientComments)

Sets the Patient Comments in Patient Module.

Parameters:

strPatientComments - - String value of User-defined additional information about the patient.

setPatientSpeciesDescription

public void setPatientSpeciesDescription(java.lang.String strPatientSpeciesDescription)

The species of the patient.

Parameters:

strPatientSpeciesDescription - - String value of Patient Species Description.

setPatientBreedDescription

public void setPatientBreedDescription(java.lang.String strPatientBreedDescription)

The breed of the patient.

Parameters:

strPatientBreedDescription - - String value of Patient Breed Description.

setResponsiblePerson

public void setResponsiblePerson(java.lang.String strResponsiblePerson)

Name of person with medical decision making authority for the patient.

Parameters:

strResponsiblePerson - - String value of Responsible Person.

setResponsiblePersonRole

public void setResponsiblePersonRole(EnumResponsiblePersonRole enumResponsiblePersonRole)

Sets Responsible Person Role.

Parameters:

enumResponsiblePersonRole - - enum value of Responsible Person Role.

setResponsibleOrganization

public void setResponsibleOrganization(java.lang.String strResponsibleOrganization)

Name of organization with medical decision making authority for the patient.

Parameters:

strResponsibleOrganization - - String value of Responsible Organization.

setPatientIdentityRemoved

public void setPatientIdentityRemoved(EnumPatientIdentityRemoved enumPatientIdentityRemoved)

Sets Patient Identity Removed. The true identity of the patient has been removed from the Attributes and the Pixel Data Enumerated Values: 1) YES 2) NO

Parameters:

enumPatientIdentityRemoved - the enum Patient Identity Removed

setDeidentificationMethod

public void setDeidentificationMethod(java.lang.String strDeidentificationMethod)

Sets Deidentification Method.

Parameters:

strDeidentificationMethod - String value of Deidentification Method.

getPatientName

public java.lang.String getPatientName()

Return the String value of the attribute Patient Name.

Returns:

String - returns the patient name

getPatientID

public java.lang.String getPatientID()

Return the String value of the attribute Patient ID.

Returns:

String - returns the patient ID

getIssuerofPatientIDMacro

public IssuerofPatientIDMacro getIssuerofPatientIDMacro()

Get the Instance of Issuer of Patient ID Macro.Attributes related to IssuerofPatientID 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 IssuerofPatientID Macro which the user programmer can populate

getIssuerOfPatientID

public java.lang.String getIssuerOfPatientID()

Return the String value of the attribute Issuer Of Patient ID.

Returns:

String - returns the issuer of patient ID

getPatientBirthDate

public java.lang.String getPatientBirthDate()

Return the String value of the attribute Patient Birth Date.

Returns:

String - returns the birth date of the patient

getPatientSex

public java.lang.String getPatientSex()

Return the String value of the attribute Patient Sex.

Returns:

String - returns the patient sex

getQualityControlSubject

public java.lang.String getQualityControlSubject()

Retrieves Quality Control Subject.

Returns:

String - String value of Quality Control Subject.

getReferencedPatientPhotoSequence

public ReferencedPatientPhotoSequence getReferencedPatientPhotoSequence()

This method provides the pre-initialized object of Referenced Patient Photo Sequence.

Returns:

- object of Referenced Patient Photo 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

getReferencedPatientSequence

public ReferencedPatientSequence getReferencedPatientSequence()

This method Returns provides the pre-initialized object of Referenced Patient Sequence return - object of Referenced Patient Sequence. If the module contans the sequence object it retruns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedPatientSequence - returns the Referenced Patient Sequence

getPatientBirthTime

public java.lang.String getPatientBirthTime()

Return the String value of the attribute Patient Birth Time.

Returns:

String - returns the Birth time of the patient

getOtherPatientIDs

public java.lang.String[] getOtherPatientIDs()

Return the Array of String values of the attribute Other Patient IDs.

Returns:

String[] - returns the collection of other patient IDs

getOtherPatientIDsSequence

public OtherPatientIDsSequence getOtherPatientIDsSequence()

This method provides the pre-initialized object of Other Patient IDs Sequence.

Returns:

- object of Other Patient IDs 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

getOtherPatientNames

public java.lang.String[] getOtherPatientNames()

Return the Array of String values of the attribute Other Patient Names.

Returns:

String[] - returns the collection of other patient names

getEthnicGroup

public java.lang.String getEthnicGroup()

Return the String value of the attribute Ethnic Group.

Returns:

String - returns the ethnic group of the patient

getPatientComments

public java.lang.String getPatientComments()

Return the String value of the attribute Patient Comments.

Returns:

String - returns the patient comments

getPatientSpeciesDescription

public java.lang.String getPatientSpeciesDescription()

Retrieves Patient Species Description.

Returns:

String - String value of Patient Species Description

getPatientSpeciesCodeSequence

public PatientSpeciesCodeSequence getPatientSpeciesCodeSequence()

This method provides the pre-initialized object of Patient Species Code Sequence.

Returns:

- object of Patient Species Code 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

getPatientBreedDescription

public java.lang.String getPatientBreedDescription()

Retrieves Patient Breed Description.

Returns:

String - String value of Patient Breed Description

getPatientBreedCodeSequence

public PatientBreedCodeSequence getPatientBreedCodeSequence()

This method provides the pre-initialized object of Patient Breed Code Sequence.

Returns:

- object of Patient Breed Code 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

getBreedRegistrationSequence

public BreedRegistrationSequence getBreedRegistrationSequence()

This method provides the pre-initialized object of Breed Registration Sequence.

Returns:

- object of Breed Registration 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

getResponsiblePerson

public java.lang.String getResponsiblePerson()

Retrieves Responsible Person.

Returns:

String - String value of Responsible Person

getResponsiblePersonRole

public java.lang.String getResponsiblePersonRole()

Retrieves Responsible Person Role.

Returns:

String - String value of Responsible Person Role

getResponsibleOrganization

public java.lang.String getResponsibleOrganization()

Retrieves Responsible Organization.

Returns:

String - String value of Responsible Organization

getPatientIdentityRemoved

public java.lang.String getPatientIdentityRemoved()

Retrieves Patient Identity Removed.

Returns:

String - String value of Patient Identity Removed.

getDeidentificationMethod

public java.lang.String getDeidentificationMethod()

Retrieves Deidentification Method.

Returns:

String - String value of Deidentification Method.

getDeidentificationMethodCodeSequence

public DeidentificationMethodCodeSequence getDeidentificationMethodCodeSequence()

This method provides the pre-initialized object of Deidentification Method Code Sequence.

Returns:

- object of Deidentification Method Code 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

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

Returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - returns the customized collection containing data element tags of this modules

isPresent

public boolean isPresent(int iGroupNumber,
                int iElementNumber)

Checks the presence of the specified DataElement in the Patient Module.

Overrides:

isPresent in class Module

Parameters:

iGroupNumber - - Group Number of the Tag

iElementNumber - - Element Number of the Tag

Returns:

- status indicating success/failure of the function