Resource type: plandefinition

Description

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.

Elements

PathShortDefinitionComments
The definition of a plan for a series of actions, independent of any specific patient or contextThis 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.
urlCanonical identifier for this plan definition, represented as a URI (globally unique)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 servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the plan definitionA 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 instance.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the plan definitionThe 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 artifacts.There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
nameName for this plan definition (computer friendly)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 generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this plan definition (human friendly)A short, descriptive, user-friendly title for the plan definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the plan definitionAn explanatory or alternate title for the plan definition giving additional information about its content.
typeorder-set | clinical-protocol | eca-rule | workflow-definitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
statusdraft | active | retired | unknownThe status of this plan definition. Enables tracking the life-cycle of the content.Allows filtering of plan definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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 usage.Allows filtering of plan definitions that are appropriate for use versus not.
subject[x]Type of individual the plan definition is focused onA code or group definition that describes the intended subject of the plan definition.
dateDate last changedThe 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 changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the plan definition.Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the plan definitionA free text natural language description of the plan definition from a consumer's perspective.This description can be used to capture details such as why the plan definition 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 plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
useContextThe context that the content is intended to supportThe 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 instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for plan definition (if applicable)A legal or geographic region in which the plan definition is intended to be used.It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this plan definition is definedExplanation of why this plan definition is needed and why it has been designed as it has.This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
usageDescribes the clinical usage of the planA detailed description of how the plan definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA 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 definition.
approvalDateWhen the plan definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the plan definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the plan definition is expected to be usedThe period during which the plan definition content was or is planned to be in active use.The effective period for a plan definition 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 might be published in 2015.
topicE.g. Education, Treatment, AssessmentDescriptive 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 searching.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citationsRelated artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the plan definitionA reference to a Library resource containing any formal logic used by the plan definition.
goalWhat the plan is trying to accomplishGoals 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, etc.
goal.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.categoryE.g. Treatment, dietary, behavioralIndicates a category the goal falls within.
goal.descriptionCode or text describing the goalHuman-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".If no code is available, use CodeableConcept.text.
goal.priorityhigh-priority | medium-priority | low-priorityIdentifies the expected level of importance associated with reaching/sustaining the defined goal.
goal.startWhen goal pursuit beginsThe event after which the goal should begin being pursued.
goal.addressesWhat does the goal addressIdentifies problems, conditions, issues, or concerns the goal is intended to address.
goal.documentationSupporting documentation for the goalDidactic 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 resources.
goal.targetTarget outcome for the goalIndicates what should be done and within what timeframe.
goal.target.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.target.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.measureThe parameter whose value is to be trackedThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
goal.target.detail[x]The target value to be achievedThe 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 value.
goal.target.dueReach goal withinIndicates the timeframe after the start of the goal in which the goal should be met.
actionAction defined by the planAn action or group of actions to be taken as part of the plan.Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionBrief description of the actionA brief description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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 dynamically.
action.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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 template.
action.reasonWhy the action should be performedA description of why this action is necessary or appropriate.This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
action.documentationSupporting documentation for the intended performer of the actionDidactic 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.
action.goalIdWhat goals this action supportsIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
action.subject[x]Type of individual the action is focused onA code or group definition that describes the intended subject of the action and its children, if any.The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
action.triggerWhen the action should be triggeredA description of when the action should be triggered.
action.conditionWhether or not the action is applicableAn expression that describes applicability criteria or start/stop conditions for the action.When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
action.condition.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.kindapplicability | start | stopThe kind of condition.Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
action.condition.expressionBoolean-valued expressionAn expression that returns true or false, indicating whether the condition is satisfied.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.inputInput data requirementsDefines input data requirements for the action.
action.outputOutput data definitionDefines the outputs of the action, if any.
action.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".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.
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.actionIdWhat action is this related toThe element id of the related action.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should participate in the actionIndicates who should participate in performing the action described.
action.participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
action.participant.roleE.g. Nurse, Surgeon, ParentThe role the participant should play in performing the described action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines the required behavior for the action.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.definition[x]Description of the activity to be performedA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
action.transformTransform to apply the templateA 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.Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValueDynamic aspects of the definitionCustomizations 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.Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.pathThe path to the element to be set dynamicallyThe 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).To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
action.dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.actionA sub-actionSub 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.

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.

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.

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.

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).

Search Parameters

