| title | titleSuffix | description | author | manager | ms.service | ms.topic | ms.date | ms.author | ms.custom |
|---|---|---|---|---|---|---|---|---|---|
How to call Text Analytics for health |
Azure AI services |
Learn how to extract and label medical information from unstructured clinical text with Text Analytics for health. |
jboback |
nitinme |
azure-ai-language |
how-to |
12/19/2023 |
jboback |
language-service-health |
[!INCLUDE service notice]
Text Analytics for health can be used to extract and label relevant medical information from unstructured texts such as doctors' notes, discharge summaries, clinical documents, and electronic health records. The service performs named entity recognition, relation extraction, entity linking, and assertion detection to uncover insights from the input text. For information on the returned confidence scores, see the transparency note.
Tip
If you want to test out the feature without writing any code, use the Language Studio.
There are two ways to call the service:
- A Docker container (synchronous)
- Using the web-based API and client libraries (asynchronous)
[!INCLUDE Development options]
The Text Analytics for health supports English in addition to multiple languages that are currently in preview. You can use the hosted API or deploy the API in a container, as detailed under Text Analytics for health languages support.
To send an API request, you will need your Language resource endpoint and key.
Note
You can find the key and endpoint for your Language resource on the Azure portal. They will be located on the resource's Key and endpoint page, under resource management.
Analysis is performed upon receipt of the request. If you send a request using the REST API or client library, the results will be returned asynchronously. If you're using the Docker container, they will be returned synchronously.
[!INCLUDE asynchronous-result-availability]
Fast Healthcare Interoperability Resources (FHIR) is the health industry communication standard developed by the Health Level Seven International (HL7) organization. The standard defines the data formats (resources) and API structure for exchanging electronic healthcare data. To receive your result using the FHIR structure, you must send the FHIR version in the API request body.
| Parameter Name | Type | Value |
|---|---|---|
| fhirVersion | string | 4.0.1 |
Depending on your API request, and the data you submit to the Text Analytics for health, you will get:
[!INCLUDE Text Analytics for health features]
[!INCLUDE service limits article]