Careplan data model

Updated:

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the care plan
created_atstring (date-time)NoWhen the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstringNoThe patient the care plan is for
encounter_idstringNoThe encounter in which the care plan was created
practitioner_idsstring[]NoThe practitioners who authored or contributed to the care plan
condition_idsstring[]NoConditions addressed by the care plan
goal_idsstring[]NoGoals the care plan is working towards
namestringNoTitle of the care plan
descriptionstringNoSummary of the care plan
codesHealthcareCode[]NoCodings for the kind of care plan (e.g. assessment and plan of treatment)
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
statusenumNoStatus of the care plan Values: DRAFT, ACTIVE, ON_HOLD, REVOKED, COMPLETED, ENTERED_IN_ERROR, UNKNOWN, OTHER
start_atstring (date-time)NoWhen the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)NoWhen the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstringNoFree-text notes about the care plan
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 HealthcareCareplan = {
	id?: string; // Unique identifier for the care plan
	created_at?: string-time; // When the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	patient_id?: string; // The patient the care plan is for
	encounter_id?: string; // The encounter in which the care plan was created
	practitioner_ids?: string[]; // The practitioners who authored or contributed to the care plan
	condition_ids?: string[]; // Conditions addressed by the care plan
	goal_ids?: string[]; // Goals the care plan is working towards
	name?: string; // Title of the care plan
	description?: string; // Summary of the care plan
	codes?: []; // Codings for the kind of care plan (e.g. assessment and plan of treatment)
	status?: 'DRAFT' | 'ACTIVE' | 'ON_HOLD' | 'REVOKED' | 'COMPLETED' | 'ENTERED_IN_ERROR' | 'UNKNOWN' | 'OTHER'; // Status of the care plan
	start_at?: string-time; // When the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // When the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	notes?: string; // Free-text notes about the care plan
	metadata?: []; // Custom field values
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcareCareplan = z.object({
	id: z.string().optional().describe("Unique identifier for the care plan"),
	created_at: z.string-time().optional().describe("When the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	patient_id: z.string().optional().describe("The patient the care plan is for"),
	encounter_id: z.string().optional().describe("The encounter in which the care plan was created"),
	practitioner_ids: z.array().optional().describe("The practitioners who authored or contributed to the care plan"),
	condition_ids: z.array().optional().describe("Conditions addressed by the care plan"),
	goal_ids: z.array().optional().describe("Goals the care plan is working towards"),
	name: z.string().optional().describe("Title of the care plan"),
	description: z.string().optional().describe("Summary of the care plan"),
	codes: z.array().optional().describe("Codings for the kind of care plan (e.g. assessment and plan of treatment)"),
	status: z.enum("DRAFT", "ACTIVE", "ON_HOLD", "REVOKED", "COMPLETED", "ENTERED_IN_ERROR", "UNKNOWN", "OTHER").optional().describe("Status of the care plan"),
	start_at: z.string-time().optional().describe("When the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("When the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	notes: z.string().optional().describe("Free-text notes about the care plan"),
	metadata: z.array().optional().describe("Custom field values"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HealthcareCareplanStatus(str, Enum):
	DRAFT = 'DRAFT'
	ACTIVE = 'ACTIVE'
	ON_HOLD = 'ON_HOLD'
	REVOKED = 'REVOKED'
	COMPLETED = 'COMPLETED'
	ENTERED_IN_ERROR = 'ENTERED_IN_ERROR'
	UNKNOWN = 'UNKNOWN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class HealthcareCareplan:
	"""Unique identifier for the care plan"""
	id: Optional[str]
	"""When the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The patient the care plan is for"""
	patient_id: Optional[str]
	"""The encounter in which the care plan was created"""
	encounter_id: Optional[str]
	"""The practitioners who authored or contributed to the care plan"""
	practitioner_ids: Optional[List[List[str]]]
	"""Conditions addressed by the care plan"""
	condition_ids: Optional[List[List[str]]]
	"""Goals the care plan is working towards"""
	goal_ids: Optional[List[List[str]]]
	"""Title of the care plan"""
	name: Optional[str]
	"""Summary of the care plan"""
	description: Optional[str]
	"""Codings for the kind of care plan (e.g. assessment and plan of treatment)"""
	codes: Optional[PropertyHealthcareCareplanCodes]
	"""Status of the care plan"""
	status: Optional[HealthcareCareplanStatus]
	"""When the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""When the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""Free-text notes about the care plan"""
	notes: Optional[str]
	"""Custom field values"""
	metadata: Optional[PropertyHealthcareCareplanMetadata]
Are we missing anything? Let us know
Was this page helpful?