composed-ofWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='composed-of').resource
contextA use context assigned to the plan definition(PlanDefinition.useContext.value as CodeableConcept)
context-quantityA quantity- or range-valued use context assigned to the plan definition(PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)
context-typeA type of use context assigned to the plan definitionPlanDefinition.useContext.code
dateThe plan definition publication datePlanDefinition.date
definitionActivity or plan definitions used by plan definitionPlanDefinition.action.definition
depends-onWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
derived-fromWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='derived-from').resource
descriptionThe description of the plan definitionPlanDefinition.description
effectiveThe time during which the plan definition is intended to be in usePlanDefinition.effectivePeriod
identifierExternal identifier for the plan definitionPlanDefinition.identifier
jurisdictionIntended jurisdiction for the plan definitionPlanDefinition.jurisdiction
nameComputationally friendly name of the plan definitionPlanDefinition.name
predecessorWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='predecessor').resource
publisherName of the publisher of the plan definitionPlanDefinition.publisher
statusThe current status of the plan definitionPlanDefinition.status
successorWhat resource is being referencedPlanDefinition.relatedArtifact.where(type='successor').resource
titleThe human-friendly name of the plan definitionPlanDefinition.title
topicTopics associated with the modulePlanDefinition.topic
typeThe type of artifact the plan (e.g. order-set, eca-rule, protocol)PlanDefinition.type
urlThe uri that identifies the plan definitionPlanDefinition.url
versionThe business version of the plan definitionPlanDefinition.version
context-type-quantityA use context type and quantity- or range-based value assigned to the plan definitionPlanDefinition.useContext
context-type-valueA use context type and value assigned to the plan definitionPlanDefinition.useContext

Extension Definitions

These are extension definitions for this resource defined by the spec

Profiles based on this resource

Shareable PlanDefinition

Enforces the minimum information set for the plan definition metadata required by HL7 and other organizations that share and publish plan definitions

Elements

PathShortDefinitionComments
The definition of a plan for a series of actions, independent of any specific patient or contextThis 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.
urlCanonical identifier for this plan definition, represented as a URI (globally unique)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 servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the plan definitionA 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 instance.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the plan definitionThe 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 artifacts.There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
nameName for this plan definition (computer friendly)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 generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this plan definition (human friendly)A short, descriptive, user-friendly title for the plan definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the plan definitionAn explanatory or alternate title for the plan definition giving additional information about its content.
typeorder-set | clinical-protocol | eca-rule | workflow-definitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
statusdraft | active | retired | unknownThe status of this plan definition. Enables tracking the life-cycle of the content.Allows filtering of plan definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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 usage.Allows filtering of plan definitions that are appropriate for use versus not.
subject[x]Type of individual the plan definition is focused onA code or group definition that describes the intended subject of the plan definition.
dateDate last changedThe 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 changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the plan definition.Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the plan definitionA free text natural language description of the plan definition from a consumer's perspective.This description can be used to capture details such as why the plan definition 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 plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
useContextThe context that the content is intended to supportThe 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 instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for plan definition (if applicable)A legal or geographic region in which the plan definition is intended to be used.It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this plan definition is definedExplanation of why this plan definition is needed and why it has been designed as it has.This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
usageDescribes the clinical usage of the planA detailed description of how the plan definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA 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 definition.
approvalDateWhen the plan definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the plan definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the plan definition is expected to be usedThe period during which the plan definition content was or is planned to be in active use.The effective period for a plan definition 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 might be published in 2015.
topicE.g. Education, Treatment, AssessmentDescriptive 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 searching.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citationsRelated artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the plan definitionA reference to a Library resource containing any formal logic used by the plan definition.
goalWhat the plan is trying to accomplishGoals 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, etc.
goal.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.categoryE.g. Treatment, dietary, behavioralIndicates a category the goal falls within.
goal.descriptionCode or text describing the goalHuman-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".If no code is available, use CodeableConcept.text.
goal.priorityhigh-priority | medium-priority | low-priorityIdentifies the expected level of importance associated with reaching/sustaining the defined goal.
goal.startWhen goal pursuit beginsThe event after which the goal should begin being pursued.
goal.addressesWhat does the goal addressIdentifies problems, conditions, issues, or concerns the goal is intended to address.
goal.documentationSupporting documentation for the goalDidactic 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 resources.
goal.targetTarget outcome for the goalIndicates what should be done and within what timeframe.
goal.target.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.target.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.measureThe parameter whose value is to be trackedThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
goal.target.detail[x]The target value to be achievedThe 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 value.
goal.target.dueReach goal withinIndicates the timeframe after the start of the goal in which the goal should be met.
actionAction defined by the planAn action or group of actions to be taken as part of the plan.Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionBrief description of the actionA brief description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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 dynamically.
action.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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 template.
action.reasonWhy the action should be performedA description of why this action is necessary or appropriate.This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
action.documentationSupporting documentation for the intended performer of the actionDidactic 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.
action.goalIdWhat goals this action supportsIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
action.subject[x]Type of individual the action is focused onA code or group definition that describes the intended subject of the action and its children, if any.The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
action.triggerWhen the action should be triggeredA description of when the action should be triggered.
action.conditionWhether or not the action is applicableAn expression that describes applicability criteria or start/stop conditions for the action.When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
action.condition.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.kindapplicability | start | stopThe kind of condition.Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
action.condition.expressionBoolean-valued expressionAn expression that returns true or false, indicating whether the condition is satisfied.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.inputInput data requirementsDefines input data requirements for the action.
action.outputOutput data definitionDefines the outputs of the action, if any.
action.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".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.
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.actionIdWhat action is this related toThe element id of the related action.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should participate in the actionIndicates who should participate in performing the action described.
action.participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
action.participant.roleE.g. Nurse, Surgeon, ParentThe role the participant should play in performing the described action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines the required behavior for the action.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.definition[x]Description of the activity to be performedA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
action.transformTransform to apply the templateA 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.Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValueDynamic aspects of the definitionCustomizations 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.Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.pathThe path to the element to be set dynamicallyThe 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).To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
action.dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.actionA sub-actionSub 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.

