Radiology Insights - Create Job

Create Radiology Insights job
Creates a Radiology Insights job with the given request body.

PUT {endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01
PUT {endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01&expand={expand}

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

The unique ID of the job.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$

api-version
query True

string

The API version to use for this operation.

expand
query

string[]

Expand the indicated resources into the response.

Request Body

Name Type Description
jobData

RadiologyInsightsData

The request data for the operation.

Responses

Name Type Description
200 OK

RadiologyInsightsJob

The request has succeeded.

Headers

  • Operation-Location: string
  • x-ms-request-id: string
201 Created

RadiologyInsightsJob

The request has succeeded and a new resource has been created as a result.

Headers

  • Operation-Location: string
  • x-ms-request-id: string
Other Status Codes

HealthInsightsErrorResponse

An unexpected error response.

Headers

  • x-ms-error-code: string
  • x-ms-request-id: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure Cognitive Services subscription.

Type: apiKey
In: header

EntraIdToken

The Microsoft Entra Id Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Creates a Radiology Insights job with the given request body.

Sample request

PUT {endpoint}/health-insights/radiology-insights/jobs/ad28aef5-87f3-4d2d-97eb-5cdeb4519d12?api-version=2024-04-01/health-insights/radiology-insights/jobs/ad28aef5-87f3-4d2d-97eb-5cdeb4519d12?api-version=2024-04-01&expand={expand}

{
  "jobData": {
    "configuration": {
      "inferenceOptions": {
        "followupRecommendationOptions": {
          "includeRecommendationsWithNoSpecifiedModality": false,
          "includeRecommendationsInReferences": false,
          "provideFocusedSentenceEvidence": false
        },
        "findingOptions": {
          "provideFocusedSentenceEvidence": false
        }
      },
      "inferenceTypes": [
        "finding",
        "ageMismatch",
        "lateralityDiscrepancy",
        "sexMismatch",
        "completeOrderDiscrepancy",
        "limitedOrderDiscrepancy",
        "criticalResult",
        "criticalRecommendation",
        "followupRecommendation",
        "followupCommunication",
        "radiologyProcedure"
      ],
      "locale": "en-US",
      "verbose": false,
      "includeEvidence": true
    },
    "patients": [
      {
        "id": "sample id 1",
        "details": {
          "sex": "male",
          "clinicalInfo": [
            {
              "resourceType": "Observation",
              "status": "unknown",
              "code": {
                "coding": [
                  {
                    "system": "http://www.nlm.nih.gov/research/umls",
                    "code": "C0018802",
                    "display": "MalignantNeoplasms"
                  }
                ]
              },
              "valueBoolean": "true"
            }
          ]
        },
        "encounters": [
          {
            "id": "encounterid1",
            "period": {
              "start": "2023-12-21T00:00:00",
              "end": "2023-12-21T00:00:00"
            },
            "class": "inpatient"
          }
        ],
        "patientDocuments": [
          {
            "type": "note",
            "clinicalType": "radiologyReport",
            "id": "docid1",
            "language": "en",
            "authors": [
              {
                "id": "authorid1",
                "fullName": "authorname1"
              }
            ],
            "specialtyType": "radiology",
            "createdAt": "2023-12-21T00:00:00",
            "administrativeMetadata": {
              "orderedProcedures": [
                {
                  "code": {
                    "coding": [
                      {
                        "system": "Http://hl7.org/fhir/ValueSet/cpt-all",
                        "code": "111111",
                        "display": "CT ABD/PELVIS"
                      }
                    ]
                  },
                  "description": "CT ABD/PELVIS"
                }
              ],
              "encounterId": "encounterid1"
            },
            "content": {
              "sourceType": "inline",
              "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C                                Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION:  History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors.  Also reported hematocrit\r\ndrop.  Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON:  Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE:  MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast.  A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST:  Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen.  Evaluation\r\nof the segmental and subsegmental branches is limited.  There is a central\r\nvenous catheter that terminates in the right atrium.  There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement.  There are coronary artery calcifications.  There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis.  The images of the lungs are limited due to motion.  There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right.  The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST:  There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study.  New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage.  Perinephric stranding is present, as was seen on the previous\r\nstudy.  The degree of dilatation of the left ureter is unchanged.  Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature.  Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion.  No active extravasation of contrast is seen.  The right\r\nkidney is normal.  The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm.  There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143).  Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C                                Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable.  The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST:  The prostate gland is\r\nenlarged.  Thickening of the bladder wall is again demonstrated.  Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter.  The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS:  There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1.  New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2.  Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis.  Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3.  Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen.  Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4.  Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5.  5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n"
            }
          }
        ]
      }
    ]
  }
}

Sample response

x-ms-request-id: c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a
Operation-Location: {endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01
{
  "status": "notStarted",
  "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12"
}
x-ms-request-id: c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a
Operation-Location: {endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01
{
  "status": "notStarted",
  "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12"
}

Definitions

Name Description
AgeMismatchInference

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.

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.

ClinicalDocumentType

The type of the clinical document.

CompleteOrderDiscrepancyInference

A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.

CriticalResult

Critical Result consists of two properties.

CriticalResultInference

Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.

DocumentAdministrativeMetadata

Document administrative metadata

DocumentAuthor

Document author

DocumentContent

The content of the patient document.

DocumentContentSourceType

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 'reference', the content is given as a URI.

DocumentType

The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).

EncounterClass

Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).

Fhir.R4.Annotation

A text note which also contains information about who made the statement and when Based on FHIR Annotation

Fhir.R4.CodeableConcept

Concept - reference to a terminology or just text Based on FHIR CodeableConcept

Fhir.R4.Coding

A Coding is a representation of a defined concept using a symbol from a defined "code system". Based on FHIR Coding

Fhir.R4.Extension

Base for all elements Based on FHIR Element

Fhir.R4.Identifier

An identifier intended for computation Based on FHIR Identifier

Fhir.R4.Meta

Metadata about a resource Based on FHIR Meta

Fhir.R4.Narrative

Any resource that is a DomainResource may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human. Based on FHIR Narrative

Fhir.R4.Observation

Detailed information about observations Based on FHIR Observation

Fhir.R4.ObservationComponent

Component results Based on FHIR Observation.component

Fhir.R4.ObservationReferenceRange

Provides guide for interpretation of component result Based on FHIR Observation.referenceRange

Fhir.R4.Period

A time period defined by a start and end date and optionally time Based on FHIR Period

Fhir.R4.Quantity

A measured or measurable amount Based on FHIR Quantity

Fhir.R4.Range

A set of ordered Quantities defined by a low and high limit Based on FHIR Range

Fhir.R4.Ratio

A ratio of two Quantity values - a numerator and a denominator Based on FHIR Ratio

Fhir.R4.Reference

A reference from one resource to another Based on FHIR Reference

Fhir.R4.Resource

Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html

Fhir.R4.SampledData

A series of measurements taken by a device Based on FHIR SampledData

FindingInference

Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.

FindingOptions

Finding options.

FollowupCommunicationInference

Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.

FollowupRecommendationInference

Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.

FollowupRecommendationOptions

Follow-up recommendation options.

GenericProcedureRecommendation

Generic procedure information.

HealthInsightsErrorResponse

A response containing error details.

ImagingProcedure

Imaging procedure.

ImagingProcedureRecommendation

Imaging procedures.

JobStatus

The status of the processing job.

LateralityDiscrepancyInference

A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).

LateralityDiscrepancyType

Laterality discrepancy type

LimitedOrderDiscrepancyInference

A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.

MedicalProfessionalType

Medical Professional Type

ObservationStatusCodeType

registered | preliminary | final | amended +

OrderedProcedure

Procedure information

PatientDetails

Patient structured information, including demographics and known structured clinical information.

PatientDocument

A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).

