Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: OhhPlanDefinition - Detailed Descriptions

Active as of 2025-12-03

Definitions for the ohh-plan-definition resource profile.

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

0. PlanDefinition
2. PlanDefinition.useContext
SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • 4. PlanDefinition.useContext:fhirViewerInvites
    Slice NamefhirViewerInvites
    Control0..1
    6. PlanDefinition.useContext:fhirViewerInvites.code
    Pattern Value{
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "program"
    }
    8. PlanDefinition.useContext:fhirViewerInvites.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on PlanDefinition.useContext.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 10. PlanDefinition.useContext:fhirViewerInvites.value[x]:valueCodeableConcept
      Slice NamevalueCodeableConcept
      Control0..1
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Pattern Value{
        "coding" : [{
          "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
          "code" : "fhir-viewer-invite"
        }]
      }
      12. PlanDefinition.goal
      Control1..?
      Must Supporttrue
      14. PlanDefinition.goal.target
      16. PlanDefinition.goal.target.due
      18. PlanDefinition.goal.target.due.extension
      Control1..1
      SlicingThis element introduces a set of slices on PlanDefinition.goal.target.due.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • value @ url
      • 20. PlanDefinition.goal.target.due.extension:iso-8601-duration
        Slice Nameiso-8601-duration
        Control1..1
        TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
        22. PlanDefinition.action
        Control1..?
        Must Supporttrue
        SlicingThis element introduces a set of slices on PlanDefinition.action. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ participant.type
        • 24. PlanDefinition.action.timing[x]
          TypeDuration, dateTime, Period, Timing, Range, Age
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          26. PlanDefinition.action.timing[x].extension
          Control1..1
          28. PlanDefinition.action.timing[x].extension:iso-8601-duration
          Slice Nameiso-8601-duration
          Control0..1
          TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
          30. PlanDefinition.action.participant
          32. PlanDefinition.action.participant.role
          34. PlanDefinition.action.participant.role.coding
          36. PlanDefinition.action.participant.role.coding.system
          Control0..0
          38. PlanDefinition.action.definition[x]
          Typecanonical(Questionnaire), uri
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          40. PlanDefinition.action.action
          TypeBackboneElement
          42. PlanDefinition.action.action.code
          Control1..?
          SlicingThis element introduces a set of slices on PlanDefinition.action.action.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ coding.system
          • 44. PlanDefinition.action.action.code:action-type
            Slice Nameaction-type
            Control1..1
            BindingThe codes SHOULD be taken from Plan Definition Action Type Value Set
            (preferred to https://api.openhealthhub.com/OpenHealthhub/fhir/4/ValueSet/plan-definition-action-type-value-set)
            46. PlanDefinition.action.action.code:action-type.coding
            48. PlanDefinition.action.action.code:action-type.coding.system
            Control1..?
            Pattern Valuehttps://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
            50. PlanDefinition.action.action.code:notification
            Slice Namenotification
            Control0..1
            52. PlanDefinition.action.action.code:notification.coding
            54. PlanDefinition.action.action.code:notification.coding.system
            Control1..?
            Pattern Valuehttps://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
            56. PlanDefinition.action:patientAction
            Slice NamepatientAction
            Control0..*
            Must Supporttrue
            58. PlanDefinition.action:patientAction.timing[x]
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            60. PlanDefinition.action:patientAction.timing[x].extension:iso-8601-duration
            Slice Nameiso-8601-duration
            Control0..1
            TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
            62. PlanDefinition.action:patientAction.participant
            64. PlanDefinition.action:patientAction.participant.type
            Pattern Valuepatient
            66. PlanDefinition.action:patientAction.participant.role
            Control0..0
            68. PlanDefinition.action:practitionerAction
            Slice NamepractitionerAction
            Control0..*
            Must Supporttrue
            70. PlanDefinition.action:practitionerAction.timing[x]
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            72. PlanDefinition.action:practitionerAction.timing[x].extension:iso-8601-duration
            Slice Nameiso-8601-duration
            Control0..1
            TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
            74. PlanDefinition.action:practitionerAction.participant
            76. PlanDefinition.action:practitionerAction.participant.type
            Pattern Valuepractitioner
            78. PlanDefinition.action:practitionerAction.participant.role
            80. PlanDefinition.action:practitionerAction.participant.role.text
            Control1..?

            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.

            ShortThe definition of a plan for a series of actions, independent of any specific patient or context
            Control0..*
            Is Modifierfalse
            Summaryfalse
            Invariantsdom-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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
            dom-6: A resource should have narrative for robust management (text.`div`.exists())
            pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
            pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
            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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

            ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

            Control0..1
            Typeuri
            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            6. PlanDefinition.status
            Definition

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

            Shortdraft | active | retired | unknown
            Comments

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

            Control1..1
            BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
            (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

            The lifecycle status of an artifact.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            8. PlanDefinition.useContext
            Definition

            The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

            ShortThe context that the content is intended to support
            Comments

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

            Control0..*
            TypeUsageContext
            Is Modifierfalse
            Summarytrue
            Requirements

            Assist in searching for appropriate content.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ code
            • 10. PlanDefinition.useContext:fhirViewerInvites
              Slice NamefhirViewerInvites
              Definition

              The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

              ShortThe context that the content is intended to support
              Comments

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

              Control0..1*
              TypeUsageContext
              Is Modifierfalse
              Summarytrue
              Requirements

              Assist in searching for appropriate content.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. PlanDefinition.useContext:fhirViewerInvites.code
              Definition

              A code that identifies the type of context being specified by this usage context.

              ShortType of context being specified
              Control1..1
              BindingUnless not suitable, these codes SHALL be taken from UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-type|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|4.0.1)

              A code that specifies a type of context being specified by a usage context.

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Pattern Value{
                "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code" : "program"
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              14. PlanDefinition.useContext:fhirViewerInvites.value[x]
              Definition

              A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

              ShortValue that defines the context
              Control1..1
              BindingFor example codes, see Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context|4.0.1
              (example to http://hl7.org/fhir/ValueSet/use-context|4.0.1)

              A code that defines the specific value for the context being specified.

              TypeChoice of: CodeableConcept, Quantity, Range, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization)
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on PlanDefinition.useContext.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • type @ $this
              • 16. PlanDefinition.useContext:fhirViewerInvites.value[x]:valueCodeableConcept
                Slice NamevalueCodeableConcept
                Definition

                A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                ShortValue that defines the context
                Control01..1
                BindingFor example codes, see Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context|4.0.1
                (example to http://hl7.org/fhir/ValueSet/use-context|4.0.1)

                A code that defines the specific value for the context being specified.

                TypeCodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Summarytrue
                Pattern Value{
                  "coding" : [{
                    "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
                    "code" : "fhir-viewer-invite"
                  }]
                }
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. 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.

                ShortWhat the plan is trying to accomplish
                Control10..*
                TypeBackboneElement
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                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.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                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.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                22. 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".

                ShortCode or text describing the goal
                Comments

                If no code is available, use CodeableConcept.text.

                Control1..1
                BindingFor example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|4.0.1
                (example to http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1)

                Describes goals that can be achieved.

                TypeCodeableConcept
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. PlanDefinition.action
                Definition

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

                ShortAction defined by the plan
                Comments

                Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                Control10..*
                TypeBackboneElement
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on PlanDefinition.action. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ participant.type
                • 26. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  28. PlanDefinition.action.timing[x]
                  Definition

                  An optional value describing when the action should be performed.

                  ShortWhen the action should take place
                  Control0..1
                  TypeDuration, dateTime, Period, Timing, Range, Age
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. PlanDefinition.action.timing[x].extension
                  Definition

                  An Extension


                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                  Control10..1*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on PlanDefinition.action.timing[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 32. PlanDefinition.action.timing[x].extension:iso-8601-duration
                    Slice Nameiso-8601-duration
                    Definition

                    Extension representing the duration in the ISO-8601 format

                    ShortISO-8601 Duration Extension
                    Control0..1
                    TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    34. PlanDefinition.action.timing[x].comparator
                    Definition

                    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                    Short< | <= | >= | > - how to understand the value
                    Control0..1
                    BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
                    (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                    How the Quantity should be understood and represented.

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                    Meaning if MissingIf there is no comparator, then there is no modification of the value
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. PlanDefinition.action.definition[x]
                    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.

                    ShortDescription of the activity to be performed
                    Comments

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

                    Control0..1
                    Typecanonical(Questionnaire, ActivityDefinition, PlanDefinition, Questionnaire), uri
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. 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.

                    ShortA sub-action
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    40. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    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.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    42. PlanDefinition.action.action.code
                    Definition

                    A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                    ShortCode representing the meaning of the action or sub-actions
                    Control10..*
                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on PlanDefinition.action.action.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ coding.system
                    • 44. PlanDefinition.action.action.code:action-type
                      Slice Nameaction-type
                      Definition

                      A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                      ShortCode representing the meaning of the action or sub-actions
                      Control10..1*
                      BindingThe codes SHOULD be taken from For codes, see Plan Definition Action Type Value Set
                      (preferred to https://api.openhealthhub.com/OpenHealthhub/fhir/4/ValueSet/plan-definition-action-type-value-set)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      46. PlanDefinition.action.action.code:notification
                      Slice Namenotification
                      Definition

                      A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                      ShortCode representing the meaning of the action or sub-actions
                      Control0..1*
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      48. PlanDefinition.action:patientAction
                      Slice NamepatientAction
                      Definition

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

                      ShortAction defined by the plan
                      Comments

                      Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      50. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      52. PlanDefinition.action:practitionerAction
                      Slice NamepractitionerAction
                      Definition

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

                      ShortAction defined by the plan
                      Comments

                      Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      54. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

                      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.

                      ShortThe definition of a plan for a series of actions, independent of any specific patient or context
                      Control0..*
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsdom-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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                      pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
                      2. PlanDefinition.id
                      Definition

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

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

                      Control0..1
                      Typeid
                      Is Modifierfalse
                      Summarytrue
                      4. PlanDefinition.meta
                      Definition

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

                      ShortMetadata about the resource
                      Control0..1
                      TypeMeta
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                      ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                      Control0..1
                      Typeuri
                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      8. PlanDefinition.language
                      Definition

                      The base language in which the resource is written.

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

                      Control0..1
                      BindingThe codes SHOULD be taken from CommonLanguages
                      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                      A human language.

                      Additional BindingsPurpose
                      AllLanguagesMax Binding
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      10. PlanDefinition.text
                      Definition

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

                      ShortText 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 information is added later.

                      Control0..1
                      TypeNarrative
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesnarrative, html, xhtml, display
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      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.

                      ShortContained, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                      Control0..*
                      TypeResource
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesinline 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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                      Summaryfalse
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

                      ShortCanonical identifier for this plan definition, represented as a URI (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.

                      The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

                      In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      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.

                      ShortAdditional identifier for the plan definition
                      Comments

                      Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      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.

                      ShortBusiness 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 reference to a particular business version of the plan definition with the format [url]|[version].

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      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.

                      ShortName for this plan definition (computer friendly)
                      Comments

                      The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

                      Control0..1
                      This element is affected by the following invariants: inv-0
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Support human navigation and code generation.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      26. PlanDefinition.title
                      Definition

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

                      ShortName for this plan definition (human friendly)
                      Comments

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

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      28. PlanDefinition.subtitle
                      Definition

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

                      ShortSubordinate title of the plan definition
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. PlanDefinition.type
                      Definition

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

                      Shortorder-set | clinical-protocol | eca-rule | workflow-definition
                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from PlanDefinitionType
                      (extensible to http://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1)

                      The type of PlanDefinition.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      32. PlanDefinition.status
                      Definition

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

                      Shortdraft | active | retired | unknown
                      Comments

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

                      Control1..1
                      BindingThe codes SHALL be taken from PublicationStatus
                      (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

                      The lifecycle status of an artifact.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      34. 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.

                      ShortFor testing purposes, not real usage
                      Comments

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

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      36. PlanDefinition.subject[x]
                      Definition

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

                      ShortType of individual the plan definition is focused on
                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from SubjectType
                      (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

                      The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

                      TypeChoice of: CodeableConcept, Reference(Group)
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summaryfalse
                      Meaning if MissingPatient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. PlanDefinition.date
                      Definition

                      The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

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

                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesRevision Date
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. PlanDefinition.publisher
                      Definition

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

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

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. PlanDefinition.contact
                      Definition

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

                      ShortContact details for the publisher
                      Comments

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

                      Control0..*
                      TypeContactDetail
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      44. PlanDefinition.description
                      Definition

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

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

                      Control0..1
                      Typemarkdown
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      46. PlanDefinition.useContext
                      Definition

                      The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

                      ShortThe context that the content is intended to support
                      Comments

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

                      Control0..*
                      TypeUsageContext
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Assist in searching for appropriate content.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ code
                      • 48. PlanDefinition.useContext:fhirViewerInvites
                        Slice NamefhirViewerInvites
                        Definition

                        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

                        ShortThe context that the content is intended to support
                        Comments

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

                        Control0..1
                        TypeUsageContext
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Assist in searching for appropriate content.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        50. PlanDefinition.useContext:fhirViewerInvites.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        52. PlanDefinition.useContext:fhirViewerInvites.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on PlanDefinition.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 54. PlanDefinition.useContext:fhirViewerInvites.code
                          Definition

                          A code that identifies the type of context being specified by this usage context.

                          ShortType of context being specified
                          Control1..1
                          BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                          (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|4.0.1)

                          A code that specifies a type of context being specified by a usage context.

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Pattern Value{
                            "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
                            "code" : "program"
                          }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          56. PlanDefinition.useContext:fhirViewerInvites.value[x]
                          Definition

                          A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                          ShortValue that defines the context
                          Control1..1
                          BindingFor example codes, see Context of Use ValueSet
                          (example to http://hl7.org/fhir/ValueSet/use-context|4.0.1)

                          A code that defines the specific value for the context being specified.

                          TypeChoice of: CodeableConcept, Quantity, Range, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on PlanDefinition.useContext.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • type @ $this
                          • 58. PlanDefinition.useContext:fhirViewerInvites.value[x]:valueCodeableConcept
                            Slice NamevalueCodeableConcept
                            Definition

                            A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                            ShortValue that defines the context
                            Control0..1
                            BindingFor example codes, see Context of Use ValueSet
                            (example to http://hl7.org/fhir/ValueSet/use-context|4.0.1)

                            A code that defines the specific value for the context being specified.

                            TypeCodeableConcept
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summarytrue
                            Pattern Value{
                              "coding" : [{
                                "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
                                "code" : "fhir-viewer-invite"
                              }]
                            }
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            60. PlanDefinition.jurisdiction
                            Definition

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

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

                            Control0..*
                            BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                            (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)

                            Countries and regions within which this artifact is targeted for use.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            62. PlanDefinition.purpose
                            Definition

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

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

                            Control0..1
                            Typemarkdown
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            64. PlanDefinition.usage
                            Definition

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

                            ShortDescribes the clinical usage of the plan
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            66. 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.

                            ShortUse and/or publishing restrictions
                            Control0..1
                            Typemarkdown
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

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

                            Alternate NamesLicense, Restrictions
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            68. 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.

                            ShortWhen the plan definition was approved by publisher
                            Comments

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

                            Control0..1
                            Typedate
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            70. PlanDefinition.lastReviewDate
                            Definition

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

                            ShortWhen the plan definition was last reviewed
                            Comments

                            If specified, this date follows the original approval date.

                            Control0..1
                            Typedate
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            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.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            72. PlanDefinition.effectivePeriod
                            Definition

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

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

                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Requirements

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

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            74. 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.

                            ShortE.g. Education, Treatment, Assessment
                            Control0..*
                            BindingFor example codes, see DefinitionTopic
                            (example to http://hl7.org/fhir/ValueSet/definition-topic|4.0.1)

                            High-level categorization of the definition, used for searching, sorting, and filtering.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

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

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            76. PlanDefinition.author
                            Definition

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

                            ShortWho authored the content
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            78. PlanDefinition.editor
                            Definition

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

                            ShortWho edited the content
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            80. PlanDefinition.reviewer
                            Definition

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

                            ShortWho reviewed the content
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            82. PlanDefinition.endorser
                            Definition

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

                            ShortWho endorsed the content
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            84. PlanDefinition.relatedArtifact
                            Definition

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

                            ShortAdditional documentation, citations
                            Comments

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

                            Control0..*
                            TypeRelatedArtifact
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

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

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            86. PlanDefinition.library
                            Definition

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

                            ShortLogic used by the plan definition
                            Control0..*
                            Typecanonical(Library)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            88. 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.

                            ShortWhat the plan is trying to accomplish
                            Control1..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            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.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            90. 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.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            92. PlanDefinition.goal.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            94. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            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.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            96. PlanDefinition.goal.category
                            Definition

                            Indicates a category the goal falls within.

                            ShortE.g. Treatment, dietary, behavioral
                            Control0..1
                            BindingFor example codes, see GoalCategory
                            (example to http://hl7.org/fhir/ValueSet/goal-category|4.0.1)

                            Example codes for grouping goals for filtering or presentation.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            98. 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".

                            ShortCode or text describing the goal
                            Comments

                            If no code is available, use CodeableConcept.text.

                            Control1..1
                            BindingFor example codes, see SNOMEDCTClinicalFindings
                            (example to http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1)

                            Describes goals that can be achieved.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            100. PlanDefinition.goal.priority
                            Definition

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

                            Shorthigh-priority | medium-priority | low-priority
                            Control0..1
                            BindingThe codes SHOULD be taken from GoalPriority
                            (preferred to http://hl7.org/fhir/ValueSet/goal-priority|4.0.1)

                            Indicates the level of importance associated with reaching or sustaining a goal.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            102. PlanDefinition.goal.start
                            Definition

                            The event after which the goal should begin being pursued.

                            ShortWhen goal pursuit begins
                            Control0..1
                            BindingFor example codes, see GoalStartEvent
                            (example to http://hl7.org/fhir/ValueSet/goal-start-event|4.0.1)

                            Identifies the types of events that might trigger the start of a goal.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            104. PlanDefinition.goal.addresses
                            Definition

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

                            ShortWhat does the goal address
                            Control0..*
                            BindingFor example codes, see Condition/Problem/DiagnosisCodes
                            (example to http://hl7.org/fhir/ValueSet/condition-code|4.0.1)

                            Identifies problems, conditions, issues, or concerns that goals may address.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            106. 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.

                            ShortSupporting documentation for the goal
                            Control0..*
                            TypeRelatedArtifact
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            108. PlanDefinition.goal.target
                            Definition

                            Indicates what should be done and within what timeframe.

                            ShortTarget outcome for the goal
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            110. 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.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            112. PlanDefinition.goal.target.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            114. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            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.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            116. PlanDefinition.goal.target.measure
                            Definition

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

                            ShortThe parameter whose value is to be tracked
                            Control0..1
                            BindingFor example codes, see LOINCCodes
                            (example to http://hl7.org/fhir/ValueSet/observation-codes|4.0.1)

                            Identifies types of parameters that can be tracked to determine goal achievement.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            118. 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. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

                            ShortThe target value to be achieved
                            Control0..1
                            TypeChoice of: Quantity, Range, CodeableConcept
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            120. PlanDefinition.goal.target.due
                            Definition

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

                            ShortReach goal within
                            Control0..1
                            TypeDuration
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            122. PlanDefinition.goal.target.due.id
                            Definition

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

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            124. PlanDefinition.goal.target.due.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control1..1
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on PlanDefinition.goal.target.due.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                            • value @ url
                            • 126. PlanDefinition.goal.target.due.extension:iso-8601-duration
                              Slice Nameiso-8601-duration
                              Definition

                              Extension representing the duration in the ISO-8601 format

                              ShortISO-8601 Duration Extension
                              Control1..1
                              TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              128. PlanDefinition.goal.target.due.value
                              Definition

                              The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                              ShortNumerical value (with implicit precision)
                              Comments

                              The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

                              Control0..1
                              Typedecimal
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Precision is handled implicitly in almost all cases of measurement.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              130. PlanDefinition.goal.target.due.comparator
                              Definition

                              How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                              Short< | <= | >= | > - how to understand the value
                              Control0..1
                              BindingThe codes SHALL be taken from QuantityComparator
                              (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                              How the Quantity should be understood and represented.

                              Typecode
                              Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                              Meaning if MissingIf there is no comparator, then there is no modification of the value
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              132. PlanDefinition.goal.target.due.unit
                              Definition

                              A human-readable form of the unit.

                              ShortUnit representation
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. PlanDefinition.goal.target.due.system
                              Definition

                              The identification of the system that provides the coded form of the unit.

                              ShortSystem that defines coded unit form
                              Control0..1
                              This element is affected by the following invariants: qty-3
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to know the system that defines the coded form of the unit.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. PlanDefinition.goal.target.due.code
                              Definition

                              A computer processable form of the unit in some unit representation system.

                              ShortCoded form of the unit
                              Comments

                              The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

                              Control0..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              138. PlanDefinition.action
                              Definition

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

                              ShortAction defined by the plan
                              Comments

                              Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                              Control1..*
                              TypeBackboneElement
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              SlicingThis element introduces a set of slices on PlanDefinition.action. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ participant.type
                              • 140. 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.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                142. PlanDefinition.action.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                144. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                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.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                146. PlanDefinition.action.prefix
                                Definition

                                A user-visible prefix for the action.

                                ShortUser-visible prefix for the action (e.g. 1. or A.)
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                148. PlanDefinition.action.title
                                Definition

                                The title of the action displayed to a user.

                                ShortUser-visible title
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                150. PlanDefinition.action.description
                                Definition

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

                                ShortBrief description of the action
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                152. 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 might not be capable of interpreting it dynamically.

                                ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                154. PlanDefinition.action.priority
                                Definition

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

                                Shortroutine | urgent | asap | stat
                                Control0..1
                                BindingThe codes SHALL be taken from RequestPriority
                                (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                                Identifies the level of importance to be assigned to actioning the request.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                156. 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 the section of a documentation template.

                                ShortCode representing the meaning of the action or sub-actions
                                Control0..*
                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                158. PlanDefinition.action.reason
                                Definition

                                A description of why this action is necessary or appropriate.

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

                                Control0..*
                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                160. 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.

                                ShortSupporting documentation for the intended performer of the action
                                Control0..*
                                TypeRelatedArtifact
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                162. PlanDefinition.action.goalId
                                Definition

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

                                ShortWhat goals this action supports
                                Control0..*
                                Typeid
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                164. PlanDefinition.action.subject[x]
                                Definition

                                A code or group definition that describes the intended subject of the action and its children, if any.

                                ShortType of individual the action is focused on
                                Comments

                                The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

                                In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from SubjectType
                                (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

                                The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

                                TypeChoice of: CodeableConcept, Reference(Group)
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

                                Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

                                Meaning if MissingPatient
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                166. PlanDefinition.action.trigger
                                Definition

                                A description of when the action should be triggered.

                                ShortWhen the action should be triggered
                                Control0..*
                                TypeTriggerDefinition
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                168. PlanDefinition.action.condition
                                Definition

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

                                ShortWhether or not the action is applicable
                                Comments

                                When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                170. 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.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                172. PlanDefinition.action.condition.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                174. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                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.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                176. PlanDefinition.action.condition.kind
                                Definition

                                The kind of condition.

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

                                Control1..1
                                BindingThe codes SHALL be taken from ActionConditionKind
                                (required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

                                Defines the kinds of conditions that can appear on actions.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                178. PlanDefinition.action.condition.expression
                                Definition

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

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

                                Control0..1
                                TypeExpression
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                180. PlanDefinition.action.input
                                Definition

                                Defines input data requirements for the action.

                                ShortInput data requirements
                                Control0..*
                                TypeDataRequirement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                182. PlanDefinition.action.output
                                Definition

                                Defines the outputs of the action, if any.

                                ShortOutput data definition
                                Control0..*
                                TypeDataRequirement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                184. PlanDefinition.action.relatedAction
                                Definition

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

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

                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                186. 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.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                188. PlanDefinition.action.relatedAction.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                190. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                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.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                192. PlanDefinition.action.relatedAction.actionId
                                Definition

                                The element id of the related action.

                                ShortWhat action is this related to
                                Control1..1
                                Typeid
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                194. PlanDefinition.action.relatedAction.relationship
                                Definition

                                The relationship of this action to the related action.

                                Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
                                Control1..1
                                BindingThe codes SHALL be taken from ActionRelationshipType
                                (required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

                                Defines the types of relationships between actions.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                196. PlanDefinition.action.relatedAction.offset[x]
                                Definition

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

                                ShortTime offset for the relationship
                                Control0..1
                                TypeChoice of: Duration, Range
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                198. PlanDefinition.action.timing[x]
                                Definition

                                An optional value describing when the action should be performed.

                                ShortWhen the action should take place
                                Control0..1
                                TypeDuration
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                200. PlanDefinition.action.timing[x].id
                                Definition

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

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                202. PlanDefinition.action.timing[x].extension
                                Definition

                                An Extension

                                ShortExtension
                                Control1..1
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on PlanDefinition.action.timing[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 204. PlanDefinition.action.timing[x].extension:iso-8601-duration
                                  Slice Nameiso-8601-duration
                                  Definition

                                  Extension representing the duration in the ISO-8601 format

                                  ShortISO-8601 Duration Extension
                                  Control0..1
                                  TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  206. PlanDefinition.action.timing[x].value
                                  Definition

                                  The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                                  ShortNumerical value (with implicit precision)
                                  Comments

                                  The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

                                  Control0..1
                                  Typedecimal
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Precision is handled implicitly in almost all cases of measurement.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  208. PlanDefinition.action.timing[x].comparator
                                  Definition

                                  How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                                  Short< | <= | >= | > - how to understand the value
                                  Control0..1
                                  BindingThe codes SHALL be taken from QuantityComparator
                                  (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                                  How the Quantity should be understood and represented.

                                  Typecode
                                  Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                                  Meaning if MissingIf there is no comparator, then there is no modification of the value
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  210. PlanDefinition.action.timing[x].unit
                                  Definition

                                  A human-readable form of the unit.

                                  ShortUnit representation
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  212. PlanDefinition.action.timing[x].system
                                  Definition

                                  The identification of the system that provides the coded form of the unit.

                                  ShortSystem that defines coded unit form
                                  Control0..1
                                  This element is affected by the following invariants: qty-3
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to know the system that defines the coded form of the unit.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  214. PlanDefinition.action.timing[x].code
                                  Definition

                                  A computer processable form of the unit in some unit representation system.

                                  ShortCoded form of the unit
                                  Comments

                                  The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

                                  Control0..1
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  216. PlanDefinition.action.participant
                                  Definition

                                  Indicates who should participate in performing the action described.

                                  ShortWho should participate in the action
                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  218. 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.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  220. PlanDefinition.action.participant.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  222. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                  ShortExtensions that cannot be ignored even if unrecognized
                                  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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                  Summarytrue
                                  Requirements

                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                  Alternate Namesextensions, user content, modifiers
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  224. PlanDefinition.action.participant.type
                                  Definition

                                  The type of participant in the action.

                                  Shortpatient | practitioner | related-person | device
                                  Control1..1
                                  BindingThe codes SHALL be taken from ActionParticipantType
                                  (required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

                                  The type of participant for the action.

                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  226. PlanDefinition.action.participant.role
                                  Definition

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

                                  ShortE.g. Nurse, Surgeon, Parent
                                  Control0..1
                                  BindingFor example codes, see ActionParticipantRole
                                  (example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

                                  Defines roles played by participants for the action.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  228. PlanDefinition.action.participant.role.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  230. PlanDefinition.action.participant.role.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on PlanDefinition.action.participant.role.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 232. PlanDefinition.action.participant.role.coding
                                    Definition

                                    A reference to a code defined by a terminology system.

                                    ShortCode defined by a terminology system
                                    Comments

                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                    Control0..*
                                    TypeCoding
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    234. PlanDefinition.action.participant.role.coding.id
                                    Definition

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

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    236. PlanDefinition.action.participant.role.coding.extension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on PlanDefinition.action.participant.role.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 238. PlanDefinition.action.participant.role.coding.system
                                      Definition

                                      The identification of the code system that defines the meaning of the symbol in the code.

                                      ShortIdentity of the terminology system
                                      Comments

                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                      Control0..0
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need to be unambiguous about the source of the definition of the symbol.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      240. PlanDefinition.action.participant.role.coding.version
                                      Definition

                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                      ShortVersion of the system - if relevant
                                      Comments

                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      242. PlanDefinition.action.participant.role.coding.code
                                      Definition

                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                      ShortSymbol in syntax defined by the system
                                      Control0..1
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need to refer to a particular code in the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      244. PlanDefinition.action.participant.role.coding.display
                                      Definition

                                      A representation of the meaning of the code in the system, following the rules of the system.

                                      ShortRepresentation defined by the system
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      246. PlanDefinition.action.participant.role.coding.userSelected
                                      Definition

                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                      ShortIf this coding was chosen directly by the user
                                      Comments

                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                      Control0..1
                                      Typeboolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      248. PlanDefinition.action.participant.role.text
                                      Definition

                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                      ShortPlain text representation of the concept
                                      Comments

                                      Very often the text is the same as a displayName of one of the codings.

                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      250. PlanDefinition.action.type
                                      Definition

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

                                      Shortcreate | update | remove | fire-event
                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ActionType
                                      (extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

                                      The type of action to be performed.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      252. PlanDefinition.action.groupingBehavior
                                      Definition

                                      Defines the grouping behavior for the action and its children.

                                      Shortvisual-group | logical-group | sentence-group
                                      Control0..1
                                      BindingThe codes SHALL be taken from ActionGroupingBehavior
                                      (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

                                      Defines organization behavior of a group.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      254. PlanDefinition.action.selectionBehavior
                                      Definition

                                      Defines the selection behavior for the action and its children.

                                      Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
                                      Control0..1
                                      BindingThe codes SHALL be taken from ActionSelectionBehavior
                                      (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

                                      Defines selection behavior of a group.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      256. PlanDefinition.action.requiredBehavior
                                      Definition

                                      Defines the required behavior for the action.

                                      Shortmust | could | must-unless-documented
                                      Control0..1
                                      BindingThe codes SHALL be taken from ActionRequiredBehavior
                                      (required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

                                      Defines expectations around whether an action or action group is required.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      258. PlanDefinition.action.precheckBehavior
                                      Definition

                                      Defines whether the action should usually be preselected.

                                      Shortyes | no
                                      Control0..1
                                      BindingThe codes SHALL be taken from ActionPrecheckBehavior
                                      (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

                                      Defines selection frequency behavior for an action or group.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      260. PlanDefinition.action.cardinalityBehavior
                                      Definition

                                      Defines whether the action can be selected multiple times.

                                      Shortsingle | multiple
                                      Control0..1
                                      BindingThe codes SHALL be taken from ActionCardinalityBehavior
                                      (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

                                      Defines behavior for an action or a group for how many times that item may be repeated.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      262. PlanDefinition.action.definition[x]
                                      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.

                                      ShortDescription of the activity to be performed
                                      Comments

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

                                      Control0..1
                                      Typecanonical(Questionnaire)
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      264. 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.

                                      ShortTransform to apply the template
                                      Comments

                                      Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                      Control0..1
                                      Typecanonical(StructureMap)
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      266. 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.

                                      ShortDynamic aspects of the definition
                                      Comments

                                      Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      268. 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.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      270. PlanDefinition.action.dynamicValue.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      272. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      274. 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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                      ShortThe path to the element to be set dynamically
                                      Comments

                                      To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      276. PlanDefinition.action.dynamicValue.expression
                                      Definition

                                      An expression specifying the value of the customized element.

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

                                      Control0..1
                                      TypeExpression
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      278. 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.

                                      ShortA sub-action
                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      280. PlanDefinition.action.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.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      282. PlanDefinition.action.action.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      284. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      286. PlanDefinition.action.action.prefix
                                      Definition

                                      A user-visible prefix for the action.

                                      ShortUser-visible prefix for the action (e.g. 1. or A.)
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      288. PlanDefinition.action.action.title
                                      Definition

                                      The title of the action displayed to a user.

                                      ShortUser-visible title
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      290. PlanDefinition.action.action.description
                                      Definition

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

                                      ShortBrief description of the action
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      292. PlanDefinition.action.action.textEquivalent
                                      Definition

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

                                      ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      294. PlanDefinition.action.action.priority
                                      Definition

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

                                      Shortroutine | urgent | asap | stat
                                      Control0..1
                                      BindingThe codes SHALL be taken from RequestPriority
                                      (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                                      Identifies the level of importance to be assigned to actioning the request.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      296. PlanDefinition.action.action.code
                                      Definition

                                      A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                                      ShortCode representing the meaning of the action or sub-actions
                                      Control1..*
                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      SlicingThis element introduces a set of slices on PlanDefinition.action.action.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ coding.system
                                      • 298. PlanDefinition.action.action.code:action-type
                                        Slice Nameaction-type
                                        Definition

                                        A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                                        ShortCode representing the meaning of the action or sub-actions
                                        Control1..1
                                        BindingThe codes SHOULD be taken from Plan Definition Action Type Value Set
                                        (preferred to https://api.openhealthhub.com/OpenHealthhub/fhir/4/ValueSet/plan-definition-action-type-value-set)
                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        300. PlanDefinition.action.action.code:action-type.id
                                        Definition

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

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        302. PlanDefinition.action.action.code:action-type.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on PlanDefinition.action.action.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 304. PlanDefinition.action.action.code:action-type.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          306. PlanDefinition.action.action.code:action-type.coding.id
                                          Definition

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

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          308. PlanDefinition.action.action.code:action-type.coding.extension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on PlanDefinition.action.action.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 310. PlanDefinition.action.action.code:action-type.coding.system
                                            Definition

                                            The identification of the code system that defines the meaning of the symbol in the code.

                                            ShortIdentity of the terminology system
                                            Comments

                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to be unambiguous about the source of the definition of the symbol.

                                            Pattern Valuehttps://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            312. PlanDefinition.action.action.code:action-type.coding.version
                                            Definition

                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                            ShortVersion of the system - if relevant
                                            Comments

                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            314. PlanDefinition.action.action.code:action-type.coding.code
                                            Definition

                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                            ShortSymbol in syntax defined by the system
                                            Control0..1
                                            Typecode
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to refer to a particular code in the system.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            316. PlanDefinition.action.action.code:action-type.coding.display
                                            Definition

                                            A representation of the meaning of the code in the system, following the rules of the system.

                                            ShortRepresentation defined by the system
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            318. PlanDefinition.action.action.code:action-type.coding.userSelected
                                            Definition

                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                            ShortIf this coding was chosen directly by the user
                                            Comments

                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                            Control0..1
                                            Typeboolean
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            320. PlanDefinition.action.action.code:action-type.text
                                            Definition

                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                            ShortPlain text representation of the concept
                                            Comments

                                            Very often the text is the same as a displayName of one of the codings.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            322. PlanDefinition.action.action.code:notification
                                            Slice Namenotification
                                            Definition

                                            A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                                            ShortCode representing the meaning of the action or sub-actions
                                            Control0..1
                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            324. PlanDefinition.action.action.code:notification.id
                                            Definition

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

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            326. PlanDefinition.action.action.code:notification.extension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on PlanDefinition.action.action.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 328. PlanDefinition.action.action.code:notification.coding
                                              Definition

                                              A reference to a code defined by a terminology system.

                                              ShortCode defined by a terminology system
                                              Comments

                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                              Control0..*
                                              TypeCoding
                                              Is Modifierfalse
                                              Summarytrue
                                              Requirements

                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              330. PlanDefinition.action.action.code:notification.coding.id
                                              Definition

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

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              332. PlanDefinition.action.action.code:notification.coding.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on PlanDefinition.action.action.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 334. PlanDefinition.action.action.code:notification.coding.system
                                                Definition

                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                ShortIdentity of the terminology system
                                                Comments

                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

                                                Need to be unambiguous about the source of the definition of the symbol.

                                                Pattern Valuehttps://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                336. PlanDefinition.action.action.code:notification.coding.version
                                                Definition

                                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                ShortVersion of the system - if relevant
                                                Comments

                                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                338. PlanDefinition.action.action.code:notification.coding.code
                                                Definition

                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                ShortSymbol in syntax defined by the system
                                                Control0..1
                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

                                                Need to refer to a particular code in the system.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                340. PlanDefinition.action.action.code:notification.coding.display
                                                Definition

                                                A representation of the meaning of the code in the system, following the rules of the system.

                                                ShortRepresentation defined by the system
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                342. PlanDefinition.action.action.code:notification.coding.userSelected
                                                Definition

                                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                ShortIf this coding was chosen directly by the user
                                                Comments

                                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                Control0..1
                                                Typeboolean
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

                                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                344. PlanDefinition.action.action.code:notification.text
                                                Definition

                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                ShortPlain text representation of the concept
                                                Comments

                                                Very often the text is the same as a displayName of one of the codings.

                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Requirements

                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                346. PlanDefinition.action.action.reason
                                                Definition

                                                A description of why this action is necessary or appropriate.

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

                                                Control0..*
                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                348. PlanDefinition.action.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.

                                                ShortSupporting documentation for the intended performer of the action
                                                Control0..*
                                                TypeRelatedArtifact
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                350. PlanDefinition.action.action.goalId
                                                Definition

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

                                                ShortWhat goals this action supports
                                                Control0..*
                                                Typeid
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                352. PlanDefinition.action.action.subject[x]
                                                Definition

                                                A code or group definition that describes the intended subject of the action and its children, if any.

                                                ShortType of individual the action is focused on
                                                Comments

                                                The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

                                                In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

                                                Control0..1
                                                BindingUnless not suitable, these codes SHALL be taken from SubjectType
                                                (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

                                                The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

                                                TypeChoice of: CodeableConcept, Reference(Group)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

                                                Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

                                                Meaning if MissingPatient
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                354. PlanDefinition.action.action.trigger
                                                Definition

                                                A description of when the action should be triggered.

                                                ShortWhen the action should be triggered
                                                Control0..*
                                                TypeTriggerDefinition
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                356. PlanDefinition.action.action.condition
                                                Definition

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

                                                ShortWhether or not the action is applicable
                                                Comments

                                                When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                358. PlanDefinition.action.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                360. PlanDefinition.action.action.condition.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                362. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                364. PlanDefinition.action.action.condition.kind
                                                Definition

                                                The kind of condition.

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

                                                Control1..1
                                                BindingThe codes SHALL be taken from ActionConditionKind
                                                (required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

                                                Defines the kinds of conditions that can appear on actions.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                366. PlanDefinition.action.action.condition.expression
                                                Definition

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

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

                                                Control0..1
                                                TypeExpression
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                368. PlanDefinition.action.action.input
                                                Definition

                                                Defines input data requirements for the action.

                                                ShortInput data requirements
                                                Control0..*
                                                TypeDataRequirement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                370. PlanDefinition.action.action.output
                                                Definition

                                                Defines the outputs of the action, if any.

                                                ShortOutput data definition
                                                Control0..*
                                                TypeDataRequirement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                372. PlanDefinition.action.action.relatedAction
                                                Definition

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

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

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                374. PlanDefinition.action.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                376. PlanDefinition.action.action.relatedAction.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                378. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                380. PlanDefinition.action.action.relatedAction.actionId
                                                Definition

                                                The element id of the related action.

                                                ShortWhat action is this related to
                                                Control1..1
                                                Typeid
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                382. PlanDefinition.action.action.relatedAction.relationship
                                                Definition

                                                The relationship of this action to the related action.

                                                Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
                                                Control1..1
                                                BindingThe codes SHALL be taken from ActionRelationshipType
                                                (required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

                                                Defines the types of relationships between actions.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                384. PlanDefinition.action.action.relatedAction.offset[x]
                                                Definition

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

                                                ShortTime offset for the relationship
                                                Control0..1
                                                TypeChoice of: Duration, Range
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                386. PlanDefinition.action.action.timing[x]
                                                Definition

                                                An optional value describing when the action should be performed.

                                                ShortWhen the action should take place
                                                Control0..1
                                                TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                388. PlanDefinition.action.action.participant
                                                Definition

                                                Indicates who should participate in performing the action described.

                                                ShortWho should participate in the action
                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                390. PlanDefinition.action.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                392. PlanDefinition.action.action.participant.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                394. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                396. PlanDefinition.action.action.participant.type
                                                Definition

                                                The type of participant in the action.

                                                Shortpatient | practitioner | related-person | device
                                                Control1..1
                                                BindingThe codes SHALL be taken from ActionParticipantType
                                                (required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

                                                The type of participant for the action.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                398. PlanDefinition.action.action.participant.role
                                                Definition

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

                                                ShortE.g. Nurse, Surgeon, Parent
                                                Control0..1
                                                BindingFor example codes, see ActionParticipantRole
                                                (example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

                                                Defines roles played by participants for the action.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                400. PlanDefinition.action.action.type
                                                Definition

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

                                                Shortcreate | update | remove | fire-event
                                                Control0..1
                                                BindingUnless not suitable, these codes SHALL be taken from ActionType
                                                (extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

                                                The type of action to be performed.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                402. PlanDefinition.action.action.groupingBehavior
                                                Definition

                                                Defines the grouping behavior for the action and its children.

                                                Shortvisual-group | logical-group | sentence-group
                                                Control0..1
                                                BindingThe codes SHALL be taken from ActionGroupingBehavior
                                                (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

                                                Defines organization behavior of a group.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                404. PlanDefinition.action.action.selectionBehavior
                                                Definition

                                                Defines the selection behavior for the action and its children.

                                                Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
                                                Control0..1
                                                BindingThe codes SHALL be taken from ActionSelectionBehavior
                                                (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

                                                Defines selection behavior of a group.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                406. PlanDefinition.action.action.requiredBehavior
                                                Definition

                                                Defines the required behavior for the action.

                                                Shortmust | could | must-unless-documented
                                                Control0..1
                                                BindingThe codes SHALL be taken from ActionRequiredBehavior
                                                (required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

                                                Defines expectations around whether an action or action group is required.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                408. PlanDefinition.action.action.precheckBehavior
                                                Definition

                                                Defines whether the action should usually be preselected.

                                                Shortyes | no
                                                Control0..1
                                                BindingThe codes SHALL be taken from ActionPrecheckBehavior
                                                (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

                                                Defines selection frequency behavior for an action or group.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                410. PlanDefinition.action.action.cardinalityBehavior
                                                Definition

                                                Defines whether the action can be selected multiple times.

                                                Shortsingle | multiple
                                                Control0..1
                                                BindingThe codes SHALL be taken from ActionCardinalityBehavior
                                                (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

                                                Defines behavior for an action or a group for how many times that item may be repeated.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                412. PlanDefinition.action.action.definition[x]
                                                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.

                                                ShortDescription of the activity to be performed
                                                Comments

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

                                                Control0..1
                                                TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                414. PlanDefinition.action.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.

                                                ShortTransform to apply the template
                                                Comments

                                                Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                Control0..1
                                                Typecanonical(StructureMap)
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                416. PlanDefinition.action.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.

                                                ShortDynamic aspects of the definition
                                                Comments

                                                Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                418. PlanDefinition.action.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                420. PlanDefinition.action.action.dynamicValue.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                422. PlanDefinition.action.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                424. PlanDefinition.action.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                ShortThe path to the element to be set dynamically
                                                Comments

                                                To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                426. PlanDefinition.action.action.dynamicValue.expression
                                                Definition

                                                An expression specifying the value of the customized element.

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

                                                Control0..1
                                                TypeExpression
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                428. PlanDefinition.action.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.

                                                ShortA sub-action
                                                Control0..*
                                                TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                430. PlanDefinition.action:patientAction
                                                Slice NamepatientAction
                                                Definition

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

                                                ShortAction defined by the plan
                                                Comments

                                                Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                432. PlanDefinition.action:patientAction.id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                434. PlanDefinition.action:patientAction.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                436. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                438. PlanDefinition.action:patientAction.prefix
                                                Definition

                                                A user-visible prefix for the action.

                                                ShortUser-visible prefix for the action (e.g. 1. or A.)
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                440. PlanDefinition.action:patientAction.title
                                                Definition

                                                The title of the action displayed to a user.

                                                ShortUser-visible title
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                442. PlanDefinition.action:patientAction.description
                                                Definition

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

                                                ShortBrief description of the action
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                444. PlanDefinition.action:patientAction.textEquivalent
                                                Definition

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

                                                ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                446. PlanDefinition.action:patientAction.priority
                                                Definition

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

                                                Shortroutine | urgent | asap | stat
                                                Control0..1
                                                BindingThe codes SHALL be taken from RequestPriority
                                                (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                                                Identifies the level of importance to be assigned to actioning the request.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                448. PlanDefinition.action:patientAction.code
                                                Definition

                                                A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                                                ShortCode representing the meaning of the action or sub-actions
                                                Control0..*
                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                450. PlanDefinition.action:patientAction.reason
                                                Definition

                                                A description of why this action is necessary or appropriate.

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

                                                Control0..*
                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                452. PlanDefinition.action:patientAction.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.

                                                ShortSupporting documentation for the intended performer of the action
                                                Control0..*
                                                TypeRelatedArtifact
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                454. PlanDefinition.action:patientAction.goalId
                                                Definition

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

                                                ShortWhat goals this action supports
                                                Control0..*
                                                Typeid
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                456. PlanDefinition.action:patientAction.subject[x]
                                                Definition

                                                A code or group definition that describes the intended subject of the action and its children, if any.

                                                ShortType of individual the action is focused on
                                                Comments

                                                The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

                                                In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

                                                Control0..1
                                                BindingUnless not suitable, these codes SHALL be taken from SubjectType
                                                (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

                                                The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

                                                TypeChoice of: CodeableConcept, Reference(Group)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Requirements

                                                Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

                                                Meaning if MissingPatient
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                458. PlanDefinition.action:patientAction.trigger
                                                Definition

                                                A description of when the action should be triggered.

                                                ShortWhen the action should be triggered
                                                Control0..*
                                                TypeTriggerDefinition
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                460. PlanDefinition.action:patientAction.condition
                                                Definition

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

                                                ShortWhether or not the action is applicable
                                                Comments

                                                When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                462. PlanDefinition.action:patientAction.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                464. PlanDefinition.action:patientAction.condition.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                466. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                468. PlanDefinition.action:patientAction.condition.kind
                                                Definition

                                                The kind of condition.

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

                                                Control1..1
                                                BindingThe codes SHALL be taken from ActionConditionKind
                                                (required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

                                                Defines the kinds of conditions that can appear on actions.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                470. PlanDefinition.action:patientAction.condition.expression
                                                Definition

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

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

                                                Control0..1
                                                TypeExpression
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                472. PlanDefinition.action:patientAction.input
                                                Definition

                                                Defines input data requirements for the action.

                                                ShortInput data requirements
                                                Control0..*
                                                TypeDataRequirement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                474. PlanDefinition.action:patientAction.output
                                                Definition

                                                Defines the outputs of the action, if any.

                                                ShortOutput data definition
                                                Control0..*
                                                TypeDataRequirement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                476. PlanDefinition.action:patientAction.relatedAction
                                                Definition

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

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

                                                Control0..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                478. PlanDefinition.action:patientAction.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                480. PlanDefinition.action:patientAction.relatedAction.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                482. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                ShortExtensions that cannot be ignored even if unrecognized
                                                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.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                Summarytrue
                                                Requirements

                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                Alternate Namesextensions, user content, modifiers
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                484. PlanDefinition.action:patientAction.relatedAction.actionId
                                                Definition

                                                The element id of the related action.

                                                ShortWhat action is this related to
                                                Control1..1
                                                Typeid
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                486. PlanDefinition.action:patientAction.relatedAction.relationship
                                                Definition

                                                The relationship of this action to the related action.

                                                Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
                                                Control1..1
                                                BindingThe codes SHALL be taken from ActionRelationshipType
                                                (required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

                                                Defines the types of relationships between actions.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                488. PlanDefinition.action:patientAction.relatedAction.offset[x]
                                                Definition

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

                                                ShortTime offset for the relationship
                                                Control0..1
                                                TypeChoice of: Duration, Range
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                490. PlanDefinition.action:patientAction.timing[x]
                                                Definition

                                                An optional value describing when the action should be performed.

                                                ShortWhen the action should take place
                                                Control0..1
                                                TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                492. PlanDefinition.action:patientAction.timing[x].id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                494. PlanDefinition.action:patientAction.timing[x].extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on PlanDefinition.action.timing[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 496. PlanDefinition.action:patientAction.timing[x].extension:iso-8601-duration
                                                  Slice Nameiso-8601-duration
                                                  Definition

                                                  Extension representing the duration in the ISO-8601 format

                                                  ShortISO-8601 Duration Extension
                                                  Control0..1
                                                  TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  498. PlanDefinition.action:patientAction.participant
                                                  Definition

                                                  Indicates who should participate in performing the action described.

                                                  ShortWho should participate in the action
                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  500. PlanDefinition.action:patientAction.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.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  502. PlanDefinition.action:patientAction.participant.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  504. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  506. PlanDefinition.action:patientAction.participant.type
                                                  Definition

                                                  The type of participant in the action.

                                                  Shortpatient | practitioner | related-person | device
                                                  Control1..1
                                                  BindingThe codes SHALL be taken from ActionParticipantType
                                                  (required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

                                                  The type of participant for the action.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Pattern Valuepatient
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  508. PlanDefinition.action:patientAction.participant.role
                                                  Definition

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

                                                  ShortE.g. Nurse, Surgeon, Parent
                                                  Control0..0
                                                  BindingFor example codes, see ActionParticipantRole
                                                  (example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

                                                  Defines roles played by participants for the action.

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  510. PlanDefinition.action:patientAction.type
                                                  Definition

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

                                                  Shortcreate | update | remove | fire-event
                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ActionType
                                                  (extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

                                                  The type of action to be performed.

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  512. PlanDefinition.action:patientAction.groupingBehavior
                                                  Definition

                                                  Defines the grouping behavior for the action and its children.

                                                  Shortvisual-group | logical-group | sentence-group
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from ActionGroupingBehavior
                                                  (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

                                                  Defines organization behavior of a group.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  514. PlanDefinition.action:patientAction.selectionBehavior
                                                  Definition

                                                  Defines the selection behavior for the action and its children.

                                                  Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from ActionSelectionBehavior
                                                  (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

                                                  Defines selection behavior of a group.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  516. PlanDefinition.action:patientAction.requiredBehavior
                                                  Definition

                                                  Defines the required behavior for the action.

                                                  Shortmust | could | must-unless-documented
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from ActionRequiredBehavior
                                                  (required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

                                                  Defines expectations around whether an action or action group is required.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  518. PlanDefinition.action:patientAction.precheckBehavior
                                                  Definition

                                                  Defines whether the action should usually be preselected.

                                                  Shortyes | no
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from ActionPrecheckBehavior
                                                  (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

                                                  Defines selection frequency behavior for an action or group.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  520. PlanDefinition.action:patientAction.cardinalityBehavior
                                                  Definition

                                                  Defines whether the action can be selected multiple times.

                                                  Shortsingle | multiple
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from ActionCardinalityBehavior
                                                  (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

                                                  Defines behavior for an action or a group for how many times that item may be repeated.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  522. PlanDefinition.action:patientAction.definition[x]
                                                  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.

                                                  ShortDescription of the activity to be performed
                                                  Comments

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

                                                  Control0..1
                                                  TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  524. PlanDefinition.action:patientAction.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.

                                                  ShortTransform to apply the template
                                                  Comments

                                                  Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                  Control0..1
                                                  Typecanonical(StructureMap)
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  526. PlanDefinition.action:patientAction.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.

                                                  ShortDynamic aspects of the definition
                                                  Comments

                                                  Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  528. PlanDefinition.action:patientAction.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.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  530. PlanDefinition.action:patientAction.dynamicValue.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  532. PlanDefinition.action:patientAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  534. PlanDefinition.action:patientAction.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                  ShortThe path to the element to be set dynamically
                                                  Comments

                                                  To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  536. PlanDefinition.action:patientAction.dynamicValue.expression
                                                  Definition

                                                  An expression specifying the value of the customized element.

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

                                                  Control0..1
                                                  TypeExpression
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  538. PlanDefinition.action:patientAction.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.

                                                  ShortA sub-action
                                                  Control0..*
                                                  TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  540. PlanDefinition.action:practitionerAction
                                                  Slice NamepractitionerAction
                                                  Definition

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

                                                  ShortAction defined by the plan
                                                  Comments

                                                  Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  542. PlanDefinition.action:practitionerAction.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  544. PlanDefinition.action:practitionerAction.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  546. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  548. PlanDefinition.action:practitionerAction.prefix
                                                  Definition

                                                  A user-visible prefix for the action.

                                                  ShortUser-visible prefix for the action (e.g. 1. or A.)
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  550. PlanDefinition.action:practitionerAction.title
                                                  Definition

                                                  The title of the action displayed to a user.

                                                  ShortUser-visible title
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  552. PlanDefinition.action:practitionerAction.description
                                                  Definition

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

                                                  ShortBrief description of the action
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  554. PlanDefinition.action:practitionerAction.textEquivalent
                                                  Definition

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

                                                  ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  556. PlanDefinition.action:practitionerAction.priority
                                                  Definition

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

                                                  Shortroutine | urgent | asap | stat
                                                  Control0..1
                                                  BindingThe codes SHALL be taken from RequestPriority
                                                  (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

                                                  Identifies the level of importance to be assigned to actioning the request.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  558. PlanDefinition.action:practitionerAction.code
                                                  Definition

                                                  A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

                                                  ShortCode representing the meaning of the action or sub-actions
                                                  Control0..*
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  560. PlanDefinition.action:practitionerAction.reason
                                                  Definition

                                                  A description of why this action is necessary or appropriate.

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

                                                  Control0..*
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  562. PlanDefinition.action:practitionerAction.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.

                                                  ShortSupporting documentation for the intended performer of the action
                                                  Control0..*
                                                  TypeRelatedArtifact
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  564. PlanDefinition.action:practitionerAction.goalId
                                                  Definition

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

                                                  ShortWhat goals this action supports
                                                  Control0..*
                                                  Typeid
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  566. PlanDefinition.action:practitionerAction.subject[x]
                                                  Definition

                                                  A code or group definition that describes the intended subject of the action and its children, if any.

                                                  ShortType of individual the action is focused on
                                                  Comments

                                                  The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

                                                  In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from SubjectType
                                                  (extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

                                                  The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

                                                  TypeChoice of: CodeableConcept, Reference(Group)
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Requirements

                                                  Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

                                                  Meaning if MissingPatient
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  568. PlanDefinition.action:practitionerAction.trigger
                                                  Definition

                                                  A description of when the action should be triggered.

                                                  ShortWhen the action should be triggered
                                                  Control0..*
                                                  TypeTriggerDefinition
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  570. PlanDefinition.action:practitionerAction.condition
                                                  Definition

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

                                                  ShortWhether or not the action is applicable
                                                  Comments

                                                  When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  572. PlanDefinition.action:practitionerAction.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.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  574. PlanDefinition.action:practitionerAction.condition.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  576. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  578. PlanDefinition.action:practitionerAction.condition.kind
                                                  Definition

                                                  The kind of condition.

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

                                                  Control1..1
                                                  BindingThe codes SHALL be taken from ActionConditionKind
                                                  (required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

                                                  Defines the kinds of conditions that can appear on actions.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  580. PlanDefinition.action:practitionerAction.condition.expression
                                                  Definition

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

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

                                                  Control0..1
                                                  TypeExpression
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  582. PlanDefinition.action:practitionerAction.input
                                                  Definition

                                                  Defines input data requirements for the action.

                                                  ShortInput data requirements
                                                  Control0..*
                                                  TypeDataRequirement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  584. PlanDefinition.action:practitionerAction.output
                                                  Definition

                                                  Defines the outputs of the action, if any.

                                                  ShortOutput data definition
                                                  Control0..*
                                                  TypeDataRequirement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  586. PlanDefinition.action:practitionerAction.relatedAction
                                                  Definition

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

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

                                                  Control0..*
                                                  TypeBackboneElement
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  588. PlanDefinition.action:practitionerAction.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.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  590. PlanDefinition.action:practitionerAction.relatedAction.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  592. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  594. PlanDefinition.action:practitionerAction.relatedAction.actionId
                                                  Definition

                                                  The element id of the related action.

                                                  ShortWhat action is this related to
                                                  Control1..1
                                                  Typeid
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  596. PlanDefinition.action:practitionerAction.relatedAction.relationship
                                                  Definition

                                                  The relationship of this action to the related action.

                                                  Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
                                                  Control1..1
                                                  BindingThe codes SHALL be taken from ActionRelationshipType
                                                  (required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

                                                  Defines the types of relationships between actions.

                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  598. PlanDefinition.action:practitionerAction.relatedAction.offset[x]
                                                  Definition

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

                                                  ShortTime offset for the relationship
                                                  Control0..1
                                                  TypeChoice of: Duration, Range
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  600. PlanDefinition.action:practitionerAction.timing[x]
                                                  Definition

                                                  An optional value describing when the action should be performed.

                                                  ShortWhen the action should take place
                                                  Control0..1
                                                  TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  602. PlanDefinition.action:practitionerAction.timing[x].id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  604. PlanDefinition.action:practitionerAction.timing[x].extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on PlanDefinition.action.timing[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 606. PlanDefinition.action:practitionerAction.timing[x].extension:iso-8601-duration
                                                    Slice Nameiso-8601-duration
                                                    Definition

                                                    Extension representing the duration in the ISO-8601 format

                                                    ShortISO-8601 Duration Extension
                                                    Control0..1
                                                    TypeExtension(ISO-8601 Duration Extension) (Extension Type: string)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    608. PlanDefinition.action:practitionerAction.participant
                                                    Definition

                                                    Indicates who should participate in performing the action described.

                                                    ShortWho should participate in the action
                                                    Control0..*
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    610. PlanDefinition.action:practitionerAction.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.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    612. PlanDefinition.action:practitionerAction.participant.extension
                                                    Definition

                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    614. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                    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.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                    Summarytrue
                                                    Requirements

                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                    Alternate Namesextensions, user content, modifiers
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    616. PlanDefinition.action:practitionerAction.participant.type
                                                    Definition

                                                    The type of participant in the action.

                                                    Shortpatient | practitioner | related-person | device
                                                    Control1..1
                                                    BindingThe codes SHALL be taken from ActionParticipantType
                                                    (required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

                                                    The type of participant for the action.

                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Pattern Valuepractitioner
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    618. PlanDefinition.action:practitionerAction.participant.role
                                                    Definition

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

                                                    ShortE.g. Nurse, Surgeon, Parent
                                                    Control0..1
                                                    BindingFor example codes, see ActionParticipantRole
                                                    (example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

                                                    Defines roles played by participants for the action.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    620. PlanDefinition.action:practitionerAction.participant.role.id
                                                    Definition

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

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    622. PlanDefinition.action:practitionerAction.participant.role.extension
                                                    Definition

                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on PlanDefinition.action.participant.role.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 624. PlanDefinition.action:practitionerAction.participant.role.coding
                                                      Definition

                                                      A reference to a code defined by a terminology system.

                                                      ShortCode defined by a terminology system
                                                      Comments

                                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                      Control0..*
                                                      TypeCoding
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Requirements

                                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      626. PlanDefinition.action:practitionerAction.participant.role.text
                                                      Definition

                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                      ShortPlain text representation of the concept
                                                      Comments

                                                      Very often the text is the same as a displayName of one of the codings.

                                                      Control1..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      628. PlanDefinition.action:practitionerAction.type
                                                      Definition

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

                                                      Shortcreate | update | remove | fire-event
                                                      Control0..1
                                                      BindingUnless not suitable, these codes SHALL be taken from ActionType
                                                      (extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

                                                      The type of action to be performed.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      630. PlanDefinition.action:practitionerAction.groupingBehavior
                                                      Definition

                                                      Defines the grouping behavior for the action and its children.

                                                      Shortvisual-group | logical-group | sentence-group
                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ActionGroupingBehavior
                                                      (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

                                                      Defines organization behavior of a group.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      632. PlanDefinition.action:practitionerAction.selectionBehavior
                                                      Definition

                                                      Defines the selection behavior for the action and its children.

                                                      Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ActionSelectionBehavior
                                                      (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

                                                      Defines selection behavior of a group.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      634. PlanDefinition.action:practitionerAction.requiredBehavior
                                                      Definition

                                                      Defines the required behavior for the action.

                                                      Shortmust | could | must-unless-documented
                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ActionRequiredBehavior
                                                      (required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

                                                      Defines expectations around whether an action or action group is required.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      636. PlanDefinition.action:practitionerAction.precheckBehavior
                                                      Definition

                                                      Defines whether the action should usually be preselected.

                                                      Shortyes | no
                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ActionPrecheckBehavior
                                                      (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

                                                      Defines selection frequency behavior for an action or group.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      638. PlanDefinition.action:practitionerAction.cardinalityBehavior
                                                      Definition

                                                      Defines whether the action can be selected multiple times.

                                                      Shortsingle | multiple
                                                      Control0..1
                                                      BindingThe codes SHALL be taken from ActionCardinalityBehavior
                                                      (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

                                                      Defines behavior for an action or a group for how many times that item may be repeated.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      640. PlanDefinition.action:practitionerAction.definition[x]
                                                      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.

                                                      ShortDescription of the activity to be performed
                                                      Comments

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

                                                      Control0..1
                                                      TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      642. PlanDefinition.action:practitionerAction.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.

                                                      ShortTransform to apply the template
                                                      Comments

                                                      Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                      Control0..1
                                                      Typecanonical(StructureMap)
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      644. PlanDefinition.action:practitionerAction.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.

                                                      ShortDynamic aspects of the definition
                                                      Comments

                                                      Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

                                                      Control0..*
                                                      TypeBackboneElement
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      646. PlanDefinition.action:practitionerAction.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.

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      648. PlanDefinition.action:practitionerAction.dynamicValue.extension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      650. PlanDefinition.action:practitionerAction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                      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.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                      Summarytrue
                                                      Requirements

                                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                      Alternate Namesextensions, user content, modifiers
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      652. PlanDefinition.action:practitionerAction.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

                                                      ShortThe path to the element to be set dynamically
                                                      Comments

                                                      To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      654. PlanDefinition.action:practitionerAction.dynamicValue.expression
                                                      Definition

                                                      An expression specifying the value of the customized element.

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

                                                      Control0..1
                                                      TypeExpression
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      656. PlanDefinition.action:practitionerAction.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.

                                                      ShortA sub-action
                                                      Control0..*
                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))