Package org.dcm4che.typeddicom.dataelements

Class InstitutionName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.InstitutionName

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, LongStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class InstitutionName
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements LongStringWrapper

Name: Institution Name
Keyword: InstitutionName
Tag: (0008,0080)
Value Representation: LongString
Value Multiplicity: 1

• Described in the contexts:
  • Display System Module > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type:
  Attribute Description:

  Institution where the Display System is located.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Institution Name
  • RT Ion Beams Module > Ion Beam Sequence > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 3
  Attribute Description:

  Institution where the equipment is located that is to be used for beam delivery.

  
  
• Described in the contexts:
  • Visit Identification Module > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type:
  Attribute Description:

  Institution where the equipment is located.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Treatment Machine Sequence > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 3
  Attribute Description:

  Institution where the equipment is located that is to be used for treatment delivery.

  
  
• Described in the contexts:
  • RT Treatment Machine Record Module > Treatment Machine Sequence > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 2
  Attribute Description:

  Institution where the equipment is located that was used for treatment delivery.

  
  
• Described in the contexts:
  • Identified Person or Device Macro > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 2
  Attribute Description:

  Institution or organization to which the identified person is responsible or accountable, or that manages the identified device.

  
  
• Described in the contexts:
  • Treatment Device Identification Macro > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 3
  Attribute Description:

  Institution where the equipment is located.

  
  
• Described in the contexts:
  • General Equipment Module > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 3
  Attribute Description:

  Institution where the equipment that produced the Composite Instances is located.

  
  
• Described in the contexts:
  • Person Identification Macro > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 1C
  Attribute Description:

  Institution or organization to which the identified individual is responsible or accountable.

  Required if Institution Code Sequence (0008,0082) is not present. May be present otherwise.

  
  
• Described in the contexts:
  • SOP Common Module > Contributing Equipment Sequence > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 3
  Attribute Description:

  Institution where the equipment that contributed to the Composite Instance is located.

  
  
• Described in the contexts:
  • SR Document General Module > Custodial Organization Sequence > Institution Name
  • Protocol Context Module > Custodial Organization Sequence > Institution Name
  as follows:
  Attribute Name: Institution Name
  Type: 2
  Attribute Description:

  Name of Custodial Institution or Organization.

  
  

Nested Class Summary

Nested Classes

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

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

LongStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends LongStringWrapper>

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
InstitutionName()	Creates a new Institution Name object which wraps a new and empty Attributes object.
InstitutionName(org.dcm4che3.data.Attributes attributes)	Creates a new Institution Name object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
InstitutionName	copy()	Returns a new Institution Name which wraps a copy of the Attributes wrapped in this Institution Name.
java.lang.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.LongStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

InstitutionName

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

Creates a new Institution Name object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

InstitutionName

public InstitutionName()

Creates a new Institution Name object which wraps a new and empty Attributes object.

Method Detail

copy

public InstitutionName copy()

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

Returns:

a new Institution Name which wraps a copy of the Attributes wrapped in this Institution Name.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper