Microsoft Azure Ai Health Insights

swagger: '2.0'
info:
  title: Microsoft Azure Azure AI Health Insights
  version: 2023-09-01-preview
  description: >-
    Azure AI Health Insights provides an API that serves insight models,
    specific for Health & Life Sciences, that perform analysis and provide
    inferences to be used by a human.
  x-typespec-generated:
    - emitter: '@azure-tools/typespec-autorest'
schemes:
  - https
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/health-insights'
  useSchemePrefix: false
  parameters:
    - name: endpoint
      in: path
      description: >-
        Supported Cognitive Services endpoints (protocol and hostname, for
        example: https://westus2.api.cognitive.microsoft.com).
      required: true
      type: string
      format: uri
      x-ms-skip-url-encoding: true
produces:
  - application/json
consumes:
  - application/json
security:
  - ApiKeyAuth: []
securityDefinitions:
  ApiKeyAuth:
    type: apiKey
    name: Ocp-Apim-Subscription-Key
    in: header
tags:
  - name: OncoPhenotype
  - name: PatientTimeline
  - name: RadiologyInsights
  - name: TrialMatcher
paths:
  /onco-phenotype/jobs:
    post:
      operationId: microsoftAzureOncophenotypeCreatejob
      tags:
        - OncoPhenotype
      summary: Microsoft Azure Create Onco Phenotype Job
      description: Creates an Onco Phenotype job with the given request body.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/OncoPhenotypeData'
      responses:
        '202':
          description: >-
            The request has been accepted for processing, but processing has not
            yet completed.
          schema:
            type: object
            description: Provides status details for long running operations.
            properties:
              id:
                $ref: '#/definitions/Azure.Core.uuid'
                description: The unique ID of the operation.
                readOnly: true
              status:
                $ref: '#/definitions/JobStatus'
                description: The status of the operation
                readOnly: true
              createdDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was created.
                readOnly: true
              expirationDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job is set to expire.
                readOnly: true
              lastUpdateDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was last updated.
                readOnly: true
              error:
                $ref: '#/definitions/Azure.Core.Foundations.Error'
                description: Error object that describes the error when status is "Failed".
              result:
                $ref: '#/definitions/OncoPhenotypeInferenceResult'
                description: The result of the operation.
            required:
              - id
              - status
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location for monitoring the operation state.
            Repeatability-Result:
              type: string
              description: >-
                Indicates whether the repeatable request was accepted or
                rejected.
              enum:
                - accepted
                - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                  - name: accepted
                    value: accepted
                    description: >-
                      If the request was accepted and the server guarantees that
                      the server state reflects a single execution of the
                      operation.
                  - name: rejected
                    value: rejected
                    description: >-
                      If the request was rejected because the combination of
                      Repeatability-First-Sent and Repeatability-Request-ID were
                      invalid

                      or because the Repeatability-First-Sent value was outside
                      the range of values held by the server.
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates an Onco Phenotype job with the given request body.:
          $ref: ./examples/SuccessfulOncoPhenotypeRequest.json
      x-ms-long-running-operation: true
  /onco-phenotype/jobs/{id}:
    get:
      operationId: microsoftAzureOncophenotypeGetjob
      tags:
        - OncoPhenotype
      summary: Microsoft Azure Get Onco Phenotype Job Details
      description: Gets the status and details of the Onco Phenotype job.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: id
          in: path
          description: A processing job identifier.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/OncoPhenotypeResult'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets the status and details of the Onco Phenotype job.:
          $ref: ./examples/SuccessfulOncoPhenotypeResponse.json
  /patient-timeline/jobs:
    post:
      operationId: microsoftAzurePatienttimelineCreatejob
      tags:
        - PatientTimeline
      summary: Microsoft Azure Create Patient Timeline Job
      description: Creates a Patient Timeline job with the given request body.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/PatientTimelineData'
      responses:
        '202':
          description: >-
            The request has been accepted for processing, but processing has not
            yet completed.
          schema:
            type: object
            description: Provides status details for long running operations.
            properties:
              id:
                $ref: '#/definitions/Azure.Core.uuid'
                description: The unique ID of the operation.
                readOnly: true
              status:
                $ref: '#/definitions/JobStatus'
                description: The status of the operation
                readOnly: true
              createdDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was created.
                readOnly: true
              expirationDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job is set to expire.
                readOnly: true
              lastUpdateDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was last updated.
                readOnly: true
              error:
                $ref: '#/definitions/Azure.Core.Foundations.Error'
                description: Error object that describes the error when status is "Failed".
              result:
                $ref: '#/definitions/PatientTimelineInferenceResult'
                description: The result of the operation.
            required:
              - id
              - status
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location for monitoring the operation state.
            Repeatability-Result:
              type: string
              description: >-
                Indicates whether the repeatable request was accepted or
                rejected.
              enum:
                - accepted
                - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                  - name: accepted
                    value: accepted
                    description: >-
                      If the request was accepted and the server guarantees that
                      the server state reflects a single execution of the
                      operation.
                  - name: rejected
                    value: rejected
                    description: >-
                      If the request was rejected because the combination of
                      Repeatability-First-Sent and Repeatability-Request-ID were
                      invalid

                      or because the Repeatability-First-Sent value was outside
                      the range of values held by the server.
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates a Patient Timeline job with the given request body.:
          $ref: ./examples/SuccessfulPatientTimelineRequest.json
      x-ms-long-running-operation: true
  /patient-timeline/jobs/{id}:
    get:
      operationId: microsoftAzurePatienttimelineGetjob
      tags:
        - PatientTimeline
      summary: Microsoft Azure Get Patient Timeline Job Details
      description: Gets the status and details of the Patient Timeline job.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: id
          in: path
          description: A processing job identifier.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PatientTimelineResult'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets the status and details of the Patient Timeline job.:
          $ref: ./examples/SuccessfulPatientTimelineResponse.json
  /radiology-insights/jobs:
    post:
      operationId: microsoftAzureRadiologyinsightsCreatejob
      tags:
        - RadiologyInsights
      summary: Microsoft Azure Create Radiology Insights Job
      description: Creates a Radiology Insights job with the given request body.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/RadiologyInsightsData'
      responses:
        '202':
          description: >-
            The request has been accepted for processing, but processing has not
            yet completed.
          schema:
            type: object
            description: Provides status details for long running operations.
            properties:
              id:
                $ref: '#/definitions/Azure.Core.uuid'
                description: The unique ID of the operation.
                readOnly: true
              status:
                $ref: '#/definitions/JobStatus'
                description: The status of the operation
                readOnly: true
              createdDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was created.
                readOnly: true
              expirationDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job is set to expire.
                readOnly: true
              lastUpdateDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was last updated.
                readOnly: true
              error:
                $ref: '#/definitions/Azure.Core.Foundations.Error'
                description: Error object that describes the error when status is "Failed".
              result:
                $ref: '#/definitions/RadiologyInsightsInferenceResult'
                description: The result of the operation.
            required:
              - id
              - status
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location for monitoring the operation state.
            Repeatability-Result:
              type: string
              description: >-
                Indicates whether the repeatable request was accepted or
                rejected.
              enum:
                - accepted
                - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                  - name: accepted
                    value: accepted
                    description: >-
                      If the request was accepted and the server guarantees that
                      the server state reflects a single execution of the
                      operation.
                  - name: rejected
                    value: rejected
                    description: >-
                      If the request was rejected because the combination of
                      Repeatability-First-Sent and Repeatability-Request-ID were
                      invalid

                      or because the Repeatability-First-Sent value was outside
                      the range of values held by the server.
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates a Radiology Insights job with the given request body.:
          $ref: ./examples/SuccessfulRadiologyInsightsRequest.json
      x-ms-long-running-operation: true
  /radiology-insights/jobs/{id}:
    get:
      operationId: microsoftAzureRadiologyinsightsGetjob
      tags:
        - RadiologyInsights
      summary: Microsoft Azure Get Radiology Insights Job Details
      description: Gets the status and details of the Radiology Insights job.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: id
          in: path
          description: A processing job identifier.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RadiologyInsightsResult'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets the status and details of the Radiology Insights job.:
          $ref: ./examples/SuccessfulRadiologyInsightsResponse.json
  /trial-matcher/jobs:
    post:
      operationId: microsoftAzureTrialmatcherCreatejob
      tags:
        - TrialMatcher
      summary: Microsoft Azure Create Trial Matcher Job
      description: Creates a Trial Matcher job with the given request body.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId
        - $ref: >-
            #/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/TrialMatcherData'
      responses:
        '202':
          description: >-
            The request has been accepted for processing, but processing has not
            yet completed.
          schema:
            type: object
            description: Provides status details for long running operations.
            properties:
              id:
                $ref: '#/definitions/Azure.Core.uuid'
                description: The unique ID of the operation.
                readOnly: true
              status:
                $ref: '#/definitions/JobStatus'
                description: The status of the operation
                readOnly: true
              createdDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was created.
                readOnly: true
              expirationDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job is set to expire.
                readOnly: true
              lastUpdateDateTime:
                type: string
                format: date-time
                description: The date and time when the processing job was last updated.
                readOnly: true
              error:
                $ref: '#/definitions/Azure.Core.Foundations.Error'
                description: Error object that describes the error when status is "Failed".
              result:
                $ref: '#/definitions/TrialMatcherInferenceResult'
                description: The result of the operation.
            required:
              - id
              - status
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location for monitoring the operation state.
            Repeatability-Result:
              type: string
              description: >-
                Indicates whether the repeatable request was accepted or
                rejected.
              enum:
                - accepted
                - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                  - name: accepted
                    value: accepted
                    description: >-
                      If the request was accepted and the server guarantees that
                      the server state reflects a single execution of the
                      operation.
                  - name: rejected
                    value: rejected
                    description: >-
                      If the request was rejected because the combination of
                      Repeatability-First-Sent and Repeatability-Request-ID were
                      invalid

                      or because the Repeatability-First-Sent value was outside
                      the range of values held by the server.
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates a Trial Matcher job with the given request body.:
          $ref: ./examples/SuccessfulTrialMatcherRequest.json
      x-ms-long-running-operation: true
  /trial-matcher/jobs/{id}:
    get:
      operationId: microsoftAzureTrialmatcherGetjob
      tags:
        - TrialMatcher
      summary: Microsoft Azure Get Trial Matcher Job Details
      description: Gets the status and details of the Trial Matcher job.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: id
          in: path
          description: A processing job identifier.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TrialMatcherResult'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: >-
                The Retry-After header can indicate how long the client should
                wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets the status and details of the Trial Matcher job.:
          $ref: ./examples/SuccessfulTrialMatcherResponse.json
definitions:
  AgeMismatchInference:
    type: object
    description: >-
      A notification for age mismatch is displayed when the age mentioned in a
      document for a specific patient does not match the age specified in the
      patient information.
    allOf:
      - $ref: '#/definitions/RadiologyInsightsInference'
    x-ms-discriminator-value: ageMismatch
  AreaGeometry:
    type: object
    description: '`GeoJSON` geometry, representing the area circle''s center.'
    properties:
      type:
        $ref: '#/definitions/GeoJsonGeometryType'
        description: '`GeoJSON` geometry type.'
      coordinates:
        type: array
        description: >-
          Coordinates of the area circle's center, represented according to the
          `GeoJSON` standard.

          This is an array of 2 decimal numbers, longitude and latitude
          (precisely in this order).
        minItems: 2
        maxItems: 2
        items:
          type: number
          format: float
    required:
      - type
      - coordinates
  AreaProperties:
    type: object
    description: '`GeoJSON` object properties.'
    properties:
      subType:
        $ref: '#/definitions/GeoJsonPropertiesSubType'
        description: '`GeoJSON` object sub-type.'
      radius:
        type: number
        format: double
        description: The radius of the area's circle, in meters.
    required:
      - subType
      - radius
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: >-
          An array of details about specific errors that led to this reported
          error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: >-
          An object containing more specific information than the current object
          about the error.
    required:
      - code
      - message
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
      - error
  Azure.Core.Foundations.InnerError:
    type: object
    description: >-
      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.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  ClinicalCodedElement:
    type: object
    description: >-
      A piece of clinical information, expressed as a code in a clinical coding
      system.
    properties:
      system:
        type: string
        description: The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.
      code:
        type: string
        description: The code within the given clinical coding system.
      name:
        type: string
        description: The name of this coded concept in the coding system.
      value:
        type: string
        description: >-
          A value associated with the code within the given clinical coding
          system.
    required:
      - system
      - code
  ClinicalDocumentType:
    type: string
    description: The type of the clinical document.
    enum:
      - consultation
      - dischargeSummary
      - historyAndPhysical
      - radiologyReport
      - procedure
      - progress
      - laboratory
      - pathologyReport
    x-ms-enum:
      name: ClinicalDocumentType
      modelAsString: true
      values:
        - name: Consultation
          value: consultation
        - name: DischargeSummary
          value: dischargeSummary
        - name: HistoryAndPhysical
          value: historyAndPhysical
        - name: RadiologyReport
          value: radiologyReport
        - name: Procedure
          value: procedure
        - name: Progress
          value: progress
        - name: Laboratory
          value: laboratory
        - name: PathologyReport
          value: pathologyReport
  ClinicalNoteEvidence:
    type: object
    description: A piece of evidence from a clinical note (text document).
    properties:
      id:
        type: string
        description: The identifier of the document containing the evidence.
      text:
        type: string
        description: The actual text span which is evidence for the inference.
      offset:
        type: integer
        format: int32
        description: The start index of the evidence text span in the document (0 based).
        minimum: 0
      length:
        type: integer
        format: int32
        description: The length of the evidence text span.
        minimum: 1
    required:
      - id
      - offset
      - length
  ClinicalTrialMetadata:
    type: object
    description: Trial data which is of interest to the potential participant.
    properties:
      phases:
        type: array
        description: |-
          Phases which are relevant for the clinical trial.
          Each clinical trial can be in a certain phase or in multiple phases.
        items:
          $ref: '#/definitions/ClinicalTrialPhase'
      studyType:
        $ref: '#/definitions/ClinicalTrialStudyType'
        description: Possible study types of a clinical trial.
      recruitmentStatus:
        $ref: '#/definitions/ClinicalTrialRecruitmentStatus'
        description: Possible recruitment status of a clinical trial.
      conditions:
        type: array
        description: >-
          Medical conditions and their synonyms which are relevant for the
          clinical trial, given as strings.
        minItems: 1
        items:
          type: string
      sponsors:
        type: array
        description: Sponsors/collaborators involved with the trial.
        items:
          type: string
      contacts:
        type: array
        description: >-
          Contact details of the trial administrators, for patients that want to
          participate in the trial.
        items:
          $ref: '#/definitions/ContactDetails'
        x-ms-identifiers: []
      facilities:
        type: array
        description: Research facilities where the clinical trial is conducted.
        items:
          $ref: '#/definitions/ClinicalTrialResearchFacility'
        x-ms-identifiers: []
    required:
      - conditions
  ClinicalTrialPhase:
    type: string
    description: Possible phases of a clinical trial.
    enum:
      - notApplicable
      - earlyPhase1
      - phase1
      - phase2
      - phase3
      - phase4
    x-ms-enum:
      name: ClinicalTrialPhase
      modelAsString: true
      values:
        - name: NotApplicable
          value: notApplicable
        - name: EarlyPhase1
          value: earlyPhase1
        - name: Phase1
          value: phase1
        - name: Phase2
          value: phase2
        - name: Phase3
          value: phase3
        - name: Phase4
          value: phase4
  ClinicalTrialPurpose:
    type: string
    description: Possible purposes of a clinical trial.
    enum:
      - notApplicable
      - screening
      - diagnostic
      - prevention
      - healthServicesResearch
      - treatment
      - deviceFeasibility
      - supportiveCare
      - basicScience
      - other
    x-ms-enum:
      name: ClinicalTrialPurpose
      modelAsString: true
      values:
        - name: NotApplicable
          value: notApplicable
        - name: Screening
          value: screening
        - name: Diagnostic
          value: diagnostic
        - name: Prevention
          value: prevention
        - name: HealthServicesResearch
          v

# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-ai-health-insights-openapi-original.yml