PatientEncounter

visit/encounter information

PatientRecord

A patient record, including their clinical information and data.

PatientSex

The patient's sex.

RadiologyCodeWithTypes

Radiology code with types : used in imaging procedure recommendation for contrast and view.

RadiologyInsightsData

Contains the list of patients, and configuration data.

RadiologyInsightsInferenceOptions

Options regarding follow up recommendation inferences and finding inferences.

RadiologyInsightsInferenceResult

The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.

RadiologyInsightsInferenceType

A Radiology Insights inference types.

RadiologyInsightsJob

Response for the Radiology Insights request.

RadiologyInsightsModelConfiguration

Configuration affecting the Radiology Insights model's inference.

RadiologyInsightsPatientResult

Results of the model's work for a single patient.

RadiologyProcedureInference

Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.

RecommendationFinding

Finding reference for recommendation.

RecommendationFindingStatusType

Recommendation finding status

SexMismatchInference

A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.

SpecialtyType

Known values codes that can be used to indicate the type of the Specialty.

TimePeriod

A duration of time during which an event is happening

AgeMismatchInference

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.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

ageMismatch

Discriminator property for RadiologyInsightsInference.

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.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.

ClinicalDocumentType

The type of the clinical document.

Name Type Description
consultation

string

dischargeSummary

