Imaging Report Template

Last updated: 27 Feb 2026

Introduction #

The ImagingReportTemplate, ImagingReportTemplateField, and ImagingReportTemplateFieldOption models represent the templates used for imaging reports. Templates define the structure of an imaging report, including what fields need to be filled in and what options are available for each field.

Basic Usage #

To retrieve an ImagingReportTemplate by identifier, use the get method on the model manager:

from canvas_sdk.v1.data.imaging import ImagingReportTemplate

template = ImagingReportTemplate.objects.get(id="d2194110-5c9a-4842-8733-ef09ea5ead11")

To access the fields defined in a template:

from canvas_sdk.v1.data.imaging import ImagingReportTemplate

template = ImagingReportTemplate.objects.get(id="d2194110-5c9a-4842-8733-ef09ea5ead11")
fields = template.fields.all()

Filtering #

Templates can be filtered by any attribute on the models.

By active status #

from canvas_sdk.v1.data.imaging import ImagingReportTemplate

active_templates = ImagingReportTemplate.objects.active()

By type #

from canvas_sdk.v1.data.imaging import ImagingReportTemplate

# Get custom (user-created) templates
custom = ImagingReportTemplate.objects.custom()

# Get built-in (system) templates
builtin = ImagingReportTemplate.objects.builtin()

By search #

from canvas_sdk.v1.data.imaging import ImagingReportTemplate

results = ImagingReportTemplate.objects.search("chest x-ray")

Attributes #