org.dicom4j.modules.patient
Class PatientIdentification

java.lang.Object
  org.dicom4j.data.DataSet
      org.dicom4j.modules.AbstractModule
          org.dicom4j.modules.patient.PatientIdentification

public class PatientIdentification
extends AbstractModule

Patient Identification Module

(generated class, do not edit)

Author:

Laurent Lecomte

Constructor Summary

PatientIdentification()
Creates a new module

PatientIdentification(DataSet aDataSet)
Creates a wrapper for data contains in the DataSet Modify data with an instance of this class will modify also data of the DataSet, IT'S NOT A COPY

Method Summary

void	addElements() add all Module Elements if not present in the DataSet
LongString	getIssuerOfPatientID() Retrun the Issuer of Patient ID
LongString	getIssuerOfPatientIDOrNull() Retrun the Issuer of Patient ID or null if doesn't exits
LongString	getMedicalRecordLocator() Retrun the Medical Record Locator
LongString	getMedicalRecordLocatorOrNull() Retrun the Medical Record Locator or null if doesn't exits
String	getName() Return the name of the module
LongString	getOtherPatientIDs() Retrun the Other Patient IDs
LongString	getOtherPatientIDsOrNull() Retrun the Other Patient IDs or null if doesn't exits
PersonName	getOtherPatientNames() Retrun the Other Patient Names
PersonName	getOtherPatientNamesOrNull() Retrun the Other Patient Names or null if doesn't exits
PersonName	getPatientBirthName() Retrun the Patient's Birth Name
PersonName	getPatientBirthNameOrNull() Retrun the Patient's Birth Name or null if doesn't exits
LongString	getPatientID() Retrun the Patient ID
LongString	getPatientIDOrNull() Retrun the Patient ID or null if doesn't exits
PersonName	getPatientMotherBirthName() Retrun the Patient's Mother's Birth Name
PersonName	getPatientMotherBirthNameOrNull() Retrun the Patient's Mother's Birth Name or null if doesn't exits
PersonName	getPatientName() Retrun the Patient's Name
PersonName	getPatientNameOrNull() Retrun the Patient's Name or null if doesn't exits
boolean	hasIssuerOfPatientID() return true if the module has the Issuer of Patient ID element
boolean	hasMedicalRecordLocator() return true if the module has the Medical Record Locator element
boolean	hasOtherPatientIDs() return true if the module has the Other Patient IDs element
boolean	hasOtherPatientNames() return true if the module has the Other Patient Names element
boolean	hasPatientBirthName() return true if the module has the Patient's Birth Name element
boolean	hasPatientID() return true if the module has the Patient ID element
boolean	hasPatientMotherBirthName() return true if the module has the Patient's Mother's Birth Name element
boolean	hasPatientName() return true if the module has the Patient's Name element

Methods inherited from class org.dicom4j.modules.AbstractModule

addModuleElements

Methods inherited from class org.dicom4j.data.DataSet

addApplicationEntity, addCodeString, addDataSet, addElement, addIntegerString, addModule, addPersonName, addPersonName, addShortString, addUniqueIdentifier, clear, count, getApplicationEntity, getApplicationEntityOrNull, getAttribute, getCodeString, getDataElementsOfSameGroup, getDate, getDoubleValues, getElement, getElementOrNull, getIntegerString, getIterator, getLongString, getLongStringOrNull, getLongText, getLongTextOrNull, getOtherByteString, getOtherByteStringOrNull, getPersonName, getPersonNameOrNull, getSequenceOfItems, getSequenceOfItemsOrNull, getShortString, getTime, getUniqueIdentifier, getUniqueIdentifierOrNull, getUnsignedLong, getUnsignedLongOrNull, getUnsignedShort, hasElement, read, read, removeAll, removeElement, removeElement, toArray, toBytes, toString, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PatientIdentification

public PatientIdentification()

Creates a new module

PatientIdentification

public PatientIdentification(DataSet aDataSet)

Creates a wrapper for data contains in the DataSet Modify data with an instance of this class will modify also data of the DataSet, IT'S NOT A COPY

Parameters:

aDataSet -

Method Detail

addElements

public void addElements()
                 throws Exception

add all Module Elements if not present in the DataSet

Throws:

Exception

getIssuerOfPatientID

public LongString getIssuerOfPatientID()
                                throws NoSuchElementException,
                                       WrongDataElementTypeException

Retrun the Issuer of Patient ID

Returns:

the Issuer of Patient ID

Throws:

NoSuchElementException

WrongDataElementTypeException

getIssuerOfPatientIDOrNull

