--- title: "Practitioner data model" url: "https://docs.unified.to/healthcare/practitioner/model" description: "The Practitioner data model object in Unified's Practitioner API: 19 fields, including created_at, updated_at and name, with types and enum values." --- # Practitioner data model View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/healthcare/integrations.md) page. | Field | Type | Required | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | id | string | No | Unique identifier for the practitioner | | created\_at | string (date-time) | No | When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | Full name of the practitioner | | first\_name | string | No | Given name of the practitioner | | last\_name | string | No | Family name of the practitioner | | title | string | No | Professional title or prefix (e.g. Dr.) | | gender | enum | No | Administrative gender of the practitioner Values: MALE, FEMALE, OTHER, UNKNOWN | | emails | [HealthcareEmail](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareEmail)\[\] | No | Email addresses of the practitioner | | emails\[\].email | string | Yes | | | emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | telephones | [HealthcareTelephone](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareTelephone)\[\] | No | Phone numbers of the practitioner | | telephones\[\].telephone | string | Yes | | | telephones\[\].type | enum | No | Values: WORK, HOME, MOBILE, FAX, OTHER | | address | object | No | Work address of the practitioner | | address.address1 | string | No | | | address.address2 | string | No | | | address.city | string | No | | | address.region | string | No | | | address.postal\_code | string | No | | | address.country | string | No | | | image\_url | string | No | Photo of the practitioner | | identifiers | [HealthcareIdentifier](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareIdentifier)\[\] | No | Business identifiers (e.g. NPI) | | identifiers\[\].value | string | Yes | The identifier value | | identifiers\[\].type | enum | No | The kind of identifier Values: MRN, NPI, SSN, DRIVERS\_LICENSE, PASSPORT, INSURANCE, OTHER | | identifiers\[\].system | string | No | The namespace/system URI that issued the identifier | | specialties | [HealthcareCode](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareCode)\[\] | No | Codings for the practitioner's specialties | | specialties\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | specialties\[\].code | string | No | The code within the system | | specialties\[\].display | string | No | Human-readable display text for the code | | qualifications | [HealthcareCode](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareCode)\[\] | No | Codings for certifications, licenses and degrees | | qualifications\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | qualifications\[\].code | string | No | The code within the system | | qualifications\[\].display | string | No | Human-readable display text for the code | | languages | string\[\] | No | Language codes the practitioner can communicate in | | location\_ids | string\[\] | No | Locations where the practitioner provides care | | is\_active | boolean | No | Whether the practitioner record is in active use | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/practitioner/model.md#HealthcareMetadata)\[\] | No | | | metadata\[\].id | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | | | metadata\[\].slug | string | No | | ## 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 ```typescript 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] ```