Microsoft Azure TrialMatcher API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include TrialMatcher. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
4 operations
across 4 paths,
and defines 80 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
TrialMatcherPatientResult_2
object
The results of the model's work for a single patient.
3 properties
2 required
Azure.Core.Foundations.Error
object
The error object.
5 properties
2 required
Fhir.R4.ContactDetail
object
Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.htmlContactDetail)
2 properties
PatientInfo
object
Patient structured information, including demographics and known structured clinical information.
3 properties
TrialMatcherResult
object
The response for the Trial Matcher request.
7 properties
2 required
Fhir.R4.ContactPointSystem
string
Contact Point System see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html
GeoJsonType
string
GeoJSON type.
Fhir.R4.Identifier
object
An identifier intended for computation Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)
6 properties
TimePeriod
object
A duration of time during which an event is happening
2 properties
GeoJsonGeometryType
string
GeoJSON geometry type.
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
ContactDetails
object
A person's contact details.
3 properties
ClinicalTrialMetadata
object
Trial data which is of interest to the potential participant.
7 properties
1 required
TrialMatcherModelConfiguration
object
Configuration affecting the Trial Matcher model's inference.
3 properties
1 required
Fhir.R4.SampledData
object
A series of measurements taken by a device Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.htmlSampledData)
7 properties
3 required
Fhir.R4.DomainResource
object
A resource with narrative, extensions, and contained resources Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
5 properties
1 required
NeededClinicalInfo
array
Clinical information which is needed to provide better trial matching results for the patient.
TrialMatcherInferenceEvidence
object
A piece of evidence corresponding to a Trial Matcher inference.
4 properties
AreaProperties
object
GeoJSON object properties.
2 properties
2 required
DocumentContentSourceType
string
The type of the content's source. In case the source type is 'inline', the content is given as a string (for instance, text). In case the source type is 'refer…
TrialMatcherResult_2
object
The response for the Trial Matcher request.
7 properties
5 required
DocumentContent
object
The content of the patient document.
2 properties
2 required
OrderedProcedure
object
Procedure information
3 properties
Azure.Core.uuid
string
Universally Unique Identifier
Fhir.R4.fhirDateTime
string
Fhir.R4.Meta
object
Metadata about a resource Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.htmlMeta)
6 properties
Fhir.R4.ResearchStudyStatusCodeType
string
https://www.hl7.org/fhir/R4/codesystem-research-study-status.html
Fhir.R4.ContactPoint
object
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. See https://www.hl7.org/fhir/R4/data…
5 properties
PatientRecord
object
A patient record, including their clinical information and data.
4 properties
1 required
Fhir.R4.Coding
object
A Coding is a representation of a defined concept using a symbol from a defined "code system". Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.htm…
4 properties
AreaGeometry
object
GeoJSON geometry, representing the area circle's center.
2 properties
2 required
SpecialtyType
string
Known values codes that can be used to indicate the type of the Specialty.
GeographicLocation
object
A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region. In case a city is specified, either…
3 properties
1 required
ExtendedClinicalCodedElement
object
A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information.
6 properties
2 required
Fhir.R4.Range
object
A set of ordered Quantities defined by a low and high limit Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.htmlRange)
2 properties
TrialMatcherPatientResult
object
The results of the model's work for a single patient.
3 properties
2 required
ClinicalTrialSource
string
Possible sources of a clinical trial.
ClinicalTrialStudyType
string
Possible study types of a clinical trial.
DocumentAdministrativeMetadata
object
Document administrative metadata
2 properties
ClinicalNoteEvidence
object
A piece of evidence from a clinical note (text document).
4 properties
3 required
Fhir.R4.Ratio
object
A ratio of two Quantity values - a numerator and a denominator Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.htmlRatio)
2 properties
Fhir.R4.Quantity
object
A measured or measurable amount Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.htmlQuantity)
5 properties
TrialMatcherInference
object
An inference made by the Trial Matcher model regarding a patient.
8 properties
2 required
Fhir.R4.Resource
object
Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. Based on [FHIR Resou…
5 properties
1 required
TrialMatcherResults
object
The inference results for the Trial Matcher request.
3 properties
2 required
Fhir.R4.ResearchStudy
object
Detailed information about Research Study Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)
23 properties
1 required
JobStatus
string
The status of the processing job.
ClinicalTrialRecruitmentStatus
string
Possible recruitment status of a clinical trial.
Fhir.R4.Annotation
object
A text note which also contains information about who made the statement and when Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.htmlAnnotati…
3 properties
1 required
ClinicalCodedElement
object
A piece of clinical information, expressed as a code in a clinical coding system.
4 properties
2 required
ClinicalTrials
object
The clinical trials that the patient(s) should be matched to. The trial selection can be given as a list of custom clinical trials and/or a list of filters to…
2 properties
GeographicArea
object
A geographic area, expressed as a Circle geometry represented using a GeoJSON Feature (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)).
3 properties
3 required
Fhir.R4.Extension
object
Base for all elements Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.htmlElement)
13 properties
1 required
Fhir.R4.Reference
object
A reference from one resource to another Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)
4 properties
ModelVersion
string
The version of the model used for inference, expressed as the model date.
ClinicalTrialResearchFacility
object
Details of a research facility where a clinical trial is conducted.
4 properties
2 required
DocumentAuthor
object
Document author
2 properties
GeoJsonPropertiesSubType
string
GeoJSON object sub-type.
Fhir.R4.Element
object
The base definition for all elements contained inside a resource. Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)
2 properties
PatientInfoSex
string
The patient's sex.
ClinicalTrialPurpose
string
Possible purposes of a clinical trial.
DocumentType
string
The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).
EncounterClass
string
Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).
Fhir.R4.ContactPointUse
string
Contact Point Use See: http://hl7.org/fhir/ValueSet/contact-point-use
TrialMatcherData
object
The body of the Trial Matcher request.
2 properties
1 required
Fhir.R4.CodeableConcept
object
Concept - reference to a terminology or just text Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.htmlCodeableConcept)
2 properties
ClinicalDocumentType
string
The type of the clinical document.
TrialMatcherInference_2
object
An inference made by the Trial Matcher model regarding a patient.
8 properties
2 required
ClinicalTrialRegistryFilter
object
A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov).
11 properties
TrialMatcherInferenceType
string
The type of the Trial Matcher inference.
PatientDocument
object
A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).
9 properties
3 required
ClinicalTrialPhase
string
Possible phases of a clinical trial.
JobStatus_2
string
The status of the processing job.
Fhir.R4.fhirInstant
string
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property
1 required
Encounter
object
visit/encounter information
3 properties
1 required
Fhir.R4.Period
object
A time period defined by a start and end date and optionally time Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.htmlPeriod)
2 properties
Fhir.R4.Narrative
object
Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the res…
2 properties
2 required
TrialMatcherInferenceResult
object
The inference results for the Trial Matcher request.
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
