Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

12.22 Resource PlanDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

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 artifacts such as clinical decision support rules, order sets and protocols.

12.22.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

A plan definition is a pre-defined group of actions to be taken in particular circumstances, often including conditional elements, options, and other decision points. The resource is flexible enough to be used to represent a variety of workflows, as well as clinical decision support and quality improvement assets, including order sets, protocols, and decision support rules.

PlanDefinitions can contain hierarchical groups of action definitions, where each action definition describes an activity to be performed (often in terms of an ActivityDefinition resource), and each group defines additional behavior, relationships, and applicable conditions between the actions in the overall definition.

In addition to describing what should take place, each action in a plan definition can specify when and whether the action should take place. For when the action should be taken, the trigger element specifies the action should be taken in response to some trigger occurring (such as a particular point in a workflow being reached, or as the result of a prescription being ordered). For whether the action should be taken, the condition element can be used to provide an expression that evaluates to true or false to indicate the applicability of the action to the specific context.

The process of applying a PlanDefinition to a particular context typically produces request resources representing the actions that should be performed, typically grouped within a CarePlan and/or RequestGroup to capture relationships between the resulting request resources.

Each ActivityDefinition is used to construct a specific resource, based on the definition of the activity and combined with contextual information for the particular patient that the plan definition is being applied to.

As with the ActivityDefinition, a PlanDefinition may provide information about how to transform the activity to a specific intent resource, either by specifying a StructureMap that can be used to perform the transformation completely, or by specifying values for specific elements of the resulting resource using dynamicValue elements in the action.

Note that these mechanisms are provided on both the ActivityDefinition and the PlanDefinition to allow both reusable transformation descriptions, as well as customization of those descriptions within specific contexts. As such, the transform descriptions specified on the PlanDefinition override transform descriptions defined on the ActivityDefinition.

Dynamic values within the definitions can be provided by specifying the expression directly, or by referencing an expression defined within a library. For more information on how to reference expressions within resources, refer to the Using Expressions topic.

As an example, the Low Suicide Risk example order set from the Clinical Decision Support Knowledge Artifact Specification can be represented using the PlanDefinition and ActivityDefinition structures: Low Suicide Risk Example Order Set.

In addition to the representation of PlanDefinitions, the $apply operation allows PlanDefinitions to be applied to a specific context such as a patient, practitioner, or institution. For Order Sets specifically, this operation is expected to place the orders defined by the order set, consistent with the service functional requirements defined by the Order Set specification .

12.22.2 Boundaries and Relationships

The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed.

As the name implies, the PlanDefinition resource is strictly definitional. It does not represent the intention to take any action, nor does it represent that any actions have been taken. Rather, the resource provides a definition that can be applied in the appropriate circumstances. When the plan definition is applied, the result will in general be a set of actions that should be (or potentially even have been) performed.

Note that the PlanDefinition still has action-level information, as well as a reference to an ActivityDefinition. The action-level information defined in the PlanDefinition itself is used to describe how the actions are related to each other within the plan, where the ActivityDefinition contains only information about the activity itself. In addition, there is some overlapping information that allows the resources to be used independently, or in combination. See the Applying a PlanDefinition section for more information.

12.22.3 References

This resource is referenced by UsageContext, CarePlan, CatalogEntry, ClinicalUseIssue, Communication, ConditionDefinition, DeviceRequest, FamilyMemberHistory, Flag, MedicationAdministration, MedicationRequest, MessageDefinition, NutritionOrder, itself, Procedure, RegulatedAuthorization, ResearchStudy and ServiceRequest.

This resource implements the Definition pattern.

