Package org.dcm4che.typeddicom.dataelements

Class BarcodeValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BarcodeValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongTextWrapper, StringDataElementWrapper

public class BarcodeValue
extends AbstractDataElementWrapper
implements LongTextWrapper

Name: Barcode Value
Keyword: BarcodeValue
Tag: (2200,0005)
Value Representation: LT
Value Multiplicity: 1

• Described in the contexts:
  • SOP Common Module > Barcode Value
  as follows:
  Attribute Name: Barcode Value
  Type: 3
  Attribute Description:

  Barcode interpreted from a scanned label.

  Note

  1. In the case of a scanned patient label, this may be the same as Patient ID (0010,0020), but it is included in an Instance level Module rather than a Patient level Module since barcodes may also be used to identify lower level entities. This might be obtained by scanning the patient's wrist band, request form, or extracting a burned-in label from the image pixel data, for example.

  2. In the case of a scanned slide label, this may be the same as Container Identifier (0040,0512) in the Specimen Module.

  
  
• Described in the contexts:
  • Slide Label Module > Barcode Value
  as follows:
  Attribute Name: Barcode Value
  Type: 2
  Attribute Description:

  Barcode interpreted from the scanned slide label.

  Note

  This may be the same as Container Identifier (0040,0512).

  
  
• Described in the contexts:
  • Media Creation Management Module > Barcode Value
  as follows:
  Attribute Name: Barcode Value
  Type:
  Attribute Description:

  String that describes the bar code value to be printed on the media label.

  Note It is SCU responsibility to convey a value for this Attribute coherent in length and content with the requested Barcode Symbology (2200,0006).

  
  
• Described in the contexts:
  • Scheduled Procedure Step Module > Barcode Value
  as follows:
  Attribute Name: Barcode Value
  Type:
  Attribute Description:

  Barcode interpreted from a scanned label.

  Note

  1. In the case of a scanned patient label, this may be the same as Patient ID (0010,0020), but it is included in the Scheduled Procedure Step Module rather than the Patient Identification Module since barcodes may also be used to identify lower level entities and/or different forms of patient identifier may be in use.

  2. In the case of a scanned slide label, this may be the same as Container Identifier (0040,0512).

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BarcodeValue()	Creates a new Barcode Value object which wraps a new and empty Attributes object.
BarcodeValue(org.dcm4che3.data.Attributes attributes)	Creates a new Barcode Value object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BarcodeValue	copy()	Returns a new Barcode Value which wraps a copy of the Attributes wrapped in this Barcode Value.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

BarcodeValue

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

Creates a new Barcode Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BarcodeValue

public BarcodeValue()

Creates a new Barcode Value object which wraps a new and empty Attributes object.

Method Details

copy

public BarcodeValue copy()

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

Returns:

a new Barcode Value which wraps a copy of the Attributes wrapped in this Barcode Value.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.