Current Build
Clinical Decision Support Work GroupMaturity Level: 2 Trial Use Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the PlanDefinition resource.

PlanDefinition
Element IdPlanDefinition
Definition

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Control1..1
TypeDomainResource
Invariants
Defined on this element
pdf-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
PlanDefinition.url
Element IdPlanDefinition.url
Definition

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.

Control0..1
Typeuri
Requirements

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

Summarytrue
Comments

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.

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 element to indicate where the current master source of the resource can be found.

PlanDefinition.identifier
Element IdPlanDefinition.identifier
Definition

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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

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

Summarytrue
Comments

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.

PlanDefinition.version
Element IdPlanDefinition.version
Definition

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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

PlanDefinition.name
Element IdPlanDefinition.name
Definition

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.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

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.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
PlanDefinition.title
Element IdPlanDefinition.title
Definition

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

Control0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

PlanDefinition.subtitle
Element IdPlanDefinition.subtitle
Definition

An explanatory or alternate title for the plan definition giving additional information about its content.

Control0..1
Typestring
PlanDefinition.type
Element IdPlanDefinition.type
Definition

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

Control0..1
Terminology BindingPlanDefinitionType (Extensible)
TypeCodeableConcept
Summarytrue
PlanDefinition.status
Element IdPlanDefinition.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

PlanDefinition.experimental
Element IdPlanDefinition.experimental
Definition

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.

Control0..1
Typeboolean
Requirements

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

Summarytrue
Comments

Allows filtering of plan definitions that are appropriate for use versus not.

PlanDefinition.subject[x]
Element IdPlanDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the plan definition.

Control0..1
Terminology BindingSubject type (Extensible)
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Meaning if MissingPatient
PlanDefinition.date
Element IdPlanDefinition.date
Definition

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

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

PlanDefinition.publisher
Element IdPlanDefinition.publisher
Definition

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

Control0..1
Typestring
Requirements

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

Summarytrue
Comments

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.

PlanDefinition.contact
Element IdPlanDefinition.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

PlanDefinition.description
Element IdPlanDefinition.description
Definition

A free text natural language description of the plan definition from a consumer's perspective.

Control0..1
Typemarkdown
Summarytrue
Comments

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

PlanDefinition.useContext
Element IdPlanDefinition.useContext
Definition

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

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

PlanDefinition.jurisdiction
Element IdPlanDefinition.jurisdiction
Definition

A legal or geographic region in which the plan definition is intended to be used.

Control0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

PlanDefinition.purpose
Element IdPlanDefinition.purpose
Definition

Explanation of why this plan definition is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

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.

PlanDefinition.usage
Element IdPlanDefinition.usage
Definition

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

Control0..1
Typestring
PlanDefinition.copyright
Element IdPlanDefinition.copyright
Definition

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.

Control0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
PlanDefinition.approvalDate
Element IdPlanDefinition.approvalDate
Definition

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

Control0..1
Typedate
Comments

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

PlanDefinition.lastReviewDate
Element IdPlanDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Control0..1
Typedate
Requirements

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.

Comments

If specified, this date follows the original approval date.

PlanDefinition.effectivePeriod
Element IdPlanDefinition.effectivePeriod
Definition

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

Control0..1
TypePeriod
Requirements

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

Summarytrue
Comments

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.

PlanDefinition.topic
Element IdPlanDefinition.topic
Definition

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.

Control0..*
Terminology BindingDefinitionTopic (Example)
TypeCodeableConcept
Requirements

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

PlanDefinition.author
Element IdPlanDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Control0..*
TypeContactDetail
PlanDefinition.editor
Element IdPlanDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Control0..*
TypeContactDetail
PlanDefinition.reviewer
Element IdPlanDefinition.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

Control0..*
TypeContactDetail
PlanDefinition.endorser
Element IdPlanDefinition.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Control0..*
TypeContactDetail
PlanDefinition.relatedArtifact
Element IdPlanDefinition.relatedArtifact
Definition

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

Control0..*
TypeRelatedArtifact
Requirements

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.

Comments

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

PlanDefinition.library
Element IdPlanDefinition.library
Definition

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

Control0..*
Typecanonical(Library)
PlanDefinition.goal
Element IdPlanDefinition.goal
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.

Control0..*
Requirements

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.

PlanDefinition.goal.category
Element IdPlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

Control0..1
Terminology BindingGoal category (Example)
TypeCodeableConcept
PlanDefinition.goal.description
Element IdPlanDefinition.goal.description
Definition

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

Control1..1
Terminology BindingSNOMED CT Clinical Findings (Example)
TypeCodeableConcept
Comments

If no code is available, use CodeableConcept.text.

PlanDefinition.goal.priority
Element IdPlanDefinition.goal.priority
Definition

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

Control0..1
Terminology BindingGoal priority (Preferred)
TypeCodeableConcept
PlanDefinition.goal.start
Element IdPlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

Control0..1
Terminology BindingGoal start event (Example)
TypeCodeableConcept
PlanDefinition.goal.addresses
Element IdPlanDefinition.goal.addresses
Definition

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

Control0..*
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
PlanDefinition.goal.documentation
Element IdPlanDefinition.goal.documentation
Definition

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.

Control0..*
TypeRelatedArtifact
PlanDefinition.goal.target
Element IdPlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

Control0..*
PlanDefinition.goal.target.measure
Element IdPlanDefinition.goal.target.measure
Definition

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