string

historyAndPhysical

string

laboratory

string

pathologyReport

string

procedure

string

progress

string

radiologyReport

string

CompleteOrderDiscrepancyInference

A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

completeOrderDiscrepancy

Discriminator property for RadiologyInsightsInference.

missingBodyPartMeasurements

Fhir.R4.CodeableConcept[]

List of missing body parts that require measurement by a complete order : SNOMED CT codes.

missingBodyParts

Fhir.R4.CodeableConcept[]

List of missing body parts required by a complete order : SNOMED CT codes.

orderType

Fhir.R4.CodeableConcept

Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast.

CriticalResult

Critical Result consists of two properties.

Name Type Description
description

string

Description : medical problem.

finding

Fhir.R4.Observation

Finding linked to the critical result.

CriticalResultInference

Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

criticalResult

Discriminator property for RadiologyInsightsInference.

result

CriticalResult

The complete Critical Result, as outlined below, will be reused for the recommendation.

DocumentAdministrativeMetadata

Document administrative metadata

Name Type Description
encounterId

string

Reference to the encounter associated with the document.

orderedProcedures

OrderedProcedure[]

List of procedure information associated with the document.

DocumentAuthor

Document author

Name Type Description
fullName

string

Text representation of the full name

id

string

author id

DocumentContent

The content of the patient document.

Name Type Description
sourceType

DocumentContentSourceType

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 'reference', the content is given as a URI.

value

string

The content of the document, given either inline (as a string) or as a reference (URI).

DocumentContentSourceType

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 'reference', the content is given as a URI.

Name Type Description
inline

string

The content is given as a string (for instance, text).

reference

string

The content is given as a URI.

DocumentType

The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).

Name Type Description
dicom

string

fhirBundle

string

genomicSequencing

string

note

string

EncounterClass

Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).

Name Type Description
ambulatory

string

The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter.

emergency

string

A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility.

healthHome

string

Healthcare encounter that takes place in the residence of the patient or a designee

inpatient

string

A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service.

observation

string

An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge.

virtual

string

A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication.

Fhir.R4.Annotation

A text note which also contains information about who made the statement and when Based on FHIR Annotation

Name Type Description
authorString

string

Individual responsible for the annotation

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

text

string

The annotation - text content (as markdown)

time

string

When the annotation was made

Fhir.R4.CodeableConcept

Concept - reference to a terminology or just text Based on FHIR CodeableConcept

Name Type Description
coding

Fhir.R4.Coding[]

Code defined by a terminology system

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

text

string

Plain text representation of the concept

Fhir.R4.Coding

A Coding is a representation of a defined concept using a symbol from a defined "code system". Based on FHIR Coding

Name Type Description
code

string

Symbol in syntax defined by the system

display

string

Representation defined by the system

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

system

string

Identity of the terminology system

version

string

Version of the system - if relevant

Fhir.R4.Extension

Base for all elements Based on FHIR Element

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

url

string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean

boolean

Value as boolean

valueCodeableConcept

Fhir.R4.CodeableConcept

Value as CodeableConcept

valueDateTime

string

Value as dateTime.

valueInteger

integer

Value as integer

valuePeriod

Fhir.R4.Period

Value as Period.

valueQuantity

Fhir.R4.Quantity

Value as Quantity

valueRange

Fhir.R4.Range

Value as Range.

valueRatio

Fhir.R4.Ratio

Value as Ratio.

valueReference

Fhir.R4.Reference

Value as reference.

valueSampledData

Fhir.R4.SampledData

Value as SampledData.

valueString

string

Value as string

valueTime

string

Value as time (hh:mm:ss)

Fhir.R4.Identifier

An identifier intended for computation Based on FHIR Identifier

Name Type Description
assigner

Fhir.R4.Reference

Organization that issued id (may be just text)

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

period

Fhir.R4.Period

Time period when id is/was valid for use

system

string

The namespace for the identifier value

type

Fhir.R4.CodeableConcept

Description of identifier

use

string

usual | official | temp | secondary | old (If known)

value

string

The value that is unique

Fhir.R4.Meta

