eHealth Infrastructure (v2019.6.1)

StructureDefinition: ehealth-plandefinition - Detailed Descriptions

Definitions for the ehealth-plandefinition Profile.

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

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
2. PlanDefinition.id
Definition

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

Control0..1
Typeid
Comments

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

3. PlanDefinition.meta
Definition

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

Control0..1
TypeMeta
4. PlanDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. PlanDefinition.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Max Binding: All Languages
Typecode
Comments

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

6. PlanDefinition.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

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 in formation is added later.

7. PlanDefinition.contained
Definition

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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

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.

8. PlanDefinition.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. PlanDefinition.extension:recommendation
SliceNamerecommendation
Definition

Defines the recommendation state of the plan definition.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(recommendation) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. PlanDefinition.extension:intendedAudience
SliceNameintendedAudience
Definition

Specifies that the plandefinition is only intended for use in the specified organisations. Leave blank if the plandefinition is intended for global use.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(intendedAudience) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. PlanDefinition.extension:modifierRole
SliceNamemodifierRole
Definition

Maintainers of the plan definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers.

Control1..* This element is affected by the following invariants: ele-1
TypeExtension(modifierRole) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. PlanDefinition.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

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.

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

Control0..1
Typeuri
Requirements

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

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.

14. PlanDefinition.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 identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

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

Comments

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.

15. PlanDefinition.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)
Control1..1
Typestring
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 refrence to a particular business version of the plan definition with the format [url]|[version].

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

Comments

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.

17. PlanDefinition.title
Definition

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

Control0..1
Typestring
Comments

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

18. PlanDefinition.type
Definition

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

Control0..1
BindingThe type of PlanDefinition
The codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable
TypeCodeableConcept
19. PlanDefinition.status
Definition

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

Control1..1
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue
Comments

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.

20. PlanDefinition.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
Is Modifiertrue
Requirements

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

Comments

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.

21. PlanDefinition.date
Definition

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.

Control0..1
TypedateTime
Alternate NamesRevision Date
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.

22. PlanDefinition.publisher
Definition

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

Control0..1
Typestring
Requirements

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

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.

23. PlanDefinition.description
Definition

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

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

24. PlanDefinition.purpose
Definition

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

25. PlanDefinition.usage
Definition

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

Control0..1
Typestring
26. PlanDefinition.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 / editorial corrections.

27. PlanDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't 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 is usually after the approval date.

28. PlanDefinition.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 a the plan definition are or are expected to be used instead.

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.

29. PlanDefinition.useContext
Definition

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.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

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

30. PlanDefinition.jurisdiction
Definition

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

Control0..*
BindingCountries and regions within which this artifact is targeted for use
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
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.

31. PlanDefinition.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..*
BindingFor example codes, see TopicType
TypeCodeableConcept
Requirements

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

32. PlanDefinition.contributor
Definition

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

Control0..*
TypeContributor
Requirements

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

33. PlanDefinition.contact
Definition

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

Control0..*
TypeContactDetail
Comments

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

34. PlanDefinition.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
35. PlanDefinition.relatedArtifact
Definition

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. The relatedArtifact.resource attribute can be used to specify a DocumentReference resource.

Control0..*
TypeRelatedArtifact
Requirements

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.

Comments

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

36. PlanDefinition.library
Definition

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

Control0..*
TypeReference(ehealth-library)
37. PlanDefinition.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..*
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
38. PlanDefinition.goal.id
Definition

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

Control0..1
Typestring
39. PlanDefinition.goal.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

40. PlanDefinition.goal.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

41. PlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

Control0..1
BindingExample codes for grouping goals for filtering or presentation
For example codes, see GoalCategory
TypeCodeableConcept
42. PlanDefinition.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
BindingDescribes goals that can be achieved
For example codes, see SNOMED CT Clinical Findings
TypeCodeableConcept
Comments

If no code is available, use CodeableConcept.text.

43. PlanDefinition.goal.priority
Definition

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

Control0..1
BindingIndicates the level of importance associated with reaching or sustaining a goal
The codes SHOULD be taken from GoalPriority
TypeCodeableConcept
44. PlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

Control0..1
BindingIdentifies the types of events that might trigger the start of a goal
For example codes, see GoalStartEvent
TypeCodeableConcept
45. PlanDefinition.goal.addresses
Definition

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

Control0..*
BindingIdentifies problems, conditions, issues, or concerns that goals may address
For example codes, see Condition/Problem/Diagnosis Codes
TypeCodeableConcept
46. PlanDefinition.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
47. PlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
48. PlanDefinition.goal.target.id
Definition

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

Control0..1
Typestring
49. PlanDefinition.goal.target.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

50. PlanDefinition.goal.target.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

51. PlanDefinition.goal.target.measure
Definition

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

