Package org.dcm4che.typeddicom.dataelements

Class PatientName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, PersonNameWrapper, StringDataElementWrapper

public class PatientName
extends AbstractDataElementWrapper
implements PersonNameWrapper

Name: Patient's Name
Keyword: PatientName
Tag: (0010,0010)
Value Representation: PN
Value Multiplicity: 1

• Described in the contexts:
  • Patient Module > Patient's Name
  as follows:
  Attribute Name: Patient's Name
  Type: 2
  Attribute Description:

  Patient's full name.

  
  
• Described in the contexts:
  • Substance Administration Log Module > Patient's Name
  • Patient Identification Module > Patient's Name
  as follows:
  Attribute Name: Patient's Name
  Type:
  Attribute Description:

  Patient's full name

  
  
• Described in the contexts:
  • Unified Procedure Step Relationship Module > Patient's Name
  • Performed Procedure Step Relationship Module > Patient's Name
  as follows:
  Attribute Name: Patient's Name
  Type:
  Attribute Description:

  Patient's full legal name.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PatientName.Builder<SELF extends PatientName.Builder<SELF,T>,T extends PatientName.Holder>
static interface	PatientName.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Patient's Name" (see PatientName)
static class	PatientName.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.PersonNameWrapper

PersonNameWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends PersonNameWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.PersonNameWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PatientName()	Creates a new Patient's Name object which wraps a new and empty Attributes object.
PatientName(org.dcm4che3.data.Attributes attributes)	Creates a new Patient's Name object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PatientName	copy()	Returns a new Patient's Name which wraps a copy of the Attributes wrapped in this Patient's Name.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.PersonNameWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

PatientName

public PatientName(org.dcm4che3.data.Attributes attributes)

Creates a new Patient's Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientName

public PatientName()

Creates a new Patient's Name object which wraps a new and empty Attributes object.

Method Details

copy

public PatientName copy()

Returns a new Patient's Name which wraps a copy of the Attributes wrapped in this Patient's Name. (see Attributes(Attributes)

Returns:

a new Patient's Name which wraps a copy of the Attributes wrapped in this Patient's Name.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.