12.22.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition TUMetadataResourceThe definition of a plan for a series of actions, independent of any specific patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
PlanDefinitionType (Extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library 0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Goal category (Example)
.... description 1..1CodeableConceptCode or text describing the goal
SNOMED CT Clinical Findings (Example)
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Goal priority (Preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Goal start event (Example)
.... addresses 0..*CodeableConceptWhat does the goal address
Condition/Problem/Diagnosis Codes (Example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
LOINC Codes (Example)
..... detail[x] 0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Request priority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Subject type (Extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... kind 1..1codeapplicability | start | stop
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... type 1..1codepatient | practitioner | related-person | device
ActionParticipantType (Required)
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Action participant role (Example)
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (Required)
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*see actionA sub-action

doco Documentation for this format

UML Diagram (Legend)

PlanDefinition (MetadataResource)An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the plan definitiontitle : string [0..1]An explanatory or alternate title for the plan definition giving additional information about its contentsubtitle : string [0..1]A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definitiontype : CodeableConcept [0..1] « The type of PlanDefinition. (Strength=Extensible)PlanDefinitionType+ »The status of this plan definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]A code or group definition that describes the intended subject of the plan definitionsubject[x] : DataType [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changesdate : dateTime [0..1]The name of the organization or individual that published the plan definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the plan definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the plan definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this plan definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the plan definition is used from a clinical perspectiveusage : string [0..1]A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definitioncopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the plan definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : canonical [0..*] « Library »GoalIndicates a category the goal falls withincategory : CodeableConcept [0..1] « Example codes for grouping goals for filtering or presentation. (Strength=Example)GoalCategory?? »Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"description : CodeableConcept [1..1] « Describes goals that can be achieved. (Strength=Example)SNOMEDCTClinicalFindings?? »Identifies the expected level of importance associated with reaching/sustaining the defined goalpriority : CodeableConcept [0..1] « Indicates the level of importance associated with reaching or sustaining a goal. (Strength=Preferred)GoalPriority? »The event after which the goal should begin being pursuedstart : CodeableConcept [0..1] « Identifies the types of events that might trigger the start of a goal. (Strength=Example)GoalStartEvent?? »Identifies problems, conditions, issues, or concerns the goal is intended to addressaddresses : CodeableConcept [0..*] « Identifies problems, conditions, issues, or concerns that goals may address. (Strength=Example) Condition/Problem/DiagnosisCo...?? »Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]TargetThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c levelmeasure : CodeableConcept [0..1] « Identifies types of parameters that can be tracked to determine goal achievement. (Strength=Example)LOINCCodes?? »The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low valuedetail[x] : DataType [0..1] « Quantity|Range|CodeableConcept »Indicates the timeframe after the start of the goal in which the goal should be metdue : Duration [0..1]ActionA user-visible prefix for the actionprefix : string [0..1]The title of the action displayed to a usertitle : string [0..1]A brief description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation templatecode : CodeableConcept [0..*]A description of why this action is necessary or appropriatereason : CodeableConcept [0..*]Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Identifies goals that this action supports. The reference must be to a goal element defined within this plan definitiongoalId : id [0..*]A code or group definition that describes the intended subject of the action and its children, if anysubject[x] : DataType [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »A description of when the action should be triggeredtrigger : TriggerDefinition [0..*]Defines input data requirements for the actioninput : DataRequirement [0..*]Defines the outputs of the action, if anyoutput : DataRequirement [0..*]An optional value describing when the action should be performedtiming[x] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « The type of action to be performed. (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group. (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group. (Strength=Required)ActionSelectionBehavior! »Defines the required behavior for the actionrequiredBehavior : code [0..1] « Defines expectations around whether an action or action group is required. (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group. (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated. (Strength=Required)ActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be takendefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| PlanDefinition|Questionnaire)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « Defines the kinds of conditions that can appear on actions. (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether the condition is satisfiedexpression : Expression [0..1]RelatedActionThe element id of the related actionactionId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions. (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantThe type of participant in the actiontype : code [1..1] « The type of participant for the action. (Strength=Required)ActionParticipantType! »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « Defines roles played by participants for the action. (Strength=Example)ActionParticipantRole?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Indicates what should be done and within what timeframetarget[0..*]Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etcgoal[0..*]An expression that describes applicability criteria or start/stop conditions for the actioncondition[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Indicates who should participate in performing the action describedparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definitionaction[0..*]An action or group of actions to be taken as part of the planaction[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <name value="[string]"/><!-- ?? 0..1 Name for this plan definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>
 <goal>  <!-- 0..* What the plan is trying to accomplish -->
  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>
  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept The target value to be achieved --></detail[x]>
   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <action>  <!-- 0..* Action defined by the plan -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- 0..* What goals this action supports -->
  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input><!-- 0..* DataRequirement Input data requirements --></input>
  <output><!-- 0..* DataRequirement Output data definition --></output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participant>  <!-- 0..* Who should participate in the action -->
   <type value="[code]"/><!-- 1..1 patient | practitioner | related-person | device -->
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent --></role>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|PlanDefinition|
    Questionnaire)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  "name" : "<string>", // C? Name for this plan definition (computer friendly)
  "title" : "<string>", // Name for this plan definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the plan definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<string>", // Describes the clinical usage of the plan
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : [{ canonical(Library) }], // Logic used by the plan definition
  "goal" : [{ // What the plan is trying to accomplish
    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral
    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked
      // detail[x]: The target value to be achieved. One of these 3:
      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },
      "due" : { Duration } // Reach goal within
    }]
  }],
  "action" : [{ // Action defined by the plan
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Brief description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // What goals this action supports
    // subject[x]: Type of individual the action is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ DataRequirement }], // Input data requirements
    "output" : [{ DataRequirement }], // Output data definition
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action is this related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ // Who should participate in the action
      "type" : "<code>", // R!  patient | practitioner | related-person | device
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : { canonical(ActivityDefinition|PlanDefinition|
    Questionnaire) },
    "definitionUri" : "<uri>",
    "transform" : { canonical(StructureMap) }, // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:PlanDefinition.url [ uri ]; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)
  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the plan definition
  fhir:PlanDefinition.version [ string ]; # 0..1 Business version of the plan definition
  fhir:PlanDefinition.name [ string ]; # 0..1 Name for this plan definition (computer friendly)
  fhir:PlanDefinition.title [ string ]; # 0..1 Name for this plan definition (human friendly)
  fhir:PlanDefinition.subtitle [ string ]; # 0..1 Subordinate title of the plan definition
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition
  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # PlanDefinition.subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 2
    fhir:PlanDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:PlanDefinition.subjectReference [ Reference(Group) ]
  fhir:PlanDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:PlanDefinition.description [ markdown ]; # 0..1 Natural language description of the plan definition
  fhir:PlanDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:PlanDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:PlanDefinition.purpose [ markdown ]; # 0..1 Why this plan definition is defined
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the plan
  fhir:PlanDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:PlanDefinition.approvalDate [ date ]; # 0..1 When the plan definition was approved by publisher
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 When the plan definition was last reviewed
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 When the plan definition is expected to be used
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment
  fhir:PlanDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:PlanDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:PlanDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:PlanDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:PlanDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations
  fhir:PlanDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the plan definition
  fhir:PlanDefinition.goal [ # 0..* What the plan is trying to accomplish
    fhir:PlanDefinition.goal.category [ CodeableConcept ]; # 0..1 E.g. Treatment, dietary, behavioral
    fhir:PlanDefinition.goal.description [ CodeableConcept ]; # 1..1 Code or text describing the goal
    fhir:PlanDefinition.goal.priority [ CodeableConcept ]; # 0..1 high-priority | medium-priority | low-priority
    fhir:PlanDefinition.goal.start [ CodeableConcept ]; # 0..1 When goal pursuit begins
    fhir:PlanDefinition.goal.addresses [ CodeableConcept ], ... ; # 0..* What does the goal address
    fhir:PlanDefinition.goal.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the goal
    fhir:PlanDefinition.goal.target [ # 0..* Target outcome for the goal
      fhir:PlanDefinition.goal.target.measure [ CodeableConcept ]; # 0..1 The parameter whose value is to be tracked
      # PlanDefinition.goal.target.detail[x] : 0..1 The target value to be achieved. One of these 3
        fhir:PlanDefinition.goal.target.detailQuantity [ Quantity ]
        fhir:PlanDefinition.goal.target.detailRange [ Range ]
        fhir:PlanDefinition.goal.target.detailCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.goal.target.due [ Duration ]; # 0..1 Reach goal within
    ], ...;
  ], ...;
  fhir:PlanDefinition.action [ # 0..* Action defined by the plan
    fhir:PlanDefinition.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)
    fhir:PlanDefinition.action.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.action.description [ string ]; # 0..1 Brief description of the action
    fhir:PlanDefinition.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:PlanDefinition.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or sub-actions
    fhir:PlanDefinition.action.reason [ CodeableConcept ], ... ; # 0..* Why the action should be performed
    fhir:PlanDefinition.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.action.goalId [ id ], ... ; # 0..* What goals this action supports
    # PlanDefinition.action.subject[x] : 0..1 Type of individual the action is focused on. One of these 2
      fhir:PlanDefinition.action.subjectCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.action.subjectReference [ Reference(Group) ]
    fhir:PlanDefinition.action.trigger [ TriggerDefinition ], ... ; # 0..* When the action should be triggered
    fhir:PlanDefinition.action.condition [ # 0..* Whether or not the action is applicable
      fhir:PlanDefinition.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:PlanDefinition.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:PlanDefinition.action.input [ DataRequirement ], ... ; # 0..* Input data requirements
    fhir:PlanDefinition.action.output [ DataRequirement ], ... ; # 0..* Output data definition
    fhir:PlanDefinition.action.relatedAction [ # 0..* Relationship to another action
      fhir:PlanDefinition.action.relatedAction.actionId [ id ]; # 1..1 What action is this related to
      fhir:PlanDefinition.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # PlanDefinition.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.action.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # PlanDefinition.action.timing[x] : 0..1 When the action should take place. One of these 6
      fhir:PlanDefinition.action.timingDateTime [ dateTime ]
      fhir:PlanDefinition.action.timingAge [ Age ]
      fhir:PlanDefinition.action.timingPeriod [ Period ]
      fhir:PlanDefinition.action.timingDuration [ Duration ]
      fhir:PlanDefinition.action.timingRange [ Range ]
      fhir:PlanDefinition.action.timingTiming [ Timing ]
    fhir:PlanDefinition.action.participant [ # 0..* Who should participate in the action
      fhir:PlanDefinition.action.participant.type [ code ]; # 1..1 patient | practitioner | related-person | device
      fhir:PlanDefinition.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent
    ], ...;
    fhir:PlanDefinition.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event
    fhir:PlanDefinition.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:PlanDefinition.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:PlanDefinition.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    # PlanDefinition.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:PlanDefinition.action.definitionCanonical [ canonical(ActivityDefinition|PlanDefinition|Questionnaire) ]
      fhir:PlanDefinition.action.definitionUri [ uri ]
    fhir:PlanDefinition.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:PlanDefinition.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:PlanDefinition.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:PlanDefinition.action.action [ See PlanDefinition.action ], ... ; # 0..* A sub-action
  ], ...;
]

Changes since R3

PlanDefinition
PlanDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.2.0
PlanDefinition.action.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.2.0
PlanDefinition.action.condition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.0 to http://hl7.org/fhir/ValueSet/action-condition-kind|4.2.0
PlanDefinition.action.relatedAction.relationship
  • Change value set from http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-relationship-type|4.2.0
PlanDefinition.action.participant.type
  • Change value set from http://hl7.org/fhir/ValueSet/action-participant-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-participant-type|4.2.0
PlanDefinition.action.groupingBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.2.0
PlanDefinition.action.selectionBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.2.0
PlanDefinition.action.requiredBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-required-behavior|4.2.0
PlanDefinition.action.precheckBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.2.0
PlanDefinition.action.cardinalityBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 11 tests of which 6 fail to execute. All tests pass round-trip testing and 5 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition TUMetadataResourceThe definition of a plan for a series of actions, independent of any specific patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
PlanDefinitionType (Extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the plan definition is focused on
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library 0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Goal category (Example)
.... description 1..1CodeableConceptCode or text describing the goal
SNOMED CT Clinical Findings (Example)
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Goal priority (Preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Goal start event (Example)
.... addresses 0..*CodeableConceptWhat does the goal address
Condition/Problem/Diagnosis Codes (Example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
LOINC Codes (Example)
..... detail[x] 0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Request priority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type of individual the action is focused on
Subject type (Extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... kind 1..1codeapplicability | start | stop
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... type 1..1codepatient | practitioner | related-person | device
ActionParticipantType (Required)
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Action participant role (Example)
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (Required)
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*see actionA sub-action

doco Documentation for this format

UML Diagram (Legend)

PlanDefinition (MetadataResource)An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the plan definitiontitle : string [0..1]An explanatory or alternate title for the plan definition giving additional information about its contentsubtitle : string [0..1]A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definitiontype : CodeableConcept [0..1] « The type of PlanDefinition. (Strength=Extensible)PlanDefinitionType+ »The status of this plan definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]A code or group definition that describes the intended subject of the plan definitionsubject[x] : DataType [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changesdate : dateTime [0..1]The name of the organization or individual that published the plan definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the plan definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the plan definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this plan definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the plan definition is used from a clinical perspectiveusage : string [0..1]A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definitioncopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the plan definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : canonical [0..*] « Library »GoalIndicates a category the goal falls withincategory : CodeableConcept [0..1] « Example codes for grouping goals for filtering or presentation. (Strength=Example)GoalCategory?? »Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"description : CodeableConcept [1..1] « Describes goals that can be achieved. (Strength=Example)SNOMEDCTClinicalFindings?? »Identifies the expected level of importance associated with reaching/sustaining the defined goalpriority : CodeableConcept [0..1] « Indicates the level of importance associated with reaching or sustaining a goal. (Strength=Preferred)GoalPriority? »The event after which the goal should begin being pursuedstart : CodeableConcept [0..1] « Identifies the types of events that might trigger the start of a goal. (Strength=Example)GoalStartEvent?? »Identifies problems, conditions, issues, or concerns the goal is intended to addressaddresses : CodeableConcept [0..*] « Identifies problems, conditions, issues, or concerns that goals may address. (Strength=Example) Condition/Problem/DiagnosisCo...?? »Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]TargetThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c levelmeasure : CodeableConcept [0..1] « Identifies types of parameters that can be tracked to determine goal achievement. (Strength=Example)LOINCCodes?? »The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low valuedetail[x] : DataType [0..1] « Quantity|Range|CodeableConcept »Indicates the timeframe after the start of the goal in which the goal should be metdue : Duration [0..1]ActionA user-visible prefix for the actionprefix : string [0..1]The title of the action displayed to a usertitle : string [0..1]A brief description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « Identifies the level of importance to be assigned to actioning the request. (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation templatecode : CodeableConcept [0..*]A description of why this action is necessary or appropriatereason : CodeableConcept [0..*]Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Identifies goals that this action supports. The reference must be to a goal element defined within this plan definitiongoalId : id [0..*]A code or group definition that describes the intended subject of the action and its children, if anysubject[x] : DataType [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »A description of when the action should be triggeredtrigger : TriggerDefinition [0..*]Defines input data requirements for the actioninput : DataRequirement [0..*]Defines the outputs of the action, if anyoutput : DataRequirement [0..*]An optional value describing when the action should be performedtiming[x] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « The type of action to be performed. (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group. (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group. (Strength=Required)ActionSelectionBehavior! »Defines the required behavior for the actionrequiredBehavior : code [0..1] « Defines expectations around whether an action or action group is required. (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group. (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated. (Strength=Required)ActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be takendefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| PlanDefinition|Questionnaire)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « Defines the kinds of conditions that can appear on actions. (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether the condition is satisfiedexpression : Expression [0..1]RelatedActionThe element id of the related actionactionId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions. (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantThe type of participant in the actiontype : code [1..1] « The type of participant for the action. (Strength=Required)ActionParticipantType! »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « Defines roles played by participants for the action. (Strength=Example)ActionParticipantRole?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Indicates what should be done and within what timeframetarget[0..*]Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etcgoal[0..*]An expression that describes applicability criteria or start/stop conditions for the actioncondition[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Indicates who should participate in performing the action describedparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definitionaction[0..*]An action or group of actions to be taken as part of the planaction[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <name value="[string]"/><!-- ?? 0..1 Name for this plan definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>
 <goal>  <!-- 0..* What the plan is trying to accomplish -->
  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>
  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept The target value to be achieved --></detail[x]>
   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <action>  <!-- 0..* Action defined by the plan -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- 0..* What goals this action supports -->
  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input><!-- 0..* DataRequirement Input data requirements --></input>
  <output><!-- 0..* DataRequirement Output data definition --></output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionId value="[id]"/><!-- 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participant>  <!-- 0..* Who should participate in the action -->
   <type value="[code]"/><!-- 1..1 patient | practitioner | related-person | device -->
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent --></role>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|PlanDefinition|
    Questionnaire)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  "name" : "<string>", // C? Name for this plan definition (computer friendly)
  "title" : "<string>", // Name for this plan definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the plan definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<string>", // Describes the clinical usage of the plan
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : [{ canonical(Library) }], // Logic used by the plan definition
  "goal" : [{ // What the plan is trying to accomplish
    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral
    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked
      // detail[x]: The target value to be achieved. One of these 3:
      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },
      "due" : { Duration } // Reach goal within
    }]
  }],
  "action" : [{ // Action defined by the plan
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Brief description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // What goals this action supports
    // subject[x]: Type of individual the action is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ DataRequirement }], // Input data requirements
    "output" : [{ DataRequirement }], // Output data definition
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action is this related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ // Who should participate in the action
      "type" : "<code>", // R!  patient | practitioner | related-person | device
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : { canonical(ActivityDefinition|PlanDefinition|
    Questionnaire) },
    "definitionUri" : "<uri>",
    "transform" : { canonical(StructureMap) }, // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:PlanDefinition.url [ uri ]; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)
  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the plan definition
  fhir:PlanDefinition.version [ string ]; # 0..1 Business version of the plan definition
  fhir:PlanDefinition.name [ string ]; # 0..1 Name for this plan definition (computer friendly)
  fhir:PlanDefinition.title [ string ]; # 0..1 Name for this plan definition (human friendly)
  fhir:PlanDefinition.subtitle [ string ]; # 0..1 Subordinate title of the plan definition
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition
  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # PlanDefinition.subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 2
    fhir:PlanDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:PlanDefinition.subjectReference [ Reference(Group) ]
  fhir:PlanDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:PlanDefinition.description [ markdown ]; # 0..1 Natural language description of the plan definition
  fhir:PlanDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:PlanDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:PlanDefinition.purpose [ markdown ]; # 0..1 Why this plan definition is defined
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the plan
  fhir:PlanDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:PlanDefinition.approvalDate [ date ]; # 0..1 When the plan definition was approved by publisher
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 When the plan definition was last reviewed
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 When the plan definition is expected to be used
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment
  fhir:PlanDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:PlanDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:PlanDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:PlanDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:PlanDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations
  fhir:PlanDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the plan definition
  fhir:PlanDefinition.goal [ # 0..* What the plan is trying to accomplish
    fhir:PlanDefinition.goal.category [ CodeableConcept ]; # 0..1 E.g. Treatment, dietary, behavioral
    fhir:PlanDefinition.goal.description [ CodeableConcept ]; # 1..1 Code or text describing the goal
    fhir:PlanDefinition.goal.priority [ CodeableConcept ]; # 0..1 high-priority | medium-priority | low-priority
    fhir:PlanDefinition.goal.start [ CodeableConcept ]; # 0..1 When goal pursuit begins
    fhir:PlanDefinition.goal.addresses [ CodeableConcept ], ... ; # 0..* What does the goal address
    fhir:PlanDefinition.goal.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the goal
    fhir:PlanDefinition.goal.target [ # 0..* Target outcome for the goal
      fhir:PlanDefinition.goal.target.measure [ CodeableConcept ]; # 0..1 The parameter whose value is to be tracked
      # PlanDefinition.goal.target.detail[x] : 0..1 The target value to be achieved. One of these 3
        fhir:PlanDefinition.goal.target.detailQuantity [ Quantity ]
        fhir:PlanDefinition.goal.target.detailRange [ Range ]
        fhir:PlanDefinition.goal.target.detailCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.goal.target.due [ Duration ]; # 0..1 Reach goal within
    ], ...;
  ], ...;
  fhir:PlanDefinition.action [ # 0..* Action defined by the plan
    fhir:PlanDefinition.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)
    fhir:PlanDefinition.action.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.action.description [ string ]; # 0..1 Brief description of the action
    fhir:PlanDefinition.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:PlanDefinition.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or sub-actions
    fhir:PlanDefinition.action.reason [ CodeableConcept ], ... ; # 0..* Why the action should be performed
    fhir:PlanDefinition.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.action.goalId [ id ], ... ; # 0..* What goals this action supports
    # PlanDefinition.action.subject[x] : 0..1 Type of individual the action is focused on. One of these 2
      fhir:PlanDefinition.action.subjectCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.action.subjectReference [ Reference(Group) ]
    fhir:PlanDefinition.action.trigger [ TriggerDefinition ], ... ; # 0..* When the action should be triggered
    fhir:PlanDefinition.action.condition [ # 0..* Whether or not the action is applicable
      fhir:PlanDefinition.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:PlanDefinition.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:PlanDefinition.action.input [ DataRequirement ], ... ; # 0..* Input data requirements
    fhir:PlanDefinition.action.output [ DataRequirement ], ... ; # 0..* Output data definition
    fhir:PlanDefinition.action.relatedAction [ # 0..* Relationship to another action
      fhir:PlanDefinition.action.relatedAction.actionId [ id ]; # 1..1 What action is this related to
      fhir:PlanDefinition.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # PlanDefinition.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.action.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # PlanDefinition.action.timing[x] : 0..1 When the action should take place. One of these 6
      fhir:PlanDefinition.action.timingDateTime [ dateTime ]
      fhir:PlanDefinition.action.timingAge [ Age ]
      fhir:PlanDefinition.action.timingPeriod [ Period ]
      fhir:PlanDefinition.action.timingDuration [ Duration ]
      fhir:PlanDefinition.action.timingRange [ Range ]
      fhir:PlanDefinition.action.timingTiming [ Timing ]
    fhir:PlanDefinition.action.participant [ # 0..* Who should participate in the action
      fhir:PlanDefinition.action.participant.type [ code ]; # 1..1 patient | practitioner | related-person | device
      fhir:PlanDefinition.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent
    ], ...;
    fhir:PlanDefinition.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event
    fhir:PlanDefinition.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:PlanDefinition.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:PlanDefinition.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    # PlanDefinition.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:PlanDefinition.action.definitionCanonical [ canonical(ActivityDefinition|PlanDefinition|Questionnaire) ]
      fhir:PlanDefinition.action.definitionUri [ uri ]
    fhir:PlanDefinition.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:PlanDefinition.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:PlanDefinition.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:PlanDefinition.action.action [ See PlanDefinition.action ], ... ; # 0..* A sub-action
  ], ...;
]

Changes since Release 3

PlanDefinition
PlanDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.2.0
PlanDefinition.action.priority
  • Change value set from http://hl7.org/fhir/ValueSet/request-priority|4.0.0 to http://hl7.org/fhir/ValueSet/request-priority|4.2.0
PlanDefinition.action.condition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.0 to http://hl7.org/fhir/ValueSet/action-condition-kind|4.2.0
PlanDefinition.action.relatedAction.relationship
  • Change value set from http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-relationship-type|4.2.0
PlanDefinition.action.participant.type
  • Change value set from http://hl7.org/fhir/ValueSet/action-participant-type|4.0.0 to http://hl7.org/fhir/ValueSet/action-participant-type|4.2.0
PlanDefinition.action.groupingBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.2.0
PlanDefinition.action.selectionBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.2.0
PlanDefinition.action.requiredBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-required-behavior|4.2.0
PlanDefinition.action.precheckBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.2.0
PlanDefinition.action.cardinalityBehavior
  • Change value set from http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.0 to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 11 tests of which 6 fail to execute. All tests pass round-trip testing and 5 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

12.22.4.1 Terminology Bindings

PathDefinitionTypeReference
PlanDefinition.type The type of PlanDefinition.ExtensiblePlanDefinitionType
PlanDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
PlanDefinition.subject[x]
PlanDefinition.action.subject[x] 		The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).ExtensibleSubjectType
PlanDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
PlanDefinition.topic High-level categorization of the definition, used for searching, sorting, and filtering.ExampleDefinitionTopic
PlanDefinition.goal.category Example codes for grouping goals for filtering or presentation.ExampleGoalCategory
PlanDefinition.goal.description Describes goals that can be achieved.ExampleSNOMEDCTClinicalFindings
PlanDefinition.goal.priority Indicates the level of importance associated with reaching or sustaining a goal.PreferredGoalPriority
PlanDefinition.goal.start Identifies the types of events that might trigger the start of a goal.ExampleGoalStartEvent
PlanDefinition.goal.addresses Identifies problems, conditions, issues, or concerns that goals may address.ExampleCondition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measure Identifies types of parameters that can be tracked to determine goal achievement.ExampleLOINCCodes
PlanDefinition.action.priority Identifies the level of importance to be assigned to actioning the request.RequiredRequestPriority
PlanDefinition.action.condition.kind Defines the kinds of conditions that can appear on actions.RequiredActionConditionKind
PlanDefinition.action.relatedAction.relationship Defines the types of relationships between actions.RequiredActionRelationshipType
PlanDefinition.action.participant.type The type of participant for the action.RequiredActionParticipantType
PlanDefinition.action.participant.role Defines roles played by participants for the action.ExampleActionParticipantRole
PlanDefinition.action.type The type of action to be performed.ExtensibleActionType
PlanDefinition.action.groupingBehavior Defines organization behavior of a group.RequiredActionGroupingBehavior
PlanDefinition.action.selectionBehavior Defines selection behavior of a group.RequiredActionSelectionBehavior
PlanDefinition.action.requiredBehavior Defines expectations around whether an action or action group is required.RequiredActionRequiredBehavior
PlanDefinition.action.precheckBehavior Defines selection frequency behavior for an action or group.RequiredActionPrecheckBehavior
PlanDefinition.action.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeated.RequiredActionCardinalityBehavior

12.22.4.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

12.22.4.3 Applying a PlanDefinition

The following diagram illustrates the relationship between the PlanDefinition and ActivityDefinition resources, as well as a typical application to CarePlan, RequestGroup, and Request resources. The resources depicted on the left side of the arrow are definition resources, while the ones on the right side of the arrow are request resources, with the arrow representing the $apply operation:

relationship-between-action-and-activity-definition

The PlanDefinition and ActivityDefinition resources support the representation of a broad range of use cases including order sets, flow sheets, event-condition-action rules, clinical protocols, and research trials. To support this range of use cases, as well as the variability in capabilities of systems that use these types of artifacts, this specification is not prescriptive about exactly how these definitions are applied to produce request and event resources. However, the approach depicted above provides a general framework for the process, and the following steps provide more detail on the potential approach:

  1. Create a CarePlan resource focused on the Patient in context and linked to the PlanDefinition using the instantiates element
  2. Create goal elements in the CarePlan based on the goal definitions in the plan
  3. Create a RequestGroup resource focused on the Patient in context and linked to the PlanDefinition using the instantiatesCanonical element
  4. Create an activity in the CarePlan to reference the RequestGroup
  5. Process each action element of the PlanDefinition

Processing for each action proceeds according to the following steps:

  1. Determine applicability by evaluating the applicability conditions defined for the element
  2. If the action is applicable, determine whether the action is a group or a single, atomic activity (does the action have child actions?)
  3. If the action is atomic, process according to the following steps:
    • Create an action element in the RequestGroup with the same id as the action being processed
    • Apply the elements of the action to the corresponding elements of the newly created action in the RequestGroup such as title, description, textEquivalent, timing, and so on
    • Carry any start and stop conditions defined in the plan action forward to the request group action.
    • There are three possibilities for the definition element:
      • ActivityDefinition:
        1. Create the target resource as described in the Applying an ActivityDefinition topic
        2. Reference the resulting resource in the resource element of the action. Note that the target resource can be set as a contained resource in the RequestGroup, or it can be persisted independently, as appropriate for the environment
        3. Set the status of the target resource to option so that it is clearly indicated as part of a RequestGroup. Note that the ActivityDefinition/$apply operation will not necessarily produce resource with this status, so this is an important step.
        4. Apply any overrides based on the elements of the action (see the section on Overlap below for details)
      • PlanDefinition:
        1. Create a CarePlan by applying the target PlanDefinition
        2. Reference the resulting resource in the resource element of the action. Note that the resulting CarePlan can be set as a contained resource in the RequestGroup, but doing so would require expanding any potentially contained resources.
        3. Set the status of the CarePlan to option so that it is clearly indicated as part of a RequestGroup.
        4. Apply any overrides based on the elements of the action such as title, description, and dynamicValue.
      • Questionnaire: Set the resource element of the action to the Questionnaire, indicating that the activity to be performed is filling out the given questionnaire.
  4. If the action is a group, determine which actions to process based on the behaviors specified in the group. Note that this aspect of the process may require input from a user. In these cases, either the choices made by the user can be provided as input to the process, or the process can be performed as part of a user-entry workflow that enables user input to be provided as necessary.

The parameters to the $apply operation are available within dynamicValue CQL and FHIRPath expressions as context variables, accessible by the name of the parameter prefixed with a percent (%) symbol. For example, to access the subject given to the apply, use the expression %subject. The value of the %subject context variable in a dynamicValue expression is determined using the current subject, as specified by the subject element on the PlanDefinition, current PlanDefinition.action, or ActivityDefinition.

In addition to the $apply operation parameters, the context variable %action can be used within the path element of a dynamicValue to specify the current action target. For example, to specify the path to the description element of the current action, use %action.description.

12.22.4.4 Overlap with ActivityDefinition

As noted in the Boundaries section, there is some overlap between the content that can be represented within the action element of a PlanDefinition, and the elements of the ActivityDefinition resource. This overlap allows for both resources to be used independently, as well as in combination. For example, a PlanDefinition may be used without any supporting ActivityDefinitions to describe a particular workflow, where it is sufficient to describe the actions simply as textual descriptions of what needs to take place. On the other hand, the PlanDefinition may be used together with ActivityDefinition to provide a detailed structural representation of the activities to be performed.

In general, where there is overlap, the elements from the PlanDefinition provide overriding behavior. Specifically, the following elements of action overlap with ActivityDefinition:

Element Behavior
title The title element in ActivityDefinition is the title of the activity "as defined", where the title element in PlanDefinition reflects the title in the scope of the plan.
description The description element in ActivityDefinition is the description of the activity "as defined", where the description element in PlanDefinition reflects the description in the scope of the plan.
code The code element in ActivityDefinition represents the meaning of the activity "as defined", where the code element in PlanDefinition represents the meaning in the scope of the plan.
documentation The documentation element in PlanDefinition represents additional documentation for the action specific to the scope of the plan, where the relatedArtifact element in ActivityDefinition provides documentation specific to the activity itself.
timing The timing element in ActivityDefinition represents timings associated within the activity itself, where the timing element in PlanDefinition represents the timing of the activity with respect to the plan and its other actions. When a timing is provided on both, the timing defined in the plan generally takes precedence.
participant The participant element in ActivityDefinition represents what type of actor is expected to perform the activity generally, where the participant element in PlanDefinition represents the type of actor that is expected to perform the activity in the context of the plan.
transform The transform element in ActivityDefinition describes the transformation of the definition to a request or event resource in general, where the transform element in PlanDefinition describes the transformation within the scope of the plan. When a transform is present in both, the transform in the plan takes precedence.
dynamicValue The dynamicValue element in ActivityDefinition defines values for elements of the target request or event resource in general, where the dynamicValue element in PlanDefinition defines values within the scope of the plan. When dynamic values are present in both, the dynamic values from the ActivityDefinition are applied first (in the order in which they appear on the ActivityDefinition), followed by the dynamic values from the PlanDefinition (in the order in which they appear on the PlanDefinition).

12.22.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the plan definition(PlanDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the plan definition(PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the plan definitionPlanDefinition.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the plan definitionOn PlanDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the plan definitionOn PlanDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe plan definition publication datePlanDefinition.date
definitionreferenceActivity or plan definitions used by plan definitionPlanDefinition.action.definition
(Questionnaire, PlanDefinition, ActivityDefinition)
depends-onreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
(Library, Any)
derived-fromreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
description NstringThe description of the plan definitionPlanDefinition.description
effectivedateThe time during which the plan definition is intended to be in usePlanDefinition.effectivePeriod
identifiertokenExternal identifier for the plan definitionPlanDefinition.identifier
jurisdictiontokenIntended jurisdiction for the plan definitionPlanDefinition.jurisdiction
name NstringComputationally friendly name of the plan definitionPlanDefinition.name
predecessorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisher NstringName of the publisher of the plan definitionPlanDefinition.publisher
status NtokenThe current status of the plan definitionPlanDefinition.status
successorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='successor').resource
(Any)
title NstringThe human-friendly name of the plan definitionPlanDefinition.title
topictokenTopics associated with the modulePlanDefinition.topic
typetokenThe type of artifact the plan (e.g. order-set, eca-rule, protocol)PlanDefinition.type
url NuriThe uri that identifies the plan definitionPlanDefinition.url
version NtokenThe business version of the plan definitionPlanDefinition.version