Metadata about a resource Based on FHIR Meta

Name Type Description
lastUpdated

string

When the resource last changed - e.g. when the version changed.

profile

string[]

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

security

Fhir.R4.Coding[]

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

source

string

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

tag

Fhir.R4.Coding[]

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

versionId

string

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Fhir.R4.Narrative

Any resource that is a DomainResource may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human. Based on FHIR Narrative

Name Type Description
div

string

xhtml

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

status

string

generated, extensions, additional, empty

Fhir.R4.Observation

Detailed information about observations Based on FHIR Observation

Name Type Description
bodySite

Fhir.R4.CodeableConcept

Observed body part

category

Fhir.R4.CodeableConcept[]

Classification of type of observation

code

Fhir.R4.CodeableConcept

Type of observation (code / type)

component

Fhir.R4.ObservationComponent[]

Component results

contained

Fhir.R4.Resource[]

Contained, inline Resources

dataAbsentReason

Fhir.R4.CodeableConcept

Why the result is missing

derivedFrom

Fhir.R4.Reference[]

Related measurements the observation is made from

effectiveDateTime

string

Clinically relevant time/time-period for observation

effectiveInstant

string

Clinically relevant time/time-period for observation

effectivePeriod

Fhir.R4.Period

Clinically relevant time/time-period for observation

encounter

Fhir.R4.Reference

Healthcare event during which this observation is made

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

hasMember

Fhir.R4.Reference[]

Related resource that belongs to the Observation group

id

string

Resource Id

identifier

Fhir.R4.Identifier[]

Business Identifier for observation

implicitRules

string

A set of rules under which this content was created

interpretation

Fhir.R4.CodeableConcept[]

High, low, normal, etc.

issued

string

Date/Time this version was made available

language

string

Language of the resource content

meta

Fhir.R4.Meta

Metadata about the resource

method

Fhir.R4.CodeableConcept

How it was done

modifierExtension

Fhir.R4.Extension[]

Extensions that cannot be ignored

note

Fhir.R4.Annotation[]

Comments about the observation

referenceRange

Fhir.R4.ObservationReferenceRange[]

Provides guide for interpretation

resourceType string:

Observation

Discriminator property for DomainResource.

status

ObservationStatusCodeType

registered | preliminary | final | amended +

subject

Fhir.R4.Reference

Who and/or what the observation is about

text

Fhir.R4.Narrative

Text summary of the resource, for human interpretation

valueBoolean

boolean

Actual result

valueCodeableConcept

Fhir.R4.CodeableConcept

Actual result

valueDateTime

string

Actual result

valueInteger

integer

Actual result

valuePeriod

Fhir.R4.Period

Actual result

valueQuantity

Fhir.R4.Quantity

Actual result

valueRange

Fhir.R4.Range

Actual result

valueRatio

Fhir.R4.Ratio

Actual result

valueSampledData

Fhir.R4.SampledData

Actual result

valueString

string

Actual result

valueTime

string

Actual result

Fhir.R4.ObservationComponent

Component results Based on FHIR Observation.component

Name Type Description
code

Fhir.R4.CodeableConcept

Type of component observation (code / type)

dataAbsentReason

Fhir.R4.CodeableConcept

Why the component result is missing

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

interpretation

Fhir.R4.CodeableConcept[]

High, low, normal, etc.

referenceRange

Fhir.R4.ObservationReferenceRange[]

Provides guide for interpretation of component result

valueBoolean

boolean

Value as boolean

valueCodeableConcept

Fhir.R4.CodeableConcept

Value as CodeableConcept

valueDateTime

string

Value as dateTime.

valueInteger

integer

Value as integer

valuePeriod

Fhir.R4.Period

Value as Period.

valueQuantity

Fhir.R4.Quantity

Value as Quantity

valueRange

Fhir.R4.Range

Value as Range.

valueRatio

Fhir.R4.Ratio

Value as Ratio.

valueReference

Fhir.R4.Reference

Value as reference.

valueSampledData

Fhir.R4.SampledData

Value as SampledData.

valueString

string

Value as string

valueTime

string

Value as time (hh:mm:ss)

Fhir.R4.ObservationReferenceRange

Provides guide for interpretation of component result Based on FHIR Observation.referenceRange

Name Type Description
age

Fhir.R4.Range

Applicable age range, if relevant

appliesTo

Fhir.R4.CodeableConcept[]

Reference range population

