RIVO-Noord Zorgviewer Implementation Guide
1.21.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.21.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: PlanDefinition - Detailed Descriptions

Draft as of 2025-10-28

Definitions for the PlanDefinition resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. 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.
Short | The definition of a plan for a series of actions, independent of any specific patient or context
Control | 0..*
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.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()`) 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-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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()) 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())
2. 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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
6. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
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.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|3.0.2 (required to `http://hl7.org/fhir/ValueSet/publication-status|3.0.2` ) The lifecycle status of a Value Set or Concept Map.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. 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.
Short | For testing purposes, not real usage
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.
Control | 0..1
Type | boolean
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
10. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Related artifacts for the asset
Comments | Zet hier een link naar de 'officiele' specificaties van het Behandelplan. Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 10..*
Type | RelatedArtifact
Must Support | true
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.
12. PlanDefinition.action
Definition | An action to be taken as part of the plan.
Short | Action defined by the plan
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
14. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
16. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Comments | Specificeer hier de zib FHIR resource en hun filters.
Control | 10..*
Type | DataRequirement
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. PlanDefinition
2. PlanDefinition.relatedArtifact
Comments | Zet hier een link naar de 'officiele' specificaties van het Behandelplan.
Control | 1..?
Must Support | true
4. PlanDefinition.action
6. PlanDefinition.action.output
Comments | Specificeer hier de zib FHIR resource en hun filters.
Control | 1..?
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. 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.
Short | The definition of a plan for a series of actions, independent of any specific patient or context
Control | 0..*
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.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()`) 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()`)
2. PlanDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
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.
Control | 0..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. 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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Summary | true
6. 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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. PlanDefinition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to `http://hl7.org/fhir/ValueSet/languages|3.0.2` ) A human language.
Additional Bindings | Purpose
All Languages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. 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.
Short | Text summary of the resource, for human interpretation
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.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
12. 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.
Short | Contained, inline 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.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
14. PlanDefinition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
16. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
18. 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.
Short | Logical URI to reference this plan definition (globally unique)
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.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
20. 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.
Short | Additional identifier for the plan definition
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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
22. 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.
Short | Business version of the plan definition
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].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
24. 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.
Short | Name for this plan definition (computer friendly)
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.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Support human navigation and code generation.
26. PlanDefinition.title
Definition | A short, descriptive, user-friendly title for the plan definition.
Short | Name for this plan definition (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
28. PlanDefinition.type
Definition | The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
Short | order-set | protocol | eca-rule
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionType (extensible to `http://hl7.org/fhir/ValueSet/plan-definition-type|3.0.2` ) The type of PlanDefinition
Type | CodeableConcept
Summary | true
30. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
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.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|3.0.2` ) The lifecycle status of a Value Set or Concept Map.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
32. 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.
Short | For testing purposes, not real usage
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.
Control | 0..1
Type | boolean
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
34. 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.
Short | Date this was last changed
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.
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Revision Date
36. PlanDefinition.publisher
Definition | The name of the individual or organization that published the plan definition.
Short | Name of the publisher (organization or individual)
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.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
38. PlanDefinition.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Short | Natural language description of the plan definition
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).
Control | 0..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
40. PlanDefinition.purpose
Definition | Explaination of why this plan definition is needed and why it has been designed as it has.
Short | Why this plan definition is defined
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.
Control | 0..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
42. PlanDefinition.usage
Definition | A detailed description of how the asset is used from a clinical perspective.
Short | Describes the clinical usage of the asset
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
44. 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.
Short | When the plan definition was approved by publisher
Comments | The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
46. 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.
Short | When the plan definition was last reviewed
Comments | If specified, this is usually after the approval date.
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
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.
48. PlanDefinition.effectivePeriod
Definition | The period during which the plan definition content was or is planned to be in active use.
Short | When the plan definition is expected to be used
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.
Control | 0..1
Type | Period
Summary | true
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.
50. 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.
Short | Context the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Summary | true
Requirements | Assist in searching for appropriate content.
52. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Short | Intended jurisdiction for plan definition (if applicable)
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.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2` ) Countries and regions within which this artifact is targeted for use
Type | CodeableConcept
Summary | true
54. 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.
Short | E.g. Education, Treatment, Assessment, etc
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic|3.0.2` ) High-level categorization of the definition, used for searching, sorting, and filtering
Type | CodeableConcept
Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.
56. PlanDefinition.contributor
Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
Short | A content contributor
Control | 0..*
Type | Contributor
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the asset.
58. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc.
Control | 0..*
Type | ContactDetail
Summary | true
60. 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.
Short | Use and/or publishing restrictions
Control | 0..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Requirements | Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.
Alternate Names | License, Restrictions
62. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Related artifacts for the asset
Comments | Zet hier een link naar de 'officiele' specificaties van het Behandelplan.
Control | 1..*
Type | RelatedArtifact
Must Support | true
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.
64. PlanDefinition.library
Definition | A reference to a Library resource containing any formal logic used by the plan definition.
Short | Logic used by the plan definition
Control | 0..*
Type | Reference(Library)
66. 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.
Short | What the plan is trying to accomplish
Control | 0..*
Type | BackboneElement
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
68. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
70. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
72. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
74. PlanDefinition.goal.category
Definition | Indicates a category the goal falls within.
Short | E.g. Treatment, dietary, behavioral, etc
Control | 0..1
Binding | For example codes, see GoalCategory (example to `http://hl7.org/fhir/ValueSet/goal-category|3.0.2` ) Example codes for grouping goals for filtering or presentation
Type | CodeableConcept
76. 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".
Short | Code or text describing the goal
Comments | If no code is available, use CodeableConcept.text.
Control | 1..1
Binding | For example codes, see SNOMED CT Clinical Findings (example to `http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2` ) Describes goals that can be achieved
Type | CodeableConcept
78. PlanDefinition.goal.priority
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal.
Short | high-priority | medium-priority | low-priority
Control | 0..1
Binding | The codes SHOULD be taken from GoalPriority (preferred to `http://hl7.org/fhir/ValueSet/goal-priority|3.0.2` ) Indicates the level of importance associated with reaching or sustaining a goal
Type | CodeableConcept
80. PlanDefinition.goal.start
Definition | The event after which the goal should begin being pursued.
Short | When goal pursuit begins
Control | 0..1
Binding | For example codes, see GoalStartEvent (example to `http://hl7.org/fhir/ValueSet/goal-start-event|3.0.2` ) Identifies the types of events that might trigger the start of a goal
Type | CodeableConcept
82. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Short | What does the goal address
Control | 0..*
Binding | For example codes, see Condition/Problem/Diagnosis Codes (example to `http://hl7.org/fhir/ValueSet/condition-code|3.0.2` ) Identifies problems, conditions, issues, or concerns that goals may address
Type | CodeableConcept
84. 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.
Short | Supporting documentation for the goal
Control | 0..*
Type | RelatedArtifact
86. PlanDefinition.goal.target
Definition | Indicates what should be done and within what timeframe.
Short | Target outcome for the goal
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
88. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
90. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
92. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
94. PlanDefinition.goal.target.measure
Definition | The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level.
Short | The parameter whose value is to be tracked
Control | 0..1
Binding | For example codes, see LOINC Codes (example to `http://hl7.org/fhir/ValueSet/observation-codes|3.0.2` ) Identifies types of parameters that can be tracked to determine goal achievement
Type | CodeableConcept
96. 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.
Short | The target value to be achieved
Control | 0..1
Type | Choice of: Quantity, Range, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
98. PlanDefinition.goal.target.due
Definition | Indicates the timeframe after the start of the goal in which the goal should be met.
Short | Reach goal within
Control | 0..1
Type | Duration
100. PlanDefinition.action
Definition | An action to be taken as part of the plan.
Short | Action defined by the plan
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
102. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
104. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
106. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
108. PlanDefinition.action.label
Definition | A user-visible label for the action.
Short | User-visible label for the action (e.g. 1. or A.)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
110. PlanDefinition.action.title
Definition | The title of the action displayed to a user.
Short | User-visible title
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
112. PlanDefinition.action.description
Definition | Changed: A short description of the action used to provide a summary to display to the user.
Short | Changed:Short description of the action
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
114. 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.
Short | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
116. 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.
Short | Code representing the meaning of the action or sub-actions
Control | 0..*
Type | CodeableConcept
118. PlanDefinition.action.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
120. 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.
Short | Supporting documentation for the intended performer of the action
Control | 0..*
Type | RelatedArtifact
122. PlanDefinition.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
124. PlanDefinition.action.triggerDefinition
Definition | A description of when the action should be triggered.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
126. PlanDefinition.action.condition
Definition | An expression that describes applicability criteria, or start/stop conditions for the action.
Short | Whether or not the action is applicable
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
128. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
130. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
132. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
134. PlanDefinition.action.condition.kind
Definition | The kind of condition.
Short | applicability | start | stop
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.
Control | 1..1
Binding | The codes SHALL be taken from ActionConditionKind (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|3.0.2` ) Defines the kinds of conditions that can appear on actions
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
136. PlanDefinition.action.condition.description
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics.
Short | Natural language description of the condition
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
138. PlanDefinition.action.condition.language
Definition | The media type of the language for the expression.
Short | Language of the expression
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
140. PlanDefinition.action.condition.expression
Definition | Changed: An expression that returns true or false, indicating whether or not the condition is satisfied.
Short | Changed:Boolean-valued expression
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
142. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
144. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Comments | Specificeer hier de zib FHIR resource en hun filters.
Control | 1..*
Type | DataRequirement
Must Support | true
146. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
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.
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
148. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
150. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
152. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
154. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
156. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|3.0.2` ) Defines the types of relationships between actions
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
158. PlanDefinition.action.relatedAction.offset[x]
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Short | Time offset for the relationship
Control | 0..1
Type | Choice of: Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
160. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Choice of: dateTime, Period, Duration, Range, Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
162. PlanDefinition.action.participant
Definition | Indicates who should participate in performing the action described.
Short | Who should participate in the action
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
164. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
166. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
168. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
170. PlanDefinition.action.participant.type
Definition | Changed: The type of participant in the action.
Short | Changed:patient | practitioner | related-person
Control | Changed:1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|3.0.2` ) The type of participant for the action
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
172. PlanDefinition.action.participant.role
Definition | The role the participant should play in performing the described action.
Short | E.g. Nurse, Surgeon, Parent, etc
Control | 0..1
Binding | For example codes, see ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role|3.0.2` ) Defines roles played by participants for the action
Type | CodeableConcept
174. PlanDefinition.action.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | The codes SHALL be taken from ActionType (required to `http://hl7.org/fhir/ValueSet/action-type|3.0.2` ) The type of action to be performed
Type | Coding
176. PlanDefinition.action.groupingBehavior
Definition | Defines the grouping behavior for the action and its children.
Short | visual-group | logical-group | sentence-group
Control | 0..1
Binding | The codes SHALL be taken from ActionGroupingBehavior (required to `http://hl7.org/fhir/ValueSet/action-grouping-behavior|3.0.2` ) Defines organization behavior of a group
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
178. PlanDefinition.action.selectionBehavior
Definition | Defines the selection behavior for the action and its children.
Short | any | all | all-or-none | exactly-one | at-most-one | one-or-more
Control | 0..1
Binding | The codes SHALL be taken from ActionSelectionBehavior (required to `http://hl7.org/fhir/ValueSet/action-selection-behavior|3.0.2` ) Defines selection behavior of a group
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
180. PlanDefinition.action.requiredBehavior
Definition | Defines the requiredness behavior for the action.
Short | must | could | must-unless-documented
Control | 0..1
Binding | The codes SHALL be taken from ActionRequiredBehavior (required to `http://hl7.org/fhir/ValueSet/action-required-behavior|3.0.2` ) Defines requiredness behavior for selecting an action or an action group
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
182. PlanDefinition.action.precheckBehavior
Definition | Defines whether the action should usually be preselected.
Short | yes | no
Control | 0..1
Binding | The codes SHALL be taken from ActionPrecheckBehavior (required to `http://hl7.org/fhir/ValueSet/action-precheck-behavior|3.0.2` ) Defines selection frequency behavior for an action or group
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
184. PlanDefinition.action.cardinalityBehavior
Definition | Defines whether the action can be selected multiple times.
Short | single | multiple
Control | 0..1
Binding | The codes SHALL be taken from ActionCardinalityBehavior (required to `http://hl7.org/fhir/ValueSet/action-cardinality-behavior|3.0.2` ) Defines behavior for an action or a group for how many times that item may be repeated
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
186. 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.
Short | Description of the activity to be performed
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.
Control | 0..1
Type | Reference(ActivityDefinition, PlanDefinition)
188. 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.
Short | Transform to apply the template
Control | 0..1
Type | Reference(StructureMap)
190. 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.
Short | Dynamic aspects of the definition
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
192. 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.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
194. 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.
Short | Additional Content defined by implementations
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
196. 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.
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
198. PlanDefinition.action.dynamicValue.description
Definition | A brief, natural language description of the intended semantics of the dynamic value.
Short | Natural language description of the dynamic value
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
200. 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.
Short | The path to the element to be set dynamically
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
202. PlanDefinition.action.dynamicValue.language
Definition | The media type of the language for the expression.
Short | Language of the expression
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
204. PlanDefinition.action.dynamicValue.expression
Definition | An expression specifying the value of the customized element.
Short | An expression that provides the dynamic value for the customization
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
206. 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.
Short | A sub-action
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action