Business Line

Last updated: 8 Jul 2025

Introduction #

The BusinessLine model represents a group of Patients that share a common brand under an Organization.

Usage #

The BusinessLine model can be used to find all of the patients for a given Business Line:

>>> from canvas_sdk.v1.data import BusinessLine
>>> business_line = BusinessLine.objects.get(id="ff844d60Od18466698dc645PtYZ3019Tt")
>>> business_line_patients = business_line.patients.all()
>>> print([patient.first_name for patient in business_line_patients])
['George', 'Louise', 'Julia']

You can also access a patient’s Business Line from the Patient model:

>>> from canvas_sdk.v1.data import Patient
>>> patient_1 = Patient.objects.get(id="aebe4d3f5d18410388dc69c4b5169fc3")
>>> patient_business_line = patient_1.business_line
>>> print(patient_business_line.name)
'New Patients that love cheese'

And you can also access all of the Business Lines under a given Organization:

>>> from canvas_sdk.v1.data import Organization
>>> organization = Organization.objects.first()
>>> organization_business_lines = organization.business_lines.all()
>>> print([business_line.name for business_line in organization_business_lines])
['New Patients that love cheese', 'Spanish Speaking Patients', 'One Medical']

Filtering #

The filter method can be used to filter by desired attributes. The following examples show commonly used operations to filter Business Line data:

Show an Organization’s Business Lines that are active and in the 732 area code

>>> from canvas_sdk.v1.data import BusinessLine, Organization
>>> org = Organization.objects.first()
>>> active_732_business_lines = BusinessLine.objects.filter(organization=org, active=True, area_code="732")
>>> print([business_line.name for business_line in active_732_business_lines])
['Foo', 'Bar']

Attributes #

BusinessLine #

Field Name	Type
id	UUID
dbid	Integer
name	String
description	String
area_code	String
subdomain	String
active	Boolean
state	BusinessLineState
organization	Organization

Enumeration types #

BusinessLineState #

Value	Label
success	Success
pending	Pending
error	Deleted