high

Fhir.R4.Quantity

High Range, if relevant

low

Fhir.R4.Quantity

Low Range, if relevant

text

string

Text based reference range in an observation

type

Fhir.R4.CodeableConcept

Reference range qualifier

Fhir.R4.Period

A time period defined by a start and end date and optionally time Based on FHIR Period

Name Type Description
end

string

End time with inclusive boundary, if not ongoing

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

start

string

Starting time with inclusive boundary

Fhir.R4.Quantity

A measured or measurable amount Based on FHIR Quantity

Name Type Description
code

string

Coded form of the unit

comparator

string

< | <= | >= | > - how to understand the value

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

system

string

System that defines coded unit form

unit

string

Unit representation

value

number

Numerical value (with implicit precision)

Fhir.R4.Range

A set of ordered Quantities defined by a low and high limit Based on FHIR Range

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

high

Fhir.R4.Quantity

High limit

id

string

Unique id for inter-element referencing

low

Fhir.R4.Quantity

Low limit

Fhir.R4.Ratio

A ratio of two Quantity values - a numerator and a denominator Based on FHIR Ratio

Name Type Description
denominator

Fhir.R4.Quantity

Denominator value

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

numerator

Fhir.R4.Quantity

Numerator value

Fhir.R4.Reference

A reference from one resource to another Based on FHIR Reference

Name Type Description
display

string

Text alternative for the resource

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

id

string

Unique id for inter-element referencing

identifier

Fhir.R4.Identifier

Logical reference, when literal reference is not known

reference

string

Literal reference, Relative, internal or absolute URL

type

string

Type the reference refers to (e.g. "Patient")

Fhir.R4.Resource

Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html

Name Type Description
id

string

Resource Id

implicitRules

string

A set of rules under which this content was created

language

string

Language of the resource content

meta

Fhir.R4.Meta

Metadata about the resource

resourceType

string

The type of resource

Fhir.R4.SampledData

A series of measurements taken by a device Based on FHIR SampledData

Name Type Description
data

string

Decimal values with spaces, or "E" | "U" | "L"

dimensions

integer

Number of sample points at each time point

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

factor

number

Multiply data by this before adding to origin

id

string

Unique id for inter-element referencing

lowerLimit

number

Lower limit of detection

origin

Fhir.R4.Quantity

Zero value and units

period

number

Number of milliseconds between samples

upperLimit

number

Upper limit of detection

FindingInference

Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

finding

Fhir.R4.Observation

Finding data : contains extensions, fields and components linked with the finding.

kind string:

finding

Discriminator property for RadiologyInsightsInference.

FindingOptions

Finding options.

Name Type Description
provideFocusedSentenceEvidence

boolean

If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false.

FollowupCommunicationInference

Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.

Name Type Description
communicatedAt

string[]

Communication date and time.

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

followupCommunication

Discriminator property for RadiologyInsightsInference.

recipient

MedicalProfessionalType[]

Recipient of the communication.

wasAcknowledged

boolean

Communication was acknowledged.

FollowupRecommendationInference

Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.

Name Type Description
effectiveAt

string

Date and time are displayed when the procedure is recommended to be done at a specific point in time.

effectivePeriod

Fhir.R4.Period

The period is shown if a specific period is mentioned, with a start and end date-time.

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

findings

RecommendationFinding[]

Findings related to the recommendation.

isConditional

boolean

The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on.

isGuideline

boolean

The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings.

isHedging

boolean

Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on.

isOption

boolean

The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on.

kind string:

followupRecommendation

Discriminator property for RadiologyInsightsInference.

recommendedProcedure ProcedureRecommendation:

The procedure recommendation can be a generic procedure or an imaging procedure.

FollowupRecommendationOptions

Follow-up recommendation options.

Name Type Description
includeRecommendationsInReferences

boolean

Include/Exclude follow-up recommendations in references to a guideline or article. Default is false.

includeRecommendationsWithNoSpecifiedModality

boolean

Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false.

provideFocusedSentenceEvidence

boolean

If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false.

GenericProcedureRecommendation

Generic procedure information.

Name Type Description
code

Fhir.R4.CodeableConcept

Procedure modality : SNOMED CT code.

description

string

Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT.

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

genericProcedureRecommendation

Discriminator property for ProcedureRecommendation.

HealthInsightsErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

ImagingProcedure

Imaging procedure.

Name Type Description
anatomy

Fhir.R4.CodeableConcept

