Skip to content

Commit 1af674b

Browse files
author
Graham Thomas
committed
Updates with team feedback
1 parent 3c2307a commit 1af674b

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

articles/healthcare-apis/deidentification/redaction-format.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,21 @@ In this tutorial, you:
1515

1616
> [!div class="checklist"]
1717
> * 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
1919
2020
## Usage
2121

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+
2233
1. Must select `Redact` as `Operation`. `RedactionFormat` is only supported for `Redact` operation.
2334
2. Pass `RedactionFormat` parameter within the `CustomizationOptions` model to the API or Job parameters.
2435

@@ -44,14 +55,13 @@ The following variables are supported:
4455
Also supports Upper and Title cases
4556

4657
```text
47-
{Type} => {Patient}
48-
{TYPE} => {PATIENT}
58+
{type} => patient
59+
{Type} => Patient
60+
{TYPE} => PATIENT
4961
```
5062

5163
### Length
5264

53-
`*{len} => ******(length of entity)`
54-
5565
This variable allows you to create a string matching the length of the PHI.
5666

5767
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.
6676

6777
## Limits
6878

69-
1. RedactionFormat supports up to 16 characters.
79+
1. The redaction format can be up to 16 characters long.
7080
2. Each variable type can only be used once in the format.

articles/healthcare-apis/deidentification/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ items:
3232
items:
3333
- name: Configure Azure Storage to de-identify documents
3434
href: configure-storage.md
35-
- name: Custom redaction format with the de-identification service
35+
- name: Customize format of redacted text during de-identification
3636
href: redaction-format.md
3737
- name: How-to
3838
expanded: true

0 commit comments

Comments
 (0)