--- title: "Careplan data model" url: "https://docs.unified.to/healthcare/careplan/model" description: "The Careplan data model object in Unified's Careplan API: 16 fields, including created_at, updated_at and patient_id, with types and enum values." date: "2026-10-24T20:36:42.560Z" updated: "2026-10-24T20:36:42.560Z" --- # Careplan data model Updated: October 24, 2026 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/healthcare/integrations.md) page. | Field | Type | Required | Description | | ------------------------ | ------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the care plan | | created\_at | string (date-time) | No | When the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient the care plan is for | | encounter\_id | string | No | The encounter in which the care plan was created | | practitioner\_ids | string\[\] | No | The practitioners who authored or contributed to the care plan | | condition\_ids | string\[\] | No | Conditions addressed by the care plan | | goal\_ids | string\[\] | No | Goals the care plan is working towards | | name | string | No | Title of the care plan | | description | string | No | Summary of the care plan | | codes | [HealthcareCode](https://docs.unified.to/healthcare/careplan/model.md#HealthcareCode)\[\] | No | Codings for the kind of care plan (e.g. assessment and plan of treatment) | | codes\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | codes\[\].code | string | No | The code within the system | | codes\[\].display | string | No | Human-readable display text for the code | | status | enum | No | Status of the care plan Values: DRAFT, ACTIVE, ON\_HOLD, REVOKED, COMPLETED, ENTERED\_IN\_ERROR, UNKNOWN, OTHER | | start\_at | string (date-time) | No | When the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | When the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | notes | string | No | Free-text notes about the care plan | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/careplan/model.md#HealthcareMetadata)\[\] | No | Custom field values | | metadata\[\].id | string | No | Identifier of the custom field | | metadata\[\].value | object | No | The custom field value | | metadata\[\].namespace | string | No | The scope or origin of the custom field | | metadata\[\].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | Additional data about the custom field | | metadata\[\].slug | string | No | The 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 ```typescript 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] ```