---
title: "Get Onco Phenotype job details"
method: GET
path: "/oncophenotype/jobs/{jobId}"
tags: ["OncoPhenotype"]
---

# Get Onco Phenotype job details

`GET /oncophenotype/jobs/{jobId}`

## Request

- Base URL: `{endpoint}/healthinsights`
- URL: `{endpoint}/healthinsights/oncophenotype/jobs/{jobId}`
- Auth: API key in header `Ocp-Apim-Subscription-Key`

Gets the status and details of the Onco Phenotype job.

## Path parameters

- `jobId` string, uuid, required

## Query parameters

- `api-version` string, required

## Response `200`

The request has succeeded.

- OncoPhenotypeResult: The response for the Onco Phenotype request.
  - `jobId` string, uuid, required: Universally Unique Identifier
  - `createdDateTime` string, date-time, required: The date and time when the processing job was created.
  - `expirationDateTime` string, date-time, required: The date and time when the processing job is set to expire.
  - `lastUpdateDateTime` string, date-time, required: The date and time when the processing job was last updated.
  - `status` 'notStarted' | 'running' | 'succeeded' | 'failed' | 'partiallyCompleted', required: The status of the processing job.
  - `errors` AzureCoreFoundationsError[]: An array of errors, if any errors occurred during the processing job.
    - `code` string, required: One of a server-defined set of error codes.
    - `message` string, required: A human-readable representation of the error.
    - `target` string: The target of the error.
    - `details` AzureCoreFoundationsError[]: An array of details about specific errors that led to this reported error.
    - `innererror` AzureCoreFoundationsInnerError: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      - `code` string: One of a server-defined set of error codes.
      - `innererror` AzureCoreFoundationsInnerError (recursive)
  - `results` OncoPhenotypeResults: The inference results for the Onco Phenotype request.
    - `patients` OncoPhenotypePatientResult[], required: Results for the patients given in the request.
      - `id` string, required: The identifier given for the patient in the request.
      - `inferences` OncoPhenotypeInference[], required: The model's inferences for the given patient.
        - `type` 'tumorSite' | 'histology' | 'clinicalStageT' | 'clinicalStageN' | 'clinicalStageM' | 'pathologicStageT' | 'pathologicStageN' | 'pathologicStageM', required: The type of the Onco Phenotype inference.
        - `value` string, required: The value of the inference, as relevant for the given inference type.
        - `description` string: The description corresponding to the inference value.
        - `confidenceScore` number, float: Confidence score for this inference.
        - `evidence` InferenceEvidence[]: The evidence corresponding to the inference value.
          - `patientDataEvidence` ClinicalNoteEvidence: A piece of evidence from a clinical note (text document).
            - `id` string, required: The identifier of the document containing the evidence.
            - `text` string: The actual text span which is evidence for the inference.
            - `offset` integer, required: The start index of the evidence text span in the document (0 based).
            - `length` integer, required: The length of the evidence text span.
          - `patientInfoEvidence` ClinicalCodedElement: A piece of clinical information, expressed as a code in a clinical coding system.
            - `system` string, required: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.
            - `code` string, required: The code within the given clinical coding system.
            - `name` string: The name of this coded concept in the coding system.
            - `value` string: A value associated with the code within the given clinical coding system.
          - `importance` number, float: A value indicating how important this piece of evidence is for the inference.
        - `caseId` string: An identifier for a clinical case, if there are multiple clinical cases regarding the same patient.
    - `modelVersion` string, required: The version of the model used for inference, expressed as the model date.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/azure/apis/azure-health-insights.md) - [All operations](https://skmtc.dev/azure/apis/azure-health-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/azure-health-insights/revisions/170d7819ac4c?raw)