Azure Cognitive Services Health Insights Cancer Profiling client library for Java - version 1.0.0-beta.1

Health Insights is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.

The Cancer Profiling model receives clinical records of oncology patients and outputs cancer staging, such as clinical stage TNM categories and pathologic stage TNM categories as well as tumor site, histology. Source code | Package (Maven) | API reference documentation | Product Documentation | Samples

Getting started


For more information about creating the resource or how to get the location and sku information see here.

Include the Package


Authenticate the client

In order to interact with the Health Insights Cancer Profiling service, you'll need to create an instance of the CancerProfilingClient class. You will need an endpoint and an API key to instantiate a client object.

Get API Key

You can obtain the endpoint and API key from the resource information in the Azure Portal.

Alternatively, you can use the Azure CLI snippet below to get the API key from the Health Insights resource.

az cognitiveservices account keys list --resource-group <your-resource-group-name> --name <your-resource-name>

Create a CancerProfilingClient with an API Key Credential

Once you have the value for the API key, you can pass it as a string into an instance of AzureKeyCredential. Use the key as the credential parameter to authenticate the client:

String endpoint = Configuration.getGlobalConfiguration().get("AZURE_HEALTH_INSIGHTS_ENDPOINT");
String apiKey = Configuration.getGlobalConfiguration().get("AZURE_HEALTH_INSIGHTS_API_KEY");

CancerProfilingAsyncClient asyncClient = new CancerProfilingClientBuilder()
    .credential(new AzureKeyCredential(apiKey))

Key concepts

The Cancer Profiling model allows you to infer cancer attributes such as tumor site, histology, clinical stage TNM categories and pathologic stage TNM categories from unstructured clinical documents.


Infer key cancer attributes such as tumor site, histology, clinical stage TNM categories and pathologic stage TNM categories from a patient's unstructured clinical documents.

// Construct Patient
PatientRecord patient1 = new PatientRecord("patient_id");
PatientInfo patientInfo = new PatientInfo();
LinkedList<PatientDocument> patientDocuments = new LinkedList<>();

// Add imaging document
final String docContent1 = String.join(System.getProperty("line.separator"),
    "Jane Doe 091175-8967",
    "42 year old female, married with 3 children, works as a nurse. ",
    "Healthy, no medications taken on a regular basis.",
    "PMHx is significant for migraines with aura, uses Mirena for contraception.",
    "Smoking history of 10 pack years (has stopped and relapsed several times).",
    "She is in c/o 2 weeks of productive cough and shortness of breath.",
    "She has a fever of 37.8 and general weakness. ",
    "Denies night sweats and rash. She denies symptoms of rhinosinusitis, asthma, and heartburn. ",
    "On PE:",
    "GENERAL: mild pallor, no cyanosis. Regular breathing rate. ",
    "LUNGS: decreased breath sounds on the base of the right lung. Vesicular breathing.",
    " No crackles, rales, and wheezes. Resonant percussion. ",
    "PLAN: ",
    "Will be referred for a chest x-ray. ",
    "CXR showed mild nonspecific opacities in right lung base. ",
    "Findings are suggestive of a working diagnosis of pneumonia. The patient is referred to a follow-up CXR in 2 weeks.");

PatientDocument patientDocument1 = new PatientDocument(
    new DocumentContent(DocumentContentSourceType.INLINE, docContent1));


// Add Pathology documents
String docContent2 = String.join(System.getProperty("line.separator"),
    "Oncology Clinic ",
    "Jane Doe 091175-8967",
    "42-year-old healthy female who works as a nurse in the ER of this hospital. ",
    "First menstruation at 11 years old. First delivery- 27 years old. She has 3 children.",
    "Didn’t breastfeed. ",
    "Contraception- Mirena.",
    "Smoking- 10 pack years. ",
    "Mother- Belarusian. Father- Georgian. ",
    "About 3 months prior to admission, she stated she had SOB and was febrile. ",
    "She did a CXR as an outpatient which showed a finding in the base of the right lung- possibly an infiltrate.",
    "She was treated with antibiotics with partial response. ",
    "6 weeks later a repeat CXR was performed- a few solid dense findings in the right lung. ",
    "Therefore, she was referred for a PET-CT which demonstrated increased uptake in the right breast, lymph nodes on the right a few areas in the lungs and liver. ",
    "On biopsy from the lesion in the right breast- triple negative adenocarcinoma. Genetic testing has not been done thus far. ",
    "Genetic counseling- the patient denies a family history of breast, ovary, uterus, and prostate cancer. Her mother has chronic lymphocytic leukemia (CLL). ",
    "She is planned to undergo genetic tests because the aggressive course of the disease, and her young age. ",
    "Stage 4 triple negative breast adenocarcinoma. ",
    "Could benefit from biological therapy. ",
    "Different treatment options were explained- the patient wants to get a second opinion.");

PatientDocument patientDocument2 = new PatientDocument(DocumentType.NOTE,
    new DocumentContent(DocumentContentSourceType.INLINE, docContent2));

String docContent3 = String.join(System.getProperty("line.separator"),
    "                          Clinical Information",
    "Ultrasound-guided biopsy; A. 18 mm mass; most likely diagnosis based on imaging:  IDC",
    "                               Diagnosis",
    " - Invasive carcinoma of no special type (invasive ductal carcinoma), grade 1",
    " Nottingham histologic grade:  1/3 (tubules 2; nuclear grade 2; mitotic rate 1; total score;  5/9)",
    " Fragments involved by invasive carcinoma:  2",
    " Largest measurement of invasive carcinoma on a single fragment:  7 mm",
    " Ductal carcinoma in situ (DCIS):  Present",
    " Architectural pattern:  Cribriform",
    " Nuclear grade:  2-",
    "                  -intermediate",
    " Necrosis:  Not identified",
    " Fragments involved by DCIS:  1",
    " Largest measurement of DCIS on a single fragment:  Span 2 mm",
    " Microcalcifications:  Present in benign breast tissue and invasive carcinoma",
    " Blocks with invasive carcinoma:  A1",
    " Special studies: Pending");

PatientDocument patientDocument3 = new PatientDocument(DocumentType.NOTE,
                                                    new DocumentContent(DocumentContentSourceType.INLINE, docContent3));


// Set configuration to include evidence for the cancer staging inferences
OncoPhenotypeModelConfiguration configuration = new OncoPhenotypeModelConfiguration();

// Construct the request with the patient and configration
OncoPhenotypeData oncoPhenotypeData = new OncoPhenotypeData(Arrays.asList(patient1));

PollerFlux<OncoPhenotypeResult, OncoPhenotypeResult> asyncPoller = asyncClient.beginInferCancerProfile(oncoPhenotypeData);


Next steps

Additional documentation

For more extensive documentation on Azure Health Insights Cancer Profiling, see the Cancer Profiling documentation on


This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.