HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide
0.1.0 - CI Build

HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by Te Aho o Te Kahu, Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions

Resource Profile: CcaPlanDefinition - Detailed Descriptions

Active as of 2026-05-21

Definitions for the CcaPlanDefinition resource profile.

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

An Extension


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.

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.

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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. PlanDefinition.extension:support-factor
    Slice Namesupport-factor
    Definition

    Support factors needed during treatment

    ShortExtension
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(SupportFactor) (Complex Extension)
    Is Modifierfalse
    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())
    8. PlanDefinition.extension:regimen-type
    Slice Nameregimen-type
    Definition

    The overall type of the regimen - eg FOLFOX

    ShortRegimen type
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Regimen type) (Extension Type: CodeableConcept)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. PlanDefinition.extension:replaced-by
    Slice Namereplaced-by
    Definition

    When a Plan has been deprecated (superceeded or discontinued), refers to the one that replaces it, if any

    ShortReplaced by
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Replaced by) (Extension Type: Reference(PlanDefinition))
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. PlanDefinition.extension:treatment-setting
    Slice Nametreatment-setting
    Definition

    The setting of the regimen - what is its purpose

    ShortExtension
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(TreatmentSetting) (Extension Type: CodeableConcept)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. PlanDefinition.extension:offLabel
    Slice NameoffLabel
    Definition

    Indicates that the medication is being used for a purpose for which it has not been specifically approved

    ShortOff label
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Off label) (Extension Type: boolean)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. PlanDefinition.extension:plan-instructions
    Slice Nameplan-instructions
    Definition

    Specific instructions for use of the regimen overall, or for the individual cycles

    ShortInstructions for use
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Instructions for use) (Extension Type: markdown)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. PlanDefinition.extension:disclaimer
    Slice Namedisclaimer
    Definition

    A disclaimer for use of this Plan

    ShortExtension
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Disclaimer) (Extension Type: markdown)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. PlanDefinition.extension:additionalDetails
    Slice NameadditionalDetails
    Definition

    Allows additional information to be added to a regimen such as dosing modification details

    ShortExtension
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(AdditionalDetails) (Complex Extension)
    Is Modifierfalse
    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.extension:esmo-score
    Slice Nameesmo-score
    Definition

    The ESMO Magnitude of Clinical Benefit Scale (ESMO-MCBS) score for the regimen

    ShortESMO-MCBS Score
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(ESMO-MCBS Score) (Complex Extension)
    Is Modifierfalse
    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())
    24. 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())
    26. 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 PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1)

    The type of PlanDefinition.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code" : "clinical-protocol"
      }]
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. 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()))
    30. PlanDefinition.status.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.

    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on PlanDefinition.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 32. PlanDefinition.status.extension:additional-status
      Slice Nameadditional-status
      Definition

      Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'

      ShortRegimen under review
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Regimen under review) (Extension Type: code)
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      34. 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 at End, and can be differentiated using the following discriminators:
      • value @ code
      • 36. PlanDefinition.useContext.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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. PlanDefinition.useContext.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.

        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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. PlanDefinition.useContext:cancer-type
        Slice Namecancer-type
        Definition

        The type of cancer


        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 type of cancerThe 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
        Must Supporttrue
        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()))
        42. PlanDefinition.useContext:cancer-type.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{
          "code" : "focus"
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. PlanDefinition.useContext:cancer-type.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
        BindingThe codes SHALL be taken from For example codes, see Cancer typehttp://hl7.org/fhir/ValueSet/use-context|4.0.1
        (required to https://standards.digital.health.nz/fhir/ValueSet/cancer-type-code)
        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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. PlanDefinition.reviewer
        Definition

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

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

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

        ShortWho endorsed the content
        Control0..0*
        TypeContactDetail
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. 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..0*
        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()))
        52. 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
        Control0..0*
        TypeBackboneElement
        Is Modifierfalse
        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()))
        56. 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..1*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. PlanDefinition.action.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.

        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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 60. PlanDefinition.action.extension:action-instructions
          Slice Nameaction-instructions
          Definition

          Specific instructions for use of the regimen overall, or for the individual cycles

          ShortInstructions for use
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Instructions for use) (Extension Type: markdown)
          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())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          62. 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())
          64. PlanDefinition.action.priority
          Definition

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

          Shortroutine | urgent | asap | stat
          Control0..01
          BindingThe codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
          (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()))
          66. 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..0*
          TypeCodeableConcept
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. 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..0*
          TypeCodeableConcept
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. 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..01
          BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1
          (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)
          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()))
          72. PlanDefinition.action.trigger
          Definition

          A description of when the action should be triggered.

          ShortWhen the action should be triggered
          Control0..0*
          TypeTriggerDefinition
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          74. 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..0*
          TypeBackboneElement
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          78. PlanDefinition.action.input
          Definition

          Defines input data requirements for the action.

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

          Defines the outputs of the action, if any.

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

          An optional value describing when the action should be performed.

          ShortWhen the action should take place
          Control0..1
          TypeTiming, dateTime, Period, Duration, 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()))
          84. PlanDefinition.action.type
          Definition

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

          Shortcreate | update | remove | fire-event
          Control0..01
          BindingUnless not suitable, these codes SHALL be taken from ActionTypehttp://hl7.org/fhir/ValueSet/action-type|4.0.1
          (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()))
          86. PlanDefinition.action.precheckBehavior
          Definition

          Defines whether the action should usually be preselected.

          Shortyes | no
          Control0..01
          BindingThe codes SHALL be taken from ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1
          (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()))
          88. PlanDefinition.action.cardinalityBehavior
          Definition

          Defines whether the action can be selected multiple times.

          Shortsingle | multiple
          Control0..01
          BindingThe codes SHALL be taken from ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1
          (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()))
          90. 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..01
          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()))
          92. 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..0*
          TypeBackboneElement
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          95. 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()))
          97. PlanDefinition.action.action.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.

          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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 99. PlanDefinition.action.action.extension:action-instructions
            Slice Nameaction-instructions
            Definition

            Specific instructions for use of the regimen overall, or for the individual cycles

            ShortInstructions for use
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Instructions for use) (Extension Type: markdown)
            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())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            101. PlanDefinition.action.action.extension:timing-of-days
            Slice Nametiming-of-days
            Definition

            Allows specific days to be indicated in a component of a regimen cycle. extends the idea of UV extension: http://hl7.org/fhir/extension-timing-daysofcycle.html by adding instructions

            ShortExtension
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(TimingOfDays) (Complex Extension)
            Is Modifierfalse
            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())
            103. 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())

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

            0. PlanDefinition
            2. PlanDefinition.extension
            SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 4. PlanDefinition.extension:support-factor
              Slice Namesupport-factor
              Control0..*
              TypeExtension(SupportFactor) (Complex Extension)
              6. PlanDefinition.extension:regimen-type
              Slice Nameregimen-type
              Control0..1
              TypeExtension(Regimen type) (Extension Type: CodeableConcept)
              8. PlanDefinition.extension:replaced-by
              Slice Namereplaced-by
              Control0..1
              TypeExtension(Replaced by) (Extension Type: Reference(PlanDefinition))
              10. PlanDefinition.extension:treatment-setting
              Slice Nametreatment-setting
              Control0..1
              TypeExtension(TreatmentSetting) (Extension Type: CodeableConcept)
              12. PlanDefinition.extension:offLabel
              Slice NameoffLabel
              Control0..1
              TypeExtension(Off label) (Extension Type: boolean)
              14. PlanDefinition.extension:plan-instructions
              Slice Nameplan-instructions
              Control0..1
              TypeExtension(Instructions for use) (Extension Type: markdown)
              16. PlanDefinition.extension:disclaimer
              Slice Namedisclaimer
              Control0..1
              TypeExtension(Disclaimer) (Extension Type: markdown)
              18. PlanDefinition.extension:additionalDetails
              Slice NameadditionalDetails
              Control0..*
              TypeExtension(AdditionalDetails) (Complex Extension)
              20. PlanDefinition.extension:esmo-score
              Slice Nameesmo-score
              Control0..1
              TypeExtension(ESMO-MCBS Score) (Complex Extension)
              22. PlanDefinition.type
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
                  "code" : "clinical-protocol"
                }]
              }
              24. PlanDefinition.status
              26. PlanDefinition.status.extension
              SlicingThis element introduces a set of slices on PlanDefinition.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 28. PlanDefinition.status.extension:additional-status
                Slice Nameadditional-status
                Control0..1
                TypeExtension(Regimen under review) (Extension Type: code)
                30. PlanDefinition.useContext
                SlicingThis element introduces a set of slices on PlanDefinition.useContext. The slices areUnordered and Open at End, and can be differentiated using the following discriminators:
                • value @ code
                • 32. PlanDefinition.useContext.value[x]
                  TypeCodeableConcept
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  34. PlanDefinition.useContext:cancer-type
                  Slice Namecancer-type
                  Definition

                  The type of cancer

                  ShortThe type of cancer
                  Control0..*
                  Must Supporttrue
                  36. PlanDefinition.useContext:cancer-type.code
                  Pattern Value{
                    "code" : "focus"
                  }
                  38. PlanDefinition.useContext:cancer-type.value[x]
                  BindingThe codes SHALL be taken from Cancer type
                  (required to https://standards.digital.health.nz/fhir/ValueSet/cancer-type-code)
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  40. PlanDefinition.reviewer
                  Control0..0
                  42. PlanDefinition.endorser
                  Control0..0
                  44. PlanDefinition.library
                  Control0..0
                  46. PlanDefinition.goal
                  Control0..0
                  48. PlanDefinition.action
                  Control1..1
                  50. PlanDefinition.action.extension
                  SlicingThis element introduces a set of slices on PlanDefinition.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 52. PlanDefinition.action.extension:action-instructions
                    Slice Nameaction-instructions
                    Control0..1
                    TypeExtension(Instructions for use) (Extension Type: markdown)
                    54. PlanDefinition.action.priority
                    Control0..0
                    56. PlanDefinition.action.code
                    Control0..0
                    58. PlanDefinition.action.reason
                    Control0..0
                    60. PlanDefinition.action.subject[x]
                    Control0..0
                    62. PlanDefinition.action.trigger
                    Control0..0
                    64. PlanDefinition.action.condition
                    Control0..0
                    66. PlanDefinition.action.input
                    Control0..0
                    68. PlanDefinition.action.output
                    Control0..0
                    70. PlanDefinition.action.timing[x]
                    TypeTiming, dateTime, Period, Duration, Range, Age
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    72. PlanDefinition.action.type
                    Control0..0
                    74. PlanDefinition.action.precheckBehavior
                    Control0..0
                    76. PlanDefinition.action.cardinalityBehavior
                    Control0..0
                    78. PlanDefinition.action.transform
                    Control0..0
                    80. PlanDefinition.action.dynamicValue
                    Control0..0
                    82. PlanDefinition.action.action
                    TypeBackboneElement
                    84. PlanDefinition.action.action.extension
                    SlicingThis element introduces a set of slices on PlanDefinition.action.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 86. PlanDefinition.action.action.extension:action-instructions
                      Slice Nameaction-instructions
                      Control0..1
                      TypeExtension(Instructions for use) (Extension Type: markdown)
                      88. PlanDefinition.action.action.extension:timing-of-days
                      Slice Nametiming-of-days
                      Control0..*
                      TypeExtension(TimingOfDays) (Complex Extension)

                      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

                      An Extension

                      ShortExtension
                      Control0..*
                      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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 16. PlanDefinition.extension:support-factor
                        Slice Namesupport-factor
                        Definition

                        Support factors needed during treatment

                        ShortExtension
                        Control0..*
                        This element is affected by the following invariants: ele-1
                        TypeExtension(SupportFactor) (Complex Extension)
                        Is Modifierfalse
                        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.extension:regimen-type
                        Slice Nameregimen-type
                        Definition

                        The overall type of the regimen - eg FOLFOX

                        ShortRegimen type
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Regimen type) (Extension Type: CodeableConcept)
                        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())
                        20. PlanDefinition.extension:replaced-by
                        Slice Namereplaced-by
                        Definition

                        When a Plan has been deprecated (superceeded or discontinued), refers to the one that replaces it, if any

                        ShortReplaced by
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Replaced by) (Extension Type: Reference(PlanDefinition))
                        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())
                        22. PlanDefinition.extension:treatment-setting
                        Slice Nametreatment-setting
                        Definition

                        The setting of the regimen - what is its purpose

                        ShortExtension
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(TreatmentSetting) (Extension Type: CodeableConcept)
                        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())
                        24. PlanDefinition.extension:offLabel
                        Slice NameoffLabel
                        Definition

                        Indicates that the medication is being used for a purpose for which it has not been specifically approved

                        ShortOff label
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Off label) (Extension Type: boolean)
                        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())
                        26. PlanDefinition.extension:plan-instructions
                        Slice Nameplan-instructions
                        Definition

                        Specific instructions for use of the regimen overall, or for the individual cycles

                        ShortInstructions for use
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Instructions for use) (Extension Type: markdown)
                        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())
                        28. PlanDefinition.extension:disclaimer
                        Slice Namedisclaimer
                        Definition

                        A disclaimer for use of this Plan

                        ShortExtension
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Disclaimer) (Extension Type: markdown)
                        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())
                        30. PlanDefinition.extension:additionalDetails
                        Slice NameadditionalDetails
                        Definition

                        Allows additional information to be added to a regimen such as dosing modification details

                        ShortExtension
                        Control0..*
                        This element is affected by the following invariants: ele-1
                        TypeExtension(AdditionalDetails) (Complex Extension)
                        Is Modifierfalse
                        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())
                        32. PlanDefinition.extension:esmo-score
                        Slice Nameesmo-score
                        Definition

                        The ESMO Magnitude of Clinical Benefit Scale (ESMO-MCBS) score for the regimen

                        ShortESMO-MCBS Score
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ESMO-MCBS Score) (Complex Extension)
                        Is Modifierfalse
                        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.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())
                        36. 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()))
                        38. 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()))
                        40. 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()))
                        42. 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()))
                        44. 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()))
                        46. 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()))
                        48. 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
                        Pattern Value{
                          "coding" : [{
                            "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
                            "code" : "clinical-protocol"
                          }]
                        }
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        50. 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()))
                        52. PlanDefinition.status.id
                        Definition

                        unique id for the element within a resource (for internal references)

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        54. PlanDefinition.status.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        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.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 56. PlanDefinition.status.extension:additional-status
                          Slice Nameadditional-status
                          Definition

                          Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'

                          ShortRegimen under review
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(Regimen under review) (Extension Type: code)
                          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())
                          58. PlanDefinition.status.value
                          Definition

                          Primitive value for code

                          ShortPrimitive value for code
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          60. 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()))
                          62. 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()))
                          64. 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()))
                          66. 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()))
                          68. 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()))
                          70. 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()))
                          72. 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 at End, and can be differentiated using the following discriminators:
                          • value @ code
                          • 74. PlanDefinition.useContext.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
                            76. PlanDefinition.useContext.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
                            • 78. PlanDefinition.useContext.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
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              80. PlanDefinition.useContext.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.

                              TypeCodeableConcept
                              [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()))
                              82. PlanDefinition.useContext:cancer-type
                              Slice Namecancer-type
                              Definition

                              The type of cancer

                              ShortThe type of cancer
                              Comments

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

                              Control0..*
                              TypeUsageContext
                              Is Modifierfalse
                              Must Supporttrue
                              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()))
                              84. PlanDefinition.useContext:cancer-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
                              86. PlanDefinition.useContext:cancer-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.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 88. PlanDefinition.useContext:cancer-type.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{
                                  "code" : "focus"
                                }
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                90. PlanDefinition.useContext:cancer-type.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
                                BindingThe codes SHALL be taken from Cancer type
                                (required to https://standards.digital.health.nz/fhir/ValueSet/cancer-type-code)
                                TypeCodeableConcept
                                [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()))
                                92. 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()))
                                94. 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()))
                                96. 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()))
                                98. 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()))
                                100. 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()))
                                102. 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()))
                                104. 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()))
                                106. 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()))
                                108. 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()))
                                110. 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()))
                                112. PlanDefinition.reviewer
                                Definition

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

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

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

                                ShortWho endorsed the content
                                Control0..0
                                TypeContactDetail
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                116. 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()))
                                118. 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..0
                                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()))
                                120. 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
                                Control0..0
                                TypeBackboneElement
                                Is Modifierfalse
                                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()))
                                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..1
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                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

                                An Extension

                                ShortExtension
                                Control0..*
                                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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 144. PlanDefinition.action.extension:action-instructions
                                  Slice Nameaction-instructions
                                  Definition

                                  Specific instructions for use of the regimen overall, or for the individual cycles

                                  ShortInstructions for use
                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(Instructions for use) (Extension Type: markdown)
                                  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())
                                  146. 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())
                                  148. 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()))
                                  150. 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()))
                                  152. 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()))
                                  154. 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()))
                                  156. PlanDefinition.action.priority
                                  Definition

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

                                  Shortroutine | urgent | asap | stat
                                  Control0..0
                                  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()))
                                  158. 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..0
                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  160. 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..0
                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  162. 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()))
                                  164. 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()))
                                  166. 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..0
                                  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)
                                  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()))
                                  168. PlanDefinition.action.trigger
                                  Definition

                                  A description of when the action should be triggered.

                                  ShortWhen the action should be triggered
                                  Control0..0
                                  TypeTriggerDefinition
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  170. 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..0
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  177. PlanDefinition.action.input
                                  Definition

                                  Defines input data requirements for the action.

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

                                  Defines the outputs of the action, if any.

                                  ShortOutput data definition
                                  Control0..0
                                  TypeDataRequirement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  181. 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()))
                                  183. 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
                                  185. 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())
                                  187. 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())
                                  189. 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()))
                                  191. 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()))
                                  193. 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()))
                                  195. PlanDefinition.action.timing[x]
                                  Definition

                                  An optional value describing when the action should be performed.

                                  ShortWhen the action should take place
                                  Control0..1
                                  TypeTiming
                                  [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()))
                                  197. 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()))
                                  199. 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
                                  201. 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())
                                  203. 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())
                                  205. 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()))
                                  207. 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()))
                                  209. PlanDefinition.action.type
                                  Definition

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

                                  Shortcreate | update | remove | fire-event
                                  Control0..0
                                  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()))
                                  211. 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()))
                                  213. 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()))
                                  215. 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()))
                                  217. PlanDefinition.action.precheckBehavior
                                  Definition

                                  Defines whether the action should usually be preselected.

                                  Shortyes | no
                                  Control0..0
                                  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()))
                                  219. PlanDefinition.action.cardinalityBehavior
                                  Definition

                                  Defines whether the action can be selected multiple times.

                                  Shortsingle | multiple
                                  Control0..0
                                  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()))
                                  221. 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
                                  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()))
                                  223. 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..0
                                  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()))
                                  225. 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..0
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  232. 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()))
                                  234. 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
                                  236. PlanDefinition.action.action.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  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.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 238. PlanDefinition.action.action.extension:action-instructions
                                    Slice Nameaction-instructions
                                    Definition

                                    Specific instructions for use of the regimen overall, or for the individual cycles

                                    ShortInstructions for use
                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(Instructions for use) (Extension Type: markdown)
                                    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())
                                    240. PlanDefinition.action.action.extension:timing-of-days
                                    Slice Nametiming-of-days
                                    Definition

                                    Allows specific days to be indicated in a component of a regimen cycle. extends the idea of UV extension: http://hl7.org/fhir/extension-timing-daysofcycle.html by adding instructions

                                    ShortExtension
                                    Control0..*
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(TimingOfDays) (Complex Extension)
                                    Is Modifierfalse
                                    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())
                                    242. 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())
                                    244. 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()))
                                    246. 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()))
                                    248. 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()))
                                    250. 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()))
                                    252. 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()))
                                    254. 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
                                    Control0..*
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    256. 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()))
                                    258. 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()))
                                    260. 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()))
                                    262. 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()))
                                    264. 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()))
                                    266. 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()))
                                    268. 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
                                    270. 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())
                                    272. 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())
                                    274. 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()))
                                    276. 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()))
                                    278. 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()))
                                    280. 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()))
                                    282. 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()))
                                    284. 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
                                    286. 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())
                                    288. 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())
                                    290. 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()))
                                    292. 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()))
                                    294. 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()))
                                    296. 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()))
                                    298. 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()))
                                    300. 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
                                    302. 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())
                                    304. 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())
                                    306. 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()))
                                    308. 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()))
                                    310. 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()))
                                    312. 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()))
                                    314. 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()))
                                    316. 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()))
                                    318. 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()))
                                    320. 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()))
                                    322. 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()))
                                    324. 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()))
                                    326. 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()))
                                    328. 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
                                    330. 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())
                                    332. 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())
                                    334. 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()))
                                    336. 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()))
                                    338. 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()))