cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PatientStudyModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PatientStudyModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PatientStudyModule
extends Module

\* The class PatientStudyModule. \* This module specifies Attributes that provide information about the Patient at the time the Study was performed.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAdditionalPatientHistory() Retrieves the String value of the attribute Patient AdditionalPatientHistory.
java.lang.String	getAdmissionID() Retrieves Admission ID.
AdmittingDiagnosesCodeSequence	getAdmittingDiagnosesCodeSequence() This method Returns provides the pre-initialized object of Admitting Diagnoses Code Sequence return - object of Admitting Diagnoses Code Sequence.
java.lang.String[]	getAdmittingDiagnosesDescription() Retrieves the Array of String values of Description of the admitting diagnosis(diagnoses).
IssuerOfAdmissionIDSequence	getIssuerOfAdmissionIDSequence() This method provides the pre-initialized object of Issuer Of Admission ID Sequence.
IssuerofServiceEpisodeIDSequence	getIssuerofServiceEpisodeIDSequence() This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.
java.lang.String	getOccupation() Retrieves the String value of the attribute Patient Occupation.
java.lang.String	getPatientAge() Retrieves the String value of the attribute Patient Age.
java.lang.String	getPatientSize() Retrieves the String value of the attribute Patient Size.
java.lang.String	getPatientsSexNeutered() Retrieves Patients Sex Neutered.
PatientsSizeCodeSequence	getPatientsSizeCodeSequence() This method provides the pre-initialized object of Patients Size Code Sequence.
java.lang.String	getPatientWeight() Retrieves the String value of the attribute Patient Weight.
java.lang.String	getServiceEpisodeDescription() Retrieves Service Episode Description.
java.lang.String	getServiceEpisodeID() Retrieves Service Episode ID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setAdditionalPatientHistory(java.lang.String strAdditionalPatientHistory) Sets the Additional Patient History in Patient Study Module.
void	setAdmissionID(java.lang.String strAdmissionID) Sets Admission ID.
void	setAdmittingDiagnosesDescription(java.lang.String[] arrStrAdmittingDiagnosesDescription) Sets the Description of the admitting diagnosis (diagnoses)in Patient Study Module.
void	setOccupation(java.lang.String strOccupation) Sets the Patient's Occupation in Patient Study Module.
void	setPatientAge(java.lang.String strPatientAge) Sets the Age of the Patient in Patient Study Module.
void	setPatientSize(java.lang.String strPatientSize) Sets the Patient Size in Patient Study Module.
void	setPatientsSexNeutered(EnumPatientsSexNeutered enumPatientsSexNeutered) Sets Patients Sex Neutered.
void	setPatientWeight(java.lang.String strPatientWeight) Sets the Patient Weight in Patient Study Module.
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

PatientStudyModule

public PatientStudyModule(IDataSet objIDataSet)

Instantiates a new patient study module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setAdmittingDiagnosesDescription

public void setAdmittingDiagnosesDescription(java.lang.String[] arrStrAdmittingDiagnosesDescription)

Sets the Description of the admitting diagnosis (diagnoses)in Patient Study Module. The function accepts a String Array as and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module Data Set

Parameters:

arrStrAdmittingDiagnosesDescription - : Description of the admitting diagnosis (diagnoses)

setPatientAge

public void setPatientAge(java.lang.String strPatientAge)

Sets the Age of the Patient in Patient Study Module. The function accepts a String as Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module Data Set

Parameters:

strPatientAge - : Age of the Patient

setPatientSize

public void setPatientSize(java.lang.String strPatientSize)

Sets the Patient Size in Patient Study Module. The function accepts a String as Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module Data Set

Parameters:

strPatientSize - : Length or size of the Patient, in meters.

setPatientWeight

public void setPatientWeight(java.lang.String strPatientWeight)

Sets the Patient Weight in Patient Study Module. The function accepts a String as Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module Data Set

Parameters:

strPatientWeight - : Weight of the Patient, in kilograms.

setOccupation

public void setOccupation(java.lang.String strOccupation)

Sets the Patient's Occupation in Patient Study Module. The function accepts a String as Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module Data Set

Parameters:

strOccupation - : Occupation of the Patient.

setAdditionalPatientHistory

public void setAdditionalPatientHistory(java.lang.String strAdditionalPatientHistory)

Sets the Additional Patient History in Patient Study Module.

Parameters:

strAdditionalPatientHistory - : Additional information about the Patient's medical history.

setAdmissionID

public void setAdmissionID(java.lang.String strAdmissionID)

Sets Admission ID. Identifier of the visit as assigned by the health care provider

Parameters:

strAdmissionID - String value of Admission ID.

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

setServiceEpisodeDescription

public void setServiceEpisodeDescription(java.lang.String strServiceEpisodeDescription)

Sets Description of the type of service episode.

Parameters:

strServiceEpisodeDescription - String value of Service Episode Description

setPatientsSexNeutered

public void setPatientsSexNeutered(EnumPatientsSexNeutered enumPatientsSexNeutered)

Sets Patients Sex Neutered.

Parameters:

enumPatientsSexNeutered - - enum value of Patients Sex Neutered.

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

Throws:

InvalidModuleException - - If validation of Module fails

getAdmittingDiagnosesCodeSequence

public AdmittingDiagnosesCodeSequence getAdmittingDiagnosesCodeSequence()

This method Returns provides the pre-initialized object of Admitting Diagnoses Code Sequence return - object of Admitting Diagnoses 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

Returns:

- object of Admitting Diagnoses Code Sequence.

getAdmittingDiagnosesDescription

public java.lang.String[] getAdmittingDiagnosesDescription()

Retrieves the Array of String values of Description of the admitting diagnosis(diagnoses).

Returns:

String[] - String array of Admitting Diagnoses Description

getPatientAge

public java.lang.String getPatientAge()

Retrieves the String value of the attribute Patient Age.

Returns:

String - String value of Patient Age.

getPatientSize

public java.lang.String getPatientSize()

Retrieves the String value of the attribute Patient Size.

Returns:

String - String value of Patient Size.

getPatientWeight

public java.lang.String getPatientWeight()

Retrieves the String value of the attribute Patient Weight.

Returns:

String - String value of Patient Weight.

getOccupation

public java.lang.String getOccupation()

Retrieves the String value of the attribute Patient Occupation.

Returns:

String - String value of Patient Occupation.

getAdditionalPatientHistory

public java.lang.String getAdditionalPatientHistory()

Retrieves the String value of the attribute Patient AdditionalPatientHistory.

Returns:

String - String value of Additional Patient History.

getPatientsSizeCodeSequence

public PatientsSizeCodeSequence getPatientsSizeCodeSequence()

This method provides the pre-initialized object of Patients Size Code Sequence.

Returns:

- object of Patients Size 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

getAdmissionID

public java.lang.String getAdmissionID()

Retrieves Admission ID. Identifier of the visit as assigned by the health care provider

Returns:

String - String value of Admission ID.

getIssuerOfAdmissionIDSequence

public IssuerOfAdmissionIDSequence getIssuerOfAdmissionIDSequence()

This method provides the pre-initialized object of Issuer Of Admission ID Sequence.

Returns:

- object of Issuer Of Admission 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

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

getServiceEpisodeDescription

public java.lang.String getServiceEpisodeDescription()

Retrieves Service Episode Description.

Returns:

String - String value of Service Episode Description

getPatientsSexNeutered

public java.lang.String getPatientsSexNeutered()

Retrieves Patients Sex Neutered.

Returns:

String - String value of Patients Sex Neutered.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module