analysis_completed
The iframe fires analysis_completed after the image has been processed and the diagnostic report is available.
The iframe fires analysis_completed after the image has been processed and the diagnostic report is available.
Post an anonymous diagnostic report
Once the iframe posts an analysis_completed message, your backend uses the report identifier to fetch the full DiagnosticReport from the API.
The iframe URL accepts a number of query parameters that control its behaviour and appearance. This page is the canonical reference: every parameter the iframe supports is listed below, and each one is explained in detail in the sections that follow.
Get a diagnostic report
Once the iframe finishes processing an upload and emits the analysis_completed callback with the report identifier, your backend retrieves the diagnostic report on demand from the API. To obtain it as a FHIR-compliant payload, call the endpoint with the ?format=fhir parameter; see the API Endpoint page.
The most important feature of the API integration is receiving a DiagnosticReport with the information created by the Artificial Intelligence.
Besides getting the DiagnosticReports linked to patients between your system and our, you can also fetch the AnonymousDiagnosticReports that you had sent, ie, those which are not linked to any patient.
Interpreting the results requires careful consideration of the image quality and the context in which it was taken. By following the recommended guidelines, you can ensure more accurate and reliable results.
Two fields in the payload carry imagery for the case: macroscopicMedia at the top level of data (the lesion photo submitted for analysis, plus any detection annotations drawn over it), and result.observations (the array of every media that was actually sent to the algorithm for analysis).
The result field captures the diagnostic process output. Three sibling fields describe the classifier's behaviour for this case: performanceIndicators, clinicalIndicators, and analysisDuration.
The result field encapsulates the comprehensive results of the diagnostic process. Three subfields describe the classifier's behaviour for this case: metrics, preliminaryFindings, and iaSeconds.
Each completed analysis produces a downloadable PDF report that mirrors the on-screen UI. The PDF is intended for archival in EHR systems that expect document attachments and for sharing the report with parties outside the iframe session.
This page walks you through the minimum work required to embed the iframe in your application, run an analysis, and retrieve the resulting DiagnosticReport. Everything described here can be customised further; see the Configure → Customize page for the full parameter reference.
The scoringSystems field lives under result and houses one or more scoring models for the identified pathology. These models come into play when the likelihood of the most probable conclusion surpasses a certain threshold, and they are used to estimate the severity of that condition.
Once the iframe finishes processing an upload and emits the analysis_completed callback with the report identifier, your backend retrieves the diagnostic report on demand from the API. See the API Endpoint page for the request format.
The iframe returns a JSON payload through the analysis_completed callback, and the full diagnostic report can be pulled from the API using the anonymousDiagnosticReportId it carries. That JSON is the raw material your host application uses to drive workflows.