Skip to main content

clinik.planDefinitions

Plan definitions (FHIR PlanDefinition) describe clinical protocols, order sets, and workflow definitions — reusable templates for care plans and clinical decision support.

create

const { data, meta } = await clinik.planDefinitions.create(request): Promise<ApiResponse<PlanDefinition>>
FieldTypeRequiredDescription
statusstringYesdraft, active, retired
namestringNoComputer-friendly name
titlestringNoHuman-friendly title
typestringNoorder-set, clinical-protocol, eca-rule, workflow-definition
descriptionstringNoDescription of the plan
purposestringNoWhy this plan exists
usagestringNoClinical usage notes
publisherstringNoPublisher name
datestringNoPublication date
versionstringNoBusiness version
urlstringNoCanonical URL
experimentalbooleanNoFor testing only
topicstring[]NoTopic categories
goalArray<object>NoPlan goals
actionArray<object>NoPlan actions

goal

FieldTypeDescription
descriptionstringGoal description (required)
prioritystringGoal priority
categorystringGoal category

action

FieldTypeDescription
titlestringAction title
descriptionstringAction description
prioritystringAction priority
codestringAction code
typestringAction type
definitionUristringURI to the activity definition

Example

const { data } = await clinik.planDefinitions.create({
  status: 'active',
  name: 'diabetes-management-protocol',
  title: 'Type 2 Diabetes Management Protocol',
  type: 'clinical-protocol',
  description: 'Standard protocol for managing Type 2 Diabetes in primary care',
  goal: [
    { description: 'HbA1c below 7%', priority: 'high-priority', category: 'physiologic' },
    { description: 'Blood pressure below 130/80', priority: 'high-priority' },
  ],
  action: [
    { title: 'Initial Assessment', description: 'Complete metabolic panel and HbA1c', priority: 'routine', code: 'initial-assessment' },
    { title: 'Quarterly Follow-up', description: 'HbA1c check every 3 months', priority: 'routine' },
    { title: 'Annual Eye Exam', description: 'Dilated eye exam referral', priority: 'routine', type: 'referral' },
  ],
});
Same pattern as other resources. Search supports status, name, title, type filters.
For advanced PlanDefinition features like dynamicValue, expression, library, or relatedArtifact, use the FHIR Passthrough.