Actions on tags

Actions on specific tags

This profile element applies an action on a tag or a group of tags defined by the user. Its codename is action.on.specific.tags.

This profile element requires the following parameters:

name: description of the action applied
codename: action.on.specific.tags
action: Remove (X) / Keep (K)
tags: list of tags the action should be applied to

This profile element can have these optional parameters:

condition: optional, defines a condition to evaluate if this profile element should be applied to this DICOM instance
excludedTags: list of tags that will be ignored by this action

In this example, all the tags starting with 0028 will be removed excepted (0028,1199) which will be kept.

- name: "Remove tags"
  codename: "action.on.specific.tags"
  action: "X"
  tags:
    - "(0028,xxxx)"
  excludedTags:
    - "(0028,1199)"

- name: "Keep tags 0028,1199"
  codename: "action.on.specific.tags"
  action: "K"
  tags:
    - "0028,1199"

Actions on private tags

This profile element applies an action on a private tag or a group of private tags defined by the user. This action won’t be applied in case the tag is not private.

Its codename is action.on.privatetags.

This profile element requires the following parameters:

name: description of the action applied
codename: action.on.privatetags
action: Remove (X) / Keep (K)

This profile can have these optional parameters:

condition: optional, defines a condition to evaluate if this profile element should be applied to this DICOM instance
tags: list of tags the action should be applied to. If not specified, the action is applied to all private tags
excludedTags: list of tags that will be ignored by this action

In this example, all tags starting with 0009 will be kept and all the other private tags will be removed.

- name: "Keep private tags starting with 0009"
  codename: "action.on.privatetags"
  action: "K"
  tags:
    - "(0009,xxxx)"

- name: "Remove all private tags"
  codename: "action.on.privatetags"
  action: "X"

Add new tags

This profile element adds a tag if it is not already present in the instance. This action will be ignored if the tag is already present in the instance.

Its codename is action.add.tag.

This profile element requires the following parameters:

name: description of the action applied
codename: action.add.tag
arguments:
- value: required value to set the tag’s value to
tags: must contain exactly one tag, the one to add

This profile can have these optional parameters:

condition: optional, defines a condition to evaluate if this profile element should be applied to this DICOM instance

Regarding the application of profile elements, if the tag is not initially present in the instance, then it will be added by this action. Further actions that match this tag won’t be applied. If the tag was already present in the instance, then the add action is ignored and a further action can be applied to that tag. It is only possible to add tags at the root level of the DICOM instance. Adding elements in a sequence is not supported.

The attribute must exist in the DICOM Standard, otherwise the profile validation will fail and cannot be added. The VR is retrieved from the Standard as well. If this profile element is applied on a SOP class that does not contain this tag, it won’t be added to prevent corrupting the DICOM instance, and a warning will be generated in the logs

This feature is especially useful when applying masks to non-compliant SOPs by using the attribute Burned In Annotation. Please refer to the Cleaning Data Pixel Exceptions page for an exhaustive example.

In this example, we add the optional tag Recognizable Visual Features (0028,0302).

- name: "Add Recognizable Visual Features tag"
  codename: "action.add.tag"
  arguments:
    value: "YES"
    vr: "CS"
  tags:
    - "(0028,0302)"

Add new private tags

This profile element adds a private tag if it is not already present in the instance. This action will be ignored if the tag is already present in the instance or if there is a collision with a different Private Creator ID.

Its codename is action.add.private.tag.

This profile element requires the following parameters:

name: description of the action applied
codename: action.add.private.tag
arguments:
- value: required value to set the tag’s value to
- vr: VR of the tag
- privateCreator: optional value of the PrivateCreatorID, see below
tags: must contain exactly one tag, the one to add

This profile can have these optional parameters:

condition: optional, defines a condition to evaluate if this profile element should be applied to this DICOM instance

PrivateCreator value

The privateCreator argument is optional. It is recommended to specify it for coherence purposes.

In case the PrivateCreatorID tag does not exist for the private tag to be added, the privateCreator argument must be specified, and it will be created at the same time.

In case the PrivateCreatorID tag exists, if the privateCreator argument is not specified, the tag will be added as a part of it. It the privateCreator argument is specified, the existing PrivateCreatorID tag value will be matched against the privateCreator argument. If it matches, the new tag is added. If it doesn’t, there is a PrivateCreatorID collision and the tag won’t be added to prevent incoherent data in the DICOM instance. A warning will be generated in the logs.

The other specificities of the Add action are the same as above, for non-private tags.

The details about the management of tags and element numbers in private tags are detailed in the DICOM Standard.

In this example, we add a private tag containing the value “sample-project” linked to the PrivateCreatorID “KARNAK-PRIVATE”. The PrivateCreatorID tag (0057,0010) is created with the value “KARNAK-PRIVATE” if it is not present in the DICOM instance. If it exists already and contains the value “KARNAK-PRIVATE”, the (0057,1000) tag will be created.

If the PrivateCreatorID tag (0057,0010) exists already but contains a value different from “KARNAK-PRIVATE”, the tag (0057,1000) won’t be added since it would result in linking it to the wrong PrivateCreatorID.

- name: "Add Private Tag"
  codename: "action.add.private.tag"
  arguments:
    value: "sample-project"
    vr: "LO"
    privateCreator: "KARNAK-PRIVATE"
  tags:
    - "(0057,1000)"

Example of a complete and valid profile yaml file that applies the following profile elements in order:

Remove the tags that match (0008,00XX) and (0010,00XX) except for (0008,0008) and (0008,0013)
Keep specifically the previously excluded tags (so that they won’t be removed by a profile element applied afterward)
Remove all the private tags
Apply the Basic DICOM Profile to all the tags that did not undergo a modification previously

name: "De-identification profile"
version: "1.0"
minimumKarnakVersion: "0.9.2"
defaultIssuerOfPatientID:
profileElements:
  - name: "Remove tags"
    codename: "action.on.specific.tags"
    action: "X"
    tags:
      - "(0008,00XX)"
      - "0010,00XX"
    excludedTags:
      - "0008,0008"
      - "0008,0013"

  - name: "Keep tags"
    codename: "action.on.specific.tags"
    action: "K"
    tags:
      - "0008,0008"
      - "0008,0013"

  - name: "Remove all private tags"
    codename: "action.on.privatetags"
    action: "X"

  - name: "DICOM basic profile"
    codename: "basic.dicom.profile"

This example keeps a Study Description tag if that as contain ‘R2D2’ value, keep the Philips PET private group and apply the basic DICOM profile.

The tag patterns (0073,xx00) and (7053,xx09) are defined in Philips PET Private Group by DICOM.

name: "Profile Example"
version: "1.0"
minimumKarnakVersion: "0.9.7"
profileElements:
  - name: "Keep StudyDescription tag according to a condition"
    codename: "action.on.specific.tags"
    condition: "tagValueContains(#Tag.StudyDescription, 'R2D2')"
    action: "K"
    tags:
      - "(0008,1030)"

  - name: "Keep Philips PET Private Group"
    codename: "action.on.privatetags"
    action: "K"
    tags:
      - "(7053,xx00)"
      - "(7053,xx09)"

  - name: "DICOM basic profile"
    codename: "basic.dicom.profile"