cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PatientIdentificationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PatientIdentificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PatientIdentificationModule
extends Module

\* This module defines the Attributes relevant to identifying a patient.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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	getMedicalRecordLocator() Retrieves An identifier used to find the patient's existing medical record (e.g.
java.lang.String[]	getOtherPatientIDs() Retrieves Other identification numbers or codes used to identify the patient.
OtherPatientIDsSequence	getOtherPatientIDsSequence() This method provides the pre-initialized object of Other Patient IDs Sequence.
java.lang.String[]	getOtherPatientNames() Retrieves Other names used to identify the patient..
java.lang.String	getPatientBirthName() Retrieves Patient's birth name.
java.lang.String	getPatientID() Retrieves Primary hospital identification number or code for the patient.
java.lang.String	getPatientName() Retrieves Patient's full name.
java.lang.String	getPatientsMothersBirthName() Retrieves Birth name of patient's mother.
ReferencedPatientPhotoSequence	getReferencedPatientPhotoSequence() This method provides the pre-initialized object of Referenced Patient Photo Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setMedicalRecordLocator(java.lang.String strMedicalRecordLocator) An identifier used to find the patient's existing medical record (e.g.
void	setOtherPatientIDs(java.lang.String[] arrStrOtherPatientIDs) Other identification numbers or codes used to identify the patient.
void	setOtherPatientNames(java.lang.String[] arrStrOtherPatientNames) Other names used to identify the patient.
void	setPatientBirthName(java.lang.String strPatientBirthName) Patient's birth name.
void	setPatientID(java.lang.String strPatientID) Sets Primary hospital identification number or code for the patient.
void	setPatientName(java.lang.String strPatientName) Sets Patient's full name.
void	setPatientsMothersBirthName(java.lang.String strPatientsMothersBirthName) Birth name of patient's mother.
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

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

PatientIdentificationModule

public PatientIdentificationModule(IDataSet objIDataSet)

Instantiates a new patient identification module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

setPatientName

public void setPatientName(java.lang.String strPatientName)

Sets Patient's full name.

Parameters:

strPatientName - - String value of Patient 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.

setOtherPatientIDs

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

Other identification numbers or codes used to identify the patient.

Parameters:

arrStrOtherPatientIDs - - String array of Other Patient IDs.

setOtherPatientNames

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

Other names used to identify the patient.

Parameters:

arrStrOtherPatientNames - - String value of Patient Other Names.

setPatientBirthName

public void setPatientBirthName(java.lang.String strPatientBirthName)

Patient's birth name.

Parameters:

strPatientBirthName - - String value of Patient Birth Name.

setPatientsMothersBirthName

public void setPatientsMothersBirthName(java.lang.String strPatientsMothersBirthName)

Birth name of patient's mother.

Parameters:

strPatientsMothersBirthName - - String value of Patient's Mother's Birth Name.

setMedicalRecordLocator

public void setMedicalRecordLocator(java.lang.String strMedicalRecordLocator)

An identifier used to find the patient's existing medical record (e.g. film jacket).

Parameters:

strMedicalRecordLocator - - String value of Medical Record Locator.

getPatientName

public java.lang.String getPatientName()

Retrieves Patient's full name.

Returns:

String - String value of Patient Name.

getPatientID

public java.lang.String getPatientID()

Retrieves Primary hospital identification number or code for the patient.

Returns:

String - String value of 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

getOtherPatientIDs

public java.lang.String[] getOtherPatientIDs()

Retrieves Other identification numbers or codes used to identify the patient.

Returns:

String[] - String array of Other identification numbers or codes used to identify the patient.

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()

Retrieves Other names used to identify the patient..

Returns:

String[] - String array of Other names used to identify the patient.

getPatientBirthName

public java.lang.String getPatientBirthName()

Retrieves Patient's birth name.

Returns:

String - String value of Patient's birth name.

getPatientsMothersBirthName

public java.lang.String getPatientsMothersBirthName()

Retrieves Birth name of patient's mother.

Returns:

String - String value of Birth name of patient's mother.

getMedicalRecordLocator

public java.lang.String getMedicalRecordLocator()

Retrieves An identifier used to find the patient's existing medical record (e.g. film jacket).

Returns:

String - String value of Medical Record Locator.

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

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - returns the collection containing the collection of tags