Trial Matcher - Get Job

Referenz

Dienst:: Cognitive Services

API-Version:: 2023-09-01-preview

Details zum Testabgleicherauftrag abrufen
Ruft die status und Details des Testabgleichsauftrags ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
id	path	True	string uuid	Ein Bezeichner für den Verarbeitungsauftrag.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	TrialMatcherResult	Die Anforderung wurde erfolgreich durchgeführt. Header Retry-After: integer
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Eine unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

TrialMatcherResult

Die Anforderung wurde erfolgreich durchgeführt.

Header

Retry-After: integer

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Eine unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Gets the status and details of the Trial Matcher job.

Beispielanforderung

HTTP

GET {endpoint}/health-insights/trial-matcher/jobs/a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754?api-version=2023-09-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754",
  "createdDateTime": "2021-11-28T09:13:11.046Z",
  "expirationDateTime": "2021-11-28T09:13:11.046Z",
  "lastUpdateDateTime": "2021-11-28T09:13:11.046Z",
  "status": "succeeded",
  "result": {
    "patientResults": [
      {
        "patientId": "Patient ID Example 2",
        "inferences": [
          {
            "type": "trialEligibility",
            "value": "Eligible",
            "description": "SwEaTB - Diagnosing of Acute Tuberculosis",
            "confidenceScore": 1,
            "evidence": [
              {
                "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis",
                "patientInfoEvidence": {
                  "system": "UMLS",
                  "code": "C0019046",
                  "name": "tuberculosis"
                },
                "importance": 1
              }
            ],
            "clinicalTrialId": "NCT03667742",
            "source": "clinicaltrials.gov",
            "metadata": {
              "phases": [
                "phase3"
              ],
              "studyType": "observational",
              "recruitmentStatus": "recruiting",
              "conditions": [
                "Tuberculosis"
              ],
              "sponsors": [
                "University Hospital, Basel, Switzerland"
              ],
              "contacts": [
                {
                  "name": "John Doe, PD Dr. Med",
                  "email": "John@contoso.com",
                  "phone": "+55-555-5555-55"
                }
              ],
              "facilities": [
                {
                  "name": "University Hospital, Basel",
                  "city": "Basel",
                  "countryOrRegion": "Switzerland"
                }
              ]
            }
          },
          {
            "type": "trialEligibility",
            "value": "Ineligible",
            "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)",
            "confidenceScore": 1,
            "evidence": [
              {
                "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot",
                "patientInfoEvidence": {
                  "system": "UMLS",
                  "code": "C0920508",
                  "name": "Enzyme-Linked Immunospot Assay",
                  "value": "30,000 PBMC cells per 10ul"
                },
                "importance": 1
              }
            ],
            "clinicalTrialId": "NCT03691883",
            "source": "clinicaltrials.gov"
          }
        ],
        "neededClinicalInfo": [
          {
            "system": "UMLS",
            "code": "C4317078",
            "name": "Mycobacterium Tuberculosis Measurement ",
            "semanticType": "Laboratory Procedure",
            "category": "EXAMINATION_NAME"
          },
          {
            "system": "UMLS",
            "code": "C0008031",
            "name": "Chest Pain",
            "semanticType": "Sign or Symptom",
            "category": "SYMPTOM_OR_SIGN"
          }
        ]
      }
    ],
    "modelVersion": "2021-10-28",
    "knowledgeGraphLastUpdateDate": "2021-11-26"
  }
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ClinicalCodedElement	Eine klinische Information, die in einem klinischen Codierungssystem als Code vorliegt.
ClinicalNoteEvidence	Ein Beweismaterial aus einer klinischen Notiz (Textdokument).
ClinicalTrialMetadata	Testdaten, die für den potenziellen Teilnehmer von Interesse sind.
ClinicalTrialPhase	Mögliche Phasen einer klinischen Studie.
ClinicalTrialRecruitmentStatus	Mögliche Rekrutierung status einer klinischen Studie.
ClinicalTrialResearchFacility	Details zu einer Forschungseinrichtung, in der eine klinische Studie durchgeführt wird.
ClinicalTrialSource	Mögliche Quellen einer klinischen Studie.
ClinicalTrialStudyType	Mögliche Studientypen einer klinischen Studie.
ContactDetails	Die Kontaktdaten einer Person.
ExtendedClinicalCodedElement	Eine klinische Information, ausgedrückt als Code in einem klinischen Codierungssystem, erweitert durch semantische Informationen.
JobStatus	Der Status des Verarbeitungsauftrags.
TrialMatcherInference	Ein Rückschluss des Trial Matcher-Modells auf einen Patienten.
TrialMatcherInferenceEvidence	Ein Beweis, der einem Testabgleicher-Rückschluss entspricht.
TrialMatcherInferenceResult	Die Rückschlussergebnisse für die Testabgleichsanforderung.
TrialMatcherInferenceType	Der Typ des Testabgleicher-Rückschlusses.
TrialMatcherPatientResult	Die Ergebnisse der Modellarbeit für einen einzelnen Patienten.
TrialMatcherResult	Die Antwort für die Testabgleichsanforderung.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