Anatomy : SNOMED CT code.

contrast

RadiologyCodeWithTypes

Contrast : see RadiologyCodeWithTypes (below).

laterality

Fhir.R4.CodeableConcept

Laterality : SNOMED CT code.

modality

Fhir.R4.CodeableConcept

Modality : SNOMED CT code.

view

RadiologyCodeWithTypes

View : see RadiologyCodeWithTypes (below).

ImagingProcedureRecommendation

Imaging procedures.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

imagingProcedures

ImagingProcedure[]

Imaging procedures.

kind string:

imagingProcedureRecommendation

Discriminator property for ProcedureRecommendation.

procedureCodes

Fhir.R4.CodeableConcept[]

LOINC codes for the procedure.

JobStatus

The status of the processing job.

Name Type Description
canceled

string

failed

string

notStarted

string

running

string

succeeded

string

LateralityDiscrepancyInference

A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).

Name Type Description
discrepancyType

LateralityDiscrepancyType

Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing.

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

lateralityDiscrepancy

Discriminator property for RadiologyInsightsInference.

lateralityIndication

Fhir.R4.CodeableConcept

Laterality indication : SNOMED CT code for laterality qualifier value.

LateralityDiscrepancyType

Laterality discrepancy type

Name Type Description
orderLateralityMismatch

string

Mismatch between order and text

textLateralityContradiction

string

Contradiction in text

textLateralityMissing

string

Missing laterality in text

LimitedOrderDiscrepancyInference

A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

limitedOrderDiscrepancy

Discriminator property for RadiologyInsightsInference.

orderType

Fhir.R4.CodeableConcept

Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast.

presentBodyPartMeasurements

Fhir.R4.CodeableConcept[]

List of body parts that are measured according to the document : SNOMED CT codes.

presentBodyParts

Fhir.R4.CodeableConcept[]

List of body parts found in the document : SNOMED CT codes.

MedicalProfessionalType

Medical Professional Type

Name Type Description
doctor

string

Doctor medical professional type

midwife

string

Technician medical professional type

nurse

string

Nurse medical professional type

physicianAssistant

string

Technician medical professional type

unknown

string

Unknown medical professional type

ObservationStatusCodeType

registered | preliminary | final | amended +

Name Type Description
amended

string

Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.

cancelled

string

The observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted").

corrected

string

Subsequent to being Final, the observation has been modified to correct an error in the test result.

entered-in-error

string

The observation has been withdrawn following previous final release.

final

string

The observation is complete and verified by an authorized person.

preliminary

string

This is an initial or interim observation: data may be incomplete or unverified.

registered

string

The existence of the observation is registered, but there is no result yet available.

unknown

string

The observation status is unknown. Note that "unknown" is a value of last resort and every attempt should be made to provide a meaningful value other than "unknown".

OrderedProcedure

Procedure information

Name Type Description
code

Fhir.R4.CodeableConcept

Procedure code

description

string

Procedure description

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

PatientDetails

Patient structured information, including demographics and known structured clinical information.

Name Type Description
birthDate

string

The patient's date of birth.

clinicalInfo

Fhir.R4.Resource[]

Known clinical information for the patient, structured.

sex

PatientSex

The patient's sex.

PatientDocument

A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).

Name Type Description
administrativeMetadata

DocumentAdministrativeMetadata

Administrative metadata for the document.

authors

DocumentAuthor[]

Document author(s)

clinicalType

ClinicalDocumentType

The type of the clinical document.

content

DocumentContent

The content of the patient document.

createdAt

string

The date and time when the document was created.

id

string

A given identifier for the document. Has to be unique across all documents for a single patient.

language

string

A 2 letter ISO 639-1 representation of the language of the document.

specialtyType

SpecialtyType

specialty type the document

type

DocumentType

The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).

PatientEncounter

visit/encounter information

Name Type Description
class

EncounterClass

The class of the encounter.

id

string

The id of the visit.

period

TimePeriod

Time period of the visit. In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time.

PatientRecord

A patient record, including their clinical information and data.

Name Type Description
details

PatientDetails

Patient structured information, including demographics and known structured clinical information.

encounters

PatientEncounter[]

Patient encounters/visits.

id

string

A given identifier for the patient. Has to be unique across all patients in a single request.

patientDocuments

PatientDocument[]

Patient unstructured clinical data, given as documents.

PatientSex

The patient's sex.

