@cosyte/dicom 0.0.3 → 0.0.5

package/dist/index.d.cts

@@ -2260,6 +2260,19 @@ type AnnexEOption = "CleanPixelData" | "CleanRecognizableVisual" | "CleanGraphic
  * (deferred to `@cosyte/dicom-pixel`). When pixel data is present it always
  * warns rather than claiming the image is clean.
  *
+ * **`RetainLongitudinalTemporal` gives you the full-dates branch.** PS3.15
+ * §E.3.6 is *two* options, and Table E.1-1 gives them separate columns:
+ * `Rtn. Long. Full Dates` (keep dates and times as they are) and
+ * `Rtn. Long. Modif. Dates` (keep them only as modified/shifted values). One
+ * name here covers both, and it carries the **full-dates** column - the *less*
+ * protective branch. That is not a rounding difference: the two columns disagree
+ * on **169** rows, and on every one of them full-dates says `K` (keep the real
+ * value) where modified-dates says `C` (clean it). Activate it only when real
+ * dates are genuinely required; leave it off and the Basic Profile action
+ * applies, which removes or empties them. Date *shifting* is not implemented at
+ * this layer - a caller who needs the modified-dates behaviour shifts the values
+ * themselves after the call.
+ *
  * @example
  *   const retain: DeidentifyOption[] = ["RetainLongitudinalTemporal", "RetainSafePrivate"];
  */
@@ -2317,6 +2330,13 @@ interface DeidentifiedAttribute {
     readonly applied: AppliedAction;
     /** Tag/index chain for an attribute inside a sequence; omitted at the root. */
     readonly contextPath?: readonly string[];
+    /**
+     * Present when the action came from a Table E.1-1 row that names a
+     * repeating-group family rather than this single tag: the mask that matched,
+     * e.g. `"60xx4000"` for Overlay Comments in any overlay plane. `tag` is always
+     * the concrete tag that was in the file. Absent for every exact-tag row.
+     */
+    readonly repeatingGroup?: string;
 }
 /**
  * The audit trail returned alongside the de-identified dataset. Contains no
@@ -2458,6 +2478,11 @@ declare class DeidentifyError extends Error {
  *   (see {@link resolveAction}), and applies it: `X` remove, `Z` zero-length, `D`
  *   VR-consistent dummy (falling back to `Z` where no safe dummy exists), `C`
  *   conservative blank, `U` deterministic consistent-UID remap, `K` keep.
+ * - Resolves the three Table E.1-1 rows the standard states as a repeating-group
+ *   mask (`(50xx,xxxx)` Curve Data, `(60xx,3000)` Overlay Data, `(60xx,4000)`
+ *   Overlay Comments) across the groups PS3.5 §7.6 bounds them to, on an
+ *   exact-tag miss. A match is removed *and* reported, with
+ *   `DeidentifiedAttribute.repeatingGroup` naming the mask.
  * - Recurses into kept sequences and **re-encodes** them so nested PHI is removed
  *   in the *serialized* bytes too - not just the object model (the Phase 5 writer
  *   blits `SQ` spans verbatim, so a rebuilt `items` array alone would not survive

package/dist/index.d.ts

@@ -2260,6 +2260,19 @@ type AnnexEOption = "CleanPixelData" | "CleanRecognizableVisual" | "CleanGraphic
  * (deferred to `@cosyte/dicom-pixel`). When pixel data is present it always
  * warns rather than claiming the image is clean.
  *
+ * **`RetainLongitudinalTemporal` gives you the full-dates branch.** PS3.15
+ * §E.3.6 is *two* options, and Table E.1-1 gives them separate columns:
+ * `Rtn. Long. Full Dates` (keep dates and times as they are) and
+ * `Rtn. Long. Modif. Dates` (keep them only as modified/shifted values). One
+ * name here covers both, and it carries the **full-dates** column - the *less*
+ * protective branch. That is not a rounding difference: the two columns disagree
+ * on **169** rows, and on every one of them full-dates says `K` (keep the real
+ * value) where modified-dates says `C` (clean it). Activate it only when real
+ * dates are genuinely required; leave it off and the Basic Profile action
+ * applies, which removes or empties them. Date *shifting* is not implemented at
+ * this layer - a caller who needs the modified-dates behaviour shifts the values
+ * themselves after the call.
+ *
  * @example
  *   const retain: DeidentifyOption[] = ["RetainLongitudinalTemporal", "RetainSafePrivate"];
  */
@@ -2317,6 +2330,13 @@ interface DeidentifiedAttribute {
     readonly applied: AppliedAction;
     /** Tag/index chain for an attribute inside a sequence; omitted at the root. */
     readonly contextPath?: readonly string[];
+    /**
+     * Present when the action came from a Table E.1-1 row that names a
+     * repeating-group family rather than this single tag: the mask that matched,
+     * e.g. `"60xx4000"` for Overlay Comments in any overlay plane. `tag` is always
+     * the concrete tag that was in the file. Absent for every exact-tag row.
+     */
+    readonly repeatingGroup?: string;
 }
 /**
  * The audit trail returned alongside the de-identified dataset. Contains no
@@ -2458,6 +2478,11 @@ declare class DeidentifyError extends Error {
  *   (see {@link resolveAction}), and applies it: `X` remove, `Z` zero-length, `D`
  *   VR-consistent dummy (falling back to `Z` where no safe dummy exists), `C`
  *   conservative blank, `U` deterministic consistent-UID remap, `K` keep.
+ * - Resolves the three Table E.1-1 rows the standard states as a repeating-group
+ *   mask (`(50xx,xxxx)` Curve Data, `(60xx,3000)` Overlay Data, `(60xx,4000)`
+ *   Overlay Comments) across the groups PS3.5 §7.6 bounds them to, on an
+ *   exact-tag miss. A match is removed *and* reported, with
+ *   `DeidentifiedAttribute.repeatingGroup` naming the mask.
  * - Recurses into kept sequences and **re-encodes** them so nested PHI is removed
  *   in the *serialized* bytes too - not just the object model (the Phase 5 writer
  *   blits `SQ` spans verbatim, so a rebuilt `items` array alone would not survive