Control0..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
PlanDefinition.goal.target.detail[x]
Element IdPlanDefinition.goal.target.detail[x]
Definition

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

Control0..1
TypeQuantity|Range|CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
PlanDefinition.goal.target.due
Element IdPlanDefinition.goal.target.due
Definition

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

Control0..1
TypeDuration
PlanDefinition.action
Element IdPlanDefinition.action
Definition

An action or group of actions to be taken as part of the plan.

Control0..*
Comments

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.

PlanDefinition.action.prefix
Element IdPlanDefinition.action.prefix
Definition

A user-visible prefix for the action.

Control0..1
Typestring
PlanDefinition.action.title
Element IdPlanDefinition.action.title
Definition

The title of the action displayed to a user.

Control0..1
Typestring
PlanDefinition.action.description
Element IdPlanDefinition.action.description
Definition

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

Control0..1
Typestring
PlanDefinition.action.textEquivalent
Element IdPlanDefinition.action.textEquivalent
Definition

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

Control0..1
Typestring
PlanDefinition.action.priority
Element IdPlanDefinition.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Control0..1
Terminology BindingRequest priority (Required)
Typecode
PlanDefinition.action.code
Element IdPlanDefinition.action.code
Definition

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

Control0..*
TypeCodeableConcept
PlanDefinition.action.reason
Element IdPlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

Control0..*
TypeCodeableConcept
Comments

This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.

PlanDefinition.action.documentation
Element IdPlanDefinition.action.documentation
Definition

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

Control0..*
TypeRelatedArtifact
PlanDefinition.action.goalId
Element IdPlanDefinition.action.goalId
Definition

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

Control0..*
Typeid
PlanDefinition.action.trigger
Element IdPlanDefinition.action.trigger
Definition

A description of when the action should be triggered.

Control0..*
TypeTriggerDefinition
PlanDefinition.action.condition
Element IdPlanDefinition.action.condition
Definition

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

Control0..*
Comments

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.

PlanDefinition.action.condition.kind
Element IdPlanDefinition.action.condition.kind
Definition

The kind of condition.

Control1..1
Terminology BindingActionConditionKind (Required)
Typecode
Comments

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.

PlanDefinition.action.condition.expression
Element IdPlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether the condition is satisfied.

Control0..1
TypeExpression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

PlanDefinition.action.input
Element IdPlanDefinition.action.input
Definition

Defines input data requirements for the action.

Control0..*
TypeDataRequirement
PlanDefinition.action.output
Element IdPlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

Control0..*
TypeDataRequirement
PlanDefinition.action.relatedAction
Element IdPlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Control0..*
Comments

When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

PlanDefinition.action.relatedAction.actionId
Element IdPlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

Control1..1
Typeid
PlanDefinition.action.relatedAction.relationship
Element IdPlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
Terminology BindingActionRelationshipType (Required)
Typecode
PlanDefinition.action.relatedAction.offset[x]
Element IdPlanDefinition.action.relatedAction.offset[x]
Definition

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

Control0..1
TypeDuration|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
PlanDefinition.action.timing[x]
Element IdPlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

Control0..1
TypedateTime|Age|Period|Duration|Range|Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
PlanDefinition.action.participant
Element IdPlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

Control0..*
PlanDefinition.action.participant.type
Element IdPlanDefinition.action.participant.type
Definition

The type of participant in the action.

Control1..1
Terminology BindingActionParticipantType (Required)
Typecode
PlanDefinition.action.participant.role
Element IdPlanDefinition.action.participant.role
Definition

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

Control0..1
Terminology BindingAction participant role (Example)
TypeCodeableConcept
PlanDefinition.action.type
Element IdPlanDefinition.action.type
Definition

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

Control0..1
Terminology BindingActionType (Extensible)
TypeCodeableConcept
PlanDefinition.action.groupingBehavior
Element IdPlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..1
Terminology BindingActionGroupingBehavior (Required)
Typecode
PlanDefinition.action.selectionBehavior
Element IdPlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Control0..1
Terminology BindingActionSelectionBehavior (Required)
Typecode
PlanDefinition.action.requiredBehavior
Element IdPlanDefinition.action.requiredBehavior
Definition

Defines the required behavior for the action.

Control0..1
Terminology BindingActionRequiredBehavior (Required)
Typecode
PlanDefinition.action.precheckBehavior
Element IdPlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Control0..1
Terminology BindingActionPrecheckBehavior (Required)
Typecode
PlanDefinition.action.cardinalityBehavior
Element IdPlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Control0..1
Terminology BindingActionCardinalityBehavior (Required)
Typecode
PlanDefinition.action.definition
Element IdPlanDefinition.action.definition
Definition

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.

Control0..1
Typecanonical(ActivityDefinition | PlanDefinition | Questionnaire)
Comments

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.

PlanDefinition.action.transform
Element IdPlanDefinition.action.transform
Definition

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

Control0..1
Typecanonical(StructureMap)
Comments

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.

PlanDefinition.action.dynamicValue
Element IdPlanDefinition.action.dynamicValue
Definition

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

Control0..*
Comments

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.

PlanDefinition.action.dynamicValue.path
Element IdPlanDefinition.action.dynamicValue.path
Definition

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

Control0..1
Typestring
PlanDefinition.action.dynamicValue.expression
Element IdPlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Control0..1
TypeExpression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

PlanDefinition.action.action
Element IdPlanDefinition.action.action
Definition

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

Control0..*
TypeSee PlanDefinition.action