Name Type Description
female

string

male

string

unspecified

string

RadiologyCodeWithTypes

Radiology code with types : used in imaging procedure recommendation for contrast and view.

Name Type Description
code

Fhir.R4.CodeableConcept

The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views.

types

Fhir.R4.CodeableConcept[]

The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc.

RadiologyInsightsData

Contains the list of patients, and configuration data.

Name Type Description
configuration

RadiologyInsightsModelConfiguration

Configuration affecting the Radiology Insights model's inference.

patients

PatientRecord[]

The list of patients, including their clinical information and data.

RadiologyInsightsInferenceOptions

Options regarding follow up recommendation inferences and finding inferences.

Name Type Description
findingOptions

FindingOptions

Finding options.

followupRecommendationOptions

FollowupRecommendationOptions

Follow-up recommendation options.

RadiologyInsightsInferenceResult

The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.

Name Type Description
modelVersion

string

The version of the model used for inference, expressed as the model date.

patientResults

RadiologyInsightsPatientResult[]

Results for the patients given in the request.

RadiologyInsightsInferenceType

A Radiology Insights inference types.

Name Type Description
ageMismatch

string

Age mismatch inference type

completeOrderDiscrepancy

string

Complete order discrepancy inference type

criticalResult

string

Critical finding inference type

finding

string

Finding inference type

followupCommunication

string

Followup Communication inference type

followupRecommendation

string

Recommendation inference type

lateralityDiscrepancy

string

Laterality discrepancy inference type

limitedOrderDiscrepancy

string

Limited order discrepancy inference type

radiologyProcedure

string

Radiology Procedure inference type

sexMismatch

string

Sex mismatch inference type

RadiologyInsightsJob

Response for the Radiology Insights request.

Name Type Description
createdAt

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".

expiresAt

string

The date and time when the processing job is set to expire.

id

string

The unique ID of the job.

jobData

RadiologyInsightsData

The request data for the operation.

result

RadiologyInsightsInferenceResult

The result of the operation.

status

JobStatus

The status of the job.

updatedAt

string

The date and time when the processing job was last updated.

RadiologyInsightsModelConfiguration

Configuration affecting the Radiology Insights model's inference.

Name Type Default value Description
includeEvidence

boolean

True

An indication whether the model's output should include evidence for the inferences.

inferenceOptions

RadiologyInsightsInferenceOptions

Options regarding follow up recommendation inferences and finding inferences.

inferenceTypes

RadiologyInsightsInferenceType[]

This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types.

locale

string

Local for the model to use. If not specified, the model will use the default locale.

verbose

boolean

False

An indication whether the model should produce verbose output.

RadiologyInsightsPatientResult

Results of the model's work for a single patient.

Name Type Description
inferences RadiologyInsightsInference[]:

The model's inferences for the given patient.

patientId

string

Identifier given for the patient in the request.

RadiologyProcedureInference

Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

imagingProcedures

ImagingProcedure[]

Imaging procedures.

kind string:

radiologyProcedure

Discriminator property for RadiologyInsightsInference.

orderedProcedure

OrderedProcedure

Ordered procedure information from the document information or text.

procedureCodes

Fhir.R4.CodeableConcept[]

LOINC codes for the procedure.

RecommendationFinding

Finding reference for recommendation.

Name Type Description
criticalFinding

CriticalResult

Critical result linked to a recommendation.

extension

Fhir.R4.Extension[]

Additional Content defined by implementations

finding

Fhir.R4.Observation

Finding linked to a recommendation.

recommendationFindingStatus

RecommendationFindingStatusType

Recommendation finding status.

RecommendationFindingStatusType

Recommendation finding status

Name Type Description
conditional

string

Conditional finding status

differential

string

Differential finding status

present

string

Present finding status

ruleOut

string

Rule out finding status

SexMismatchInference

A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.

Name Type Description
extension

Fhir.R4.Extension[]

Additional Content defined by implementations

kind string:

sexMismatch

Discriminator property for RadiologyInsightsInference.

sexIndication

Fhir.R4.CodeableConcept

Sex indication : SNOMED CT code for gender finding.

SpecialtyType

Known values codes that can be used to indicate the type of the Specialty.

Name Type Description
pathology

string

pathology

radiology

string

radiology

TimePeriod

A duration of time during which an event is happening

Name Type Description
end

string

End time with inclusive boundary, if not ongoing

start

string

Starting time with inclusive boundary