AnalyzeEntitiesResponse

Includes recognized entity mentions and relationships between them.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name	Type	Description
entities	array	The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content.
entityMentions	array	The `entity_mentions` field contains all the annotated medical entities that were mentioned in the provided document.
fhirBundle	string	The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all the entities, the entity mentions, and the relationships in JSON format.
relationships	array	relationships contains all the binary relationships that were identified between entity mentions within the provided document.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AnalyzeEntitiesResponse",
  "description": "Includes recognized entity mentions and relationships between them.",
  "properties": {
    "entities": {
      "description": "The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content.",
      "items": {
        "$ref": "#/components/schemas/Entity"
      },
      "type": "array"
    },
    "entityMentions": {
      "description": "The `entity_mentions` field contains all the annotated medical entities that were mentioned in the provided document.",
      "items": {
        "$ref": "#/components/schemas/EntityMention"
      },
      "type": "array"
    },
    "fhirBundle": {
      "description": "The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all the entities, the entity mentions, and the relationships in JSON format.",
      "type": "string"
    },
    "relationships": {
      "description": "relationships contains all the binary relationships that were identified between entity mentions within the provided document.",
      "items": {
        "$ref": "#/components/schemas/EntityMentionRelationship"
      },
      "type": "array"
    }
  },
  "type": "object"
}