Onco Phenotype - Get Job

Reference

Service:: Cognitive Services

API Version:: 2023-09-01-preview

Get Onco Phenotype job details
Gets the status and details of the Onco Phenotype job.

GET {endpoint}/health-insights/onco-phenotype/jobs/{id}?api-version=2023-09-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
id	path	True	string uuid	A processing job identifier.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Responses

Name	Type	Description
200 OK	OncoPhenotypeResult	The request has succeeded. Headers Retry-After: integer
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

OncoPhenotypeResult

The request has succeeded.

Headers

Retry-After: integer

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Gets the status and details of the Onco Phenotype job.

Sample request

HTTP

GET {endpoint}/health-insights/onco-phenotype/jobs/3fa85f64-5717-4562-b3fc-2c963f66afa6?api-version=2023-09-01-preview

Sample response

Status code:: 200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDateTime": "2021-11-26T17:22:27.386Z",
  "expirationDateTime": "2021-11-26T17:22:27.386Z",
  "lastUpdateDateTime": "2021-11-26T17:22:27.386Z",
  "status": "succeeded",
  "result": {
    "patientResults": [
      {
        "patientId": "Patient ID Example 1",
        "inferences": [
          {
            "type": "histology",
            "value": "8561",
            "description": "Adenolymphoma",
            "confidenceScore": 0.85,
            "evidence": [
              {
                "patientDataEvidence": {
                  "id": "1",
                  "text": "string",
                  "offset": 70,
                  "length": 135
                },
                "importance": 1
              }
            ]
          },
          {
            "type": "clinicalStageT",
            "value": "T3",
            "description": "Locally advanced disease at risk for micrometastases",
            "confidenceScore": 0.88,
            "evidence": [
              {
                "patientDataEvidence": {
                  "id": "2",
                  "text": "string",
                  "offset": 12,
                  "length": 9
                },
                "importance": 1
              }
            ],
            "caseId": "1"
          }
        ]
      }
    ],
    "modelVersion": "2021-11-26"
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	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.
ClinicalCodedElement	A piece of clinical information, expressed as a code in a clinical coding system.
ClinicalNoteEvidence	A piece of evidence from a clinical note (text document).
InferenceEvidence	A piece of evidence corresponding to an inference.
JobStatus	The status of the processing job.
OncoPhenotypeInference	An inference made by the Onco Phenotype model regarding a patient.
OncoPhenotypeInferenceResult	The inference results for the Onco Phenotype request.
OncoPhenotypeInferenceType	The type of the Onco Phenotype inference.
OncoPhenotypePatientResult	The results of the model's work for a single patient.
OncoPhenotypeResult	The response for the Onco Phenotype request.

Azure.Core.Foundations.Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

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.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

ClinicalCodedElement

A piece of clinical information, expressed as a code in a clinical coding system.

Name	Type	Description
code	string	The code within the given clinical coding system.
name	string	The name of this coded concept in the coding system.
system	string	The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.
value	string	A value associated with the code within the given clinical coding system.

ClinicalNoteEvidence

A piece of evidence from a clinical note (text document).

Name	Type	Description
id	string	The identifier of the document containing the evidence.
length	integer	The length of the evidence text span.
offset	integer	The start index of the evidence text span in the document (0 based).
text	string	The actual text span which is evidence for the inference.

InferenceEvidence

A piece of evidence corresponding to an inference.

Name	Type	Description
importance	number	A value indicating how important this piece of evidence is for the inference.
patientDataEvidence	ClinicalNoteEvidence	A piece of evidence from a clinical note (text document).
patientInfoEvidence	ClinicalCodedElement	A piece of clinical information, expressed as a code in a clinical coding system.

JobStatus

The status of the processing job.

Name	Type	Description
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OncoPhenotypeInference

An inference made by the Onco Phenotype model regarding a patient.

Name	Type	Description
caseId	string	An identifier for a clinical case, if there are multiple clinical cases regarding the same patient.
confidenceScore	number	Confidence score for this inference.
description	string	The description corresponding to the inference value.
evidence	InferenceEvidence[]	The evidence corresponding to the inference value.
type	OncoPhenotypeInferenceType	The type of the Onco Phenotype inference
value	string	The value of the inference, as relevant for the given inference type.

OncoPhenotypeInferenceResult

The inference results for the Onco Phenotype request.

Name	Type	Description
modelVersion	string	The version of the model used for inference, expressed as the model date.
patientResults	OncoPhenotypePatientResult[]	Results for the patients given in the request.

OncoPhenotypeInferenceType

The type of the Onco Phenotype inference.

Name	Type	Description
clinicalStageM	string
clinicalStageN	string
clinicalStageT	string
diagnosisDate	string
histology	string
pathologicStageM	string
pathologicStageN	string
pathologicStageT	string
tumorSite	string

OncoPhenotypePatientResult

The results of the model's work for a single patient.

Name	Type	Description
inferences	OncoPhenotypeInference[]	The model's inferences for the given patient.
patientId	string	The identifier given for the patient in the request.

OncoPhenotypeResult

The response for the Onco Phenotype request.

Name	Type	Description
createdDateTime	string	The date and time when the processing job was created.
error	Azure.Core.Foundations.Error	Error object that describes the error when status is "Failed".
expirationDateTime	string	The date and time when the processing job is set to expire.
id	string	The unique ID of the operation.
lastUpdateDateTime	string	The date and time when the processing job was last updated.
result	OncoPhenotypeInferenceResult	The result of the operation.
status	JobStatus	The status of the operation

Share via

Onco Phenotype - Get Job

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Gets the status and details of the Onco Phenotype job.

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ClinicalCodedElement

ClinicalNoteEvidence

InferenceEvidence

JobStatus

OncoPhenotypeInference

OncoPhenotypeInferenceResult

OncoPhenotypeInferenceType

OncoPhenotypePatientResult

OncoPhenotypeResult

Additional resources