AnalyzeEntitiesRequest

The request to analyze healthcare entities in a document.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name	Type	Description
alternativeOutputFormat	string	Optional. Alternative output format to be generated based on the results of analysis.
documentContent	string	document_content is a document to be annotated.
licensedVocabularies	array	A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AnalyzeEntitiesRequest",
  "description": "The request to analyze healthcare entities in a document.",
  "properties": {
    "alternativeOutputFormat": {
      "description": "Optional. Alternative output format to be generated based on the results of analysis.",
      "enum": [
        "ALTERNATIVE_OUTPUT_FORMAT_UNSPECIFIED",
        "FHIR_BUNDLE"
      ],
      "type": "string"
    },
    "documentContent": {
      "description": "document_content is a document to be annotated.",
      "type": "string"
    },
    "licensedVocabularies": {
      "description": "A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies.",
      "items": {
        "enum": [
          "LICENSED_VOCABULARY_UNSPECIFIED",
          "ICD10CM",
          "SNOMEDCT_US"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}