TA v3.1-preview.4 - updated examples and definitions for TA for Health

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json

@@ -1778,8 +1778,13 @@
             "isNegated"
           ],
           "properties": {
-            "isNegated": {
-              "type": "boolean"
+            "assertion": {
+              "type": "object",
+              "$ref": "#/definitions/HealthcareAssertion"
+            },
+            "name": {
+              "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.",
+              "type": "string"
             },
             "links": {
               "description": "Entity references in known data sources.",
@@ -1805,16 +1810,45 @@
           "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.",
           "type": "string"
         },
-        "bidirectional": {
-          "description": "If true the relation between the entities is bidirectional, otherwise directionality is source to target.",
-          "type": "boolean"
+        "entities":{
+          "description": "The entities in the relation.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/HealthcareRelationEntity"
+          }
+        }
+      }
+    },
+    "HealthcareAssertion": {
+      "type": "object",
+      "properties": {
+        "conditionality": {
+          "description": "Describes any conditionality on the entity. Possbile values: conditional, hypothetical",
+          "type": "string"
+        },        
+        "certainty": {
+          "description": "Describes the entities certainty and sentiment. Possible values: positive, postive possible, neutral, negative possible, negative",
+          "type": "string"
         },
-        "source": {
-          "description": "Reference link to the source entity.",
+        "association": {
+          "description": "Describes if the entity is the subject of the text or if it describes someone else. Possible values: subject, other",
+          "type": "string"
+        }
+      }
+    },
+    "HealthcareRelationEntity": {
+      "type": "object",
+      "required": [
+        "ref",
+        "role"
+      ],
+      "properties": {
+        "ref": {
+          "description": "Reference link to the entity object.",
           "type": "string"
         },
-        "target": {
-          "description": "Reference link to the target entity.",
+        "role": {
+          "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parathesis:  CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis)",
           "type": "string"
         }
       }

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/examples/SuccessfulHealthStatusRequest.json

@@ -23,16 +23,17 @@
                   "length": 5,
                   "text": "100mg",
                   "category": "Dosage",
-                  "confidenceScore": 0.99,
-                  "isNegated": false
+                  "confidenceScore": 0.99
                 },
                 {
                   "offset": 27,
                   "length": 9,
                   "text": "ibuprofen",
                   "category": "MedicationName",
                   "confidenceScore": 1.0,
-                  "isNegated": false,
+                  "assertions":{
+                    "certainty": "Positive"
+                  },
                   "links": [
                     {
                       "id": "C0020740",
@@ -161,22 +162,37 @@
                   "length": 11,
                   "text": "twice daily",
                   "category": "Frequency",
-                  "confidenceScore": 1,
-                  "isNegated": false
+                  "confidenceScore": 1
                 }
               ],
               "relations": [
                 {
                   "relationType": "DosageOfMedication",
-                  "bidirectional": false,
-                  "source": "#/documents/0/entities/0",
-                  "target": "#/documents/0/entities/1"
+                  "entities":
+                    [
+                      {
+                        "ref":"#/documents/0/entities/0",
+                        "role": "Attribute"
+                      },
+                      {
+                        "ref":"#/documents/0/entities/1",
+                        "role": "Entity"
+                      }
+                    ]
                 },
                 {
                   "relationType": "FrequencyOfMedication",
-                  "bidirectional": false,
-                  "source": "#/documents/0/entities/2",
-                  "target": "#/documents/0/entities/1"
+                  "entities":
+                    [
+                      {
+                        "ref":"#/documents/0/entities/2",
+                        "role": "Attribute"
+                      },
+                      {
+                        "ref":"#/documents/0/entities/1",
+                        "role": "Entity"
+                      }
+                    ]
                 }
               ],
               "warnings": []
@@ -210,4 +226,4 @@
       }
     }
   }
-}
+}