ClinicalCodedElement

Eine klinische Information, die in einem klinischen Codierungssystem als Code vorliegt.

Name	Typ	Beschreibung
code	string	Der Code innerhalb des verwendeten klinischen Codierungssystems.
name	string	Der Name dieses codierten Konzepts im Codierungssystem.
system	string	Das klinische Codierungssystem, z.B. ICD-10, SNOMED-CT, UMLS.
value	string	Ein Wert, der dem Code innerhalb des angegebenen klinischen Codierungssystems zugeordnet ist.

ClinicalNoteEvidence

Ein Beweismaterial aus einer klinischen Notiz (Textdokument).

Name	Typ	Beschreibung
id	string	Der Bezeichner des Dokuments, das den Beweis enthält.
length	integer	Die Länge der Beweistextspanne.
offset	integer	Der Anfangsindex des Beweistexts im Dokument (0 basierend).
text	string	Die tatsächliche Textspanne, die einen Beweis für den Rückschluss darstellt.

ClinicalTrialMetadata

Testdaten, die für den potenziellen Teilnehmer von Interesse sind.

Name	Typ	Beschreibung
conditions	string[]	Medizinische Bedingungen und ihre Synonyme, die für die klinische Studie relevant sind, werden als Zeichenfolgen angegeben.
contacts	ContactDetails[]	Kontaktdaten der Testadministratoren für Patienten, die an der Studie teilnehmen möchten.
facilities	ClinicalTrialResearchFacility[]	Forschungseinrichtungen, in denen die klinische Studie durchgeführt wird.
phases	ClinicalTrialPhase[]	Phasen, die für die klinische Prüfung relevant sind. Jede klinische Studie kann sich in einer bestimmten Phase oder in mehreren Phasen befinden.
recruitmentStatus	ClinicalTrialRecruitmentStatus	Mögliche Rekrutierung status einer klinischen Studie.
sponsors	string[]	Sponsoren/Mitarbeiter, die an der Testversion beteiligt sind.
studyType	ClinicalTrialStudyType	Mögliche Studientypen einer klinischen Studie.

ClinicalTrialPhase

Mögliche Phasen einer klinischen Studie.

Name	Typ	Beschreibung
earlyPhase1	string
notApplicable	string
phase1	string
phase2	string
phase3	string
phase4	string

ClinicalTrialRecruitmentStatus

Mögliche Rekrutierung status einer klinischen Studie.

Name	Typ	Beschreibung
enrollingByInvitation	string
notYetRecruiting	string
recruiting	string
unknownStatus	string

ClinicalTrialResearchFacility

Details zu einer Forschungseinrichtung, in der eine klinische Studie durchgeführt wird.

Name	Typ	Beschreibung
city	string	Ortsname.
countryOrRegion	string	Name des Landes/der Region.
name	string	Der Name der Einrichtung.
state	string	Statusname.

ClinicalTrialSource

Mögliche Quellen einer klinischen Studie.

Name	Typ	Beschreibung
clinicaltrials.gov	string
custom	string

ClinicalTrialStudyType

Mögliche Studientypen einer klinischen Studie.

Name	Typ	Beschreibung
expandedAccess	string
interventional	string
observational	string
patientRegistries	string

ContactDetails

Die Kontaktdaten einer Person.

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse der Person.
name	string	Der Name der Person.
phone	string	Telefonnummer einer Person.

ExtendedClinicalCodedElement

Eine klinische Information, ausgedrückt als Code in einem klinischen Codierungssystem, erweitert durch semantische Informationen.

Name	Typ	Beschreibung
category	string	Die Biografie-medizinische Kategorie bezogen auf das codierte Konzept, z. B. Diagnose, Symptom, Medikation, Untersuchung.
code	string	Der Code innerhalb des verwendeten klinischen Codierungssystems.
name	string	Der Name dieses codierten Konzepts im Codierungssystem.
semanticType	string	Der semantische UMLS-Typ , der dem codierten Konzept zugeordnet ist.
system	string	Das klinische Codierungssystem, z.B. ICD-10, SNOMED-CT, UMLS.
value	string	Ein Wert, der dem Code innerhalb des angegebenen klinischen Codierungssystems zugeordnet ist.

