Skip to main content

PlanDefinition

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

NameRequiredTypeDescription
urluri

Canonical identifier for this plan definition, represented as a URI (globally unique)

Details

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.

identifierIdentifier[]

Additional identifier for the plan definition

Details

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.

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.

versionstring

Business version of the plan definition

Details

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

namestring

Name for this plan definition (computer friendly)

Details

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.

titlestring

Name for this plan definition (human friendly)

Details

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.

subtitlestring

Subordinate title of the plan definition

Details

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

typeCodeableConcept

order-set | clinical-protocol | eca-rule | workflow-definition

Details

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

statuscode

draft | active | retired | unknown

Details

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

experimentalboolean

For testing purposes, not real usage

Details

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.

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

subject[x]CodeableConcept, Reference<Group>

Type of individual the plan definition is focused on

Details

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

datedateTime

Date last changed

Details

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.

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.

publisherstring

Name of the publisher (organization or individual)

Details

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.

contactContactDetail[]

Contact details for the publisher

Details

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.

descriptionmarkdown

Natural language description of the plan definition

Details

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

useContextUsageContext[]

The context that the content is intended to support

Details

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.

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

jurisdictionCodeableConcept[]

Intended jurisdiction for plan definition (if applicable)

Details

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.

purposemarkdown

Why this plan definition is defined

Details

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

usagestring

Describes the clinical usage of the plan

Details

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

copyrightmarkdown

Use and/or publishing restrictions

Details

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.

approvalDatedate

When the plan definition was approved by publisher

Details

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 or editorial corrections.

lastReviewDatedate

When the plan definition was last reviewed

Details

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

effectivePeriodPeriod

When the plan definition is expected to be used

Details

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

topicCodeableConcept[]

E.g. Education, Treatment, Assessment

Details

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.

authorContactDetail[]

Who authored the content

Details

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

editorContactDetail[]

Who edited the content

Details

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

reviewerContactDetail[]

Who reviewed the content

Details

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

endorserContactDetail[]

Who endorsed the content

Details

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

relatedArtifactRelatedArtifact[]

Additional documentation, citations

Details

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

librarycanonical[]

Logic used by the plan definition

Details

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

goalPlanDefinitionGoal[]

What the plan is trying to accomplish

Details

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.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

categoryCodeableConcept

E.g. Treatment, dietary, behavioral

Details

Indicates a category the goal falls within.

descriptionCodeableConcept

Code or text describing the goal

Details

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.

priorityCodeableConcept

high-priority | medium-priority | low-priority

Details

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

startCodeableConcept

When goal pursuit begins

Details

The event after which the goal should begin being pursued.

addressesCodeableConcept[]

What does the goal address

Details

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

documentationRelatedArtifact[]

Supporting documentation for the goal

Details

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.

targetPlanDefinitionGoalTarget[]

Target outcome for the goal

Details

Indicates what should be done and within what timeframe.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

measureCodeableConcept

The parameter whose value is to be tracked

Details

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

detail[x]Quantity, Range, CodeableConcept

The target value to be achieved

Details

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.

dueDuration

Reach goal within

Details

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

actionPlanDefinitionAction[]

Action defined by the plan

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

prefixstring

User-visible prefix for the action (e.g. 1. or A.)

Details

A user-visible prefix for the action.

titlestring

User-visible title

Details

The title of the action displayed to a user.

descriptionstring

Brief description of the action

Details

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

textEquivalentstring

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system

Details

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.

prioritycode

routine | urgent | asap | stat

Details

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

codeCodeableConcept[]

Code representing the meaning of the action or sub-actions

Details

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.

reasonCodeableConcept[]

Why the action should be performed

Details

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.

documentationRelatedArtifact[]

Supporting documentation for the intended performer of the action

Details

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.

goalIdid[]

What goals this action supports

Details

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

subject[x]CodeableConcept, Reference<Group>

Type of individual the action is focused on

Details

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

triggerTriggerDefinition[]

When the action should be triggered

Details

A description of when the action should be triggered.

conditionPlanDefinitionActionCondition[]

