This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

PlanDefinition
url
Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier
Additional identifier for the plan definition
version
Business version of the plan definition
versionAlgorithm[x]
How to compare versions
name
Name for this plan definition (computer friendly)
title
Name for this plan definition (human friendly)
subtitle
Subordinate title of the plan definition
type
order-set | clinical-protocol | eca-rule | workflow-definition
status
draft | active | retired | unknown
experimental
For testing purposes, not real usage
subject[x]
Type of individual the plan definition is focused on
date
Date last changed
publisher
Name of the publisher/steward (organization or individual)
contact
Contact details for the publisher
description
Natural language description of the plan definition
useContext
The context that the content is intended to support
jurisdiction
Intended jurisdiction for plan definition (if applicable)
purpose
Why this plan definition is defined
usage
Describes the clinical usage of the plan
copyrightLabel
Copyright holder and year(s)
approvalDate
When the plan definition was approved by publisher
lastReviewDate
When the plan definition was last reviewed by the publisher
effectivePeriod
When the plan definition is expected to be used
topic
E.g. Education, Treatment, Assessment
author
Who authored the content
editor
Who edited the content
reviewer
Who reviewed the content
endorser
Who endorsed the content
relatedArtifact
Additional documentation, citations
library
Logic used by the plan definition
goal
What the plan is trying to accomplish
category
E.g. Treatment, dietary, behavioral
description
Code or text describing the goal
priority
high-priority | medium-priority | low-priority
start
When goal pursuit begins
addresses
What does the goal address
documentation
Supporting documentation for the goal
target
Target outcome for the goal
measure
The parameter whose value is to be tracked
detail[x]
The target value to be achieved
due
Reach goal within
actor
Actors within the plan
title
User-visible title
description
Describes the actor
option
Who or what can be this actor
type
careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
typeCanonical
Who or what can participate
typeReference
Who or what can participate
role
E.g. Nurse, Surgeon, Parent
action
Action defined by the plan
linkId
Unique id for the action in the PlanDefinition
prefix
User-visible prefix for the action (e.g. 1. or A.)
title
User-visible title
description
Brief description of the action
textEquivalent
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority
routine | urgent | asap | stat
code
Code representing the meaning of the action or sub-actions
reason
Why the action should be performed
documentation
Supporting documentation for the intended performer of the action
goalId
What goals this action supports
subject[x]
Type of individual the action is focused on
trigger
When the action should be triggered
condition
Whether or not the action is applicable
kind
applicability | start | stop
expression
Boolean-valued expression
input
Input data requirements
title
User-visible title
requirement
What data is provided
relatedData
What data is provided
output
Output data definition
title
User-visible title
requirement
What data is provided
relatedData
What data is provided
relatedAction
Relationship to another action
targetId
What action is this related to
relationship
before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
endRelationship
before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
offset[x]
Time offset for the relationship
timing[x]
When the action should take place
location
Where it should happen
participant
Who should participate in the action
actorId
What actor
type
careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
typeCanonical
Who or what can participate
typeReference
Who or what can participate
role
E.g. Nurse, Surgeon, Parent
function
E.g. Author, Reviewer, Witness, etc
type
create | update | remove | fire-event
groupingBehavior
visual-group | logical-group | sentence-group
selectionBehavior
any | all | all-or-none | exactly-one | at-most-one | one-or-more
requiredBehavior
must | could | must-unless-documented
precheckBehavior
yes | no
cardinalityBehavior
single | multiple
definition[x]
Description of the activity to be performed
transform
Transform to apply the template
dynamicValue
Dynamic aspects of the definition
path
The path to the element to be set dynamically
expression
An expression that provides the dynamic value for the customization
action
A sub-action
asNeeded[x]
Preconditions for service