Practitioner data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations 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[] | No | Email addresses of the practitioner |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
telephones | 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[] | 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[] | 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[] | 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[] | 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 |
Are we missing anything? Let us know