Patient data model

Updated:

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the patient
created_atstring (date-time)NoWhen the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoFull name of the patient
first_namestringNoGiven name of the patient
last_namestringNoFamily name of the patient
genderenumNoAdministrative gender of the patient Values: MALE, FEMALE, OTHER, UNKNOWN
birthdatestringNoDate of birth (YYYY-MM-DD)
is_deceasedbooleanNoWhether the patient is deceased
deceased_atstring (date-time)NoWhen the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
emailsHealthcareEmail[]NoEmail addresses of the patient
emails[].emailstringYesThe email address
emails[].typeenumNoThe kind of email address (work, home or other) Values: WORK, HOME, OTHER
telephonesHealthcareTelephone[]NoPhone numbers of the patient
telephones[].telephonestringYesThe telephone number
telephones[].typeenumNoThe kind of telephone number (work, home, mobile, fax or other) Values: WORK, HOME, MOBILE, FAX, OTHER
addressobjectNoHome address of the patient
address.address1stringNoFirst line of the street address
address.address2stringNoSecond line of the street address
address.citystringNoCity or locality
address.regionstringNoRegional area (e.g., state in the U.S., province in Canada)
address.postal_codestringNoPostal or ZIP code
address.countrystringNoCountry
languagestringNoPreferred language code of the patient
identifiersHealthcareIdentifier[]NoBusiness identifiers (e.g. MRN)
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
practitioner_idsstring[]NoThe patient's primary care practitioners
is_activebooleanNoWhether the patient record is in active use
racesHealthcareCode[]NoCodings for the patient's race (e.g. CDC race codes)
races[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
races[].codestringNoThe code within the system
races[].displaystringNoHuman-readable display text for the code
ethnicitiesHealthcareCode[]NoCodings for the patient's ethnicity (e.g. CDC ethnicity codes)
ethnicities[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
ethnicities[].codestringNoThe code within the system
ethnicities[].displaystringNoHuman-readable display text for the code
marital_statusenumNoMarital status of the patient Values: MARRIED, SINGLE, DOMESTIC_PARTNER, SEPARATED, DIVORCED, WIDOWED, ANNULLED, UNKNOWN, OTHER
contactsHealthcarePatientContact[]NoEmergency contacts, guardians and other contact persons for the patient
contacts[].namestringNoFull name of the contact person
contacts[].relationshipstringNoRelationship of the contact to the patient (e.g. emergency contact, spouse)
contacts[].telephonesHealthcareTelephone[]NoPhone numbers of the contact person
contacts[].telephones[].telephonestringYesThe telephone number
contacts[].telephones[].typeenumNoThe kind of telephone number (work, home, mobile, fax or other) Values: WORK, HOME, MOBILE, FAX, OTHER
contacts[].emailsHealthcareEmail[]NoEmail addresses of the contact person
contacts[].emails[].emailstringYesThe email address
contacts[].emails[].typeenumNoThe kind of email address (work, home or other) Values: WORK, HOME, OTHER
contacts[].addressHealthcarePatientContact_addressNoPostal address of the contact person
contacts[].address.address1stringNoFirst line of the street address
contacts[].address.address2stringNoSecond line of the street address
contacts[].address.citystringNoCity or locality
contacts[].address.regionstringNoRegional area (e.g., state in the U.S., province in Canada)
contacts[].address.postal_codestringNoPostal or ZIP code
contacts[].address.countrystringNoCountry
metadataHealthcareMetadata[]NoCustom field values
metadata[].idstringNoIdentifier of the custom field
metadata[].valueobjectNoThe custom field value
metadata[].namespacestringNoThe scope or origin of the custom field
metadata[].formatenumNoThe data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNoAdditional data about the custom field
metadata[].slugstringNoThe custom field key

TypeScript

TypeScript
export type HealthcarePatient = {
	id?: string; // Unique identifier for the patient
	created_at?: string-time; // When the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Full name of the patient
	first_name?: string; // Given name of the patient
	last_name?: string; // Family name of the patient
	gender?: 'MALE' | 'FEMALE' | 'OTHER' | 'UNKNOWN'; // Administrative gender of the patient
	birthdate?: string; // Date of birth (YYYY-MM-DD)
	is_deceased?: boolean; // Whether the patient is deceased
	deceased_at?: string-time; // When the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	emails?: []; // Email addresses of the patient
	telephones?: []; // Phone numbers of the patient
	address?: {
		address1?: string; // First line of the street address 
		address2?: string; // Second line of the street address 
		city?: string; // City or locality 
		region?: string; // Regional area (e.g., state in the U.S., province in Canada) 
		postal_code?: string; // Postal or ZIP code 
		country?: string; // Country 
	}; // Home address of the patient
	language?: string; // Preferred language code of the patient
	identifiers?: []; // Business identifiers (e.g. MRN)
	practitioner_ids?: string[]; // The patient's primary care practitioners
	is_active?: boolean; // Whether the patient record is in active use
	races?: []; // Codings for the patient's race (e.g. CDC race codes)
	ethnicities?: []; // Codings for the patient's ethnicity (e.g. CDC ethnicity codes)
	marital_status?: 'MARRIED' | 'SINGLE' | 'DOMESTIC_PARTNER' | 'SEPARATED' | 'DIVORCED' | 'WIDOWED' | 'ANNULLED' | 'UNKNOWN' | 'OTHER'; // Marital status of the patient
	contacts?: []; // Emergency contacts, guardians and other contact persons for the patient
	metadata?: []; // Custom field values
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcarePatient = z.object({
	id: z.string().optional().describe("Unique identifier for the patient"),
	created_at: z.string-time().optional().describe("When the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Full name of the patient"),
	first_name: z.string().optional().describe("Given name of the patient"),
	last_name: z.string().optional().describe("Family name of the patient"),
	gender: z.enum("MALE", "FEMALE", "OTHER", "UNKNOWN").optional().describe("Administrative gender of the patient"),
	birthdate: z.string().optional().describe("Date of birth (YYYY-MM-DD)"),
	is_deceased: z.boolean().optional().describe("Whether the patient is deceased"),
	deceased_at: z.string-time().optional().describe("When the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	emails: z.array().optional().describe("Email addresses of the patient"),
	telephones: z.array().optional().describe("Phone numbers of the patient"),
	address: z.object({
			address1: z.string().optional().describe("First line of the street address"),
			address2: z.string().optional().describe("Second line of the street address"),
			city: z.string().optional().describe("City or locality"),
			region: z.string().optional().describe("Regional area (e.g., state in the U.S., province in Canada)"),
			postal_code: z.string().optional().describe("Postal or ZIP code"),
			country: z.string().optional().describe("Country")
}).optional().describe("Home address of the patient"),
	language: z.string().optional().describe("Preferred language code of the patient"),
	identifiers: z.array().optional().describe("Business identifiers (e.g. MRN)"),
	practitioner_ids: z.array().optional().describe("The patient's primary care practitioners"),
	is_active: z.boolean().optional().describe("Whether the patient record is in active use"),
	races: z.array().optional().describe("Codings for the patient's race (e.g. CDC race codes)"),
	ethnicities: z.array().optional().describe("Codings for the patient's ethnicity (e.g. CDC ethnicity codes)"),
	marital_status: z.enum("MARRIED", "SINGLE", "DOMESTIC_PARTNER", "SEPARATED", "DIVORCED", "WIDOWED", "ANNULLED", "UNKNOWN", "OTHER").optional().describe("Marital status of the patient"),
	contacts: z.array().optional().describe("Emergency contacts, guardians and other contact persons for the patient"),
	metadata: z.array().optional().describe("Custom field values"),

});

Python

Python
import dataclasses

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

@dataclasses.dataclass
class HealthcarePatientMarital_status(str, Enum):
	MARRIED = 'MARRIED'
	SINGLE = 'SINGLE'
	DOMESTIC_PARTNER = 'DOMESTIC_PARTNER'
	SEPARATED = 'SEPARATED'
	DIVORCED = 'DIVORCED'
	WIDOWED = 'WIDOWED'
	ANNULLED = 'ANNULLED'
	UNKNOWN = 'UNKNOWN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertyHealthcarePatientAddress:
	"""First line of the street address"""
	address1: Optional[str]
	"""Second line of the street address"""
	address2: Optional[str]
	"""City or locality"""
	city: Optional[str]
	"""Regional area (e.g., state in the U.S., province in Canada)"""
	region: Optional[str]
	"""Postal or ZIP code"""
	postal_code: Optional[str]
	"""Country"""
	country: Optional[str]

@dataclasses.dataclass
class HealthcarePatient:
	"""Unique identifier for the patient"""
	id: Optional[str]
	"""When the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Full name of the patient"""
	name: Optional[str]
	"""Given name of the patient"""
	first_name: Optional[str]
	"""Family name of the patient"""
	last_name: Optional[str]
	"""Administrative gender of the patient"""
	gender: Optional[HealthcarePatientGender]
	"""Date of birth (YYYY-MM-DD)"""
	birthdate: Optional[str]
	"""Whether the patient is deceased"""
	is_deceased: Optional[bool]
	"""When the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	deceased_at: Optional[str]
	"""Email addresses of the patient"""
	emails: Optional[PropertyHealthcarePatientEmails]
	"""Phone numbers of the patient"""
	telephones: Optional[PropertyHealthcarePatientTelephones]
	"""Home address of the patient"""
	address: Optional[PropertyHealthcarePatientAddress]
	"""Preferred language code of the patient"""
	language: Optional[str]
	"""Business identifiers (e.g. MRN)"""
	identifiers: Optional[PropertyHealthcarePatientIdentifiers]
	"""The patient's primary care practitioners"""
	practitioner_ids: Optional[List[List[str]]]
	"""Whether the patient record is in active use"""
	is_active: Optional[bool]
	"""Codings for the patient's race (e.g. CDC race codes)"""
	races: Optional[PropertyHealthcarePatientRaces]
	"""Codings for the patient's ethnicity (e.g. CDC ethnicity codes)"""
	ethnicities: Optional[PropertyHealthcarePatientEthnicities]
	"""Marital status of the patient"""
	marital_status: Optional[HealthcarePatientMarital_status]
	"""Emergency contacts, guardians and other contact persons for the patient"""
	contacts: Optional[PropertyHealthcarePatientContacts]
	"""Custom field values"""
	metadata: Optional[PropertyHealthcarePatientMetadata]
Are we missing anything? Let us know
Was this page helpful?