Skip to main content

​
clinik.carePlans

Care plans (FHIR CarePlan) represent planned healthcare activities for a patient, including goals, activities, and care team coordination.

​
create

const { data, meta } = await clinik.carePlans.create(request): Promise<ApiResponse<CarePlan>>
FieldTypeRequiredDescription
statusstringYesdraft, active, on-hold, revoked, completed
intentstringYesproposal, plan, order, option
patientIdstringYesPatient ID
encounterIdstringNoEncounter context
titlestringNoHuman-readable title
descriptionstringNoDescription of the care plan
categorystring[]NoCategory tags
period{ start?, end? }NoTime period covered
createdstringNoWhen created (defaults to now)
authorIdstringNoAuthor Practitioner ID
contributorIdsstring[]NoContributor Practitioner IDs
careTeamIdsstring[]NoCareTeam IDs
addressesIdsstring[]NoCondition IDs this plan addresses
goalIdsstring[]NoGoal IDs
notestringNoAdditional notes
activityArrayNoPlanned activities
basedOnstring[]NoCarePlan IDs this is based on
replacesstring[]NoCarePlan IDs this replaces
partOfstring[]NoCarePlan IDs this is part of

​
Activity Object

FieldTypeRequiredDescription
descriptionstringYesActivity description
statusstringYesnot-started, scheduled, in-progress, completed, cancelled
codestringNoActivity code
scheduledStringstringNoScheduled timing as text
performerIdstringNoPerformer Practitioner ID
referenceIdstringNoReference to another resource

​
Example

const { data } = await clinik.carePlans.create({
  status: 'active',
  intent: 'plan',
  patientId: 'pt_abc123',
  title: 'Diabetes Management Plan',
  description: 'Comprehensive care plan for Type 2 diabetes management',
  category: ['diabetes-management'],
  authorId: 'prac_dr456',
  activity: [
    {
      description: 'HbA1c test every 3 months',
      status: 'scheduled',
      code: 'lab-test',
      scheduledString: 'Every 3 months',
    },
    {
      description: 'Dietary consultation',
      status: 'not-started',
      performerId: 'prac_dietitian789',
    },
  ],
  goalIds: ['goal_target_a1c'],
  note: 'Patient motivated to improve glycemic control',
});
Same pattern as other resources. Search supports patientId, status, category, authorId filters.