Whether or not the action is applicable

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

kindcode

applicability | start | stop

Details

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

expressionExpression

Boolean-valued expression

Details

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

inputDataRequirement[]

Input data requirements

Details

Defines input data requirements for the action.

outputDataRequirement[]

Output data definition

Details

Defines the outputs of the action, if any.

relatedActionPlanDefinitionActionRelatedAction[]

Relationship to another action

Details

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.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

actionIdid

What action is this related to

Details

The element id of the related action.

relationshipcode

before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Details

The relationship of this action to the related action.

offset[x]Duration, Range

Time offset for the relationship

Details

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

timing[x]dateTime, Age, Period, Duration, Range, Timing

When the action should take place

Details

An optional value describing when the action should be performed.

participantPlanDefinitionActionParticipant[]

Who should participate in the action

Details

Indicates who should participate in performing the action described.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

typecode

patient | practitioner | related-person | device

Details

The type of participant in the action.

roleCodeableConcept

E.g. Nurse, Surgeon, Parent

Details

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

typeCodeableConcept

create | update | remove | fire-event

Details

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

groupingBehaviorcode

visual-group | logical-group | sentence-group

Details

Defines the grouping behavior for the action and its children.

selectionBehaviorcode

any | all | all-or-none | exactly-one | at-most-one | one-or-more

Details

Defines the selection behavior for the action and its children.

requiredBehaviorcode

must | could | must-unless-documented

Details

Defines the required behavior for the action.

precheckBehaviorcode

yes | no

Details

Defines whether the action should usually be preselected.

cardinalityBehaviorcode

single | multiple

Details

Defines whether the action can be selected multiple times.

definition[x]canonical, uri

Description of the activity to be performed

Details

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 ($this) path can be used to define the entire resource dynamically.

transformcanonical

Transform to apply the template

Details

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.

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.

dynamicValuePlanDefinitionActionDynamicValue[]

Dynamic aspects of the definition

Details

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.

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.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

pathstring

The path to the element to be set dynamically

Details

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

expressionExpression

An expression that provides the dynamic value for the customization

Details

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.

action[]

A sub-action

Details

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.

Search Parameters

NameTypeDescriptionExpression
composed-ofreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type = 'composed-of').resource
contexttokenA use context assigned to the plan definitionPlanDefinition.useContext.value as CodeableConcept
context-quantityquantityA quantity- or range-valued use context assigned to the plan definitionPlanDefinition.useContext.value as Quantity | PlanDefinition.useContext.value as Range
context-typetokenA type of use context assigned to the plan definitionPlanDefinition.useContext.code
datedateThe plan definition publication datePlanDefinition.date
definitionreferenceActivity or plan definitions used by plan definitionPlanDefinition.action.definition
depends-onreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type = 'depends-on').resource | PlanDefinition.library
derived-fromreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type = 'derived-from').resource
descriptionstringThe description of the plan definitionPlanDefinition.description
effectivedateThe time during which the plan definition is intended to be in usePlanDefinition.effectivePeriod
identifiertokenExternal identifier for the plan definitionPlanDefinition.identifier
jurisdictiontokenIntended jurisdiction for the plan definitionPlanDefinition.jurisdiction
namestringComputationally friendly name of the plan definitionPlanDefinition.name
predecessorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type = 'predecessor').resource
publisherstringName of the publisher of the plan definitionPlanDefinition.publisher
statustokenThe current status of the plan definitionPlanDefinition.status
successorreferenceWhat resource is being referencedPlanDefinition.relatedArtifact.where(type = 'successor').resource
titlestringThe human-friendly name of the plan definitionPlanDefinition.title
topictokenTopics associated with the modulePlanDefinition.topic
typetokenThe type of artifact the plan (e.g. order-set, eca-rule, protocol)PlanDefinition.type
urluriThe uri that identifies the plan definitionPlanDefinition.url
versiontokenThe business version of the plan definitionPlanDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the plan definitionPlanDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the plan definitionPlanDefinition.useContext

Inherited Elements

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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.