STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

14.2 Resource PlanDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: 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.

14.2.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Reasoning module.

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

PlanDefinitions can contain hierarchical groups of actions, where each specific action defines an activity to be performed (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 triggerDefinition 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, potentially grouped within a CarePlan 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 Languages 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 realized for 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 Service specification.

14.2.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 eachother within the plan, where the ActivityDefinition contains only information about the activity itself.

This resource is referenced by CarePlan and Flag

14.2.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition DomainResourceThe definition of a plan for a series of actions, independent of any specific patient or context
... url Σ0..1uriLogical URL to reference this asset
... identifier Σ0..*IdentifierLogical identifier(s) for the asset
... version Σ0..1stringThe version of the asset, if any
... name Σ0..1stringA machine-friendly name for the asset
... title Σ0..1stringA user-friendly title for the asset
... type Σ0..1CodeableConceptorder-set | protocol | eca-rule
PlanDefinitionType (Extensible)
... status ?!Σ1..1codedraft | active | inactive
LibraryStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the asset
... purpose 0..1stringDescribes the purpose of the asset
... usage 0..1stringDescribes the clinical usage of the asset
... publicationDate 0..1datePublication date for this version of the asset
... lastReviewDate 0..1dateLast review date for the asset
... effectivePeriod 0..1PeriodThe effective date range for the asset
... coverage 0..*UsageContextDescribes the context of use for this asset
... topic 0..*CodeableConceptDescriptional topics for the asset
... contributor 0..*ContributorA content contributor
... publisher 0..1stringName of the publisher (Organization or individual)
... contact 0..*ContactDetailContact details of the publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*RelatedResourceRelated resources for the asset
... library 0..*Reference(Library)Logic used by the plan definition
... actionDefinition 0..*BackboneElementAction defined by the plan
.... actionIdentifier 0..1IdentifierUnique identifier
.... label 0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... concept 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedResourceSupporting documentation for the intended performer of the action
.... triggerDefinition 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..1BackboneElementWhether or not the action is applicable
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore | after | concurrent
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
..... anchor 0..1codestart | end
PlanActionRelationshipAnchor (Required)
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participantType 0..*codepatient | practitioner | related-person
PlanActionParticipantType (Required)
.... type 0..1Codingcreate | update | remove | fire-event
PlanActionType (Required)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
PlanActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
PlanActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
PlanActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
PlanActionCardinalityBehavior (Required)
.... activityDefinition 0..1Reference(ActivityDefinition)Description of the activity to be performed
.... transform 0..1Reference(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... description 0..1stringNatural language description of the dynamic value
..... path 0..1stringThe path to the element to be set dynamically
..... language 0..1stringLanguage of the expression
..... expression 0..1stringAn expression that provides the dynamic value for the customization
.... actionDefinition 0..*see actionDefinitionA sub-action

doco Documentation for this format

UML Diagram (Legend)

PlanDefinition (DomainResource)An absolute URL that is used to identify this asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) publishedurl : uri [0..1]A logical identifier for the asset such as the CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifactsidentifier : Identifier [0..*]The version of the asset, if any. 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 machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the assettitle : string [0..1]The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action ruletype : CodeableConcept [0..1] « The type of PlanDefinition (Strength=Extensible)PlanDefinitionType+ »The status of the asset (this element modifies the meaning of other elements)status : code [1..1] « The status of the PlanDefinition (Strength=Required)LibraryStatus! »Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the asset from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the assetpurpose : string [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset was publishedpublicationDate : date [0..1]The date on which the asset content was last reviewedlastReviewDate : date [0..1]The period during which the asset content is effectiveeffectivePeriod : Period [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the asset is applicablecoverage : UsageContext [0..*]Clinical topics related to the content of the assettopic : CodeableConcept [0..*]A contributor to the content of the asset, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the asset (also known as the steward for the asset). This information is required for non-experimental active artifactspublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the assetcopyright : string [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource : RelatedResource [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : Reference [0..*] « Library »ActionDefinitionA unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally uniqueactionIdentifier : Identifier [0..1]A user-visible label for the actionlabel : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short 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 may not be capable of interpreting it dynamicallytextEquivalent : string [0..1]The concept represented by this action or its sub-actionsconcept : 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 : RelatedResource [0..*]A description of when the action should be triggeredtriggerDefinition : TriggerDefinition [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range|Timing »The type of participant in the actionparticipantType : code [0..*] « The type of participant for the action (Strength=Required)PlanActionParticipantType! »The type of action to perform (create, update, remove)type : Coding [0..1] « The type of action to be performed (Strength=Required)PlanActionType! »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)PlanActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)PlanActionSelectionBehavior! »Defines the requiredness behavior for the actionrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)PlanActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)PlanActionPrecheckBehavior! »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)PlanActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detailactivityDefinition : Reference [0..1] « ActivityDefinition »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 : Reference [0..1] « StructureMap »ConditionA brief, natural language description of the condition that effectively communicates the intended semanticsdescription : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : string [0..1]RelatedActionThe unique identifier of the related actionactionIdentifier : Identifier [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions (Strength=Required)PlanActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : Type [0..1] « Duration|Range »An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related actionanchor : code [0..1] « Defines possible anchors for the relationship between actions (Strength=Required)PlanActionRelationshipAnchor! »DynamicValueA brief, natural language description of the intended semantics of the dynamic valuedescription : string [0..1]The 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 expressionpath : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression specifying the value of the customized elementexpression : string [0..1]An expression specifying whether or not the action is applicable in a given contextcondition[0..1]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[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 definitionactionDefinition[0..*]An action to be taken as part of the planactionDefinition[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URL to reference this asset -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the asset --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the asset, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the asset -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the asset -->
 <type><!-- 0..1 CodeableConcept order-set | protocol | eca-rule --></type>
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the asset -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the asset -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the asset -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the asset -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the asset --></effectivePeriod>
 <coverage><!-- 0..* UsageContext Describes the context of use for this asset --></coverage>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the asset --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details of the publisher --></contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource><!-- 0..* RelatedResource Related resources for the asset --></relatedResource>
 <library><!-- 0..* Reference(Library) Logic used by the plan definition --></library>
 <actionDefinition>  <!-- 0..* Action defined by the plan -->
  <actionIdentifier><!-- 0..1 Identifier Unique identifier --></actionIdentifier>
  <label value="[string]"/><!-- 0..1 User-visible label for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short 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 -->
  <concept><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></concept>
  <documentation><!-- 0..* RelatedResource Supporting documentation for the intended performer of the action --></documentation>
  <triggerDefinition><!-- 0..* TriggerDefinition When the action should be triggered --></triggerDefinition>
  <condition>  <!-- 0..1 Whether or not the action is applicable -->
   <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before | after | concurrent -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
   <anchor value="[code]"/><!-- 0..1 start | end -->
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participantType value="[code]"/><!-- 0..* patient | practitioner | related-person -->
  <type><!-- 0..1 Coding 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 -->
  <activityDefinition><!-- 0..1 Reference(ActivityDefinition) Description of the activity to be performed --></activityDefinition>
  <transform><!-- 0..1 Reference(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <description value="[string]"/><!-- 0..1 Natural language description of the dynamic value -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 An expression that provides the dynamic value for the customization -->
  </dynamicValue>
  <actionDefinition><!-- 0..* Content as for PlanDefinition.actionDefinition A sub-action --></actionDefinition>
 </actionDefinition>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URL to reference this asset
  "identifier" : [{ Identifier }], // Logical identifier(s) for the asset
  "version" : "<string>", // The version of the asset, if any
  "name" : "<string>", // A machine-friendly name for the asset
  "title" : "<string>", // A user-friendly title for the asset
  "type" : { CodeableConcept }, // order-set | protocol | eca-rule
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the asset
  "purpose" : "<string>", // Describes the purpose of the asset
  "usage" : "<string>", // Describes the clinical usage of the asset
  "publicationDate" : "<date>", // Publication date for this version of the asset
  "lastReviewDate" : "<date>", // Last review date for the asset
  "effectivePeriod" : { Period }, // The effective date range for the asset
  "coverage" : [{ UsageContext }], // Describes the context of use for this asset
  "topic" : [{ CodeableConcept }], // Descriptional topics for the asset
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details of the publisher
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ RelatedResource }], // Related resources for the asset
  "library" : [{ Reference(Library) }], // Logic used by the plan definition
  "actionDefinition" : [{ // Action defined by the plan
    "actionIdentifier" : { Identifier }, // Unique identifier
    "label" : "<string>", // User-visible label for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "concept" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedResource }], // Supporting documentation for the intended performer of the action
    "triggerDefinition" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : { // Whether or not the action is applicable
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // Boolean-valued expression
    },
    "relatedAction" : [{ // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before | after | concurrent
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range },
      "anchor" : "<code>" // start | end
    }],
    // timing[x]: When the action should take place. One of these 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participantType" : ["<code>"], // patient | practitioner | related-person
    "type" : { Coding }, // 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
    "activityDefinition" : { Reference(ActivityDefinition) }, // Description of the activity to be performed
    "transform" : { Reference(StructureMap) }, // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "description" : "<string>", // Natural language description of the dynamic value
      "path" : "<string>", // The path to the element to be set dynamically
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // An expression that provides the dynamic value for the customization
    }],
    "actionDefinition" : [{ Content as for PlanDefinition.actionDefinition }] // 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
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PlanDefinition.url [ uri ]; # 0..1 Logical URL to reference this asset
  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the asset
  fhir:PlanDefinition.version [ string ]; # 0..1 The version of the asset, if any
  fhir:PlanDefinition.name [ string ]; # 0..1 A machine-friendly name for the asset
  fhir:PlanDefinition.title [ string ]; # 0..1 A user-friendly title for the asset
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | protocol | eca-rule
  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | inactive
  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:PlanDefinition.description [ string ]; # 0..1 Natural language description of the asset
  fhir:PlanDefinition.purpose [ string ]; # 0..1 Describes the purpose of the asset
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:PlanDefinition.publicationDate [ date ]; # 0..1 Publication date for this version of the asset
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the asset
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the asset
  fhir:PlanDefinition.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this asset
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the asset
  fhir:PlanDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details of the publisher
  fhir:PlanDefinition.copyright [ string ]; # 0..1 Use and/or publishing restrictions
  fhir:PlanDefinition.relatedResource [ RelatedResource ], ... ; # 0..* Related resources for the asset
  fhir:PlanDefinition.library [ Reference(Library) ], ... ; # 0..* Logic used by the plan definition
  fhir:PlanDefinition.actionDefinition [ # 0..* Action defined by the plan
    fhir:PlanDefinition.actionDefinition.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:PlanDefinition.actionDefinition.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:PlanDefinition.actionDefinition.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.actionDefinition.description [ string ]; # 0..1 Short description of the action
    fhir:PlanDefinition.actionDefinition.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.actionDefinition.concept [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:PlanDefinition.actionDefinition.documentation [ RelatedResource ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.actionDefinition.triggerDefinition [ TriggerDefinition ], ... ; # 0..* When the action should be triggered
    fhir:PlanDefinition.actionDefinition.condition [ # 0..1 Whether or not the action is applicable
      fhir:PlanDefinition.actionDefinition.condition.description [ string ]; # 0..1 Natural language description of the condition
      fhir:PlanDefinition.actionDefinition.condition.language [ string ]; # 0..1 Language of the expression
      fhir:PlanDefinition.actionDefinition.condition.expression [ string ]; # 0..1 Boolean-valued expression
    ];
    fhir:PlanDefinition.actionDefinition.relatedAction [ # 0..* Relationship to another action
      fhir:PlanDefinition.actionDefinition.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:PlanDefinition.actionDefinition.relatedAction.relationship [ code ]; # 1..1 before | after | concurrent
      # PlanDefinition.actionDefinition.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.actionDefinition.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.actionDefinition.relatedAction.offsetRange [ Range ]
      fhir:PlanDefinition.actionDefinition.relatedAction.anchor [ code ]; # 0..1 start | end
    ], ...;
    # PlanDefinition.actionDefinition.timing[x] : 0..1 When the action should take place. One of these 5
      fhir:PlanDefinition.actionDefinition.timingDateTime [ dateTime ]
      fhir:PlanDefinition.actionDefinition.timingPeriod [ Period ]
      fhir:PlanDefinition.actionDefinition.timingDuration [ Duration ]
      fhir:PlanDefinition.actionDefinition.timingRange [ Range ]
      fhir:PlanDefinition.actionDefinition.timingTiming [ Timing ]
    fhir:PlanDefinition.actionDefinition.participantType [ code ], ... ; # 0..* patient | practitioner | related-person
    fhir:PlanDefinition.actionDefinition.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:PlanDefinition.actionDefinition.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.actionDefinition.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:PlanDefinition.actionDefinition.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:PlanDefinition.actionDefinition.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.actionDefinition.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:PlanDefinition.actionDefinition.activityDefinition [ Reference(ActivityDefinition) ]; # 0..1 Description of the activity to be performed
    fhir:PlanDefinition.actionDefinition.transform [ Reference(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:PlanDefinition.actionDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:PlanDefinition.actionDefinition.dynamicValue.description [ string ]; # 0..1 Natural language description of the dynamic value
      fhir:PlanDefinition.actionDefinition.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.actionDefinition.dynamicValue.language [ string ]; # 0..1 Language of the expression
      fhir:PlanDefinition.actionDefinition.dynamicValue.expression [ string ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:PlanDefinition.actionDefinition.actionDefinition [ See PlanDefinition.actionDefinition ], ... ; # 0..* A sub-action
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition DomainResourceThe definition of a plan for a series of actions, independent of any specific patient or context
... url Σ0..1uriLogical URL to reference this asset
... identifier Σ0..*IdentifierLogical identifier(s) for the asset
... version Σ0..1stringThe version of the asset, if any
... name Σ0..1stringA machine-friendly name for the asset
... title Σ0..1stringA user-friendly title for the asset
... type Σ0..1CodeableConceptorder-set | protocol | eca-rule
PlanDefinitionType (Extensible)
... status ?!Σ1..1codedraft | active | inactive
LibraryStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the asset
... purpose 0..1stringDescribes the purpose of the asset
... usage 0..1stringDescribes the clinical usage of the asset
... publicationDate 0..1datePublication date for this version of the asset
... lastReviewDate 0..1dateLast review date for the asset
... effectivePeriod 0..1PeriodThe effective date range for the asset
... coverage 0..*UsageContextDescribes the context of use for this asset
... topic 0..*CodeableConceptDescriptional topics for the asset
... contributor 0..*ContributorA content contributor
... publisher 0..1stringName of the publisher (Organization or individual)
... contact 0..*ContactDetailContact details of the publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*RelatedResourceRelated resources for the asset
... library 0..*Reference(Library)Logic used by the plan definition
... actionDefinition 0..*BackboneElementAction defined by the plan
.... actionIdentifier 0..1IdentifierUnique identifier
.... label 0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... concept 0..*CodeableConceptThe meaning of the action or its sub-actions
.... documentation 0..*RelatedResourceSupporting documentation for the intended performer of the action
.... triggerDefinition 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..1BackboneElementWhether or not the action is applicable
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... actionIdentifier 1..1IdentifierIdentifier of the related action
..... relationship 1..1codebefore | after | concurrent
PlanActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
..... anchor 0..1codestart | end
PlanActionRelationshipAnchor (Required)
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participantType 0..*codepatient | practitioner | related-person
PlanActionParticipantType (Required)
.... type 0..1Codingcreate | update | remove | fire-event
PlanActionType (Required)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
PlanActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
PlanActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
PlanActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
PlanActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
PlanActionCardinalityBehavior (Required)
.... activityDefinition 0..1Reference(ActivityDefinition)Description of the activity to be performed
.... transform 0..1Reference(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... description 0..1stringNatural language description of the dynamic value
..... path 0..1stringThe path to the element to be set dynamically
..... language 0..1stringLanguage of the expression
..... expression 0..1stringAn expression that provides the dynamic value for the customization
.... actionDefinition 0..*see actionDefinitionA sub-action

doco Documentation for this format

UML Diagram (Legend)

PlanDefinition (DomainResource)An absolute URL that is used to identify this asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) publishedurl : uri [0..1]A logical identifier for the asset such as the CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifactsidentifier : Identifier [0..*]The version of the asset, if any. 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 machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the assettitle : string [0..1]The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action ruletype : CodeableConcept [0..1] « The type of PlanDefinition (Strength=Extensible)PlanDefinitionType+ »The status of the asset (this element modifies the meaning of other elements)status : code [1..1] « The status of the PlanDefinition (Strength=Required)LibraryStatus! »Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the asset from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the assetpurpose : string [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset was publishedpublicationDate : date [0..1]The date on which the asset content was last reviewedlastReviewDate : date [0..1]The period during which the asset content is effectiveeffectivePeriod : Period [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the asset is applicablecoverage : UsageContext [0..*]Clinical topics related to the content of the assettopic : CodeableConcept [0..*]A contributor to the content of the asset, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the asset (also known as the steward for the asset). This information is required for non-experimental active artifactspublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the assetcopyright : string [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource : RelatedResource [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : Reference [0..*] « Library »ActionDefinitionA unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally uniqueactionIdentifier : Identifier [0..1]A user-visible label for the actionlabel : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short 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 may not be capable of interpreting it dynamicallytextEquivalent : string [0..1]The concept represented by this action or its sub-actionsconcept : 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 : RelatedResource [0..*]A description of when the action should be triggeredtriggerDefinition : TriggerDefinition [0..*]An optional value describing when the action should be performedtiming[x] : Type [0..1] « dateTime|Period|Duration|Range|Timing »The type of participant in the actionparticipantType : code [0..*] « The type of participant for the action (Strength=Required)PlanActionParticipantType! »The type of action to perform (create, update, remove)type : Coding [0..1] « The type of action to be performed (Strength=Required)PlanActionType! »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)PlanActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)PlanActionSelectionBehavior! »Defines the requiredness behavior for the actionrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)PlanActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)PlanActionPrecheckBehavior! »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)PlanActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detailactivityDefinition : Reference [0..1] « ActivityDefinition »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 : Reference [0..1] « StructureMap »ConditionA brief, natural language description of the condition that effectively communicates the intended semanticsdescription : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : string [0..1]RelatedActionThe unique identifier of the related actionactionIdentifier : Identifier [1..1]The relationship of this action to the related actionrelationship : code [1..1] « Defines the types of relationships between actions (Strength=Required)PlanActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : Type [0..1] « Duration|Range »An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related actionanchor : code [0..1] « Defines possible anchors for the relationship between actions (Strength=Required)PlanActionRelationshipAnchor! »DynamicValueA brief, natural language description of the intended semantics of the dynamic valuedescription : string [0..1]The 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 expressionpath : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression specifying the value of the customized elementexpression : string [0..1]An expression specifying whether or not the action is applicable in a given contextcondition[0..1]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[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 definitionactionDefinition[0..*]An action to be taken as part of the planactionDefinition[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URL to reference this asset -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the asset --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the asset, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the asset -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the asset -->
 <type><!-- 0..1 CodeableConcept order-set | protocol | eca-rule --></type>
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the asset -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the asset -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the asset -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the asset -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the asset --></effectivePeriod>
 <coverage><!-- 0..* UsageContext Describes the context of use for this asset --></coverage>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the asset --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details of the publisher --></contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource><!-- 0..* RelatedResource Related resources for the asset --></relatedResource>
 <library><!-- 0..* Reference(Library) Logic used by the plan definition --></library>
 <actionDefinition>  <!-- 0..* Action defined by the plan -->
  <actionIdentifier><!-- 0..1 Identifier Unique identifier --></actionIdentifier>
  <label value="[string]"/><!-- 0..1 User-visible label for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short 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 -->
  <concept><!-- 0..* CodeableConcept The meaning of the action or its sub-actions --></concept>
  <documentation><!-- 0..* RelatedResource Supporting documentation for the intended performer of the action --></documentation>
  <triggerDefinition><!-- 0..* TriggerDefinition When the action should be triggered --></triggerDefinition>
  <condition>  <!-- 0..1 Whether or not the action is applicable -->
   <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
  </condition>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <actionIdentifier><!-- 1..1 Identifier Identifier of the related action --></actionIdentifier>
   <relationship value="[code]"/><!-- 1..1 before | after | concurrent -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
   <anchor value="[code]"/><!-- 0..1 start | end -->
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <participantType value="[code]"/><!-- 0..* patient | practitioner | related-person -->
  <type><!-- 0..1 Coding 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 -->
  <activityDefinition><!-- 0..1 Reference(ActivityDefinition) Description of the activity to be performed --></activityDefinition>
  <transform><!-- 0..1 Reference(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <description value="[string]"/><!-- 0..1 Natural language description of the dynamic value -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <language value="[string]"/><!-- 0..1 Language of the expression -->
   <expression value="[string]"/><!-- 0..1 An expression that provides the dynamic value for the customization -->
  </dynamicValue>
  <actionDefinition><!-- 0..* Content as for PlanDefinition.actionDefinition A sub-action --></actionDefinition>
 </actionDefinition>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URL to reference this asset
  "identifier" : [{ Identifier }], // Logical identifier(s) for the asset
  "version" : "<string>", // The version of the asset, if any
  "name" : "<string>", // A machine-friendly name for the asset
  "title" : "<string>", // A user-friendly title for the asset
  "type" : { CodeableConcept }, // order-set | protocol | eca-rule
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the asset
  "purpose" : "<string>", // Describes the purpose of the asset
  "usage" : "<string>", // Describes the clinical usage of the asset
  "publicationDate" : "<date>", // Publication date for this version of the asset
  "lastReviewDate" : "<date>", // Last review date for the asset
  "effectivePeriod" : { Period }, // The effective date range for the asset
  "coverage" : [{ UsageContext }], // Describes the context of use for this asset
  "topic" : [{ CodeableConcept }], // Descriptional topics for the asset
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details of the publisher
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ RelatedResource }], // Related resources for the asset
  "library" : [{ Reference(Library) }], // Logic used by the plan definition
  "actionDefinition" : [{ // Action defined by the plan
    "actionIdentifier" : { Identifier }, // Unique identifier
    "label" : "<string>", // User-visible label for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "concept" : [{ CodeableConcept }], // The meaning of the action or its sub-actions
    "documentation" : [{ RelatedResource }], // Supporting documentation for the intended performer of the action
    "triggerDefinition" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : { // Whether or not the action is applicable
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // Boolean-valued expression
    },
    "relatedAction" : [{ // Relationship to another action
      "actionIdentifier" : { Identifier }, // R!  Identifier of the related action
      "relationship" : "<code>", // R!  before | after | concurrent
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range },
      "anchor" : "<code>" // start | end
    }],
    // timing[x]: When the action should take place. One of these 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participantType" : ["<code>"], // patient | practitioner | related-person
    "type" : { Coding }, // 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
    "activityDefinition" : { Reference(ActivityDefinition) }, // Description of the activity to be performed
    "transform" : { Reference(StructureMap) }, // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "description" : "<string>", // Natural language description of the dynamic value
      "path" : "<string>", // The path to the element to be set dynamically
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // An expression that provides the dynamic value for the customization
    }],
    "actionDefinition" : [{ Content as for PlanDefinition.actionDefinition }] // 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
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PlanDefinition.url [ uri ]; # 0..1 Logical URL to reference this asset
  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the asset
  fhir:PlanDefinition.version [ string ]; # 0..1 The version of the asset, if any
  fhir:PlanDefinition.name [ string ]; # 0..1 A machine-friendly name for the asset
  fhir:PlanDefinition.title [ string ]; # 0..1 A user-friendly title for the asset
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | protocol | eca-rule
  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | inactive
  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:PlanDefinition.description [ string ]; # 0..1 Natural language description of the asset
  fhir:PlanDefinition.purpose [ string ]; # 0..1 Describes the purpose of the asset
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:PlanDefinition.publicationDate [ date ]; # 0..1 Publication date for this version of the asset
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the asset
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the asset
  fhir:PlanDefinition.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this asset
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the asset
  fhir:PlanDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details of the publisher
  fhir:PlanDefinition.copyright [ string ]; # 0..1 Use and/or publishing restrictions
  fhir:PlanDefinition.relatedResource [ RelatedResource ], ... ; # 0..* Related resources for the asset
  fhir:PlanDefinition.library [ Reference(Library) ], ... ; # 0..* Logic used by the plan definition
  fhir:PlanDefinition.actionDefinition [ # 0..* Action defined by the plan
    fhir:PlanDefinition.actionDefinition.actionIdentifier [ Identifier ]; # 0..1 Unique identifier
    fhir:PlanDefinition.actionDefinition.label [ string ]; # 0..1 User-visible label for the action (e.g. 1. or A.)
    fhir:PlanDefinition.actionDefinition.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.actionDefinition.description [ string ]; # 0..1 Short description of the action
    fhir:PlanDefinition.actionDefinition.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.actionDefinition.concept [ CodeableConcept ], ... ; # 0..* The meaning of the action or its sub-actions
    fhir:PlanDefinition.actionDefinition.documentation [ RelatedResource ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.actionDefinition.triggerDefinition [ TriggerDefinition ], ... ; # 0..* When the action should be triggered
    fhir:PlanDefinition.actionDefinition.condition [ # 0..1 Whether or not the action is applicable
      fhir:PlanDefinition.actionDefinition.condition.description [ string ]; # 0..1 Natural language description of the condition
      fhir:PlanDefinition.actionDefinition.condition.language [ string ]; # 0..1 Language of the expression
      fhir:PlanDefinition.actionDefinition.condition.expression [ string ]; # 0..1 Boolean-valued expression
    ];
    fhir:PlanDefinition.actionDefinition.relatedAction [ # 0..* Relationship to another action
      fhir:PlanDefinition.actionDefinition.relatedAction.actionIdentifier [ Identifier ]; # 1..1 Identifier of the related action
      fhir:PlanDefinition.actionDefinition.relatedAction.relationship [ code ]; # 1..1 before | after | concurrent
      # PlanDefinition.actionDefinition.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.actionDefinition.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.actionDefinition.relatedAction.offsetRange [ Range ]
      fhir:PlanDefinition.actionDefinition.relatedAction.anchor [ code ]; # 0..1 start | end
    ], ...;
    # PlanDefinition.actionDefinition.timing[x] : 0..1 When the action should take place. One of these 5
      fhir:PlanDefinition.actionDefinition.timingDateTime [ dateTime ]
      fhir:PlanDefinition.actionDefinition.timingPeriod [ Period ]
      fhir:PlanDefinition.actionDefinition.timingDuration [ Duration ]
      fhir:PlanDefinition.actionDefinition.timingRange [ Range ]
      fhir:PlanDefinition.actionDefinition.timingTiming [ Timing ]
    fhir:PlanDefinition.actionDefinition.participantType [ code ], ... ; # 0..* patient | practitioner | related-person
    fhir:PlanDefinition.actionDefinition.type [ Coding ]; # 0..1 create | update | remove | fire-event
    fhir:PlanDefinition.actionDefinition.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.actionDefinition.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:PlanDefinition.actionDefinition.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:PlanDefinition.actionDefinition.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.actionDefinition.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:PlanDefinition.actionDefinition.activityDefinition [ Reference(ActivityDefinition) ]; # 0..1 Description of the activity to be performed
    fhir:PlanDefinition.actionDefinition.transform [ Reference(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:PlanDefinition.actionDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:PlanDefinition.actionDefinition.dynamicValue.description [ string ]; # 0..1 Natural language description of the dynamic value
      fhir:PlanDefinition.actionDefinition.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.actionDefinition.dynamicValue.language [ string ]; # 0..1 Language of the expression
      fhir:PlanDefinition.actionDefinition.dynamicValue.expression [ string ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:PlanDefinition.actionDefinition.actionDefinition [ See PlanDefinition.actionDefinition ], ... ; # 0..* A sub-action
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

14.2.3.1 Terminology Bindings

PathDefinitionTypeReference
PlanDefinition.type The type of PlanDefinitionExtensiblePlanDefinitionType
PlanDefinition.status The status of the PlanDefinitionRequiredLibraryStatus
PlanDefinition.actionDefinition.relatedAction.relationship Defines the types of relationships between actionsRequiredPlanActionRelationshipType
PlanDefinition.actionDefinition.relatedAction.anchor Defines possible anchors for the relationship between actionsRequiredPlanActionRelationshipAnchor
PlanDefinition.actionDefinition.participantType The type of participant for the actionRequiredPlanActionParticipantType
PlanDefinition.actionDefinition.type The type of action to be performedRequiredPlanActionType
PlanDefinition.actionDefinition.groupingBehavior Defines organization behavior of a groupRequiredPlanActionGroupingBehavior
PlanDefinition.actionDefinition.selectionBehavior Defines selection behavior of a groupRequiredPlanActionSelectionBehavior
PlanDefinition.actionDefinition.requiredBehavior Defines requiredness behavior for selecting an action or an action groupRequiredPlanActionRequiredBehavior
PlanDefinition.actionDefinition.precheckBehavior Defines selection frequency behavior for an action or groupRequiredPlanActionPrecheckBehavior
PlanDefinition.actionDefinition.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeatedRequiredPlanActionCardinalityBehavior

14.2.4 Search Parameters

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

NameTypeDescriptionPaths
descriptionstringText search against the descriptionPlanDefinition.description
identifiertokenLogical identifier for the module (e.g. CMS-143)PlanDefinition.identifier
statustokenStatus of the modulePlanDefinition.status
titlestringText search against the titlePlanDefinition.title
topictokenTopics associated with the modulePlanDefinition.topic
versionstringVersion of the module (e.g. 1.0.0)PlanDefinition.version