@@ -15,10 +15,21 @@ In this tutorial, you:
15
15
16
16
> [ !div class="checklist"]
17
17
> * Learn how to specify a custom redaction format
18
- > * Learn how to create your desired redaction format
18
+ > * Learn how to use variables in a custom redaction format
19
19
20
20
## Usage
21
21
22
+ Within the de-identification service, we support an operation called ` Redact ` that allows you to redact PHI from a text document. You can specify
23
+ what that redaction looks like using a custom format.
24
+
25
+ For example:
26
+
27
+ | Text | RedactedText |
28
+ | ---------------------- | ------------------ |
29
+ | My name is John Smith. | My name is [ name] . |
30
+
31
+ ### Specify a custom redaction format
32
+
22
33
1 . Must select ` Redact ` as ` Operation ` . ` RedactionFormat ` is only supported for ` Redact ` operation.
23
34
2 . Pass ` RedactionFormat ` parameter within the ` CustomizationOptions ` model to the API or Job parameters.
24
35
@@ -44,14 +55,13 @@ The following variables are supported:
44
55
Also supports Upper and Title cases
45
56
46
57
``` text
47
- {Type} => {Patient}
48
- {TYPE} => {PATIENT}
58
+ {type} => patient
59
+ {Type} => Patient
60
+ {TYPE} => PATIENT
49
61
```
50
62
51
63
### Length
52
64
53
- ` *{len} => ******(length of entity) `
54
-
55
65
This variable allows you to create a string matching the length of the PHI.
56
66
57
67
It duplicates the previous character to match the length of the tagged entity.
@@ -66,5 +76,5 @@ It duplicates the previous character to match the length of the tagged entity.
66
76
67
77
## Limits
68
78
69
- 1 . RedactionFormat supports up to 16 characters.
79
+ 1 . The redaction format can be up to 16 characters long .
70
80
2 . Each variable type can only be used once in the format.
0 commit comments