Specialty Report Template

Last updated: 27 Feb 2026

Introduction #

The SpecialtyReportTemplate, SpecialtyReportTemplateField, and SpecialtyReportTemplateFieldOption models represent the templates used for specialty and referral reports. Templates define the structure of a specialty report, including what fields need to be filled in and what options are available for each field. Each template can be associated with a medical specialty via taxonomy codes.

Basic Usage #

To retrieve a SpecialtyReportTemplate by identifier, use the get method on the model manager:

from canvas_sdk.v1.data.specialty_report_template import SpecialtyReportTemplate

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

To access the fields defined in a template:

from canvas_sdk.v1.data.specialty_report_template import SpecialtyReportTemplate

template = SpecialtyReportTemplate.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.specialty_report_template import SpecialtyReportTemplate

active_templates = SpecialtyReportTemplate.objects.active()

By type #

from canvas_sdk.v1.data.specialty_report_template import SpecialtyReportTemplate

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

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

By specialty #

from canvas_sdk.v1.data.specialty_report_template import SpecialtyReportTemplate

# Filter by specialty taxonomy code
cardiology = SpecialtyReportTemplate.objects.by_specialty("207RC0000X")

By search #

from canvas_sdk.v1.data.specialty_report_template import SpecialtyReportTemplate

results = SpecialtyReportTemplate.objects.search("cardiology")

Attributes #