Computable PlanDefinition

Defines a computable PlanDefinition that specifies a single library and requires all expressions referenced from the PlanDefinition to be definitions in that single library

Elements

PathShortDefinitionComments
The definition of a plan for a series of actions, independent of any specific patient or contextThis 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.
urlCanonical identifier for this plan definition, represented as a URI (globally unique)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 servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the plan definitionA 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 instance.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the plan definitionThe 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 artifacts.There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
nameName for this plan definition (computer friendly)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 generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this plan definition (human friendly)A short, descriptive, user-friendly title for the plan definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the plan definitionAn explanatory or alternate title for the plan definition giving additional information about its content.
typeorder-set | clinical-protocol | eca-rule | workflow-definitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
statusdraft | active | retired | unknownThe status of this plan definition. Enables tracking the life-cycle of the content.Allows filtering of plan definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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 usage.Allows filtering of plan definitions that are appropriate for use versus not.
subject[x]Type of individual the plan definition is focused onA code or group definition that describes the intended subject of the plan definition.
dateDate last changedThe 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 changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the plan definition.Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the plan definitionA free text natural language description of the plan definition from a consumer's perspective.This description can be used to capture details such as why the plan definition 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 plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
useContextThe context that the content is intended to supportThe 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 instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for plan definition (if applicable)A legal or geographic region in which the plan definition is intended to be used.It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this plan definition is definedExplanation of why this plan definition is needed and why it has been designed as it has.This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
usageDescribes the clinical usage of the planA detailed description of how the plan definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA 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 definition.
approvalDateWhen the plan definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the plan definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the plan definition is expected to be usedThe period during which the plan definition content was or is planned to be in active use.The effective period for a plan definition 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 might be published in 2015.
topicE.g. Education, Treatment, AssessmentDescriptive 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 searching.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citationsRelated artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the plan definitionA reference to a Library resource containing any formal logic used by the plan definition.
goalWhat the plan is trying to accomplishGoals 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, etc.
goal.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.categoryE.g. Treatment, dietary, behavioralIndicates a category the goal falls within.
goal.descriptionCode or text describing the goalHuman-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".If no code is available, use CodeableConcept.text.
goal.priorityhigh-priority | medium-priority | low-priorityIdentifies the expected level of importance associated with reaching/sustaining the defined goal.
goal.startWhen goal pursuit beginsThe event after which the goal should begin being pursued.
goal.addressesWhat does the goal addressIdentifies problems, conditions, issues, or concerns the goal is intended to address.
goal.documentationSupporting documentation for the goalDidactic 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 resources.
goal.targetTarget outcome for the goalIndicates what should be done and within what timeframe.
goal.target.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.target.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.measureThe parameter whose value is to be trackedThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
goal.target.detail[x]The target value to be achievedThe 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 value.
goal.target.dueReach goal withinIndicates the timeframe after the start of the goal in which the goal should be met.
actionAction defined by the planAn action or group of actions to be taken as part of the plan.Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionBrief description of the actionA brief description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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 dynamically.
action.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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 template.
action.reasonWhy the action should be performedA description of why this action is necessary or appropriate.This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
action.documentationSupporting documentation for the intended performer of the actionDidactic 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.
action.goalIdWhat goals this action supportsIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
action.subject[x]Type of individual the action is focused onA code or group definition that describes the intended subject of the action and its children, if any.The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
action.triggerWhen the action should be triggeredA description of when the action should be triggered.
action.conditionWhether or not the action is applicableAn expression that describes applicability criteria or start/stop conditions for the action.When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
action.condition.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.kindapplicability | start | stopThe kind of condition.Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
action.condition.expressionBoolean-valued expressionAn expression that returns true or false, indicating whether the condition is satisfied.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.inputInput data requirementsDefines input data requirements for the action.
action.outputOutput data definitionDefines the outputs of the action, if any.
action.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".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.
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.actionIdWhat action is this related toThe element id of the related action.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should participate in the actionIndicates who should participate in performing the action described.
action.participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
action.participant.roleE.g. Nurse, Surgeon, ParentThe role the participant should play in performing the described action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines the required behavior for the action.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.definition[x]Description of the activity to be performedA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
action.transformTransform to apply the templateA 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.Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValueDynamic aspects of the definitionCustomizations 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.Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.pathThe path to the element to be set dynamicallyThe 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).To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
action.dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.actionA sub-actionSub 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.

