Location data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the location
created_atstring (date-time)NoWhen the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoName of the location
descriptionstringNoDescription of the location
parent_idstringNoThe location this one is part of (e.g. a department within a hospital)
organization_namestringNoName of the organization that manages the location
addressobjectNoPostal address of the location
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.postal_codestringNo
address.countrystringNo
telephonesHealthcareTelephone[]NoPhone and fax numbers for the location
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, MOBILE, FAX, OTHER
emailsHealthcareEmail[]NoEmail addresses for the location
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
latitudenumberNoLatitude of the location
longitudenumberNoLongitude of the location
identifiersHealthcareIdentifier[]NoBusiness identifiers for the location
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
is_activebooleanNoWhether the location 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 HealthcareLocation = {
	id?: string; // Unique identifier for the location
	created_at?: string-time; // When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Name of the location
	description?: string; // Description of the location
	parent_id?: string; // The location this one is part of (e.g. a department within a hospital)
	organization_name?: string; // Name of the organization that manages the location
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		postal_code?: string; 
		country?: string; 
	}; // Postal address of the location
	telephones?: []; // Phone and fax numbers for the location
	emails?: []; // Email addresses for the location
	latitude?: number; // Latitude of the location
	longitude?: number; // Longitude of the location
	identifiers?: []; // Business identifiers for the location
	is_active?: boolean; // Whether the location is in active use
	metadata?: [];
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcareLocation = z.object({
	id: z.string().optional().describe("Unique identifier for the location"),
	created_at: z.string-time().optional().describe("When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Name of the location"),
	description: z.string().optional().describe("Description of the location"),
	parent_id: z.string().optional().describe("The location this one is part of (e.g. a department within a hospital)"),
	organization_name: z.string().optional().describe("Name of the organization that manages the location"),
	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("Postal address of the location"),
	telephones: z.array().optional().describe("Phone and fax numbers for the location"),
	emails: z.array().optional().describe("Email addresses for the location"),
	latitude: z.number().optional().describe("Latitude of the location"),
	longitude: z.number().optional().describe("Longitude of the location"),
	identifiers: z.array().optional().describe("Business identifiers for the location"),
	is_active: z.boolean().optional().describe("Whether the location is in active use"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

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

@dataclasses.dataclass
class HealthcareLocation:
	"""Unique identifier for the location"""
	id: Optional[str]
	"""When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Name of the location"""
	name: Optional[str]
	"""Description of the location"""
	description: Optional[str]
	"""The location this one is part of (e.g. a department within a hospital)"""
	parent_id: Optional[str]
	"""Name of the organization that manages the location"""
	organization_name: Optional[str]
	"""Postal address of the location"""
	address: Optional[PropertyHealthcareLocationAddress]
	"""Phone and fax numbers for the location"""
	telephones: Optional[PropertyHealthcareLocationTelephones]
	"""Email addresses for the location"""
	emails: Optional[PropertyHealthcareLocationEmails]
	"""Latitude of the location"""
	latitude: Optional[int]
	"""Longitude of the location"""
	longitude: Optional[int]
	"""Business identifiers for the location"""
	identifiers: Optional[PropertyHealthcareLocationIdentifiers]
	"""Whether the location is in active use"""
	is_active: Optional[bool]
	metadata: Optional[PropertyHealthcareLocationMetadata]
Are we missing anything? Let us know
Was this page helpful?