JobStatus

Der Status des Verarbeitungsauftrags.

Name	Typ	Beschreibung
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

TrialMatcherInference

Ein Rückschluss des Trial Matcher-Modells auf einen Patienten.

Name	Typ	Beschreibung
clinicalTrialId	string	Der Bezeichner der klinischen Studie.
confidenceScore	number	Konfidenzbewertung für diesen Rückschluss.
description	string	Die Beschreibung, die dem Rückschlusswert entspricht.
evidence	TrialMatcherInferenceEvidence[]	Der Beweis, der dem Rückschlusswert entspricht.
metadata	ClinicalTrialMetadata	Testdaten, die für den potenziellen Teilnehmer von Interesse sind.
source	ClinicalTrialSource	Mögliche Quellen einer klinischen Studie.
type	TrialMatcherInferenceType	Der Typ des Testabgleicher-Rückschlusses.
value	string	Der Wert des Rückschlusses, der für den angegebenen Rückschlusstyp relevant ist.

TrialMatcherInferenceEvidence

Ein Beweis, der einem Testabgleicher-Rückschluss entspricht.

Name	Typ	Beschreibung
eligibilityCriteriaEvidence	string	Ein Beweis aus dem Text der Zulassungskriterien einer klinischen Studie.
importance	number	Ein Wert, der angibt, wie wichtig dieser Beweis für den Rückschluss ist.
patientDataEvidence	ClinicalNoteEvidence	Ein Beweismaterial aus einer klinischen Notiz (Textdokument).
patientInfoEvidence	ClinicalCodedElement	Eine klinische Information, die in einem klinischen Codierungssystem als Code vorliegt.

TrialMatcherInferenceResult

Die Rückschlussergebnisse für die Testabgleichsanforderung.

Name	Typ	Beschreibung
knowledgeGraphLastUpdateDate	string	Das Datum, an dem das Wissensdiagramm für klinische Studien zuletzt aktualisiert wurde.
modelVersion	string	Die Version des modells, das für rückschlüsse verwendet wird, ausgedrückt als Modelldatum.
patientResults	TrialMatcherPatientResult[]	Ergebnisse für die in der Anfrage angegebenen Patienten.

TrialMatcherInferenceType

Der Typ des Testabgleicher-Rückschlusses.

Name	Typ	Beschreibung
trialEligibility	string

TrialMatcherPatientResult

Die Ergebnisse der Modellarbeit für einen einzelnen Patienten.

Name	Typ	Beschreibung
inferences	TrialMatcherInference[]	Der Rückschluss ergibt für den Patienten.
neededClinicalInfo	ExtendedClinicalCodedElement[]	Klinische Informationen, die benötigt werden, um dem Patienten bessere Ergebnisse für die Übereinstimmung der Studien zu liefern.
patientId	string	Der Bezeichner, der für den Patienten in der Anforderung angegeben wird.

TrialMatcherResult

Die Antwort für die Testabgleichsanforderung.

Name	Typ	Beschreibung
createdDateTime	string	Das Datum und die Uhrzeit, zu der der Verarbeitungsauftrag erstellt wurde.
error	Azure.Core.Foundations.Error	Fehlerobjekt, das den Fehler beschreibt, wenn status "Failed" ist.
expirationDateTime	string	Das Datum und die Uhrzeit, zu dem der Verarbeitungsauftrag abläuft.
id	string	Die eindeutige ID des Vorgangs.
lastUpdateDateTime	string	Das Datum und die Uhrzeit der letzten Aktualisierung des Verarbeitungsauftrags.
result	TrialMatcherInferenceResult	Das Ergebnis des Vorgangs.
status	JobStatus	Status des Vorgangs

Freigeben über

Trial Matcher - Get Job

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Gets the status and details of the Trial Matcher job.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ClinicalCodedElement

ClinicalNoteEvidence

ClinicalTrialMetadata

ClinicalTrialPhase

ClinicalTrialRecruitmentStatus

ClinicalTrialResearchFacility

ClinicalTrialSource

ClinicalTrialStudyType

ContactDetails

ExtendedClinicalCodedElement

JobStatus

TrialMatcherInference

TrialMatcherInferenceEvidence

TrialMatcherInferenceResult

TrialMatcherInferenceType

TrialMatcherPatientResult

TrialMatcherResult

Zusätzliche Ressourcen