Updated readme

specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md

@@ -26,7 +26,7 @@ These are the global settings for the HealthDataAIServices.DeidServices.
 
 ```yaml
 openapi-type: data-plane
-tag: package-2024-11-15
+tag: package-2024-12-15
 title: Azure Health Data Services de-identification service
 security: AADToken
 security-scopes:
@@ -42,6 +42,15 @@ input-file:
   - stable/2024-11-15/HealthDataAIServices.DeidServices.json
 ```
 
+### Tag: package-2024-12-15
+
+These settings apply only when `--tag=package-2024-12-15` is specified on the command line.
+
+```yaml $(tag) == 'package-2024-12-15'
+input-file:
+  - stable/2024-12-15/HealthDataAIServices.DeidServices.json
+```
+
 ---
 
 # Code Generation
@@ -75,4 +84,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md)
 
 ## CSharp
 
-See configuration in [readme.csharp.md](./readme.csharp.md)
+See configuration in [readme.csharp.md](./readme.csharp.md)

specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/stable/2024-12-15/HealthDataAIServices.DeidServices.json

@@ -649,20 +649,17 @@
             ]
           }
         },
-        "encodedEntities": {
-          "type": "array",
-          "description": "List of PHI entities with simplified single encoding for SurrogateOnly operation. Cannot be used with Entities.",
-          "items": {
-            "$ref": "#/definitions/EncodedPhiEntity"
-          }
-        },
         "entities": {
           "type": "array",
-          "description": "List of PHI entities for SurrogateOnly operation with full encoding information. Cannot be used with EncodedEntities.",
+          "description": "List of PHI entities for SurrogateOnly operation with full encoding information. Cannot be used with TaggedEntities.",
           "items": {
-            "$ref": "#/definitions/PhiEntity"
+            "$ref": "#/definitions/PublicPhiEntity"
           }
         },
+        "taggedEntities": {
+          "$ref": "#/definitions/TaggedPhiEntities",
+          "description": "Grouped PHI entities with single encoding specification for SurrogateOnly operation. Cannot be used with Entities."
+        },
         "customizations": {
           "$ref": "#/definitions/DeidentificationCustomizationOptions",
           "description": "Customization parameters to override default service behaviors."
@@ -925,40 +922,6 @@
         }
       }
     },
-    "EncodedPhiEntity": {
-      "type": "object",
-      "description": "Simplified PHI Entity for use in SurrogateOnly operations with single encoding.",
-      "properties": {
-        "category": {
-          "type": "string",
-          "description": "PHI Category of the entity."
-        },
-        "offset": {
-          "type": "integer",
-          "format": "int32",
-          "description": "Starting index of the location from within the input text using the specified encoding."
-        },
-        "length": {
-          "type": "integer",
-          "format": "int32",
-          "description": "Length of the input text using the specified encoding."
-        },
-        "encoding": {
-          "$ref": "#/definitions/EncodingType",
-          "description": "The encoding used for offset and length values."
-        },
-        "text": {
-          "type": "string",
-          "description": "Text of the entity (optional)."
-        }
-      },
-      "required": [
-        "category",
-        "offset",
-        "length",
-        "encoding"
-      ]
-    },
     "EncodingType": {
       "type": "string",
       "description": "Encoding type for text offset and length calculations.",
@@ -1265,6 +1228,62 @@
         "entities"
       ]
     },
+    "PublicPhiEntity": {
+      "type": "object",
+      "description": "PHI Entity for public use in SurrogateOnly operations with full encoding information.",
+      "properties": {
+        "category": {
+          "$ref": "#/definitions/PhiCategory",
+          "description": "PHI Category of the entity."
+        },
+        "offset": {
+          "$ref": "#/definitions/StringIndex",
+          "description": "Starting index of the location from within the input text."
+        },
+        "length": {
+          "$ref": "#/definitions/StringIndex",
+          "description": "Length of the input text."
+        },
+        "text": {
+          "type": "string",
+          "description": "Text of the entity (optional)."
+        }
+      },
+      "required": [
+        "category",
+        "offset",
+        "length"
+      ]
+    },
+    "SimplePhiEntity": {
+      "type": "object",
+      "description": "Simple PHI entity with encoding-specific offset and length values.",
+      "properties": {
+        "category": {
+          "$ref": "#/definitions/PhiCategory",
+          "description": "PHI Category of the entity."
+        },
+        "offset": {
+          "type": "integer",
+          "format": "int32",
+          "description": "Starting index of the location from within the input text using the group's encoding."
+        },
+        "length": {
+          "type": "integer",
+          "format": "int32",
+          "description": "Length of the input text using the group's encoding."
+        },
+        "text": {
+          "type": "string",
+          "description": "Text of the entity (optional)."
+        }
+      },
+      "required": [
+        "category",
+        "offset",
+        "length"
+      ]
+    },
     "SourceStorageLocation": {
       "type": "object",
       "description": "Storage location.",
@@ -1322,6 +1341,27 @@
         "codePoint"
       ]
     },
+    "TaggedPhiEntities": {
+      "type": "object",
+      "description": "Grouped PHI entities with shared encoding specification.",
+      "properties": {
+        "encoding": {
+          "$ref": "#/definitions/EncodingType",
+          "description": "The encoding type used for all entities in this group."
+        },
+        "entities": {
+          "type": "array",
+          "description": "List of PHI entities using the specified encoding.",
+          "items": {
+            "$ref": "#/definitions/SimplePhiEntity"
+          }
+        }
+      },
+      "required": [
+        "encoding",
+        "entities"
+      ]
+    },
     "TargetStorageLocation": {
       "type": "object",
       "description": "Storage location.",