Condition data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the condition
created_atstring (date-time)NoWhen the condition record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the condition record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstringNoThe patient who has the condition
encounter_idstringNoThe encounter in which the condition was recorded
practitioner_idstringNoThe practitioner who recorded or asserted the condition
namestringNoHuman-readable name of the condition
codesHealthcareCode[]NoCodings for the condition (e.g. ICD-10, SNOMED CT)
codes[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
codes[].codestringNoThe code within the system
codes[].displaystringNoHuman-readable display text for the code
statusenumNoClinical status of the condition Values: ACTIVE, RECURRENCE, RELAPSE, INACTIVE, REMISSION, RESOLVED, OTHER
typeenumNoCategory of the condition Values: PROBLEM, DIAGNOSIS, HEALTH_CONCERN, OTHER
onset_atstring (date-time)NoWhen the condition began (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
resolved_atstring (date-time)NoWhen the condition resolved (abatement) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
recorded_atstring (date-time)NoWhen the condition was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstringNoFree-text notes about the condition
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 HealthcareCondition = {
	id?: string; // Unique identifier for the condition
	created_at?: string-time; // When the condition record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the condition record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	patient_id?: string; // The patient who has the condition
	encounter_id?: string; // The encounter in which the condition was recorded
	practitioner_id?: string; // The practitioner who recorded or asserted the condition
	name?: string; // Human-readable name of the condition
	codes?: []; // Codings for the condition (e.g. ICD-10, SNOMED CT)
	status?: 'ACTIVE' | 'RECURRENCE' | 'RELAPSE' | 'INACTIVE' | 'REMISSION' | 'RESOLVED' | 'OTHER'; // Clinical status of the condition
	type?: 'PROBLEM' | 'DIAGNOSIS' | 'HEALTH_CONCERN' | 'OTHER'; // Category of the condition
	onset_at?: string-time; // When the condition began (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	resolved_at?: string-time; // When the condition resolved (abatement) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	recorded_at?: string-time; // When the condition was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	notes?: string; // Free-text notes about the condition
	metadata?: [];
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcareCondition = z.object({
	id: z.string().optional().describe("Unique identifier for the condition"),
	created_at: z.string-time().optional().describe("When the condition record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the condition record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	patient_id: z.string().optional().describe("The patient who has the condition"),
	encounter_id: z.string().optional().describe("The encounter in which the condition was recorded"),
	practitioner_id: z.string().optional().describe("The practitioner who recorded or asserted the condition"),
	name: z.string().optional().describe("Human-readable name of the condition"),
	codes: z.array().optional().describe("Codings for the condition (e.g. ICD-10, SNOMED CT)"),
	status: z.enum("ACTIVE", "RECURRENCE", "RELAPSE", "INACTIVE", "REMISSION", "RESOLVED", "OTHER").optional().describe("Clinical status of the condition"),
	type: z.enum("PROBLEM", "DIAGNOSIS", "HEALTH_CONCERN", "OTHER").optional().describe("Category of the condition"),
	onset_at: z.string-time().optional().describe("When the condition began (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	resolved_at: z.string-time().optional().describe("When the condition resolved (abatement) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	recorded_at: z.string-time().optional().describe("When the condition was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	notes: z.string().optional().describe("Free-text notes about the condition"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HealthcareConditionStatus(str, Enum):
	ACTIVE = 'ACTIVE'
	RECURRENCE = 'RECURRENCE'
	RELAPSE = 'RELAPSE'
	INACTIVE = 'INACTIVE'
	REMISSION = 'REMISSION'
	RESOLVED = 'RESOLVED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class HealthcareConditionType(str, Enum):
	PROBLEM = 'PROBLEM'
	DIAGNOSIS = 'DIAGNOSIS'
	HEALTH_CONCERN = 'HEALTH_CONCERN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class HealthcareCondition:
	"""Unique identifier for the condition"""
	id: Optional[str]
	"""When the condition record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the condition record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The patient who has the condition"""
	patient_id: Optional[str]
	"""The encounter in which the condition was recorded"""
	encounter_id: Optional[str]
	"""The practitioner who recorded or asserted the condition"""
	practitioner_id: Optional[str]
	"""Human-readable name of the condition"""
	name: Optional[str]
	"""Codings for the condition (e.g. ICD-10, SNOMED CT)"""
	codes: Optional[PropertyHealthcareConditionCodes]
	"""Clinical status of the condition"""
	status: Optional[HealthcareConditionStatus]
	"""Category of the condition"""
	type: Optional[HealthcareConditionType]
	"""When the condition began (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	onset_at: Optional[str]
	"""When the condition resolved (abatement) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	resolved_at: Optional[str]
	"""When the condition was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	recorded_at: Optional[str]
	"""Free-text notes about the condition"""
	notes: Optional[str]
	metadata: Optional[PropertyHealthcareConditionMetadata]
Are we missing anything? Let us know
Was this page helpful?