CDS Hooks Service PlanDefinition

Defines a PlanDefinition that implements the behavior for a CDS Hooks service

Elements

PathShortDefinitionComments
The definition of a plan for a series of actions, independent of any specific patient or contextThis 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.
urlCanonical identifier for this plan definition, represented as a URI (globally unique)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 servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the plan definitionA 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 instance.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the plan definitionThe 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 artifacts.There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
nameName for this plan definition (computer friendly)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 generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this plan definition (human friendly)A short, descriptive, user-friendly title for the plan definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the plan definitionAn explanatory or alternate title for the plan definition giving additional information about its content.
typeorder-set | clinical-protocol | eca-rule | workflow-definitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
statusdraft | active | retired | unknownThe status of this plan definition. Enables tracking the life-cycle of the content.Allows filtering of plan definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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 usage.Allows filtering of plan definitions that are appropriate for use versus not.
subject[x]Type of individual the plan definition is focused onA code or group definition that describes the intended subject of the plan definition.
dateDate last changedThe 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 changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the plan definition.Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the plan definitionA free text natural language description of the plan definition from a consumer's perspective.This description can be used to capture details such as why the plan definition 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 plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
useContextThe context that the content is intended to supportThe 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 instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for plan definition (if applicable)A legal or geographic region in which the plan definition is intended to be used.It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this plan definition is definedExplanation of why this plan definition is needed and why it has been designed as it has.This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
usageDescribes the clinical usage of the planA detailed description of how the plan definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA 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 definition.
approvalDateWhen the plan definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the plan definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the plan definition is expected to be usedThe period during which the plan definition content was or is planned to be in active use.The effective period for a plan definition 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 might be published in 2015.
topicE.g. Education, Treatment, AssessmentDescriptive 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 searching.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citationsRelated artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the plan definitionA reference to a Library resource containing any formal logic used by the plan definition.
goalWhat the plan is trying to accomplishGoals 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, etc.
goal.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.categoryE.g. Treatment, dietary, behavioralIndicates a category the goal falls within.
goal.descriptionCode or text describing the goalHuman-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".If no code is available, use CodeableConcept.text.
goal.priorityhigh-priority | medium-priority | low-priorityIdentifies the expected level of importance associated with reaching/sustaining the defined goal.
goal.startWhen goal pursuit beginsThe event after which the goal should begin being pursued.
goal.addressesWhat does the goal addressIdentifies problems, conditions, issues, or concerns the goal is intended to address.
goal.documentationSupporting documentation for the goalDidactic 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 resources.
goal.targetTarget outcome for the goalIndicates what should be done and within what timeframe.
goal.target.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
goal.target.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
goal.target.measureThe parameter whose value is to be trackedThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
goal.target.detail[x]The target value to be achievedThe 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 value.
goal.target.dueReach goal withinIndicates the timeframe after the start of the goal in which the goal should be met.
actionAction defined by the planAn action or group of actions to be taken as part of the plan.Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionBrief description of the actionA brief description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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 dynamically.
action.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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 template.
action.reasonWhy the action should be performedA description of why this action is necessary or appropriate.This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
action.documentationSupporting documentation for the intended performer of the actionDidactic 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.
action.goalIdWhat goals this action supportsIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
action.subject[x]Type of individual the action is focused onA code or group definition that describes the intended subject of the action and its children, if any.The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
action.triggerWhen the action should be triggeredA description of when the action should be triggered.
action.conditionWhether or not the action is applicableAn expression that describes applicability criteria or start/stop conditions for the action.When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
action.condition.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.condition.kindapplicability | start | stopThe kind of condition.Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
action.condition.expressionBoolean-valued expressionAn expression that returns true or false, indicating whether the condition is satisfied.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.inputInput data requirementsDefines input data requirements for the action.
action.outputOutput data definitionDefines the outputs of the action, if any.
action.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".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.
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.relatedAction.actionIdWhat action is this related toThe element id of the related action.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should participate in the actionIndicates who should participate in performing the action described.
action.participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
action.participant.roleE.g. Nurse, Surgeon, ParentThe role the participant should play in performing the described action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines the required behavior for the action.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.definition[x]Description of the activity to be performedA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
action.transformTransform to apply the templateA 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.Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValueDynamic aspects of the definitionCustomizations 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.Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
action.dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
action.dynamicValue.pathThe path to the element to be set dynamicallyThe 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).To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
action.dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
action.actionA sub-actionSub 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.