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 URL that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see Technical and Business Versions.

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.

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 useable business identifiers to be easily associated with the module.

Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this plan definition outside of FHIR, where the logical URL is not possible to use.

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 are orderable. 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 multiple different instances of a plan definition that have the same identifier but different versions.

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 & code generation.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.

A short, descriptive, user-friendly title for the plan definition.

The type of asset 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 definition that are appropriate for use vs. not.

A flag 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 life-cycle as a production-level plan definition would.

Allows filtering of plan definition that are appropriate for use vs. not.

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

A free text natural language description of the plan definition from the 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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

Explains 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 (See, e.g, the comments element, or relatedArtifacts), rather it's for 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 asset is used from a clinical perspective.

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

The date may be more recent than the approval date because of minor changes / editorial corrections.

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

If specified, this is usually after the approval date.

The period during which the plan definition content was or is planned to be effective.

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 would 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 of code system definitions.

Assist in searching for appropriate content.

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

A jurisdiction in which the plan definition is intended to be used.

Clinical topics related to the content of the asset.

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

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

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

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.

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 of the library 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.

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

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.

An action to be taken as part of the plan.

A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.

A user-visible label 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 may not be capable of interpreting it dynamically.

The concept represented by this action or its sub-actions.

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.

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 unique identifier 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.

The type of participant in the 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.

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

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.