Practitioner data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for the practitioner
created_atstring (date-time)NoWhen the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoFull name of the practitioner
first_namestringNoGiven name of the practitioner
last_namestringNoFamily name of the practitioner
titlestringNoProfessional title or prefix (e.g. Dr.)
genderenumNoAdministrative gender of the practitioner Values: MALE, FEMALE, OTHER, UNKNOWN
emailsHealthcareEmail[]NoEmail addresses of the practitioner
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesHealthcareTelephone[]NoPhone numbers of the practitioner
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, MOBILE, FAX, OTHER
addressobjectNoWork address of the practitioner
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.postal_codestringNo
address.countrystringNo
image_urlstringNoPhoto of the practitioner
identifiersHealthcareIdentifier[]NoBusiness identifiers (e.g. NPI)
identifiers[].valuestringYesThe identifier value
identifiers[].typeenumNoThe kind of identifier Values: MRN, NPI, SSN, DRIVERS_LICENSE, PASSPORT, INSURANCE, OTHER
identifiers[].systemstringNoThe namespace/system URI that issued the identifier
specialtiesHealthcareCode[]NoCodings for the practitioner's specialties
specialties[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
specialties[].codestringNoThe code within the system
specialties[].displaystringNoHuman-readable display text for the code
qualificationsHealthcareCode[]NoCodings for certifications, licenses and degrees
qualifications[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
qualifications[].codestringNoThe code within the system
qualifications[].displaystringNoHuman-readable display text for the code
languagesstring[]NoLanguage codes the practitioner can communicate in
location_idsstring[]NoLocations where the practitioner provides care
is_activebooleanNoWhether the practitioner record is in active use
metadataHealthcareMetadata[]No
metadata[].idstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo
metadata[].slugstringNo

TypeScript

TypeScript
export type HealthcarePractitioner = {
	id?: string; // Unique identifier for the practitioner
	created_at?: string-time; // When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Full name of the practitioner
	first_name?: string; // Given name of the practitioner
	last_name?: string; // Family name of the practitioner
	title?: string; // Professional title or prefix (e.g. Dr.)
	gender?: 'MALE' | 'FEMALE' | 'OTHER' | 'UNKNOWN'; // Administrative gender of the practitioner
	emails?: []; // Email addresses of the practitioner
	telephones?: []; // Phone numbers of the practitioner
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		postal_code?: string; 
		country?: string; 
	}; // Work address of the practitioner
	image_url?: string; // Photo of the practitioner
	identifiers?: []; // Business identifiers (e.g. NPI)
	specialties?: []; // Codings for the practitioner's specialties
	qualifications?: []; // Codings for certifications, licenses and degrees
	languages?: string[]; // Language codes the practitioner can communicate in
	location_ids?: string[]; // Locations where the practitioner provides care
	is_active?: boolean; // Whether the practitioner record is in active use
	metadata?: [];
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcarePractitioner = z.object({
	id: z.string().optional().describe("Unique identifier for the practitioner"),
	created_at: z.string-time().optional().describe("When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Full name of the practitioner"),
	first_name: z.string().optional().describe("Given name of the practitioner"),
	last_name: z.string().optional().describe("Family name of the practitioner"),
	title: z.string().optional().describe("Professional title or prefix (e.g. Dr.)"),
	gender: z.enum("MALE", "FEMALE", "OTHER", "UNKNOWN").optional().describe("Administrative gender of the practitioner"),
	emails: z.array().optional().describe("Email addresses of the practitioner"),
	telephones: z.array().optional().describe("Phone numbers of the practitioner"),
	address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional()
}).optional().describe("Work address of the practitioner"),
	image_url: z.string().optional().describe("Photo of the practitioner"),
	identifiers: z.array().optional().describe("Business identifiers (e.g. NPI)"),
	specialties: z.array().optional().describe("Codings for the practitioner's specialties"),
	qualifications: z.array().optional().describe("Codings for certifications, licenses and degrees"),
	languages: z.array().optional().describe("Language codes the practitioner can communicate in"),
	location_ids: z.array().optional().describe("Locations where the practitioner provides care"),
	is_active: z.boolean().optional().describe("Whether the practitioner record is in active use"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HealthcarePractitionerGender(str, Enum):
	MALE = 'MALE'
	FEMALE = 'FEMALE'
	OTHER = 'OTHER'
	UNKNOWN = 'UNKNOWN'

@dataclasses.dataclass
class PropertyHealthcarePractitionerAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]

@dataclasses.dataclass
class HealthcarePractitioner:
	"""Unique identifier for the practitioner"""
	id: Optional[str]
	"""When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Full name of the practitioner"""
	name: Optional[str]
	"""Given name of the practitioner"""
	first_name: Optional[str]
	"""Family name of the practitioner"""
	last_name: Optional[str]
	"""Professional title or prefix (e.g. Dr.)"""
	title: Optional[str]
	"""Administrative gender of the practitioner"""
	gender: Optional[HealthcarePractitionerGender]
	"""Email addresses of the practitioner"""
	emails: Optional[PropertyHealthcarePractitionerEmails]
	"""Phone numbers of the practitioner"""
	telephones: Optional[PropertyHealthcarePractitionerTelephones]
	"""Work address of the practitioner"""
	address: Optional[PropertyHealthcarePractitionerAddress]
	"""Photo of the practitioner"""
	image_url: Optional[str]
	"""Business identifiers (e.g. NPI)"""
	identifiers: Optional[PropertyHealthcarePractitionerIdentifiers]
	"""Codings for the practitioner's specialties"""
	specialties: Optional[PropertyHealthcarePractitionerSpecialties]
	"""Codings for certifications, licenses and degrees"""
	qualifications: Optional[PropertyHealthcarePractitionerQualifications]
	"""Language codes the practitioner can communicate in"""
	languages: Optional[List[List[str]]]
	"""Locations where the practitioner provides care"""
	location_ids: Optional[List[List[str]]]
	"""Whether the practitioner record is in active use"""
	is_active: Optional[bool]
	metadata: Optional[PropertyHealthcarePractitionerMetadata]
Are we missing anything? Let us know
Was this page helpful?