public LongString getIssuerOfPatientIDOrNull()

Retrun the Issuer of Patient ID or null if doesn't exits

Returns:

the Issuer of Patient ID or null

getMedicalRecordLocator

public LongString getMedicalRecordLocator()
                                   throws NoSuchElementException,
                                          WrongDataElementTypeException

Retrun the Medical Record Locator

Returns:

the Medical Record Locator

Throws:

NoSuchElementException

WrongDataElementTypeException

getMedicalRecordLocatorOrNull

public LongString getMedicalRecordLocatorOrNull()

Retrun the Medical Record Locator or null if doesn't exits

Returns:

the Medical Record Locator or null

getName

public String getName()

Description copied from class: AbstractModule

Return the name of the module

Specified by:

getName in class AbstractModule

Returns:

the name

getOtherPatientIDs

public LongString getOtherPatientIDs()
                              throws NoSuchElementException,
                                     WrongDataElementTypeException

Retrun the Other Patient IDs

Returns:

the Other Patient IDs

Throws:

NoSuchElementException

WrongDataElementTypeException

getOtherPatientIDsOrNull

public LongString getOtherPatientIDsOrNull()

Retrun the Other Patient IDs or null if doesn't exits

Returns:

the Other Patient IDs or null

getOtherPatientNames

public PersonName getOtherPatientNames()
                                throws NoSuchElementException,
                                       WrongDataElementTypeException

Retrun the Other Patient Names

Returns:

the Other Patient Names

Throws:

NoSuchElementException

WrongDataElementTypeException

getOtherPatientNamesOrNull

public PersonName getOtherPatientNamesOrNull()

Retrun the Other Patient Names or null if doesn't exits

Returns:

the Other Patient Names or null

getPatientBirthName

public PersonName getPatientBirthName()
                               throws NoSuchElementException,
                                      WrongDataElementTypeException

Retrun the Patient's Birth Name

Returns:

the Patient's Birth Name

Throws:

NoSuchElementException

WrongDataElementTypeException

getPatientBirthNameOrNull

public PersonName getPatientBirthNameOrNull()

Retrun the Patient's Birth Name or null if doesn't exits

Returns:

the Patient's Birth Name or null

getPatientID

public LongString getPatientID()
                        throws NoSuchElementException,
                               WrongDataElementTypeException

Retrun the Patient ID

Returns:

the Patient ID

Throws:

NoSuchElementException

WrongDataElementTypeException

getPatientIDOrNull

public LongString getPatientIDOrNull()

Retrun the Patient ID or null if doesn't exits

Returns:

the Patient ID or null

getPatientMotherBirthName

public PersonName getPatientMotherBirthName()
                                     throws NoSuchElementException,
                                            WrongDataElementTypeException

Retrun the Patient's Mother's Birth Name

Returns:

the Patient's Mother's Birth Name

Throws:

NoSuchElementException

WrongDataElementTypeException

getPatientMotherBirthNameOrNull

public PersonName getPatientMotherBirthNameOrNull()

Retrun the Patient's Mother's Birth Name or null if doesn't exits

Returns:

the Patient's Mother's Birth Name or null

getPatientName

public PersonName getPatientName()
                          throws NoSuchElementException,
                                 WrongDataElementTypeException

Retrun the Patient's Name

Returns:

the Patient's Name

Throws:

NoSuchElementException

WrongDataElementTypeException

getPatientNameOrNull

public PersonName getPatientNameOrNull()

Retrun the Patient's Name or null if doesn't exits

Returns:

the Patient's Name or null

hasIssuerOfPatientID

public boolean hasIssuerOfPatientID()

return true if the module has the Issuer of Patient ID element

Returns:

true if present

hasMedicalRecordLocator

public boolean hasMedicalRecordLocator()

return true if the module has the Medical Record Locator element

Returns:

true if present

hasOtherPatientIDs

public boolean hasOtherPatientIDs()

return true if the module has the Other Patient IDs element

Returns:

true if present

hasOtherPatientNames

public boolean hasOtherPatientNames()

return true if the module has the Other Patient Names element

Returns:

true if present

hasPatientBirthName

public boolean hasPatientBirthName()

return true if the module has the Patient's Birth Name element

Returns:

true if present

hasPatientID

public boolean hasPatientID()

return true if the module has the Patient ID element

Returns:

true if present

hasPatientMotherBirthName

public boolean hasPatientMotherBirthName()

return true if the module has the Patient's Mother's Birth Name element

Returns:

true if present

hasPatientName

public boolean hasPatientName()

return true if the module has the Patient's Name element

Returns:

true if present