Control0..1
BindingIdentifies types of parameters that can be tracked to determine goal achievement
For example codes, see LOINC Codes
TypeCodeableConcept
52. PlanDefinition.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. 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.

Control0..1
TypeChoice of: Quantity, Range, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
53. PlanDefinition.goal.target.due
Definition

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

Control0..1
TypeDuration
54. PlanDefinition.action
Definition

An action to be taken as part of the plan.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
55. PlanDefinition.action.id
Definition

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

Control0..1
Typestring
56. PlanDefinition.action.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

57. PlanDefinition.action.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

58. PlanDefinition.action.label
Definition

A user-visible label for the action.

Control0..1
Typestring
59. PlanDefinition.action.title
Definition

The title of the action displayed to a user.

Control0..1
Typestring
60. PlanDefinition.action.description
Definition

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

Control0..1
Typestring
61. PlanDefinition.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 may not be capable of interpreting it dynamically.

Control0..1
Typestring
62. PlanDefinition.action.code
Definition

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.

Control0..*
TypeCodeableConcept
63. PlanDefinition.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.

64. PlanDefinition.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
65. PlanDefinition.action.goalId
Definition

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

Control0..*
Typeid
66. PlanDefinition.action.triggerDefinition
Definition

A description of when the action should be triggered.

Control0..*
TypeTriggerDefinition
67. PlanDefinition.action.condition
Definition

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

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
68. PlanDefinition.action.condition.id
Definition

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

Control0..1
Typestring
69. PlanDefinition.action.condition.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

70. PlanDefinition.action.condition.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

71. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Control1..1
BindingDefines the kinds of conditions that can appear on actions
The codes SHALL be taken from ActionConditionKind
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 when enter/exit criteria for an action.

72. PlanDefinition.action.condition.description
Definition

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

Control0..1
Typestring
73. PlanDefinition.action.condition.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
74. PlanDefinition.action.condition.expression
Definition

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

Control0..1
Typestring
Comments

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

75. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

Control0..*
TypeDataRequirement
76. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

Control0..*
TypeDataRequirement
77. PlanDefinition.action.relatedAction
Definition

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

Control0..*
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
78. PlanDefinition.action.relatedAction.id
Definition

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

Control0..1
Typestring
79. PlanDefinition.action.relatedAction.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

80. PlanDefinition.action.relatedAction.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

81. PlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

Control1..1
Typeid
82. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
BindingDefines the types of relationships between actions
The codes SHALL be taken from ActionRelationshipType
Typecode
83. PlanDefinition.action.relatedAction.offset[x]
Definition

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

Control0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
84. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

Control0..1
TypeChoice of: dateTime, Period, Duration, Range, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
85. PlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
86. PlanDefinition.action.participant.id
Definition

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

Control0..1
Typestring
87. PlanDefinition.action.participant.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

88. PlanDefinition.action.participant.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

89. PlanDefinition.action.participant.type
Definition

The type of participant in the action.

Control1..1
BindingThe type of participant for the action
The codes SHALL be taken from ActionParticipantType
Typecode
90. PlanDefinition.action.participant.role
Definition

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

Control0..1
BindingDefines roles played by participants for the action
For example codes, see ActionParticipantRole
TypeCodeableConcept
91. PlanDefinition.action.type
Definition

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

Control0..1
BindingThe type of action to be performed
The codes SHALL be taken from ActionType
TypeCoding
92. PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..1
BindingDefines organization behavior of a group
The codes SHALL be taken from ActionGroupingBehavior
Typecode
93. PlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Control0..1
BindingDefines selection behavior of a group
The codes SHALL be taken from ActionSelectionBehavior
Typecode
94. PlanDefinition.action.requiredBehavior
Definition

Defines the requiredness behavior for the action.

Control0..1
BindingDefines requiredness behavior for selecting an action or an action group
The codes SHALL be taken from ActionRequiredBehavior
Typecode
95. PlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Control0..1
BindingDefines selection frequency behavior for an action or group
The codes SHALL be taken from ActionPrecheckBehavior
Typecode
96. PlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Control0..1
BindingDefines behavior for an action or a group for how many times that item may be repeated
The codes SHALL be taken from ActionCardinalityBehavior
Typecode
97. PlanDefinition.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
TypeReference(ehealth-activitydefinition | ehealth-plandefinition)
Comments

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.

98. PlanDefinition.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
TypeReference(StructureMap)
99. PlanDefinition.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..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
100. PlanDefinition.action.dynamicValue.id
Definition

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

Control0..1
Typestring
101. PlanDefinition.action.dynamicValue.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

102. PlanDefinition.action.dynamicValue.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

103. PlanDefinition.action.dynamicValue.description
Definition

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

Control0..1
Typestring
104. PlanDefinition.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
105. PlanDefinition.action.dynamicValue.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
106. PlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Control0..1
Typestring
Comments

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

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