Package org.dcm4che.typeddicom.dataelements

Class InstanceOriginStatus

java.lang.Object
org.dcm4che.typeddicom.AbstractAttributesWrapper
org.dcm4che.typeddicom.AbstractDataElementWrapper
org.dcm4che.typeddicom.dataelements.InstanceOriginStatus
All Implemented Interfaces:
AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper
public class InstanceOriginStatus extends AbstractDataElementWrapper implements CodeStringWrapper
Name: Instance Origin Status
Keyword: InstanceOriginStatus
Tag: (0400,0600)
Value Representation: CS
Value Multiplicity: 1
  • Described in the contexts: as follows:
    Attribute Name: Instance Origin Status
    Type: 3
    Attribute Description:

    Categorizes the locality of the entity from whence the Instance originated.

    Enumerated Values:

    LOCAL

    Acquired or created in the local entity.

    IMPORTED

    Imported from an external entity.

    Note

    1. The interpretation of the meaning of local and imported are user-specific. The purpose of this Attribute is to provide a means of communicating a user-specific decision, not to attempt to achieve uniformity with respect to any particular organizational or geographical boundary around any particular organizational or geographical entity, be it an entity that is a device, system, facility, office, department, site, enterprise, region, nation, etc.

    2. A typical pattern would be for an archive to set a value of LOCAL when receiving Instances on the network from a modality within the hospital but to set a value of IMPORTED when receiving Instances from an interchange media reader or an external network Instance sharing gateway. Displaying the value of this Attribute in a viewer then makes it apparent to a user whether or not an Instance is "one of their own". How a receiver determines whether or not the sender is local is not specified, but could, for example, be determined from the sender's AE Title.

    3. When Instances are transported from one entity to another and then imported, it is expected that this Attribute be set to an appropriate value for the new context, overwriting any previous value. E.g., a value of LOCAL used within an archive at the site where the Instances were acquired would be coerced to a value of IMPORTED when those Instances were received by another site to which the patient had been transferred. Whether or not previous values of this Attribute are copied into Original Attributes Sequence (0400,0561) after coercion is not specified.

    4. It is not expected (but nor is it prohibited) that this Attribute will be removed by an exporting entity, since it may be useful to a recipient to know whether or not the Instance was local to the previous entity or not. Similarly, a modality may populate this Attribute with a value of LOCAL after creating the images, but is not required to.

    5. The round-trip case, e.g., when an image is acquired locally, exported, locally deleted and then re-imported may be challenging unless a local record is maintained. I.e., after acquisition, in the local archive it would be expected to be LOCAL. After re-importation without any local state, it may be hard to determine that it once was LOCAL. Other Attributes such as Institution Name may not be sufficient to reliably detect this.

    6. A new SOP Instance UID (0008,0018) is not required when adding or coercing this Attribute, since a derived Instance is not being created. See DICOM Standard Part 3 - Section C.12.4.1.1 and B.4.1.3.

    7. A more detailed history of the handling of an Instance may be recorded in Contributing Equipment Sequence (0018,A001).

    8. This Attribute may need to be removed during de-identification. See chapterE.


  • Field Details

  • Constructor Details

    • InstanceOriginStatus

      public InstanceOriginStatus(org.dcm4che3.data.Attributes attributes)
      Creates a new Instance Origin Status object which wraps the provided attributes.
      Parameters:
      attributes - The Attributes object to be wrapped.

    • InstanceOriginStatus

      public InstanceOriginStatus()
      Creates a new Instance Origin Status object which wraps a new and empty Attributes object.

  • Method Details

    • copy

      public InstanceOriginStatus copy()
      Returns a new Instance Origin Status which wraps a copy of the Attributes wrapped in this Instance Origin Status. (see Attributes(Attributes)
      Returns:
      a new Instance Origin Status which wraps a copy of the Attributes wrapped in this Instance Origin Status.

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