Package org.dcm4che.typeddicom.dataelements

Class BarcodeValue

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, LongTextWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
    public class BarcodeValue
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements LongTextWrapper
    Name: Barcode Value
    Keyword: BarcodeValue
    Tag: (2200,0005)
    Value Representation: LongText
    Value Multiplicity: 1
    • Described in the contexts: 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: 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 DICOM Standard Part 3 - Section C.4.10 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).


    • Described in the contexts: 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: 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 DICOM Standard Part 3 - Section C.7.6.22.


    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BarcodeValue copy()
      Returns a new Barcode Value which wraps a copy of the Attributes wrapped in this Barcode Value.
      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, getKnownAttributeTags, getUnknownAttributeTags, 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

    • Constructor Detail

      • 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 Detail

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

      • 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