IntegrationTask

Last updated: 6 Jan 2026

Introduction #

The IntegrationTask and IntegrationTaskReview models represent incoming documents that need processing and their associated review assignments. Integration tasks include faxes, document uploads, lab results, and patient portal submissions.

Basic Usage #

To get an integration task by its identifier, use the get method on the IntegrationTask model manager:

from canvas_sdk.v1.data.integration_task import IntegrationTask

task = IntegrationTask.objects.get(id="d2194110-5c9a-4842-8733-ef09ea5ead11")

To get an integration task review:

from canvas_sdk.v1.data.integration_task import IntegrationTaskReview

review = IntegrationTaskReview.objects.get(id="c1a5a35a-4ee2-4a0e-85c0-21739dc8c4a8")

From a Patient object, integration tasks for the patient can be accessed with the integration_tasks attribute:

from canvas_sdk.v1.data.patient import Patient

patient = Patient.objects.get(id="36950971cb3e4174ad8b9d365abfd6d0")
tasks_for_patient = patient.integration_tasks.all()

Filtering #

Integration tasks and reviews can be filtered by any attribute that exists on the models. The models also provide convenient filter methods for common use cases.

By Status #

from canvas_sdk.v1.data.integration_task import IntegrationTask

unread_tasks = IntegrationTask.objects.unread()
pending_tasks = IntegrationTask.objects.pending_review()
processed_tasks = IntegrationTask.objects.processed()
error_tasks = IntegrationTask.objects.with_errors()
junked_tasks = IntegrationTask.objects.junked()
active_tasks = IntegrationTask.objects.not_junked()

By Channel #

from canvas_sdk.v1.data.integration_task import IntegrationTask

faxes = IntegrationTask.objects.faxes()
uploads = IntegrationTask.objects.uploads()
from_engine = IntegrationTask.objects.from_integration_engine()
from_portal = IntegrationTask.objects.from_patient_portal()

By Patient #

from canvas_sdk.v1.data.integration_task import IntegrationTask

patient_tasks = IntegrationTask.objects.for_patient("36950971cb3e4174ad8b9d365abfd6d0")
unread_faxes = IntegrationTask.objects.for_patient("36950971cb3e4174ad8b9d365abfd6d0").faxes().unread()

Filtering Reviews #

from canvas_sdk.v1.data.integration_task import IntegrationTaskReview

task_reviews = IntegrationTaskReview.objects.for_task("d2194110-5c9a-4842-8733-ef09ea5ead11")
active_reviews = IntegrationTaskReview.objects.active()
junked_reviews = IntegrationTaskReview.objects.junked()
reviewer_reviews = IntegrationTaskReview.objects.by_reviewer("staff-uuid-here")
team_reviews = IntegrationTaskReview.objects.by_team("team-uuid-here")

Attributes #