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.

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this plan definition is (or will be) published.

Allows the plan definition to be referenced by a single globally unique identifier.

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 URL SHOULD include the major version of the plan definition. For more information see Technical and Business Versions.

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active 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].

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.

Support human navigation and code generation.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable 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.

The type of artifact the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.

The status of this plan definition. Enables tracking the life-cycle of the content.

Allows filtering of plan definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired plan definition without due consideration.

A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

Allows filtering of plan definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production.

The date (and optionally time) when the plan definition was published. The date must change if and 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.

The name of the individual or organization that published the plan definition.

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

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.

A 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 profile is presumed to be the predominant language in the place the profile was created).

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

A detailed description of how the plan definition is used from a clinical perspective.

The 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 / editorial corrections.

The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

If specified, this is usually after the approval date.

The period during which the plan definition content was or is planned to be in active use.

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the plan definition are or are expected to be used instead.

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.

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.

Assist in searching for appropriate content.

When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

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.

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

A contributor to the content of the plan definition, including authors, editors, reviewers, and endorsers.

Consumers of the content must be able to quickly determine who contributed to the content of the plan definition.

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.

Related artifacts such as additional documentation, justification, or bibliographic references.

Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Each related artifact is either an attachment, or a reference to another resource, but not both.

A reference to a Library resource containing any formal logic used by the plan definition.

Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.

Indicates a category the goal falls within.

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

If no code is available, use CodeableConcept.text.

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

The event after which the goal should begin being pursued.

Identifies problems, conditions, issues, or concerns the goal is intended to address.

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

Indicates what should be done and within what timeframe.

The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level.

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan 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.

Indicates the timeframe after the start of the goal in which the goal should be met.

An action to be taken as part of the plan.

A user-visible prefix for the action.

The title of the action displayed to a user.

A short description of the action used to provide a summary to display to the user.

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.

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

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

A description of when the action should be triggered.

An expression that describes applicability criteria, or start/stop conditions for the action.

The 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 when enter/exit criteria for an action.

A brief, natural language description of the condition that effectively communicates the intended semantics.

The media type of the language for the expression.

An expression that returns true or false, indicating whether or not 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.

Defines input data requirements for the action.

Defines the outputs of the action, if any.

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

The element id of the related action.

The relationship of this action to the related action.

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

An optional value describing when the action should be performed.

Indicates who should participate in performing the action described.

The type of participant in the action.

The role the participant should play in performing the described action.

The type of action to perform (create, update, remove).

Defines the grouping behavior for the action and its children.

Defines the selection behavior for the action and its children.

Defines the requiredness behavior for the action.

Defines whether the action should usually be preselected.

Defines whether the action can be selected multiple times.

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root (~) path can be used to define the entire resource dynamically.

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

A brief, natural language description of the intended semantics of the dynamic value.

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.

The media type of the language for the expression.

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

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.