--- title: "Get Trial Matcher job details" method: GET path: "/trialmatcher/jobs/{jobId}" tags: ["TrialMatcher"] --- # Get Trial Matcher job details `GET /trialmatcher/jobs/{jobId}` ## Request - Base URL: `{endpoint}/healthinsights` - URL: `{endpoint}/healthinsights/trialmatcher/jobs/{jobId}` - Auth: API key in header `Ocp-Apim-Subscription-Key` Gets the status and details of the Trial Matcher job. ## Path parameters - `jobId` string, uuid, required ## Query parameters - `api-version` string, required ## Response `200` The request has succeeded. - TrialMatcherResult: The response for the Trial Matcher 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` TrialMatcherResults: The inference results for the Trial Matcher request. - `patients` TrialMatcherPatientResult[], required: Results for the patients given in the request. - `id` string, required: The identifier given for the patient in the request. - `inferences` TrialMatcherInference[], required: The model's inferences for the given patient. - `type` 'trialEligibility', required: The type of the Trial Matcher 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` TrialMatcherInferenceEvidence[]: The evidence corresponding to the inference value. - `eligibilityCriteriaEvidence` string: A piece of evidence from the eligibility criteria text of a clinical trial. - `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. - `id` string: The identifier of the clinical trial. - `source` 'custom' | 'clinicaltrials.gov': Possible sources of a clinical trial. - `metadata` ClinicalTrialMetadata: Trial data which is of interest to the potential participant. - `phases` ClinicalTrialPhase[]: Phases which are relevant for the clinical trial. Each clinical trial can be in a certain phase or in multiple phases. - `studyType` 'interventional' | 'observational' | 'expandedAccess' | 'patientRegistries': Possible study types of a clinical trial. - `recruitmentStatus` 'unknownStatus' | 'notYetRecruiting' | 'recruiting' | 'enrollingByInvitation': Possible recruitment status of a clinical trial. - `conditions` string[], required: Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. - `sponsors` string[]: Sponsors/collaborators involved with the trial. - `contacts` ContactDetails[]: Contact details of the trial administrators, for patients that want to participate in the trial. - `name` string: The person's name. - `email` string: The person's email. - `phone` string: A person's phone number. - `facilities` ClinicalTrialResearchFacility[]: Research facilities where the clinical trial is conducted. - `name` string, required: The facility's name. - `city` string: City name. - `state` string: State name. - `countryOrRegion` string, required: Country/region name. - `neededClinicalInfo` ExtendedClinicalCodedElement[]: Clinical information which is needed to provide better trial matching results for the patient. - `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. - `semanticType` string: The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept. - `category` string: The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. - `modelVersion` string, required: The version of the model used for inference, expressed as the model date. - `knowledgeGraphLastUpdateDate` string, date: The date when the clinical trials knowledge graph was last updated. ## 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)