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
Detailed Descriptions for the elements in the PlanDefinition resource.
PlanDefinition | |
Definition | 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. |
Control | 1..1 |
PlanDefinition.url | |
Definition | 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) published. |
Control | 0..1 |
Type | uri |
Requirements | Allows the asset to be referenced by a single globally unique identifier. |
Summary | true |
PlanDefinition.identifier | |
Definition | 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 artifacts. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows external business identifiers to be easily associated with the asset. |
Summary | true |
To Do | Add constraint to require an identifier for non-experimental active artifacts. |
PlanDefinition.version | |
Definition | 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 artifacts. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Requirements | Allows for versioning of the content of the asset. |
Summary | true |
To Do | Add constraint to require a version for non-experimental active artifacts. |
PlanDefinition.name | |
Definition | 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 generation. |
Control | 0..1 |
Type | string |
Requirements | Simplifies machine-processing tasks related to the asset such as code-generation or logging. |
Summary | true |
Comments | This identifier for the asset should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z][A-Za-z0-9]*). |
PlanDefinition.title | |
Definition | A short, descriptive, user-friendly title for the asset. |
Control | 0..1 |
Type | string |
Summary | true |
PlanDefinition.type | |
Definition | The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule. |
Control | 0..1 |
Binding | PlanDefinitionType: The type of PlanDefinition (Extensible) |
Type | CodeableConcept |
Summary | true |
PlanDefinition.status | |
Definition | The status of the asset. |
Control | 1..1 |
Binding | LibraryStatus: The status of the PlanDefinition (Required) |
Type | code |
Is Modifier | true |
Requirements | Enables tracking the life-cycle of the content of the asset. |
Summary | true |
PlanDefinition.experimental | |
Definition | Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level asset would. |
Summary | true |
PlanDefinition.description | |
Definition | A free text natural language description of the asset from the consumer's perspective. |
Control | 0..1 |
Type | string |
Comments | This description can be used to capture details such as why the asset was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the asset as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. |
PlanDefinition.purpose | |
Definition | A brief description of the purpose of the asset. |
Control | 0..1 |
Type | string |
Comments | This description should address the question of why this asset was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element. |
PlanDefinition.usage | |
Definition | A detailed description of how the asset is used from a clinical perspective. |
Control | 0..1 |
Type | string |
PlanDefinition.publicationDate | |
Definition | The date on which the asset was published. |
Control | 0..1 |
Type | date |
PlanDefinition.lastReviewDate | |
Definition | The date on which the asset content was last reviewed. |
Control | 0..1 |
Type | date |
PlanDefinition.effectivePeriod | |
Definition | The period during which the asset content is effective. |
Control | 0..1 |
Type | Period |
Comments | The effective period for an asset determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015. |
PlanDefinition.coverage | |
Definition | Specifies various attributes of the patient population for whom and/or environment of care in which, the asset is applicable. |
Control | 0..* |
Type | UsageContext |
Requirements | Consumers of the asset must be able to determine the intended applicability for the asset. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed. |
PlanDefinition.topic | |
Definition | Clinical topics related to the content of the asset. |
Control | 0..* |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. |
PlanDefinition.contributor | |
Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. |
Control | 0..* |
Type | Contributor |
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the asset. |
PlanDefinition.publisher | |
Definition | 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 artifacts. |
Control | 0..1 |
Type | string |
Requirements | Consumers of the asset must be able to determine where to obtain support in the use of this asset, as well as where to direct questions and concerns about the content. |
Comments | The publisher (or steward) of the asset is the organization or individual primarily responsible for the maintenance and upkeep of the asset. This is not necessarily the same organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the asset. |
To Do | Add constraint to require a publisher for non-experimental active artifacts. |
PlanDefinition.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
PlanDefinition.copyright | |
Definition | A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the asset. |
Control | 0..1 |
Type | string |
Requirements | Consumers of the asset must be able to determine any legal restrictions on the use of the asset and/or its content. |
PlanDefinition.relatedResource | |
Definition | Related resources such as additional documentation, justification, or bibliographic references. |
Control | 0..* |
Type | RelatedResource |
Requirements | Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. |
Comments | Each related resource is either an attachment, or a reference to another resource, but not both. |
PlanDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the plan definition. |
Control | 0..* |
Type | Reference(Library) |
PlanDefinition.actionDefinition | |
Definition | An action to be taken as part of the plan. |
Control | 0..* |
PlanDefinition.actionDefinition.actionIdentifier | |
Definition | A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique. |
Control | 0..1 |
Type | Identifier |
PlanDefinition.actionDefinition.label | |
Definition | A user-visible label for the action. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.title | |
Definition | The title of the action displayed to a user. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.description | |
Definition | A short description of the action used to provide a summary to display to the user. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.textEquivalent | |
Definition | 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 dynamically. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.concept | |
Definition | The concept represented by this action or its sub-actions. |
Control | 0..* |
Type | CodeableConcept |
PlanDefinition.actionDefinition.documentation | |
Definition | 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 resources. |
Control | 0..* |
Type | RelatedResource |
PlanDefinition.actionDefinition.triggerDefinition | |
Definition | A description of when the action should be triggered. |
Control | 0..* |
Type | TriggerDefinition |
PlanDefinition.actionDefinition.condition | |
Definition | An expression specifying whether or not the action is applicable in a given context. |
Control | 0..1 |
PlanDefinition.actionDefinition.condition.description | |
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.condition.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.condition.expression | |
Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
PlanDefinition.actionDefinition.relatedAction | |
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". |
Control | 0..* |
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency. |
PlanDefinition.actionDefinition.relatedAction.actionIdentifier | |
Definition | The unique identifier of the related action. |
Control | 1..1 |
Type | Identifier |
PlanDefinition.actionDefinition.relatedAction.relationship | |
Definition | The relationship of this action to the related action. |
Control | 1..1 |
Binding | PlanActionRelationshipType: Defines the types of relationships between actions (Required) |
Type | code |
PlanDefinition.actionDefinition.relatedAction.offset[x] | |
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
Control | 0..1 |
Type | Duration|Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
PlanDefinition.actionDefinition.relatedAction.anchor | |
Definition | 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 action. |
Control | 0..1 |
Binding | PlanActionRelationshipAnchor: Defines possible anchors for the relationship between actions (Required) |
Type | code |
PlanDefinition.actionDefinition.timing[x] | |
Definition | An optional value describing when the action should be performed. |
Control | 0..1 |
Type | dateTime|Period|Duration|Range|Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
PlanDefinition.actionDefinition.participantType | |
Definition | The type of participant in the action. |
Control | 0..* |
Binding | PlanActionParticipantType: The type of participant for the action (Required) |
Type | code |
PlanDefinition.actionDefinition.type | |
Definition | The type of action to perform (create, update, remove). |
Control | 0..1 |
Binding | PlanActionType: The type of action to be performed (Required) |
Type | Coding |
PlanDefinition.actionDefinition.groupingBehavior | |
Definition | Defines the grouping behavior for the action and its children. |
Control | 0..1 |
Binding | PlanActionGroupingBehavior: Defines organization behavior of a group (Required) |
Type | code |
PlanDefinition.actionDefinition.selectionBehavior | |
Definition | Defines the selection behavior for the action and its children. |
Control | 0..1 |
Binding | PlanActionSelectionBehavior: Defines selection behavior of a group (Required) |
Type | code |
PlanDefinition.actionDefinition.requiredBehavior | |
Definition | Defines the requiredness behavior for the action. |
Control | 0..1 |
Binding | PlanActionRequiredBehavior: Defines requiredness behavior for selecting an action or an action group (Required) |
Type | code |
PlanDefinition.actionDefinition.precheckBehavior | |
Definition | Defines whether the action should usually be preselected. |
Control | 0..1 |
Binding | PlanActionPrecheckBehavior: Defines selection frequency behavior for an action or group (Required) |
Type | code |
PlanDefinition.actionDefinition.cardinalityBehavior | |
Definition | Defines whether the action can be selected multiple times. |
Control | 0..1 |
Binding | PlanActionCardinalityBehavior: Defines behavior for an action or a group for how many times that item may be repeated (Required) |
Type | code |
PlanDefinition.actionDefinition.activityDefinition | |
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail. |
Control | 0..1 |
Type | Reference(ActivityDefinition) |
Comments | Note that the resource is optional, and if no resource is specified, a dynamicValue with a root (/) path can be used to define the entire resource dynamically. |
PlanDefinition.actionDefinition.transform | |
Definition | 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 input. |
Control | 0..1 |
Type | Reference(StructureMap) |
PlanDefinition.actionDefinition.dynamicValue | |
Definition | 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 result. |
Control | 0..* |
PlanDefinition.actionDefinition.dynamicValue.description | |
Definition | A brief, natural language description of the intended semantics of the dynamic value. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.dynamicValue.path | |
Definition | 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 expression. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.dynamicValue.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
PlanDefinition.actionDefinition.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
PlanDefinition.actionDefinition.actionDefinition | |
Definition | 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 definition. |
Control | 0..* |
Type | See PlanDefinition.actionDefinition |